-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
Jenkinsfile
678 lines (565 loc) · 33 KB
/
Jenkinsfile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
#!/usr/bin/env groovy
/*
* Copyright (C) 2019 - present Instructure, Inc.
*
* This file is part of Canvas.
*
* Canvas is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the Free
* Software Foundation, version 3 of the License.
*
* Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
* A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
final static JS_BUILD_IMAGE_STAGE = 'Javascript (Build Image)'
final static LINTERS_BUILD_IMAGE_STAGE = 'Linters (Build Image)'
final static RUN_MIGRATIONS_STAGE = 'Run Migrations'
final static BUILD_DOCKER_IMAGE_STAGE = 'Build Docker Image'
def buildParameters = [
string(name: 'GERRIT_REFSPEC', value: "${env.GERRIT_REFSPEC}"),
string(name: 'GERRIT_EVENT_TYPE', value: "${env.GERRIT_EVENT_TYPE}"),
string(name: 'GERRIT_PROJECT', value: "${env.GERRIT_PROJECT}"),
string(name: 'GERRIT_BRANCH', value: "${env.GERRIT_BRANCH}"),
string(name: 'GERRIT_CHANGE_NUMBER', value: "${env.GERRIT_CHANGE_NUMBER}"),
string(name: 'GERRIT_CHANGE_SUBJECT', value: "${env.GERRIT_CHANGE_SUBJECT}"),
string(name: 'GERRIT_PATCHSET_NUMBER', value: "${env.GERRIT_PATCHSET_NUMBER}"),
string(name: 'GERRIT_PATCHSET_REVISION', value: "${env.GERRIT_PATCHSET_REVISION}"),
string(name: 'GERRIT_EVENT_ACCOUNT_NAME', value: "${env.GERRIT_EVENT_ACCOUNT_NAME}"),
string(name: 'GERRIT_EVENT_ACCOUNT_EMAIL', value: "${env.GERRIT_EVENT_ACCOUNT_EMAIL}"),
string(name: 'GERRIT_CHANGE_COMMIT_MESSAGE', value: "${env.GERRIT_CHANGE_COMMIT_MESSAGE}"),
string(name: 'GERRIT_HOST', value: "${env.GERRIT_HOST}"),
string(name: 'GERGICH_PUBLISH', value: "${env.GERGICH_PUBLISH}"),
string(name: 'MASTER_BOUNCER_RUN', value: "${env.MASTER_BOUNCER_RUN}"),
string(name: 'CRYSTALBALL_MAP_S3_VERSION', value: "${env.CRYSTALBALL_MAP_S3_VERSION}")
]
commitMessageFlag.setEnabled(env.GERRIT_EVENT_TYPE != 'change-merged')
library "canvas-builds-library@${getCanvasBuildsRefspec()}"
loadLocalLibrary('local-lib', 'build/new-jenkins/library')
commitMessageFlag.setDefaultValues(commitMessageFlagDefaults() + commitMessageFlagPrivateDefaults())
protectedNode.setReportUnhandledExceptions(!env.JOB_NAME.endsWith('Jenkinsfile'))
def getSummaryUrl() {
return "${env.BUILD_URL}/build-summary-report"
}
def getDockerWorkDir() {
if (env.GERRIT_PROJECT == 'qti_migration_tool') {
return "/usr/src/app/vendor/${env.GERRIT_PROJECT}"
}
return env.GERRIT_PROJECT == 'canvas-lms' ? '/usr/src/app/' : "/usr/src/app/gems/plugins/${env.GERRIT_PROJECT}/"
}
def getLocalWorkDir() {
if (env.GERRIT_PROJECT == 'qti_migration_tool') {
return "vendor/${env.GERRIT_PROJECT}"
}
return env.GERRIT_PROJECT == 'canvas-lms' ? '.' : "gems/plugins/${env.GERRIT_PROJECT}"
}
def isPatchsetPublishable() {
env.PUBLISH_PATCHSET_IMAGE == "1"
}
def isPatchsetRetriggered() {
if (env.IS_AUTOMATIC_RETRIGGER == '1') {
return true
}
def userCause = currentBuild.getBuildCauses('com.sonyericsson.hudson.plugins.gerrit.trigger.hudsontrigger.GerritUserCause')
return userCause && userCause[0].shortDescription.contains('Retriggered')
}
def isStartedByUser() {
return currentBuild.getBuildCauses('hudson.model.Cause$UserIdCause')
}
def postFn(status) {
try {
def requestStartTime = System.currentTimeMillis()
node('master') {
def requestEndTime = System.currentTimeMillis()
reportToSplunk('node_request_time', [
'nodeName': 'master',
'nodeLabel': 'master',
'requestTime': requestEndTime - requestStartTime,
])
buildSummaryReport.publishReport('Build Summary Report', status)
if (isPatchsetPublishable()) {
dockerUtils.tagRemote(env.PATCHSET_TAG, env.EXTERNAL_TAG)
}
if (status == 'SUCCESS' && configuration.isChangeMerged() && isPatchsetPublishable()) {
dockerUtils.tagRemote(env.PATCHSET_TAG, env.MERGE_TAG)
dockerUtils.tagRemote(env.CASSANDRA_IMAGE_TAG, env.CASSANDRA_MERGE_IMAGE)
dockerUtils.tagRemote(env.DYNAMODB_IMAGE_TAG, env.DYNAMODB_MERGE_IMAGE)
dockerUtils.tagRemote(env.POSTGRES_IMAGE_TAG, env.POSTGRES_MERGE_IMAGE)
dockerUtils.tagRemote(env.KARMA_RUNNER_IMAGE, env.KARMA_MERGE_IMAGE)
}
if (isStartedByUser()) {
submitGerritReview((status == 'SUCCESS' ? '--verified +1' : '--verified -1'), "${env.BUILD_URL}/build-summary-report/")
}
}
build(job: "/Canvas/helpers/junit-uploader", parameters: [
string(name: 'GERRIT_REFSPEC', value: "${env.GERRIT_REFSPEC}"),
string(name: 'GERRIT_EVENT_TYPE', value: "${env.GERRIT_EVENT_TYPE}"),
string(name: 'SOURCE', value: "${env.JOB_NAME}/${env.BUILD_NUMBER}"),
], propagate: false, wait: false)
} finally {
if (status == 'SUCCESS') {
maybeSlackSendSuccess()
} else {
maybeSlackSendFailure()
maybeRetrigger()
}
}
}
def shouldPatchsetRetrigger() {
// NOTE: The IS_AUTOMATIC_RETRIGGER check is here to ensure that the parameter is properly defined for the triggering job.
// If it isn't, we have the risk of triggering this job over and over in an infinite loop.
return env.IS_AUTOMATIC_RETRIGGER == '0' && (
configuration.isChangeMerged() && (commitMessageFlag('enable-automatic-retrigger') as Boolean)
)
}
def maybeRetrigger() {
if (shouldPatchsetRetrigger() && !isPatchsetRetriggered()) {
def retriggerParams = currentBuild.rawBuild.getAction(ParametersAction).getParameters()
retriggerParams = retriggerParams.findAll { record ->
record.name != 'IS_AUTOMATIC_RETRIGGER'
}
retriggerParams << new StringParameterValue('IS_AUTOMATIC_RETRIGGER', '1')
build(job: env.JOB_NAME, parameters: retriggerParams, propagate: false, wait: false)
}
}
def maybeSlackSendFailure() {
if (configuration.isChangeMerged()) {
def extra = 'Oh no! Your build failed the post-merge checks. If you have a test failure not related to your build, please reach out to the owning team and ask them to skip or fix the failed test. Spec flakiness can be investigated <https://inst.splunkcloud.com/en-US/app/search/canvas_spec_tracker|here>. Otherwise, tag our @ oncall for help in diagnosing the build issue if it is unclear.'
slackHelpers.sendSlackFailureWithMsg(getSlackChannel(), extra, true)
} else {
slackHelpers.sendSlackFailureWithDuration('#canvas_builds-noisy')
}
}
def maybeSlackSendSuccess() {
if (configuration.isChangeMerged() && isPatchsetRetriggered()) {
def patchsetPrefix = env.GERRIT_CHANGE_URL ? "Patchset <${env.GERRIT_CHANGE_URL}|#${env.GERRIT_CHANGE_NUMBER}>" : env.JOB_NAME
slackSend(
channel: getSlackChannel(),
color: 'good',
message: "${patchsetPrefix} succeeded on re-trigger. Build <${getSummaryUrl()}|#${env.BUILD_NUMBER}>"
)
}
slackSend(
channel: '#canvas_builds-noisy',
color: 'good',
message: "${env.JOB_NAME} <${getSummaryUrl()}|#${env.BUILD_NUMBER}> succeeded. Patchset <${env.GERRIT_CHANGE_URL}|#${env.GERRIT_CHANGE_NUMBER}>. (${currentBuild.durationString})"
)
}
def maybeSlackSendRetrigger() {
if (configuration.isChangeMerged() && isPatchsetRetriggered()) {
def patchsetPrefix = env.GERRIT_CHANGE_URL ? "Patchset <${env.GERRIT_CHANGE_URL}|#${env.GERRIT_CHANGE_NUMBER}>" : env.JOB_NAME
slackSend(
channel: getSlackChannel(),
color: 'warning',
message: "${patchsetPrefix} by ${env.GERRIT_EVENT_ACCOUNT_EMAIL} has been re-triggered. Build <${env.BUILD_URL}|#${env.BUILD_NUMBER}>"
)
}
}
@groovy.transform.Field final static GERRIT_CHANGE_ID_REGEX = /Change\-Id: (.*)/
def getChangeId() {
if (env.GERRIT_CHANGE_ID) {
return env.GERRIT_CHANGE_ID
}
def commitMessage = env.GERRIT_CHANGE_COMMIT_MESSAGE ? new String(env.GERRIT_CHANGE_COMMIT_MESSAGE.decodeBase64()) : null
if (!commitMessage) {
error 'GERRIT_CHANGE_COMMIT_MESSAGE not found! You must provide a commit message!'
}
return (commitMessage =~ GERRIT_CHANGE_ID_REGEX).findAll()[0][1]
}
// These functions are intentionally pinned to GERRIT_EVENT_TYPE == 'change-merged' to ensure that real post-merge
// builds always run correctly. We intentionally ignore overrides for version pins, docker image paths, etc when
// running real post-merge builds.
// =========
def getSlackChannel() {
return env.SLACK_CHANNEL_OVERRIDE ?: env.GERRIT_EVENT_TYPE == 'change-merged' ? '#canvas_builds' : '#devx-bots'
}
def getCanvasBuildsRefspec() {
def defaultValue = env.GERRIT_BRANCH.contains('stable/') ? env.GERRIT_BRANCH : 'master'
return commitMessageFlag('canvas-builds-refspec') as String ?: defaultValue
}
def getCanvasLmsRefspec() {
def defaultBranch = env.GERRIT_BRANCH.contains('stable/') ? env.GERRIT_BRANCH : 'master'
def defaultValue = "+refs/heads/$defaultBranch:refs/remotes/origin/$defaultBranch"
return commitMessageFlag('canvas-lms-refspec') as String ?: defaultValue
}
// =========
pipeline {
agent none
options {
ansiColor('xterm')
timeout(time: 8, unit: 'HOURS')
timestamps()
}
environment {
GERRIT_PORT = '29418'
GERRIT_URL = "$GERRIT_HOST:$GERRIT_PORT"
BUILD_REGISTRY_FQDN = configuration.buildRegistryFQDN()
BUILD_IMAGE = configuration.buildRegistryPath()
POSTGRES = configuration.postgres()
POSTGRES_CLIENT = configuration.postgresClient()
RSPEC_PROCESSES = commitMessageFlag('rspecq-processes').asType(Integer)
GERRIT_CHANGE_ID = getChangeId()
// e.g. postgres-12-ruby-2.6
TAG_SUFFIX = imageTag.suffix()
// e.g. canvas-lms:01.123456.78-postgres-12-ruby-2.6
PATCHSET_TAG = imageTag.patchset()
// e.g. canvas-lms:master when not on another branch
MERGE_TAG = imageTag.mergeTag()
// e.g. canvas-lms:01.123456.78; this is for consumers like Portal 2 who want to build a patchset
EXTERNAL_TAG = imageTag.externalTag()
RUBY = configuration.ruby() // RUBY_VERSION is a reserved keyword for ruby installs
FORCE_CRYSTALBALL = "${commitMessageFlag('force-crystalball').asBooleanInteger()}"
BASE_RUNNER_PREFIX = configuration.buildRegistryPath('base-runner')
CASSANDRA_PREFIX = configuration.buildRegistryPath('cassandra-migrations')
DYNAMODB_PREFIX = configuration.buildRegistryPath('dynamodb-migrations')
KARMA_RUNNER_PREFIX = configuration.buildRegistryPath('karma-runner')
LINTERS_RUNNER_PREFIX = configuration.buildRegistryPath('linters-runner')
POSTGRES_PREFIX = configuration.buildRegistryPath('postgres-migrations')
RUBY_RUNNER_PREFIX = configuration.buildRegistryPath('ruby-runner')
YARN_RUNNER_PREFIX = configuration.buildRegistryPath('yarn-runner')
WEBPACK_BUILDER_PREFIX = configuration.buildRegistryPath('webpack-builder')
WEBPACK_ASSETS_PREFIX = configuration.buildRegistryPath('webpack-assets')
WEBPACK_CACHE_PREFIX = configuration.buildRegistryPath('webpack-cache')
IMAGE_CACHE_BUILD_SCOPE = configuration.gerritChangeNumber()
IMAGE_CACHE_MERGE_SCOPE = configuration.gerritBranchSanitized()
IMAGE_CACHE_UNIQUE_SCOPE = "${imageTagVersion()}-$TAG_SUFFIX"
CASSANDRA_IMAGE_TAG = "$CASSANDRA_PREFIX:$IMAGE_CACHE_UNIQUE_SCOPE"
DYNAMODB_IMAGE_TAG = "$DYNAMODB_PREFIX:$IMAGE_CACHE_UNIQUE_SCOPE"
POSTGRES_IMAGE_TAG = "$POSTGRES_PREFIX:$IMAGE_CACHE_UNIQUE_SCOPE"
WEBPACK_BUILDER_IMAGE = "$WEBPACK_BUILDER_PREFIX:$IMAGE_CACHE_UNIQUE_SCOPE"
WEBPACK_ASSETS_IMAGE = "$WEBPACK_ASSETS_PREFIX:$IMAGE_CACHE_UNIQUE_SCOPE"
CASSANDRA_MERGE_IMAGE = "$CASSANDRA_PREFIX:$IMAGE_CACHE_MERGE_SCOPE-${env.RSPEC_PROCESSES ?: '4'}"
DYNAMODB_MERGE_IMAGE = "$DYNAMODB_PREFIX:$IMAGE_CACHE_MERGE_SCOPE-${env.RSPEC_PROCESSES ?: '4'}"
KARMA_RUNNER_IMAGE = "$KARMA_RUNNER_PREFIX:$IMAGE_CACHE_UNIQUE_SCOPE"
KARMA_MERGE_IMAGE = "$KARMA_RUNNER_PREFIX:$IMAGE_CACHE_MERGE_SCOPE"
LINTERS_RUNNER_IMAGE = "$LINTERS_RUNNER_PREFIX:$IMAGE_CACHE_UNIQUE_SCOPE"
POSTGRES_MERGE_IMAGE = "$POSTGRES_PREFIX:$IMAGE_CACHE_MERGE_SCOPE-${env.RSPEC_PROCESSES ?: '4'}"
// This is primarily for the plugin build
// for testing canvas-lms changes against plugin repo changes
CANVAS_BUILDS_REFSPEC = getCanvasBuildsRefspec()
CANVAS_LMS_REFSPEC = getCanvasLmsRefspec()
DOCKER_WORKDIR = getDockerWorkDir()
LOCAL_WORKDIR = getLocalWorkDir()
// TEST_CACHE_CLASSES is consumed by config/environments/test.rb
// to decide whether to allow class reloading or not.
// in local development we usually want this unset or set to '0' because
// we want spring to be able to reload classes between
// spec runs, but this is expensive when running all the
// specs for the build. EVERYWHERE in the build we want
// to be able to cache classes because they don't change while the build
// is running and should never be reloaded.
TEST_CACHE_CLASSES = '1'
}
stages {
stage('Environment') {
steps {
script {
lock(label: 'canvas_build_global_mutex', quantity: 1) {
timeout(60) {
// Skip translation builds for patchsets uploaded by svc.cloudjenkins
if (env.GERRIT_PATCHSET_UPLOADER_EMAIL == '[email protected]' && env.GERRIT_CHANGE_SUBJECT =~ /translation$/) {
// Set status to NOT_BUILT for pre-merge builds
if (!configuration.isChangeMerged()) {
currentBuild.result = 'NOT_BUILT'
}
return
}
node('master') {
// For builds like Rails 6.1 prototype, we want to be able to see the build link, but
// not have Gerrit vote on it. This isn't currently supported through the Gerrit Trigger
// plugin, because the Build Started message always votes and will clear the original
// vote. Work around this by disabling the build start message and setting EMULATE_BUILD_START=1
// in the Build Parameters section.
// https://issues.jenkins.io/browse/JENKINS-28339
if (commitMessageFlag("emulate-build-start") as Boolean) {
submitGerritReview("", "Build Started ${RUN_DISPLAY_URL}")
}
if (commitMessageFlag("skip-ci") as Boolean) {
currentBuild.result = 'NOT_BUILT'
submitGerritReview('--label Lint-Review=-2', 'Build not executed due to [skip-ci] flag')
error '[skip-ci] flag enabled: skipping the build'
return
} else if (extendedStage.isAllowStagesFilterUsed() || extendedStage.isIgnoreStageResultsFilterUsed() || extendedStage.isSkipStagesFilterUsed()) {
submitGerritReview('--label Lint-Review=-2', 'One or more build flags causes a subset of the build to be run')
} else if (setupStage.hasGemOverrides()) {
submitGerritReview('--label Lint-Review=-2', 'One or more build flags causes the build to be run against an unmerged gem or plugin version; if you need to coordinate merging multiple changes at once, you may want to edit the commit message to remove this flag after Jenkins has run tests')
} else {
submitGerritReview('--label Lint-Review=0')
}
}
if (isStartedByUser()) {
env.GERRIT_PATCHSET_REVISION = git.getRevisionHash()
buildParameters += string(name: 'GERRIT_PATCHSET_REVISION', value: "${env.GERRIT_PATCHSET_REVISION}")
}
// Ensure that all build flags are compatible.
if (commitMessageFlag('change-merged') as Boolean && configuration.buildRegistryPath() == configuration.buildRegistryPathDefault()) {
error 'Manually triggering the change-merged build path must be combined with a custom build-registry-path'
return
}
maybeSlackSendRetrigger()
def postBuildHandler = [
onStageEnded: { stageName, stageConfig, result ->
buildSummaryReport.addFailureRun('Main Build', currentBuild)
postFn(stageConfig.status())
}
]
extendedStage('Root').hooks(postBuildHandler).obeysAllowStages(false).reportTimings(false).execute {
def rootStages = [:]
buildParameters += string(name: 'CANVAS_BUILDS_REFSPEC', value: "${env.CANVAS_BUILDS_REFSPEC}")
buildParameters += string(name: 'PATCHSET_TAG', value: "${env.PATCHSET_TAG}")
buildParameters += string(name: 'POSTGRES', value: "${env.POSTGRES}")
buildParameters += string(name: 'RUBY', value: "${env.RUBY}")
buildParameters += string(name: 'CANVAS_RAILS', value: "${env.CANVAS_RAILS}")
// If modifying any of our Jenkinsfiles set JENKINSFILE_REFSPEC for sub-builds to use Jenkinsfiles in
// the gerrit rather than master. Stable branches also need to check out the JENKINSFILE_REFSPEC to prevent
// the job default from pulling master.
if (env.GERRIT_PROJECT == 'canvas-lms' && env.JOB_NAME.endsWith('Jenkinsfile')) {
buildParameters += string(name: 'JENKINSFILE_REFSPEC', value: "${env.GERRIT_REFSPEC}")
} else if (env.GERRIT_PROJECT == 'canvas-lms' && env.JOB_NAME.endsWith('stable')) {
buildParameters += string(name: 'JENKINSFILE_REFSPEC', value: "${env.GERRIT_REFSPEC}")
}
if (env.GERRIT_PROJECT != 'canvas-lms') {
// the plugin builds require the canvas lms refspec to be different. so only
// set this refspec if the main build is requesting it to be set.
// NOTE: this is only being set in main-from-plugin build. so main-canvas wont run this.
buildParameters += string(name: 'CANVAS_LMS_REFSPEC', value: env.CANVAS_LMS_REFSPEC)
}
extendedStage('Builder').nodeRequirements(label: nodeLabel(), podTemplate: null).obeysAllowStages(false).reportTimings(false).queue(rootStages) {
extendedStage('Setup')
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.timeout(2)
.execute {
buildDockerImageStage.preloadCacheImagesAsync()
setupStage()
}
extendedStage('Rebase')
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.required(!configuration.isChangeMerged() && env.GERRIT_PROJECT == 'canvas-lms')
.timeout(2)
.execute { rebaseStage() }
extendedStage(filesChangedStage.STAGE_NAME)
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.timeout(2)
.execute(filesChangedStage.&preBuild)
extendedStage('Build Docker Image (Pre-Merge)')
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.required(configuration.isChangeMerged())
.timeout(20)
.execute(buildDockerImageStage.&premergeCacheImage)
extendedStage(BUILD_DOCKER_IMAGE_STAGE)
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.timeout(20)
.execute {
def startStep = '''
docker run -dt --name general-build-container --volume $(pwd)/$LOCAL_WORKDIR/.git:$DOCKER_WORKDIR/.git -e RAILS_ENV=test $PATCHSET_TAG bash -c "sleep infinity"
docker exec -dt general-build-container bin/rails graphql:schema
'''
@SuppressWarnings('GStringExpressionWithinString')
def crystalballStep = '''
diffFrom=$(git --git-dir $LOCAL_WORKDIR/.git rev-parse $GERRIT_PATCHSET_REVISION^1)
# crystalball will fail without adding $DOCKER_WORKDIR to safe.directory
docker exec -t general-build-container bash -c "git config --global --add safe.directory ${DOCKER_WORKDIR%/}"
docker exec -dt \
-e CRYSTALBALL_DIFF_FROM=$diffFrom \
-e CRYSTALBALL_DIFF_TO=$GERRIT_PATCHSET_REVISION \
-e CRYSTALBALL_REPO_PATH=$DOCKER_WORKDIR \
-e FORCE_CRYSTALBALL=$FORCE_CRYSTALBALL \
general-build-container bundle exec crystalball --dry-run
'''
def finalStep = '''
docker exec -t general-build-container ps aww
'''
def asyncSteps = [
startStep,
!configuration.isChangeMerged() && env.GERRIT_REFSPEC != 'refs/heads/master' ? crystalballStep : '',
finalStep
]
buildDockerImageStage.patchsetImage(asyncSteps.join("\n"))
}
extendedStage(filesChangedStage.STAGE_NAME_POST_BUILD)
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.timeout(2)
.execute(filesChangedStage.&postBuild)
extendedStage(RUN_MIGRATIONS_STAGE)
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.timeout(10)
.execute { runMigrationsStage() }
extendedStage('Generate Crystalball Prediction')
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.required(!configuration.isChangeMerged() && env.GERRIT_REFSPEC != "refs/heads/master")
.timeout(2)
.execute {
try {
/* groovylint-disable-next-line GStringExpressionWithinString */
sh '''#!/bin/bash
set -ex
while docker exec -t general-build-container ps aww | grep crystalball; do
sleep 0.1
done
docker exec -t general-build-container bash -c 'cat log/crystalball.log'
docker cp \$(docker ps -qa -f name=general-build-container):/usr/src/app/crystalball_spec_list.txt ./tmp/crystalball_spec_list.txt
'''
archiveArtifacts allowEmptyArchive: true, artifacts: 'tmp/crystalball_spec_list.txt'
sh 'grep ":timestamp:" crystalball_map.yml | sed "s/:timestamp: //g" > ./tmp/crystalball_map_version.txt'
archiveArtifacts allowEmptyArchive: true, artifacts: 'tmp/crystalball_map_version.txt'
/* groovylint-disable-next-line CatchException */
} catch (Exception e) {
// default to full run of specs
sh 'echo -n "." > tmp/crystalball_spec_list.txt'
sh 'echo -n "broken map, defaulting to run all tests" > tmp/crystalball_map_version.txt'
archiveArtifacts allowEmptyArchive: true, artifacts: 'tmp/crystalball_spec_list.txt, tmp/crystalball_map_version.txt'
slackSend(
channel: '#crystalball-noisy',
color: 'danger',
message: "${env.JOB_NAME} <${getSummaryUrl()}|#${env.BUILD_NUMBER}>\n\nFailed to generate prediction!"
)
}
}
extendedStage('Locales Only Changes')
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.required(!configuration.isChangeMerged() && env.GERRIT_PROJECT == 'canvas-lms' && sh(script: "${WORKSPACE}/build/new-jenkins/locales-changes.sh", returnStatus: true) == 0)
.execute {
submitGerritReview('--label Lint-Review=-2', 'This commit contains only changes to config/locales/, this could be a bad sign!')
}
extendedStage('Webpack Bundle Size Check')
.hooks(buildSummaryReportHooks.call())
.obeysAllowStages(false)
.required(configuration.isChangeMerged())
.timeout(20)
.execute { webpackStage.&calcBundleSizes() }
extendedStage('Parallel Run Tests').obeysAllowStages(false).execute { stageConfig, buildConfig ->
def stages = [:]
extendedStage('Consumer Smoke Test').hooks(buildSummaryReportHooks.call()).queue(stages) {
sh 'build/new-jenkins/consumer-smoke-test.sh'
}
def shouldRunJS = configuration.isChangeMerged() || commitMessageFlag('force-failure-js') as Boolean ||
(!configuration.isChangeMerged() && (filesChangedStage.hasGraphqlFiles(buildConfig) || filesChangedStage.hasJsFiles(buildConfig)))
extendedStage(JS_BUILD_IMAGE_STAGE)
.hooks(buildSummaryReportHooks.call())
.required(shouldRunJS)
.queue(stages, buildDockerImageStage.&jsImage)
extendedStage(LINTERS_BUILD_IMAGE_STAGE)
.hooks(buildSummaryReportHooks.call())
.queue(stages, buildDockerImageStage.&lintersImage)
extendedStage('Run i18n:extract')
.hooks(buildSummaryReportHooks.call())
.required(configuration.isChangeMerged())
.queue(stages, buildDockerImageStage.&i18nExtract)
parallel(stages)
}
}
extendedStage('ARM64 Builder - Container')
.hooks(buildSummaryReportHooks.call())
.nodeRequirements(label: 'docker-arm64')
.required(configuration.isChangeMerged())
.queue(rootStages) {
extendedStage('ARM64 Builder').execute {
setupStage()
// Rebase is fortunately not needed - since this only runs in post-merge
buildDockerImageStage.patchsetImage('', '-arm64')
}
extendedStage('Augment Manifest').waitsFor(BUILD_DOCKER_IMAGE_STAGE, 'Builder').execute {
sh """#!/bin/bash -ex
docker manifest create --amend $PATCHSET_TAG $PATCHSET_TAG $PATCHSET_TAG-arm64
docker manifest push $PATCHSET_TAG
"""
}
}
extendedStage("${filesChangedStage.STAGE_NAME} (Waiting for Dependencies)").obeysAllowStages(false).waitsFor(filesChangedStage.STAGE_NAME, 'Builder').queue(rootStages) { stageConfig, buildConfig ->
def nestedStages = [:]
extendedStage('Local Docker Dev Build')
.hooks(buildSummaryReportHooks.call())
.required(env.GERRIT_PROJECT == 'canvas-lms' && filesChangedStage.hasDockerDevFiles(buildConfig))
.queue(nestedStages, jobName: '/Canvas/test-suites/local-docker-dev-smoke', buildParameters: buildParameters)
parallel(nestedStages)
}
extendedStage('Javascript (Waiting for Dependencies)').obeysAllowStages(false).waitsFor(JS_BUILD_IMAGE_STAGE, 'Builder').queue(rootStages) {
def nestedStages = [:]
extendedStage('Javascript')
.hooks(buildSummaryReportHooks.withRunManifest(true))
.queue(nestedStages, jobName: '/Canvas/test-suites/JS', buildParameters: buildParameters + [
string(name: 'KARMA_RUNNER_IMAGE', value: env.KARMA_RUNNER_IMAGE),
])
parallel(nestedStages)
}
extendedStage('Linters (Waiting for Dependencies)').obeysAllowStages(false).waitsFor(LINTERS_BUILD_IMAGE_STAGE, 'Builder').queue(rootStages) { stageConfig, buildConfig ->
extendedStage('Linters - Dependency Check')
.nodeRequirements(label: nodeLabel(), podTemplate: dependencyCheckStage.nodeRequirementsTemplate(), container: 'dependency-check')
.required(configuration.isChangeMerged())
.execute(dependencyCheckStage.queueTestStage())
extendedStage('Linters')
.hooks([onNodeReleasing: lintersStage.tearDownNode()])
.nodeRequirements(label: nodeLabel(), podTemplate: lintersStage.nodeRequirementsTemplate())
.required(!configuration.isChangeMerged() && env.GERRIT_CHANGE_ID != '0')
.execute {
def nestedStages = [:]
callableWithDelegate(lintersStage.bundleStage(nestedStages, buildConfig))()
callableWithDelegate(lintersStage.codeStage(nestedStages))()
callableWithDelegate(lintersStage.masterBouncerStage(nestedStages))()
callableWithDelegate(lintersStage.yarnStage(nestedStages, buildConfig))()
parallel(nestedStages)
}
}
extendedStage("${RUN_MIGRATIONS_STAGE} (Waiting for Dependencies)").obeysAllowStages(false).waitsFor(RUN_MIGRATIONS_STAGE, 'Builder').queue(rootStages) { stageConfig, buildConfig ->
def nestedStages = [:]
extendedStage('Contract Tests')
.hooks(buildSummaryReportHooks.call())
.queue(nestedStages, jobName: '/Canvas/test-suites/contract-tests', buildParameters: buildParameters + [
string(name: 'CASSANDRA_IMAGE_TAG', value: "${env.CASSANDRA_IMAGE_TAG}"),
string(name: 'DYNAMODB_IMAGE_TAG', value: "${env.DYNAMODB_IMAGE_TAG}"),
string(name: 'POSTGRES_IMAGE_TAG', value: "${env.POSTGRES_IMAGE_TAG}"),
])
// Trigger Crystalball map build if spec files were added or removed, will not vote on builds.
// Only trigger for main-postmerge job.
if (env.JOB_NAME == "Canvas/main-postmerge" && configuration.isChangeMerged() && filesChangedStage.hasNewDeletedSpecFiles(buildConfig)) {
build(wait: false, job: 'Canvas/helpers/crystalball-map')
}
extendedStage('Flakey Spec Catcher')
.hooks(buildSummaryReportHooks.call())
.required(!configuration.isChangeMerged() && filesChangedStage.hasSpecFiles(buildConfig) || commitMessageFlag('force-failure-fsc') as Boolean)
.queue(nestedStages, jobName: '/Canvas/test-suites/flakey-spec-catcher', buildParameters: buildParameters + [
string(name: 'CASSANDRA_IMAGE_TAG', value: "${env.CASSANDRA_IMAGE_TAG}"),
string(name: 'DYNAMODB_IMAGE_TAG', value: "${env.DYNAMODB_IMAGE_TAG}"),
string(name: 'POSTGRES_IMAGE_TAG', value: "${env.POSTGRES_IMAGE_TAG}"),
])
extendedStage('Vendored Gems')
.hooks(buildSummaryReportHooks.call())
.queue(nestedStages, jobName: '/Canvas/test-suites/vendored-gems', buildParameters: buildParameters + [
string(name: 'CASSANDRA_IMAGE_TAG', value: "${env.CASSANDRA_IMAGE_TAG}"),
string(name: 'DYNAMODB_IMAGE_TAG', value: "${env.DYNAMODB_IMAGE_TAG}"),
string(name: 'POSTGRES_IMAGE_TAG', value: "${env.POSTGRES_IMAGE_TAG}"),
])
extendedStage('RspecQ Tests')
.hooks(buildSummaryReportHooks.withRunManifest())
.queue(nestedStages, jobName: '/Canvas/test-suites/test-queue', buildParameters: buildParameters + [
string(name: 'CASSANDRA_IMAGE_TAG', value: "${env.CASSANDRA_IMAGE_TAG}"),
string(name: 'DYNAMODB_IMAGE_TAG', value: "${env.DYNAMODB_IMAGE_TAG}"),
string(name: 'POSTGRES_IMAGE_TAG', value: "${env.POSTGRES_IMAGE_TAG}"),
string(name: 'SKIP_CRYSTALBALL', value: "${env.SKIP_CRYSTALBALL || setupStage.hasGemOverrides()}"),
string(name: 'UPSTREAM_TAG', value: "${env.BUILD_TAG}"),
string(name: 'UPSTREAM', value: "${env.JOB_NAME}"),
])
parallel(nestedStages)
}
parallel(rootStages)
}
}
}
} // script
} // steps
} // environment
} // stages
} // pipeline