__tests__/main.test.ts

import * as cp from 'child_process';
import * as path from 'path';
import * as fs from 'fs';
import * as os from 'os';

const fakeEvent = (event: Record<string, unknown>, scope: (filename: string) => void): void => {
  const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'checks-actions-'));
  const filename = path.join(directory, 'github_event.json');
  fs.writeFileSync(filename, JSON.stringify(event));
  try {
    scope(filename);
  } finally {
    fs.unlinkSync(filename);
    fs.rmdirSync(directory);
  }
};

type ExecSyncError = Error & {stdout: Buffer};

// shows how the runner will run a javascript action with env / stdout protocol
test('test runs (creation)', () => {
  const entry = path.join(__dirname, '..', 'lib', 'main.js');
  const options: cp.ExecSyncOptions = {
    env: {
      GITHUB_REPOSITORY: 'LB/ABC',
      GITHUB_SHA: 'SHA',
      INPUT_TOKEN: 'ABC',
      INPUT_NAME: 'ABC',
      INPUT_STATUS: 'completed',
      INPUT_CONCLUSION: 'success',
    },
  };
  try {
    console.log(cp.execSync(`node ${entry}`, options).toString());
  } catch (e) {
    const error = e as ExecSyncError;
    const output = error.stdout.toString();
    console.log(output);
    expect(output).toMatch(/::debug::Creating a new Run on LB\/ABC@SHA/);
    expect(output).toMatch(/::debug::HttpError: Bad credentials/);
  }
});

test('test runs (update)', () => {
  const entry = path.join(__dirname, '..', 'lib', 'main.js');
  const options: cp.ExecSyncOptions = {
    env: {
      GITHUB_REPOSITORY: 'LB/ABC',
      GITHUB_SHA: 'SHA',
      INPUT_TOKEN: 'ABC',
      INPUT_CHECK_ID: '123',
      INPUT_STATUS: 'completed',
      INPUT_CONCLUSION: 'success',
    },
  };
  try {
    console.log(cp.execSync(`node ${entry}`, options).toString());
  } catch (e) {
    const error = e as ExecSyncError;
    const output = error.stdout.toString();
    console.log(output);
    expect(output).toMatch(/::debug::Updating a Run on LB\/ABC@SHA \(123\)/);
    expect(output).toMatch(/::debug::HttpError: Bad credentials/);
  }
});

test('test runs (creation on remote repository)', () => {
  const entry = path.join(__dirname, '..', 'lib', 'main.js');
  const options: cp.ExecSyncOptions = {
    env: {
      GITHUB_REPOSITORY: 'LB/ABC',
      GITHUB_SHA: 'SHA',
      INPUT_TOKEN: 'ABC',
      INPUT_NAME: 'ABC',
      INPUT_STATUS: 'completed',
      INPUT_CONCLUSION: 'success',
      INPUT_REPO: 'remote/repo',
      INPUT_SHA: 'DEF',
    },
  };
  try {
    console.log(cp.execSync(`node ${entry}`, options).toString());
  } catch (e) {
    const error = e as ExecSyncError;
    const output = error.stdout.toString();
    console.log(output);
    expect(output).toMatch(/::debug::Creating a new Run on remote\/repo@DEF/);
    expect(output).toMatch(/::debug::HttpError: Bad credentials/);
  }
});

test('test runs (update on remote repository)', () => {
  const entry = path.join(__dirname, '..', 'lib', 'main.js');
  const options: cp.ExecSyncOptions = {
    env: {
      GITHUB_REPOSITORY: 'LB/ABC',
      GITHUB_SHA: 'SHA',
      INPUT_TOKEN: 'ABC',
      INPUT_CHECK_ID: '123',
      INPUT_STATUS: 'completed',
      INPUT_CONCLUSION: 'success',
      INPUT_REPO: 'remote/repo',
      INPUT_SHA: 'DEF',
    },
  };
  try {
    console.log(cp.execSync(`node ${entry}`, options).toString());
  } catch (e) {
    const error = e as ExecSyncError;
    const output = error.stdout.toString();
    console.log(output);
    expect(output).toMatch(/::debug::Updating a Run on remote\/repo@DEF \(123\)/);
    expect(output).toMatch(/::debug::HttpError: Bad credentials/);
  }
});

test('test rejects invalid repo', () => {
  const entry = path.join(__dirname, '..', 'lib', 'main.js');
  const options: cp.ExecSyncOptions = {
    env: {
      GITHUB_REPOSITORY: 'LB/ABC',
      GITHUB_SHA: 'SHA',
      INPUT_TOKEN: 'ABC',
      INPUT_CHECK_ID: '123',
      INPUT_STATUS: 'completed',
      INPUT_CONCLUSION: 'success',
      INPUT_REPO: 'invalid',
      INPUT_SHA: 'DEF',
    },
  };
  try {
    console.log(cp.execSync(`node ${entry}`, options).toString());
  } catch (e) {
    const error = e as ExecSyncError;
    const output = error.stdout.toString();
    console.log(output);
    expect(output).toMatch(/::debug::Error: repo needs to be in the {owner}\/{repository} format/);
  }
});

test('test runs (creation + pull_request)', () => {
  const event = {
    pull_request: {
      head: {
        sha: '123',
      },
    },
  };
  fakeEvent(event, (filename: string): void => {
    const entry = path.join(__dirname, '..', 'lib', 'main.js');
    const options: cp.ExecSyncOptions = {
      env: {
        GITHUB_REPOSITORY: 'LB/ABC',
        GITHUB_SHA: 'SHA',
        GITHUB_EVENT_NAME: 'pull_request',
        GITHUB_EVENT_PATH: filename,
        INPUT_TOKEN: 'ABC',
        INPUT_NAME: 'ABC',
        INPUT_STATUS: 'completed',
        INPUT_CONCLUSION: 'success',
      },
    };
    try {
      console.log(cp.execSync(`node ${entry}`, options).toString());
    } catch (e) {
      const error = e as ExecSyncError;
      const output = error.stdout.toString();
      console.log(output);
      expect(output).toMatch(/::debug::Creating a new Run on LB\/ABC@123/);
      expect(output).toMatch(/::debug::HttpError: Bad credentials/);
    }
  });
});

// TODO: add more