├── .github └── workflows │ └── gradle.yml ├── .gitignore ├── LICENSE.md ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── jobs ├── hello.groovy ├── release │ ├── mail │ │ └── basic.groovy │ └── release_input.groovy └── template │ ├── release.groovy │ └── semver.groovy ├── settings.gradle ├── src └── org │ └── hcm │ └── libjenkins │ ├── AbstractLibClass.groovy │ ├── Release.groovy │ └── Semver.groovy ├── test ├── integration │ └── groovy │ │ └── TestReleaseMail.groovy └── unit │ └── groovy │ ├── TestHelloWorld.groovy │ ├── TestJenkinsCommonLib.groovy │ └── TestRelease.groovy └── vars ├── gitlab_stage.groovy └── renderTemplate.groovy /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | name: Java CI 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v1 12 | - name: Set up JDK 1.8 13 | uses: actions/setup-java@v1 14 | with: 15 | java-version: 1.8 16 | - name: Build with Gradle 17 | run: | 18 | chmod +x ./gradlew 19 | ./gradlew --no-daemon check 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | target 3 | .idea 4 | build 5 | .gradle 6 | *.swp 7 | .jobs 8 | .seed_ref 9 | out/ 10 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Copyright (c) 2016 @stchar 2 | 3 | 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: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | 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. 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Jenkins Shared Library Test Harness Example 2 | This repository contains examples of a Jenkins Shared Library 3 | and JenkinsPipelineUnit test harness (see slides https://slides.com/stasovchar/deck-2) 4 | 5 | ## Repository Structure 6 | ``` 7 | . 8 | ├── jobs # Template pipeline scripts to load the lib 9 | │   │ # are used by unit tests 10 | │   └── template 11 | | | 12 | │   └── template.groovy 13 | ├── src 14 | │   └── org 15 | │   └── hcm 16 | │   └── libjenkins 17 | │   └── *.groovy # Examples of Library class 18 | ├── test 19 | │   ├── integration 20 | │   │   └── groovy 21 | │   │   └── *.groovy # Integration tests 22 | │   └── unit 23 | │   └── groovy 24 | │   └── *.groovy # JenkinsPipelineUnit tests 25 | └── vars 26 | └── *.groovy # Jenkins pipeline shared library vars objects 27 | ``` 28 | 29 | ## Contribution 30 | 31 | ### Testing 32 | ``` 33 | ./gradlew check 34 | 35 | # Runing gradle behind a proxy 36 | # ./gradlew -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 check 37 | ``` 38 | 39 | ## Slides 40 | * `EN_US`: https://slides.com/stasovchar/deck-2 41 | 42 | ## Video 43 | * `RU_RU`: TBD 44 | * `EN_US`: TBD 45 | 46 | 47 | ## Additional Links 48 | * https://jenkins.io/doc/book/pipeline/shared-libraries/ 49 | * https://www.cloudbees.com/blog/top-10-best-practices-jenkins-pipeline-plugin 50 | * https://github.com/lesfurets/JenkinsPipelineUnit 51 | * https://github.com/mkobit/jenkins-pipeline-shared-libraries-gradle-plugin 52 | * https://github.com/jenkinsci/jenkins-test-harness 53 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * This build file was generated by the Gradle 'init' task. 3 | * 4 | * This generated file contains a commented-out sample Java project to get you started. 5 | * For more details take a look at the Java Quickstart chapter in the Gradle 6 | * user guide available at https://docs.gradle.org/3.5/userguide/tutorial_java_projects.html 7 | */ 8 | plugins { 9 | id "com.mkobit.jenkins.pipelines.shared-library" version "0.10.1" 10 | id "jacoco" 11 | id "java" 12 | id "groovy" 13 | 14 | } 15 | 16 | // In this section you declare where to find the dependencies of your project 17 | repositories { 18 | // Use 'jcenter' for resolving your dependencies. 19 | // You can declare any Maven/Ivy/file repository here. 20 | //All sub-projects will now refer to the same 'libs' directory 21 | maven { url 'http://bits.netbeans.org/maven2/' } 22 | maven { url 'https://repo.jenkins-ci.org/releases/' } 23 | jcenter() 24 | maven { url 'https://mvnrepository.com/artifact/' } 25 | mavenLocal() 26 | flatDir { 27 | dirs "jars" 28 | } 29 | } 30 | 31 | dependencies { 32 | testImplementation(group: 'junit', name: 'junit', version: '4.13.2') 33 | 34 | compile group: 'junit', name: 'junit', version: '4.12' 35 | compile group: 'org.assertj', name: 'assertj-core', version: '3.26.0' 36 | 37 | // Jenkis Pipeline JUnit 38 | compile group: 'com.lesfurets', name:'jenkins-pipeline-unit', version: '1.4' 39 | compile group: 'com.cloudbees', name: 'groovy-cps', version: '1.34' 40 | 41 | // grapes 42 | compile group: 'org.codehaus.groovy', name: 'groovy-json', version: '3.0.22' 43 | compile group: 'com.github.zafarkhaja', name: 'java-semver', version: '0.10.2' 44 | compile group: 'org.apache.commons', name: 'commons-math3', version: '3.6.1' 45 | 46 | // integration tests dependecies 47 | integrationTestCompile group: 'org.jvnet.mock-javamail',name: 'mock-javamail', version: '1.9' 48 | integrationTestCompile group: 'org.slf4j', name: 'slf4j-nop', version: '2.0.13' 49 | } 50 | 51 | // In this section you declare the dependencies for your production and test code 52 | compileGroovy { 53 | // Create temp file. 54 | File temp = File.createTempFile("config", ".groovy"); 55 | 56 | // Delete temp file when program exits. 57 | temp.deleteOnExit(); 58 | 59 | // Write to temp file 60 | BufferedWriter out = new BufferedWriter(new FileWriter(temp)); 61 | out.write("""\ 62 | withConfig(configuration) { 63 | configuration.setDisabledGlobalASTTransformations(['groovy.grape.GrabAnnotationTransformation'] as Set) 64 | } 65 | """.stripIndent()); 66 | out.close(); 67 | groovyOptions.configurationScript = temp 68 | } 69 | 70 | sourceSets { 71 | jobs { 72 | groovy { 73 | srcDirs 'jobs' 74 | compileClasspath += main.compileClasspath 75 | } 76 | compileClasspath += sourceSets.main.output 77 | runtimeClasspath += sourceSets.main.output 78 | } 79 | } 80 | 81 | sharedLibrary { 82 | coreVersion = "2.176.2" 83 | testHarnessVersion = "2.54" 84 | pluginDependencies { 85 | workflowCpsGlobalLibraryPluginVersion = "2.16" 86 | dependency("org.jenkins-ci.plugins", "pipeline-input-step", "2.8") 87 | dependency("org.jenkins-ci.plugins", "email-ext", "2.63") 88 | } 89 | } 90 | 91 | test { 92 | testLogging { 93 | events "PASSED", "FAILED", "SKIPPED" 94 | } 95 | } 96 | 97 | integrationTest { 98 | systemProperties 'java.net.preferIPv4Stack' : true 99 | testLogging { 100 | events "PASSED", "FAILED", "SKIPPED" 101 | } 102 | } 103 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stchar/pipeline-sharedlib-testharness/b0666703dc5110b257685075121553cd1e305fbe/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Fri Jul 07 15:19:49 MSK 2017 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.3-bin.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn ( ) { 37 | echo "$*" 38 | } 39 | 40 | die ( ) { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save ( ) { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /jobs/hello.groovy: -------------------------------------------------------------------------------- 1 | def greet = "Hello World!" 2 | node() { 3 | echo greet 4 | } 5 | -------------------------------------------------------------------------------- /jobs/release/mail/basic.groovy: -------------------------------------------------------------------------------- 1 | package release.mail 2 | 3 | def jc=library('jenkins-commons') 4 | def release_lib = jc.org.hcm.libjenkins.Release.new(this) 5 | 6 | def component = [:] 7 | component.name = component.name ? component.name : 'component' 8 | component.namespace = component.namespace ? component.namespace : 'namespace' 9 | component.project = component.project ? component.project : 'namespace/component' 10 | component.src_ref = component.src_ref ? component.src_ref : 'master' 11 | component.target_ref = component.target_ref ? component.target_ref : 'master' 12 | component.mailto = component.mailto ? component.mailto : 'jhon.doe@example.com' 13 | 14 | node() { 15 | echo "Preparing email context" 16 | echo "Echo Run release mail step" 17 | echo "component.mailto= ${component.mailto}" 18 | echo "component.body= ${component.body}" 19 | release_lib.release_mail(component) 20 | echo "Mail Sent" 21 | } -------------------------------------------------------------------------------- /jobs/release/release_input.groovy: -------------------------------------------------------------------------------- 1 | package release 2 | 3 | def jc=library('jenkins-commons') 4 | def release_lib = jc.org.hcm.libjenkins.Release.new(this) 5 | 6 | 7 | def component = [:] 8 | component.name = component.name ? component.name : 'component' 9 | component.namespace = component.namespace ? component.namespace : 'namespace' 10 | component.project = component.project ? component.project : 'namespace/component' 11 | component.src_ref = component.src_ref ? component.src_ref : 'master' 12 | component.target_ref = component.target_ref ? component.target_ref : 'master' 13 | component.mailto = component.mailto ? component.mailto : 'jhon.doe@example.com' 14 | 15 | node() { 16 | echo "Preparing for a release" 17 | release_lib.release_input([id: '123']) 18 | } 19 | -------------------------------------------------------------------------------- /jobs/template/release.groovy: -------------------------------------------------------------------------------- 1 | jc = library('jenkins-commons') 2 | 3 | release_lib = jc.org.hcm.libjenkins.Release.new(this) 4 | 5 | node() { 6 | echo "Hello World!" 7 | } 8 | 9 | return this 10 | -------------------------------------------------------------------------------- /jobs/template/semver.groovy: -------------------------------------------------------------------------------- 1 | jc = library('jenkins-commons') 2 | semver_lib = jc.org.hcm.libjenkins.Semver.new() 3 | 4 | node() { 5 | echo "Hello World!" 6 | } 7 | 8 | return this 9 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * This settings file was generated by the Gradle 'init' task. 3 | * 4 | * The settings file is used to specify which projects to include in your build. 5 | * In a single project build this file can be empty or even removed. 6 | * 7 | * Detailed information about configuring a multi-project build in Gradle can be found 8 | * in the user guide at https://docs.gradle.org/3.5/userguide/multi_project_builds.html 9 | */ 10 | 11 | /* 12 | // To declare projects as part of a multi-project build use the 'include' method 13 | include 'shared' 14 | include 'api' 15 | include 'services:webservice' 16 | */ 17 | 18 | rootProject.name = 'jenkins-commons' 19 | -------------------------------------------------------------------------------- /src/org/hcm/libjenkins/AbstractLibClass.groovy: -------------------------------------------------------------------------------- 1 | package org.hcm.libjenkins 2 | 3 | // Class declaration 4 | abstract class AbstractLibClass implements Serializable { 5 | public Script script 6 | 7 | AbstractLibClass ( script ) { 8 | this.script = script 9 | } 10 | 11 | AbstractLibClass () { 12 | this.script = null 13 | } 14 | } -------------------------------------------------------------------------------- /src/org/hcm/libjenkins/Release.groovy: -------------------------------------------------------------------------------- 1 | package org.hcm.libjenkins 2 | import groovy.transform.InheritConstructors 3 | 4 | 5 | // Class declaration 6 | @InheritConstructors 7 | class Release extends AbstractLibClass { 8 | 9 | /** 10 | * Sends release mail. It takes email body template from the appropriate 11 | * component field and processes it using groovy.text.StreamingTemplateEngine 12 | * 13 | * @argument Object component 14 | * 15 | * @note Mail template in component.body shouldn't contain any calls to pipeline methods 16 | * only static data, if you need to generate something please perform it before to 17 | * call release_mail 18 | * */ 19 | def release_mail(Object component) { 20 | String mailto = component.mailto ? component.mailto : "" 21 | 22 | String subject = component.subject ? component.subject : 23 | "${component.name}-${component.version} is out" 24 | 25 | String mimeType = component.mimeType ? component.mimeType : 'text/html' 26 | 27 | Map greet = component.greet ? component.greet : [ 28 | es_ES: '''Hola, ${component.name}-${component.version} ha sido lanzado''', 29 | en_EN: '''Hi, ${component.name}-${component.version} has been released''', 30 | ru_RU: '''Привет, ${component.name}-${component.version} построен''', 31 | de_DE: '''Hallo, ${component.name}-${component.version} wurde freigegeben''', 32 | uk_UK: '''Здрастуй, ${component.name}-${component.version} був випущений''' 33 | ] 34 | def random = new java.util.Random() 35 | def randomKey = (greet.keySet() as List)[random.nextInt(greet.size())] 36 | 37 | String body = component.body ? component.body : ''' 38 |

${GREET}

39 | 40 |

Release Artifacts

41 |

Build Artifacts: ${env.BUILD_URL}artifact

42 | ''' 43 | script.emailext(to: mailto, 44 | subject: subject, 45 | mimeType: mimeType, 46 | body: script.renderTemplate(body,[ 47 | "component":component, 48 | "env":script.env, 49 | "GREET":script.renderTemplate(greet[randomKey],[ 50 | "component":component, 51 | ]), 52 | ]) 53 | ) 54 | } 55 | 56 | /** 57 | * Wait user input to approve the load 58 | * @return Map [ newtag_ref: // Commit sha1 or branch or tag 59 | // where to place the new tag 60 | ,newtag: // New tag name 61 | ,prevtag // Previous tag name ] 62 | */ 63 | def release_input(options=[:]) { 64 | String newtag_ref = options.newtag_ref ? options.newtag_ref : "HEAD" 65 | String prevtag = options.prevtag ? options.prevtag : null 66 | String newtag = options.newtag ? options.newtag : null 67 | String id = options.id ? options.id : null 68 | 69 | return script.input(id: id, message:'Would you like to release the load?', 70 | parameters: [ 71 | script.string(name: 'newtag_ref', 72 | defaultValue: newtag_ref, 73 | description: 'Commit sha1 or branch or tag where to place the new tag'), 74 | script.string(name: 'newtag', 75 | defaultValue: '', 76 | description: '''New tag name will be calculated automaticaly if empty: 77 | if prevtag = 1.0.0 => newtag = 1.0.1'''), 78 | script.string(name: 'prevtag', 79 | defaultValue: '', 80 | description: 'Previous tag name will be retrived from the repository if empty ') 81 | ] // input parameters 82 | ) // input 83 | } 84 | //" 85 | 86 | 87 | } // Class 88 | 89 | -------------------------------------------------------------------------------- /src/org/hcm/libjenkins/Semver.groovy: -------------------------------------------------------------------------------- 1 | package org.hcm.libjenkins 2 | 3 | @Grab('com.github.zafarkhaja:java-semver:0.9.0') 4 | import com.github.zafarkhaja.semver.Version 5 | import groovy.transform.InheritConstructors 6 | 7 | // Class declaration 8 | @InheritConstructors 9 | class Semver extends AbstractLibClass { 10 | 11 | /** 12 | * Incremet semver value 13 | */ 14 | def increment_version(semver) { 15 | Version v = Version.valueOf(semver) 16 | return v.incrementPatchVersion().toString() 17 | } 18 | 19 | /** 20 | * Generate semver value. If some arguments are missed it uses git to retrive the values 21 | * @param tag {String} Nearest tag 22 | * @param patch_count {Integer} Number of commits beyond the tag 23 | * @param sha1_abr {String} Commit sha1 abbraviation 24 | * @return {String} semver value 25 | */ 26 | def extract_semver_git(tag=null, patch_count=null ,sha1_abr=null) { 27 | if(!tag) { 28 | try { 29 | script.sh "git describe --abbrev=0 HEAD 2>&1 |grep 'fatal: No names found, cannot describe anything.'" 30 | tag = "0.0.0" 31 | } catch (err) { 32 | } 33 | } 34 | 35 | if(!tag) { 36 | script.sh "git describe --abbrev=0 HEAD > .tag" 37 | tag = script.readFile('.tag' ).trim() 38 | script.sh("rm .tag") 39 | } 40 | 41 | if (!sha1_abr) { 42 | script.sh "git log -1 --format=%h HEAD > .sha1" 43 | sha1_abr = script.readFile('.sha1' ).trim() 44 | script.sh("rm .sha1") 45 | } 46 | 47 | if (!patch_count) { 48 | if (tag == "0.0.0") { 49 | script.sh "git rev-list HEAD |wc -l > .tagdist" 50 | } else { 51 | script.sh "git rev-list ${tag}..HEAD |wc -l > .tagdist" 52 | } 53 | patch_count = new Integer(script.readFile('.tagdist' ).trim()) 54 | script.sh("rm .tagdist") 55 | } 56 | 57 | Version.Builder builder = new Version.Builder(tag) 58 | if( patch_count && sha1_abr ){ 59 | builder.setBuildMetadata("build.${patch_count}.ref${sha1_abr}") 60 | } 61 | return builder.build().toString() 62 | } 63 | 64 | /** 65 | * Generate assemblyFileVersion version for a C# component. 66 | * The format of this filed is regulated by windows 67 | * maj min patch build_version 68 | * ushort.ushort.ushort.ushort 69 | * ushort is in a range if [0..65535] of integer values 70 | * if one of smever value is out of this range error is emmited 71 | * @param tag {String} semver value 72 | * @return {String} semver value 73 | */ 74 | def semver_to_assembly_file_version(semver) { 75 | Version v = Version.valueOf(semver) 76 | int major = v.getMajorVersion() // 1 77 | if ( major < 0 || major > 65535 ) { 78 | throw new IllegalArgumentException("$semver major value: $major is out of range") 79 | } 80 | 81 | int minor = v.getMinorVersion() // 0 82 | if ( minor < 0 || minor > 65535 ) { 83 | throw new IllegalArgumentException("$semver minor value: $minor is out of range") 84 | } 85 | 86 | int patch = v.getPatchVersion() // 0 87 | if ( patch < 0 || patch > 65535 ) { 88 | throw new IllegalArgumentException("$semver patch value: $patch is out of range") 89 | } 90 | 91 | int pre_release_count = 0 92 | String preRelease = v.getPreReleaseVersion().trim() // "rc.1" 93 | 94 | if(preRelease) { 95 | preRelease = preRelease.replaceAll(/rc.(\d+)/) { fullMatch -> 96 | "${fullMatch[1]}" 97 | } 98 | pre_release_count = preRelease ? new Integer(preRelease) : 0 99 | } 100 | int patch_count = 0 101 | String buildMeta = v.getBuildMetadata() // "build.1" 102 | if(buildMeta) { 103 | buildMeta = buildMeta.replaceAll(/build.(\d+)(.-ref.*)?/) { fullMatch -> 104 | "${fullMatch[1]}" 105 | } 106 | patch_count = buildMeta ? new Integer(buildMeta) : 0 107 | } 108 | 109 | int build_version = pre_release_count*1000+patch_count 110 | if ( build_version < 0 || build_version > 65535 ) { 111 | throw new IllegalArgumentException("$semver build_version value: $build_version is out of range") 112 | } 113 | 114 | return "${major}.${minor}.${patch}.${build_version}" 115 | } 116 | 117 | 118 | } 119 | -------------------------------------------------------------------------------- /test/integration/groovy/TestReleaseMail.groovy: -------------------------------------------------------------------------------- 1 | package it 2 | 3 | import com.gargoylesoftware.htmlunit.html.HtmlPage 4 | import com.mkobit.jenkins.pipelines.codegen.LocalLibraryRetriever 5 | import hudson.model.queue.QueueTaskFuture 6 | import jenkins.model.Jenkins 7 | import org.jenkinsci.plugins.workflow.cps.CpsFlowExecution 8 | import org.jenkinsci.plugins.workflow.libs.GlobalLibraries 9 | import org.jenkinsci.plugins.workflow.libs.LibraryConfiguration 10 | import org.jenkinsci.plugins.workflow.libs.LibraryRetriever 11 | import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition 12 | import org.jenkinsci.plugins.workflow.job.WorkflowJob 13 | import org.jenkinsci.plugins.workflow.job.WorkflowRun 14 | import org.jenkinsci.plugins.workflow.support.steps.input.InputAction 15 | import org.jenkinsci.plugins.workflow.support.steps.input.InputStepExecution 16 | import org.junit.Before 17 | import org.junit.Rule 18 | import org.junit.Test 19 | import org.jvnet.hudson.test.JenkinsRule 20 | import org.jvnet.hudson.test.MockAuthorizationStrategy 21 | import org.jvnet.hudson.test.recipes.WithTimeout 22 | import org.jvnet.mock_javamail.Mailbox 23 | 24 | import javax.mail.Message 25 | import javax.mail.internet.MimeMultipart 26 | 27 | import static org.junit.Assert.assertEquals 28 | import static org.junit.Assert.assertTrue 29 | 30 | class TestReleaseMail { 31 | 32 | @Rule 33 | public JenkinsRule rule = new JenkinsRule() { 34 | @Override 35 | public void before() throws Throwable { 36 | super.before() 37 | Mailbox.clearAll() 38 | } 39 | 40 | @Override 41 | public void after() throws Exception { 42 | super.after() 43 | Mailbox.clearAll() 44 | } 45 | } 46 | 47 | @Before 48 | void configureGlobalLibraries() { 49 | rule.timeout = 30 50 | final LibraryRetriever retriever = new LocalLibraryRetriever() 51 | final LibraryConfiguration localLibrary = 52 | new LibraryConfiguration('jenkins-commons', retriever) 53 | localLibrary.implicit = true 54 | localLibrary.defaultVersion = 'master' 55 | localLibrary.allowVersionOverride = true 56 | GlobalLibraries.get().setLibraries(Collections.singletonList(localLibrary)) 57 | Mailbox.clearAll(); 58 | } 59 | 60 | 61 | @Test 62 | void "verify release mail"() { 63 | 64 | WorkflowJob workflowJob = rule.createProject(WorkflowJob, 'test-release-mail') 65 | def script = new File('jobs/release/mail/basic.groovy') 66 | workflowJob.definition = new CpsFlowDefinition(script.text, true) 67 | 68 | WorkflowRun result = rule.buildAndAssertSuccess(workflowJob) 69 | rule.assertLogContains('Sending email to: jhon.doe@example.com', result) 70 | 71 | assertEquals(1, Mailbox.get("jhon.doe@example.com").getNewMessageCount()); 72 | Message message = Mailbox.get("jhon.doe@example.com").get(0); 73 | MimeMultipart part = (MimeMultipart) message.getContent(); 74 | assertTrue("Verify message body", part.getBodyPart(0).getInputStream().text.contains("Release Artifacts")) 75 | 76 | 77 | } 78 | 79 | 80 | @Test 81 | @WithTimeout(0) 82 | void "verify release input"() { 83 | 84 | JenkinsRule.WebClient webClient = rule.createWebClient() 85 | webClient.getOptions().setThrowExceptionOnFailingStatusCode(false) 86 | 87 | rule.jenkins.setSecurityRealm(rule.createDummySecurityRealm()) 88 | rule.jenkins.setAuthorizationStrategy(new MockAuthorizationStrategy(). 89 | grant(Jenkins.ADMINISTER).everywhere().to("admin") 90 | ); 91 | 92 | WorkflowJob workflowJob = rule.createProject(WorkflowJob, 'test-release-input') 93 | def script = new File('jobs/release/release_input.groovy') 94 | workflowJob.definition = new CpsFlowDefinition(script.text, true) 95 | 96 | runAndContinue(webClient, workflowJob, "admin", "123", true) 97 | } 98 | 99 | 100 | private void runAndContinue(JenkinsRule.WebClient webClient, WorkflowJob job, String loginAs, inputId, boolean expectContinueOk) throws Exception { 101 | // get the build going, and wait until workflow pauses 102 | QueueTaskFuture queueTaskFuture = job.scheduleBuild2(0); 103 | WorkflowRun run = queueTaskFuture.getStartCondition().get(); 104 | CpsFlowExecution execution = (CpsFlowExecution) run.getExecutionPromise().get(); 105 | println("DEBUG: started build ${execution}") 106 | while (run.getAction(InputAction.class) == null) { 107 | execution.waitForSuspension() 108 | } 109 | InputAction inputAction = run.getAction(InputAction.class); 110 | InputStepExecution is = inputAction.getExecution(inputId); 111 | println("DEBUG: InputStepExecution: ${is}") 112 | 113 | webClient.login(loginAs); 114 | HtmlPage p = webClient.getPage(run, inputAction.getUrlName()); 115 | 116 | rule.submit(p.getFormByName(is.getId()), "proceed"); 117 | assertEquals(0, inputAction.getExecutions().size()); 118 | queueTaskFuture.get(); 119 | 120 | assertTrue(expectContinueOk); 121 | rule.assertBuildStatusSuccess(rule.waitForCompletion(run)); // Should be successful. 122 | } 123 | 124 | } 125 | -------------------------------------------------------------------------------- /test/unit/groovy/TestHelloWorld.groovy: -------------------------------------------------------------------------------- 1 | //package ut 2 | 3 | 4 | import com.lesfurets.jenkins.unit.BasePipelineTest 5 | import com.lesfurets.jenkins.unit.MethodCall 6 | import org.junit.Before 7 | import org.junit.Rule 8 | import org.junit.Test 9 | import org.junit.rules.ExpectedException 10 | 11 | import static org.assertj.core.api.Assertions.assertThat 12 | 13 | class TestHelloWorld extends BasePipelineTest { 14 | 15 | @Rule 16 | public ExpectedException thrown = ExpectedException.none() 17 | 18 | @Override 19 | @Before 20 | void setUp() throws Exception { 21 | scriptRoots += 'jobs' 22 | super.setUp() 23 | } 24 | 25 | @Test 26 | void testHello() { 27 | runScript("hello.groovy") 28 | assertJobStatusSuccess() 29 | assertThat(helper.callStack.stream() 30 | .filter { c -> c.methodName ==~ /echo/ } 31 | .map(MethodCall.&callArgsToString) 32 | .findAll { s -> s =~ /Hello.*/ }) 33 | .hasSize(1) 34 | printCallStack() 35 | } 36 | } // class 37 | -------------------------------------------------------------------------------- /test/unit/groovy/TestJenkinsCommonLib.groovy: -------------------------------------------------------------------------------- 1 | 2 | import static com.lesfurets.jenkins.unit.global.lib.LibraryConfiguration.library 3 | import static com.lesfurets.jenkins.unit.global.lib.ProjectSource.projectSource 4 | 5 | import org.junit.Before 6 | import org.junit.Test 7 | 8 | import com.lesfurets.jenkins.unit.BasePipelineTest 9 | 10 | import com.lesfurets.jenkins.unit.MethodCall 11 | import static com.lesfurets.jenkins.unit.MethodCall.callArgsToString 12 | import static org.assertj.core.api.Assertions.assertThat 13 | import static org.junit.Assert.assertEquals 14 | 15 | class TestJenkinsCommonLib extends BasePipelineTest { 16 | 17 | String sharedLibs = '' 18 | 19 | @Override 20 | @Before 21 | void setUp() throws Exception { 22 | scriptRoots += 'jobs' 23 | super.setUp() 24 | def library = library().name('jenkins-commons') 25 | .defaultVersion('') 26 | .allowOverride(true) 27 | .implicit(false) 28 | .targetPath('') 29 | .retriever(projectSource()) 30 | .build() 31 | helper.registerSharedLibrary(library) 32 | } 33 | 34 | @Test 35 | void should_execute_without_errors() throws Exception { 36 | def script = runScript("template/semver.groovy") 37 | printCallStack() 38 | } 39 | 40 | @Test 41 | void verify_increment_version() throws Exception { 42 | def script = runScript("template/semver.groovy") 43 | assertEquals('Verify increment_version ', "1.2.4", script.semver_lib.increment_version('1.2.3')) 44 | printCallStack() 45 | } 46 | 47 | } 48 | -------------------------------------------------------------------------------- /test/unit/groovy/TestRelease.groovy: -------------------------------------------------------------------------------- 1 | //package ut 2 | 3 | 4 | import com.lesfurets.jenkins.unit.BasePipelineTest 5 | import org.junit.Before 6 | import org.junit.Rule 7 | import org.junit.Test 8 | import org.junit.rules.ExpectedException 9 | 10 | import static com.lesfurets.jenkins.unit.global.lib.LibraryConfiguration.library 11 | import static com.lesfurets.jenkins.unit.global.lib.ProjectSource.projectSource 12 | import static org.junit.Assert.assertEquals 13 | 14 | class TestRelease extends BasePipelineTest { 15 | 16 | @Rule 17 | public ExpectedException thrown = ExpectedException.none() 18 | 19 | @Override 20 | @Before 21 | void setUp() throws Exception { 22 | scriptRoots += 'jobs' 23 | super.setUp() 24 | 25 | def library = library().name('jenkins-commons') 26 | .defaultVersion('') 27 | .allowOverride(true) 28 | .implicit(false) 29 | .targetPath('') 30 | .retriever(projectSource()) 31 | .build() 32 | helper.registerSharedLibrary(library) 33 | 34 | 35 | binding.setVariable('env', [ 36 | BUILD_URL:"fake_jurl/", 37 | ]) 38 | 39 | } 40 | 41 | @Test 42 | void "Verify release mail with default fields"() { 43 | 44 | helper.registerAllowedMethod("emailext", [Map.class], {m->return m}) 45 | 46 | def script = runScript("jobs/template/release.groovy") 47 | 48 | def c = [ 49 | name:'fake_component', 50 | version: "1.2.3", 51 | gitlab_url: "fake_gitlab_url/", 52 | project: "fake/project", 53 | mailto: 'jhon.doe@example.com', 54 | ] 55 | 56 | def expected_mail_body = ''' 57 |

Hola, fake_component-1.2.3 ha sido lanzado

58 | 59 |

Release Artifacts

60 |

Build Artifacts: fake_jurl/artifact

61 | ''' 62 | Map mail 63 | def random_mock = new groovy.mock.interceptor.MockFor(java.util.Random) 64 | random_mock.demand.nextInt(){ 65 | Integer size -> println "Mocked random" 66 | return 0 67 | } 68 | random_mock.use { 69 | mail = script.release_lib.release_mail(c) 70 | } 71 | assertEquals('Verify to field', 'jhon.doe@example.com', mail.to) 72 | assertEquals('Verify subject field', (String) "${c.name}-${c.version} is out", mail.subject) 73 | assertEquals('Verify mimeType field', "text/html", mail.mimeType) 74 | assertEquals('Verify body field', expected_mail_body, mail.body) 75 | printCallStack() 76 | } 77 | } // class 78 | -------------------------------------------------------------------------------- /vars/gitlab_stage.groovy: -------------------------------------------------------------------------------- 1 | def call(_stages,_name, _node, _timeout, Closure _closure) { 2 | stage(_name) { 3 | if(_stages.contains(_name)) { 4 | gitlabCommitStatus(name: _name) { 5 | timeout(time: _timeout, unit: 'MINUTES') { 6 | node(_node) { 7 | _closure() 8 | } 9 | } 10 | } 11 | } else { 12 | updateGitlabCommitStatus name: _name, state: 'canceled' 13 | } 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /vars/renderTemplate.groovy: -------------------------------------------------------------------------------- 1 | /** 2 | * Process groovy template 3 | * @argument template string groovy template 4 | * @argument bindings any vars to be used in the template 5 | * @return string 6 | * 7 | * @note template shouldn't contain any calls to pipeline methods 8 | * only static data, if you need to generate something please perform it before to 9 | * call renderTemplate 10 | * */ 11 | def call(String template, Map bindings){ 12 | def engine = new groovy.text.StreamingTemplateEngine() 13 | return engine.createTemplate(template).make(bindings).toString() 14 | } --------------------------------------------------------------------------------