Using @elastic/synthetics to run uptime e2e tests

.ci/end2end.groovy

@@ -37,83 +37,90 @@ pipeline {
         deleteDir()
         gitCheckout(basedir: "${BASE_DIR}", githubNotifyFirstTimeContributor: false,
                     shallow: false, reference: "/var/lib/jenkins/.git-references/kibana.git")
-
-        // Filter when to run based on the below reasons:
-        //  - On a PRs when:
-        //    - There are changes related to the APM UI project
-        //      - only when the owners of those changes are members of the given GitHub teams
-        //  - On merges to branches when:
-        //    - There are changes related to the APM UI project
-        //  - FORCE parameter is set to true.
-        script {
-          def apm_updated = false
-          dir("${BASE_DIR}"){
-            apm_updated = isGitRegionMatch(patterns: [ "^x-pack/plugins/apm/.*" ])
-          }
-          if (isPR()) {
-            def isMember = isMemberOf(user: env.CHANGE_AUTHOR, team: ['apm-ui', 'uptime'])
-            setEnvVar('RUN_APM_E2E', params.FORCE || (apm_updated && isMember))
-          } else {
-            setEnvVar('RUN_APM_E2E', params.FORCE || apm_updated)
-          }
-        }
-      }
-    }
-    stage('Prepare Kibana') {
-      options { skipDefaultCheckout() }
-      when { expression { return env.RUN_APM_E2E != "false" } }
-      environment {
-        JENKINS_NODE_COOKIE = 'dontKillMe'
-      }
-      steps {
-        notifyStatus('Preparing kibana', 'PENDING')
-        dir("${BASE_DIR}"){
-          sh "${E2E_DIR}/ci/prepare-kibana.sh"
-        }
-      }
-      post {
-        unsuccessful {
-          notifyStatus('Kibana warm up failed', 'FAILURE')
-        }
+        analyseBuildReasonForApmUI()
+        analyseBuildReasonForUptimeUI()
       }
     }
