source: Jenkinsfile @ bdc154b

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprno_listpersistent-indexer
Last change on this file since bdc154b was bdc154b, checked in by Thierry Delisle <tdelisle@…>, 4 years ago

Testing build description

  • Property mode set to 100644
File size: 10.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        echo """Compiler              : ${compiler.cc_name} (${compiler.cpp_cc}/${compiler.cfa_cc})
161Architecture            : ${arch_name}
162Arc Flags               : ${architecture}
163Run All Tests           : ${ pRunAllTests.toString() }
164Run Benchmark           : ${ pRunBenchmark.toString() }
165Build Documentation     : ${ pBuildDocumentation.toString() }
166Publish                 : ${ pPublish.toString() }
167Silent                  : ${ pSilent.toString() }
168"""
169
170        collect_git_info()
171
172        currentBuild.description = "Cforall ${gitRefName} ${compiler}:${architecture}"
173}
174
175def build_stage(String name, Closure block ) {
176        stage_name = name
177        stage(name, block)
178}
179
180def notify_server(int wait) {
181        sh """curl --silent --show-error --data "wait=${wait}" -X POST https://cforall.uwaterloo.ca:8082/jenkins/notify > /dev/null || true"""
182        return
183}
184
185def make_doc() {
186        def err = null
187        try {
188                sh 'make clean > /dev/null'
189                sh 'make > /dev/null 2>&1'
190        }
191        catch (Exception caughtError) {
192                err = caughtError //rethrow error later
193                sh 'cat *.log'
194        }
195        finally {
196                if (err) throw err // Must re-throw exception to propagate error
197        }
198}
199
200//Description of a compiler (Must be serializable since pipelines are persistent)
201class CC_Desc implements Serializable {
202        public String cc_name
203        public String cpp_cc
204        public String cfa_cc
205
206        CC_Desc(String cc_name, String cpp_cc, String cfa_cc) {
207                this.cc_name = cc_name
208                this.cpp_cc = cpp_cc
209                this.cfa_cc = cfa_cc
210        }
211}
212
213def compiler_from_params(cc) {
214        switch( cc ) {
215                case 'gcc-6':
216                        return new CC_Desc('gcc-6', 'g++-6', 'gcc-6')
217                break
218                case 'gcc-5':
219                        return new CC_Desc('gcc-5', 'g++-5', 'gcc-5')
220                break
221                case 'gcc-4.9':
222                        return new CC_Desc('gcc-4.9', 'g++-4.9', 'gcc-4.9')
223                break
224                case 'clang':
225                        return new CC_Desc('clang', 'clang++', 'gcc-6')
226                break
227                default :
228                        error "Unhandled compiler : ${cc}"
229        }
230}
231
232def architecture_from_params( arch ) {
233        switch( arch ) {
234                case 'x64':
235                        return '--host=x86_64'
236                break
237                case 'x86':
238                        return '--host=i386'
239                break
240                default :
241                        error "Unhandled architecture : ${arch}"
242        }
243}
244
245//===========================================================================================================
246// Main compilation routines
247//===========================================================================================================
248def clean() {
249        build_stage('Cleanup') {
250                // clean the build by wipping the build directory
251                dir(builddir) {
252                        deleteDir()
253                }
254
255                //Clean all temporary files to make sure no artifacts of the previous build remain
256                sh 'git clean -fdqx'
257
258                //Reset the git repo so no local changes persist
259                sh 'git reset --hard'
260        }
261}
262
263//Compilation script is done here but environnement set-up and error handling is done in main loop
264def checkout() {
265        build_stage('Checkout') {
266                //checkout the source code and clean the repo
267                checkout scm
268        }
269}
270
271def build() {
272        build_stage('Build') {
273                // Build outside of the src tree to ease cleaning
274                dir (builddir) {
275                        //Configure the conpilation (Output is not relevant)
276                        //Use the current directory as the installation target so nothing escapes the sandbox
277                        //Also specify the compiler by hand
278                        sh "${srcdir}/configure CXX=${compiler.cpp_cc} ${architecture} --with-backend-compiler=${compiler.cfa_cc} --enable-silent-rules --quiet"
279
280                        //Compile the project
281                        sh 'make -j 8 --no-print-directory'
282                }
283        }
284}
285
286def test() {
287        build_stage('Test') {
288
289                dir (builddir) {
290                        //Run the tests from the tests directory
291                        if ( do_alltests ) {
292                                sh 'make --no-print-directory -C src/tests all-tests debug=yes'
293                                sh 'make --no-print-directory -C src/tests all-tests debug=no '
294                        }
295                        else {
296                                sh 'make --no-print-directory -C src/tests'
297                        }
298                }
299        }
300}
301
302def benchmark() {
303        build_stage('Benchmark') {
304
305                if( !do_benchmark ) return
306
307                dir (builddir) {
308                        //Append bench results
309                        sh "make --no-print-directory -C src/benchmark jenkins githash=${gitRefNewValue} arch=${arch_name} | tee ${srcdir}/bench.json"
310                }
311        }
312}
313
314def build_doc() {
315        build_stage('Documentation') {
316
317                if( !do_doc ) return
318
319                dir ('doc/user') {
320                        make_doc()
321                }
322
323                dir ('doc/refrat') {
324                        make_doc()
325                }
326        }
327}
328
329def publish() {
330        build_stage('Publish') {
331
332                if( !do_publish ) return
333
334                //Then publish the results
335                sh 'curl --silent --show-error -H \'Content-Type: application/json\' --data @bench.json https://cforall.uwaterloo.ca:8082/jenkins/publish > /dev/null || true'
336        }
337}
338
339//===========================================================================================================
340//Routine responsible of sending the email notification once the build is completed
341//===========================================================================================================
342//Standard build email notification
343def email(String status, boolean log, boolean bIsSandbox) {
344        //Since tokenizer doesn't work, figure stuff out from the environnement variables and command line
345        //Configurations for email format
346        def project_name = (env.JOB_NAME =~ /(.+)\/.+/)[0][1].toLowerCase()
347
348        def gitLog = 'Error retrieving git logs'
349        def gitDiff = 'Error retrieving git diff'
350
351        try {
352
353                sh "git rev-list --format=short ${gitRefOldValue}...${gitRefNewValue} > GIT_LOG"
354                gitLog = readFile('GIT_LOG')
355
356                sh "git diff --stat ${gitRefNewValue} ${gitRefOldValue} > GIT_DIFF"
357                gitDiff = readFile('GIT_DIFF')
358        }
359        catch (Exception error) {}
360
361        def email_subject = "[${project_name} git][BUILD# ${env.BUILD_NUMBER} - ${status}] - branch ${env.BRANCH_NAME}"
362        def email_body = """This is an automated email from the Jenkins build machine. It was
363generated because of a git hooks/post-receive script following
364a ref change was pushed to the repository containing
365the project "UNNAMED PROJECT".
366
367The branch ${env.BRANCH_NAME} has been updated.
368   via  ${gitRefOldValue} (commit)
369  from  ${gitRefNewValue} (commit)
370
371Check console output at ${env.BUILD_URL} to view the results.
372
373- Status --------------------------------------------------------------
374
375BUILD# ${env.BUILD_NUMBER} - ${status}
376
377- Log -----------------------------------------------------------------
378${gitLog}
379-----------------------------------------------------------------------
380Summary of changes:
381${gitDiff}
382"""
383
384        def email_to = "cforall@lists.uwaterloo.ca"
385
386        if( !bIsSandbox ) {
387                //send email notification
388                emailext body: email_body, subject: email_subject, to: email_to, attachLog: log
389        } else {
390                echo "Would send email to: ${email_to}"
391                echo "With title: ${email_subject}"
392                echo "Content: \n${email_body}"
393        }
394}
Note: See TracBrowser for help on using the repository browser.