Cherry-pick to 7.9: [CI] MacOS stages for branches/tags and PRs when certain conditions (#20069) (#20333)

v1v · web-flow · commit 3152e56f2710 · 2020-07-31T08:08:19.000+01:00
* [CI] MacOS stages for branches/tags and PRs when certain conditions (#20069) * [CI] fix null string with contains (#20182)
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -37,17 +37,15 @@ pipeline {
     rateLimitBuilds(throttle: [count: 60, durationName: 'hour', userBoost: true])
   }
   triggers {
-    issueCommentTrigger('(?i).*(?:jenkins\\W+)?run\\W+(?:the\\W+)?tests(?:\\W+please)?.*')
+    issueCommentTrigger('(?i)(.*(?:jenkins\\W+)?run\\W+(?:the\\W+)?tests(?:\\W+please)?.*|^/test(\\W+macos)?$)')
   }
   parameters {
     booleanParam(name: 'runAllStages', defaultValue: false, description: 'Allow to run all stages.')
     booleanParam(name: 'windowsTest', defaultValue: true, description: 'Allow Windows stages.')
-    booleanParam(name: 'macosTest', defaultValue: true, description: 'Allow macOS stages.')
-
+    booleanParam(name: 'macosTest', defaultValue: false, description: 'Allow macOS stages.')
     booleanParam(name: 'allCloudTests', defaultValue: false, description: 'Run all cloud integration tests.')
     booleanParam(name: 'awsCloudTests', defaultValue: false, description: 'Run AWS cloud integration tests.')
     string(name: 'awsRegion', defaultValue: 'eu-central-1', description: 'Default AWS region to use for testing.')
-
     booleanParam(name: 'debug', defaultValue: false, description: 'Allow debug logging for Jenkins steps')
     booleanParam(name: 'dry_run', defaultValue: false, description: 'Skip build steps, it is for testing pipeline flow')
   }
@@ -100,7 +98,6 @@ pipeline {
             mageTarget(context: "Elastic Agent x-pack Linux", directory: "x-pack/elastic-agent", target: "build test")
           }
         }
-
         stage('Elastic Agent x-pack Windows'){
           agent { label 'windows-immutable && windows-2019' }
           options { skipDefaultCheckout() }
@@ -114,14 +111,13 @@ pipeline {
             mageTargetWin(context: "Elastic Agent x-pack Windows Unit test", directory: "x-pack/elastic-agent", target: "build unitTest")
           }
         }
-
         stage('Elastic Agent Mac OS X'){
           agent { label 'macosx' }
           options { skipDefaultCheckout() }
           when {
             beforeAgent true
             expression {
-              return env.BUILD_ELASTIC_AGENT_XPACK != "false" && params.macosTest
+              return env.BUILD_ELASTIC_AGENT_XPACK != "false" && env.BUILD_ON_MACOS != 'false'
             }
           }
           steps {
@@ -133,7 +129,6 @@ pipeline {
             }
           }
         }
-
         stage('Filebeat oss'){
           agent { label 'ubuntu-18 && immutable' }
           options { skipDefaultCheckout() }
@@ -166,7 +161,7 @@ pipeline {
           when {
             beforeAgent true
             expression {
-              return env.BUILD_FILEBEAT != "false" && params.macosTest
+              return env.BUILD_FILEBEAT != "false" && env.BUILD_ON_MACOS != 'false'
             }
           }
           steps {
@@ -184,7 +179,7 @@ pipeline {
           when {
             beforeAgent true
             expression {
-              return env.BUILD_FILEBEAT_XPACK != "false" && params.macosTest
+              return env.BUILD_FILEBEAT_XPACK != "false" && env.BUILD_ON_MACOS != 'false'
             }
           }
           steps {
@@ -243,7 +238,7 @@ pipeline {
               when {
                 beforeAgent true
                 expression {
-                  return params.macosTest
+                  return env.BUILD_ON_MACOS != 'false'
                 }
               }
               steps {
@@ -302,7 +297,7 @@ pipeline {
           when {
             beforeAgent true
             expression {
-              return env.BUILD_AUDITBEAT != "false" && params.macosTest
+              return env.BUILD_AUDITBEAT != "false" && env.BUILD_ON_MACOS != 'false'
             }
           }
           steps {
@@ -346,7 +341,7 @@ pipeline {
           when {
             beforeAgent true
             expression {
-              return env.BUILD_AUDITBEAT_XPACK != "false" && params.macosTest
+              return env.BUILD_AUDITBEAT_XPACK != "false" && env.BUILD_ON_MACOS != 'false'
             }
           }
           steps {
@@ -499,7 +494,7 @@ pipeline {
           when {
             beforeAgent true
             expression {
-              return env.BUILD_METRICBEAT != "false" && params.macosTest
+              return env.BUILD_METRICBEAT != "false" && env.BUILD_ON_MACOS != 'false'
             }
           }
           steps {
@@ -512,7 +507,7 @@ pipeline {
           when {
             beforeAgent true
             expression {
-              return env.BUILD_METRICBEAT_XPACK != "false" && params.macosTest
+              return env.BUILD_METRICBEAT_XPACK != "false" && env.BUILD_ON_MACOS != 'false'
             }
           }
           steps {
@@ -571,7 +566,7 @@ pipeline {
               when {
                 beforeAgent true
                 expression {
-                  return params.macosTest
+                  return env.BUILD_ON_MACOS != 'false'
                 }
               }
               steps {
@@ -682,7 +677,7 @@ pipeline {
               when {
                 beforeAgent true
                 expression {
-                  return params.macosTest
+                  return env.BUILD_ON_MACOS != 'false'
                 }
               }
               steps {
@@ -754,7 +749,7 @@ pipeline {
               when {
                 beforeAgent true
                 expression {
-                  return params.macosTest
+                  return env.BUILD_ON_MACOS != 'false'
                 }
               }
               steps {
@@ -772,7 +767,7 @@ pipeline {
               when {
                 beforeAgent true
                 expression {
-                  return params.macosTest
+                  return env.BUILD_ON_MACOS != 'false'
                 }
               }
               steps {
@@ -1330,6 +1325,12 @@ def loadConfigEnvVars(){
 
   // Skip all the stages for changes only related to the documentation
   env.ONLY_DOCS = isDocChangedOnly()
+
+  // Enable macOS builds when required
+  env.BUILD_ON_MACOS = (params.macosTest                  // UI Input parameter is set to true
+                        || !isPR()                        // For branches and tags
+                        || matchesPrLabel(label: 'macOS') // If `macOS` GH label (Case-Sensitive)
+                        || (env.GITHUB_COMMENT?.toLowerCase()?.contains('/test macos'))) // If `/test macos` in the GH comment (Case-Insensitive)
 }
 
 /**
diff --git a/README.md b/README.md
@@ -84,4 +84,19 @@ your dev environment to build Beats from the source.
 
 ## Snapshots
 
-For testing purposes, we generate snapshot builds that you can find [here](https://beats-ci.elastic.co/job/elastic+beats+master+multijob-package-linux/lastSuccessfulBuild/gcsObjects/). Please be aware that these are built on top of master and are not meant for production.
+For testing purposes, we generate snapshot builds that you can find [here](https://beats-ci.elastic.co/job/Beats/job/packaging/job/master/lastSuccessfulBuild/gcsObjects/). Please be aware that these are built on top of master and are not meant for production.
+
+## CI
+
+It is possible to trigger some jobs by putting a comment on a GitHub PR.
+(This service is only available for users affiliated with Elastic and not for open-source contributors.)
+
+* [beats][]
+  * `jenkins run the tests please` or `jenkins run tests` or `/test` will kick off a default build.
+  * `/test macos` will kick off a default build with also the `macos` stages.
+* [apm-beats-update][]
+  * `/run apm-beats-update`
+
+
+[beats]: https://beats-ci.elastic.co/job/Beats/job/beats-beats-mbp/
+[apm-beats-update]: https://beats-ci.elastic.co/job/Beats/job/apm-beats-update/

Original file line number	Diff line number	Diff line change
`@@ -37,17 +37,15 @@ pipeline {`
`37`	`37`	`rateLimitBuilds(throttle: [count: 60, durationName: 'hour', userBoost: true])`
`38`	`38`	`}`
`39`	`39`	`triggers {`
`40`		`- issueCommentTrigger('(?i).(?:jenkins\\W+)?run\\W+(?:the\\W+)?tests(?:\\W+please)?.')`
	`40`	`+ issueCommentTrigger('(?i)(.(?:jenkins\\W+)?run\\W+(?:the\\W+)?tests(?:\\W+please)?.\|^/test(\\W+macos)?$)')`
`41`	`41`	`}`
`42`	`42`	`parameters {`
`43`	`43`	`booleanParam(name: 'runAllStages', defaultValue: false, description: 'Allow to run all stages.')`
`44`	`44`	`booleanParam(name: 'windowsTest', defaultValue: true, description: 'Allow Windows stages.')`
`45`		`- booleanParam(name: 'macosTest', defaultValue: true, description: 'Allow macOS stages.')`
`46`		`-`
	`45`	`+ booleanParam(name: 'macosTest', defaultValue: false, description: 'Allow macOS stages.')`
`47`	`46`	`booleanParam(name: 'allCloudTests', defaultValue: false, description: 'Run all cloud integration tests.')`
`48`	`47`	`booleanParam(name: 'awsCloudTests', defaultValue: false, description: 'Run AWS cloud integration tests.')`
`49`	`48`	`string(name: 'awsRegion', defaultValue: 'eu-central-1', description: 'Default AWS region to use for testing.')`
`50`		`-`
`51`	`49`	`booleanParam(name: 'debug', defaultValue: false, description: 'Allow debug logging for Jenkins steps')`
`52`	`50`	`booleanParam(name: 'dry_run', defaultValue: false, description: 'Skip build steps, it is for testing pipeline flow')`
`53`	`51`	`}`
`@@ -100,7 +98,6 @@ pipeline {`
`100`	`98`	`mageTarget(context: "Elastic Agent x-pack Linux", directory: "x-pack/elastic-agent", target: "build test")`
`101`	`99`	`}`
`102`	`100`	`}`
`103`		`-`
`104`	`101`	`stage('Elastic Agent x-pack Windows'){`
`105`	`102`	`agent { label 'windows-immutable && windows-2019' }`
`106`	`103`	`options { skipDefaultCheckout() }`
`@@ -114,14 +111,13 @@ pipeline {`
`114`	`111`	`mageTargetWin(context: "Elastic Agent x-pack Windows Unit test", directory: "x-pack/elastic-agent", target: "build unitTest")`
`115`	`112`	`}`
`116`	`113`	`}`
`117`		`-`
`118`	`114`	`stage('Elastic Agent Mac OS X'){`
`119`	`115`	`agent { label 'macosx' }`
`120`	`116`	`options { skipDefaultCheckout() }`
`121`	`117`	`when {`
`122`	`118`	`beforeAgent true`
`123`	`119`	`expression {`
`124`		`- return env.BUILD_ELASTIC_AGENT_XPACK != "false" && params.macosTest`
	`120`	`+ return env.BUILD_ELASTIC_AGENT_XPACK != "false" && env.BUILD_ON_MACOS != 'false'`
`125`	`121`	`}`
`126`	`122`	`}`
`127`	`123`	`steps {`
`@@ -133,7 +129,6 @@ pipeline {`
`133`	`129`	`}`
`134`	`130`	`}`
`135`	`131`	`}`
`136`		`-`
`137`	`132`	`stage('Filebeat oss'){`
`138`	`133`	`agent { label 'ubuntu-18 && immutable' }`
`139`	`134`	`options { skipDefaultCheckout() }`
`@@ -166,7 +161,7 @@ pipeline {`
`166`	`161`	`when {`
`167`	`162`	`beforeAgent true`
`168`	`163`	`expression {`
`169`		`- return env.BUILD_FILEBEAT != "false" && params.macosTest`
	`164`	`+ return env.BUILD_FILEBEAT != "false" && env.BUILD_ON_MACOS != 'false'`
`170`	`165`	`}`
`171`	`166`	`}`
`172`	`167`	`steps {`
`@@ -184,7 +179,7 @@ pipeline {`
`184`	`179`	`when {`
`185`	`180`	`beforeAgent true`
`186`	`181`	`expression {`
`187`		`- return env.BUILD_FILEBEAT_XPACK != "false" && params.macosTest`
	`182`	`+ return env.BUILD_FILEBEAT_XPACK != "false" && env.BUILD_ON_MACOS != 'false'`
`188`	`183`	`}`
`189`	`184`	`}`
`190`	`185`	`steps {`
`@@ -243,7 +238,7 @@ pipeline {`
`243`	`238`	`when {`
`244`	`239`	`beforeAgent true`
`245`	`240`	`expression {`
`246`		`- return params.macosTest`
	`241`	`+ return env.BUILD_ON_MACOS != 'false'`
`247`	`242`	`}`
`248`	`243`	`}`
`249`	`244`	`steps {`
`@@ -302,7 +297,7 @@ pipeline {`
`302`	`297`	`when {`
`303`	`298`	`beforeAgent true`
`304`	`299`	`expression {`
`305`		`- return env.BUILD_AUDITBEAT != "false" && params.macosTest`
	`300`	`+ return env.BUILD_AUDITBEAT != "false" && env.BUILD_ON_MACOS != 'false'`
`306`	`301`	`}`
`307`	`302`	`}`
`308`	`303`	`steps {`
`@@ -346,7 +341,7 @@ pipeline {`
`346`	`341`	`when {`
`347`	`342`	`beforeAgent true`
`348`	`343`	`expression {`
`349`		`- return env.BUILD_AUDITBEAT_XPACK != "false" && params.macosTest`
	`344`	`+ return env.BUILD_AUDITBEAT_XPACK != "false" && env.BUILD_ON_MACOS != 'false'`
`350`	`345`	`}`
`351`	`346`	`}`
`352`	`347`	`steps {`
`@@ -499,7 +494,7 @@ pipeline {`
`499`	`494`	`when {`
`500`	`495`	`beforeAgent true`
`501`	`496`	`expression {`
`502`		`- return env.BUILD_METRICBEAT != "false" && params.macosTest`
	`497`	`+ return env.BUILD_METRICBEAT != "false" && env.BUILD_ON_MACOS != 'false'`
`503`	`498`	`}`
`504`	`499`	`}`
`505`	`500`	`steps {`
`@@ -512,7 +507,7 @@ pipeline {`
`512`	`507`	`when {`
`513`	`508`	`beforeAgent true`
`514`	`509`	`expression {`
`515`		`- return env.BUILD_METRICBEAT_XPACK != "false" && params.macosTest`
	`510`	`+ return env.BUILD_METRICBEAT_XPACK != "false" && env.BUILD_ON_MACOS != 'false'`
`516`	`511`	`}`
`517`	`512`	`}`
`518`	`513`	`steps {`
`@@ -571,7 +566,7 @@ pipeline {`
`571`	`566`	`when {`
`572`	`567`	`beforeAgent true`
`573`	`568`	`expression {`
`574`		`- return params.macosTest`
	`569`	`+ return env.BUILD_ON_MACOS != 'false'`
`575`	`570`	`}`
`576`	`571`	`}`
`577`	`572`	`steps {`
`@@ -682,7 +677,7 @@ pipeline {`
`682`	`677`	`when {`
`683`	`678`	`beforeAgent true`
`684`	`679`	`expression {`
`685`		`- return params.macosTest`
	`680`	`+ return env.BUILD_ON_MACOS != 'false'`
`686`	`681`	`}`
`687`	`682`	`}`
`688`	`683`	`steps {`
`@@ -754,7 +749,7 @@ pipeline {`
`754`	`749`	`when {`
`755`	`750`	`beforeAgent true`
`756`	`751`	`expression {`
`757`		`- return params.macosTest`
	`752`	`+ return env.BUILD_ON_MACOS != 'false'`
`758`	`753`	`}`
`759`	`754`	`}`
`760`	`755`	`steps {`
`@@ -772,7 +767,7 @@ pipeline {`
`772`	`767`	`when {`
`773`	`768`	`beforeAgent true`
`774`	`769`	`expression {`
`775`		`- return params.macosTest`
	`770`	`+ return env.BUILD_ON_MACOS != 'false'`
`776`	`771`	`}`
`777`	`772`	`}`
`778`	`773`	`steps {`
`@@ -1330,6 +1325,12 @@ def loadConfigEnvVars(){`
`1330`	`1325`
`1331`	`1326`	`// Skip all the stages for changes only related to the documentation`
`1332`	`1327`	`env.ONLY_DOCS = isDocChangedOnly()`
	`1328`	`+`
	`1329`	`+ // Enable macOS builds when required`
	`1330`	`+ env.BUILD_ON_MACOS = (params.macosTest // UI Input parameter is set to true`
	`1331`	`+ \|\| !isPR() // For branches and tags`
	`1332`	+ \|\| matchesPrLabel(label: 'macOS') // If `macOS` GH label (Case-Sensitive)
	`1333`	+ \|\| (env.GITHUB_COMMENT?.toLowerCase()?.contains('/test macos'))) // If `/test macos` in the GH comment (Case-Insensitive)
`1333`	`1334`	`}`
`1334`	`1335`
`1335`	`1336`	`/**`