/
Jenkinsfile
1153 lines (1066 loc) · 46.5 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
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/*
* See https://github.com/hibernate/hibernate-jenkins-pipeline-helpers
*/
@Library('hibernate-jenkins-pipeline-helpers@1.13') _
import groovy.transform.Field
import org.hibernate.jenkins.pipeline.helpers.job.JobHelper
import org.hibernate.jenkins.pipeline.helpers.alternative.AlternativeMultiMap
/*
* WARNING: DO NOT IMPORT LOCAL LIBRARIES HERE.
*
* By local, I mean libraries whose files are in the same Git repository.
*
* The Jenkinsfile is protected and will not be executed if modified in pull requests from external users,
* but other local library files are not protected.
* A user could potentially craft a malicious PR by modifying a local library.
*
* See https://blog.grdryn.me/blog/jenkins-pipeline-trust.html for a full explanation,
* and a potential solution if we really need local libraries.
* Alternatively we might be able to host libraries in a separate GitHub repo and configure
* them in the GUI: see https://ci.hibernate.org/job/hibernate-search/configure, "Pipeline Libraries".
*/
/*
* See https://github.com/hibernate/hibernate-jenkins-pipeline-helpers for the documentation
* of the helpers library used in this Jenkinsfile,
* and for help writing Jenkinsfiles.
*
* ### Jenkins configuration
*
* #### Jenkins plugins
*
* This file requires the following plugins in particular:
*
* - everything required by the helpers library (see the org.hibernate.(...) imports for a link to its documentation)
* - https://plugins.jenkins.io/ec2 for AWS credentials
* - https://plugins.jenkins.io/lockable-resources for the lock on the AWS Elasticsearch server
* - https://plugins.jenkins.io/pipeline-github for the trigger on pull request comments
*
* #### Script approval
*
* If not already done, you will need to allow the following calls in <jenkinsUrl>/scriptApproval/:
*
* - everything required by the helpers library (see the org.hibernate.(...) imports for a link to its documentation)
*
* ### Integrations
*
* #### Nexus deployment
*
* This job is only able to deploy snapshot artifacts,
* for every non-PR build on "primary" branches (main and maintenance branches),
* but the name of a Maven settings file must be provided in the job configuration file
* (see below).
*
* For actual releases, see jenkins/release.groovy.
*
* #### AWS
*
* This job will trigger integration tests against an Elasticsearch service hosted on AWS.
*
* You need to set some environment variables to select the endpoint (see below).
*
* Then you will also need to add AWS credentials in Jenkins
* and reference them from the configuration file (see below).
*
* #### Sonarcloud (optional)
*
* You need to enable the SonarCloud GitHub app for your repository:
* see https://github.com/apps/sonarcloud.
*
* Then you will also need to add SonarCloud credentials in Jenkins
* and reference them from the configuration file (see below).
*
* #### Develocity (optional)
*
* You will need to add Develocity credentials in Jenkins
* and reference them from the configuration file (see below).
*
* #### Gitter (optional)
*
* You need to enable the Jenkins integration in your Gitter room first:
* see https://gitlab.com/gitlab-org/gitter/webapp/blob/master/docs/integrations.md
*
* Then you will also need to configure *global* secret text credentials containing the Gitter webhook URL,
* and list the ID of these credentials in the job configuration file
* (see https://github.com/hibernate/hibernate-jenkins-pipeline-helpers#job-configuration-file).
*
* ### Job configuration
*
* This Jenkinsfile gets its configuration from four sources:
* branch name, environment variables, a configuration file, and credentials.
* All configuration is optional for the default build (and it should stay that way),
* but some features require some configuration.
*
* #### Branch name
*
* See the org.hibernate.(...) imports for a link to the helpers library documentation,
* which explains the basics.
*
* #### Environment variables
*
* The following environment variables are necessary for some features:
*
* - 'ES_AWS_REGION', containing the name of an AWS region such as 'us-east-1', to test Elasticsearch as a service on AWS.
* - 'ES_AWS_<majorminor without dot>_ENDPOINT' (e.g. 'ES_AWS_52_ENDPOINT'),
* containing the URL of an AWS Elasticsearch service endpoint using that exact version,
* to test Elasticsearch as a service on AWS.
*
* #### Job configuration file
*
* See the org.hibernate.(...) imports for a link to the helpers library documentation,
* which explains the basic structure of this file and how to set it up.
*
* Below is the additional structure specific to this Jenkinsfile:
*
* aws:
* # String containing the ID of aws credentials. Mandatory in order to test against an Elasticsearch service hosted on AWS.
* # Expects username/password credentials where the username is the AWS access key
* # and the password is the AWS secret key.
* credentials: ...
* sonar:
* # String containing the ID of Sonar credentials. Optional.
* # Expects username/password credentials where the username is the organization ID on sonarcloud.io
* # and the password is a sonarcloud.io access token with sufficient rights for that organization.
* credentials: ...
* develocity:
* credentials:
* # String containing the ID of Develocity credentials used on "main" (non-PR) builds. Optional.
* # Expects something valid for the DEVELOCITY_ACCESS_KEY environment variable.
* # See https://docs.gradle.com/enterprise/gradle-plugin/#via_environment_variable
* main: ...
* # String containing the ID of Develocity credentials used on PR builds. Optional.
* # Expects something valid for the DEVELOCITY_ACCESS_KEY environment variable.
* # See https://docs.gradle.com/enterprise/gradle-plugin/#via_environment_variable
* # WARNING: These credentials should not give write access to the build cache!
* pr: ...
* deployment:
* maven:
* # String containing the ID of a Maven settings file registered using the config-file-provider Jenkins plugin.
* # The settings must provide credentials to the server with ID 'ossrh'.
* settingsId: ...
*/
@Field final String DEFAULT_JDK_TOOL = 'OpenJDK 17 Latest'
@Field final String MAVEN_TOOL = 'Apache Maven 3.9'
// Default node pattern, to be used for resource-intensive stages.
// Should not include the controller node.
@Field final String NODE_PATTERN_BASE = 'Worker&&Containers'
// Quick-use node pattern, to be used for very light, quick, and environment-independent stages,
// such as sending a notification. May include the controller node in particular.
@Field final String QUICK_USE_NODE_PATTERN = 'Controller||Worker'
@Field AlternativeMultiMap<BuildEnvironment> environments
@Field JobHelper helper
@Field boolean enableDefaultBuild = false
@Field boolean enableDefaultBuildIT = false
@Field boolean deploySnapshot = false
@Field boolean incrementalBuild = false
this.helper = new JobHelper(this)
helper.runWithNotification {
stage('Configure') {
// We want to make sure that if we are building a PR that the branch name will not require any escaping of symbols in it.
// Otherwise, it may lead to cryptic build errors.
if (helper.scmSource.branch.name && !(helper.scmSource.branch.name ==~ /^[\w\d\/\\_\-\.]+$/)) {
throw new IllegalArgumentException("""
Branch name ${helper.scmSource.branch.name} contains unexpected symbols.
Only characters, digits and -_.\\/ symbols are allowed in the branch name.
Change the branch name and open a new Pull Request.
""")
}
requireApprovalForPullRequest 'hibernate'
this.environments = AlternativeMultiMap.create([
jdk: [
// This should not include every JDK; in particular let's not care too much about EOL'd JDKs like version 9
// See http://www.oracle.com/technetwork/java/javase/eol-135779.html
new JdkBuildEnvironment(version: '11', testCompilerTool: 'OpenJDK 11 Latest',
condition: TestCondition.AFTER_MERGE),
new JdkBuildEnvironment(version: '17', testCompilerTool: 'OpenJDK 17 Latest',
condition: TestCondition.BEFORE_MERGE,
isDefault: true),
// We want to enable preview features when testing newer builds of OpenJDK:
// even if we don't use these features, just enabling them can cause side effects
// and it's useful to test that.
new JdkBuildEnvironment(version: '21', testCompilerTool: 'OpenJDK 21 Latest',
testLauncherArgs: '--enable-preview',
condition: TestCondition.AFTER_MERGE),
new JdkBuildEnvironment(version: '22', testCompilerTool: 'OpenJDK 22 Latest',
testLauncherArgs: '--enable-preview',
condition: TestCondition.AFTER_MERGE),
// The following JDKs aren't supported by Hibernate ORM out-of-the box yet:
// they require the use of -Dnet.bytebuddy.experimental=true.
// Make sure to remove that argument as soon as possible
// -- generally that requires upgrading bytebuddy in Hibernate ORM after the JDK goes GA.
new JdkBuildEnvironment(version: '23', testCompilerTool: 'OpenJDK 23 Latest',
testLauncherArgs: '--enable-preview -Dnet.bytebuddy.experimental=true',
condition: TestCondition.AFTER_MERGE)
// IMPORTANT: Make sure to update the documentation for any newly supported Java versions
// See java-version.main.compatible.expected.text in POMs.
],
compiler: [
new CompilerBuildEnvironment(name: 'eclipse', mavenProfile: 'compiler-eclipse',
condition: TestCondition.BEFORE_MERGE)
],
database: [
new DatabaseBuildEnvironment(dbName: 'h2', mavenProfile: 'h2',
condition: TestCondition.BEFORE_MERGE,
isDefault: true),
new DatabaseBuildEnvironment(dbName: 'postgresql', mavenProfile: 'ci-postgresql',
condition: TestCondition.BEFORE_MERGE),
new DatabaseBuildEnvironment(dbName: 'oracle', mavenProfile: 'ci-oracle',
condition: TestCondition.BEFORE_MERGE),
new DatabaseBuildEnvironment(dbName: 'mariadb', mavenProfile: 'ci-mariadb',
condition: TestCondition.AFTER_MERGE),
new DatabaseBuildEnvironment(dbName: 'mysql', mavenProfile: 'ci-mysql',
condition: TestCondition.AFTER_MERGE),
new DatabaseBuildEnvironment(dbName: 'db2', mavenProfile: 'ci-db2',
slow: true,
condition: TestCondition.AFTER_MERGE),
new DatabaseBuildEnvironment(dbName: 'mssql', mavenProfile: 'ci-mssql',
condition: TestCondition.AFTER_MERGE),
new DatabaseBuildEnvironment(dbName: 'cockroachdb', mavenProfile: 'ci-cockroachdb',
slow: true,
condition: TestCondition.AFTER_MERGE),
],
localElasticsearch: [
// --------------------------------------------
// Elasticsearch distribution from Elastic
// Not testing 7.9- since those versions are EOL'ed.
new LocalElasticsearchBuildEnvironment(version: '7.10.1', condition: TestCondition.AFTER_MERGE),
// Not testing 7.11 to make the build quicker.
// The only difference with 7.12+ is that wildcard predicates on analyzed fields get their pattern normalized,
// and that was deemed a bug: https://github.com/elastic/elasticsearch/pull/53127
new LocalElasticsearchBuildEnvironment(version: '7.11.2', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '7.12.1', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '7.13.2', condition: TestCondition.ON_DEMAND),
// 7.14 and 7.15 have annoying bugs that make almost all of our test suite fail,
// so we don't test them
// See https://hibernate.atlassian.net/browse/HSEARCH-4340
new LocalElasticsearchBuildEnvironment(version: '7.16.3', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '7.17.21', condition: TestCondition.AFTER_MERGE),
// Not testing 8.0 because we know there are problems in 8.0.1 (see https://hibernate.atlassian.net/browse/HSEARCH-4497)
// Not testing 8.1-8.6 to make the build quicker.
new LocalElasticsearchBuildEnvironment(version: '8.1.3', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.2.3', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.3.3', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.4.3', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.5.3', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.6.2', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.7.1', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.8.2', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.9.2', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.10.4', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.11.4', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.12.2', condition: TestCondition.ON_DEMAND),
new LocalElasticsearchBuildEnvironment(version: '8.13.4', condition: TestCondition.BEFORE_MERGE, isDefault: true),
// IMPORTANT: Make sure to update the documentation for any newly supported Elasticsearch versions
// See version.org.elasticsearch.compatible.expected.text
// and version.org.elasticsearch.compatible.regularly-tested.text in POMs.
// --------------------------------------------
// OpenSearch
// Not testing 1.0 - 1.2 as these versions are EOL'ed.
new LocalOpenSearchBuildEnvironment(version: '1.3.16', condition: TestCondition.AFTER_MERGE),
// See https://opensearch.org/lines/1x.html for a list of all 1.x versions
new LocalOpenSearchBuildEnvironment(version: '2.0.1', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.1.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.2.1', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.3.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.4.1', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.5.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.6.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.7.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.8.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.9.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.10.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.11.1', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.12.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.13.0', condition: TestCondition.ON_DEMAND),
new LocalOpenSearchBuildEnvironment(version: '2.14.0', condition: TestCondition.BEFORE_MERGE),
// See https://opensearch.org/lines/2x.html for a list of all 2.x versions
// IMPORTANT: Make sure to update the documentation for any newly supported OpenSearch versions
// See version.org.opensearch.compatible.expected.text
// and version.org.opensearch.compatible.regularly-tested.text in POMs.
// --------------------------------------------
// Amazon OpenSearch Serverless dialect running against a local OpenSearch instance
// WARNING: this does NOT actually run against Amazon OpenSearch Serverless (yet)
// See https://hibernate.atlassian.net/browse/HSEARCH-4919
new AmazonOpenSearchServerlessLocalBuildEnvironment(condition: TestCondition.AFTER_MERGE)
],
amazonElasticsearch: [
// --------------------------------------------
// Amazon Elasticsearch Service (OpenDistro)
new AmazonElasticsearchServiceBuildEnvironment(version: '7.10', condition: TestCondition.AFTER_MERGE),
// --------------------------------------------
// Amazon OpenSearch Service
new AmazonOpenSearchServiceBuildEnvironment(version: '1.3', condition: TestCondition.AFTER_MERGE),
new AmazonOpenSearchServiceBuildEnvironment(version: '2.11', condition: TestCondition.AFTER_MERGE),
// Also test static credentials, but only for the latest version
new AmazonOpenSearchServiceBuildEnvironment(version: '2.11', condition: TestCondition.AFTER_MERGE, staticCredentials: true)
]
])
helper.configure {
configurationNodePattern QUICK_USE_NODE_PATTERN
file 'job-configuration.yaml'
jdk {
defaultTool DEFAULT_JDK_TOOL
}
maven {
defaultTool MAVEN_TOOL
producedArtifactPattern "org/hibernate/search/*"
producedArtifactPattern "org/hibernate/hibernate-search*"
}
}
properties([
buildDiscarder(
logRotator(daysToKeepStr: '30', numToKeepStr: '10')
),
disableConcurrentBuilds(abortPrevious: true),
pipelineTriggers(
// HSEARCH-3417: do not add snapshotDependencies() here, this was known to cause problems.
[
issueCommentTrigger('.*test this please.*')
]
+ helper.generateUpstreamTriggers()
),
helper.generateNotificationProperty(),
[$class: 'EnvInjectJobProperty', info: [propertiesContent: 'TESTCONTAINERS_REUSE_ENABLE=true']],
parameters([
choice(
name: 'ENVIRONMENT_SET',
choices: """AUTOMATIC
DEFAULT
SUPPORTED
ALL""",
description: """A set of environments that must be checked.
'AUTOMATIC' picks a different set of environments based on the branch name.
'DEFAULT' means a single build with the default environment expected by the Maven configuration,
while other options will trigger multiple Maven executions in different environments."""
),
string(
name: 'ENVIRONMENT_FILTER',
defaultValue: '',
trim: true,
description: """A regex filter to apply to the environments that must be checked.
If this parameter is non-empty, ENVIRONMENT_SET will be ignored and environments whose tag matches the given regex will be checked.
Some useful filters: 'default', 'jdk', 'jdk-10', 'eclipse', 'postgresql', 'elasticsearch-local-[5.6'.
"""
)
])
])
if (helper.scmSource.branch.primary && !helper.scmSource.pullRequest) {
if (helper.configuration.file?.deployment?.maven?.settingsId) {
deploySnapshot = true
}
else {
echo "Missing deployment configuration in job configuration file - snapshot deployment will be skipped."
}
}
if (params.ENVIRONMENT_FILTER) {
keepOnlyEnvironmentsMatchingFilter(params.ENVIRONMENT_FILTER)
}
else {
keepOnlyEnvironmentsFromSet(params.ENVIRONMENT_SET)
}
// Determine whether ITs need to be run in the default build
enableDefaultBuildIT = environments.content.any { key, envSet ->
return envSet.enabled.contains(envSet.default)
}
// No need to re-test default environments separately, they will be tested as part of the default build if needed
environments.content.each { key, envSet ->
envSet.enabled.remove(envSet.default)
}
enableDefaultBuild =
enableDefaultBuildIT ||
environments.content.any { key, envSet -> envSet.enabled.any { buildEnv -> buildEnv.requiresDefaultBuildArtifacts() } } ||
deploySnapshot
if (helper.scmSource.pullRequest) {
incrementalBuild = true
}
echo """Branch: ${helper.scmSource.branch.name}
PR: ${helper.scmSource.pullRequest?.id}
params.ENVIRONMENT_SET: ${params.ENVIRONMENT_SET}
params.ENVIRONMENT_FILTER: ${params.ENVIRONMENT_FILTER}
Resulting execution plan:
enableDefaultBuild=$enableDefaultBuild
enableDefaultBuildIT=$enableDefaultBuildIT
environments=${environments.enabledAsString}
deploySnapshot=$deploySnapshot
incrementalBuild=$incrementalBuild
"""
}
stage('Default build') {
if (!enableDefaultBuild) {
echo 'Skipping default build and integration tests in the default environment'
helper.markStageSkipped()
return
}
runBuildOnNode( NODE_PATTERN_BASE, [time: 2, unit: 'HOURS'] ) {
withMavenWorkspace(mavenSettingsConfig: deploySnapshot ? helper.configuration.file.deployment.maven.settingsId : null) {
String commonMavenArgs = """ \
--fail-at-end \
-Pcoverage \
${toTestEnvironmentArgs(environments.content.jdk.default)} \
"""
echo "Building code and running unit tests and basic checks."
mvn """ \
${commonMavenArgs} \
-Pdist \
-Pjqassistant -Pci-build \
-DskipITs \
clean \
${deploySnapshot ? "\
deploy \
" : "\
install \
"} \
"""
dir(helper.configuration.maven.localRepositoryPath) {
stash name:'default-build-result', includes:"org/hibernate/search/**"
stash name:'default-build-cache', includes:".develocity/**"
}
if (!enableDefaultBuildIT) {
echo "Skipping integration tests in the default environment."
return
}
echo "Running integration tests in the default environment."
// We want to include all (relevant) modules in this second build,
// so that their coverage data is taken into account by jacoco:report-aggregate:
// if some modules are not in the build or classes are not compiled,
// Jacoco will just not report coverage for these classes.
// In PRs, "relevant" modules are only those affected by changes.
// However:
// - We have the Develocity local build cache to avoid re-compiling/re-running unit tests.
// - We disable a couple checks that were run above.
String itMavenArgs = """ \
${commonMavenArgs} \
-Pskip-checks \
-Pci-build \
${incrementalBuild ? """ \
-Dincremental \
-Dgib.referenceBranch=refs/remotes/origin/${helper.scmSource.pullRequest.target.name} \
""" : '' } \
"""
pullContainerImages( itMavenArgs )
// Note "clean" is necessary here in order to store the result of the build in the remote build cache
mvn """ \
${itMavenArgs} \
clean verify \
"""
stash name:'default-build-jacoco-reports', includes:"**/jacoco.exec"
}
}
}
stage('Non-default environments') {
Map<String, Closure> executions = [:]
Closure addExecution = { String tag, Closure execution ->
executions.put( tag, {
// This nested stage is necessary to be able to mark a single parallel execution as skipped
// See https://stackoverflow.com/a/59210261/6692043
stage( tag, execution )
} )
}
// Test with multiple JDKs
environments.content.jdk.enabled.each { JdkBuildEnvironment buildEnv ->
addExecution(buildEnv.tag, {
runBuildOnNode {
withMavenWorkspace {
// Re-run integration tests against the JARs produced by the default build,
// but using a different JDK to build and run the tests.
mavenNonDefaultBuild buildEnv, "-f integrationtest"
}
}
})
}
// Build with different compilers
environments.content.compiler.enabled.each { CompilerBuildEnvironment buildEnv ->
addExecution(buildEnv.tag, {
runBuildOnNode {
withMavenWorkspace {
// NOTE: we are not relying on incremental build in this case as
// we'd better recompile everything with the same compiler rather than get some strange errors
mavenNonDefaultBuild buildEnv, """ \
-DskipTests -DskipITs \
-P${buildEnv.mavenProfile},!javaModuleITs \
-Dgib.buildAll=true \
"""
}
}
})
}
// Test ORM integration with multiple databases
environments.content.database.enabled.each { DatabaseBuildEnvironment buildEnv ->
addExecution(buildEnv.tag, {
runBuildOnNode(NODE_PATTERN_BASE, [time: buildEnv.slow ? 2 : 1, unit: 'HOURS']) {
withMavenWorkspace {
def artifactsToTest = ['hibernate-search-mapper-orm']
// Some modules are likely to fail for reasons unrelated to Hibernate Search anyway
// (for example because we didn't configure the tests to handle other DBs),
// so we skip them.
String mavenBuildAdditionalArgs = ''' \
-pl !documentation \
-pl !integrationtest/mapper/orm-spring \
-pl !integrationtest/v5migrationhelper/orm \
-pl !integrationtest/java/modules/orm-lucene \
-pl !integrationtest/java/modules/orm-elasticsearch \
-pl !integrationtest/java/modules/orm-outbox-polling-elasticsearch \
'''
String mavenDockerArgs = ""
def startedContainers = false
tryFinally({
mavenNonDefaultBuild buildEnv, """ \
-Pdist \
-P$buildEnv.mavenProfile \
$mavenBuildAdditionalArgs \
""",
artifactsToTest
}, { // Finally
if ( startedContainers ) {
sh "mvn docker:stop $mavenDockerArgs"
}
})
}
}
})
}
// Test Elasticsearch integration with multiple versions in a local instance
environments.content.localElasticsearch.enabled.each { LocalElasticsearchBuildEnvironment buildEnv ->
addExecution(buildEnv.tag, {
runBuildOnNode {
withMavenWorkspace {
mavenNonDefaultBuild buildEnv, """ \
-Pdist \
-Dtest.elasticsearch.distribution=$buildEnv.distribution \
-Dtest.elasticsearch.version=$buildEnv.version \
-Dtest.lucene.skip=true \
""",
['hibernate-search-backend-elasticsearch']
}
}
})
}
// Test Elasticsearch integration with multiple versions in an AWS instance
environments.content.amazonElasticsearch.enabled.each { AmazonElasticsearchServiceBuildEnvironment buildEnv ->
if (!env.ES_AWS_REGION) {
throw new IllegalStateException("Environment variable ES_AWS_REGION is not set")
}
def awsCredentialsId = null
if (buildEnv.staticCredentials) {
awsCredentialsId = helper.configuration.file?.aws?.credentials
if (!awsCredentialsId) {
throw new IllegalStateException("Missing AWS credentials")
}
}
addExecution(buildEnv.tag, {
lock(label: buildEnv.lockedResourcesLabel, variable: 'LOCKED_RESOURCE_URI') {
runBuildOnNode(NODE_PATTERN_BASE + '&&AWS') {
if (awsCredentialsId == null) {
// By default, rely on credentials provided by the EC2 infrastructure
withMavenWorkspace {
// Tests may fail because of hourly AWS snapshots,
// which prevent deleting indexes while they are being executed.
// Unfortunately, this triggers test failure in @BeforeAll/@AfterAll,
// which cannot be handled by the maven-failsafe-plugin,
// which normally re-runs failing tests, but only if
// the failure occurs in the @Test method.
// So if this fails, we re-try ALL TESTS, at most twice.
// Note that because we expect frequent failure and retries,
// we use --fail-fast here, to make sure we don't waste time.
retry(count: 3) {
mavenNonDefaultBuild buildEnv, """ \
--fail-fast \
-pl ${[
'org.hibernate.search:hibernate-search-integrationtest-backend-elasticsearch',
'org.hibernate.search:hibernate-search-integrationtest-showcase-library'
].join(',')} \
-Dtest.lucene.skip=true \
-Dtest.elasticsearch.distribution=$buildEnv.distribution \
-Dtest.elasticsearch.version=$buildEnv.version \
-Dtest.elasticsearch.connection.uris=$env.LOCKED_RESOURCE_URI \
-Dtest.elasticsearch.connection.aws.signing.enabled=true \
-Dtest.elasticsearch.connection.aws.region=$env.ES_AWS_REGION \
"""
// We're not using ./ci/list-dependent-integration-tests.sh here on purpose:
// testing using AWS services is slow, and requires tweaks in test modules,
// so we're running only a few specific test modules.
}
}
}
else {
// For a few builds only, rely on static credentials provided by Jenkins
// (just to check that statically-provided credentials work correctly)
withMavenWorkspace {
// WARNING: Make sure credentials are evaluated by sh, not Groovy.
// To that end, escape the '$' when referencing the variables.
// See https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#string-interpolation
withCredentials([[$class : 'AmazonWebServicesCredentialsBinding',
credentialsId : awsCredentialsId,
// We use non-standard env variable names because we want the credentials
// to be provided through configuration properties.
// See how ElasticsearchTestHostConnectionConfiguration does that.
accessKeyVariable: 'HIBERNATE_SEARCH_AWS_STATIC_CREDENTIALS_ACCESS_KEY_ID',
secretKeyVariable: 'HIBERNATE_SEARCH_AWS_STATIC_CREDENTIALS_SECRET_ACCESS_KEY'
]]) {
// Tests may fail because of hourly AWS snapshots,
// which prevent deleting indexes while they are being executed.
// Unfortunately, this triggers test failure in @BeforeAll/@AfterAll,
// which cannot be handled by the maven-failsafe-plugin,
// which normally re-runs failing tests, but only if
// the failure occurs in the @Test method.
// So if this fails, we re-try ALL TESTS, at most twice.
// Note that because we expect frequent failure and retries,
// we use --fail-fast here, to make sure we don't waste time.
retry(count: 3) {
mavenNonDefaultBuild buildEnv, """ \
--fail-fast \
-pl org.hibernate.search:hibernate-search-integrationtest-backend-elasticsearch,org.hibernate.search:hibernate-search-integrationtest-showcase-library \
-Dtest.lucene.skip=true \
-Dtest.elasticsearch.distribution=$buildEnv.distribution \
-Dtest.elasticsearch.version=$buildEnv.version \
-Dtest.elasticsearch.connection.uris=$env.LOCKED_RESOURCE_URI \
-Dtest.elasticsearch.connection.aws.signing.enabled=true \
-Dtest.elasticsearch.connection.aws.region=$env.ES_AWS_REGION \
-Dtest.elasticsearch.connection.aws.credentials.type=static \
"""
// We're not using ./ci/list-dependent-integration-tests.sh here on purpose:
// testing using AWS services is slow, and requires tweaks in test modules,
// so we're running only a few specific test modules.
}
}
}
}
}
}
})
}
if (executions.isEmpty()) {
echo 'Skipping builds in non-default environments'
helper.markStageSkipped()
}
else {
parallel(executions)
}
}
stage('Sonar analysis') {
def sonarCredentialsId = helper.configuration.file?.sonar?.credentials
if (sonarCredentialsId) {
runBuildOnNode {
withMavenWorkspace {
dir(helper.configuration.maven.localRepositoryPath) {
unstash name: "default-build-cache"
}
if (enableDefaultBuild && enableDefaultBuildIT) {
unstash name: "default-build-jacoco-reports"
}
environments.content.jdk.enabled.each { JdkBuildEnvironment buildEnv ->
unstash name: "${buildEnv.tag}-build-jacoco-reports"
}
environments.content.database.enabled.each { JdkBuildEnvironment buildEnv ->
unstash name: "${buildEnv.tag}-build-jacoco-reports"
}
environments.content.localElasticsearch.enabled.each { JdkBuildEnvironment buildEnv ->
unstash name: "${buildEnv.tag}-build-jacoco-reports"
}
environments.content.amazonElasticsearch.enabled.each { JdkBuildEnvironment buildEnv ->
unstash name: "${buildEnv.tag}-build-jacoco-reports"
}
// we don't clean to keep the unstashed jacoco reports:
sh "mvn package -Pskip-checks -Pci-build -DskipTests -Pcoverage-report ${toTestEnvironmentArgs(environments.content.jdk.default)}"
// WARNING: Make sure credentials are evaluated by sh, not Groovy.
// To that end, escape the '$' when referencing the variables.
// See https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#string-interpolation
withCredentials([usernamePassword(
credentialsId: sonarCredentialsId,
usernameVariable: 'SONARCLOUD_ORGANIZATION',
// https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/scanners/sonarscanner-for-maven/#analyzing
passwordVariable: 'SONAR_TOKEN'
)]) {
// We don't want to use the build cache or build scans for this execution
def miscMavenArgs = '-Dscan=false -Dno-build-cache'
sh """ \
mvn sonar:sonar \
${miscMavenArgs} \
-Dsonar.organization=\${SONARCLOUD_ORGANIZATION} \
-Dsonar.host.url=https://sonarcloud.io \
${helper.scmSource.pullRequest ? """ \
-Dsonar.pullrequest.branch=${helper.scmSource.branch.name} \
-Dsonar.pullrequest.key=${helper.scmSource.pullRequest.id} \
-Dsonar.pullrequest.base=${helper.scmSource.pullRequest.target.name} \
${helper.scmSource.gitHubRepoId ? """ \
-Dsonar.pullrequest.provider=GitHub \
-Dsonar.pullrequest.github.repository=${helper.scmSource.gitHubRepoId} \
""" : ''} \
""" : """ \
-Dsonar.branch.name=${helper.scmSource.branch.name} \
"""} \
"""
}
}
}
} else {
echo "Skipping Sonar report: no credentials."
}
}
} // End of helper.runWithNotification
// Job-specific helpers
enum TestCondition {
// For environments that are expected to work correctly
// before merging into main or maintenance branches.
// Tested on main and maintenance branches, on feature branches, and for PRs.
BEFORE_MERGE,
// For environments that are expected to work correctly,
// but are considered too resource-intensive to test them on pull requests.
// Tested on main and maintenance branches only.
// Not tested on feature branches or PRs.
AFTER_MERGE,
// For environments that may not work correctly.
// Only tested when explicitly requested through job parameters.
ON_DEMAND;
// Work around JENKINS-33023
// See https://issues.jenkins-ci.org/browse/JENKINS-33023?focusedCommentId=325738&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-325738
public TestCondition() {}
}
abstract class BuildEnvironment {
boolean isDefault = false
TestCondition condition
String toString() { getTag() }
abstract String getTag()
boolean isDefault() { isDefault }
boolean requiresDefaultBuildArtifacts() { true }
boolean generatesCoverage() { true }
}
class JdkBuildEnvironment extends BuildEnvironment {
String version
String testCompilerTool
String testLauncherTool
String testLauncherArgs
@Override
String getTag() { "jdk-$version" }
}
class CompilerBuildEnvironment extends BuildEnvironment {
String name
String mavenProfile
String getTag() { "compiler-$name" }
@Override
boolean requiresDefaultBuildArtifacts() { false }
@Override
boolean generatesCoverage() {
return false
}
}
class DatabaseBuildEnvironment extends BuildEnvironment {
String dbName
String mavenProfile
boolean slow
@Override
String getTag() { "database-$dbName" }
}
class LocalElasticsearchBuildEnvironment extends BuildEnvironment {
String version
String getTagPrefix() { 'elasticsearch-local' }
@Override
String getTag() { tagPrefix + (version ? '-' + version : '') }
String getDistribution() { 'elastic' }
}
class LocalOpenSearchBuildEnvironment extends LocalElasticsearchBuildEnvironment {
String version
@Override
String getTagPrefix() { 'opensearch-local' }
@Override
String getDistribution() { 'opensearch' }
}
class AmazonOpenSearchServerlessLocalBuildEnvironment
extends LocalOpenSearchBuildEnvironment {
{
setVersion('')
}
@Override
String getTagPrefix() { 'amazon-opensearch-serverless' }
@Override
String getDistribution() { 'amazon-opensearch-serverless' }
}
class AmazonElasticsearchServiceBuildEnvironment extends LocalElasticsearchBuildEnvironment {
boolean staticCredentials = false
@Override
String getTagPrefix() { 'amazon-elasticsearch-service' }
@Override
String getTag() {
tagPrefix + (version ? '-' + version : '') + (staticCredentials ? '-credentials-static' : '')
}
String getLockedResourcesPrefix() { 'es' }
String getLockedResourcesLabel() {
"$lockedResourcesPrefix-aws-${version.replaceAll('\\.', '-')}"
}
}
class AmazonOpenSearchServiceBuildEnvironment extends AmazonElasticsearchServiceBuildEnvironment {
@Override
String getTagPrefix() { 'amazon-opensearch-service' }
@Override
String getDistribution() { 'opensearch' }
@Override
String getLockedResourcesPrefix() { 'opensearch' }
}
void keepOnlyEnvironmentsMatchingFilter(String regex) {
def pattern = /$regex/
boolean enableDefault = ('default' =~ pattern)
environments.content.each { key, envSet ->
envSet.enabled.removeAll { buildEnv ->
!(buildEnv.tag =~ pattern) && !(envSet.default == buildEnv && enableDefault)
}
}
}
void keepOnlyEnvironmentsFromSet(String environmentSetName) {
boolean enableDefaultEnv = false
boolean enableBeforeMergeEnvs = false
boolean enableAfterMergeEnvs = false
boolean enableOnDemandEnvs = false
switch (environmentSetName) {
case 'DEFAULT':
enableDefaultEnv = true
break
case 'SUPPORTED':
enableDefaultEnv = true
enableBeforeMergeEnvs = true
enableAfterMergeEnvs = true
break
case 'ALL':
enableDefaultEnv = true
enableBeforeMergeEnvs = true
enableAfterMergeEnvs = true
enableOnDemandEnvs = true
break
case 'AUTOMATIC':
if (helper.scmSource.pullRequest) {
echo "Building pull request '$helper.scmSource.pullRequest.id'"
enableDefaultEnv = true
enableBeforeMergeEnvs = true
} else if (helper.scmSource.branch.primary) {
echo "Building primary branch '$helper.scmSource.branch.name'"
enableDefaultEnv = true
enableBeforeMergeEnvs = true
enableAfterMergeEnvs = true
} else {
echo "Building feature branch '$helper.scmSource.branch.name'"
enableDefaultEnv = true
}
break
default:
throw new IllegalArgumentException(
"Unknown value for param 'ENVIRONMENT_SET': '$environmentSetName'."
)
}
// Filter environments
environments.content.each { key, envSet ->
envSet.enabled.removeAll { buildEnv -> ! (
enableDefaultEnv && buildEnv.isDefault ||
enableBeforeMergeEnvs && buildEnv.condition == TestCondition.BEFORE_MERGE ||
enableAfterMergeEnvs && buildEnv.condition == TestCondition.AFTER_MERGE ||
enableOnDemandEnvs && buildEnv.condition == TestCondition.ON_DEMAND ) }
}
}
void runBuildOnNode(Closure body) {
runBuildOnNode( NODE_PATTERN_BASE, body )
}
void runBuildOnNode(String label, Closure body) {
runBuildOnNode( label, [time: 1, unit: 'HOURS'], body )
}
void runBuildOnNode(String label, def timeoutValue, Closure body) {
node( label ) {
timeout( timeoutValue, body )
}
}
void withMavenWorkspace(Closure body) {
withMavenWorkspace([:], body)
}
void withMavenWorkspace(Map args, Closure body) {
args.put("options", [
// Artifacts are not needed and take up disk space
artifactsPublisher(disabled: true),
// stdout/stderr for successful tests is not needed and takes up disk space
// we archive test results and stdout/stderr as part of the build scan anyway,
// see https://ge.hibernate.org/scans?search.rootProjectNames=Hibernate%20Search
junitPublisher(disabled: true)
])
helper.withMavenWorkspace(args, {
// The script is in the code repository, so we need the scm checkout
// to be performed by helper.withMavenWorkspace before we can call the script.
sh 'ci/docker-cleanup.sh'
tryFinally(body, { // Finally
sh 'ci/docker-cleanup.sh'
})
})
}
void mvn(String args) {
def develocityMainCredentialsId = helper.configuration.file?.develocity?.credentials?.main
def develocityPrCredentialsId = helper.configuration.file?.develocity?.credentials?.pr
if ( !helper.scmSource.pullRequest && develocityMainCredentialsId ) {
// Not a PR: we can pass credentials to the build, allowing it to populate the build cache
// and to publish build scans directly.
withCredentials([string(credentialsId: develocityMainCredentialsId,
variable: 'DEVELOCITY_ACCESS_KEY')]) {
withGradle { // withDevelocity, actually: https://plugins.jenkins.io/gradle/#plugin-content-capturing-build-scans-from-jenkins-pipeline
sh "mvn $args"
}
}
}
else if ( helper.scmSource.pullRequest && develocityPrCredentialsId ) {
// Pull request: we can't pass credentials to the build, since we'd be exposing secrets to e.g. tests.
// We do the build first, then publish the build scan separately.
tryFinally({
sh "mvn $args"
}, { // Finally
withCredentials([string(credentialsId: develocityPrCredentialsId,
variable: 'DEVELOCITY_ACCESS_KEY')]) {
withGradle { // withDevelocity, actually: https://plugins.jenkins.io/gradle/#plugin-content-capturing-build-scans-from-jenkins-pipeline
sh 'mvn gradle-enterprise:build-scan-publish-previous'
}
}
})
}
else {
// No Develocity credentials.
sh "mvn $args"
}
}
// Perform authenticated pulls of container images, to avoid failure due to download throttling on dockerhub.
def pullContainerImages(String mavenArgs) {
String containerImageRefsString = ((String) sh( script: "./ci/list-container-images.sh ${mavenArgs}", returnStdout: true ) )