-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathJenkinsfile
1161 lines (1133 loc) · 50.9 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
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env groovy
/*
* semanticcms-core-breadcrumblist-json-ld - BreadcrumbList for SemanticCMS in JSON-LD format.
* Copyright (C) 2021, 2022, 2023, 2024, 2025 AO Industries, Inc.
* 7262 Bull Pen Cir
* Mobile, AL 36695
*
* This file is part of semanticcms-core-breadcrumblist-json-ld.
*
* semanticcms-core-breadcrumblist-json-ld is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* semanticcms-core-breadcrumblist-json-ld 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with semanticcms-core-breadcrumblist-json-ld. If not, see <https://www.gnu.org/licenses/>.
*/
// Parent, Extensions, Plugins, Direct and BOM Dependencies
def upstreamProjects = [
// Parent
'../parent', // <groupId>com.semanticcms</groupId><artifactId>semanticcms-parent</artifactId>
// Direct
'../../oss/encoding', // <groupId>com.aoapps</groupId><artifactId>ao-encoding</artifactId>
'../../oss/fluent-html-servlet', // <groupId>com.aoapps</groupId><artifactId>ao-fluent-html-servlet</artifactId>
'../../oss/lang', // <groupId>com.aoapps</groupId><artifactId>ao-lang</artifactId>
'../../oss/net-types', // <groupId>com.aoapps</groupId><artifactId>ao-net-types</artifactId>
// No Jenkins: <groupId>javax.servlet</groupId><artifactId>javax.servlet-api</artifactId>
'model', // <groupId>com.semanticcms</groupId><artifactId>semanticcms-core-model</artifactId>
'servlet', // <groupId>com.semanticcms</groupId><artifactId>semanticcms-core-servlet</artifactId>
// BOM
'../../oss/javaee-web-api-bom', // <groupId>com.aoapps</groupId><artifactId>javaee-web-api-bom</artifactId>
]
/******************************************************************************************
* *
* Everything below this line is identical for all projects, except the copied matrix *
* axes and any "Begin .*custom" / "End .*custom" blocks (see filter_custom script). *
* *
* See https://issues.jenkins.io/browse/JENKINS-61047 *
* See https://issues.jenkins.io/browse/JENKINS-61280 *
* *
******************************************************************************************
* *
* Variables that may be defined above this block: *
* *
* deployJdk The version of JDK that will be used for the deploy stage. *
* Defaults to '21' *
* *
* buildJdks The array of JDK versions that will build. *
* Defaults to ['11', '17', '21'] *
* Changes must be copied to matrix axes! *
* *
* testJdks The array of JDK versions that will test against every build JDK. *
* Defaults to ['11', '17', '21'] *
* Changes must be copied to matrix axes! *
* *
* upstreamProjects The array of relative paths to upstream projects. *
* Defaults to [] *
* *
* projectDir The directory within the workspace containing the Maven project. *
* Default depends on the path of Jenkinsfile: *
* 'Jenkinsfile' -> '.' *
* 'book/Jenkinsfile' -> 'book' *
* 'devel/Jenkinsfile' -> 'devel' *
* *
* disableSubmodules Disables checkout of Git submodules. *
* Defaults to true *
* *
* sparseCheckoutPaths The sparse paths for Git checkout. *
* Default depends on projectDir: *
* '.' -> [[path:'/*'], *
* [path:'!/book/'], *
* [path:'!/devel/']] *
* 'book' -> [[path:'/.gitignore'], *
* [path:'/.gitmodules'], *
* [path:'/book/']] *
* 'devel' -> [[path:'/.gitignore'], *
* [path:'/.gitmodules'], *
* [path:'/devel/']] *
* *
* scmUrl The Git URL. *
* Default depends on the project's SCM settings: *
* scm.userRemoteConfigs[0].url *
* *
* scmBranch The Git branch name, without and ref/path prefix *
* Default depends on the project's SCM settings: *
* scm.branches[0].name: 'refs/heads/*' -> '*' *
* *
* scmBrowser The Git SCM browser URL. *
* Default depends on scmUrl: *
* '/srv/git/ao-apps/*' -> 'https://github.com/ao-apps/*' *
* '/srv/git/nmwoss/*' -> 'https://github.com/newmediaworks/*' *
* '/srv/git/*' -> No default *
* *
* buildPriority The build job priority from 1 to 30 (lower is build first). *
* Defaults to the depth in the upstreamProjects dependency graph. *
* *
* quietPeriod The time to delay between queuing job and starting build. *
* Default depends on buildPriority: *
* 10 + buildPriority * 2 *
* *
* nice The nice level to run the build processes or 0 for none. *
* Default depends on params.BuildPriority: *
* min(19, params.BuildPriority - 1) *
* *
* maven The Maven tool to use. *
* Defaults to 'maven-3' *
* *
* mavenOpts The Maven Java options. *
* Defaults to '-Djansi.force' for colorful logs *
* *
* extraProfiles An array of additional profiles to pass to Maven. *
* Defaults to [] *
* *
* testWhenExpression A closure determining when to run tests. *
* Defaults to {return fileExists(projectDir + '/src/test')} *
* *
* sonarqubeWhenExpression A closure determining when to perform SonarQube analysis. *
* Defaults to { *
* return !fileExists( *
* projectDir + '/.github/workflows/build.yml' *
* ) *
* } *
* *
* failureEmailTo The recipient of build failure emails. *
* Defaults to '[email protected]' *
* *
*****************************************************************************************/
// If RejectedAccessException, grant per-controller:
// https://jenkins.aoindustries.com/scriptApproval/
// "Approve"
// Repeat until all permissions granted
// JDK versions
if (!binding.hasVariable('deployJdk')) {
// Matches build.yml:java-version
binding.setVariable('deployJdk', '21')
}
if (!binding.hasVariable('buildJdks')) {
binding.setVariable(
'buildJdks',
['11', '17', '21'] // Changes must be copied to matrix axes!
)
}
if (!binding.hasVariable('testJdks')) {
binding.setVariable(
'testJdks',
['11', '17', '21'] // Changes must be copied to matrix axes!
)
}
if (!binding.hasVariable('upstreamProjects')) {
binding.setVariable('upstreamProjects', [])
}
if (!binding.hasVariable('projectDir')) {
def scriptPath = currentBuild.rawBuild.parent.definition.scriptPath
def projectDir
if (scriptPath == 'Jenkinsfile') {
projectDir = '.'
} else if (scriptPath == 'book/Jenkinsfile') {
projectDir = 'book'
} else if (scriptPath == 'devel/Jenkinsfile') {
projectDir = 'devel'
} else {
throw new Exception("Unexpected value for 'scriptPath': '$scriptPath'")
}
binding.setVariable('projectDir', projectDir)
}
if (!binding.hasVariable('disableSubmodules')) {
binding.setVariable('disableSubmodules', true)
}
if (!binding.hasVariable('sparseCheckoutPaths')) {
def sparseCheckoutPaths
if (projectDir == '.') {
sparseCheckoutPaths = [
[path:'/*'],
[path:'!/book/'],
[path:'!/devel/']
]
} else if (projectDir == 'book' || projectDir == 'devel') {
sparseCheckoutPaths = [
[path:'/.gitignore'],
[path:'/.gitmodules'],
[path:"/$projectDir/"]
]
} else {
throw new Exception("Unexpected value for 'projectDir': '$projectDir'")
}
binding.setVariable('sparseCheckoutPaths', sparseCheckoutPaths)
}
if (!binding.hasVariable('scmUrl')) {
// Automatically determine Git URL: https://stackoverflow.com/a/38255364
if (scm.userRemoteConfigs.size() == 1) {
binding.setVariable('scmUrl', scm.userRemoteConfigs[0].url)
} else {
throw new Exception("Precisely one SCM remote expected: '" + scm.userRemoteConfigs + "'")
}
}
if (!binding.hasVariable('scmBranch')) {
// Automatically determine branch
if (scm.branches.size() == 1) {
def scmBranchPrefix = 'refs/heads/'
def scmBranch = scm.branches[0].name
if (scmBranch.startsWith(scmBranchPrefix)) {
scmBranch = scmBranch.substring(scmBranchPrefix.length())
binding.setVariable('scmBranch', scmBranch)
} else {
throw new Exception("SCM branch does not start with '$scmBranchPrefix': '$scmBranch'")
}
} else {
throw new Exception("Precisely one SCM branch expected: '" + scm.branches + "'")
}
}
if (!binding.hasVariable('scmBrowser')) {
// Automatically determine SCM browser
def aoappsPrefix = '/srv/git/ao-apps/'
def newmediaworksPrefix = '/srv/git/nmwoss/'
def scmBrowser
if (scmUrl.startsWith(aoappsPrefix)) {
// Is also mirrored to GitHub user "ao-apps"
def repo = scmUrl.substring(aoappsPrefix.length())
if (repo.endsWith('.git')) {
repo = repo.substring(0, repo.length() - 4)
}
scmBrowser = [$class: 'GithubWeb',
repoUrl: 'https://github.com/ao-apps/' + repo
]
} else if (scmUrl.startsWith(newmediaworksPrefix)) {
// Is also mirrored to GitHub user "newmediaworks"
def repo = scmUrl.substring(newmediaworksPrefix.length())
if (repo.endsWith('.git')) {
repo = repo.substring(0, repo.length() - 4)
}
scmBrowser = [$class: 'GithubWeb',
repoUrl: 'https://github.com/newmediaworks/' + repo
]
} else if (scmUrl.startsWith('/srv/git/') || scmUrl.startsWith('ssh://')) {
// No default
scmBrowser = null
} else {
throw new Exception("Unexpected SCM URL: '$scmUrl'")
}
binding.setVariable('scmBrowser', scmBrowser)
}
/*
* Finds the upstream projects for the given job.
* Returns an array of upstream projects, possibly empty but never null
*/
def getUpstreamProjects(jenkins, upstreamProjectsCache, workflowJob) {
def fullName = workflowJob.fullName
def upstreamProjects = upstreamProjectsCache[fullName]
if (upstreamProjects == null) {
upstreamProjects = []
workflowJob.triggers?.each {triggerDescriptor, trigger ->
if (trigger instanceof jenkins.triggers.ReverseBuildTrigger) {
trigger.upstreamProjects.split(',').each {upstreamProject ->
upstreamProject = upstreamProject.trim()
if (upstreamProject != '') {
upstreamProjects << upstreamProject
}
}
} else {
throw new Exception("$fullName: trigger is not a ReverseBuildTrigger: $upstreamFullName -> $trigger")
}
}
upstreamProjectsCache[fullName] = upstreamProjects
}
return upstreamProjects
}
/*
* Gets the set of full names for the given workflowJob and all transitive upstream projects.
*/
def getAllUpstreamProjects(jenkins, upstreamProjectsCache, allUpstreamProjectsCache, workflowJob) {
def fullName = workflowJob.fullName
def allUpstreamProjects = allUpstreamProjectsCache[fullName]
if (allUpstreamProjects == null) {
if (allUpstreamProjectsCache.containsKey(fullName)) {
throw new Exception("$fullName: Loop detected in upstream project graph")
}
// Add to map with null for loop detection
allUpstreamProjectsCache[fullName] = null
// Create new set
allUpstreamProjects = [] as Set<String>
// Always contains self
allUpstreamProjects << fullName
// Transitively add all
for (upstreamProject in getUpstreamProjects(jenkins, upstreamProjectsCache, workflowJob)) {
def upstreamWorkflowJob = jenkins.getItem(upstreamProject, workflowJob)
if (upstreamWorkflowJob == null) {
throw new Exception("$fullName: upstreamWorkflowJob not found: '$upstreamProject'")
}
if (!(upstreamWorkflowJob instanceof org.jenkinsci.plugins.workflow.job.WorkflowJob)) {
throw new Exception("$fullName: $upstreamProject: upstreamWorkflowJob is not a WorkflowJob: $upstreamWorkflowJob")
}
allUpstreamProjects.addAll(getAllUpstreamProjects(jenkins, upstreamProjectsCache, allUpstreamProjectsCache, upstreamWorkflowJob))
}
// Cache result
allUpstreamProjectsCache[fullName] = allUpstreamProjects
}
return allUpstreamProjects
}
/*
* Prunes upstream projects in two ways:
*
* 1) Remove duplicates by job fullName (handles different relative paths to same project)
*
* 2) Removes direct upstream projects that are also transitive through others
*/
def pruneUpstreamProjects(jenkins, upstreamProjectsCache, currentWorkflowJob, upstreamProjects) {
// Quick unique by name, and ensures a new object to not affect parameter
upstreamProjects = upstreamProjects.unique()
// Find the set of all projects for each upstreamProject
def upstreamFullNames = []
def allUpstreamProjects = []
def allUpstreamProjectsCache = [:]
for (upstreamProject in upstreamProjects) {
def upstreamWorkflowJob = jenkins.getItem(upstreamProject, currentWorkflowJob)
if (upstreamWorkflowJob == null) {
throw new Exception("${currentWorkflowJob.fullName}: upstreamWorkflowJob not found: '$upstreamProject'")
}
if (!(upstreamWorkflowJob instanceof org.jenkinsci.plugins.workflow.job.WorkflowJob)) {
throw new Exception("${currentWorkflowJob.fullName}: $upstreamProject: upstreamWorkflowJob is not a WorkflowJob: $upstreamWorkflowJob")
}
upstreamFullNames << upstreamWorkflowJob.fullName
allUpstreamProjects << getAllUpstreamProjects(jenkins, upstreamProjectsCache, allUpstreamProjectsCache, upstreamWorkflowJob)
}
allUpstreamProjectsCache = null
// Prune upstream, quadratic algorithm
def pruned = []
def len = upstreamProjects.size()
assert len == upstreamFullNames.size()
assert len == allUpstreamProjects.size()
for (int i = 0; i < len; i++) {
def upstreamFullName = upstreamFullNames[i]
// Make sure no contained by any other upstream
def transitiveOnOther = false
for (int j = 0; j < len; j++) {
if (j != i && allUpstreamProjects[j].contains(upstreamFullName)) {
//echo "pruneUpstreamProjects: ${currentWorkflowJob.fullName}: Pruned due to transitive: $upstreamFullName found in ${upstreamProjects[j]}"
transitiveOnOther = true
break
}
}
if (!transitiveOnOther) {
//echo "pruneUpstreamProjects: ${currentWorkflowJob.fullName}: Direct: ${upstreamProjects[i]}"
pruned << upstreamProjects[i]
}
}
return pruned
}
/*
* Finds the depth of the given job in the upstream project graph
* Top-most projects will be 1, which matches the job priorities for Priority Sorter plugin
*
* Uses depthMap for tracking
*
* Mapping from project full name to depth, where final depth is >= 1
* During traversal, a project is first added to the map with a value of 0, which is used to detect graph loops
*/
def getDepth(jenkins, upstreamProjectsCache, depthMap, workflowJob, jobUpstreamProjects) {
def fullName = workflowJob.fullName
def depth = depthMap[fullName]
if (depth == null) {
// Add to map with value 0 for loop detection
depthMap[fullName] = 0
def maxUpstream = 0
jobUpstreamProjects.each {upstreamProject ->
def upstreamWorkflowJob = jenkins.getItem(upstreamProject, workflowJob)
if (upstreamWorkflowJob == null) {
throw new Exception("$fullName: upstreamWorkflowJob not found: '$upstreamProject'")
}
if (!(upstreamWorkflowJob instanceof org.jenkinsci.plugins.workflow.job.WorkflowJob)) {
throw new Exception("$fullName: $upstreamProject: upstreamWorkflowJob is not a WorkflowJob: $upstreamWorkflowJob")
}
def upstreamProjects = getUpstreamProjects(jenkins, upstreamProjectsCache, upstreamWorkflowJob)
def upstreamDepth = getDepth(jenkins, upstreamProjectsCache, depthMap, upstreamWorkflowJob, upstreamProjects)
if (upstreamDepth > maxUpstream) maxUpstream = upstreamDepth
}
depth = maxUpstream + 1
//echo "$fullName: $depth"
depthMap[fullName] = depth
} else if (depth == 0) {
throw new Exception("$fullName: Loop detected in upstream project graph")
}
return depth;
}
// Variables temporarily used in project resolution
def tempUpstreamProjectsCache = [:]
def tempJenkins = Jenkins.get()
// Find the current project
def tempCurrentWorkflowJob = currentBuild.rawBuild.parent
if (!(tempCurrentWorkflowJob instanceof org.jenkinsci.plugins.workflow.job.WorkflowJob)) {
throw new Exception("tempCurrentWorkflowJob is not a WorkflowJob: $tempCurrentWorkflowJob")
}
// Prune set of upstreamProjects
def prunedUpstreamProjects = pruneUpstreamProjects(tempJenkins, tempUpstreamProjectsCache, tempCurrentWorkflowJob, upstreamProjects)
if (!binding.hasVariable('buildPriority')) {
// Find the longest path through all upstream projects, which will be used as both job priority and
// nice value. This will ensure proper build order in all cases. However, it may prevent some
// possible concurrency since reduction to simple job priority number loses information about which
// are critical paths on the upstream project graph.
def buildPriority = getDepth(tempJenkins, tempUpstreamProjectsCache, [:], tempCurrentWorkflowJob, prunedUpstreamProjects)
if (buildPriority > 30) throw new Exception("buildPriority > 30, increase global configuration: $buildPriority")
binding.setVariable('buildPriority', buildPriority)
}
if (buildPriority < 1 || buildPriority > 30) {
throw new Exception("buildPriority out of range 1 - 30: $buildPriority")
}
// Remove temporary variables
tempUpstreamProjectsCache = null
tempJenkins = null
tempCurrentWorkflowJob = null
if (!binding.hasVariable('quietPeriod')) {
binding.setVariable('quietPeriod', 10 + buildPriority * 2)
}
if (!binding.hasVariable('nice')) {
def nice = (params.BuildPriority == null) ? 0 : ((params.BuildPriority as Integer) - 1);
if (nice < 0) nice = 0;
else if (nice > 19) nice = 19;
binding.setVariable('nice', nice)
}
if (!binding.hasVariable('maven')) {
binding.setVariable('maven', 'maven-3')
}
if (!binding.hasVariable('mavenOpts')) {
binding.setVariable('mavenOpts', '-Djansi.force')
}
if (!binding.hasVariable('extraProfiles')) {
binding.setVariable('extraProfiles', [])
}
if (!binding.hasVariable('testWhenExpression')) {
binding.setVariable('testWhenExpression',
{return fileExists(projectDir + '/src/test')}
)
}
if (!binding.hasVariable('sonarqubeWhenExpression')) {
binding.setVariable('sonarqubeWhenExpression',
{return !fileExists(projectDir + '/.github/workflows/build.yml')}
)
}
if (!binding.hasVariable('failureEmailTo')) {
binding.setVariable('failureEmailTo', '[email protected]')
}
// Common settings
def mvnCommon = "-Dstyle.color=always -Dmaven.gitcommitid.nativegit=true -DrequireLastBuild=${params.requireLastBuild == null ? false : params.requireLastBuild} -Djenkins.buildNumber=${currentBuild.number} -N -U -Pjenkins,POST-SNAPSHOT${extraProfiles.isEmpty() ? '' : (',' + extraProfiles.join(','))}"
def buildPhases = 'clean process-test-classes'
// Determine nice command prefix or empty string for none
def niceCmd = (nice == 0) ? '' : "nice -n$nice "
//
// Scripts pulled out of pipeline due to "General error during class generation: Method too large"
//
// Make sure working tree not modified after checkout
def checkTreeUnmodifiedScriptCheckout(niceCmd) {
return """#!/bin/bash
s="\$(${niceCmd}git status --short)"
if [ "\$s" != "" ]
then
echo "Working tree modified after checkout:"
echo "\$s"
exit 1
fi
"""
}
// Make sure working tree not modified by build or test
def checkTreeUnmodifiedScriptBuild(niceCmd) {
return """#!/bin/bash
s="\$(${niceCmd}git status --short)"
if [ "\$s" != "" ]
then
echo "Working tree modified during build or test:"
echo "\$s"
exit 1
fi
"""
}
// Temporarily move surefire-reports before withMaven to avoid duplicate logging of test results
def moveSurefireReportsScript() {
return """#!/bin/bash
if [ -d target/surefire-reports ]
then
mv target/surefire-reports target/surefire-reports.do-not-report-twice
fi
"""
}
// Restore surefire-reports
def restoreSurefireReportsScript() {
return """#!/bin/bash
if [ -d target/surefire-reports.do-not-report-twice ]
then
mv target/surefire-reports.do-not-report-twice target/surefire-reports
fi
"""
}
// Make sure working tree not modified by deploy
def checkTreeUnmodifiedScriptDeploy(niceCmd) {
return """#!/bin/bash
s="\$(${niceCmd}git status --short)"
if [ "\$s" != "" ]
then
echo "Working tree modified during deploy:"
echo "\$s"
exit 1
fi
"""
}
pipeline {
agent any
options {
ansiColor('xterm')
disableConcurrentBuilds(abortPrevious: true)
quietPeriod(quietPeriod)
skipDefaultCheckout()
//
// It is difficult to differentiate the cause of status ABORTED. It can be a normal status when caused by a
// dependency build still in-progress. Or it can be an unexpected status when caused by a timeout. In the former
// cause, the build will be started again automatically by the upstream project. In the latter case, the build
// must be manually restarted. Without being able to distinguish, it is less clear when the build system is not
// making progress (all jobs can be in ABORTED state), and it is tedious to find which builds to start manually.
//
// This pipeline-level timeout does not convert status from ABORTED to FAILURE and should be a higher than the sum
// of all individual per-steps timeouts below, and thus is never expected to be reached, but remains as a fallback.
//
// Individual "steps" blocks below perform timeouts within catch blocks to convert status ABORTED to FAILURE.
// See https://devops.stackexchange.com/a/9692
//
timeout(time: 6, unit: 'HOURS')
// Only allowed to copy build artifacts from self
// See https://plugins.jenkins.io/copyartifact/
copyArtifactPermission("/${JOB_NAME}")
// See https://plugins.jenkins.io/build-history-manager/
buildDiscarder(BuildHistoryManager([
[
// Keep most recent not_built build, which is useful to know which
// builds have been superseded during their quiet period.
conditions: [BuildResult(
matchNotBuilt: true
)],
matchAtMost: 1,
continueAfterMatch: false
],
[
// Keep most recent aborted build, which is useful to know what the build is waiting for
// and to see that the build is still pending in Active and Blinkenlichten views.
conditions: [BuildResult(
matchAborted: true
)],
matchAtMost: 1,
continueAfterMatch: false
],
[
// Keep most recent 50 success/unstable/failure builds
conditions: [BuildResult(
// All statuses except ABORTED from
// https://github.com/jenkinsci/build-history-manager-plugin/blob/master/src/main/java/pl/damianszczepanik/jenkins/buildhistorymanager/model/conditions/BuildResultCondition.java
matchSuccess: true,
matchUnstable: true,
matchFailure: true
)],
matchAtMost: 50,
continueAfterMatch: false
],
[
actions: [DeleteBuild()]
]
]))
}
parameters {
string(
name: 'BuildPriority',
defaultValue: "$buildPriority",
description: """Specify the priority of this build.
Must be between 1 and 30, with lower values built first.
Defaults to project's depth in the upstream project graph."""
)
booleanParam(
name: 'abortOnUnreadyDependency',
defaultValue: true,
description: """Aborts the build when any dependency is queued, building, or unsuccessful.
Defaults to true and will typically only be false to push a new version of a project out immediately.
May also want to set BuildPriority to \"1\" to put at the top of the build queue."""
)
booleanParam(
name: 'requireLastBuild',
defaultValue: true,
description: """Is the last build required for the zip-timestamp-merge Ant task?
Defaults to true and will typically only be false for either the first build
or any build that adds or removes build artifacts."""
)
}
triggers {
upstream(
threshold: hudson.model.Result.SUCCESS,
upstreamProjects: "${prunedUpstreamProjects.join(', ')}"
)
}
stages {
stage('Check Ready') {
when {
expression {
return (params.abortOnUnreadyDependency == null) ? true : params.abortOnUnreadyDependency
}
}
steps {
script {
try {
timeout(time: 15, unit: 'MINUTES') {
try {
// See https://javadoc.jenkins.io/jenkins/model/Jenkins.html
// See https://javadoc.jenkins.io/hudson/model/Job.html
// See https://javadoc.jenkins.io/hudson/model/Run.html
// See https://javadoc.jenkins.io/hudson/model/Result.html
def jenkins = Jenkins.get();
// Get the mapping of all active dependencies and their current status
def upstreamProjectsCache = [:]
def allUpstreamProjectsCache = [:]
// Find the current project
def currentWorkflowJob = currentBuild.rawBuild.parent
if (!(currentWorkflowJob instanceof org.jenkinsci.plugins.workflow.job.WorkflowJob)) {
throw new Exception("currentWorkflowJob is not a WorkflowJob: ${currentWorkflowJob.fullName}")
}
// Get all upstream projects (and the current)
def allUpstreamProjects = getAllUpstreamProjects(
jenkins,
upstreamProjectsCache,
allUpstreamProjectsCache,
currentWorkflowJob
)
// Remove current project
if (!allUpstreamProjects.removeElement(currentWorkflowJob.fullName)) {
throw new Exception("currentWorkflowJob is not in allUpstreamProjects: ${currentWorkflowJob.fullName}")
}
// Check queue and get statuses, stop searching on first found unready
allUpstreamProjects.each {upstreamProject ->
def upstreamWorkflowJob = jenkins.getItemByFullName(upstreamProject)
if (upstreamWorkflowJob == null) {
throw new Exception("${currentWorkflowJob.fullName}: upstreamWorkflowJob not found: '$upstreamProject'")
}
if (!(upstreamWorkflowJob instanceof org.jenkinsci.plugins.workflow.job.WorkflowJob)) {
throw new Exception("${currentWorkflowJob.fullName}: $upstreamProject: upstreamWorkflowJob is not a WorkflowJob: $upstreamWorkflowJob")
}
def lastBuild = upstreamWorkflowJob.getLastBuild();
if (lastBuild == null) {
throw new IllegalStateException("${currentWorkflowJob.fullName}: Aborting due to dependency never built: ${upstreamWorkflowJob.fullName}")
}
if (lastBuild.isBuilding()) {
throw new IllegalStateException("${currentWorkflowJob.fullName}: Aborting due to dependency currently building: ${upstreamWorkflowJob.fullName} #${lastBuild.number}")
}
def result = lastBuild.result;
if (result != hudson.model.Result.SUCCESS) {
throw new IllegalStateException("${currentWorkflowJob.fullName}: Aborting due to dependency last build not successful: ${upstreamWorkflowJob.fullName} #${lastBuild.number} is $result")
}
}
} catch (org.jenkinsci.plugins.workflow.steps.FlowInterruptedException e) {
// rethrow timeout
throw e;
} catch (IllegalStateException e) {
// It is assumed the only cause of IllegalStateException is our own throws
catchError(message: 'Aborted due to dependencies not ready', buildResult: 'ABORTED', stageResult: 'ABORTED') {
error(e.message)
}
}
}
} catch (org.jenkinsci.plugins.workflow.steps.FlowInterruptedException e) {
if (e.isActualInterruption()) {
echo 'Rethrowing actual interruption instead of converting timeout to failure'
throw e;
}
if (currentBuild.result == null || currentBuild.result == hudson.model.Result.ABORTED) {
error((e.message == null) ? 'Converting timeout to failure' : "Converting timeout to failure: ${e.message}")
}
}
}
}
}
stage('Workaround Git #27287') {
when {
expression {
return (
currentBuild.result == null
|| currentBuild.result == hudson.model.Result.SUCCESS
|| currentBuild.result == hudson.model.Result.UNSTABLE
) && projectDir != '.' && fileExists('.gitmodules')
}
}
steps {
script {
try {
timeout(time: 15, unit: 'MINUTES') {
// See https://www.jenkins.io/doc/pipeline/steps/params/gitscm/
// See https://www.jenkins.io/doc/pipeline/steps/workflow-scm-step/#checkout-check-out-from-version-control
// See https://stackoverflow.com/questions/43293334/sparsecheckout-in-jenkinsfile-pipeline
/*
* Git version 2.34.1 is failing when fetching without submodules, which is our most common usage.
* It fails only on the first fetch, then succeeds on subsequent fetches.
* This issue is expected to be resolved in 2.35.1.
*
* To workaround this issue, we are allowing to retry the Git fetch by catching the first failure.
*
* See https://github.com/git/git/commit/c977ff440735e2ddc2ef18b18ae9a653bb8650fe
* See https://gitlab.com/gitlab-org/gitlab/-/issues/27287
*
* TODO: Remove once on Git >= 2.35.1
*/
catchError(message: 'Git 2.34.1 first fetch fails when not fetching submodules, will retry', buildResult: 'SUCCESS', stageResult: 'UNSTABLE') {
checkout scm: [$class: 'GitSCM',
userRemoteConfigs: [[
url: scmUrl,
refspec: "+refs/heads/$scmBranch:refs/remotes/origin/$scmBranch"
]],
branches: [[name: "refs/heads/$scmBranch"]],
browser: scmBrowser,
extensions: [
// CleanCheckout was too aggressive and removed the workspace .m2 folder, added "sh" steps below
// [$class: 'CleanCheckout'],
[$class: 'CloneOption',
// See https://issues.jenkins.io/browse/JENKINS-45586
shallow: false,
// depth: 20,
honorRefspec: true
],
[$class: 'SparseCheckoutPaths',
sparseCheckoutPaths: sparseCheckoutPaths
],
[$class: 'SubmoduleOption',
disableSubmodules: disableSubmodules,
shallow: false
// depth: 20
]
]
]
}
}
} catch (org.jenkinsci.plugins.workflow.steps.FlowInterruptedException e) {
if (e.isActualInterruption()) {
echo 'Rethrowing actual interruption instead of converting timeout to failure'
throw e;
}
if (currentBuild.result == null || currentBuild.result == hudson.model.Result.ABORTED) {
error((e.message == null) ? 'Converting timeout to failure' : "Converting timeout to failure: ${e.message}")
}
}
}
}
}
stage('Checkout SCM') {
when {
expression {
return (
currentBuild.result == null
|| currentBuild.result == hudson.model.Result.SUCCESS
|| currentBuild.result == hudson.model.Result.UNSTABLE
)
}
}
steps {
script {
try {
timeout(time: 15, unit: 'MINUTES') {
checkout scm: [$class: 'GitSCM',
userRemoteConfigs: [[
url: scmUrl,
refspec: "+refs/heads/$scmBranch:refs/remotes/origin/$scmBranch"
]],
branches: [[name: "refs/heads/$scmBranch"]],
browser: scmBrowser,
extensions: [
// CleanCheckout was too aggressive and removed the workspace .m2 folder, added "sh" steps below
// [$class: 'CleanCheckout'],
[$class: 'CloneOption',
// See https://issues.jenkins.io/browse/JENKINS-45586
shallow: false,
// depth: 20,
honorRefspec: true
],
[$class: 'SparseCheckoutPaths',
sparseCheckoutPaths: sparseCheckoutPaths
],
[$class: 'SubmoduleOption',
disableSubmodules: disableSubmodules,
shallow: false
// depth: 20
]
]
]
sh "${niceCmd}git verify-commit HEAD"
sh "${niceCmd}git reset --hard"
// git clean -fdx was iterating all of /.m2 despite being ignored
sh "${niceCmd}git clean -fx -e ${(projectDir == '.') ? '/.m2' : ('/' + projectDir + '/.m2')}"
// Make sure working tree not modified after checkout
sh checkTreeUnmodifiedScriptCheckout(niceCmd)
}
} catch (org.jenkinsci.plugins.workflow.steps.FlowInterruptedException e) {
if (e.isActualInterruption()) {
echo 'Rethrowing actual interruption instead of converting timeout to failure'
throw e;
}
if (currentBuild.result == null || currentBuild.result == hudson.model.Result.ABORTED) {
error((e.message == null) ? 'Converting timeout to failure' : "Converting timeout to failure: ${e.message}")
}
}
}
}
}
stage('Builds') {
matrix {
when {
expression {
return (
currentBuild.result == null
|| currentBuild.result == hudson.model.Result.SUCCESS
|| currentBuild.result == hudson.model.Result.UNSTABLE
)
}
}
axes {
axis {
name 'jdk'
values '11', '17', '21' // buildJdks
}
}
stages {
stage('Build') {
steps {
script {
try {
timeout(time: 1, unit: 'HOURS') {
dir(projectDir) {
withMaven(
maven: maven,
mavenOpts: mavenOpts,
mavenLocalRepo: ".m2/repository-jdk-$jdk",
jdk: "jdk-$jdk"
) {
sh "${niceCmd}$MVN_CMD $mvnCommon ${jdk == deployJdk ? '' : "-Dalt.build.dir=target-jdk-$jdk -Pjenkins-build-altjdk "}$buildPhases"
}
}
script {
// Create a separate copy for full test matrix
if (testWhenExpression.call()) {
testJdks.each() {testJdk ->
if (testJdk != jdk) {
sh "${niceCmd}rm $projectDir/target-jdk-$jdk-$testJdk -rf"
sh "${niceCmd}cp -al $projectDir/target${jdk == deployJdk ? '' : "-jdk-$jdk"} $projectDir/target-jdk-$jdk-$testJdk"
}
}
}
}
}
} catch (org.jenkinsci.plugins.workflow.steps.FlowInterruptedException e) {
if (e.isActualInterruption()) {
echo 'Rethrowing actual interruption instead of converting timeout to failure'
throw e;
}
if (currentBuild.result == null || currentBuild.result == hudson.model.Result.ABORTED) {
error((e.message == null) ? 'Converting timeout to failure' : "Converting timeout to failure: ${e.message}")
}
}
}
}
}
}
}
}
stage('Tests') {
matrix {
when {
expression {
return (
currentBuild.result == null
|| currentBuild.result == hudson.model.Result.SUCCESS
|| currentBuild.result == hudson.model.Result.UNSTABLE
) && testWhenExpression.call()
}
}
axes {
axis {
name 'jdk'
values '11', '17', '21' // buildJdks
}
axis {
name 'testJdk'
values '11', '17', '21' // testJdks
}
}
stages {
stage('Test') {
environment {
buildDir = "target${(testJdk == jdk) ? (jdk == deployJdk ? '' : "-jdk-$jdk") : ("-jdk-$jdk-$testJdk")}"
coverage = "${(jdk == deployJdk && testJdk == deployJdk && fileExists(projectDir + '/src/main/java') && fileExists(projectDir + '/src/test')) ? '-Pcoverage' : '-P!coverage'}"
testGoals = "${(coverage == '-Pcoverage') ? 'jacoco:prepare-agent surefire:test jacoco:report' : 'surefire:test'}"
}
steps {
script {
try {
timeout(time: 1, unit: 'HOURS') {
dir(projectDir) {
withMaven(
maven: maven,
mavenOpts: mavenOpts,
mavenLocalRepo: ".m2/repository-jdk-$jdk",
jdk: "jdk-$testJdk"
) {
sh "${niceCmd}$MVN_CMD $mvnCommon -Dalt.build.dir=$buildDir $coverage $testGoals"
}
}
}
} catch (org.jenkinsci.plugins.workflow.steps.FlowInterruptedException e) {
if (e.isActualInterruption()) {
echo 'Rethrowing actual interruption instead of converting timeout to failure'
throw e;
}
if (currentBuild.result == null || currentBuild.result == hudson.model.Result.ABORTED) {
error((e.message == null) ? 'Converting timeout to failure' : "Converting timeout to failure: ${e.message}")
}
}
}
}
}
}
}
}
stage('Deploy') {
when {
expression {
return (
currentBuild.result == null
|| currentBuild.result == hudson.model.Result.SUCCESS
|| currentBuild.result == hudson.model.Result.UNSTABLE
)
}
}
steps {
// Steps moved to separate function to avoid "Method too large"
// See https://stackoverflow.com/a/47631522
deploySteps(niceCmd, projectDir, deployJdk, maven, mavenOpts, mvnCommon)
}
}
stage('SonarQube analysis') {
when {
expression {
return (
currentBuild.result == null
|| currentBuild.result == hudson.model.Result.SUCCESS
|| currentBuild.result == hudson.model.Result.UNSTABLE
) && sonarqubeWhenExpression.call()
}
}
steps {
// Steps moved to separate function to avoid "Method too large"
// See https://stackoverflow.com/a/47631522
sonarQubeAnalysisSteps(niceCmd, projectDir, deployJdk, maven, mavenOpts, mvnCommon)
}
}
stage('Quality Gate') {
when {
expression {
return (
currentBuild.result == null
|| currentBuild.result == hudson.model.Result.SUCCESS
|| currentBuild.result == hudson.model.Result.UNSTABLE
) && sonarqubeWhenExpression.call()
}
}
steps {
// Steps moved to separate function to avoid "Method too large"
// See https://stackoverflow.com/a/47631522
qualityGateSteps()
}
}
stage('Analysis') {
when {
expression {
return (