Merge pull request #2 from TheCleric/feature/enhance-debugging

Feature/enhance debugging
nrccua · Aug 24, 2020 · 9adbbed · 9adbbed
2 parents 1949133 + a428e02
commit 9adbbed
Show file tree

Hide file tree

Showing 11 changed files with 113 additions and 3,989 deletions.
diff --git a/.github/workflows/checkin.yml b/.github/workflows/checkin.yml
@@ -5,21 +5,21 @@ jobs:
   check_pr:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v1
 
-    - name: "npm ci"
-      run: npm ci
+      - name: "npm ci"
+        run: npm ci
 
-    - name: "npm run build"
-      run: npm run build
+      - name: "npm run build"
+        run: npm run build
 
-    - name: "npm run test"
-      run: npm run test
+      - name: "npm run test"
+        run: npm run test
 
-    - name: "check for uncommitted changes"
-      # Ensure no changes, but ignore node_modules dir since dev/fresh ci deps installed.
-      run: |
-        git diff --exit-code --stat -- . ':!node_modules' \
-        || (echo "##[error] found changed files after build. please 'npm run build && npm run format'" \
-                 "and check in all changes" \
-            && exit 1)
+      - name: "check for uncommitted changes"
+        # Ensure no changes, but ignore node_modules dir since dev/fresh ci deps installed.
+        run: |
+          git diff --exit-code --stat -- . ':!node_modules' \
+          || (echo "##[error] found changed files after build. please 'npm run build && npm run format'" \
+                   "and check in all changes" \
+              && exit 1)
diff --git a/__tests__/config.test.ts b/__tests__/config.test.ts
@@ -1,33 +1,40 @@
 import * as github from "@actions/github";
+import * as Context from '@actions/github/lib/context';
 import "jest-extended";
 import nock from "nock";
+import path from "path";
 import { getConfig } from '../src/config';
 import { configFixture, emptyConfigFixture } from './shared';
 
