diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..62739df --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/.idea/ +*.iml +/build/ +/.gradle/ diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..e945b19 --- /dev/null +++ b/build.gradle @@ -0,0 +1,24 @@ +plugins { + id 'groovy' +} + +group 'de.lundf' +version '0.1.0' + +repositories { + mavenCentral() +} + +wrapper { + gradleVersion = '6.3' +} + +dependencies { + implementation 'org.codehaus.groovy:groovy-all:3.0.2' + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.1.1' + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.1.1' +} + +test { + useJUnitPlatform() +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..29953ea 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..26bbc9e --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Tue May 14 00:40:27 CEST 2019 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-all.zip diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..cccdd3d --- /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="" + +# 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..f955316 --- /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= + +@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 0000000..7e44dcc --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'jenkins-jobdsl-remote' + diff --git a/src/main/groovy/JenkinsJobDslRemote.groovy b/src/main/groovy/JenkinsJobDslRemote.groovy new file mode 100644 index 0000000..c798a76 --- /dev/null +++ b/src/main/groovy/JenkinsJobDslRemote.groovy @@ -0,0 +1,13 @@ +/** + * Jenkins JobDSL Remote Script + */ +class JenkinsJobDslRemote { + /** + * Main method. + * This method will be executed, when Jenkins calls this as script. + * + * @param args arguments (not used) + */ + static void main(String[] args) { + } +} diff --git a/src/main/groovy/model/BaseJobDslPipelineModel.groovy b/src/main/groovy/model/BaseJobDslPipelineModel.groovy new file mode 100644 index 0000000..2bb6219 --- /dev/null +++ b/src/main/groovy/model/BaseJobDslPipelineModel.groovy @@ -0,0 +1,11 @@ +package model + +import groovy.transform.ToString + +@ToString(includeNames = true, includeFields = true) +class BaseJobDslPipelineModel { + String jobName + String jobDescription + String pipelineScriptPath + GitModel git +} diff --git a/src/main/groovy/model/GitModel.groovy b/src/main/groovy/model/GitModel.groovy new file mode 100644 index 0000000..58124ed --- /dev/null +++ b/src/main/groovy/model/GitModel.groovy @@ -0,0 +1,13 @@ +package model + +import groovy.transform.ToString + +@ToString(includeNames = true, includeFields = true) +class GitModel { + // unique repository ID + String repositoryId + // URL to the repository + String repositoryUrl + // Trigger in Cron format. Defines how often the scm should be checked + String repositoryTrigger +} diff --git a/src/main/groovy/model/JobsModel.groovy b/src/main/groovy/model/JobsModel.groovy new file mode 100644 index 0000000..7666935 --- /dev/null +++ b/src/main/groovy/model/JobsModel.groovy @@ -0,0 +1,9 @@ +package model + +import groovy.transform.ToString + +@ToString(includeNames = true, includeFields = true) +class JobsModel { + List multiBranchJobs + List pipelineJobs +} diff --git a/src/main/groovy/model/MultibranchModel.groovy b/src/main/groovy/model/MultibranchModel.groovy new file mode 100644 index 0000000..1c79a4b --- /dev/null +++ b/src/main/groovy/model/MultibranchModel.groovy @@ -0,0 +1,7 @@ +package model + +import groovy.transform.ToString + +@ToString(includeNames = true, includeFields = true) +class MultibranchModel extends BaseJobDslPipelineModel { +} diff --git a/src/main/groovy/model/PipelineJobModel.groovy b/src/main/groovy/model/PipelineJobModel.groovy new file mode 100644 index 0000000..6feed2b --- /dev/null +++ b/src/main/groovy/model/PipelineJobModel.groovy @@ -0,0 +1,7 @@ +package model + +import groovy.transform.ToString + +@ToString(includeNames = true, includeFields = true) +class PipelineJobModel extends BaseJobDslPipelineModel { +} diff --git a/src/main/groovy/parser/Json2ModelParser.groovy b/src/main/groovy/parser/Json2ModelParser.groovy new file mode 100644 index 0000000..9dd9289 --- /dev/null +++ b/src/main/groovy/parser/Json2ModelParser.groovy @@ -0,0 +1,20 @@ +package parser + +import groovy.json.JsonSlurper +import model.JobsModel + +final class Json2ModelParser { + + /** + * Parse the Jenkins JobDSL JSON abstraction to the model + * + * @return JobDslPipelineModel with mapped data from JSON file + */ + static JobsModel parseJobJsonToModel(String jobDescriptionPath) { + println "INFO: Try to parse JSON file from ${jobDescriptionPath}" + JsonSlurper jsonSlurper = new JsonSlurper() + JobsModel jobsModel = jsonSlurper.parse(new File(jobDescriptionPath)) + + return jobsModel + } +} diff --git a/src/main/groovy/validator/ModelValidator.groovy b/src/main/groovy/validator/ModelValidator.groovy new file mode 100644 index 0000000..5b21c59 --- /dev/null +++ b/src/main/groovy/validator/ModelValidator.groovy @@ -0,0 +1,4 @@ +package validator + +class ModelValidator { +} diff --git a/src/test/groovy/JsonParserTest.groovy b/src/test/groovy/JsonParserTest.groovy new file mode 100644 index 0000000..5c2419d --- /dev/null +++ b/src/test/groovy/JsonParserTest.groovy @@ -0,0 +1,85 @@ +import model.BaseJobDslPipelineModel +import model.GitModel +import model.JobsModel +import model.MultibranchModel +import model.PipelineJobModel +import org.junit.jupiter.api.DisplayName +import org.junit.jupiter.api.Test +import parser.Json2ModelParser + +import static org.junit.jupiter.api.Assertions.assertNotNull +import static org.junit.jupiter.api.Assertions.assertEquals +import static org.junit.jupiter.api.Assertions.assertNull + +class JsonParserTest { + @Test + @DisplayName(value = "JSON file with one multibranch") + void testMultiBranch() { + JobsModel jobsModel = Json2ModelParser.parseJobJsonToModel(getClass().getResource('jobs-multibranch-single.json').getPath()) + + // validate, that everything was set + assertNotNull(jobsModel) + assertNotNull(jobsModel.getMultiBranchJobs()) + assertNull(jobsModel.getPipelineJobs()) + assertEquals(1, jobsModel.getMultiBranchJobs().size()) + + // validate multibranchJobs + MultibranchModel multibranchModel = jobsModel.getMultiBranchJobs().get(0) + validateBaseJobDslPipelineModel(multibranchModel) + } + + @Test + @DisplayName(value = "JSON file with one pipelineJob") + void testPipelineJob() { + JobsModel jobsModel = Json2ModelParser.parseJobJsonToModel(getClass().getResource('jobs-pipeline-single.json').getPath()) + + // validate, that everything was set + assertNotNull(jobsModel) + assertNull(jobsModel.getMultiBranchJobs()) + assertNotNull(jobsModel.getPipelineJobs()) + assertEquals(1, jobsModel.getPipelineJobs().size()) + + // validate pipelineJobs + PipelineJobModel pipelineJobModel = jobsModel.getPipelineJobs().get(0) + validateBaseJobDslPipelineModel(pipelineJobModel) + } + + @Test + @DisplayName(value = "JSON file with one multiBranchJob and one pipelineJob") + void testMultiBranchAndPipelineJob() { + JobsModel jobsModel = Json2ModelParser.parseJobJsonToModel(getClass().getResource('jobs-multi-jobs.json').getPath()) + + // validate, that everything was set + assertNotNull(jobsModel) + assertNotNull(jobsModel.getMultiBranchJobs()) + assertNotNull(jobsModel.getPipelineJobs()) + assertEquals(1, jobsModel.getPipelineJobs().size()) + assertEquals(1, jobsModel.getPipelineJobs().size()) + + // validate multibranchJobs + MultibranchModel multibranchModel = jobsModel.getMultiBranchJobs().get(0) + validateBaseJobDslPipelineModel(multibranchModel) + // validate pipelineJobs + PipelineJobModel pipelineJobModel = jobsModel.getPipelineJobs().get(0) + validateBaseJobDslPipelineModel(pipelineJobModel) + } + + /** + * Method to test the data of BaseJobDslPipelineModel + * + * @param baseJobDslPipelineModel parsed BasePipelineModel + */ + static void validateBaseJobDslPipelineModel(BaseJobDslPipelineModel baseJobDslPipelineModel) { + assertNotNull(baseJobDslPipelineModel) + assertEquals("myJob", baseJobDslPipelineModel.getJobName()) + assertEquals("This is a test job", baseJobDslPipelineModel.getJobDescription()) + assertEquals("Jenkinsfile", baseJobDslPipelineModel.getPipelineScriptPath()) + + // Validate Git object + assertNotNull(baseJobDslPipelineModel.getGit()) + GitModel gitModel = baseJobDslPipelineModel.getGit() + assertEquals("my-repo", gitModel.getRepositoryId()) + assertEquals("https://github.com/myrepo.git", gitModel.getRepositoryUrl()) + assertEquals("* * * * *", gitModel.getRepositoryTrigger()) + } +} diff --git a/src/test/resources/jobs-multi-jobs.json b/src/test/resources/jobs-multi-jobs.json new file mode 100644 index 0000000..4938646 --- /dev/null +++ b/src/test/resources/jobs-multi-jobs.json @@ -0,0 +1,26 @@ +{ + "multiBranchJobs": [ + { + "jobName": "myJob", + "jobDescription": "This is a test job", + "pipelineScriptPath": "Jenkinsfile", + "git": { + "repositoryId": "my-repo", + "repositoryUrl": "https://github.com/myrepo.git", + "repositoryTrigger": "* * * * *" + } + } + ], + "pipelineJobs": [ + { + "jobName": "myJob", + "jobDescription": "This is a test job", + "pipelineScriptPath": "Jenkinsfile", + "git": { + "repositoryId": "my-repo", + "repositoryUrl": "https://github.com/myrepo.git", + "repositoryTrigger": "* * * * *" + } + } + ] +} \ No newline at end of file diff --git a/src/test/resources/jobs-multibranch-single.json b/src/test/resources/jobs-multibranch-single.json new file mode 100644 index 0000000..41ebcde --- /dev/null +++ b/src/test/resources/jobs-multibranch-single.json @@ -0,0 +1,14 @@ +{ + "multiBranchJobs": [ + { + "jobName": "myJob", + "jobDescription": "This is a test job", + "pipelineScriptPath": "Jenkinsfile", + "git": { + "repositoryId": "my-repo", + "repositoryUrl": "https://github.com/myrepo.git", + "repositoryTrigger": "* * * * *" + } + } + ] +} \ No newline at end of file diff --git a/src/test/resources/jobs-pipeline-single.json b/src/test/resources/jobs-pipeline-single.json new file mode 100644 index 0000000..edd003d --- /dev/null +++ b/src/test/resources/jobs-pipeline-single.json @@ -0,0 +1,14 @@ +{ + "pipelineJobs": [ + { + "jobName": "myJob", + "jobDescription": "This is a test job", + "pipelineScriptPath": "Jenkinsfile", + "git": { + "repositoryId": "my-repo", + "repositoryUrl": "https://github.com/myrepo.git", + "repositoryTrigger": "* * * * *" + } + } + ] +} \ No newline at end of file