feat: Running locally (#20)

* feat: Running locally

It can be useful to run a build outside of CI.
So, this action can also be installed locally
to kick off a CodeBuild project from your git sandbox.

* fix test

* fixes

Remove unneded rev-parse.
I can just use the branch name
since I make one just for this…
Also, comments and re-work the remote search.
Since remote is user input this should be a little safer.

* Update README.md

Co-Authored-By: Matt Bullock <[email protected]>

* Update README.md

Co-Authored-By: Matt Bullock <[email protected]>

* better words for readme

* display errors

* Update README.md

Co-Authored-By: Matt Bullock <[email protected]>

Co-authored-by: Matt Bullock <[email protected]>

Author: seebees

README.md

@@ -164,6 +164,28 @@ this will overwrite them.
     event-name: ${{ github.event_name }}
 ```
 
+### Running Locally
+
+It can be useful to run a build outside of CI.
+So, this action can also be installed locally
+to kick off a CodeBuild project from your git sandbox.
+You could push your changes to an open PR,
+but if you only want to test one project this may be faster.
+In order to use this tool,
+you must first `git checkout` the commit that you want to test.
+
+```
+npx @aws-actions/codebuild-run-build -p ProjectName -r remoteName
+```
+
+This will use whatever commit you have checked out
+and push to a temporary branch in the specified remote.
+Then kick off the build
+and delete the remote branch when complete.
+
+You can also install the project globally or locally
+and execute it that way.
+
 ## Implementation Notes
 
 ### What we did

code-build.js

@@ -7,25 +7,26 @@ const aws = require("aws-sdk");
 const assert = require("assert");
 
 module.exports = {
-  buildProject,
-  _buildProject,
+  runBuild,
+  build,
   waitForBuildEndTime,
   inputs2Parameters,
+  githubInputs,
   buildSdk,
   logName
 };
 
-function buildProject() {
+function runBuild() {
   // get a codeBuild instance from the SDK
   const sdk = buildSdk();
 
   // Get input options for startBuild
-  const params = inputs2Parameters();
+  const params = inputs2Parameters(githubInputs());
 
-  return _buildProject(sdk, params);
+  return build(sdk, params);
 }
 
-async function _buildProject(sdk, params) {
+async function build(sdk, params) {
   // Start the build
   const start = await sdk.codeBuild.startBuild(params).promise();
 
@@ -67,28 +68,49 @@ async function waitForBuildEndTime(sdk, { id, logs }, nextToken) {
   return waitForBuildEndTime(sdk, current, nextForwardToken);
 }
 
-function inputs2Parameters() {
+function githubInputs() {
   const projectName = core.getInput("project-name", { required: true });
-
+  const { owner, repo } = github.context.repo;
   // 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`];
-  const sourceTypeOverride = "GITHUB";
-  const { owner, repo } = github.context.repo;
-  const sourceLocationOverride = `https://github.com/${owner}/${repo}.git`;
-
   const buildspecOverride =
     core.getInput("buildspec-override", { required: false }) || undefined;
 
-  const envVars = core
+  const envPassthrough = core
     .getInput("env-passthrough", { required: false })
     .split(",")
+    .map(i => i.trim())
+    .filter(i => i !== "");
 
-    .map(i => i.trim());
+  return {
+    projectName,
+    owner,
+    repo,
+    sourceVersion,
+    buildspecOverride,
+    envPassthrough
+  };
+}
+
+function inputs2Parameters(inputs) {
+  const {
+    projectName,
+    owner,
+    repo,
+    sourceVersion,
+    buildspecOverride,
+    envPassthrough = []
+  } = inputs;
+
+  const sourceTypeOverride = "GITHUB";
+  const sourceLocationOverride = `https://github.com/${owner}/${repo}.git`;
 
   const environmentVariablesOverride = Object.entries(process.env)
-    .filter(([key]) => key.startsWith("GITHUB_") || envVars.includes(key))
+    .filter(
+      ([key]) => key.startsWith("GITHUB_") || envPassthrough.includes(key)
+    )
     .map(([name, value]) => ({ name, value, type: "PLAINTEXT" }));
 
   // The idempotencyToken is intentionally not set.

index.js

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 const core = require("@actions/core");
-const { buildProject } = require("./code-build");
+const { runBuild } = require("./code-build");
 const assert = require("assert");
 
 /* istanbul ignore next */
@@ -14,7 +14,7 @@ module.exports = run;
 
 async function run() {
   try {
-    const build = await buildProject();
+    const build = await runBuild();
     core.setOutput("aws-build-id", build.id);
 
     // Signal the outcome

local.js

@@ -0,0 +1,87 @@
+#!/usr/bin/env node
+// Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+const uuid = require("uuid/v4");
+const cp = require("child_process");
+const cb = require("./code-build");
+const assert = require("assert");
+const yargs = require("yargs");
+
+const { projectName, buildspecOverride, envPassthrough, remote } = yargs
+  .option("project-name", {
+    alias: "p",
+    describe: "AWS CodeBuild Project Name",
+    demandOption: true,
+    type: "string"
+  })
+  .option("buildspec-override", {
+    alias: "b",
+    describe: "Path to buildspec file",
+    type: "string"
+  })
+  .option("env-passthrough", {
+    alias: "e",
+    describe: "List of environment variables to send to CodeBuild",
+    type: "array"
+  })
+  .option("remote", {
+    alias: "r",
+    describe: "remote name to publish to",
+    default: "origin",
+    type: "string"
+  }).argv;
+
+const BRANCH_NAME = uuid();
+
+const params = cb.inputs2Parameters({
+  projectName,
+  ...githubInfo(remote),
+  sourceVersion: BRANCH_NAME,
+  buildspecOverride,
+  envPassthrough
+});
+
+const sdk = cb.buildSdk();
+
+pushBranch(remote, BRANCH_NAME);
+
+cb.build(sdk, params)
+  .then(() => deleteBranch(remote, BRANCH_NAME))
+  .catch(err => {
+    deleteBranch(remote, BRANCH_NAME);
+    throw err;
+  });
+
+function pushBranch(remote, branchName) {
+  cp.execSync(`git push ${remote} HEAD:${branchName}`);
+}
+
+function deleteBranch(remote, branchName) {
+  cp.execSync(`git push ${remote} :${branchName}`);
+}
+
+function githubInfo(remote) {
+  const gitHubSSH = "[email protected]:";
+  /* Expecting to match something like:
+   * 'fork    [email protected]:seebees/aws-codebuild-run-build.git (push)'
+   * Which is the output of `git remote -v`
+   */
+  const remoteMatch = /^fork.*\(push\)$/;
+  /* Not doing a grep because then I have to pass user input to the shell.
+   * This way I don't have to worry about sanitizing and injection and all that jazz.
+   * Further, when I _do_ pass the remote into the shell to push to it,
+   * given that I find it in the remote list,
+   * I feel confident that there are no shinanaigans.
+   */
+  const [gitRemote] = cp
+    .execSync("git remote -v")
+    .toString()
+    .split("\n")
+    .filter(line => line.trim().match(remoteMatch));
+  assert(gitRemote, `No remote found named ${remote}`);
+  const [, url] = gitRemote.split(/[\t ]/);
+  assert(url.startsWith(gitHubSSH), `Unsupported format: ${url}`);
+  const [owner, repo] = url.slice(gitHubSSH.length, -4).split("/");
+  return { owner, repo };
+}