unity-builder/src/model/system.test.ts

import * as core from '@actions/core';
import * as exec from '@actions/exec';
import System from './system';

jest.spyOn(core, 'debug').mockImplementation(() => {});
const info = jest.spyOn(core, 'info').mockImplementation(() => {});
jest.spyOn(core, 'warning').mockImplementation(() => {});
jest.spyOn(core, 'error').mockImplementation(() => {});
const execSpy = jest.spyOn(exec, 'exec').mockImplementation(async () => 0);

describe('System', () => {
  describe('run', () => {
    describe('units', () => {
      afterEach(() => jest.clearAllMocks());

      it('passes the command to command line', async () => {
        await expect(System.run('echo test')).resolves.not.toBeNull();
        await expect(execSpy).toHaveBeenLastCalledWith('echo test', expect.anything(), expect.anything());
      });

      it('throws on when error code is not 0', async () => {
        execSpy.mockImplementationOnce(async () => 1);
        await expect(System.run('false')).rejects.toThrowError();
      });

      it('throws when no command is given', async () => {
        await expect(System.run('')).rejects.toThrowError();
      });

      it('throws when command consists only of spaces', async () => {
        await expect(System.run(' \t\n')).rejects.toThrowError();
      });

      it('outputs info', async () => {
        execSpy.mockImplementationOnce(async (input, _, options) => {
          options?.listeners?.stdout?.(Buffer.from(input, 'utf8'));
          return 0;
        });

        await expect(System.run('foo-bar')).resolves.not.toBeNull();
        expect(info).toHaveBeenCalledTimes(1);
        expect(info).toHaveBeenLastCalledWith('foo-bar');
      });
    });

    /**
     * Not all shells (e.g. Powershell, sh) have a reference to `echo` binary (absent or alias).
     * To ensure our integration with '@actions/exec' works as expected we run some specific tests in CI only
     */
    if (process.env.CI) {
      describe('integration', () => {
        execSpy.mockRestore();

        it('runs a command successfully', async () => {
          await expect(System.run('true')).resolves.not.toBeNull();
        });

        it('outputs results', async () => {
          await expect(System.run('echo test')).resolves.toStrictEqual('test\n');
        });

        it('throws on when error code is not 0', async () => {
          await expect(System.run('false')).rejects.toThrowError();
        });

        it('allows pipes using buffer', async () => {
          await expect(
            System.run('sh', undefined, {
              input: Buffer.from('git tag --list --merged HEAD | grep v[0-9]* | wc -l'),
              // eslint-disable-next-line github/no-then
            }).then((result) => Number(result)),
          ).resolves.not.toBeNaN();
        });
      });
    }
  });
});