analogj/job-dsl-gradle-example

An example Job DSL project that uses Gradle for building and testing.

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

.
├── jobs                    # DSL script files
├── resources               # resources for DSL scripts
├── src
│   ├── main
│   │   ├── groovy          # support classes
│   │   └── resources
│   │       └── idea.gdsl   # IDE support for IDEA
│   └── 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.

Debug XML

./gradlew debugXml -Dpattern=jobs/**/*Jobs.groovy runs the DSL and writes the XML output to files to build/debug-xml.

This can be useful if you want to inspect the generated XML before check-in.

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
• Invoke Gradle script → Tasks: clean test
• Process Job DSLs → DSL Scripts: jobs/**/*Jobs.groovy
• Process Job DSLs → Additional classpath: src/main/groovy
• Publish JUnit test result report → Test report XMLs: build/test-results/**/*.xml

REST API Runner

A gradle task is configured that can be used to create/update jobs via the Jenkins REST API, if desired. Normally a seed job is used to keep jobs in sync with the DSL, but this runner might be useful if you'd rather process the DSL outside of the Jenkins environment or if you want to create the seed job from a DSL script.

./gradlew rest -Dpattern=<pattern> -DbaseUrl=<baseUrl> [-Dusername=<username>] [-Dpassword=<password>]

• pattern - ant-style path pattern of files to include
• baseUrl - base URL of Jenkins server
• username - Jenkins username, if secured
• password - Jenkins password or token, if secured