Merge pull request #14 from marvinpinto/bundle-errors

Harden the tests to prevent future bundle-related regressions

Author: marvinpinto

.github/workflows/pre-release.yml

@@ -34,8 +34,8 @@ jobs:
 
       - run: "yarn install --frozen-lockfile"
       - run: "yarn lint"
-      - run: "yarn test"
       - run: "yarn build"
+      - run: "yarn jest --colors --forceExit"
 
       - uses: "./packages/automatic-releases/"
         with:

.github/workflows/tagged-release.yml

@@ -32,8 +32,8 @@ jobs:
 
       - run: "yarn install --frozen-lockfile"
       - run: "yarn lint"
-      - run: "yarn test"
       - run: "yarn build"
+      - run: "yarn jest --colors --forceExit"
 
       - uses: "marvinpinto/action-automatic-releases@latest"
         with:

.github/workflows/tests.yml

@@ -36,8 +36,8 @@ jobs:
 
       - run: "yarn install --frozen-lockfile"
       - run: "yarn lint"
-      - run: "yarn test"
       - run: "yarn build"
+      - run: "yarn jest --colors --forceExit"
 
       - uses: "./packages/keybase-notifications"
         if: always()

babel.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  presets: [
+    [
+      '@babel/preset-env',
+      {
+        targets: {
+          node: 'current',
+        },
+      },
+    ],
+    '@babel/preset-typescript',
+  ],
+  plugins: ['@babel/proposal-class-properties', '@babel/plugin-proposal-optional-chaining'],
+};

jest.config.js

@@ -1,20 +1,43 @@
 module.exports = {
-  roots: ['<rootDir>/src', '<rootDir>/__tests__'],
   clearMocks: true,
-  moduleFileExtensions: ['js', 'ts'],
+  moduleFileExtensions: ['js', 'ts', 'tsx'],
   testEnvironment: 'node',
-  testMatch: ['**/*.test.ts'],
   testRunner: 'jest-circus/runner',
   transform: {
-    '^.+\\.ts$': 'ts-jest',
+    '^.+\\.ts$': 'babel-jest',
+    '^.+\\.tsx$': 'babel-jest',
   },
   collectCoverage: true,
-  projects: ['<rootDir>/packages/*/jest.config.js'],
+  projects: [
+    {
+      name: 'keybase-notifications',
+      displayName: 'keybase-notifications',
+      testRegex: 'packages/keybase-notifications/__tests__',
+      testPathIgnorePatterns: ['/__tests__/payloads', '/__tests__/utils'],
+      setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
+    },
+    {
+      name: 'automatic-releases',
+      displayName: 'automatic-releases',
+      testRegex: 'packages/automatic-releases/__tests__',
+      testPathIgnorePatterns: ['/__tests__/payloads', '/__tests__/utils/', '/__tests__/assets'],
+      setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
+    },
+  ],
   coverageReporters: ['text'],
   coverageThreshold: {
     global: {
       lines: 100,
     },
   },
-  setupFilesAfterEnv: ['<rootDir>/../../jest.setup.js'],
+  collectCoverageFrom: [
+    '**/packages/keybase-notifications/**/*.ts',
+    '**/packages/automatic-releases/**/*.ts',
+    '!**/__tests__/**',
+    '!**/dist/**',
+    '!**/packages/keybase-notifications/src/index.ts',
+    '!**/packages/keybase-notifications/src/utils.ts',
+    '!**/packages/automatic-releases/src/index.ts',
+    '!**/packages/automatic-releases/src/uploadReleaseArtifacts.ts',
+  ],
 };

package.json

