index.test.ts

/*
 * Copyright (c) Trainline Limited, 2020. All rights reserved.
 * See LICENSE.md in the project root for license information.
 */
import RestrictPlugin from './index';
import baseCompilationStats from '../../../test/fixtures/base-compilation-stats.json';
import headCompilationStats from '../../../test/fixtures/head-compilation-stats.json';
import { RestrictConfig } from './config';
import { defaultBasePluginConfig } from '../../config/PluginConfig';
import { Stats4 } from '../../types';
import normalizeStats from '../../helpers/normalizeStats';

const normalizedBaseStats = normalizeStats((baseCompilationStats as unknown) as Stats4);
const normalizedHeadStats = normalizeStats((headCompilationStats as unknown) as Stats4);
const restrictConfig: RestrictConfig = {
  showExisting: false,
  chunkFilename: defaultBasePluginConfig.chunkFilename,
  restrictions: [
    {
      search: './src/private/common/components/section-error-fallback/index.jsx',
      responseType: 'warn',
      message: 'no section error fallback component',
    },
    { search: 'lodash.omitby', responseType: 'error', message: 'no lodash.omitby' },
  ],
};

describe('RestrictPlugin', () => {
  let restrictPlugin: RestrictPlugin;

  describe('only new restrictions', () => {
    beforeEach(() => {
      restrictPlugin = new RestrictPlugin({
        baseCompilationStats: normalizedBaseStats,
        headCompilationStats: normalizedHeadStats,
        config: {
          ...restrictConfig,
          showExisting: false,
        },
      });
    });

    it('returns summary', () => {
      expect(restrictPlugin.summaryOutput()).toBe('1 restricted file found');
    });

    it('returns errorMessages', () => {
      expect(restrictPlugin.errorMessages()).toEqual([]);
    });

    it('returns warningMessages', () => {
      expect(restrictPlugin.warningMessages()).toEqual([
        './src/private/common/components/section-error-fallback/index.jsx is restricted',
      ]);
    });

    it('returns danger output', () => {
      expect(restrictPlugin.dangerOutput()).toMatchSnapshot();
    });

    it('returns cli output', () => {
      expect(restrictPlugin.cliOutput()).toMatchSnapshot();
    });
  });

  describe('existing restrictions', () => {
    beforeEach(() => {
      restrictPlugin = new RestrictPlugin({
        baseCompilationStats: normalizedBaseStats,
        headCompilationStats: normalizedHeadStats,
        config: {
          ...restrictConfig,
          showExisting: true,
        },
      });
    });

    it('returns summary', () => {
      expect(restrictPlugin.summaryOutput()).toBe('2 restricted files found');
    });

    it('returns errorMessages', () => {
      expect(restrictPlugin.errorMessages()).toEqual([
        './node_modules/lodash.omitby/index.js is restricted',
      ]);
    });

    it('returns warningMessages', () => {
      expect(restrictPlugin.warningMessages()).toEqual([
        './src/private/common/components/section-error-fallback/index.jsx is restricted',
      ]);
    });

    it('returns danger output', () => {
      expect(restrictPlugin.dangerOutput()).toMatchSnapshot();
    });

    it('returns cli output', () => {
      expect(restrictPlugin.cliOutput()).toMatchSnapshot();
    });
  });
});