add some tests

Author: taoyong-ty

README.md

@@ -75,7 +75,7 @@ The only required input is `project-name`.
    The default value is 15.
 
 1. **hide-cloudwatch-logs** (optional) :
-   Set to `true` if you do not want CloudWatch logs to be streamed to GitHub Action.
+   Set to `true` if you do not want CloudWatch Logs to be streamed to GitHub Action.
 
 ### Outputs
 

action.yml

@@ -34,7 +34,6 @@ inputs:
   hide-cloudwatch-logs:
     description: 'Set to `true` to prevent the CloudWatch logs from streaming the output to GitHub'
     required: false
-    default: false
 outputs:
   aws-build-id:
     description: 'The AWS CodeBuild Build ID for this build.'

aws-codebuild-run-build

@@ -0,0 +1 @@
+Subproject commit eb17d173dcaabf0456059585bbb8ad3f41924004

code-build.js

@@ -22,10 +22,10 @@ function runBuild() {
 
   const inputs = githubInputs();
 
-  const config = (({ updateInterval, updateBackOff, hideCloudwatchLogs }) => ({
+  const config = (({ updateInterval, updateBackOff, hideCloudWatchLogs }) => ({
     updateInterval,
     updateBackOff,
-    hideCloudwatchLogs,
+    hideCloudWatchLogs,
   }))(inputs);
 
   // Get input options for startBuild
@@ -45,7 +45,7 @@ async function build(sdk, params, config) {
 async function waitForBuildEndTime(
   sdk,
   { id, logs },
-  { updateInterval, updateBackOff, hideCloudwatchLogs },
+  { updateInterval, updateBackOff, hideCloudWatchLogs },
   seqEmptyLogs,
   totalEvents,
   throttleCount,
@@ -66,9 +66,9 @@ async function waitForBuildEndTime(
   // Check the state
   const [batch, cloudWatch = {}] = await Promise.all([
     codeBuild.batchGetBuilds({ ids: [id] }).promise(),
-    !hideCloudwatchLogs &&
+    !hideCloudWatchLogs &&
       logGroupName &&
-      cloudWatchLogs // only make the call if hideCloudwatchLogs is not enabled and a logGroupName exists
+      cloudWatchLogs // only make the call if hideCloudWatchLogs is not enabled and a logGroupName exists
         .getLogEvents({
           logGroupName,
           logStreamName,
@@ -155,7 +155,7 @@ async function waitForBuildEndTime(
   return waitForBuildEndTime(
     sdk,
     current,
-    { updateInterval, updateBackOff, hideCloudwatchLogs },
+    { updateInterval, updateBackOff, hideCloudWatchLogs },
     seqEmptyLogs,
     totalEvents,
     throttleCount,
@@ -210,8 +210,8 @@ function githubInputs() {
       10
     ) * 1000;
 
-  const hideCloudwatchLogs =
-    core.getInput("hide-cloudwatch-logs", { required: false }) || undefined;
+  const hideCloudWatchLogs =
+    core.getInput("hide-cloudwatch-logs", { required: false }) === "true";
 
   return {
     projectName,
@@ -226,7 +226,7 @@ function githubInputs() {
     updateInterval,
     updateBackOff,
     disableSourceOverride,
-    hideCloudwatchLogs,
+    hideCloudWatchLogs,
   };
 }
 

dist/index.js

@@ -33,11 +33,11 @@
         const config = (({
           updateInterval,
           updateBackOff,
-          hideCloudwatchLogs,
+          hideCloudWatchLogs,
         }) => ({
           updateInterval,
           updateBackOff,
-          hideCloudwatchLogs,
+          hideCloudWatchLogs,
         }))(inputs);
 
         // Get input options for startBuild
@@ -57,7 +57,7 @@
       async function waitForBuildEndTime(
         sdk,
         { id, logs },
-        { updateInterval, updateBackOff, hideCloudwatchLogs },
+        { updateInterval, updateBackOff, hideCloudWatchLogs },
         seqEmptyLogs,
         totalEvents,
         throttleCount,
@@ -78,9 +78,9 @@
         // Check the state
         const [batch, cloudWatch = {}] = await Promise.all([
           codeBuild.batchGetBuilds({ ids: [id] }).promise(),
-          !hideCloudwatchLogs &&
+          !hideCloudWatchLogs &&
             logGroupName &&
-            cloudWatchLogs // only make the call if hideCloudwatchLogs is not enabled and a logGroupName exists
+            cloudWatchLogs // only make the call if hideCloudWatchLogs is not enabled and a logGroupName exists
               .getLogEvents({
                 logGroupName,
                 logStreamName,
@@ -170,7 +170,7 @@
         return waitForBuildEndTime(
           sdk,
           current,
-          { updateInterval, updateBackOff, hideCloudwatchLogs },
+          { updateInterval, updateBackOff, hideCloudWatchLogs },
           seqEmptyLogs,
           totalEvents,
           throttleCount,
@@ -227,9 +227,8 @@
             10
           ) * 1000;
 
-        const hideCloudwatchLogs =
-          core.getInput("hide-cloudwatch-logs", { required: false }) ||
-          undefined;
+        const hideCloudWatchLogs =
+          core.getInput("hide-cloudwatch-logs", { required: false }) === "true";
 
         return {
           projectName,
@@ -244,7 +243,7 @@
           updateInterval,
           updateBackOff,
           disableSourceOverride,
-          hideCloudwatchLogs,
+          hideCloudWatchLogs,
         };
       }
 

test/code-build-test.js

@@ -82,6 +82,7 @@ describe("githubInputs", () => {
       .and.to.equal(undefined);
     expect(test).to.haveOwnProperty("imageOverride").and.to.equal(undefined);
     expect(test).to.haveOwnProperty("envPassthrough").and.to.deep.equal([]);
+    expect(test).to.haveOwnProperty("hideCloudWatchLogs").and.to.equal(false);
   });
 
   it("a project name is required.", () => {
@@ -170,6 +171,7 @@ describe("githubInputs", () => {
       "No source version could be evaluated."
     );
   });
+
   it("can handle configuring update call-rate", () => {
     process.env[`INPUT_PROJECT-NAME`] = projectName;
     process.env[`INPUT_UPDATE-INTERVAL`] = `${updateInterval}`;
@@ -188,6 +190,19 @@ describe("githubInputs", () => {
       .to.haveOwnProperty("updateBackOff")
       .and.to.equal(updateBackOff * 1000);
   });
+
+  it("can hide cloudwatch logs when the parameter is set to true", () => {
+    // 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[`INPUT_HIDE-CLOUDWATCH-LOGS`] = "true";
+    process.env[`GITHUB_REPOSITORY`] = repoInfo;
+    process.env[`GITHUB_SHA`] = sha;
+
+    const test = githubInputs();
+
+    expect(test).to.haveOwnProperty("hideCloudWatchLogs").and.to.equal(true);
+  });
 });
 
 describe("inputs2Parameters", () => {