[ftr] add support for docker servers (#68173) (#69593)

Co-authored-by: spalger <spalger@users.noreply.github.com>

Co-authored-by: spalger <spalger@users.noreply.github.com>

packages/kbn-dev-utils/src/index.ts

@@ -37,4 +37,5 @@ export { run, createFailError, createFlagError, combineErrors, isFailError, Flag
 export { REPO_ROOT } from './repo_root';
 export { KbnClient } from './kbn_client';
 export * from './axios';
+export * from './stdio';
 export * from './ci_stats_reporter';

packages/kbn-dev-utils/src/proc_runner/proc.ts

@@ -29,7 +29,7 @@ import { promisify } from 'util';
 const treeKillAsync = promisify((...args: [number, string, any]) => treeKill(...args));
 
 import { ToolingLog } from '../tooling_log';
-import { observeLines } from './observe_lines';
+import { observeLines } from '../stdio';
 import { createCliError } from './errors';
 
 const SECOND = 1000;

packages/kbn-dev-utils/src/stdio/index.ts

@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+export * from './observe_lines';
+export * from './observe_readable';

packages/kbn-test/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@kbn/test",
-  "main": "./target/index.js",
   "version": "1.0.0",
-  "license": "Apache-2.0",
   "private": true,
+  "license": "Apache-2.0",
+  "main": "./target/index.js",
   "scripts": {
     "build": "babel src --out-dir target --delete-dir-on-start --extensions .ts,.js,.tsx --ignore *.test.js,**/__tests__/** --source-maps=inline",
     "kbn:bootstrap": "yarn build",
@@ -13,6 +13,7 @@
     "@babel/cli": "^7.10.1",
     "@kbn/babel-preset": "1.0.0",
     "@kbn/dev-utils": "1.0.0",
+    "@types/joi": "^13.4.2",
     "@types/parse-link-header": "^1.0.0",
     "@types/puppeteer": "^3.0.0",
     "@types/strip-ansi": "^5.2.1",
@@ -23,12 +24,14 @@
     "chalk": "^2.4.2",
     "dedent": "^0.7.0",
     "del": "^5.1.0",
+    "exit-hook": "^2.2.0",
     "getopts": "^2.2.4",
     "glob": "^7.1.2",
+    "joi": "^13.5.2",
     "parse-link-header": "^1.0.1",
     "puppeteer": "^3.3.0",
-    "strip-ansi": "^5.2.0",
     "rxjs": "^6.5.5",
+    "strip-ansi": "^5.2.0",
     "tar-fs": "^1.16.3",
     "tmp": "^0.1.0",
     "xml2js": "^0.4.22",

packages/kbn-test/src/functional_test_runner/cli.ts

@@ -19,7 +19,10 @@
 
 import { resolve } from 'path';
 import { inspect } from 'util';
+
 import { run, createFlagError, Flags } from '@kbn/dev-utils';
+import exitHook from 'exit-hook';
+
 import { FunctionalTestRunner } from './functional_test_runner';
 
 const makeAbsolutePath = (v: string) => resolve(process.cwd(), v);
@@ -84,8 +87,7 @@ export function runFtrCli() {
           err instanceof Error ? err : new Error(`non-Error type rejection value: ${inspect(err)}`)
         )
       );
-      process.on('SIGTERM', () => teardown());
-      process.on('SIGINT', () => teardown());
+      exitHook(teardown);
 
       try {
         if (flags['test-stats']) {

packages/kbn-test/src/functional_test_runner/functional_test_runner.ts

@@ -29,6 +29,7 @@ import {
   readProviderSpec,
   setupMocha,
   runTests,
+  DockerServersService,
   Config,
   SuiteTracker,
 } from './lib';
@@ -130,12 +131,19 @@ export class FunctionalTestRunner {
         throw new Error('No tests defined.');
       }
 
+      const dockerServers = new DockerServersService(
+        config.get('dockerServers'),
+        this.log,
+        this.lifecycle
+      );
+
       // base level services that functional_test_runner exposes
       const coreProviders = readProviderSpec('Service', {
         lifecycle: () => this.lifecycle,
         log: () => this.log,
         failureMetadata: () => this.failureMetadata,
         config: () => config,
+        dockerServers: () => dockerServers,
       });
 
       return await handler(config, coreProviders);

packages/kbn-test/src/functional_test_runner/index.ts

@@ -20,3 +20,4 @@
 export { FunctionalTestRunner } from './functional_test_runner';
 export { readConfigFile } from './lib';
 export { runFtrCli } from './cli';
+export * from './lib/docker_servers';

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

@@ -57,6 +57,27 @@ const appUrlPartsSchema = () =>
     })
     .default();
 
+const requiredWhenEnabled = (schema: Joi.Schema) => {
+  return Joi.when('enabled', {
+    is: true,
+    then: schema.required(),
+    otherwise: schema.optional(),
+  });
+};
+
+const dockerServerSchema = () =>
+  Joi.object()
+    .keys({
+      enabled: Joi.boolean().required(),
+      image: requiredWhenEnabled(Joi.string()),
+      port: requiredWhenEnabled(Joi.number()),
+      portInContainer: requiredWhenEnabled(Joi.number()),
+      waitForLogLine: Joi.alternatives(Joi.object().type(RegExp), Joi.string()).optional(),
+      waitFor: Joi.func().optional(),
+      args: Joi.array().items(Joi.string()).optional(),
+    })
+    .default();
+
 const defaultRelativeToConfigPath = (path: string) => {
   const makeDefault: any = (_: any, options: any) => resolve(dirname(options.context.path), path);
   makeDefault.description = `<config.js directory>/${path}`;
@@ -259,5 +280,7 @@ export const schema = Joi.object()
         disableTestUser: Joi.boolean(),
       })
       .default(),
+
+    dockerServers: Joi.object().pattern(Joi.string(), dockerServerSchema()).default(),
   })
   .default();

