tasks.js

/*
 * 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 { relative, resolve } from 'path';
import Rx from 'rxjs/Rx';
import { withProcRunner } from '@kbn/dev-utils';

import {
  runElasticsearch,
  runKibanaServer,
  runFtr,
  KIBANA_FTR_SCRIPT,
} from './lib';

import { readConfigFile } from '../../../../src/functional_test_runner/lib';

const SUCCESS_MESSAGE = `

Elasticsearch and Kibana are ready for functional testing. Start the functional tests
in another terminal session by running this command from this directory:

    node ${relative(process.cwd(), KIBANA_FTR_SCRIPT)}

`;

/**
 * Run servers and tests for each config
 * @param {string[]} configPaths         Array of paths to configs
 * @param {object}   options             Optional
 * @param {Log}      options.log         Optional logger
 * @param {string}   options.installDir  Optional installation dir
 *                                       from which to run Kibana
 * @param {boolean}  options.bail  Whether to exit test run at the first failure
 */
export async function runTests(configPaths, options) {
  for (const configPath of configPaths) {
    await runSingleConfig(resolve(process.cwd(), configPath), options);
  }
}

/**
 * Start only servers using single config
 * @param {string}  configPath          Path to a config file
 * @param {object}  options             Optional
 * @param {Log}     options.log         Optional logger
 * @param {string}  options.installDir  Optional installation dir
 *                                      from which to run Kibana
 */
export async function startServers(configPath, options) {
  const { log } = options;
  configPath = resolve(process.cwd(), configPath);

  await withProcRunner(log, async procs => {
    const config = await readConfigFile(log, configPath);

    const es = await runElasticsearch({ config, log });
    await runKibanaServer({
      procs,
      config,
      options: { ...options, devMode: true },
    });

    // wait for 5 seconds of silence before logging the
    // success message so that it doesn't get buried
    await silence(5000, { log });
    log.info(SUCCESS_MESSAGE);

    await procs.waitForAllToStop();
    await es.cleanup();
  });
}

async function silence(milliseconds, { log }) {
  await Rx.Observable.fromEvent(log, 'data')
    .startWith(null)
    .switchMap(() => Rx.Observable.timer(milliseconds))
    .take(1)
    .toPromise();
}

/*
 * Start servers and run tests for single config
 */
async function runSingleConfig(configPath, options) {
  const { bail, log } = options;

  await withProcRunner(log, async procs => {
    const config = await readConfigFile(log, configPath);

    const es = await runElasticsearch({ config, log });
    await runKibanaServer({ procs, config, options });

    // Note: When solving how to incorporate functional_test_runner
    // clean this up
    await runFtr({
      procs,
      configPath,
      bail,
      log,
      cwd: process.cwd(),
    });

    await procs.stop('kibana');
    await es.cleanup();
  });
}