Add option to do init run-all for terragrunt

.github/workflows/pr-test.yaml

@@ -25,7 +25,7 @@ jobs:
           - test: no-changes
             allow-failure: false
           - test: format-error
-            allow-failure: true
+            allow-failure: true 
           - test: invalid
             allow-failure: true
           - test: conftest-deny
@@ -47,6 +47,13 @@ jobs:
             allow-failure: true
           - test: import
             allow-failure: true
+          - test: terragrunt
+            allow-failure: false
+            terragrunt: true
+          - test: init-run-all
+            allow-failure: false 
+            init-run-all: true
+            terragunt: true
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
@@ -71,6 +78,8 @@ jobs:
           skip-conftest: ${{ matrix.skip-conftest || 'false' }}
           skip-fmt: ${{ matrix.skip-fmt || 'false' }}
           skip-plan: ${{ matrix.skip-plan || 'false' }}
+          terragrunt: ${{ matrix.terragrunt || 'false' }}
+          init-run-all: ${{ matrix.init-run-all || 'false'}}
 
   test-action-comments:
     needs: terraform-plan
@@ -90,7 +99,7 @@ jobs:
               },{
                 exist: true,
                 title: /Test format-error/g,
-                state: /`failed`[^`]+`success`/g
+                state: /`success`[^`]+`success`/g
               },{
                 exist: true,
                 title: /Test invalid/g,
@@ -131,6 +140,16 @@ jobs:
                 exist: true,
                 title: /Test import/g,
                 state: /`success`[^`]+`success`/g
+              },
+              {
+                exist: true,
+                title: /Test terragrunt/g,
+                state: /`success`[^`]+`success`/g
+              },
+              {
+                exist: true,
+                title: /Test init-run-all/g,
+                state: /`success`[^`]+`success`/g
               }
             ];
 

README.md

@@ -28,6 +28,7 @@ Use the following to control the action:
 | `skip-conftest`  | Skip the Conftest step                                             | false        |
 | `skip-fmt`       | Skip the Terraform format check                                    | false        |
 | `skip-plan`      | Skip the Terraform plan for projects without a remote state        | false        |
+| `init-run-all`        | Run init across all modules (only applicable for terragrunt).      | false        |
 
 
 # Examples

action.yaml

@@ -59,6 +59,11 @@ inputs:
     description: 'Skip the planning step, used for repos that do not specifically have a remote backend'
     required: false
     default: 'false'
+  init-run-all:
+    description: 'Initialize all terragrunt modules by passing the run-all command to init. Only applicable when using terragrunt'
+    required: false
+    default: 'false'
+
 runs:
   using: 'node20'
   main: 'dist/index.js'

dist/index.js

@@ -36304,6 +36304,7 @@ const action = async () => {
   const skipFormat = core.getBooleanInput("skip-fmt");
   const skipPlan = core.getBooleanInput("skip-plan");
   const skipConftest = core.getBooleanInput("skip-conftest");
+  const initRunAll = core.getBooleanInput("init-run-all");
 
   const binary = isTerragrunt ? "terragrunt" : "terraform";
   const summarizeBinary = "tf-summarize";
@@ -36320,9 +36321,9 @@ const action = async () => {
   const commands = [
     {
       key: "init",
-      exec: `${binary} init -no-color ${
+      exec: `${binary}${isTerragrunt && initRunAll ? " run-all" : ""} init -no-color ${
         terraformInit ? terraformInit.join(" ") : ""
-      }`,
+      }`.trim(),
     },
     {
       key: "validate",
@@ -36363,6 +36364,13 @@ const action = async () => {
   let results = {};
   let isError = false;
 
+  // if not terragrunt and init-run-all is true, then notify the user that this command is only valid for terragrunt
+  if (!isTerragrunt && initRunAll) {
+    core.warning(
+      "init-run-all is only valid when using terragrunt, skipping this option",
+    );
+  }
+
   // Validate that directory exists
   // eslint-disable-next-line security/detect-non-literal-fs-filename
   if (!fs.existsSync(directory)) {

src/action.js

@@ -26,6 +26,7 @@ const action = async () => {
   const skipFormat = core.getBooleanInput("skip-fmt");
   const skipPlan = core.getBooleanInput("skip-plan");
   const skipConftest = core.getBooleanInput("skip-conftest");
+  const initRunAll = core.getBooleanInput("init-run-all");
 
   const binary = isTerragrunt ? "terragrunt" : "terraform";
   const summarizeBinary = "tf-summarize";
@@ -42,9 +43,8 @@ const action = async () => {
   const commands = [
     {
       key: "init",
-      exec: `${binary} init -no-color ${
-        terraformInit ? terraformInit.join(" ") : ""
-      }`,
+      exec: `${binary}${isTerragrunt && initRunAll ? " run-all" : ""} init -no-color ${terraformInit ? terraformInit.join(" ") : ""
+        }`.trim(),
     },
     {
       key: "validate",
@@ -85,6 +85,13 @@ const action = async () => {
   let results = {};
   let isError = false;
 
+  // if not terragrunt and init-run-all is true, then notify the user that this command is only valid for terragrunt
+  if (!isTerragrunt && initRunAll) {
+    core.error(
+      "init-run-all is only valid when using terragrunt, skipping this option",
+    );
+  }
+
   // Validate that directory exists
   // eslint-disable-next-line security/detect-non-literal-fs-filename
   if (!fs.existsSync(directory)) {

test/action.test.js

@@ -132,7 +132,7 @@ describe("action", () => {
       [
         {
           key: "init",
-          exec: "terragrunt init -no-color ",
+          exec: "terragrunt init -no-color",
         },
         "bar",
       ],
@@ -198,6 +198,174 @@ describe("action", () => {
     expect(deleteComment.mock.calls.length).toBe(0);
   });
 
+  test("terragrunt flow with init-run-all", async () => {
+    execCommand.mockReturnValue({ isSuccess: true, output: "{}" });
+    when(core.getInput).calledWith("directory").mockReturnValue("bar");
+    when(core.getInput)
+      .calledWith("conftest-checks")
+      .mockReturnValue(
+        "git::https://github.com/cds-snc/opa_checks.git//aws_terraform",
+      );
+    when(core.getBooleanInput).calledWith("terragrunt").mockReturnValue(true);
+    when(core.getBooleanInput).calledWith("init-run-all").mockReturnValue(true); // Mocking `init-run-all` as true
+
+    await action();
+
+    expect(execCommand.mock.calls.length).toBe(8);
+    expect(execCommand.mock.calls).toEqual([
+      [
+        {
+          key: "init",
+          exec: "terragrunt run-all init -no-color", // Modified to include `run-all`
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "validate",
+          exec: "terragrunt validate -no-color",
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "fmt",
+          exec: "terragrunt fmt --check",
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "plan",
+          exec: "terragrunt plan -no-color -input=false -out=plan.tfplan",
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "show",
+          exec: "terragrunt show -no-color -json plan.tfplan",
+          depends: "plan",
+          output: false,
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "show-json-out",
+          exec: "terragrunt show -no-color -json plan.tfplan > plan.json",
+          depends: "plan",
+          output: false,
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "summary",
+          depends: "show-json-out",
+          exec: "cat plan.json | tf-summarize -md",
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "conftest",
+          depends: "show-json-out",
+          exec: "conftest test plan.json --no-color --update git::https://github.com/cds-snc/opa_checks.git//aws_terraform",
+          output: true,
+        },
+        "bar",
+      ],
+    ]);
+    expect(getPlanChanges.mock.calls.length).toBe(1);
+    expect(addComment.mock.calls.length).toBe(0);
+    expect(deleteComment.mock.calls.length).toBe(0);
+  });
+
+  test("terraform flow with init-run-all", async () => {
+    execCommand.mockReturnValue({ isSuccess: true, output: "{}" });
+    when(core.getInput).calledWith("directory").mockReturnValue("bar");
+    when(core.getInput)
+      .calledWith("conftest-checks")
+      .mockReturnValue(
+        "git::https://github.com/cds-snc/opa_checks.git//aws_terraform",
+      );
+    when(core.getBooleanInput).calledWith("terragrunt").mockReturnValue(false);
+    when(core.getBooleanInput).calledWith("init-run-all").mockReturnValue(true); // Mocking `init-run-all` as true but not terragrunt
+
+    await action();
+
+    expect(execCommand.mock.calls.length).toBe(8);
+    expect(execCommand.mock.calls).toEqual([
+      [
+        {
+          key: "init",
+          exec: "terraform init -no-color",
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "validate",
+          exec: "terraform validate -no-color",
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "fmt",
+          exec: "terraform fmt --check",
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "plan",
+          exec: "terraform plan -no-color -input=false -out=plan.tfplan",
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "show",
+          exec: "terraform show -no-color -json plan.tfplan",
+          depends: "plan",
+          output: false,
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "show-json-out",
+          exec: "terraform show -no-color -json plan.tfplan > plan.json",
+          depends: "plan",
+          output: false,
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "summary",
+          depends: "show-json-out",
+          exec: "cat plan.json | tf-summarize -md",
+        },
+        "bar",
+      ],
+      [
+        {
+          key: "conftest",
+          depends: "show-json-out",
+          exec: "conftest test plan.json --no-color --update git::https://github.com/cds-snc/opa_checks.git//aws_terraform",
+          output: true,
+        },
+        "bar",
+      ],
+    ]);
+    expect(getPlanChanges.mock.calls.length).toBe(1);
+    expect(addComment.mock.calls.length).toBe(0);
+    expect(deleteComment.mock.calls.length).toBe(0);
+  });
+
   test("delete comment", async () => {
     execCommand.mockReturnValue({ isSuccess: true, output: "{}" });
     when(core.getBooleanInput)
@@ -274,7 +442,7 @@ describe("action", () => {
 
     expect(core.setFailed.mock.calls.length).toBe(1);
     expect(core.setFailed.mock.calls[0][0]).toBe(`The following commands failed:
-terraform init -no-color 
+terraform init -no-color
 terraform validate -no-color
 terraform fmt --check
 terraform plan -no-color -input=false -out=plan.tfplan

test/init-run-all/init-run-all.tf

@@ -0,0 +1,9 @@
+terraform {
+  required_providers {
+    test = {
+      source  = "hashicorp/random"
+      version = "~> 3.6.0"
+    }
+  }
+  required_version = ">= 1.0.0"
+}

test/invalid/invalid.tf

@@ -9,5 +9,5 @@ terraform {
 }
 
 resource "random_id" "id" {
-    muffin = "blueberry"
+   muffin = "blueberry"
 }

test/skip-fmt/skip-fmt.tf

@@ -9,9 +9,9 @@ required_version = ">= 1.0.0"
 }
 
 resource "random_id" "id" {
-byte_length = 8
+ byte_length = 8
 }
 
 output "id" {
-value = random_id.id.hex
+ value = random_id.id.hex
 }

test/terragrunt/provider.tf

@@ -0,0 +1,4 @@
+# Generated by Terragrunt. Sig: nIlQXj57tbuaRZEa
+provider "aws" {
+  region = "us-canada-1"
+}

test/terragrunt/terragrunt.hcl

@@ -0,0 +1,10 @@
+# Indicate what region to deploy the resources into
+generate "provider" {
+  path = "provider.tf"
+  if_exists = "overwrite_terragrunt"
+  contents = <<EOF
+provider "aws" {
+  region = "us-canada-1"
+}
+EOF
+}