packages/kbn-test/src/functional_test_runner/lib/docker_servers/README.md

@@ -0,0 +1,113 @@
+# Functional Test Runner - Docker Servers
+
+In order to make it simpler to run some services while the functional tests are running, we've added the ability to execute docker containers while the tests execute for the purpose of exposing services to the tests. These containers are expected to expose an application via a single HTTP port and live for the life of the tests. If the application exits for any reason before the tests complete the tests will abort.
+
+To configure docker servers in your FTR config add the `dockerServers` key to your config like so:
+
+```ts
+// import this helper to get TypeScript support for this section of the config
+import { defineDockerServersConfig } from '@kbn/test';
+
+export default function () {
+  return {
+    ...
+
+    dockerServers: defineDockerServersConfig({
+      // unique names are used in logging and to get the details of this server in the tests
+      helloWorld: {
+        /** disable this docker server unless the user sets some flag/env var */
+        enabled: !!process.env.HELLO_WORLD_PORT,
+        /** the docker image to pull and run */
+        image: 'vad1mo/hello-world-rest',
+        /** The port that this application will be accessible via locally */
+        port: process.env.HELLO_WORLD_PORT,
+        /** The port that the container binds to in the container */
+        portInContainer: 5050,
+        /**
+         * OPTIONAL: string/regex to look for in the log, when specified the
+         * tests won't start until a line containing this string, or matching
+         * this expression is found.
+         */
+        waitForLogLine: /hello/,
+        /**
+         * OPTIONAL: function that is called when server is started, when defined
+         * it is called to give the configuration an option to write custom delay
+         * logic. The function is passed a DockerServer object, which is described
+         * below, and an observable of the log lines produced by the application
+         */
+        async waitFor(server, logLine$) {
+          await logLine$.pipe(
+            filter(line => line.includes('...')),
+            tap((line) => {
+              console.log('marking server ready because this line was logged:', line);
+              console.log('server accessible from url', server.url);
+            })
+          ).toPromise()
+        }
+      }
+    })
+  }
+}
+```
+
+To consume the test server, use can use something like supertest to send request. Just make sure that you disable your test suite if the user doesn't choose to enable your docker server:
+
+```ts
+import makeSupertest from 'supertest-as-promised';
+import { FtrProviderContext } from '../ftr_provider_context';
+
+export default function ({ getService }: FtrProviderContext) {
+  const dockerServers = getService('dockerServers');
+  const log = getService('log');
+
+  const server = dockerServers.get('helloWorld');
+  const supertest = makeSupertest(server.url);
+
+  describe('test suite name', function () {
+    if (!server.enabled) {
+      log.warning(
+        'disabling tests because server is not enabled, set HELLO_WORLD_PORT to run them'
+      );
+      this.pending = true;
+    }
+
+    it('test name', async () => {
+      await supertest.get('/foo/bar').expect(200);
+    });
+  });
+}
+```
+
+## `DockerServersService`
+
+The docker servers service is a core service that is always available in functional test runner tests. When you call `getService('dockerServers')` you will receive an instance of the `DockerServersService` class which has to methods:
+
+### `has(name: string): boolean`
+
+Determine if a name resolves to a known docker server.
+
+### `isEnabled(name: string): boolean`
+
+Determine if a named server is enabled.
+
+### `get(name: string): DockerServer`
+
+Get a `DockerServer` object for the server with the given name.
+
+
+## `DockerServer`
+
+The object passed to the `waitFor()` config function and returned by `DockerServersService#get()`
+
+```ts
+{
+  url: string;
+  name: string;
+
+  portInContainer: number;
+  port: number;
+  image: string;
+  waitForLogLine?: RegExp | string;
+  waitFor?: (server: DockerServer, logLine$: Rx.Observable<string>) => Promise<boolean>;
+}
+```

