npm-audit-pipeline/test/executorResponseHandler.test.ts

Using npm audit in deployment pipelines

/* eslint-disable fp/no-nil */
/* eslint-disable fp/no-unused-expression */
import * as E from 'fp-ts/Either';
import { NpmResponseError } from '../src/errors';
import { handleExecResponse } from '../src/executorResponseHandler';
import { handleExecYarnResponse } from '../src/executorResponseHandler';

describe('executorResponseHandler', () => {
  describe(handleExecResponse.name, () => {
    test('if stderr value is set then an NpmResponseError is returned', () =>
      expect(
        handleExecResponse({
          stderr: 'npm audit error',
          stdout: '',
        }),
      ).toStrictEqual(
        E.left(
          new NpmResponseError(
            'npm audit returned an error',
            'npm audit error',
          ),
        ),
      ));

    test('if npm response is not in correct format, validation error is returned', () =>
      expect(
        handleExecResponse({
          stderr: '',
          stdout: JSON.stringify({
            otherValue: 'otherValue',
          }),
        }),
      ).toStrictEqual(
        E.left(
          new Error(
            'Invalid value undefined supplied to : {| metadata: {| vulnerabilities: {| info: number, low: number, moderate: number, high: number, critical: number |} |} |}/metadata: {| vulnerabilities: {| info: number, low: number, moderate: number, high: number, critical: number |} |}',
          ),
        ),
      ));

    test('a NpmAuditResponse is returned upon valid npm response', () =>
      expect(
        handleExecResponse({
          stderr: '',
          stdout: JSON.stringify({
            metadata: {
              vulnerabilities: {
                info: 0,
                low: 10,
                moderate: 2,
                high: 1,
                critical: 6,
              },
            },
          }),
        }),
      ).toStrictEqual(
        E.right({
          info: 0,
          low: 10,
          moderate: 2,
          high: 1,
          critical: 6,
        }),
      ));
  });

  describe(handleExecYarnResponse.name, () => {
    test('if stderr value is set and stdout is not then an NpmResponseError is returned', () =>
      expect(
        handleExecYarnResponse({
          stderr: 'yarn audit error',
          stdout: '',
        }),
      ).toStrictEqual(
        E.left(
          new NpmResponseError(
            'npm audit returned an error',
            'npm audit error',
          ),
        ),
      ));

    test('if yarn response is not in correct format, validation error is returned', () =>
      expect(
        handleExecYarnResponse({
          stderr: 'some value',
          stdout: JSON.stringify({
            otherValue: 'otherValue',
          }),
        }),
      ).toStrictEqual(
        E.left(
          new Error(
            'Invalid value undefined supplied to : {| data: {| vulnerabilities: {| info: number, low: number, moderate: number, high: number, critical: number |} |} |}/data: {| vulnerabilities: {| info: number, low: number, moderate: number, high: number, critical: number |} |}',
          ),
        ),
      ));

    test('a NpmAuditResponse is returned upon valid npm response', () =>
      expect(
        handleExecYarnResponse({
          stderr: 'some value',
          stdout: JSON.stringify({
            data: {
              vulnerabilities: {
                info: 0,
                low: 10,
                moderate: 2,
                high: 1,
                critical: 6,
              },
            },
          }),
        }),
      ).toStrictEqual(
        E.right({
          info: 0,
          low: 10,
          moderate: 2,
          high: 1,
          critical: 6,
        }),
      ));
  });
});