serverless-offline-msk/examples/docker-compose-single-broker/node_modules/@serverless/dashboard-plugin/lib/test/index.js

A serverless offline plugin that enables AWS MSK events

'use strict';

const { entries, find } = require('lodash');
const fse = require('fs-extra');
const yaml = require('js-yaml');
const { progress, style, writeText } = require('@serverless/utils/log');

const runTest = require('./run-test');

module.exports.test = async (ctx) => {
  ctx.sls.logDeprecation('TEST_COMMAND', 'Command "test" will be removed with next major release.');

  if (!ctx.sls.enterpriseEnabled) {
    throw new ctx.sls.classes.Error('Run "serverless" to configure your service for testing.');
  }
  if (!fse.exists('serverless.test.yml')) {
    throw new ctx.sls.classes.Error('No serverless.test.yml file found');
  }
  let tests = yaml.load(await fse.readFile('serverless.test.yml'));

  const { options } = ctx.sls.processedInput;
  if (options.function) {
    tests = tests.filter(({ endpoint }) => endpoint.function === options.function);
  }
  if (options.test) {
    tests = tests.filter(({ name }) => name === options.test);
  }

  const cfnStack = await ctx.provider.request('CloudFormation', 'describeStacks', {
    StackName: ctx.provider.naming.getStackName(),
  });
  const apigResource = find(
    cfnStack.Stacks[0].Outputs,
    ({ OutputKey }) =>
      !OutputKey.endsWith('Websocket') &&
      OutputKey.match(ctx.provider.naming.getServiceEndpointRegex())
  );
  const baseApiUrl = apigResource.OutputValue;

  writeText('Test Results:', '', 'Summary --------------------------------------------------', '');

  const testProgress = progress.get('tests');

  const errors = [];
  let numTests = 0;

  const funcs = ctx.sls.service.functions || {};
  for (const testSpec of tests || []) {
    let method = testSpec.endpoint.method;
    if (!method) {
      if (typeof funcs[testSpec.endpoint.function].events[0].http === 'string') {
        method = funcs[testSpec.endpoint.function].events[0].http.split(' ')[0];
      } else {
        method = funcs[testSpec.endpoint.function].events[0].http.method;
      }
    }
    let path = testSpec.endpoint.path;
    if (!path) {
      if (typeof funcs[testSpec.endpoint.function].events[0].http === 'string') {
        path = funcs[testSpec.endpoint.function].events[0].http.split(' ')[1];
      } else {
        path = funcs[testSpec.endpoint.function].events[0].http.path;
      }
    }
    const testName = `${method.toUpperCase()} ${path} - ${testSpec.name}`;
    try {
      numTests += 1;
      testProgress.notice(`running - ${testName}`);
      await runTest(testSpec, path, method, baseApiUrl);
      writeText(`passed - ${testName}\n`);
    } catch (error) {
      errors.push({ testSpec, error });
      writeText(style.error(`${style.error('failed')} - ${testName}`));
    }
  }
  testProgress.remove();
  writeText();
  if (errors.length > 0) {
    writeText('Details --------------------------------------------------', '');

    for (let i = 0; i < errors.length; i++) {
      const { error, testSpec } = errors[i];
      const { headers, status } = error.resp;
      writeText(`   ${i + 1}) ${style.error(`Failed -  ${testSpec.name}`)}`);
      const info = `      status: ${status}
      headers:
    ${entries(headers._headers)
      .map(([key, value]) => `    ${key}: ${value}`)
      .join('\n')
      .replace(/\n/g, '\n    ')}
      body: ${error.body}`;
      writeText(info);

      const expectedAndReceived = `
      expected: ${error.field} = ${
        typeof error.expected === 'object'
          ? JSON.stringify(error.expected, null, 2).replace(/\n/g, '\n      ')
          : error.expected
      }
      received: ${error.field} = ${
        typeof error.received === 'object'
          ? JSON.stringify(error.received, null, 2).replace(/\n/g, '\n      ')
          : error.received
      }\n\n`;
      writeText(expectedAndReceived);
    }
  }

  writeText(`Test Summary: ${numTests - errors.length} passed, ${errors.length} failed`);

  if (errors.length) {
    throw new ctx.sls.classes.Error('Test run failed', 'TEST_FAILURE');
  }
};