Jenkins pipeline for sending PRs to agents when changing the BDD specs

.ci/.jenkins-agents.yml

@@ -0,0 +1,12 @@
+---
+agents:
+  - NAME: "dotnet"
+    FEATURES_PATH: "test/Elastic.Apm.Feature.Tests/Features"
+  - NAME: "go"
+    FEATURES_PATH: "features"
+  - NAME: "java"
+    FEATURES_PATH: "apm-agent-core/src/test/resources/specs"
+  - NAME: "python"
+    FEATURES_PATH: "tests/bdd/features"
+  - NAME: "ruby"
+    FEATURES_PATH: "features"

.ci/Jenkinsfile

@@ -0,0 +1,121 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+@Library('apm@current') _
+
+pipeline {
+   agent { label 'linux && immutable' }
+  environment {
+    REPO = 'apm'
+    BASE_DIR = "src/github.com/elastic/${env.REPO}"
+    HOME = "${env.WORKSPACE}"
+    NOTIFY_TO = credentials('notify-to')
+    JOB_GCS_BUCKET = credentials('gcs-bucket')
+    JOB_GIT_CREDENTIALS = "f6c7695a-671e-4f4f-a331-acdce44ff9ba"
+    PATH = "${env.PATH}:${env.WORKSPACE}/bin"
+    PIPELINE_LOG_LEVEL='INFO'
+  }
+  options {
+    timeout(time: 3, unit: 'HOURS')
+    buildDiscarder(logRotator(numToKeepStr: '5', artifactNumToKeepStr: '5'))
+    timestamps()
+    ansiColor('xterm')
+    disableResume()
+    durabilityHint('PERFORMANCE_OPTIMIZED')
+  }
+  parameters {
+    booleanParam(name: 'Do_Send_PR', defaultValue: false, description: 'Allows to execute this pipeline in dry run mode, without sending a PR.')
+  }
+  stages {
+    stage('Initializing'){
+      options { skipDefaultCheckout() }
+      stages {
+        stage('Checkout'){
+          steps {
+            deleteDir()
+            gitCheckout(basedir: "${BASE_DIR}",
+              branch: "master",
+              repo: "git@github.com:elastic/${REPO}.git",
+              credentialsId: "${JOB_GIT_CREDENTIALS}"
+            )
+            stash allowEmpty: true, name: 'source', useDefaultExcludes: false
+            script {
+              dir("${BASE_DIR}"){
+                def regexps =[
+                  "^tests/agents/gherkin-specs/"
+                ]
+                env.GHERKIN_SPECS_UPDATED = isGitRegionMatch(patterns: regexps)
+              }
+            }
+          }
+        }
+        stage('Send Pull Request'){
+          options {
+            skipDefaultCheckout()
+            warnError('Pull Requests to APM agents failed')
+          }
+          environment {
+            DO_SEND_PR = "${params.Do_Send_PR}"
+          }
+          when {
+            beforeAgent true
+            expression { return env.GHERKIN_SPECS_UPDATED != "false" }
+          }
+          steps {
+            unstash 'source'
+            dir("${BASE_DIR}"){
+              script {
+                def agents = readYaml(file: '.ci/.jenkins-agents.yml')
+                def parallelTasks = [:]
+                agents['agents'].each { agent ->
+                  parallelTasks["apm-agent-${agent.NAME}"] = generateStepForAgent(agent: "${agent.NAME}", featuresPath: "${agent.FEATURES_PATH}")
+                }
+
+                parallel(parallelTasks)
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+  post {
+    cleanup {
+      notifyBuildResult()
+    }
+  }
+}
+
+def generateStepForAgent(Map params = [:]){
+  def agent = params.get('agent')
+  def featuresPath = params.get('featuresPath')
+  log(level: 'INFO', text: "agent=${agent} featuresPath=${featuresPath}")
+  return {
+    node('linux && immutable') {
+      catchError(buildResult: 'SUCCESS', stageResult: 'UNSTABLE') {
+        deleteDir()
+        gitCmd(cmd: "config", credentialsId: '', args: '--global user.name elasticmachine')
+        gitCmd(cmd: "config", credentialsId: '', args: '--global user.email infra-root-elasticmachine@elastic.co')
+        unstash 'source'
+        dir("${BASE_DIR}"){
+          sh script: '.ci/scripts/install-dependencies.sh', label: "Install dependencies"
+          sh script: """.ci/scripts/send-pr.sh "${agent}" "${featuresPath}" """, label: "Send Pull Request for apm-agent-${agent}"
+        }
+      }
+    }
+  }
+}

.ci/scripts/install-dependencies.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -uexo pipefail
+
+readonly HUB_VERSION="2.14.2"
+readonly HUB_CMD="${HOME}/bin"
+
+# install GitHub's hub
+curl -fsSL https://github.com/github/hub/raw/master/script/get | bash -s ${HUB_VERSION}
+mkdir -p ${HUB_CMD}
+mv bin/hub "${HUB_CMD}/hub"

.ci/scripts/send-pr.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+set -uexo pipefail
+
+readonly APM_AGENT=${1}
+readonly APM_AGENT_SPECS_DIR=${2}
+readonly APM_AGENT_REPO_NAME="apm-agent-${APM_AGENT}"
+readonly GIT_DIR=".ci/git"
+readonly APM_AGENT_REPO_DIR="${GIT_DIR}/${APM_AGENT_REPO_NAME}"
+
+git clone "https://github.com/elastic/${APM_AGENT_REPO_NAME}" "${APM_AGENT_REPO_DIR}"
+
+mkdir -p "${APM_AGENT_REPO_DIR}/${APM_AGENT_SPECS_DIR}"
+echo "Copying feature files to the ${APM_AGENT_REPO_NAME} repo"
+cp tests/agents/gherkin-specs/*.feature "${APM_AGENT_REPO_DIR}/${APM_AGENT_SPECS_DIR}"
+
+cd ${APM_AGENT_REPO_DIR}
+git checkout -b update-feature-files-$(date "+%Y%m%d%H%M%S")
+git add ${APM_AGENT_SPECS_DIR}
+git commit -m "test: synchronizing bdd specs"
+
+if [[ "${DO_SEND_PR}" == "true" ]]; then
+    hub pull-request \ 
+        -p \                                  # push the branch to the remote
+        --labels automation \                 # comma-separated list of tags
+        --reviewer @elastic/apm-agent-devs \  # set agents as reviewer of the PR
+        -m "test: synchronizing bdd specs"  # PR message
+else 
+    echo "PR sent to ${APM_AGENT_REPO_NAME}"
+fi