Merge pull request #15 from infrablocks/module-variables

fix library generating types for variables of modules

Author: JDurstberger

.github/workflows/pr.yaml

@@ -0,0 +1,30 @@
+name: Pull Request
+on:
+  pull_request:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install tools
+        uses: ./.github/actions/asdf_install
+      - name: Test
+        run: ./go library:check
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install tools
+        uses: ./.github/actions/asdf_install
+      - name: Test
+        run: ./go library:test:all
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install tools
+        uses: ./.github/actions/asdf_install
+      - name: Test
+        run: ./go library:build
+

.idea/copilot.data.migration.ask2agent.xml

@@ -0,0 +1,5 @@
+module "child" {
+  source = "./modules/child"
+
+  sub_variable = "foo"
+}

examples/with_module/main.tf

@@ -0,0 +1,3 @@
+output "sub_variable" {
+  value = var.sub_variable
+}

examples/with_module/modules/child/main.tf

@@ -0,0 +1,2 @@
+variable "sub_variable" {
+}

examples/with_module/modules/child/variables.tf

@@ -0,0 +1,7 @@
+variable "root_string" {
+  type = string
+}
+
+variable "root_number" {
+  type = number
+}

examples/with_module/variables.tf

@@ -6,6 +6,7 @@
 class TFMeta(TypedDict):
     label: str
     filename: str
+    path: str
 
 
 class VariableMeta(TypedDict, total=False):
@@ -57,6 +58,7 @@ def generate_pkl_type(chdir: str, type_name: str) -> str:
         variable
         for variable in parsed["variable"]
         if variable["__tfmeta"]["filename"] == "variables.tf"
+        and variable["__tfmeta"]["path"].startswith("variable.")
     ]
     output: List[str] = []
 

src/infrablocks/terraform_pkl_type_gen/pkl_generator.py

@@ -0,0 +1,24 @@
+from infrablocks.terraform_pkl_type_gen.pkl_generator import generate_pkl_type
+
+with_module_example = generate_pkl_type(
+    "examples/with_module", "WithModuleExample"
+).split("\n")
+
+
+class TestGeneratePklTypeWithModule:
+    def test_includes_root_variables(self):
+        labels = [
+            line.split(":")[0].strip()
+            for line in with_module_example
+            if ":" in line and not line.startswith("//")
+        ]
+        assert "root_string" in labels
+        assert "root_number" in labels
+
+    def test_excludes_submodule_variables(self):
+        labels = [
+            line.split(":")[0].strip()
+            for line in with_module_example
+            if ":" in line and not line.startswith("//")
+        ]
+        assert "sub_variable" not in labels

tests/unit/infrablocks/test_generate_pkl_with_module.py

@@ -12,6 +12,7 @@ from tfparse._tfparse import ffi
 class TFMeta(tp.TypedDict):
     label: str
     filename: str
+    path: str
 
 class VariableMeta(tp.TypedDict, total=False):
     __tfmeta: tp.Required[TFMeta]
@@ -29,4 +30,4 @@ def load_from_path(
     allow_downloads: bool = False,
     workspace_name: str = "default",
     vars_paths: tp.List[str] | None = None,
-) -> Parsed: ...
+) -> Parsed: ...