+
 nock.disableNetConnect();
 
 describe("Config file loader", () => {
+    let context;
+
     beforeEach(() => {
+        const repoToken = "token";
+        process.env["INPUT_REPO-TOKEN"] = repoToken;
+        process.env["GITHUB_REPOSITORY"] = "Codertocat/Hello-World";
+        process.env["GITHUB_EVENT_PATH"] = path.join(__dirname, "fixtures", "payload.json");
+
+        context = new Context.Context();
     });
 
     afterEach(() => {
         nock.cleanAll();
     });
 
     it("succeeds", async () => {
-
         // Arrange
         const getConfigScope = nock("https://api.github.com")
             .persist()
-            .get("/repos/TheCleric/Hello-World/contents/.github/pr-branch-labeler.yml")
+            .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=0123456")
             .reply(200, configFixture());
 
         const octokit = new github.GitHub("token");
 
-        const config = await getConfig(octokit, "pr-branch-labeler.yml", {
-            repo: "Hello-World",
-            owner: "TheCleric"
-        });
+        const config = await getConfig(octokit, "pr-branch-labeler.yml", context);
 
         // Assert
         expect(getConfigScope.isDone()).toBeTrue();
@@ -40,15 +47,12 @@ describe("Config file loader", () => {
         // Arrange
         const getConfigScope = nock("https://api.github.com")
             .persist()
-            .get("/repos/TheCleric/Hello-World/contents/.github/pr-branch-labeler.yml")
+            .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=0123456")
             .reply(200, configFixture("invalid-config.yml"));
 
         const octokit = new github.GitHub("token");
 
-        await expect(getConfig(octokit, "pr-branch-labeler.yml", {
-            repo: "Hello-World",
-            owner: "TheCleric"
-        })).rejects.toThrow(new Error("config.yml has invalid structure."));
+        await expect(getConfig(octokit, "pr-branch-labeler.yml", context)).rejects.toThrow(new Error("config.yml has invalid structure."));
 
         // Assert
         expect(getConfigScope.isDone()).toBeTrue();
@@ -60,15 +64,12 @@ describe("Config file loader", () => {
         // Arrange
         const getConfigScope = nock("https://api.github.com")
             .persist()
-            .get("/repos/TheCleric/Hello-World/contents/.github/test")
+            .get("/repos/Codertocat/Hello-World/contents/.github/test?ref=0123456")
             .reply(200, []);
 
         const octokit = new github.GitHub("token");
 
-        await expect(getConfig(octokit, "test", {
-            repo: "Hello-World",
-            owner: "TheCleric"
-        })).rejects.toThrow(new Error("test is not a file."));
+        await expect(getConfig(octokit, "test", context)).rejects.toThrow(new Error("test is not a file."));
 
         // Assert
         expect(getConfigScope.isDone()).toBeTrue();
@@ -80,15 +81,12 @@ describe("Config file loader", () => {
         // Arrange
         const getConfigScope = nock("https://api.github.com")
             .persist()
-            .get("/repos/TheCleric/Hello-World/contents/.github/pr-branch-labeler.yml")
+            .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=0123456")
             .reply(200, emptyConfigFixture());
 
         const octokit = new github.GitHub("token");
 
-        await expect(getConfig(octokit, "pr-branch-labeler.yml", {
-            repo: "Hello-World",
-            owner: "TheCleric"
-        })).rejects.toThrow(new Error("pr-branch-labeler.yml is empty."));
+        await expect(getConfig(octokit, "pr-branch-labeler.yml", context)).rejects.toThrow(new Error("pr-branch-labeler.yml is empty."));
 
         // Assert
         expect(getConfigScope.isDone()).toBeTrue();

diff --git a/__tests__/fixtures/payload.json b/__tests__/fixtures/payload.json
@@ -3,7 +3,8 @@
   "pull_request": {
     "number": 1,
     "head": {
-      "ref": "feature/awesome-stuff"
+      "ref": "feature/awesome-stuff",
+      "sha": "0123456"
     },
     "base": {
       "ref": "master"

diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -13,6 +13,7 @@ describe("PR Branch Labeler", () => {
     process.env["INPUT_REPO-TOKEN"] = repoToken;
     process.env["GITHUB_REPOSITORY"] = "Codertocat/Hello-World";
     process.env["GITHUB_EVENT_PATH"] = path.join(__dirname, "fixtures", "payload.json");
+
     main = require("../src/main");
   });
 
@@ -24,15 +25,15 @@ describe("PR Branch Labeler", () => {
     // Arrange
     const getConfigScope = nock("https://api.github.com")
       .persist()
-      .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+      .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
       .reply(200, configFixture());
 
     const postLabelsScope = nock("https://api.github.com")
       .persist()
       .post("/repos/Codertocat/Hello-World/issues/42/labels")
       .reply(200);
 
-    main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-awesome-stuff", "master");
+    main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-awesome-stuff", "master", main.context.payload.pull_request.head.sha);
 
     // Act
     await main.run();
@@ -48,7 +49,7 @@ describe("PR Branch Labeler", () => {
       // Arrange
       const getConfigScope = nock("https://api.github.com")
         .persist()
-        .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+        .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
         .reply(200, configFixture());
 
       const postLabelsScope = nock("https://api.github.com")
@@ -61,7 +62,7 @@ describe("PR Branch Labeler", () => {
         })
         .reply(200);
 
-      main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-awesome-stuff", "master");
+      main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-awesome-stuff", "master", main.context.payload.pull_request.head.sha);
 
       // Act
       await main.run();
@@ -78,7 +79,7 @@ describe("PR Branch Labeler", () => {
       // Arrange
       const getConfigScope = nock("https://api.github.com")
         .persist()
-        .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+        .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
         .reply(200, configFixture());
 
       const postLabelsScope = nock("https://api.github.com")
@@ -91,7 +92,7 @@ describe("PR Branch Labeler", () => {
         })
         .reply(200);
 
-      main.context.payload = createPullRequestOpenedFixture("support/FOO-42-assisting", "master");
+      main.context.payload = createPullRequestOpenedFixture("support/FOO-42-assisting", "master", main.context.payload.pull_request.head.sha);
 
       // Act
       await main.run();
@@ -108,7 +109,7 @@ describe("PR Branch Labeler", () => {
       // Arrange
       const getConfigScope = nock("https://api.github.com")
         .persist()
-        .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+        .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
         .reply(200, configFixture());
 
       const postLabelsScope = nock("https://api.github.com")
@@ -121,7 +122,7 @@ describe("PR Branch Labeler", () => {
         })
         .reply(200);
 
-      main.context.payload = createPullRequestOpenedFixture("bugfix/FOO-42-squash-bugs", "master");
+      main.context.payload = createPullRequestOpenedFixture("bugfix/FOO-42-squash-bugs", "master", main.context.payload.pull_request.head.sha);
 
       // Act
       await main.run();
@@ -136,7 +137,7 @@ describe("PR Branch Labeler", () => {
       // Arrange
       const getConfigScope = nock("https://api.github.com")
         .persist()
-        .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+        .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
         .reply(200, configFixture());
 
       const postLabelsScope = nock("https://api.github.com")
@@ -149,7 +150,7 @@ describe("PR Branch Labeler", () => {
         })
         .reply(200);
 
-      main.context.payload = createPullRequestOpenedFixture("hotfix/FOO-42-squash-bugs", "master");
+      main.context.payload = createPullRequestOpenedFixture("hotfix/FOO-42-squash-bugs", "master", main.context.payload.pull_request.head.sha);
 
       // Act
       await main.run();
@@ -164,7 +165,7 @@ describe("PR Branch Labeler", () => {
       // Arrange
       const getConfigScope = nock("https://api.github.com")
         .persist()
-        .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+        .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
         .reply(200, configFixture());
 
       const postLabelsScope = nock("https://api.github.com")
@@ -175,7 +176,7 @@ describe("PR Branch Labeler", () => {
         })
         .reply(200);
 
-      main.context.payload = createPullRequestOpenedFixture("bugfix/FOO-42-changes", "release/1.0.0");
+      main.context.payload = createPullRequestOpenedFixture("bugfix/FOO-42-changes", "release/1.0.0", main.context.payload.pull_request.head.sha);
 
       // Act
       await main.run();
@@ -190,7 +191,7 @@ describe("PR Branch Labeler", () => {
       // Arrange
       const getConfigScope = nock("https://api.github.com")
         .persist()
-        .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+        .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
         .reply(200, configFixture());
 
       const postLabelsScope = nock("https://api.github.com")
@@ -201,7 +202,7 @@ describe("PR Branch Labeler", () => {
         })
         .reply(200);
 
-      main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-part", "feature/FOO-42-whole");
+      main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-part", "feature/FOO-42-whole", main.context.payload.pull_request.head.sha);
 
       // Act
       await main.run();
@@ -217,7 +218,7 @@ describe("PR Branch Labeler", () => {
     // Arrange
     const getConfigScope = nock("https://api.github.com")
       .persist()
-      .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+      .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
       .reply(404);
 
     const postLabelsScope = nock("https://api.github.com")
@@ -230,7 +231,7 @@ describe("PR Branch Labeler", () => {
       })
       .reply(200);
 
-    main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-awesome-stuff", "master");
+    main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-awesome-stuff", "master", main.context.payload.pull_request.head.sha);
 
     // Act
     await main.run();
@@ -245,7 +246,7 @@ describe("PR Branch Labeler", () => {
     // Arrange
     const getConfigScope = nock("https://api.github.com")
       .persist()
-      .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+      .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
       .reply(200, configFixture());
 
     const postLabelsScope = nock("https://api.github.com")
@@ -255,7 +256,7 @@ describe("PR Branch Labeler", () => {
       })
       .reply(200);
 
-    main.context.payload = createPullRequestOpenedFixture("fix-the-build", "master");
+    main.context.payload = createPullRequestOpenedFixture("fix-the-build", "master", main.context.payload.pull_request.head.sha);
 
     // Act
     await main.run();
@@ -270,7 +271,7 @@ describe("PR Branch Labeler", () => {
     // Arrange
     const getConfigScope = nock("https://api.github.com")
       .persist()
-      .get("/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml")
+      .get(`/repos/Codertocat/Hello-World/contents/.github/pr-branch-labeler.yml?ref=${main.context.payload.pull_request.head.sha}`)
       .reply(200, configFixture("invalid-config.yml"));
 
     const postLabelsScope = nock("https://api.github.com")
@@ -280,7 +281,7 @@ describe("PR Branch Labeler", () => {
       })
       .reply(200);
 
-    main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-awesome-stuff", "master");
+    main.context.payload = createPullRequestOpenedFixture("feature/FOO-42-awesome-stuff", "master", main.context.payload.pull_request.head.sha);
 
     // Act
     await expect(main.run()).rejects.toThrow(new Error("config.yml has invalid structure."));
@@ -292,13 +293,14 @@ describe("PR Branch Labeler", () => {
   });
 });
 
-function createPullRequestOpenedFixture(headRef: string, baseRef: string) {
+function createPullRequestOpenedFixture(headRef: string, baseRef: string, sha: string) {
   return {
     action: "opened",
     pull_request: {
       number: 42,
       head: {
-        ref: headRef
+        ref: headRef,
+        sha
       },
       base: {
         ref: baseRef

diff --git a/__tests__/shared.ts b/__tests__/shared.ts
@@ -1,4 +1,10 @@
+import * as core from "@actions/core";
 import { readFileSync } from "fs";
+import "jest-extended";
+
+// Dump core debug/error to console debug so that --silent works
+jest.spyOn(core, 'debug').mockImplementation(console.debug);
+jest.spyOn(core, 'error').mockImplementation(console.debug);
 
 function encodeContent(content: Buffer | ArrayBuffer | SharedArrayBuffer) {
     return Buffer.from(content).toString("base64");

diff --git a/jest.config.js b/jest.config.js
@@ -7,5 +7,5 @@ module.exports = {
   transform: {
     "^.+\\.ts$": "ts-jest"
   },
-  verbose: true
+  verbose: true,
 };