feat(build): #232 test terraform

- Add /testTerraform to makes.nix
- Add argument, docs, etc

Author: kamadorueda

.github/workflows/dev.yml

@@ -139,6 +139,14 @@ jobs:
       name: /lintWithLizard
       with:
         args: sh -c "nix-env -if . && m . /lintWithLizard"
+  testTerraform_module:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: docker://docker.io/nixos/nix:2.3.12
+      name: /testTerraform/module
+      with:
+        args: sh -c "nix-env -if . && m . /testTerraform/module"
 name: dev
 on:
   pull_request:

README.md

@@ -47,6 +47,8 @@ in just a few steps, in any technology.
         - [lintPython](#lintpython)
         - [lintTerraform](#lintterraform)
         - [lintWithLizard](#lintwithlizard)
+    - [Testing](#testing)
+        - [testTerraform](#testterraform)
     - [Pinning](#pinning)
         - [inputs](#inputs)
         - [requiredMakesVersion](#requiredmakesversion)
@@ -925,7 +927,7 @@ Custom Types:
       Defaults to `[ ]`.
     - src (`str`):
       Path to the [Terraform][TERRAFORM] module.
-    - version (`str`):
+    - version (`enum [ "0.12" "0.13" "0.14" "0.15" "0.16" ]`):
       [Terraform][TERRAFORM] version your module is built with.
 
 Example `makes.nix`:
@@ -980,6 +982,52 @@ Example `makes.nix`:
 
 Example invocation: `$ m . /lintWithLizard`
 
+## Testing
+
+### testTerraform
+
+Test [Terraform][TERRAFORM] code
+by performing a `terraform plan`
+over the specified [Terraform][TERRAFORM] modules.
+
+Attributes:
+
+- modules (`attrsOf moduleType`): Optional.
+  Path to [Terraform][TERRAFORM] modules to lint.
+  Defaults to `{ }`.
+
+Custom Types:
+
+- moduleType (`submodule`):
+    - authentication (`listOf package`): Optional.
+      [Makes Secrets][MAKES_SECRETS] to use (if required by your module).
+      Defaults to `[ ]`.
+    - src (`str`):
+      Path to the [Terraform][TERRAFORM] module.
+    - version (`enum [ "0.12" "0.13" "0.14" "0.15" "0.16" ]`):
+      [Terraform][TERRAFORM] version your module is built with.
+
+Example `makes.nix`:
+
+```nix
+{
+  testTerraform = {
+    modules = {
+      module1 = {
+        src = "/my/module1";
+        version = "0.12";
+      };
+      module2 = {
+        src = "/my/module2";
+        version = "0.16";
+      };
+    };
+  };
+}
+```
+
+Example invocation: `$ m . /testTerraform`
+
 ## Pinning
 
 ### inputs
@@ -1709,6 +1757,8 @@ Guidelines:
 - Write an argument: `/src/args`
 - Write a module (if applies): `/src/evaluator/modules`
 - Write docs: `/README.md`
+- Write a test: `/makes.nix` or `/makes/**/main.nix`
+- Write a test [GitHub workflow][GITHUB_WORKFLOWS]: `/.github/workflows/dev.yml`
 
 Examples:
 

makes.nix

@@ -90,7 +90,7 @@
   lintTerraform = {
     modules = {
       module = {
-        src = "/test/lintTerraform/module";
+        src = "/test/terraform/module";
         version = "0.13";
       };
     };
@@ -100,4 +100,12 @@
     targets = [ "/" ];
   };
   requiredMakesVersion = "21.08";
+  testTerraform = {
+    modules = {
+      module = {
+        src = "/test/terraform/module";
+        version = "0.13";
+      };
+    };
+  };
 }

src/args/default.nix

@@ -42,6 +42,7 @@ let
     pathImpure = path: headImpure + path;
     sortAscii = builtins.sort (a: b: a < b);
     sortAsciiCaseless = builtins.sort (a: b: lib.toLower a < lib.toLower b);
+    testTerraform = import ./test-terraform/default.nix args;
     toDerivationName = lib.strings.sanitizeDerivationName;
     toFileJson = import ./to-file-json/default.nix args;
     toFileLst = import ./to-file-lst/default.nix;

src/args/test-terraform/default.nix

@@ -0,0 +1,25 @@
+{ __nixpkgs__
+, makeScript
+, makeTerraformEnvironment
+, ...
+}:
+{ authentication
+, name
+, version
+, src
+, ...
+}:
+makeScript {
+  entrypoint = ./entrypoint.sh;
+  replace = {
+    __argSrc__ = src;
+  };
+  name = "test-terraform-for-${name}";
+  searchPaths = {
+    source = [
+      (makeTerraformEnvironment {
+        inherit version;
+      })
+    ] ++ authentication;
+  };
+}

src/args/test-terraform/entrypoint.sh

@@ -0,0 +1,12 @@
+# shellcheck shell=bash
+
+function main {
+  cd "$(mktemp -d)" \
+    && copy '__argSrc__' . \
+    && info Initializing '__argSrc__' \
+    && terraform init \
+    && info Testing '__argSrc__' \
+    && terraform plan -lock=false -refresh=true
+}
+
+main "${@}"

src/evaluator/modules/outputs/builtins/default.nix

@@ -17,5 +17,6 @@ args:
     (import ./lint-python/default.nix args)
     (import ./lint-terraform/default.nix args)
     (import ./lint-with-lizard/default.nix args)
+    (import ./test-terraform/default.nix args)
   ];
 }

src/evaluator/modules/outputs/builtins/test-terraform/default.nix

@@ -0,0 +1,53 @@
+{ __nixpkgs__
+, __toModuleOutputs__
+, testTerraform
+, path
+, ...
+}:
+{ config
+, lib
+, ...
+}:
+let
+  makeOutput = name: { authentication, src, version }: {
+    name = "/testTerraform/${name}";
+    value = testTerraform {
+      inherit authentication;
+      inherit name;
+      src = path src;
+      inherit version;
+    };
+  };
+in
+{
+  options = {
+    testTerraform = {
+      modules = lib.mkOption {
+        default = { };
+        type = lib.types.attrsOf (lib.types.submodule (_: {
+          options = {
+            authentication = lib.mkOption {
+              default = [ ];
+              type = lib.types.listOf lib.types.package;
+            };
+            src = lib.mkOption {
+              type = lib.types.str;
+            };
+            version = lib.mkOption {
+              type = lib.types.enum [
+                "0.12"
+                "0.13"
+                "0.14"
+                "0.15"
+                "0.16"
+              ];
+            };
+          };
+        }));
+      };
+    };
+  };
+  config = {
+    outputs = __toModuleOutputs__ makeOutput config.testTerraform.modules;
+  };
+}