-    stage('Smoke Tests'){
-      options { skipDefaultCheckout() }
-      when { expression { return env.RUN_APM_E2E != "false" } }
-      steps{
-        notifyTestStatus('Running smoke tests', 'PENDING')
-        dir("${BASE_DIR}"){
-          sh "${E2E_DIR}/ci/run-e2e.sh"
+    stage('e2e') {
+      when {
+        anyOf {
+          expression { return env.RUN_APM_E2E != "false" }
+          expression { return env.RUN_UPTIME_E2E != "false" }
         }
       }
-      post {
-        always {
-          dir("${BASE_DIR}/${E2E_DIR}"){
-            archiveArtifacts(allowEmptyArchive: false, artifacts: 'cypress/screenshots/**,cypress/videos/**,cypress/test-results/*e2e-tests.xml')
-            junit(allowEmptyResults: true, testResults: 'cypress/test-results/*e2e-tests.xml')
-            dir('tmp/apm-integration-testing'){
-              sh 'docker-compose logs > apm-its-docker.log || true'
-              sh 'docker-compose down -v || true'
-              archiveArtifacts(allowEmptyArchive: true, artifacts: 'apm-its-docker.log')
+      parallel {
+        // One or more stages need to be included within the parallel block.
+        stage('APM-UI') {
+          stages {
+            stage('Prepare Kibana') {
+              options { skipDefaultCheckout() }
+              when { expression { return env.RUN_APM_E2E != "false" } }
+              environment {
+                JENKINS_NODE_COOKIE = 'dontKillMe'
+              }
+              steps {
+                notifyStatus('Preparing kibana', 'PENDING')
+                dir("${BASE_DIR}"){
+                  sh "${E2E_DIR}/ci/prepare-kibana.sh"
+                }
+              }
+              post {
+                unsuccessful {
+                  notifyStatus('Kibana warm up failed', 'FAILURE')
+                }
+              }
+            }
+            stage('Smoke Tests'){
+              options { skipDefaultCheckout() }
+              when { expression { return env.RUN_APM_E2E != "false" } }
+              steps{
+                notifyTestStatus('Running smoke tests', 'PENDING')
+                dir("${BASE_DIR}"){
+                  sh "${E2E_DIR}/ci/run-e2e.sh"
+                }
+              }
+              post {
+                always {
+                  dir("${BASE_DIR}/${E2E_DIR}"){
+                    archiveArtifacts(allowEmptyArchive: false, artifacts: 'cypress/screenshots/**,cypress/videos/**,cypress/test-results/*e2e-tests.xml')
+                    junit(allowEmptyResults: true, testResults: 'cypress/test-results/*e2e-tests.xml')
+                    dir('tmp/apm-integration-testing'){
+                      sh 'docker-compose logs > apm-its-docker.log || true'
+                      sh 'docker-compose down -v || true'
+                      archiveArtifacts(allowEmptyArchive: true, artifacts: 'apm-its-docker.log')
+                    }
+                    archiveArtifacts(allowEmptyArchive: true, artifacts: 'tmp/*.log')
+                  }
+                }
+                unsuccessful {
+                  notifyTestStatus('Test failures', 'FAILURE')
+                }
+                success {
+                  notifyTestStatus('Tests passed', 'SUCCESS')
+                }
+              }
+            }
+          }
+          post {
+            always {
+              dir("${BASE_DIR}"){
+                archiveArtifacts(allowEmptyArchive: true, artifacts: "${E2E_DIR}/kibana.log")
+              }
             }
-            archiveArtifacts(allowEmptyArchive: true, artifacts: 'tmp/*.log')
           }
         }
-        unsuccessful {
-          notifyTestStatus('Test failures', 'FAILURE')
-        }
-        success {
-          notifyTestStatus('Tests passed', 'SUCCESS')
+        stage('UPTIME-UI') {
+          agent { label 'linux && immutable' }
+          options { skipDefaultCheckout() }
+          when { expression { return env.RUN_UPTIME_E2E != "false" } }
+          steps {
+            echo 'TBC'
+          }
         }
       }
     }
   }
   post {
-    always {
-      dir("${BASE_DIR}"){
-        archiveArtifacts(allowEmptyArchive: true, artifacts: "${E2E_DIR}/kibana.log")
-      }
-    }
     cleanup {
       notifyBuildResult(prComment: false, analyzeFlakey: false, shouldNotify: false)
     }
@@ -127,3 +134,47 @@ def notifyStatus(String description, String status) {
 def notifyTestStatus(String description, String status) {
   withGithubStatus.notify('end2end-for-apm-ui', description, status, getBlueoceanTabURL('tests'))
 }
+
+/**
+* Filter when to run based on the below reasons:
+*  - On a PRs when:
+*    - There are changes related to the APM UI project
+*      - only when the owners of those changes are members of the given GitHub teams
+*  - On merges to branches when:
+*    - There are changes related to the APM UI project
+*  - FORCE parameter is set to true.
+*/
+def analyseBuildReasonForApmUI() {
+  def apm_updated = false
+  dir("${BASE_DIR}"){
+    apm_updated = isGitRegionMatch(patterns: [ "^x-pack/plugins/apm/.*" ])
+  }
+  if (isPR()) {
+    def isMember = isMemberOf(user: env.CHANGE_AUTHOR, team: ['apm-ui', 'uptime'])
+    setEnvVar('RUN_APM_E2E', params.FORCE || (apm_updated && isMember))
+  } else {
+    setEnvVar('RUN_APM_E2E', params.FORCE || apm_updated)
+  }
+}
+
+/**
+* Filter when to run based on the below reasons:
+*  - On a PRs when:
+*    - There are changes related to the Uptime UI project
+*      - only when the owners of those changes are members of the given GitHub teams
+*  - On merges to branches when:
+*    - There are changes related to the Uptime UI project
+*  - FORCE parameter is set to true.
+*/
+def analyseBuildReasonForUptimeUI() {
+  def uptime_updated = false
+  dir("${BASE_DIR}"){
+    uptime_updated = isGitRegionMatch(patterns: [ "^x-pack/plugins/apm/.*" ])
+  }
+  if (isPR()) {
+    def isMember = isMemberOf(user: env.CHANGE_AUTHOR, team: ['uptime'])
+    setEnvVar('RUN_UPTIME_E2E', params.FORCE || (uptime_updated && isMember))
+  } else {
+    setEnvVar('RUN_UPTIME_E2E', params.FORCE || uptime_updated)
+  }
+}

package.json

@@ -353,6 +353,7 @@
     "@elastic/github-checks-reporter": "0.0.20b3",
     "@elastic/makelogs": "^6.0.0",
     "@elastic/maki": "6.3.0",
+    "@elastic/synthetics": "0.0.1-alpha.9",
     "@elastic/ui-ace": "0.2.3",
     "@istanbuljs/schema": "^0.1.2",
     "@jest/reporters": "^26.5.2",

packages/kbn-test/src/functional_test_runner/lib/config/schema.ts

@@ -175,6 +175,7 @@ export const schema = Joi.object()
         serverEnvVars: Joi.object(),
         dataArchive: Joi.string(),
         ssl: Joi.boolean().default(false),
+        skipEsCluster: Joi.boolean(),
       })
       .default(),
 

packages/kbn-test/src/functional_tests/lib/run_elasticsearch.js

@@ -14,12 +14,16 @@ import { setupUsers, DEFAULT_SUPERUSER_PASS } from './auth';
 
 export async function runElasticsearch({ config, options }) {
   const { log, esFrom } = options;
+
   const ssl = config.get('esTestCluster.ssl');
   const license = config.get('esTestCluster.license');
   const esArgs = config.get('esTestCluster.serverArgs');
   const esEnvVars = config.get('esTestCluster.serverEnvVars');
   const isSecurityEnabled = esArgs.includes('xpack.security.enabled=true');
 
+  if (config.get('esTestCluster.skipEsCluster')) {
+    return;
+  }
   const cluster = createLegacyEsTestCluster({
     port: config.get('servers.elasticsearch.port'),
     password: isSecurityEnabled

src/dev/typescript/projects.ts

@@ -32,6 +32,11 @@ export const PROJECTS = [
     disableTypeCheck: true,
   }),
 
+  new Project(resolve(REPO_ROOT, 'x-pack/plugins/uptime/e2e/tsconfig.json'), {
+    name: 'uptime/synthetics-e2e-tests',
+    disableTypeCheck: true,
+  }),
+
   // NOTE: using glob.sync rather than glob-all or globby
   // because it takes less than 10 ms, while the other modules
   // both took closer to 1000ms.

x-pack/plugins/uptime/e2e/config.ts

@@ -0,0 +1,50 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { FtrConfigProviderContext } from '@kbn/test/types/ftr';
+
+import { CA_CERT_PATH } from '@kbn/dev-utils';
+async function config({ readConfigFile }: FtrConfigProviderContext) {
+  const kibanaCommonTestsConfig = await readConfigFile(
+    require.resolve('../../../../test/common/config.js')
+  );
+  const xpackFunctionalTestsConfig = await readConfigFile(
+    require.resolve('../../../test/functional/config.js')
+  );
+
+  return {
+    ...kibanaCommonTestsConfig.getAll(),
+
+    esTestCluster: {
+      skipEsCluster: true,
+      ...xpackFunctionalTestsConfig.get('esTestCluster'),
+      serverArgs: [
+        ...xpackFunctionalTestsConfig.get('esTestCluster.serverArgs'),
+        // define custom es server here
+        // API Keys is enabled at the top level
+        'xpack.security.enabled=true',
+      ],
+    },
+
+    kbnTestServer: {
+      ...xpackFunctionalTestsConfig.get('kbnTestServer'),
+      serverArgs: [
+        ...xpackFunctionalTestsConfig.get('kbnTestServer.serverArgs'),
+        '--csp.strict=false',
+        // define custom kibana server args here
+        `--elasticsearch.ssl.certificateAuthorities=${CA_CERT_PATH}`,
+        `--elasticsearch.ignoreVersionMismatch=true`,
+        `--uiSettings.overrides.theme:darkMode=true`,
+        `--elasticsearch.username=kibana_system`,
+        `--elasticsearch.password=changeme`,
+      ],
+    },
+  };
+}
+
+// eslint-disable-next-line import/no-default-export
+export default config;

x-pack/plugins/uptime/e2e/docker-compose.yml

@@ -0,0 +1,48 @@
+# Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+# or more contributor license agreements. Licensed under the Elastic License
+# 2.0; you may not use this file except in compliance with the Elastic License
+# 2.0.
+
+  version: '3.7'
+services:
+  elasticsearch:
+    image: docker.elastic.co/elasticsearch/elasticsearch:${STACK_VERSION}
+    container_name: uptime-e2e-es
+    healthcheck:
+      test:
+        ['CMD-SHELL', 'curl -s http://localhost:9220/_cluster/health | grep -vq ''"status":"red"''']
+      retries: 10
+      interval: 20s
+    environment:
+      - node.name=elasticsearch
+      - cluster.name=es-docker-cluster
+      - cluster.initial_master_nodes=elasticsearch
+      - bootstrap.memory_lock=true
+      - 'ES_JAVA_OPTS=-Xms512m -Xmx512m'
+      - ELASTICSEARCH_PORT=9220
+      - xpack.security.enabled=true
+      - ELASTIC_PASSWORD=changeme
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+    ports:
+      - '9220:9200'
+      - '9320:9300'
+    expose:
+      - '9220'
+    networks:
+      - elastic
+  heartbeat:
+    image: docker.elastic.co/beats/heartbeat:${STACK_VERSION}
+    container_name: uptime-e2e-heartbeat
+    depends_on:
+      - elasticsearch
+    volumes:
+      - ./heartbeat.docker.yml:/usr/share/heartbeat/heartbeat.yml:ro
+    networks:
+      - elastic
+
+networks:
+  elastic:
+    driver: bridge

x-pack/plugins/uptime/e2e/ftr_provider_context.d.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { GenericFtrProviderContext } from '@kbn/test/types/ftr';
+
+import { services } from './services';
+
+export type FtrProviderContext = GenericFtrProviderContext<typeof services, {}>;