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