The document discusses the Job DSL plugin for Jenkins, which allows configuring Jenkins jobs using Groovy scripts instead of the graphical user interface. It describes how to create job templates in Groovy, process them with the Job DSL plugin to generate jobs, and configure properties and views. Using the plugin saves time compared to manual configuration and allows treating job definitions as code.

1. Job DSL Plugin for
Jenkins CI
by Nikita Bugrovsky
Devops Consultant at DevOps Israel
02/18/2015
www.devops.co.il

2. How Simple is Your Workflow?
or

3. If Workflow is Complex...
Can You remember Details?!

4. If Workflow is Complex...
More fun: You Have to Do It with a Mouse!

5. If Workflow is Complex...
Hidden Configuration

6. Job DSL Plugin to the Rescue!
Groovy

7. How to use Job DSL Plugin?

8. Create templates of the jobs
job {
name "Some_Name"
displayName "Some display name"
customWorspace
scm {}
parameters{}
wrappers{} // build environment configuration
steps{}
publishers{} // post compilation steps
configure {}
}

9. Create free-style project in Jenkins

10. Add SCM with Job Templates

11. Add “Process Job DSL Step”

12. "Build result" page will list the jobs
Test-Project-1
Test-Project-2
Test-Project-3
Test-Project-4
Test-Project-5
Test-Project-6

13. Job DSL Plugin: Groovy -> XML -> GUI
job {
name "Test_Project"
scm {
git("git@github.com:YourOrganization/your-repo.git")
}
}

14. <project>
<scm class="hudson.plugins.git.GitSCM" plugin="git@2.3.4">
<userRemoteConfigs>
<hudson.plugins.git.UserRemoteConfig>
<url>
git@github.com:YourOrg/your-repo.git
</url>
</hudson.plugins.git.UserRemoteConfig>
</userRemoteConfigs>
<branches>
<hudson.plugins.git.BranchSpec>
<name>*/master</name>
</hudson.plugins.git.BranchSpec>
</branches>
</scm>
</project>
Job DSL Plugin: Groovy -> XML -> GUI

15. Job DSL Plugin: Groovy -> XML -> GUI

16. Configure {} Block
GUI<project>
<properties>
<class="com.example.Test">
<switch>
on
</switch>
</class>
</properties>
</project>

17. Configure {} Block
job {
name "Test_Project"
configure {
it / "properties" / "com.example.Test" {
"switch"("on")
}
}
}

18. JsonSlurper
def project = 'YourProject/build-project'
def branchApi = new URL("https://api.github.com/repos/${project}/branches")
def branches = new groovy.json.JsonSlurper().parse(branchApi.newReader())
branches.each {
def branchName = it.name
job {
name "${project}-${branchName}".replaceAll('/','-')
scm {
git("git://github.com/${project}.git", branchName)
}
}
}

19. Single Point of Configuration
evaluate(new File("/path/to/GlobalConfig.groovy"))
job {
name NewName
}
NewName = "Test_Job"

20. Iterate Over Job Names
def job_prefixes = ["CI", "NB"]
// Configure the jobs for each job preffix - "CI", "NB"
job_prefixes.each() {
def job_prefix = it
job {
name "${job_prefix}"
}
}

21. Views
job {
view(type: ListView) {
name('Mcr')
description('This View displays Mcr jobs')
filterBuildQueue()
filterExecutors()
jobs {
regex('Mcr.+')
}
}
}

22. ● SCM to Control Code/Trace Changes
● Write/Refactor Jobs via Groovy Code
● Save time -> PROFIT!
Job DSL Plugin: Benefits

23. Useful links
● DSL to XML online https://job-
dsl.herokuapp.com/
● Job DSL Wiki
https://github.com/jenkinsci/job-dsl-
plugin/wiki
● Groovy Docs
http://groovy.codehaus.org/Documentation