source: Jenkinsfile@ 9421f3d8

ADT arm-eh ast-experimental enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr pthread-emulation qualifiedEnum
Last change on this file since 9421f3d8 was 85142648, checked in by Thierry Delisle <tdelisle@…>, 6 years ago

Reverted usage of node
  • Property mode set to 100644
File size: 15.7 KB
Line 
1#!groovy
2
3import groovy.transform.Field
4
5// For skipping stages
6import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
7
8//===========================================================================================================
9// Main loop of the compilation
10//===========================================================================================================
11
12node('master') {
13 // Globals
14 BuildDir = pwd tmp: true
15 SrcDir = pwd tmp: false
16 Settings = null
17 StageName = ''
18
19 // Local variables
20 def err = null
21 def log_needed = false
22
23 currentBuild.result = "SUCCESS"
24
25 try {
26 //Wrap build to add timestamp to command line
27 wrap([$class: 'TimestamperBuildWrapper']) {
28
29 Settings = prepare_build()
30
31 node(Settings.Architecture.node) {
32 BuildDir = pwd tmp: true
33 SrcDir = pwd tmp: false
34
35 clean()
36
37 checkout()
38
39 build()
40
41 test()
42
43 benchmark()
44
45 build_doc()
46
47 publish()
48 }
49
50 // Update the build directories when exiting the node
51 BuildDir = pwd tmp: true
52 SrcDir = pwd tmp: false
53 }
54 }
55
56 //If an exception is caught we need to change the status and remember to
57 //attach the build log to the email
58 catch (Exception caughtError) {
59 //rethrow error later
60 err = caughtError
61
62 echo err.toString()
63
64 //An error has occured, the build log is relevent
65 log_needed = true
66
67 //Store the result of the build log
68 currentBuild.result = "${StageName} FAILURE".trim()
69 }
70
71 finally {
72 //Send email with final results if this is not a full build
73 email(log_needed)
74
75 echo 'Build Completed'
76
77 /* Must re-throw exception to propagate error */
78 if (err) {
79 throw err
80 }
81 }
82}
83//===========================================================================================================
84// Main compilation routines
85//===========================================================================================================
86def clean() {
87 build_stage('Cleanup', true) {
88 // clean the build by wipping the build directory
89 dir(BuildDir) {
90 deleteDir()
91 }
92 }
93}
94
95//Compilation script is done here but environnement set-up and error handling is done in main loop
96def checkout() {
97 build_stage('Checkout', true) {
98 //checkout the source code and clean the repo
99 final scmVars = checkout scm
100 Settings.GitNewRef = scmVars.GIT_COMMIT
101 Settings.GitOldRef = scmVars.GIT_PREVIOUS_COMMIT
102
103 echo GitLogMessage()
104 }
105}
106
107def build() {
108 debug = true
109 release = Settings.RunAllTests || Settings.RunBenchmark
110 build_stage('Build : configure', true) {
111 // Build outside of the src tree to ease cleaning
112 dir (BuildDir) {
113 //Configure the conpilation (Output is not relevant)
114 //Use the current directory as the installation target so nothing escapes the sandbox
115 //Also specify the compiler by hand
116 targets=""
117 if( Settings.RunAllTests || Settings.RunBenchmark ) {
118 targets="--with-target-hosts='host:debug,host:nodebug'"
119 } else {
120 targets="--with-target-hosts='host:debug'"
121 }
122
123 sh "${SrcDir}/configure CXX=${Settings.Compiler.CXX} CC=${Settings.Compiler.CC} ${Settings.Architecture.flags} ${targets} --quiet"
124
125 // Configure libcfa
126 sh 'make -j 8 --no-print-directory configure-libcfa'
127 }
128 }
129
130 build_stage('Build : cfa-cpp', true) {
131 // Build outside of the src tree to ease cleaning
132 dir (BuildDir) {
133 // Build driver
134 sh 'make -j 8 --no-print-directory -C driver'
135
136 // Build translator
137 sh 'make -j 8 --no-print-directory -C src'
138 }
139 }
140
141 build_stage('Build : libcfa(debug)', debug) {
142 // Build outside of the src tree to ease cleaning
143 dir (BuildDir) {
144 sh "make -j 8 --no-print-directory -C libcfa/${Settings.Architecture.name}-debug"
145 }
146 }
147
148 build_stage('Build : libcfa(nodebug)', release) {
149 // Build outside of the src tree to ease cleaning
150 dir (BuildDir) {
151 sh "make -j 8 --no-print-directory -C libcfa/${Settings.Architecture.name}-nodebug"
152 }
153 }
154}
155
156def test() {
157 try {
158 build_stage('Test: short', !Settings.RunAllTests) {
159 dir (BuildDir) {
160 //Run the tests from the tests directory
161 sh "make --no-print-directory -C tests archiveerrors=${BuildDir}/tests/crashes/short"
162 }
163 }
164
165 build_stage('Test: full', Settings.RunAllTests) {
166 dir (BuildDir) {
167 //Run the tests from the tests directory
168 sh """make --no-print-directory -C tests timeouts="--timeout=600 --global-timeout=14400" all-tests debug=yes archiveerrors=${BuildDir}/tests/crashes/full-debug"""
169 sh """make --no-print-directory -C tests timeouts="--timeout=600 --global-timeout=14400" all-tests debug=no archiveerrors=${BuildDir}/tests/crashes/full-nodebug"""
170 }
171 }
172 }
173 catch (Exception err) {
174 echo "Archiving core dumps"
175 dir (BuildDir) {
176 archiveArtifacts artifacts: "tests/crashes/**/*", fingerprint: true
177 }
178 throw err
179 }
180}
181
182def benchmark() {
183 build_stage('Benchmark', Settings.RunBenchmark) {
184 dir (BuildDir) {
185 //Append bench results
186 sh "make --no-print-directory -C benchmark jenkins arch=${Settings.Architecture.name}"
187 }
188 }
189}
190
191def build_doc() {
192 build_stage('Documentation', Settings.BuildDocumentation) {
193 dir ('doc/user') {
194 make_doc()
195 }
196
197 dir ('doc/refrat') {
198 make_doc()
199 }
200 }
201}
202
203def publish() {
204 build_stage('Publish', true) {
205
206 if( Settings.Publish && !Settings.RunBenchmark ) { echo 'No results to publish!!!' }
207
208 def groupCompile = new PlotGroup('Compilation', 'duration (s) - lower is better', true)
209 def groupConcurrency = new PlotGroup('Concurrency', 'duration (n) - lower is better', false)
210
211 //Then publish the results
212 do_plot(Settings.RunBenchmark && Settings.Publish, 'compile' , groupCompile , false, 'Compilation')
213 do_plot(Settings.RunBenchmark && Settings.Publish, 'compile.diff' , groupCompile , true , 'Compilation (relative)')
214 do_plot(Settings.RunBenchmark && Settings.Publish, 'ctxswitch' , groupConcurrency, false, 'Context Switching')
215 do_plot(Settings.RunBenchmark && Settings.Publish, 'ctxswitch.diff', groupConcurrency, true , 'Context Switching (relative)')
216 do_plot(Settings.RunBenchmark && Settings.Publish, 'mutex' , groupConcurrency, false, 'Mutual Exclusion')
217 do_plot(Settings.RunBenchmark && Settings.Publish, 'mutex.diff' , groupConcurrency, true , 'Mutual Exclusion (relative)')
218 do_plot(Settings.RunBenchmark && Settings.Publish, 'signal' , groupConcurrency, false, 'Internal and External Scheduling')
219 do_plot(Settings.RunBenchmark && Settings.Publish, 'signal.diff' , groupConcurrency, true , 'Internal and External Scheduling (relative)')
220 }
221}
222
223//===========================================================================================================
224//Routine responsible of sending the email notification once the build is completed
225//===========================================================================================================
226@NonCPS
227def SplitLines(String text) {
228 def list = []
229
230 text.eachLine {
231 list += it
232 }
233
234 return list
235}
236
237def GitLogMessage() {
238 if (!Settings || !Settings.GitOldRef || !Settings.GitNewRef) return "\nERROR retrieveing git information!\n"
239
240 def oldRef = Settings.GitOldRef
241 def newRef = Settings.GitNewRef
242
243 def revText = sh(returnStdout: true, script: "git rev-list ${oldRef}..${newRef}").trim()
244 def revList = SplitLines( revText )
245
246 def gitUpdate = ""
247 revList.each { rev ->
248 def type = sh(returnStdout: true, script: "git cat-file -t ${rev}").trim()
249 gitUpdate = gitUpdate + " via ${rev} (${type})"
250 }
251
252 def rev = oldRef
253 def type = sh(returnStdout: true, script: "git cat-file -t ${rev}").trim()
254 gitUpdate = gitUpdate + " from ${rev} (${type})"
255
256 def gitLog = sh(returnStdout: true, script: "git rev-list --format=short ${oldRef}...${newRef}").trim()
257
258 def gitDiff = sh(returnStdout: true, script: "git diff --stat --color ${newRef} ${oldRef}").trim()
259 gitDiff = gitDiff.replace('[32m', '<span style="color: #00AA00;">')
260 gitDiff = gitDiff.replace('[31m', '<span style="color: #AA0000;">')
261 gitDiff = gitDiff.replace('[m', '</span>')
262
263 return """
264<pre>
265The branch ${env.BRANCH_NAME} has been updated.
266${gitUpdate}
267</pre>
268
269<p>Check console output at ${env.BUILD_URL} to view the results.</p>
270
271<p>- Status --------------------------------------------------------------</p>
272
273<p>BUILD# ${env.BUILD_NUMBER} - ${currentBuild.result}</p>
274
275<p>- Log -----------------------------------------------------------------</p>
276
277<pre>
278${gitLog}
279</pre>
280
281<p>-----------------------------------------------------------------------</p>
282<pre>
283Summary of changes:
284${gitDiff}
285</pre>
286"""
287}
288
289//Standard build email notification
290def email(boolean log) {
291 //Since tokenizer doesn't work, figure stuff out from the environnement variables and command line
292 //Configurations for email format
293 echo 'Notifying users of result'
294
295 def project_name = (env.JOB_NAME =~ /(.+)\/.+/)[0][1].toLowerCase()
296 def email_subject = "[${project_name} git][BUILD# ${env.BUILD_NUMBER} - ${currentBuild.result}] - branch ${env.BRANCH_NAME}"
297 def email_body = """<p>This is an automated email from the Jenkins build machine. It was
298generated because of a git hooks/post-receive script following
299a ref change which was pushed to the C\u2200 repository.</p>
300""" + GitLogMessage()
301
302 def email_to = !Settings.IsSandbox ? "cforall@lists.uwaterloo.ca" : "tdelisle@uwaterloo.ca"
303
304 if( Settings && !Settings.Silent ) {
305 //send email notification
306 emailext body: email_body, subject: email_subject, to: email_to, attachLog: log
307 } else {
308 echo "Would send email to: ${email_to}"
309 echo "With title: ${email_subject}"
310 echo "Content: \n${email_body}"
311 }
312}
313
314//===========================================================================================================
315// Helper classes/variables/routines
316//===========================================================================================================
317//Description of a compiler (Must be serializable since pipelines are persistent)
318class CC_Desc implements Serializable {
319 public String name
320 public String CXX
321 public String CC
322
323 CC_Desc(String name, String CXX, String CC) {
324 this.name = name
325 this.CXX = CXX
326 this.CC = CC
327 }
328}
329
330//Description of an architecture (Must be serializable since pipelines are persistent)
331class Arch_Desc implements Serializable {
332 public String name
333 public String flags
334 public String node
335
336 Arch_Desc(String name, String flags, String node) {
337 this.name = name
338 this.flags = flags
339 this.node = node
340 }
341}
342
343class BuildSettings implements Serializable {
344 public final CC_Desc Compiler
345 public final Arch_Desc Architecture
346 public final Boolean RunAllTests
347 public final Boolean RunBenchmark
348 public final Boolean BuildDocumentation
349 public final Boolean Publish
350 public final Boolean Silent
351 public final Boolean IsSandbox
352 public final String DescLong
353 public final String DescShort
354
355 public String GitNewRef
356 public String GitOldRef
357
358 BuildSettings(java.util.Collections$UnmodifiableMap param, String branch) {
359 switch( param.Compiler ) {
360 case 'gcc-6':
361 this.Compiler = new CC_Desc('gcc-6', 'g++-6', 'gcc-6')
362 break
363 case 'gcc-5':
364 this.Compiler = new CC_Desc('gcc-5', 'g++-5', 'gcc-5')
365 break
366 case 'gcc-4.9':
367 this.Compiler = new CC_Desc('gcc-4.9', 'g++-4.9', 'gcc-4.9')
368 break
369 case 'clang':
370 this.Compiler = new CC_Desc('clang', 'clang++', 'gcc-6')
371 break
372 default :
373 error "Unhandled compiler : ${cc}"
374 }
375
376 switch( param.Architecture ) {
377 case 'x64':
378 this.Architecture = new Arch_Desc('x64', '--host=x86_64', 'x64')
379 break
380 case 'x86':
381 this.Architecture = new Arch_Desc('x86', '--host=i386', 'x86')
382 break
383 default :
384 error "Unhandled architecture : ${arch}"
385 }
386
387 this.IsSandbox = (branch == "jenkins-sandbox")
388 this.RunAllTests = param.RunAllTests
389 this.RunBenchmark = param.RunBenchmark
390 this.BuildDocumentation = param.BuildDocumentation
391 this.Publish = param.Publish
392 this.Silent = param.Silent
393
394 def full = param.RunAllTests ? " (Full)" : ""
395 this.DescShort = "${ this.Compiler.name }:${ this.Architecture.name }${full}"
396
397 this.DescLong = """Compiler : ${ this.Compiler.name } (${ this.Compiler.CXX }/${ this.Compiler.CC })
398Architecture : ${ this.Architecture.name }
399Arc Flags : ${ this.Architecture.flags }
400Run All Tests : ${ this.RunAllTests.toString() }
401Run Benchmark : ${ this.RunBenchmark.toString() }
402Build Documentation : ${ this.BuildDocumentation.toString() }
403Publish : ${ this.Publish.toString() }
404Silent : ${ this.Silent.toString() }
405"""
406
407 this.GitNewRef = ''
408 this.GitOldRef = ''
409 }
410}
411
412class PlotGroup implements Serializable {
413 public String name
414 public String unit
415 public boolean log
416
417 PlotGroup(String name, String unit, boolean log) {
418 this.name = name
419 this.unit = unit
420 this.log = log
421 }
422}
423
424def prepare_build() {
425 // prepare the properties
426 properties ([ \
427 [$class: 'ParametersDefinitionProperty', \
428 parameterDefinitions: [ \
429 [$class: 'ChoiceParameterDefinition', \
430 description: 'Which compiler to use', \
431 name: 'Compiler', \
432 choices: 'gcc-6\ngcc-5\ngcc-4.9\nclang', \
433 defaultValue: 'gcc-6', \
434 ], \
435 [$class: 'ChoiceParameterDefinition', \
436 description: 'The target architecture', \
437 name: 'Architecture', \
438 choices: 'x64\nx86', \
439 defaultValue: 'x64', \
440 ], \
441 [$class: 'BooleanParameterDefinition', \
442 description: 'If false, only the quick test suite is ran', \
443 name: 'RunAllTests', \
444 defaultValue: false, \
445 ], \
446 [$class: 'BooleanParameterDefinition', \
447 description: 'If true, jenkins also runs benchmarks', \
448 name: 'RunBenchmark', \
449 defaultValue: false, \
450 ], \
451 [$class: 'BooleanParameterDefinition', \
452 description: 'If true, jenkins also builds documentation', \
453 name: 'BuildDocumentation', \
454 defaultValue: true, \
455 ], \
456 [$class: 'BooleanParameterDefinition', \
457 description: 'If true, jenkins also publishes results', \
458 name: 'Publish', \
459 defaultValue: false, \
460 ], \
461 [$class: 'BooleanParameterDefinition', \
462 description: 'If true, jenkins will not send emails', \
463 name: 'Silent', \
464 defaultValue: false, \
465 ], \
466 ],
467 ]])
468
469 // It's unfortunate but it looks like we need to checkout the entire repo just to get the pretty git printer
470 checkout scm
471
472 final settings = new BuildSettings(params, env.BRANCH_NAME)
473
474 currentBuild.description = settings.DescShort
475 echo settings.DescLong
476
477 return settings
478}
479
480def build_stage(String name, boolean run, Closure block ) {
481 StageName = name
482 echo " -------- ${StageName} -------- "
483 if(run) {
484 stage(name, block)
485 } else {
486 stage(name) { Utils.markStageSkippedForConditional(STAGE_NAME) }
487 }
488}
489
490def make_doc() {
491 def err = null
492 try {
493 sh 'make clean > /dev/null'
494 sh 'make > /dev/null 2>&1'
495 }
496 catch (Exception caughtError) {
497 err = caughtError //rethrow error later
498 sh 'cat build/*.log'
499 }
500 finally {
501 if (err) throw err // Must re-throw exception to propagate error
502 }
503}
504
505def do_plot(boolean new_data, String file, PlotGroup group, boolean relative, String title) {
506
507 if(new_data) {
508 echo "Publishing new data"
509 }
510
511 def series = new_data ? [[
512 file: "${file}.csv",
513 exclusionValues: '',
514 displayTableFlag: false,
515 inclusionFlag: 'OFF',
516 url: ''
517 ]] : [];
518
519 echo "file is ${BuildDir}/benchmark/${file}.csv, group ${group}, title ${title}"
520 dir("${BuildDir}/benchmark/") {
521 plot csvFileName: "cforall-${env.BRANCH_NAME}-${file}.csv",
522 csvSeries: series,
523 group: "${group.name}",
524 title: "${title}",
525 style: 'lineSimple',
526 exclZero: false,
527 keepRecords: false,
528 logarithmic: !relative && group.log,
529 numBuilds: '120',
530 useDescr: true,
531 yaxis: group.unit,
532 yaxisMaximum: '',
533 yaxisMinimum: ''
534 }
535}
Note: See TracBrowser for help on using the repository browser.