This repo is for Candlepin Jenkins Job DSL files.
.
├── 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
This repo is based off the Job DSL example project. Examples have been moved to the jobs/examples folder for reference. Check out this presentation for a walkthrough of this example (starts around 14:00).
./gradlew test
runs the specs.
JobScriptsSpec will loop through all DSL files and make sure they don't throw any exceptions when processed.
./gradlew debugXml -Dpattern=jobs/**/*Job.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.
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/**/*Job.groovy
- Process Job DSLs → Additional classpath:
src/main/groovy
- Publish JUnit test result report → Test report XMLs:
build/test-results/**/*.xml
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 includebaseUrl
- base URL of Jenkins serverusername
- Jenkins username, if securedpassword
- Jenkins password or token, if secured
vagrant up
with vagrant installed will spawn a VM that runs an instance of
Jenkins, with necessary plugins and a modified seed job that will generate the
jobs based on the vagrant shared folder (the top-level directory of this repo).
Using this, you can make changes, run vagrant rsync
, run the seed job, and
see the results.
If you would like to test the jobs against your own repos, you can set CANDLEPIN_JENKINS_GITHUB_ORG
to your username
(or another org where appropriate repos exist).