Jenkins Job DSL Gradle Example

An example Job DSL project that uses Gradle for building and testing. Check out this presentation for a walkthrough of this example (starts around 14:00).

File structure

.
├── src
│   ├── jobs                # DSL script files
│   ├── main
│   │   ├── groovy          # support classes
│   │   └── resources
│   │       └── idea.gdsl   # IDE support for IDEA
│   ├── scripts             # scripts to use with "readFileFromWorkspace"
│   └── test
│       └── groovy          # specs
└── build.gradle            # build file

Script Examples

• Example 1 - shows basic folder/job creation
• Example 2 - shows how to create a set of jobs for each github branch, each in its own folder
• Example 3 - shows how to use the configure block
• Example 4 - shows a way to reuse job definitions for jobs that differ only with a few properties
• Example 5 - shows how to pull out common components into static methods
• Example 6 - shows how to include script resources from the workspace
• Example 7 - shows how to create jobs using builders
• Example 8 - shows how to use DSL extensions provided by other plugins

Testing

./gradlew test runs the specs.

JobScriptsSpec will loop through all DSL files and make sure they don't throw any exceptions when processed. All XML output files are written to build/debug-xml. This can be useful if you want to inspect the generated XML before check-in. Plugins providing auto-generated DSL must be added to the build dependencies.

If you prefer to stub the auto-generated DSL, you can use JobScriptsSpecAlternative, though you may miss some syntax errors.

Seed Job

You can create the example seed job via the Rest API Runner (see below) using the pattern jobs/seed.groovy.

Or manually create a job with the same structure:

• Invoke Gradle script
  • Use Gradle Wrapper: true
  • Tasks: clean test
• Process Job DSLs
  • DSL Scripts: src/jobs/**/*Jobs.groovy
  • Additional classpath: src/main/groovy
• Publish JUnit test result report
  • Test report XMLs: build/test-results/**/*.xml

Note that starting with Job DSL 1.60 the "Additional classpath" setting is not available when Job DSL script security is enabled.

Other Resources

• Job DSL Playground - App for debugging Job DSL scripts.
• Job DSL API Viewer - Full Job DSL syntax reference.
• Job DSL REST Example - Example that shows how to make Job DSL updates via the Jenkins REST API. Originally part of this repo, later split off.

Gradle Plugins

Plugins that automatically apply the functionality laid out in this example repo.

• Gradle Job DSL Support Plugin - Plugin for easy management of Jenkins Job DSL scripts with Gradle.
• Gradle Jenkins Job DSL Plugin - Plugin to manage Jenkins Job DSL projects in a Gradle project.