setup-php/__tests__/install.test.ts

import * as install from '../src/install';
import * as matchers from '../src/matchers';
import * as path from 'path';

/**
 * Mock install.ts
 */
jest.mock('../src/install', () => ({
  build: jest.fn().mockImplementation(
    async (
      filename: string,
      version: string,
      os_version: string
    ): Promise<string> => {
      const extension_csv: string = process.env['extension-csv'] || '';
      const ini_values_csv: string = process.env['ini-values-csv'] || '';
      const coverage_driver: string = process.env['coverage'] || '';

      let script = 'initial script ' + filename + version + os_version;
      if (extension_csv) {
        script += 'install extensions';
      }
      if (ini_values_csv) {
        script += 'edit php.ini';
      }
      if (coverage_driver) {
        script += 'set coverage driver';
      }

      return script;
    }
  ),
  run: jest.fn().mockImplementation(
    async (): Promise<string> => {
      const os_version: string = process.env['RUNNER_OS'] || '';
      const version: string = process.env['php-version'] || '';
      let script = '';
      switch (os_version) {
        case 'darwin':
          script = await install.build(os_version + '.sh', version, os_version);
          script += 'sh script.sh ' + version + ' ' + __dirname;
          break;
        case 'linux': {
          const pecl: string = process.env['pecl'] || '';
          script = await install.build(os_version + '.sh', version, os_version);
          script += 'sh script.sh ' + version + ' ' + pecl + ' ' + __dirname;
          break;
        }
        case 'win32':
          script = await install.build(os_version + '.sh', version, os_version);
          script +=
            'pwsh script.ps1 -version ' + version + ' -dir ' + __dirname;
          break;
        default:
          script += os_version + ' is not supported';
      }

      return script;
    }
  )
}));

/**
 * Function to set the process.env
 *
 * @param version
 * @param os
 * @param extension_csv
 * @param ini_values_csv
 * @param coverage_driver
 */
function setEnv(
  version: string,
  os: string,
  extension_csv: string,
  ini_values_csv: string,
  coverage_driver: string,
  pecl: string
): void {
  process.env['php-version'] = version;
  process.env['RUNNER_OS'] = os;
  process.env['extension-csv'] = extension_csv;
  process.env['ini-values-csv'] = ini_values_csv;
  process.env['coverage'] = coverage_driver;
  process.env['pecl'] = pecl;
}

describe('Install', () => {
  it('Test install on windows', async () => {
    setEnv('7.3', 'win32', '', '', '', '');
    // @ts-ignore
    let script: string = await install.run();
    expect(script).toContain('initial script');
    expect(script).toContain('pwsh script.ps1 -version 7.3 -dir ' + __dirname);

    setEnv('7.3', 'win32', 'a, b', 'a=b', 'x', '');
    // @ts-ignore
    script = await install.run();
    expect(script).toContain('initial script');
    expect(script).toContain('install extensions');
    expect(script).toContain('edit php.ini');
    expect(script).toContain('set coverage driver');
    expect(script).toContain('pwsh script.ps1 -version 7.3 -dir ' + __dirname);
  });

  it('Test install on linux', async () => {
    setEnv('7.3', 'linux', '', '', '', '');
    // @ts-ignore
    let script: string = await install.run();
    expect(script).toContain('initial script');
    expect(script).toContain('sh script.sh 7.3 ');

    setEnv('7.3', 'linux', 'a, b', 'a=b', 'x', 'true');
    // @ts-ignore
    script = await install.run();
    expect(script).toContain('initial script');
    expect(script).toContain('install extensions');
    expect(script).toContain('edit php.ini');
    expect(script).toContain('set coverage driver');
    expect(script).toContain('sh script.sh 7.3 true');

    setEnv('7.3', 'linux', 'a, b', 'a=b', 'x', 'true');
    // @ts-ignore
    script = await install.run();
    expect(script).toContain('initial script');
    expect(script).toContain('install extensions');
    expect(script).toContain('edit php.ini');
    expect(script).toContain('set coverage driver');
    expect(script).toContain('sh script.sh 7.3 true');
  });

  it('Test install on darwin', async () => {
    setEnv('7.3', 'darwin', '', '', '', '');
    // @ts-ignore
    let script: string = await install.run();
    expect(script).toContain('initial script');
    expect(script).toContain('sh script.sh 7.3 ' + __dirname);

    setEnv('7.3', 'darwin', 'a, b', 'a=b', 'x', '');
    // @ts-ignore
    script = await install.run();
    expect(script).toContain('initial script');
    expect(script).toContain('install extensions');
    expect(script).toContain('edit php.ini');
    expect(script).toContain('set coverage driver');
    expect(script).toContain('sh script.sh 7.3 ' + __dirname);
  });

  describe('Matchers', () => {
    let originalLogMethod: any;
    let outputData: any[] = [];

    beforeAll(() => {
      originalLogMethod = console.log;
      console['log'] = jest.fn(inputs => outputData.push(inputs));
    });

    beforeEach(() => {
      outputData = [];
    });

    afterAll(() => {
      console['log'] = originalLogMethod;
    });

    it('Add matchers', async () => {
      matchers.addMatchers();

      expect(outputData).toEqual([
        `##[add-matcher]${path.join(
          __dirname,
          '..',
          '.github/matchers/phpunit.json'
        )}`
      ]);
    });
  });
});