source: Jenkinsfile@ d4ba8e9

ADT aaron-thesis arm-eh ast-experimental cleanup-dtors deferred_resn demangler enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr no_list persistent-indexer pthread-emulation qualifiedEnum
Last change on this file since d4ba8e9 was d4ba8e9, checked in by Thierry Delisle <tdelisle@…>, 7 years ago

Print email body early to debug
  • Property mode set to 100644
File size: 12.6 KB
Line 
1#!groovy
2
3//===========================================================================================================
4// Main loop of the compilation
5//===========================================================================================================
6node ('master'){
7
8 boolean bIsSandbox = env.BRANCH_NAME == "jenkins-sandbox"
9 def err = null
10 def log_needed = false
11
12 stage_name = ''
13
14 compiler = null
15 arch_name = ''
16 architecture = ''
17
18 do_alltests = false
19 do_benchmark = false
20 do_doc = false
21 do_publish = false
22 do_sendemail = true
23
24 builddir = pwd tmp: true
25 srcdir = pwd tmp: false
26
27 currentBuild.result = "SUCCESS"
28
29 try {
30 //Wrap build to add timestamp to command line
31 wrap([$class: 'TimestamperBuildWrapper']) {
32
33 notify_server(0)
34
35 prepare_build()
36
37 clean()
38
39 checkout()
40
41 notify_server(0)
42
43 build()
44
45 test()
46
47 benchmark()
48
49 build_doc()
50
51 publish()
52
53 notify_server(45)
54 }
55 }
56
57 //If an exception is caught we need to change the status and remember to
58 //attach the build log to the email
59 catch (Exception caughtError) {
60 //rethrow error later
61 err = caughtError
62
63 //An error has occured, the build log is relevent
64 log_needed = true
65
66 //Store the result of the build log
67 currentBuild.result = "${stage_name} FAILURE".trim()
68 }
69
70 finally {
71 //Send email with final results if this is not a full build
72 if( do_sendemail ) {
73 echo 'Notifying users of result'
74 email(currentBuild.result, log_needed, bIsSandbox)
75 }
76
77 echo 'Build Completed'
78
79 /* Must re-throw exception to propagate error */
80 if (err) {
81 throw err
82 }
83 }
84}
85
86//===========================================================================================================
87// Helper classes/variables/routines
88//===========================================================================================================
89//Helper routine to collect information about the git history
90def collect_git_info() {
91
92 checkout scm
93
94 //create the temporary output directory in case it doesn't already exist
95 def out_dir = pwd tmp: true
96 sh "mkdir -p ${out_dir}"
97
98 //parse git logs to find what changed
99 gitRefName = env.BRANCH_NAME
100 sh "git reflog > ${out_dir}/GIT_COMMIT"
101 git_reflog = readFile("${out_dir}/GIT_COMMIT")
102 gitRefOldValue = (git_reflog =~ /moving from (.+) to (.+)/)[0][1]
103 gitRefNewValue = (git_reflog =~ /moving from (.+) to (.+)/)[0][2]
104}
105
106def prepare_build() {
107 properties ([ \
108 [$class: 'ParametersDefinitionProperty', \
109 parameterDefinitions: [ \
110 [$class: 'ChoiceParameterDefinition', \
111 description: 'Which compiler to use', \
112 name: 'pCompiler', \
113 choices: 'gcc-6\ngcc-5\ngcc-4.9\nclang', \
114 defaultValue: 'gcc-6', \
115 ], \
116 [$class: 'ChoiceParameterDefinition', \
117 description: 'The target architecture', \
118 name: 'pArchitecture', \
119 choices: 'x64\nx86', \
120 defaultValue: 'x64', \
121 ], \
122 [$class: 'BooleanParameterDefinition', \
123 description: 'If false, only the quick test suite is ran', \
124 name: 'pRunAllTests', \
125 defaultValue: false, \
126 ], \
127 [$class: 'BooleanParameterDefinition', \
128 description: 'If true, jenkins also runs benchmarks', \
129 name: 'pRunBenchmark', \
130 defaultValue: true, \
131 ], \
132 [$class: 'BooleanParameterDefinition', \
133 description: 'If true, jenkins also builds documentation', \
134 name: 'pBuildDocumentation', \
135 defaultValue: true, \
136 ], \
137 [$class: 'BooleanParameterDefinition', \
138 description: 'If true, jenkins also publishes results', \
139 name: 'pPublish', \
140 defaultValue: false, \
141 ], \
142 [$class: 'BooleanParameterDefinition', \
143 description: 'If true, jenkins will not send emails', \
144 name: 'pSilent', \
145 defaultValue: false, \
146 ], \
147 ],
148 ]])
149
150 compiler = compiler_from_params( pCompiler )
151 arch_name = pArchitecture
152 architecture = architecture_from_params( arch_name )
153
154 do_alltests = (pRunAllTests == 'true')
155 do_benchmark = (pRunBenchmark == 'true')
156 do_doc = (pBuildDocumentation == 'true')
157 do_publish = (pPublish == 'true')
158 do_sendemail = ! (pSilent == 'true')
159
160 collect_git_info()
161
162 def full = do_alltests ? " (Full)" : ""
163 currentBuild.description = "${compiler.cc_name}:${arch_name}${full}"
164
165 echo """Compiler : ${compiler.cc_name} (${compiler.cpp_cc}/${compiler.cfa_cc})
166Architecture : ${arch_name}
167Arc Flags : ${architecture}
168Run All Tests : ${ pRunAllTests.toString() }
169Run Benchmark : ${ pRunBenchmark.toString() }
170Build Documentation : ${ pBuildDocumentation.toString() }
171Publish : ${ pPublish.toString() }
172Silent : ${ pSilent.toString() }
173"""
174
175
176 //Since tokenizer doesn't work, figure stuff out from the environnement variables and command line
177 //Configurations for email format
178 def project_name = (env.JOB_NAME =~ /(.+)\/.+/)[0][1].toLowerCase()
179
180 def gitLog = 'Error retrieving git logs'
181 def gitDiff = 'Error retrieving git diff'
182 def gitUpdate = 'Error retrieving update'
183
184 try {
185 gitUpdate = gitBranchUpdate(gitRefOldValue, gitRefNewValue)
186
187 sh "git rev-list --format=short ${gitRefOldValue}...${gitRefNewValue} > GIT_LOG"
188 gitLog = readFile('GIT_LOG')
189
190 sh "git diff --stat ${gitRefNewValue} ${gitRefOldValue} > GIT_DIFF"
191 gitDiff = readFile('GIT_DIFF')
192 }
193 catch (Exception error) {}
194
195 def email_subject = "[${project_name} git][BUILD# ${env.BUILD_NUMBER} - ${status}] - branch ${env.BRANCH_NAME}"
196 def email_body = """This is an automated email from the Jenkins build machine. It was
197generated because of a git hooks/post-receive script following
198a ref change was pushed to the repository containing
199the project "UNNAMED PROJECT".
200
201The branch ${env.BRANCH_NAME} has been updated.
202${gitUpdate}
203
204Check console output at ${env.BUILD_URL} to view the results.
205
206- Status --------------------------------------------------------------
207
208BUILD# ${env.BUILD_NUMBER} - ${status}
209
210- Log -----------------------------------------------------------------
211${gitLog}
212-----------------------------------------------------------------------
213Summary of changes:
214${gitDiff}
215"""
216
217 echo email_body
218}
219
220def build_stage(String name, Closure block ) {
221 stage_name = name
222 stage(name, block)
223}
224
225def notify_server(int wait) {
226 sh """curl --silent --show-error --data "wait=${wait}" -X POST https://cforall.uwaterloo.ca:8082/jenkins/notify > /dev/null || true"""
227 return
228}
229
230def make_doc() {
231 def err = null
232 try {
233 sh 'make clean > /dev/null'
234 sh 'make > /dev/null 2>&1'
235 }
236 catch (Exception caughtError) {
237 err = caughtError //rethrow error later
238 sh 'cat *.log'
239 }
240 finally {
241 if (err) throw err // Must re-throw exception to propagate error
242 }
243}
244
245//Description of a compiler (Must be serializable since pipelines are persistent)
246class CC_Desc implements Serializable {
247 public String cc_name
248 public String cpp_cc
249 public String cfa_cc
250
251 CC_Desc(String cc_name, String cpp_cc, String cfa_cc) {
252 this.cc_name = cc_name
253 this.cpp_cc = cpp_cc
254 this.cfa_cc = cfa_cc
255 }
256}
257
258def compiler_from_params(cc) {
259 switch( cc ) {
260 case 'gcc-6':
261 return new CC_Desc('gcc-6', 'g++-6', 'gcc-6')
262 break
263 case 'gcc-5':
264 return new CC_Desc('gcc-5', 'g++-5', 'gcc-5')
265 break
266 case 'gcc-4.9':
267 return new CC_Desc('gcc-4.9', 'g++-4.9', 'gcc-4.9')
268 break
269 case 'clang':
270 return new CC_Desc('clang', 'clang++', 'gcc-6')
271 break
272 default :
273 error "Unhandled compiler : ${cc}"
274 }
275}
276
277def architecture_from_params( arch ) {
278 switch( arch ) {
279 case 'x64':
280 return '--host=x86_64'
281 break
282 case 'x86':
283 return '--host=i386'
284 break
285 default :
286 error "Unhandled architecture : ${arch}"
287 }
288}
289
290//===========================================================================================================
291// Main compilation routines
292//===========================================================================================================
293def clean() {
294 build_stage('Cleanup') {
295 // clean the build by wipping the build directory
296 dir(builddir) {
297 deleteDir()
298 }
299
300 //Clean all temporary files to make sure no artifacts of the previous build remain
301 sh 'git clean -fdqx'
302
303 //Reset the git repo so no local changes persist
304 sh 'git reset --hard'
305 }
306}
307
308//Compilation script is done here but environnement set-up and error handling is done in main loop
309def checkout() {
310 build_stage('Checkout') {
311 //checkout the source code and clean the repo
312 checkout scm
313 }
314}
315
316def build() {
317 build_stage('Build') {
318 // Build outside of the src tree to ease cleaning
319 dir (builddir) {
320 //Configure the conpilation (Output is not relevant)
321 //Use the current directory as the installation target so nothing escapes the sandbox
322 //Also specify the compiler by hand
323 sh "${srcdir}/configure CXX=${compiler.cpp_cc} ${architecture} --with-backend-compiler=${compiler.cfa_cc} --enable-silent-rules --quiet"
324
325 //Compile the project
326 sh 'make -j 8 --no-print-directory'
327 }
328 }
329}
330
331def test() {
332 build_stage('Test') {
333
334 dir (builddir) {
335 //Run the tests from the tests directory
336 if ( do_alltests ) {
337 sh 'make --no-print-directory -C src/tests all-tests debug=yes'
338 sh 'make --no-print-directory -C src/tests all-tests debug=no '
339 }
340 else {
341 sh 'make --no-print-directory -C src/tests'
342 }
343 }
344 }
345}
346
347def benchmark() {
348 build_stage('Benchmark') {
349
350 if( !do_benchmark ) return
351
352 dir (builddir) {
353 //Append bench results
354 sh "make --no-print-directory -C src/benchmark jenkins githash=${gitRefNewValue} arch=${arch_name} | tee ${srcdir}/bench.json"
355 }
356 }
357}
358
359def build_doc() {
360 build_stage('Documentation') {
361
362 if( !do_doc ) return
363
364 dir ('doc/user') {
365 make_doc()
366 }
367
368 dir ('doc/refrat') {
369 make_doc()
370 }
371 }
372}
373
374def publish() {
375 build_stage('Publish') {
376
377 if( !do_publish ) return
378
379 //Then publish the results
380 sh 'curl --silent --show-error -H \'Content-Type: application/json\' --data @bench.json https://cforall.uwaterloo.ca:8082/jenkins/publish > /dev/null || true'
381 }
382}
383
384//===========================================================================================================
385//Routine responsible of sending the email notification once the build is completed
386//===========================================================================================================
387def gitBranchUpdate(String gitRefOldValue, String gitRefNewValue) {
388 def update = ""
389 sh "git rev-list $oldrev..$newrev > GIT_LOG";
390 readFile('GIT_LOG').eachLine { rev ->
391 sh "git cat-file -t ${rev} > GIT_TYPE"
392 def type = readFile('GIT_TYPE')
393
394 update += " via ${rev} (${type})\n"
395 }
396 def rev = gitRefOldValue
397 sh "git cat-file -t ${rev} > GIT_TYPE"
398 def type = readFile('GIT_TYPE')
399
400 update += " from ${rev} (${type})\n"
401 return update
402
403def output=readFile('result').trim()
404echo "output=$output";
405}
406
407//Standard build email notification
408def email(String status, boolean log, boolean bIsSandbox) {
409 //Since tokenizer doesn't work, figure stuff out from the environnement variables and command line
410 //Configurations for email format
411 def project_name = (env.JOB_NAME =~ /(.+)\/.+/)[0][1].toLowerCase()
412
413 def gitLog = 'Error retrieving git logs'
414 def gitDiff = 'Error retrieving git diff'
415 def gitUpdate = 'Error retrieving update'
416
417 try {
418 gitUpdate = gitBranchUpdate(gitRefOldValue, gitRefNewValue)
419
420 sh "git rev-list --format=short ${gitRefOldValue}...${gitRefNewValue} > GIT_LOG"
421 gitLog = readFile('GIT_LOG')
422
423 sh "git diff --stat ${gitRefNewValue} ${gitRefOldValue} > GIT_DIFF"
424 gitDiff = readFile('GIT_DIFF')
425 }
426 catch (Exception error) {}
427
428 def email_subject = "[${project_name} git][BUILD# ${env.BUILD_NUMBER} - ${status}] - branch ${env.BRANCH_NAME}"
429 def email_body = """This is an automated email from the Jenkins build machine. It was
430generated because of a git hooks/post-receive script following
431a ref change was pushed to the repository containing
432the project "UNNAMED PROJECT".
433
434The branch ${env.BRANCH_NAME} has been updated.
435${gitUpdate}
436
437Check console output at ${env.BUILD_URL} to view the results.
438
439- Status --------------------------------------------------------------
440
441BUILD# ${env.BUILD_NUMBER} - ${status}
442
443- Log -----------------------------------------------------------------
444${gitLog}
445-----------------------------------------------------------------------
446Summary of changes:
447${gitDiff}
448"""
449
450 def email_to = "cforall@lists.uwaterloo.ca"
451
452 if( !bIsSandbox ) {
453 //send email notification
454 emailext body: email_body, subject: email_subject, to: email_to, attachLog: log
455 } else {
456 echo "Would send email to: ${email_to}"
457 echo "With title: ${email_subject}"
458 echo "Content: \n${email_body}"
459 }
460}
Note: See TracBrowser for help on using the repository browser.