source: Jenkinsfile @ 094a42c

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

Jenkins sandbox now shows preview of the email

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