fix: Pull requests sha evaluation (#40)

The SHA for pull requests are more complicated.
The GITHUB_SHA is not always the actual commit to test.

Resolves: #35

Author: seebees

code-build.js

@@ -111,10 +111,19 @@ async function waitForBuildEndTime(sdk, { id, logs }, nextToken) {
 function githubInputs() {
   const projectName = core.getInput("project-name", { required: true });
   const { owner, repo } = github.context.repo;
+  const { payload } = github.context;
   // The github.context.sha is evaluated on import.
   // This makes it hard to test.
-  // So I use the raw ENV
-  const sourceVersion = process.env[`GITHUB_SHA`];
+  // So I use the raw ENV.
+  // There is a complexity here because for pull request
+  // the GITHUB_SHA value is NOT the correct value.
+  // See: https://github.com/aws-actions/aws-codebuild-run-build/issues/36
+  const sourceVersion =
+    process.env[`GITHUB_EVENT_NAME`] === "pull_request"
+      ? (((payload || {}).pull_request || {}).head || {}).sha
+      : process.env[`GITHUB_SHA`];
+
+  assert(sourceVersion, "No source version could be evaluated.");
   const buildspecOverride =
     core.getInput("buildspec-override", { required: false }) || undefined;
 

test/code-build-test.js

@@ -33,20 +33,29 @@ describe("logName", () => {
 
 describe("githubInputs", () => {
   const OLD_ENV = { ...process.env };
+  const { context: OLD_CONTEXT } = require("@actions/github");
+  const { payload: OLD_PAYLOAD, eventName: OLD_EVENT_NAME } = OLD_CONTEXT;
   afterEach(() => {
     process.env = { ...OLD_ENV };
+    const { context } = require("@actions/github");
+    context.eventName = OLD_EVENT_NAME;
+    context.payload = OLD_PAYLOAD;
   });
 
   const projectName = "project_name";
   const repoInfo = "owner/repo";
   const sha = "1234abcd-12ab-34cd-56ef-1234567890ab";
+  const pullRequestSha = "181600acb3cfb803f4570d0018928be5d730c00d";
 
   it("build basic parameters for codeBuild.startBuild", () => {
     // This is how GITHUB injects its input values.
     // It would be nice if there was an easy way to test this...
     process.env[`INPUT_PROJECT-NAME`] = projectName;
     process.env[`GITHUB_REPOSITORY`] = repoInfo;
     process.env[`GITHUB_SHA`] = sha;
+    // These tests run in pull requests
+    // so to tests things that are NOT pull request...
+    process.env[`GITHUB_EVENT_NAME`] = "not_pull_request";
     const test = githubInputs();
     expect(test).to.haveOwnProperty("projectName").and.to.equal(projectName);
     expect(test).to.haveOwnProperty("sourceVersion").and.to.equal(sha);
@@ -84,6 +93,44 @@ describe("githubInputs", () => {
       .to.haveOwnProperty("envPassthrough")
       .and.to.deep.equal(["one", "two", "three", "four"]);
   });
+
+  it("can handle pull requests", () => {
+    // This is how GITHUB injects its input values.
+    // It would be nice if there was an easy way to test this...
+    process.env[`INPUT_PROJECT-NAME`] = projectName;
+    process.env[`GITHUB_REPOSITORY`] = repoInfo;
+    process.env[`GITHUB_SHA`] = sha;
+    process.env[`GITHUB_EVENT_NAME`] = "pull_request";
+    const { context } = require("@actions/github");
+    context.payload = { pull_request: { head: { sha: pullRequestSha } } };
+    const test = githubInputs();
+    expect(test).to.haveOwnProperty("projectName").and.to.equal(projectName);
+    expect(test)
+      .to.haveOwnProperty("sourceVersion")
+      .and.to.equal(pullRequestSha);
+    expect(test).to.haveOwnProperty("owner").and.to.equal(`owner`);
+    expect(test).to.haveOwnProperty("repo").and.to.equal(`repo`);
+    expect(test)
+      .to.haveOwnProperty("buildspecOverride")
+      .and.to.equal(undefined);
+    expect(test).to.haveOwnProperty("envPassthrough").and.to.deep.equal([]);
+  });
+
+  it("will not continue if there is no payload", () => {
+    // This is how GITHUB injects its input values.
+    // It would be nice if there was an easy way to test this...
+    process.env[`INPUT_PROJECT-NAME`] = projectName;
+    process.env[`GITHUB_REPOSITORY`] = repoInfo;
+    process.env[`GITHUB_SHA`] = sha;
+    process.env[`GITHUB_EVENT_NAME`] = "pull_request";
+    // These tests run in pull requests
+    // so to tests things that are NOT pull request...
+    require("@actions/github").context.payload = {};
+
+    expect(() => githubInputs()).to.throw(
+      "No source version could be evaluated."
+    );
+  });
 });
 
 describe("inputs2Parameters", () => {