diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..0f516bd7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.* +!.gitignore +build/ +out/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..9b83cd12 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) {{year}} bakdata + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 00000000..3aba2390 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +[![Build status](https://travis-ci.org/bakdata/common-kafka-streams.svg?branch=master)](https://travis-ci.org/bakdata/common-kafka-streams/) +[![Sonarcloud status](https://sonarcloud.io/api/project_badges/measure?project=bakdata-common-kafka-streams&metric=alert_status)](https://sonarcloud.io/dashboard?id=bakdata-common-kafka-streams) +[![Code coverage](https://sonarcloud.io/api/project_badges/measure?project=bakdata-common-kafka-streams&metric=coverage)](https://sonarcloud.io/dashboard?id=bakdata-common-kafka-streams) +[![Maven](https://img.shields.io/maven-central/v/com.bakdata.common-kafka-streams/common-kafka-streams.svg)](https://search.maven.org/search?q=g:com.bakdata.common-kafka-streams%20AND%20a:common-kafka-streams&core=gav) + + +# common-kafka-streams + +Quick intro on what this does. + +Optional: +You can find a [blog post on medium](https://medium.com/bakdata/xxx) with some examples and detailed explanations of how common-kafka-streams works. + +## Getting Started + +You can add common-kafka-streams via Maven Central. + +#### Gradle +```gradle +compile group: 'com.bakdata', name: 'common-kafka-streams', version: '1.0.0' +``` + +#### Maven +```xml + + com.bakdata + common-kafka-streams + 1.0.0 + +``` + + +For other build tools or versions, refer to the [latest version in MvnRepository](https://mvnrepository.com/artifact/com.bakdata.common-kafka-streams/common-kafka-streams/latest). + +### How to use it + +Here are X examples that show you how to use common-kafka-streams. + +#### Example 1 + +```java +class ExampleSnippet { +} +``` + +#### More Examples + +You can find many more example in [this repository's XXX code](https://github.com/bakdata/common-kafka-streams/xxx). + + +## Development + +If you want to contribute to this project, you can simply clone the repository and build it via Gradle. +All dependencies should be included in the Gradle files, there are no external prerequisites. + +```bash +> git clone git@github.com:bakdata/common-kafka-streams.git +> cd common-kafka-streams && ./gradlew build +``` + +Please note, that we have [code styles](https://github.com/bakdata/bakdata-code-styles) for Java. +They are basically the Google style guide, with some small modifications. + +## Contributing + +We are happy if you want to contribute to this project. +If you find any bugs or have suggestions for improvements, please open an issue. +We are also happy to accept your PRs. +Just open an issue beforehand and let us know what you want to do and why. + +## License +This project is licensed under the MIT license. +Have a look at the [LICENSE](https://github.com/bakdata/common-kafka-streams/blob/master/LICENSE) for more details. diff --git a/azure-pipelines.yml b/azure-pipelines.yml new file mode 100644 index 00000000..ceb0cbaf --- /dev/null +++ b/azure-pipelines.yml @@ -0,0 +1,27 @@ +trigger: + branches: + include: + - refs/heads/* + - refs/tags/* +pr: + branches: + include: + - master + +variables: +- group: sonarqube +- group: sign +- group: ossrh + +resources: + repositories: + - repository: templates + type: github + name: bakdata/bakdata-project-templates + endpoint: bot + +jobs: +- template: azure/gradle/build.yml@templates +- template: azure/gradle/create_tag_version.yml@templates +- template: azure/gradle/upload_release.yml@templates +- template: azure/gradle/upload_snapshot.yml@templates diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 00000000..bfcd7e87 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,61 @@ +plugins { + id("net.researchgate.release") version "2.6.0" + id("com.bakdata.sonar") version "1.1.4" + id("com.bakdata.sonatype") version "1.1.4" + id("org.hildan.github.changelog") version "0.8.0" +} + +allprojects { + // TODO: adjust subpackage if needed + group = "com.bakdata.${rootProject.name}" + + tasks.withType { + maxParallelForks = 4 + } + + repositories { + mavenCentral() + } +} + +configure { + developers { + // TODO: adjust + developer { + name.set("Arvid Heise") + id.set("AHeise") + } + } +} + +configure { + githubUser = "bakdata" + futureVersionTag = findProperty("changelog.releaseVersion")?.toString() + sinceTag = findProperty("changelog.sinceTag")?.toString() +} + +subprojects { + apply(plugin = "java-library") + + configure { + sourceCompatibility = org.gradle.api.JavaVersion.VERSION_11 + targetCompatibility = org.gradle.api.JavaVersion.VERSION_11 + } + + dependencies { + "testImplementation"("org.junit.jupiter:junit-jupiter-api:5.3.0") + "testRuntimeOnly"("org.junit.jupiter:junit-jupiter-engine:5.3.0") + "testImplementation"(group = "org.assertj", name = "assertj-core", version = "3.11.1") + + "compileOnly"("org.projectlombok:lombok:1.18.6") + "annotationProcessor"("org.projectlombok:lombok:1.18.6") + "testCompileOnly"("org.projectlombok:lombok:1.18.6") + "testAnnotationProcessor"("org.projectlombok:lombok:1.18.6") + } +} + +configure { + githubUser = "bakdata" + futureVersionTag = findProperty("changelog.releaseVersion")?.toString() + sinceTag = findProperty("changelog.sinceTag")?.toString() +} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 00000000..01f8cfb2 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,3 @@ +version=1.0.0-SNAPSHOT +org.gradle.caching=true +org.gradle.parallel=true diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..87b738cb Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..558870da --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-5.1.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 00000000..af6708ff --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 00000000..0f8d5937 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 00000000..824c96b2 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'common-kafka-streams'