serverless/tests/fixtures/index.js

Serverless Framework - Build web, mobile and IoT applications with serverless architectures using AWS Lambda, Azure Functions, Google CloudFunctions & more

'use strict';

const path = require('path');
const ensureString = require('type/string/ensure');
const ensurePlainObject = require('type/plain-object/ensure');
const fse = require('fs-extra');
const { memoize, merge } = require('lodash');
const { load: loadYaml, dump: saveYaml } = require('js-yaml');
const provisionTmpDir = require('@serverless/test/provision-tmp-dir');

const isFixtureConfigured = memoize(fixturePath => {
  let stats;
  try {
    stats = fse.statSync(fixturePath);
  } catch (error) {
    if (error.code === 'ENOENT') return false;
    throw error;
  }
  return Boolean(stats.isDirectory());
});

const retrievedFixturesPaths = new Set();

module.exports = {
  map: new Proxy(
    {},
    {
      get: (obj, fixtureName) => {
        const fixturePath = path.join(__dirname, fixtureName);
        if (!isFixtureConfigured(fixturePath)) {
          throw new Error(`No fixture configured at ${fixtureName}`);
        }
        retrievedFixturesPaths.add(fixturePath);
        return fixturePath;
      },
    }
  ),
  extend: (fixtureName, extConfig) => {
    const baseFixturePath = path.join(__dirname, ensureString(fixtureName));
    if (!isFixtureConfigured(baseFixturePath)) {
      throw new Error(`No fixture configured at ${fixtureName}`);
    }
    ensurePlainObject(extConfig);
    return provisionTmpDir().then(fixturePath => {
      return Promise.all([
        fse.readFile(path.join(baseFixturePath, 'serverless.yml')),
        fse.copy(baseFixturePath, fixturePath),
      ])
        .then(([yamlConfig]) =>
          fse.writeFile(
            path.join(fixturePath, 'serverless.yml'),
            saveYaml(merge(loadYaml(yamlConfig), extConfig))
          )
        )
        .then(() => fixturePath);
    });
  },
  cleanup: (options = {}) =>
    Promise.all(
      Array.from(retrievedFixturesPaths, fixturePath => {
        const pathsToRemove = [path.join(fixturePath, '.serverless')];
        if (options.extraPaths) {
          pathsToRemove.push(...options.extraPaths.map(target => path.join(fixturePath, target)));
        }
        return Promise.all(pathsToRemove.map(pathToRemove => fse.remove(pathToRemove))).then(() =>
          retrievedFixturesPaths.delete(fixturePath)
        );
      })
    ),
};