diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..a2aec71 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,217 @@ +image: registry.gitlab.com/josm/docker-library/openjdk-8-josmplugin:latest + +before_script: +- export GRADLE_USER_HOME=`pwd`/.gradle + +cache: + paths: + - .gradle/wrapper + - .gradle/caches + +############################# +# Various additional Checks # +############################# +#include: +# - template: SAST.gitlab-ci.yml +# - template: Code-Quality.gitlab-ci.yml +# - template: Dependency-Scanning.gitlab-ci.yml +# - template: Container-Scanning.gitlab-ci.yml +# - template: DAST.gitlab-ci.yml +# - template: License-Management.gitlab-ci.yml + +#sast: +# variables: +# GRADLE_PATH: "./gradlew" +# CI_DEBUG_TRACE: "true" + +############### +# Build stage # +############### + +assemble: + stage: build + script: + - ./gradlew assemble --stacktrace + artifacts: + paths: + - build/ + +assemble with java 11: + stage: build + image: registry.gitlab.com/josm/docker-library/openjdk-11-josmplugin:latest + script: + - ./gradlew assemble --stacktrace + artifacts: + paths: + - build/ + +assemble with java 12: + stage: build + image: registry.gitlab.com/josm/docker-library/openjdk-12-josmplugin:latest + script: + - ./gradlew assemble --stacktrace + artifacts: + paths: + - build/ + allow_failure: true + +assemble with java 13: + stage: build + image: registry.gitlab.com/josm/docker-library/openjdk-13-josmplugin:latest + script: + - ./gradlew assemble --stacktrace + artifacts: + paths: + - build/ + allow_failure: true + +############## +# Test stage # +############## + +build: + stage: test + script: + - ./gradlew build generateSnapshotUpdateSite --stacktrace + artifacts: + paths: + - build + reports: + codequality: build/reports/pmd/main.xml + sast: build/reports/spotbugs/main.html + #junit: build/test-results/test/TEST-*.xml + dependencies: + - assemble + +compile against min JOSM: + stage: test + script: + - ./gradlew compileJava_minJosm + dependencies: + - assemble + +compile against latest JOSM: + stage: test + script: + - ./gradlew compileJava_latestJosm + dependencies: + - assemble + +build with java 11: + stage: test + image: registry.gitlab.com/josm/docker-library/openjdk-11-josmplugin:latest + script: + - ./gradlew build --stacktrace + dependencies: + - assemble with java 11 + allow_failure: true # due to copy-paste-detection + +build with java 12: + stage: test + image: registry.gitlab.com/josm/docker-library/openjdk-12-josmplugin:latest + script: + - ./gradlew build --stacktrace + dependencies: + - assemble with java 12 + allow_failure: true + +build with java 13: + stage: test + image: registry.gitlab.com/josm/docker-library/openjdk-13-josmplugin:latest + script: + - ./gradlew build --stacktrace + dependencies: + - assemble with java 13 + allow_failure: true + +################ +# Deploy stage # +################ + +#upload to transifex: +# image: python:3.6-stretch +# stage: deploy +# environment: +# name: transifex +# url: https://www.transifex.com/josm/josm/josm-plugin_highwaynamemodification/ +# before_script: +# - apt-get update && apt-get install -yq gettext git +# - pip install git+https://github.com/transifex/transifex-client.git +# script: +# - TX_TOKEN="$TRANSIFEX_TOKEN" tx push -s --no-interactive +# dependencies: +# - build +# only: +# - master + +release: + stage: deploy + environment: + name: pages branch / dist directory + url: ${CI_PAGES_URL}/${CI_PROJECT_NAME} + script: + - &clone_pages_branch | + echo "$SSH_PRIVATE_DEPLOY_KEY" > ~/.ssh/id_rsa + chmod 600 ~/.ssh/id_rsa + git clone --depth 1 --branch pages git@${CI_SERVER_HOST}:${CI_PROJECT_PATH} pages + - | + version=`git describe --always --dirty` + longVersion=`git describe --always --long --dirty` + commitMessage="Release version $longVersion" + - | + mkdir -pv "pages/public/dist/$version" + cp -v "build/dist/"* "build/tmp/jar/MANIFEST.MF" "pages/public/dist/$version" + rm -fv "pages/public/dist/latest" + ln -s "./$version" "pages/public/dist/latest" + - &push_pages_branch | + cd pages/ + git config user.name "Deploy with GitLab CI" + git config user.email "${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}@${CI_SERVER_HOST}" + git stage . + git commit -a -m "$commitMessage" + git push origin pages + dependencies: + - build + only: + refs: + - tags + variables: + - $SSH_PRIVATE_DEPLOY_KEY + +publish master update site: + stage: deploy + environment: + name: pages branch / snapshot update site + url: ${CI_PAGES_URL}/${CI_PROJECT_NAME}/snapshot/master/update-site + script: + - *clone_pages_branch + - | + commitHash=`git rev-parse HEAD` + commitMessage="Make latest commit from master available via JOSM update site ($commitHash)" + - | + rm -vrf "pages/public/snapshot/master" + mkdir -pv "pages/public/snapshot/master" + cp -v "build/snapshot-update-site" "pages/public/snapshot/master/update-site" + cp -v "build/dist/"* "pages/public/snapshot/master" + - *push_pages_branch + dependencies: + - build + only: + refs: + - master + variables: + - $SSH_PRIVATE_DEPLOY_KEY + +publish to / GitLab.com packages: + stage: deploy + environment: + name: GitLab.com / ${CI_PROJECT_NAME} packages + url: ${CI_PROJECT_URL}/-/packages + script: + - ./gradlew publishAllPublicationsToGitlabRepository + - ./gradlew releaseToGitlab + dependencies: + - build + only: + refs: + - tags diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..27c82a6 --- /dev/null +++ b/build.gradle @@ -0,0 +1,206 @@ +import com.github.spotbugs.SpotBugsTask +import net.ltgt.gradle.errorprone.CheckSeverity +import org.openstreetmap.josm.gradle.plugin.task.GeneratePluginList + +import java.nio.file.Files +import java.nio.file.Paths + +plugins { + id "java" + id "eclipse" + id "jacoco" + id "maven-publish" + id "pmd" + id "com.github.ben-manes.versions" version "0.26.0" + id "com.github.spotbugs" version "2.0.0" + id "org.openstreetmap.josm" version "0.6.4" + id "net.ltgt.errorprone" version "1.0.0" + //id 'de.aaschmid.cpd' version '2.0' +} + +// Set up Errorprone +tasks.withType(JavaCompile).configureEach { + options.errorprone { + check("DefaultCharset", CheckSeverity.ERROR) + check("StringEquality", CheckSeverity.ERROR) + check("ConstantField", CheckSeverity.WARN) + check("FieldCanBeFinal", CheckSeverity.WARN) + check("LambdaFunctionalInterface", CheckSeverity.WARN) + check("MethodCanBeStatic", CheckSeverity.WARN) + check("MultiVariableDeclaration", CheckSeverity.WARN) + check("PrivateConstructorForUtilityClass", CheckSeverity.WARN) + check("UngroupedOverloads", CheckSeverity.WARN) + check("WildcardImport", CheckSeverity.WARN) + // TODO remove this on errorprone update + if ((JavaVersion.current().majorVersion as Integer) > 11) { + check('Finally', CheckSeverity.OFF) + } + } +} + +archivesBaseName = "highwaynamemodification" +def gitlabGroup = "gokaart" +def gitlabRepositoryName = "JOSM_highwayNameModification" + + +def versions = [ + awaitility: "4.0.1", + errorprone: "2.3.3", + jacoco: "0.8.5", + jmockit: "1.46", + junit: "5.5.2", + pmd: "6.6.0", + spotbugs: "3.1.12", + wiremock: "2.25.0", + findsecbugs: "1.9.0", +] + +repositories { + jcenter() + mavenCentral() +} +dependencies { + if (!JavaVersion.current().isJava9Compatible()) { + errorproneJavac("com.google.errorprone:javac:9+181-r4173-1") + } + spotbugsPlugins "com.h3xstream.findsecbugs:findsecbugs-plugin:${versions.findsecbugs}" + errorprone("com.google.errorprone:error_prone_core:${versions.errorprone}") + + testImplementation("org.junit.jupiter:junit-jupiter-api:${versions.junit}") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:${versions.junit}") + testImplementation("org.junit.vintage:junit-vintage-engine:${versions.junit}") + testCompile("org.jmockit:jmockit:${versions.jmockit}") + testImplementation("com.github.spotbugs:spotbugs-annotations:${versions.spotbugs}") + testImplementation("org.openstreetmap.josm:josm-unittest:"){changing=true} + testImplementation("com.github.tomakehurst:wiremock:${versions.wiremock}") + testImplementation("org.awaitility:awaitility:${versions.awaitility}") +} + +// Add dependencies from ivy.xml +def ivyModule = new XmlParser().parse(new File("$projectDir/ivy.xml")) +logger.info("Dependencies from ivy.xml (added to configuration `packIntoJar`):") +ivyModule.dependencies.dependency.each { + logger.info(" * ${it.@org}:${it.@name}:${it.@rev}") + project.dependencies.packIntoJar("${it.@org}:${it.@name}:${it.@rev}") +} + +test { + project.afterEvaluate { + jvmArgs("-javaagent:${classpath.find { it.name.contains("jmockit") }.absolutePath}") + } + useJUnitPlatform() + testLogging.exceptionFormat = 'full' +} + +sourceSets { + test { + java { + srcDirs = ["test/unit"] + } + resources { + srcDirs = ["test/data"] + } + } +} +tasks.processResources { + from("$projectDir/LICENSE") + from("$projectDir/README.md") + from("$projectDir/src/resources") +} + +josm { + i18n { + pathTransformer = getPathTransformer("gitlab.com/${gitlabGroup}/${gitlabRepositoryName}/blob") + } +} + +tasks.withType(JavaCompile) { + options.compilerArgs += [ + "-Xlint:all", + "-Xlint:-serial", + ] +} + +// Set up JaCoCo +jacoco { + toolVersion = "${versions.jacoco}" +} +jacocoTestReport { + dependsOn test + reports { + xml.enabled = true + html.enabled = true + } +} +check.dependsOn jacocoTestReport + +// Set up PMD +pmd { + toolVersion = versions.pmd + ignoreFailures true + incrementalAnalysis = true + ruleSets = [] + ruleSetConfig = resources.text.fromFile("$projectDir/config/pmd/ruleset.xml") + sourceSets = [sourceSets.main] +} + +// Set up SpotBugs +spotbugs { + toolVersion = versions.spotbugs + ignoreFailures = true + sourceSets = [sourceSets.main] +} +tasks.withType(SpotBugsTask) { + reports { + xml.enabled = false + html.enabled = true + } +} + +task generateSnapshotUpdateSite(type: GeneratePluginList) { + dependsOn(tasks.processResources) + + outputFile = new File(project.buildDir, "snapshot-update-site") + versionSuffix = {a -> ""} + doFirst { + def pluginDownloadUrl = "https://${gitlabGroup}.gitlab.io/${gitlabRepositoryName}/snapshot/master/${archivesBaseName}.jar" + it.iconBase64Provider = { + def file = new File(sourceSets.main.resources.srcDirs[0], it) + if (file.exists()) { + def contentType = file.name.endsWith(".svg") ? "svg+xml" : "png" + return "data:image/" + contentType + ";base64," + Base64.getEncoder().encodeToString(Files.readAllBytes(Paths.get(file.toURI()))); + } + } + it.addPlugin("$archivesBaseName-dev.jar", project.josm.manifest.createJosmPluginJarManifest(), new URL(pluginDownloadUrl)) + } +} + +project.afterEvaluate { + publishing { + publications { + plugin(MavenPublication) { + groupId = "org.openstreetmap.josm.plugins" + artifactId = archivesBaseName + version = project.version + + from components.java + } + } + } +} + +def ciJobToken = System.getenv("CI_JOB_TOKEN") +def projectId = System.getenv("CI_PROJECT_ID") +if (ciJobToken != null && projectId!= null) { + publishing.repositories.maven { + url = "https://gitlab.com/api/v4/projects/$projectId/packages/maven" + name = "gitlab" + credentials(HttpHeaderCredentials.class) { + name = "Job-Token" + value = ciJobToken + } + authentication { + create("auth", HttpHeaderAuthentication.class) + } + } +} diff --git a/build.xml b/build.xml index 87558f3..3813ecd 100644 --- a/build.xml +++ b/build.xml @@ -1,39 +1,45 @@ - - - - + + - - - - + + - - - - - - - - - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..2f8f587 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,12 @@ +# The minimum JOSM version this plugin is compatible with (can be any numeric version) +plugin.main.version = 15038 +# The JOSM version this plugin is currently compiled against +# Please make sure this version is available at https://josm.openstreetmap.de/download +# The special values "latest" and "tested" are also possible here, but not recommended. +plugin.compile.version = 15038 +plugin.canloadatruntime = true +plugin.author = Taylor Smock +plugin.class = com.kaart.highwaynamemodification.HighwayNameModification +plugin.icon = images/addresses.png +plugin.link = https://gitlab.com/gokaart/JOSM_highwayNameModification +plugin.description = Modify addr tags when a highway name is changed diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..87b738c 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 0000000..7c4388a --- /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.6.2-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..af6708f --- /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 0000000..0f8d593 --- /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/ivy.xml b/ivy.xml new file mode 100644 index 0000000..431279c --- /dev/null +++ b/ivy.xml @@ -0,0 +1,3 @@ + + +