feat: improve variable handling

data.go

@@ -8,6 +8,15 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
+type ErrUndefinedPath struct {
+	Path     []interface{}
+	FuncName string
+}
+
+func (e ErrUndefinedPath) Error() string {
+	return fmt.Sprintf("%s: undefined path: %v", e.FuncName, e.Path)
+}
+
 // Data is an arbitrary map of values which makes up the inventory.
 type Data map[string]interface{}
 
@@ -79,14 +88,14 @@ func (d Data) GetPath(path ...interface{}) (tree interface{}, err error) {
 			}
 			tree, ok = node[key]
 			if !ok {
-				return nil, fmt.Errorf("key not found: %v", el)
+				return nil, ErrUndefinedPath{Path: path, FuncName: "GetPath"}
 			}
 
 		case map[interface{}]interface{}:
 			var ok bool
 			tree, ok = node[el]
 			if !ok {
-				return nil, fmt.Errorf("key not found: %v", el)
+				return nil, ErrUndefinedPath{Path: path, FuncName: "GetPath"}
 			}
 
 		case []interface{}:
@@ -101,9 +110,8 @@ func (d Data) GetPath(path ...interface{}) (tree interface{}, err error) {
 				return nil, fmt.Errorf("path index out of range: %d", index)
 			}
 			tree = node[index]
-
 		default:
-			return nil, fmt.Errorf("unexpected node type %T at index %d", node, i)
+			return nil, ErrUndefinedPath{Path: path, FuncName: "GetPath"}
 		}
 	}
 	return tree, nil
@@ -151,9 +159,8 @@ func (d *Data) SetPath(value interface{}, path ...interface{}) (err error) {
 			return fmt.Errorf("path index out of range: %d", index)
 		}
 		node[index] = value
-
-	default:
-		return fmt.Errorf("unexpected node type %T at index %d", node, i)
+	case string:
+		return ErrUndefinedPath{Path: path, FuncName: "SetPath"}
 	}
 
 	return nil

examples/secrets/compiled/azure_keyvault/AzureReadme.md

@@ -0,0 +1,2 @@
+# Azure KeyVault
+

examples/secrets/compiled/azure_keyvault/README.md

@@ -1,2 +1,122 @@
 # Azure KeyVault
 
+azure_keyvault
+INVALID DEFAULT VALUE
+defined
+{
+  "alphaNum": "test",
+  "azure": {
+    "common": {
+      "baz": null,
+      "baz2": null,
+      "foo": {
+        "bar": "test"
+      },
+      "from_target": "test_CHANGED",
+      "self_reference": "bar",
+      "skipper": {
+        "copy": [
+          {
+            "source": "inventory.json",
+            "target": "something_else/foobar.json"
+          }
+        ]
+      },
+      "subscription_id": "INVALID DEFAULT VALUE",
+      "this": {
+        "complex": "object",
+        "is": "a",
+        "which": [
+          "I",
+          "WANT",
+          "TO",
+          "INCLUDE"
+        ]
+      }
+    },
+    "resources": {
+      "location": "westeurope",
+      "resource_group": {
+        "name": "rg-azure_keyvault-terraform-example-westeurope"
+      },
+      "vnet": {
+        "address_space": [
+          "10.1.0.0/16",
+          "10.2.0.0/16"
+        ],
+        "name": "vnet-azure_keyvault-terraform-example",
+        "subnets": {
+          "virtual_machines": {
+            "address_prefixes": [
+              "10.1.1.0/24"
+            ],
+            "name": "virtual_machines"
+          }
+        }
+      }
+    }
+  },
+  "features": {
+    "production": {
+      "feature1": false,
+      "feature2": false
+    },
+    "sandbox": {
+      "asdf": "asdf",
+      "feature1": true,
+      "feature2": true
+    }
+  },
+  "foo": "defined",
+  "import": {
+    "complex": "object",
+    "is": "a",
+    "which": [
+      "I",
+      "WANT",
+      "TO",
+      "INCLUDE"
+    ]
+  },
+  "secrets": {
+    "test1": "?{azurekv:targets/azure_keyvault/test1||randomstring:32}",
+    "test2": "?{azurekv:targets/azure_keyvault/test2||randomstring:64}",
+    "test3": "?{azurekv:targets/azure_keyvault/test2}"
+  },
+  "skipper": {
+    "components": [
+      {
+        "input_paths": [
+          "AzureReadme.md",
+          "inventory.json"
+        ],
+        "output_path": ".",
+        "rename": [
+          {
+            "filename": "README.md",
+            "input_path": "AzureReadme.md"
+          }
+        ]
+      }
+    ],
+    "copy": [
+      {
+        "source": "inventory.json",
+        "target": "something/foobar.json"
+      }
+    ],
+    "secrets": {
+      "drivers": {
+        "azurekv": {
+          "ignore_version": true,
+          "key_id": "https://kv-dev-infra-platform.vault.azure.net/keys/dev-infra-secrets-key/6e0360a098eb4808af5ec1f970d399c0"
+        }
+      }
+    },
+    "use": [
+      "azure.*",
+      "features"
+    ]
+  },
+  "test": "azure_keyvault"
+}

