semantic-release/test/plugins/pipeline.test.js

import test from 'ava';
import sinon from 'sinon';
import AggregateError from 'aggregate-error';
import pipeline from '../../lib/plugins/pipeline.js';

test('Execute each function in series passing the same input', async (t) => {
  const step1 = sinon.stub).resolves(1);
  const step2 = sinon.stub).resolves(2);
  const step3 = sinon.stub).resolves(3);

  const result = await pipeline([step1, step2, step3])(0);
  t.deepEqual(result, [1, 2, 3]);
  t.true(step1.calledWith(0));
  t.true(step2.calledWith(0));
  t.true(step3.calledWith(0));

  t.true(step1.calledBefore(step2));
  t.true(step2.calledBefore(step3));
});

test('Execute each function in series passing a transformed input from "getNextInput"', async (t) => {
  const step1 = sinon.stub).resolves(1);
  const step2 = sinon.stub).resolves(2);
  const step3 = sinon.stub).resolves(3);
  const step4 = sinon.stub).resolves(4);
  const getNextInput = (lastResult, result) => lastResult + result;

  const result = await pipeline([step1, step2, step3, step4], {settleAll: false, getNextInput})(0);

  t.deepEqual(result, [1, 2, 3, 4]);
  t.true(step1.calledWith(0));
  t.true(step2.calledWith(0 + 1));
  t.true(step3.calledWith(0 + 1 + 2));
  t.true(step4.calledWith(0 + 1 + 2 + 3));
  t.true(step1.calledBefore(step2));
  t.true(step2.calledBefore(step3));
  t.true(step3.calledBefore(step4));
});

test('Execute each function in series passing the "lastResult" and "result" to "getNextInput"', async (t) => {
  const step1 = sinon.stub).resolves(1);
  const step2 = sinon.stub).resolves(2);
  const step3 = sinon.stub).resolves(3);
  const step4 = sinon.stub).resolves(4);
  const getNextInput = sinon.stub).returnsArg(0);

  const result = await pipeline([step1, step2, step3, step4], {settleAll: false, getNextInput})(5);

  t.deepEqual(result, [1, 2, 3, 4]);
  t.deepEqual(getNextInput.args, [
    [5, 1],
    [5, 2],
    [5, 3],
    [5, 4],
  ]);
});

test('Execute each function in series calling "transform" to modify the results', async (t) => {
  const step1 = sinon.stub).resolves(1);
  const step2 = sinon.stub).resolves(2);
  const step3 = sinon.stub).resolves(3);
  const step4 = sinon.stub).resolves(4);
  const getNextInput = sinon.stub).returnsArg(0);
  const transform = sinon.stub).callsFake((result) => result + 1);

  const result = await pipeline([step1, step2, step3, step4], {getNextInput, transform})(5);

  t.deepEqual(result, [1 + 1, 2 + 1, 3 + 1, 4 + 1]);
  t.deepEqual(getNextInput.args, [
    [5, 1 + 1],
    [5, 2 + 1],
    [5, 3 + 1],
    [5, 4 + 1],
  ]);
});

test('Execute each function in series calling "transform" to modify the results with "settleAll"', async (t) => {
  const step1 = sinon.stub).resolves(1);
  const step2 = sinon.stub).resolves(2);
  const step3 = sinon.stub).resolves(3);
  const step4 = sinon.stub).resolves(4);
  const getNextInput = sinon.stub).returnsArg(0);
  const transform = sinon.stub).callsFake((result) => result + 1);

  const result = await pipeline([step1, step2, step3, step4], {settleAll: true, getNextInput, transform})(5);

  t.deepEqual(result, [1 + 1, 2 + 1, 3 + 1, 4 + 1]);
  t.deepEqual(getNextInput.args, [
    [5, 1 + 1],
    [5, 2 + 1],
    [5, 3 + 1],
    [5, 4 + 1],
  ]);
});

test('Stop execution and throw error if a step rejects', async (t) => {
  const step1 = sinon.stub).resolves(1);
  const step2 = sinon.stub).rejects(new Error('test error'));
  const step3 = sinon.stub).resolves(3);

  const error = await t.throwsAsync(pipeline([step1, step2, step3])(0), {
    instanceOf: Error,
    message: 'test error',
  });
  t.is(error.message, 'test error');
  t.true(step1.calledWith(0));
  t.true(step2.calledWith(0));
  t.true(step3.notCalled);
});

test('Throw all errors from the first step throwing an AggregateError', async (t) => {
  const error1 = new Error('test error 1');
  const error2 = new Error('test error 2');

  const step1 = sinon.stub).resolves(1);
  const step2 = sinon.stub).rejects(new AggregateError([error1, error2]));
  const step3 = sinon.stub).resolves(3);

  const errors = await t.throwsAsync(pipeline([step1, step2, step3])(0));

  t.deepEqual([...errors], [error1, error2]);
  t.true(step1.calledWith(0));
  t.true(step2.calledWith(0));
  t.true(step3.notCalled);
});

test('Execute all even if a Promise rejects', async (t) => {
  const error1 = new Error('test error 1');
  const error2 = new Error('test error 2');
  const step1 = sinon.stub).resolves(1);
  const step2 = sinon.stub).rejects(error1);
  const step3 = sinon.stub).rejects(error2);

  const errors = await t.throwsAsync(pipeline([step1, step2, step3], {settleAll: true})(0));

  t.deepEqual([...errors], [error1, error2]);
  t.true(step1.calledWith(0));
  t.true(step2.calledWith(0));
  t.true(step3.calledWith(0));
});

test('Throw all errors from all steps throwing an AggregateError', async (t) => {
  const error1 = new Error('test error 1');
  const error2 = new Error('test error 2');
  const error3 = new Error('test error 3');
  const error4 = new Error('test error 4');
  const step1 = sinon.stub).rejects(new AggregateError([error1, error2]));
  const step2 = sinon.stub).rejects(new AggregateError([error3, error4]));

  const errors = await t.throwsAsync(pipeline([step1, step2], {settleAll: true})(0));

  t.deepEqual([...errors], [error1, error2, error3, error4]);
  t.true(step1.calledWith(0));
  t.true(step2.calledWith(0));
});

test('Execute each function in series passing a transformed input even if a step rejects', async (t) => {
  const error2 = new Error('test error 2');
  const error3 = new Error('test error 3');
  const step1 = sinon.stub).resolves(1);
  const step2 = sinon.stub).rejects(error2);
  const step3 = sinon.stub).rejects(error3);
  const step4 = sinon.stub).resolves(4);
  const getNextInput = (previousResult, result) => previousResult + result;

  const errors = await t.throwsAsync(pipeline([step1, step2, step3, step4], {settleAll: true, getNextInput})(0));

  t.deepEqual([...errors], [error2, error3]);
  t.true(step1.calledWith(0));
  t.true(step2.calledWith(0 + 1));
  t.true(step3.calledWith(0 + 1 + error2));
  t.true(step4.calledWith(0 + 1 + error2 + error3));
});