packages/kbn-test/src/functional_test_runner/lib/docker_servers/container_logs.ts

@@ -0,0 +1,43 @@
+/*
+ * 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.
+ */
+
+import execa from 'execa';
+import * as Rx from 'rxjs';
+import { tap } from 'rxjs/operators';
+import { ToolingLog, observeLines } from '@kbn/dev-utils';
+
+/**
+ * Observe the logs for a container, reflecting the log lines
+ * to the ToolingLog and the returned Observable
+ */
+export function observeContainerLogs(name: string, containerId: string, log: ToolingLog) {
+  log.debug(`[docker:${name}] streaming logs from container [id=${containerId}]`);
+  const logsProc = execa('docker', ['logs', '--follow', containerId], {
+    stdio: ['ignore', 'pipe', 'pipe'],
+  });
+
+  const logLine$ = new Rx.Subject<string>();
+
+  Rx.merge(
+    observeLines(logsProc.stdout).pipe(tap((line) => log.info(`[docker:${name}] ${line}`))),
+    observeLines(logsProc.stderr).pipe(tap((line) => log.error(`[docker:${name}] ${line}`)))
+  ).subscribe(logLine$);
+
+  return logLine$.asObservable();
+}

packages/kbn-test/src/functional_test_runner/lib/docker_servers/container_running.ts

@@ -0,0 +1,65 @@
+/*
+ * 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.
+ */
+
+import execa from 'execa';
+import * as Rx from 'rxjs';
+import { ToolingLog } from '@kbn/dev-utils';
+
+/**
+ * Create an observable that errors if a docker
+ * container exits before being unsubscribed
+ */
+export function observeContainerRunning(name: string, containerId: string, log: ToolingLog) {
+  return new Rx.Observable((subscriber) => {
+    log.debug(`[docker:${name}] watching container for exit status [${containerId}]`);
+
+    const exitCodeProc = execa('docker', ['wait', containerId]);
+
+    let exitCode: Error | number | null = null;
+    exitCodeProc
+      .then(({ stdout }) => {
+        exitCode = Number.parseInt(stdout.trim(), 10);
+
+        if (Number.isFinite(exitCode)) {
+          subscriber.error(
+            new Error(`container [id=${containerId}] unexpectedly exitted with code ${exitCode}`)
+          );
+        } else {
+          subscriber.error(
+            new Error(`unable to parse exit code from output of "docker wait": ${stdout}`)
+          );
+        }
+      })
+      .catch((error) => {
+        if (error?.killed) {
+          // ignore errors thrown because the process was killed
+          subscriber.complete();
+          return;
+        }
+
+        subscriber.error(
+          new Error(`failed to monitor process with "docker wait": ${error.message}`)
+        );
+      });
+
+    return () => {
+      exitCodeProc.kill('SIGKILL');
+    };
+  });
+}