examples/secrets/compiled/azure_keyvault/inventory.json

@@ -2,12 +2,13 @@
   "alphaNum": "test",
   "azure": {
     "common": {
-      "baz": "test",
-      "baz2": "test",
+      "baz": null,
+      "baz2": null,
       "foo": {
         "bar": "test"
       },
       "from_target": "test_CHANGED",
+      "self_reference": "bar",
       "skipper": {
         "copy": [
           {
@@ -16,7 +17,17 @@
           }
         ]
       },
-      "subscription_id": "INVALID DEFAULT VALUE"
+      "subscription_id": "INVALID DEFAULT VALUE",
+      "this": {
+        "complex": "object",
+        "is": "a",
+        "which": [
+          "I",
+          "WANT",
+          "TO",
+          "INCLUDE"
+        ]
+      }
     },
     "resources": {
       "location": "westeurope",
@@ -40,6 +51,28 @@
       }
     }
   },
+  "features": {
+    "production": {
+      "feature1": false,
+      "feature2": false
+    },
+    "sandbox": {
+      "asdf": "asdf",
+      "feature1": true,
+      "feature2": true
+    }
+  },
+  "foo": "defined",
+  "import": {
+    "complex": "object",
+    "is": "a",
+    "which": [
+      "I",
+      "WANT",
+      "TO",
+      "INCLUDE"
+    ]
+  },
   "secrets": {
     "test1": "?{azurekv:targets/azure_keyvault/test1||randomstring:32}",
     "test2": "?{azurekv:targets/azure_keyvault/test2||randomstring:64}",
@@ -76,7 +109,8 @@
       }
     },
     "use": [
-      "azure.*"
+      "azure.*",
+      "features"
     ]
   },
   "test": "azure_keyvault"

examples/secrets/compiled/test/AzureReadme.md

@@ -0,0 +1,2 @@
+# Azure KeyVault
+

examples/secrets/inventory/classes/features.yaml

@@ -0,0 +1,8 @@
+features:
+  sandbox:
+    feature1: true
+    feature2: true
+    asdf: "asdf"
+  production:
+    feature1: false
+    feature2: false

examples/secrets/inventory/targets/azure_keyvault.yaml

@@ -3,6 +3,7 @@ target:
   skipper:
     use: 
       - azure.*
+      - features
     components:
       - output_path: .
         input_paths:
@@ -20,6 +21,16 @@ target:
           ignore_version: true
           key_id: "https://kv-dev-infra-platform.vault.azure.net/keys/dev-infra-secrets-key/6e0360a098eb4808af5ec1f970d399c0"
 
+  features: 
+    sandbox: ${features:sandbox}
+
+  asdf: ${asdf}
+
+    #features: ${features:production}
+
+  azure:
+    common:
+      self_reference: "bar"
   secrets:
     test1: ?{azurekv:targets/${target_name}/test1||randomstring:32}
     test2: ?{azurekv:targets/${target_name}/test2||randomstring:64}
@@ -29,3 +40,4 @@ target:
   alphaNum: "%{loweralpha:${azure:common:foo:bar}}"
 
   import: ${azure:common:this}
+  foo: "defined"

examples/secrets/main.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"log"
 	"path"
 
 	"github.com/lukasjarosch/skipper"
@@ -32,29 +31,21 @@ func main() {
 		panic(err)
 	}
 
-	log.Printf("\n%s", data.String())
+	//	log.Printf("\n%s", data.String())
 
 	templateOutputPath := path.Join(outputPath, target)
 	templater, err := skipper.NewTemplater(fileSystem, templatePath, templateOutputPath, nil)
 	if err != nil {
 		panic(err)
 	}
 
-	templateData := struct {
-		Inventory  any
-		TargetName string
-	}{
-		Inventory:  data,
-		TargetName: target,
-	}
-
 	skipperConfig, err := inventory.GetSkipperConfig(target)
 	if err != nil {
 		panic(err)
 	}
 
 	// execute templates  ----------------------------------------------------------------------------------
-	err = templater.ExecuteComponents(templateData, skipperConfig.Components, false)
+	err = templater.ExecuteComponents(skipper.DefaultTemplateContext(data, target), skipperConfig.Components, false)
 	if err != nil {
 		panic(err)
 	}

examples/secrets/templates/AzureReadme.md

@@ -1,2 +1,6 @@
 # Azure KeyVault
 
+{{ .TargetName }}
+{{ .Inventory.azure.common.subscription_id }}
+{{ .Inventory.foo }}
+{{ .Inventory | toPrettyJson }}