As you probably know, Jenkins is highly configurable CI server. We can setup different custom build process. And I’m going to share some approach I’ve been using to setup the hierarchy of Jenkins’ jobs. Here is use case:
- We have one main entry job which is invoked to start the whole build process.
- This job can have from one to many child jobs. (Level 2)
- Each child job can have from one to many child jobs, aslo. (Level 3)
- The main idea is to collect/aggregate all children jobs’ status into main entry job.
See sample screenshot below which visualize the general idea. Here:
- Main_Job is single entry job, which must contain all sibling jobs statuses
- Job_Set_1 and Job_Set_2 are two child jobs
- Build_[1-4] are child jobs of Job_Set_1
- Tests_[1-3] are child jobs of Job_Set_2
Now, we should use some Jenkins plugin to build such hierarchy. I’ve been using Multijob Plugin. See below screenshots of configuration for:
Main_Job/configure
Job_Set_1/configure
Job_Set_2/configure
But, it’s not enough. We have to aggregate statuses into Main_Job from all sibling jobs. I’ve been using patched Groovy Postbuild Plugin. Modified plugin is located here https://github.com/halyph/groovy-postbuild-plugin Groovy Postbuild Plugin allows us to write groovy scripts for job’s Post-build Actions. This script has access to whole Jenkins environment and can consume functionality of all installed Jenkins plugin:
Here is the source of this script:
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 | import hudson.model.*import com.tikal.jenkins.plugins.multijob.*;void log(msg) { manager.listener.logger.println(msg)}threshold = Result.SUCCESSvoid aggregate_results() { failed = false mainJob = manager.build.getProject().getName() job = hudson.model.Hudson.instance.getItem(mainJob) log '-------------------------------------------------------------------------------------' log 'Aggregated status report' log '-------------------------------------------------------------------------------------' log('${mainJob} #${manager.build.getNumber()} - ${manager.build.getResult()}') job.getLastBuild().getSubBuilds().each { subBuild-> subJob = subBuild.getJobName() subJobNumber = subBuild.getBuildNumber() job = hudson.model.Hudson.instance.getItem(subBuild.getJobName()) log '${subJob} #${subJobNumber} - ${job.getLastCompletedBuild().getResult()}' log job.getLastCompletedBuild().getLog() //println subBuild dePhaseJob = hudson.model.Hudson.instance.getItem(subBuild.getJobName()) dePhaseJobBuild = dePhaseJob.getBuildByNumber(subBuild.getBuildNumber()) dePhaseJobBuild.getSubBuilds().each { childSubBuild -> try { log ' ${childSubBuild.jobName}' job = hudson.model.Hudson.instance.getItem(childSubBuild.getJobName()) build = job.getBuildByNumber(childSubBuild.getBuildNumber()) indent = ' ' log '${indent} #${build.getNumber()} - ${build.getResult()}' log build.getLog() if(!failed && build.getResult().isWorseThan(threshold) ) { failed = true } } catch (Exception e) { log('ERROR: ${e.getMessage()}') failed = true } } } if(failed) {manager.build.setResult(hudson.model.Result.FAILURE)}}try { aggregate_results()} catch(Exception e) { log('ERROR: ${e.message}') log('ERROR: Failed Status report aggregation') manager.build.setResult(hudson.model.Result.FAILURE)} |
You can find it on GitHub Gist also: https://gist.github.com/4610274.
This script is pretty dumb. It simply extracts (prints in Main_Job console) the next info for each child jobs:
- job name
- build nubmer
- build result (status)
- build log
Also, it has ability to set the Main_Job status based on statuses of child jobs. See threshold variable in script. And aggregated report looks like this:
001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051 052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087 088 089 090 091 092 093 094 095 096 097 098 099 100 101 102 103 104 105 106 | Started by user anonymousBuilding in workspace C:\Users\oivasiv\.jenkins\jobs\Main_Job\workspaceStarting build job Job_Set_1.Finished Build : #8 of Job : Job_Set_1 with status :SUCCESSStarting build job Job_Set_2.Finished Build : #8 of Job : Job_Set_2 with status :SUCCESS-------------------------------------------------------------------------------------Aggregated status report-------------------------------------------------------------------------------------Main_Job #8 - SUCCESSJob_Set_1 #8 - SUCCESSStarted by upstream project 'Main_Job' build number 8Building in workspace C:\Users\oivasiv\.jenkins\jobs\Job_Set_1\workspaceStarting build job Build_1.Starting build job Build_2.Finished Build : #8 of Job : Build_1 with status :FAILUREFinished Build : #8 of Job : Build_2 with status :SUCCESSStarting build job Build_3.Starting build job Build_4.Finished Build : #6 of Job : Build_3 with status :UNSTABLEFinished Build : #6 of Job : Build_4 with status :SUCCESSNotifying upstream projects of job completionFinished: SUCCESS Build_1 #8 - FAILUREStarted by upstream project 'Job_Set_1' build number 8Building in workspace C:\Users\oivasiv\.jenkins\jobs\Build_1\workspaceSetting result to [Failed]Build step 'Set the build result' changed build result to FAILUREBuild step 'Set the build result' marked build as failureNotifying upstream projects of job completionFinished: FAILURE Build_2 #8 - SUCCESSStarted by upstream project 'Job_Set_1' build number 8Building in workspace C:\Users\oivasiv\.jenkins\jobs\Build_2\workspaceSetting result to [Success]Build step 'Set the build result' changed build result to SUCCESS>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>nullNotifying upstream projects of job completionFinished: SUCCESS Build_3 #6 - UNSTABLEStarted by upstream project 'Job_Set_1' build number 8Building in workspace C:\Users\oivasiv\.jenkins\jobs\Build_3\workspaceSetting result to [Unstable]Build step 'Set the build result' changed build result to UNSTABLENotifying upstream projects of job completionFinished: UNSTABLE Build_4 #6 - SUCCESSStarted by upstream project 'Job_Set_1' build number 8Building in workspace C:\Users\oivasiv\.jenkins\jobs\Build_4\workspaceSetting result to [Success]Build step 'Set the build result' changed build result to SUCCESSNotifying upstream projects of job completionFinished: SUCCESSJob_Set_2 #8 - SUCCESSStarted by upstream project 'Main_Job' build number 8Building in workspace C:\Users\oivasiv\.jenkins\jobs\Job_Set_2\workspaceStarting build job Test_1.Finished Build : #8 of Job : Test_1 with status :SUCCESSStarting build job Test_2.Finished Build : #8 of Job : Test_2 with status :UNSTABLEStarting build job Test_3.Finished Build : #8 of Job : Test_3 with status :SUCCESSNotifying upstream projects of job completionFinished: SUCCESS Test_1 #8 - SUCCESSStarted by upstream project 'Job_Set_2' build number 8Building in workspace C:\Users\oivasiv\.jenkins\jobs\Test_1\workspaceSetting result to [Success]Build step 'Set the build result' changed build result to SUCCESSNotifying upstream projects of job completionFinished: SUCCESS Test_2 #8 - UNSTABLEStarted by upstream project 'Job_Set_2' build number 8Building in workspace C:\Users\oivasiv\.jenkins\jobs\Test_2\workspaceSetting result to [Unstable]Build step 'Set the build result' changed build result to UNSTABLENotifying upstream projects of job completionFinished: UNSTABLE Test_3 #8 - SUCCESSStarted by upstream project 'Job_Set_2' build number 8Building in workspace C:\Users\oivasiv\.jenkins\jobs\Test_3\workspaceSetting result to [Success]Build step 'Set the build result' changed build result to SUCCESSNotifying upstream projects of job completionFinished: SUCCESSBuild step 'Groovy Postbuild' changed build result to FAILUREBuild step 'Groovy Postbuild' marked build as failureNotifying upstream projects of job completionFinished: FAILURE |
So, what are the benefits of such jobs status aggregation and Groovy post-processing:
- we have jobs status in one place
- e-mail notification sent from Main_Job contains this status
- ability to implement any custom post-processing logic
- ability to re-use the other plugins features via groovy scrip
Reference: Jenkins hierarchical jobs and jobs status aggregation from our JCG partner Orest Ivasiv at the Knowledge Is Everything blog.
Do you want to know how to develop your skillset to become a Java Rockstar?
Subscribe to our newsletter to start Rocking right now!
To get you started we give you our best selling eBooks for FREE!
1. JPA Mini Book
2. JVM Troubleshooting Guide
3. JUnit Tutorial for Unit Testing
4. Java Annotations Tutorial
5. Java Interview Questions
6. Spring Interview Questions
7. Android UI Design
and many more ....
I agree to the Terms and Privacy Policy
Hi there,
I get this error when I am trying this code. Can you helo me fix this?
ERROR: No signature of method: hudson.maven.MavenModuleSetBuild.getSubBuilds() is applicable for argument types: () values: []
Possible solutions: getNextBuild(), getNextBuild(), getRootBuild(), getModuleBuilds()
ERROR: Failed Status report aggregation
Build step ‘Groovy Postbuild’ changed build result to FAILURE
Build step ‘Groovy Postbuild’ marked build as failure