@@ -16,7 +16,7 @@
     "prettierPaths": "*.{json,md,yaml,yml} .github/**/*.{json,md,yaml,yml} !package.json !lerna.json"
   },
   "scripts": {
-    "test": "lerna run test --stream --no-bail",
+    "test": "yarn jest --colors",
     "build": "lerna run build --stream",
     "clean": "lerna run clean --stream && rm -rf node_modules yarn-error.log",
     "reinstall": "yarn clean; yarn install",
@@ -30,14 +30,19 @@
     "release": "lerna version"
   },
   "devDependencies": {
+    "@babel/core": "^7.7.7",
+    "@babel/plugin-proposal-class-properties": "^7.7.4",
+    "@babel/plugin-proposal-optional-chaining": "^7.7.5",
+    "@babel/preset-env": "^7.7.7",
+    "@babel/preset-typescript": "^7.7.7",
     "@commitlint/cli": "^8.2.0",
     "@commitlint/config-conventional": "^8.2.0",
     "@commitlint/config-lerna-scopes": "^8.2.0",
     "@types/jest": "^24.0.24",
     "@types/node": "^13.1.0",
     "@typescript-eslint/eslint-plugin": "^2.13.0",
     "@typescript-eslint/parser": "^2.13.0",
-    "@zeit/ncc": "^0.20.5",
+    "babel-jest": "^24.9.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.8.0",
     "eslint-plugin-jest": "^23.1.1",
@@ -46,7 +51,6 @@
     "jest-circus": "^24.9.0",
     "lerna": "^3.19.0",
     "prettier": "^1.19.1",
-    "ts-jest": "^24.2.0",
     "typescript": "^3.7.4"
   },
   "eslintIgnore": [

packages/automatic-releases/__tests__/automaticReleases-smoke.test.ts

@@ -0,0 +1,72 @@
+import skipSmokeTestsLocally from './utils/skipSmoke';
+import util from 'util';
+import child_process from 'child_process';
+import path from 'path';
+import fs from 'fs';
+import os from 'os';
+import portfinder from 'portfinder';
+import * as mockNewReleaseTag from './utils/mockNewReleaseTag';
+import * as mockUpdateExistingTag from './utils/mockUpdateExistingTag';
+import which from 'which';
+
+const exec = util.promisify(child_process.exec)
+
+describe('automatic releases smoke tests', () => {
+  skipSmokeTestsLocally();
+  const distBundle = path.join(__dirname, '../dist', 'index.js');
+
+  const sanitizeEnvironment = async () => {
+    const bundlePath = path.join(__dirname, '../dist');
+    const tdir = fs.mkdtempSync(path.join(os.tmpdir(), 'ghactions-'));
+    await exec(`cp ${bundlePath}/* ${tdir}/`);
+    return path.join(tdir, 'index.js');
+  };
+
+  it('should create a new release tag', async (cb) => {
+    const httpPort = await portfinder.getPortPromise();
+    const mockHttp = mockNewReleaseTag.server.listen(httpPort);
+    const bundle = await sanitizeEnvironment();
+
+    const node = which.sync('node')
+    const {stdout, stderr} = await exec(`${node} ${bundle}`, {
+      cwd: os.tmpdir(),
+      env: {
+        ...mockNewReleaseTag.setupEnv,
+        JEST_MOCK_HTTP_PORT: JSON.stringify(httpPort),
+        AUTOMATIC_RELEASES_TAG: '',
+      },
+    });
+
+    // Should set the AUTOMATIC_RELEASES_TAG env variable to "testingtaglatest"
+    expect(stdout).toEqual(expect.stringMatching(/::set-env name=AUTOMATIC_RELEASES_TAG,::testingtaglatest/));
+
+    // There should not be any stderr output
+    expect(stderr).toEqual('');
+
+    mockHttp.close(cb);
+  });
+
+  it('should update an existing release tag', async (cb) => {
+    const httpPort = await portfinder.getPortPromise();
+    const mockHttp = mockUpdateExistingTag.server.listen(httpPort);
+    const bundle = await sanitizeEnvironment();
+
+    const node = which.sync('node')
+    const {stdout, stderr} = await exec(`${node} ${bundle}`, {
+      cwd: os.tmpdir(),
+      env: {
+        ...mockUpdateExistingTag.setupEnv,
+        JEST_MOCK_HTTP_PORT: JSON.stringify(httpPort),
+        AUTOMATIC_RELEASES_TAG: '',
+      },
+    });
+
+    // Should set the AUTOMATIC_RELEASES_TAG env variable to "testingtaglatest"
+    expect(stdout).toEqual(expect.stringMatching(/::set-env name=AUTOMATIC_RELEASES_TAG,::testingtaglatest/));
+
+    // There should not be any stderr output
+    expect(stderr).toEqual('');
+
+    mockHttp.close(cb);
+  });
+});

packages/automatic-releases/__tests__/automaticReleases.test.ts

@@ -1,9 +1,11 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-
 import * as process from 'process';
 import * as path from 'path';
 import nock from 'nock';
 import fs from 'fs';
+import {uploadReleaseArtifacts} from '../src/uploadReleaseArtifacts';
+import {main} from '../src/main';
+
+jest.mock('../src/uploadReleaseArtifacts');
 
 describe('main handler processing automatic releases', () => {
   const testGhToken = 'fake-secret-token';
@@ -33,6 +35,8 @@ describe('main handler processing automatic releases', () => {
     process.env['GITHUB_ACTOR'] = 'marvinpinto';
     process.env['GITHUB_EVENT_PATH'] = path.join(__dirname, 'payloads', 'git-push.json');
     process.env['GITHUB_REPOSITORY'] = 'marvinpinto/private-actions-tester';
+
+    uploadReleaseArtifacts.mockImplementation().mockResolvedValue({});
   });
 
   afterEach(() => {
@@ -44,8 +48,7 @@ describe('main handler processing automatic releases', () => {
 
   it('throws an error when "automatic_release_tag" is not supplied', async () => {
     delete process.env.INPUT_AUTOMATIC_RELEASE_TAG;
-    const inst = require('../src/main');
-    await expect(inst.main()).rejects.toThrow(
+    await expect(main()).rejects.toThrow(
       'The parameter "automatic_release_tag" was not set and this does not appear to be a GitHub tag event. (Event: refs/heads/automatic-pre-releaser)',
     );
   });
@@ -62,6 +65,11 @@ describe('main handler processing automatic releases', () => {
       .get(`/repos/marvinpinto/private-actions-tester/compare/HEAD...${testGhSHA}`)
       .reply(200, compareCommitsPayload);
 
+    const getRef = nock('https://api.github.com')
+      .matchHeader('authorization', `token ${testGhToken}`)
+      .get(`/repos/marvinpinto/private-actions-tester/git/refs/tags/${testInputAutomaticReleaseTag}`)
+      .reply(404);
+
     const listAssociatedPRs = nock('https://api.github.com')
       .matchHeader('authorization', `token ${testGhToken}`)
       .get(`/repos/marvinpinto/private-actions-tester/commits/${testGhSHA}/pulls`)
@@ -101,21 +109,20 @@ describe('main handler processing automatic releases', () => {
     // Output env variable should be empty
     expect(process.env['AUTOMATIC_RELEASES_TAG']).toBeUndefined();
 
-    const inst = require('../src/main');
-    inst.uploadReleaseArtifacts = jest.fn(() => Promise.resolve());
-    await inst.main();
+    await main();
 
     expect(createRef.isDone()).toBe(true);
     expect(getReleaseByTag.isDone()).toBe(true);
     expect(deleteRelease.isDone()).toBe(false);
     expect(createRelease.isDone()).toBe(true);
+    expect(getRef.isDone()).toBe(true);
     expect(getCommitsSinceRelease.isDone()).toBe(true);
     expect(listAssociatedPRs.isDone()).toBe(true);
 
-    expect(inst.uploadReleaseArtifacts).toHaveBeenCalledTimes(1);
-    expect(inst.uploadReleaseArtifacts.mock.calls[0][1]).toBe(releaseUploadUrl);
+    expect(uploadReleaseArtifacts).toHaveBeenCalledTimes(1);
+    expect(uploadReleaseArtifacts.mock.calls[0][1]).toBe(releaseUploadUrl);
     // Should not attempt to upload any release artifacts, as there are none
-    expect(inst.uploadReleaseArtifacts.mock.calls[0][2]).toEqual([]);
+    expect(uploadReleaseArtifacts.mock.calls[0][2]).toEqual([]);
 
     // Should populate the output env variable
     expect(process.env['AUTOMATIC_RELEASES_TAG']).toBe(testInputAutomaticReleaseTag);
@@ -193,9 +200,7 @@ describe('main handler processing automatic releases', () => {
     // Output env variable should be empty
     expect(process.env['AUTOMATIC_RELEASES_TAG']).toBeUndefined();
 
-    const inst = require('../src/main');
-    inst.uploadReleaseArtifacts = jest.fn(() => Promise.resolve());
-    await inst.main();
+    await main();
 
     expect(createRef.isDone()).toBe(true);
     expect(updateRef.isDone()).toBe(true);
@@ -206,9 +211,9 @@ describe('main handler processing automatic releases', () => {
     expect(getCommitsSinceRelease.isDone()).toBe(true);
     expect(listAssociatedPRs.isDone()).toBe(true);
 
-    expect(inst.uploadReleaseArtifacts).toHaveBeenCalledTimes(1);
-    expect(inst.uploadReleaseArtifacts.mock.calls[0][1]).toBe(releaseUploadUrl);
-    expect(inst.uploadReleaseArtifacts.mock.calls[0][2]).toEqual(['file1.txt', 'file2.txt', '*.jar']);
+    expect(uploadReleaseArtifacts).toHaveBeenCalledTimes(1);
+    expect(uploadReleaseArtifacts.mock.calls[0][1]).toBe(releaseUploadUrl);
+    expect(uploadReleaseArtifacts.mock.calls[0][2]).toEqual(['file1.txt', 'file2.txt', '*.jar']);
 
     // Should populate the output env variable
     expect(process.env['AUTOMATIC_RELEASES_TAG']).toBe(testInputAutomaticReleaseTag);

packages/automatic-releases/__tests__/taggedReleases-smoke.test.ts

@@ -0,0 +1,47 @@
+import skipSmokeTestsLocally from './utils/skipSmoke';
+import util from 'util';
+import child_process from 'child_process';
+import path from 'path';
+import fs from 'fs';
+import os from 'os';
+import portfinder from 'portfinder';
+import * as mockNewTaggedRelease from './utils/mockNewTaggedRelease';
+import which from 'which';
+
+const exec = util.promisify(child_process.exec)
+
+describe('tagged releases smoke tests', () => {
+  skipSmokeTestsLocally();
+  const distBundle = path.join(__dirname, '../dist', 'index.js');
+
+  const sanitizeEnvironment = async () => {
+    const bundlePath = path.join(__dirname, '../dist');
+    const tdir = fs.mkdtempSync(path.join(os.tmpdir(), 'ghactions-'));
+    await exec(`cp ${bundlePath}/* ${tdir}/`);
+    return path.join(tdir, 'index.js');
+  };
+
+  it('should create a new release', async (cb) => {
+    const httpPort = await portfinder.getPortPromise();
+    const mockHttp = mockNewTaggedRelease.server.listen(httpPort);
+    const bundle = await sanitizeEnvironment();
+
+    const node = which.sync('node')
+    const {stdout, stderr} = await exec(`${node} ${bundle}`, {
+      cwd: os.tmpdir(),
+      env: {
+        ...mockNewTaggedRelease.setupEnv,
+        JEST_MOCK_HTTP_PORT: JSON.stringify(httpPort),
+        AUTOMATIC_RELEASES_TAG: '',
+      },
+    });
+
+    // Should set the AUTOMATIC_RELEASES_TAG env variable to "v0.0.1"
+    expect(stdout).toEqual(expect.stringMatching(/::set-env name=AUTOMATIC_RELEASES_TAG,::v0.0.1/));
+
+    // There should not be any stderr output
+    expect(stderr).toEqual('');
+
+    mockHttp.close(cb);
+  });
+});