| 1 | #!groovy |
|---|
| 2 | |
|---|
| 3 | //=========================================================================================================== |
|---|
| 4 | // Main loop of the compilation |
|---|
| 5 | //=========================================================================================================== |
|---|
| 6 | node ('master'){ |
|---|
| 7 | |
|---|
| 8 | boolean bIsSandbox = env.BRANCH_NAME == "jenkins-sandbox" |
|---|
| 9 | def err = null |
|---|
| 10 | def log_needed = false |
|---|
| 11 | |
|---|
| 12 | compiler = null |
|---|
| 13 | architecture = '' |
|---|
| 14 | |
|---|
| 15 | do_alltests = false |
|---|
| 16 | do_benchmark = false |
|---|
| 17 | do_doc = false |
|---|
| 18 | do_publish = false |
|---|
| 19 | |
|---|
| 20 | currentBuild.result = "SUCCESS" |
|---|
| 21 | |
|---|
| 22 | try { |
|---|
| 23 | //Wrap build to add timestamp to command line |
|---|
| 24 | wrap([$class: 'TimestamperBuildWrapper']) { |
|---|
| 25 | |
|---|
| 26 | //Prevent the build from exceeding 60 minutes |
|---|
| 27 | timeout(60) { |
|---|
| 28 | |
|---|
| 29 | notify() |
|---|
| 30 | |
|---|
| 31 | prepare_build() |
|---|
| 32 | |
|---|
| 33 | checkout() |
|---|
| 34 | |
|---|
| 35 | build() |
|---|
| 36 | |
|---|
| 37 | test() |
|---|
| 38 | |
|---|
| 39 | benchmark() |
|---|
| 40 | |
|---|
| 41 | clean() |
|---|
| 42 | |
|---|
| 43 | build_doc() |
|---|
| 44 | |
|---|
| 45 | publish() |
|---|
| 46 | |
|---|
| 47 | notify() |
|---|
| 48 | } |
|---|
| 49 | } |
|---|
| 50 | } |
|---|
| 51 | |
|---|
| 52 | //If an exception is caught we need to change the status and remember to |
|---|
| 53 | //attach the build log to the email |
|---|
| 54 | catch (Exception caughtError) { |
|---|
| 55 | //rethrow error later |
|---|
| 56 | err = caughtError |
|---|
| 57 | |
|---|
| 58 | //An error has occured, the build log is relevent |
|---|
| 59 | log_needed = true |
|---|
| 60 | |
|---|
| 61 | //Store the result of the build log |
|---|
| 62 | currentBuild.result = "${status_prefix} FAILURE".trim() |
|---|
| 63 | } |
|---|
| 64 | |
|---|
| 65 | finally { |
|---|
| 66 | echo 'Build Completed' |
|---|
| 67 | |
|---|
| 68 | //Send email with final results if this is not a full build |
|---|
| 69 | if( !do_sendemail && !bIsSandbox ) { |
|---|
| 70 | echo 'Notifying users of result' |
|---|
| 71 | email(currentBuild.result, log_needed) |
|---|
| 72 | } |
|---|
| 73 | |
|---|
| 74 | /* Must re-throw exception to propagate error */ |
|---|
| 75 | if (err) { |
|---|
| 76 | throw err |
|---|
| 77 | } |
|---|
| 78 | } |
|---|
| 79 | } |
|---|
| 80 | |
|---|
| 81 | //=========================================================================================================== |
|---|
| 82 | // Helper classes/variables/routines |
|---|
| 83 | //=========================================================================================================== |
|---|
| 84 | //Helper routine to collect information about the git history |
|---|
| 85 | def collect_git_info() { |
|---|
| 86 | |
|---|
| 87 | //create the temporary output directory in case it doesn't already exist |
|---|
| 88 | def out_dir = pwd tmp: true |
|---|
| 89 | sh "mkdir -p ${out_dir}" |
|---|
| 90 | |
|---|
| 91 | //parse git logs to find what changed |
|---|
| 92 | gitRefName = env.BRANCH_NAME |
|---|
| 93 | dir("../${gitRefName}@script") { |
|---|
| 94 | sh "git reflog > ${out_dir}/GIT_COMMIT" |
|---|
| 95 | } |
|---|
| 96 | git_reflog = readFile("${out_dir}/GIT_COMMIT") |
|---|
| 97 | gitRefOldValue = (git_reflog =~ /moving from (.+) to (.+)/)[0][1] |
|---|
| 98 | gitRefNewValue = (git_reflog =~ /moving from (.+) to (.+)/)[0][2] |
|---|
| 99 | } |
|---|
| 100 | |
|---|
| 101 | def prepare_build() { |
|---|
| 102 | properties ([ \ |
|---|
| 103 | [$class: 'ParametersDefinitionProperty', \ |
|---|
| 104 | parameterDefinitions: [ \ |
|---|
| 105 | [$class: 'ChoiceParameterDefinition', \ |
|---|
| 106 | description: 'Which compiler to use', \ |
|---|
| 107 | name: 'param_compiler', \ |
|---|
| 108 | choices: 'gcc-6\ngcc-5\ngcc-4.9\nclang', \ |
|---|
| 109 | defaultValue: 'gcc-6', \ |
|---|
| 110 | ], \ |
|---|
| 111 | [$class: 'ChoiceParameterDefinition', \ |
|---|
| 112 | description: 'The target architecture', \ |
|---|
| 113 | name: 'param_arch', \ |
|---|
| 114 | choices: '64-bit\n32-bit', \ |
|---|
| 115 | defaultValue: '64-bit', \ |
|---|
| 116 | ], \ |
|---|
| 117 | [$class: 'BooleanParameterDefinition', \ |
|---|
| 118 | description: 'If false, only the quick test suite is ran', \ |
|---|
| 119 | name: 'param_allTests', \ |
|---|
| 120 | defaultValue: false, \ |
|---|
| 121 | ], \ |
|---|
| 122 | [$class: 'BooleanParameterDefinition', \ |
|---|
| 123 | description: 'If true, jenkins also runs benchmarks', \ |
|---|
| 124 | name: 'param_benchmark', \ |
|---|
| 125 | defaultValue: false, \ |
|---|
| 126 | ], \ |
|---|
| 127 | [$class: 'BooleanParameterDefinition', \ |
|---|
| 128 | description: 'If true, jenkins also builds documentation', \ |
|---|
| 129 | name: 'param_doc', \ |
|---|
| 130 | defaultValue: false, \ |
|---|
| 131 | ], \ |
|---|
| 132 | [$class: 'BooleanParameterDefinition', \ |
|---|
| 133 | description: 'If true, jenkins also publishes results', \ |
|---|
| 134 | name: 'param_publish', \ |
|---|
| 135 | defaultValue: false, \ |
|---|
| 136 | ], \ |
|---|
| 137 | ], |
|---|
| 138 | ]]) |
|---|
| 139 | |
|---|
| 140 | compiler = compiler_from_params( param_compiler ) |
|---|
| 141 | architecture = architecture_from_params( param_arch ) |
|---|
| 142 | |
|---|
| 143 | do_alltests = param_allTests .toBoolean() |
|---|
| 144 | do_benchmark = param_benchmark .toBoolean() |
|---|
| 145 | do_doc = param_doc .toBoolean() |
|---|
| 146 | do_publish = param_publish .toBoolean() |
|---|
| 147 | |
|---|
| 148 | echo """Compiler : ${compiler.name} (${compiler.cpp_cc}/${compiler.cfa_cc}) |
|---|
| 149 | Architecture : ${architecture} |
|---|
| 150 | Run All Tests : ${ param_allTests.toString() } |
|---|
| 151 | Run Benchmark : ${ param_benchmark.toString() } |
|---|
| 152 | Build Documentation : ${ param_doc.toString() } |
|---|
| 153 | Publish : ${ param_publish.toString() } |
|---|
| 154 | """ |
|---|
| 155 | |
|---|
| 156 | collect_git_info() |
|---|
| 157 | } |
|---|
| 158 | |
|---|
| 159 | def notify() { |
|---|
| 160 | sh 'curl --data "" http://plg2:8082/jenkins/notify' |
|---|
| 161 | return |
|---|
| 162 | } |
|---|
| 163 | |
|---|
| 164 | def make_doc() { |
|---|
| 165 | def err = null |
|---|
| 166 | try { |
|---|
| 167 | sh 'make clean > /dev/null' |
|---|
| 168 | sh 'make > /dev/null 2>&1' |
|---|
| 169 | } |
|---|
| 170 | catch (Exception caughtError) { |
|---|
| 171 | err = caughtError //rethrow error later |
|---|
| 172 | sh 'cat *.log' |
|---|
| 173 | } |
|---|
| 174 | finally { |
|---|
| 175 | if (err) throw err // Must re-throw exception to propagate error |
|---|
| 176 | } |
|---|
| 177 | } |
|---|
| 178 | |
|---|
| 179 | //Description of a compiler (Must be serializable since pipelines are persistent) |
|---|
| 180 | class CC_Desc implements Serializable { |
|---|
| 181 | public String cc_name |
|---|
| 182 | public String cpp_cc |
|---|
| 183 | public String cfa_cc |
|---|
| 184 | |
|---|
| 185 | CC_Desc(String cc_name, String cpp_cc, String cfa_cc) { |
|---|
| 186 | this.cc_name = cc_name |
|---|
| 187 | this.cpp_cc = cpp_cc |
|---|
| 188 | this.cfa_cc = cfa_cc |
|---|
| 189 | } |
|---|
| 190 | } |
|---|
| 191 | |
|---|
| 192 | def compiler_from_params(cc) { |
|---|
| 193 | switch( cc ) { |
|---|
| 194 | case 'gcc-6': |
|---|
| 195 | return new CC_Desc('gcc-6', 'g++-6', 'gcc-6') |
|---|
| 196 | break |
|---|
| 197 | case 'gcc-5': |
|---|
| 198 | return new CC_Desc('gcc-5', 'g++-5', 'gcc-5') |
|---|
| 199 | break |
|---|
| 200 | case 'gcc-4.9': |
|---|
| 201 | return new CC_Desc('gcc-4.9', 'g++-4.9', 'gcc-4.9') |
|---|
| 202 | break |
|---|
| 203 | case 'clang': |
|---|
| 204 | return new CC_Desc('clang', 'clang++', 'gcc-6') |
|---|
| 205 | break |
|---|
| 206 | default : |
|---|
| 207 | error 'Unhandled compiler' |
|---|
| 208 | } |
|---|
| 209 | } |
|---|
| 210 | |
|---|
| 211 | def architecture_from_params( arch ) { |
|---|
| 212 | switch( arch ) { |
|---|
| 213 | case '64-bit': |
|---|
| 214 | return '--host=x86_64 CXXFLAGS="-m64" CFAFLAGS="-m64"' |
|---|
| 215 | break |
|---|
| 216 | case '32-bit': |
|---|
| 217 | return '--host=i386 CXXFLAGS="-m32" CFAFLAGS="-m32"' |
|---|
| 218 | break |
|---|
| 219 | default : |
|---|
| 220 | error 'Unhandled architecture' |
|---|
| 221 | } |
|---|
| 222 | } |
|---|
| 223 | |
|---|
| 224 | //=========================================================================================================== |
|---|
| 225 | // Main compilation routines |
|---|
| 226 | //=========================================================================================================== |
|---|
| 227 | //Compilation script is done here but environnement set-up and error handling is done in main loop |
|---|
| 228 | def checkout() { |
|---|
| 229 | stage 'Checkout' |
|---|
| 230 | //checkout the source code and clean the repo |
|---|
| 231 | checkout scm |
|---|
| 232 | |
|---|
| 233 | //Clean all temporary files to make sure no artifacts of the previous build remain |
|---|
| 234 | sh 'git clean -fdqx' |
|---|
| 235 | |
|---|
| 236 | //Reset the git repo so no local changes persist |
|---|
| 237 | sh 'git reset --hard' |
|---|
| 238 | } |
|---|
| 239 | |
|---|
| 240 | def build() { |
|---|
| 241 | stage 'Build' |
|---|
| 242 | |
|---|
| 243 | def install_dir = pwd tmp: true |
|---|
| 244 | |
|---|
| 245 | //Configure the conpilation (Output is not relevant) |
|---|
| 246 | //Use the current directory as the installation target so nothing |
|---|
| 247 | //escapes the sandbox |
|---|
| 248 | //Also specify the compiler by hand |
|---|
| 249 | sh "./configure CXX=${compiler.cpp_cc} ${architecture} --with-backend-compiler=${compiler.cfa_cc} --prefix=${install_dir} --enable-silent-rules --quiet" |
|---|
| 250 | |
|---|
| 251 | //Compile the project |
|---|
| 252 | sh 'make -j 8 --no-print-directory V=0 install' |
|---|
| 253 | } |
|---|
| 254 | |
|---|
| 255 | def test() { |
|---|
| 256 | stage 'Test' |
|---|
| 257 | |
|---|
| 258 | //Run the tests from the tests directory |
|---|
| 259 | if ( do_alltests ) { |
|---|
| 260 | sh 'make -C src/tests all-tests debug=yes' |
|---|
| 261 | sh 'make -C src/tests all-tests debug=no' |
|---|
| 262 | } |
|---|
| 263 | else { |
|---|
| 264 | sh 'make -C src/tests' |
|---|
| 265 | } |
|---|
| 266 | } |
|---|
| 267 | |
|---|
| 268 | def benchmark() { |
|---|
| 269 | stage 'Benchmark' |
|---|
| 270 | |
|---|
| 271 | if( !do_bencmark ) return |
|---|
| 272 | |
|---|
| 273 | //Write the commit id to Benchmark |
|---|
| 274 | writeFile file: 'bench.csv', text:'data=' + gitRefNewValue + ',' |
|---|
| 275 | |
|---|
| 276 | //Append bench results |
|---|
| 277 | sh 'make -C src/benchmark --no-print-directory csv-data >> bench.csv' |
|---|
| 278 | } |
|---|
| 279 | |
|---|
| 280 | def clean() { |
|---|
| 281 | stage 'Cleanup' |
|---|
| 282 | |
|---|
| 283 | //do a maintainer-clean to make sure we need to remake from scratch |
|---|
| 284 | sh 'make maintainer-clean > /dev/null' |
|---|
| 285 | } |
|---|
| 286 | |
|---|
| 287 | def build_doc() { |
|---|
| 288 | stage 'Documentation' |
|---|
| 289 | |
|---|
| 290 | if( !do_doc ) return |
|---|
| 291 | |
|---|
| 292 | dir ('doc/user') { |
|---|
| 293 | make_doc() |
|---|
| 294 | } |
|---|
| 295 | |
|---|
| 296 | dir ('doc/refrat') { |
|---|
| 297 | make_doc() |
|---|
| 298 | } |
|---|
| 299 | } |
|---|
| 300 | |
|---|
| 301 | def publish() { |
|---|
| 302 | stage 'Publish' |
|---|
| 303 | |
|---|
| 304 | if( !do_publish ) return |
|---|
| 305 | |
|---|
| 306 | //Then publish the results |
|---|
| 307 | sh 'curl --data @bench.csv http://plg2:8082/jenkins/publish' |
|---|
| 308 | } |
|---|
| 309 | |
|---|
| 310 | //=========================================================================================================== |
|---|
| 311 | //Routine responsible of sending the email notification once the build is completed |
|---|
| 312 | //=========================================================================================================== |
|---|
| 313 | //Standard build email notification |
|---|
| 314 | def email(String status, boolean log) { |
|---|
| 315 | //Since tokenizer doesn't work, figure stuff out from the environnement variables and command line |
|---|
| 316 | //Configurations for email format |
|---|
| 317 | def project_name = (env.JOB_NAME =~ /(.+)\/.+/)[0][1].toLowerCase() |
|---|
| 318 | |
|---|
| 319 | def gitLog = 'Error retrieving git logs' |
|---|
| 320 | def gitDiff = 'Error retrieving git diff' |
|---|
| 321 | |
|---|
| 322 | try { |
|---|
| 323 | |
|---|
| 324 | sh "git rev-list --format=short ${gitRefOldValue}...${gitRefNewValue} > GIT_LOG" |
|---|
| 325 | gitLog = readFile('GIT_LOG') |
|---|
| 326 | |
|---|
| 327 | sh "git diff --stat ${gitRefNewValue} ${gitRefOldValue} > GIT_DIFF" |
|---|
| 328 | gitDiff = readFile('GIT_DIFF') |
|---|
| 329 | } |
|---|
| 330 | catch (Exception error) {} |
|---|
| 331 | |
|---|
| 332 | def email_subject = "[${project_name} git][BUILD# ${env.BUILD_NUMBER} - ${status}] - branch ${env.BRANCH_NAME}" |
|---|
| 333 | def email_body = """This is an automated email from the Jenkins build machine. It was |
|---|
| 334 | generated because of a git hooks/post-receive script following |
|---|
| 335 | a ref change was pushed to the repository containing |
|---|
| 336 | the project "UNNAMED PROJECT". |
|---|
| 337 | |
|---|
| 338 | The branch ${env.BRANCH_NAME} has been updated. |
|---|
| 339 | via ${gitRefOldValue} (commit) |
|---|
| 340 | from ${gitRefNewValue} (commit) |
|---|
| 341 | |
|---|
| 342 | Check console output at ${env.BUILD_URL} to view the results. |
|---|
| 343 | |
|---|
| 344 | - Status -------------------------------------------------------------- |
|---|
| 345 | |
|---|
| 346 | BUILD# ${env.BUILD_NUMBER} - ${status} |
|---|
| 347 | |
|---|
| 348 | - Log ----------------------------------------------------------------- |
|---|
| 349 | ${gitLog} |
|---|
| 350 | ----------------------------------------------------------------------- |
|---|
| 351 | Summary of changes: |
|---|
| 352 | ${gitDiff} |
|---|
| 353 | """ |
|---|
| 354 | |
|---|
| 355 | def email_to = "pabuhr@uwaterloo.ca, rschlunt@uwaterloo.ca, a3moss@uwaterloo.ca, tdelisle@uwaterloo.ca, brice.dobry@huawei.com" |
|---|
| 356 | |
|---|
| 357 | //send email notification |
|---|
| 358 | emailext body: email_body, subject: email_subject, to: email_to, attachLog: log |
|---|
| 359 | } |
|---|
