source: Jenkinsfile @ 3f9876e

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

Tentative fix of git log in email

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