├── .gitignore ├── settings.gradle ├── src └── org │ └── somecompany │ ├── ioc │ ├── IContext.groovy │ ├── DefaultContext.groovy │ └── ContextRegistry.groovy │ ├── IStepExecutor.groovy │ ├── StepExecutor.groovy │ └── build │ └── MsBuild.groovy ├── vars └── ex_msbuild.groovy ├── LICENSE ├── jenkins-shared-library.iml ├── test └── org │ └── somecompany │ └── build │ └── MsBuildTest.java ├── README.md ├── gradlew.bat └── gradlew /.gitignore: -------------------------------------------------------------------------------- 1 | /out 2 | /gradle 3 | /build 4 | /.gradle -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'jenkins-shared-library' 2 | 3 | -------------------------------------------------------------------------------- /src/org/somecompany/ioc/IContext.groovy: -------------------------------------------------------------------------------- 1 | package org.somecompany.ioc 2 | 3 | import org.somecompany.IStepExecutor 4 | 5 | interface IContext { 6 | IStepExecutor getStepExecutor() 7 | } 8 | -------------------------------------------------------------------------------- /src/org/somecompany/IStepExecutor.groovy: -------------------------------------------------------------------------------- 1 | package org.somecompany 2 | 3 | /** 4 | * Interface for calling any necessary Jenkins steps. This will be mocked in unit tests. 5 | */ 6 | interface IStepExecutor { 7 | int sh(String command) 8 | void error(String message) 9 | } 10 | -------------------------------------------------------------------------------- /vars/ex_msbuild.groovy: -------------------------------------------------------------------------------- 1 | import org.somecompany.build.MsBuild 2 | import org.somecompany.ioc.ContextRegistry 3 | 4 | /** 5 | * Example custom step for easy use of MsBuild inside Jenkinsfiles 6 | * @param solutionPath Path to .sln file 7 | * @return 8 | */ 9 | def call(String solutionPath) { 10 | ContextRegistry.registerDefaultContext(this) 11 | 12 | def msbuilder = new MsBuild(solutionPath) 13 | msbuilder.build() 14 | } -------------------------------------------------------------------------------- /src/org/somecompany/ioc/DefaultContext.groovy: -------------------------------------------------------------------------------- 1 | package org.somecompany.ioc 2 | 3 | import org.somecompany.IStepExecutor 4 | import org.somecompany.StepExecutor 5 | 6 | class DefaultContext implements IContext, Serializable { 7 | private _steps 8 | 9 | DefaultContext(steps) { 10 | this._steps = steps 11 | } 12 | 13 | @Override 14 | IStepExecutor getStepExecutor() { 15 | return new StepExecutor(this._steps) 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /src/org/somecompany/StepExecutor.groovy: -------------------------------------------------------------------------------- 1 | package org.somecompany 2 | 3 | class StepExecutor implements IStepExecutor { 4 | private _steps 5 | 6 | StepExecutor(steps) { 7 | this._steps = steps 8 | } 9 | 10 | @Override 11 | int sh(String command) { 12 | this._steps.sh returnStatus: true, script: "${command}" 13 | } 14 | 15 | @Override 16 | void error(String message) { 17 | this._steps.error(message) 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/org/somecompany/ioc/ContextRegistry.groovy: -------------------------------------------------------------------------------- 1 | package org.somecompany.ioc 2 | 3 | class ContextRegistry implements Serializable { 4 | private static IContext _context 5 | 6 | static void registerContext(IContext context) { 7 | _context = context 8 | } 9 | 10 | static void registerDefaultContext(Object steps) { 11 | _context = new DefaultContext(steps) 12 | } 13 | 14 | static IContext getContext() { 15 | return _context 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE 2 | Version 2, December 2004 3 | 4 | Copyright (C) 2004 Sam Hocevar 5 | 6 | Everyone is permitted to copy and distribute verbatim or modified 7 | copies of this license document, and changing it is allowed as long 8 | as the name is changed. 9 | 10 | DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE 11 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 12 | 13 | 0. You just DO WHAT THE FUCK YOU WANT TO. -------------------------------------------------------------------------------- /src/org/somecompany/build/MsBuild.groovy: -------------------------------------------------------------------------------- 1 | package org.somecompany.build 2 | 3 | import org.somecompany.IStepExecutor 4 | import org.somecompany.ioc.ContextRegistry 5 | 6 | /** 7 | * Example class (without proper implementation) for using the MsBuild tool for building .NET projects. 8 | */ 9 | class MsBuild implements Serializable { 10 | private String _solutionPath 11 | 12 | MsBuild(String solutionPath) { 13 | _solutionPath = solutionPath 14 | } 15 | 16 | void build() { 17 | IStepExecutor steps = ContextRegistry.getContext().getStepExecutor() 18 | 19 | int returnStatus = steps.sh("echo \"building ${this._solutionPath}...\"") 20 | if (returnStatus != 0) { 21 | steps.error("Some error") 22 | } 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /jenkins-shared-library.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /test/org/somecompany/build/MsBuildTest.java: -------------------------------------------------------------------------------- 1 | package org.somecompany.build; 2 | 3 | import org.somecompany.IStepExecutor; 4 | import org.somecompany.ioc.ContextRegistry; 5 | import org.somecompany.ioc.IContext; 6 | import org.junit.Before; 7 | import org.junit.Test; 8 | 9 | import static org.mockito.Mockito.*; 10 | 11 | /** 12 | * Example test class 13 | */ 14 | public class MsBuildTest { 15 | private IContext _context; 16 | private IStepExecutor _steps; 17 | 18 | @Before 19 | public void setup() { 20 | _context = mock(IContext.class); 21 | _steps = mock(IStepExecutor.class); 22 | 23 | when(_context.getStepExecutor()).thenReturn(_steps); 24 | 25 | ContextRegistry.registerContext(_context); 26 | } 27 | 28 | @Test 29 | public void build_callsShStep() { 30 | // prepare 31 | String solutionPath = "some/path/to.sln"; 32 | MsBuild builder = new MsBuild(solutionPath); 33 | 34 | // execute 35 | builder.build(); 36 | 37 | // verify 38 | verify(_steps).sh(anyString()); 39 | } 40 | 41 | @Test 42 | public void build_shStepReturnsStatusNotEqualsZero_callsErrorStep() { 43 | // prepare 44 | String solutionPath = "some/path/to.sln"; 45 | MsBuild builder = new MsBuild(solutionPath); 46 | 47 | when(_steps.sh(anyString())).thenReturn(-1); 48 | 49 | // execute 50 | builder.build(); 51 | 52 | // verify 53 | verify(_steps).error(anyString()); 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Jenkins Shared Pipeline Example with Unit Tests 2 | 3 | This repository contains a example shared library for Jenkins that can be unit tested with JUnit and Mockito. The general idea is: 4 | 5 | 1. Keep the custom steps inside `vars` as small as possible and without any logic. Instead do everything inside classes (inside `src`). 6 | 2. Create an interface `IStepExecutor` which declares methods for all required Jenkins steps (sh, bat, error, etc.). The classes call steps only through this interface. 7 | 3. Write unit tests for your classes like you normally would. Use your favorite mocking and dependency framework to mock IStepExecutor. 8 | 9 | This way you should be able to: 10 | 11 | * Compile and execute your library/unit tests without Jenkins 12 | * Test that your classes work as intended 13 | * Test that Jenkins steps are called with the right parameters 14 | * Test the behaviour of your code when a Jenkins step fails 15 | * Build, test, run metrics and deploy your Jenkins Pipeline Library through Jenkins itself 16 | 17 | I suggest the IntelliJ IDEA for the least painful Jenkins Shared Library development experience ;) 18 | 19 | Head over to my [blog post](https://dev.to/kuperadrian/how-to-setup-a-unit-testable-jenkins-shared-pipeline-library-2e62) on dev.to if you want a tutorial/more detailed explanation. 20 | 21 | ## Example Jenkinsfile 22 | 23 | ``` 24 | // add the following line and replace necessary values if you are not loading the library implicitly 25 | // @Library('my-library@master') _ 26 | 27 | pipeline { 28 | agent any 29 | stages { 30 | stage('build') { 31 | steps { 32 | ex_msbuild 'test' 33 | } 34 | } 35 | } 36 | } 37 | ``` 38 | 39 | ## License 40 | 41 | Good ol' WTFPL 42 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------