src/reporters/build_kite_cli.ts

/**
 * MIT License
 *
 * Copyright (c) 2020-present, Elastic NV
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

import { red, green, cyan } from 'kleur/colors';
import { ReporterOptions } from '.';

import BaseReporter, { renderDuration } from './base';
import { indent, now, symbols } from '../helpers';
import {
  JourneyEndResult,
  JourneyStartResult,
  StepEndResult,
} from '../common_types';
import { Journey, Step } from '../dsl';
import { renderError, serializeError } from './reporter-util';

export default class BuildKiteCLIReporter extends BaseReporter {
  journeys: Map<string, Array<Step>> = new Map();

  constructor(options: ReporterOptions = {}) {
    super(options);
  }

  override onJourneyStart(journey: Journey, {}: JourneyStartResult) {
    this.write(`\n--- Journey: ${journey.name}`);
  }

  override onStepEnd(journey: Journey, step: Step, result: StepEndResult) {
    super.onStepEnd(journey, step, result);
    if (!this.journeys.has(journey.name)) {
      this.journeys.set(journey.name, []);
    }
    this.journeys.get(journey.name)?.push(step);
  }

  override async onJourneyEnd(journey: Journey, result: JourneyEndResult) {
    super.onJourneyEnd(journey, result);
    const message = `${symbols[journey.status]} Took (${renderDuration(
      journey.duration
    )} seconds)`;
    this.write(message);
  }

  override onEnd() {
    const { failed, succeeded, skipped } = this.metrics;
    const total = failed + succeeded + skipped;

    if (total > 0) {
      const failedJourneys = Array.from(this.journeys.entries()).filter(
        ([, steps]) => steps.some(step => step.status === 'failed')
      );

      // if more than 5 journeys, we also report failed journeys at the end
      if (failedJourneys.length > 0 && this.journeys.size > 5) {
        failedJourneys.forEach(([journeyName, steps]) => {
          const name = red(`Journey: ${journeyName} :slightly_frowning_face:`);
          this.write(`\n+++ ${name}`);
          steps.forEach(step => {
            const message = `${symbols[step.status]}  Step: '${step.name}' ${
              step.status
            } (${renderDuration(step.duration * 1000)} ms)`;
            this.write(indent(message));
            if (step.error) {
              this.write(renderError(serializeError(step.error)));
            }
          });
        });
      }
    }

    let message = '\n';
    if (total === 0) {
      message = 'No tests found!';
      message += ` (${renderDuration(now())} ms) \n`;
      this.write(message);
      return;
    }

    message += succeeded > 0 ? green(` ${succeeded} passed`) : '';
    message += failed > 0 ? red(` ${failed} failed`) : '';
    message += skipped > 0 ? cyan(` ${skipped} skipped`) : '';
    message += ` (${renderDuration(now() / 1000)} seconds) \n`;
    this.write(message);
  }
}