feat: support passing terraform.workspace name (#225)

gotfparse/cmd/tfparse/main.go

@@ -15,7 +15,7 @@ import (
 )
 
 //export Parse
-func Parse(a *C.char, stopHCL C.int, debug C.int, allowDownloads C.int, num_vars_files C.int, vars_files **C.char) (resp C.parseResponse) {
+func Parse(a *C.char, stopHCL C.int, debug C.int, allowDownloads C.int, workspaceName *C.char, num_vars_files C.int, vars_files **C.char) (resp C.parseResponse) {
 	input := C.GoString(a)
 
 	options := []converter.TerraformConverterOption{}
@@ -33,6 +33,8 @@ func Parse(a *C.char, stopHCL C.int, debug C.int, allowDownloads C.int, num_vars
 		options = append(options, converter.WithAllowDownloads(false))
 	}
 
+	options = append(options, converter.WithWorkspaceName(C.GoString(workspaceName)))
+
 	var varFiles []string
 	for _, v := range unsafe.Slice(vars_files, num_vars_files) {
 		varFiles = append(varFiles, C.GoString(v))

gotfparse/pkg/converter/converter.go

@@ -403,6 +403,11 @@ func (t *terraformConverter) SetTFVarsPaths(paths ...string) {
 	t.parserOptions = append(t.parserOptions, parser.OptionWithTFVarsPaths(paths...))
 }
 
+// SetWorkspaceName is a TerraformConverter option that sets the value for the workspace name.
+func (t *terraformConverter) SetWorkspaceName(workspace string) {
+	t.parserOptions = append(t.parserOptions, parser.OptionWithWorkspaceName(workspace))
+}
+
 func getModuleName(b *terraform.Block) string {
 	// This field is unexported, but necessary to generate the path of the
 	// module. Hopefully aquasecurity/defsec exports this in a future release.

gotfparse/pkg/converter/options.go

@@ -7,6 +7,7 @@ type TerraformConverterOptions interface {
 	SetStopOnHCLError()
 	SetAllowDownloads(allowed bool)
 	SetTFVarsPaths(paths ...string)
+	SetWorkspaceName(workspace string)
 }
 
 type TerraformConverterOption func(t TerraformConverterOptions)
@@ -38,3 +39,10 @@ func WithTFVarsPaths(paths ...string) TerraformConverterOption {
 		t.SetTFVarsPaths(paths...)
 	}
 }
+
+// WithWorkspaceName sets the Terraform workspace name.
+func WithWorkspaceName(workspace string) TerraformConverterOption {
+	return func(t TerraformConverterOptions) {
+		t.SetWorkspaceName(workspace)
+	}
+}

tests/terraform/workspace/main.tf

@@ -0,0 +1,15 @@
+locals {
+  map = {
+    default = "DEFAULT"
+    other   = "OTHER"
+  }
+  value = local.map[terraform.workspace]
+}
+
+output "workspace" {
+  value = terraform.workspace
+}
+
+output "value" {
+  value = local.value
+}

tests/test_tfparse.py

@@ -532,3 +532,17 @@ def test_funcs(tmp_path):
         "modules_list": ["x", "y", "z"],
     }
     assert len(actual["check_fileset_abs_path"]) > 0
+
+
+def test_workspace(tmp_path):
+    mod_path = init_module("workspace", tmp_path)
+
+    parsed = load_from_path(mod_path)
+    value, workspace = parsed["output"]
+    assert workspace["value"] == "default"
+    assert value["value"] == "DEFAULT"
+
+    parsed = load_from_path(mod_path, workspace_name="other")
+    value, workspace = parsed["output"]
+    assert workspace["value"] == "other"
+    assert value["value"] == "OTHER"

tfparse/__init__.py

@@ -28,14 +28,14 @@ def load_from_path(
     stop_on_hcl_error: bool = False,
     debug: bool = False,
     allow_downloads: bool = False,
+    workspace_name: str = "default",
     vars_paths=None,  # list[str]
 ) -> tp.Dict:
     if not isinstance(filePath, (str, Path)):
         raise ValueError("filePath must be str or Path, got %s" % type(filePath))
 
-    filePath = str(filePath).encode("utf8")
-
-    s = ffi.new("char[]", filePath)
+    path = ffi.new("char[]", str(filePath).encode("utf8"))
+    workspace = ffi.new("char[]", str(workspace_name).encode("utf8"))
 
     vars_paths = vars_paths or []
     num_var_paths = len(vars_paths)
@@ -44,7 +44,13 @@ def load_from_path(
     ]
 
     ret = lib.Parse(
-        s, stop_on_hcl_error, debug, allow_downloads, num_var_paths, c_var_paths
+        path,
+        stop_on_hcl_error,
+        debug,
+        allow_downloads,
+        workspace,
+        num_var_paths,
+        c_var_paths,
     )
 
     if ret.err != ffi.NULL:

tfparse/build_cffi.py

@@ -19,7 +19,7 @@
             char *err;
         } parseResponse;
 
-        parseResponse Parse(char* a, int stop_on_error, int debug, int allow_downloads, int num_vars_files, char** vars_files);
+        parseResponse Parse(char* a, int stop_on_error, int debug, int allow_downloads, char* workspace_name, int num_vars_files, char** vars_files);
         void free(void *ptr);
         """  # noqa
 )