Feature 57 (config and provisioning): modules declare config and provisions, their files rendered from templates; synced with main (issues of feature 57, 874)

modules/records/cmd/records/templates_test.go

@@ -0,0 +1,64 @@
+package main
+
+import (
+	"encoding/json"
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+// The module's directory, where its manifest and its files/ are.
+const moduleDir = "../.."
+
+// templateText is the text a file resource places on the machine: its template's, in the module's files/
+// (novox/hq ADR 0349 §2). A resource that names no template, or a template that is not there, fails the test.
+func templateText(t *testing.T, r map[string]any) string {
+	t.Helper()
+	name, _ := r["template"].(string)
+	if name == "" {
+		t.Fatalf("resource %v names no template", r["id"])
+	}
+	raw, err := os.ReadFile(filepath.Join(moduleDir, filepath.FromSlash(name)))
+	if err != nil {
+		t.Fatalf("resource %v names %s: %v", r["id"], name, err)
+	}
+	return string(raw)
+}
+
+// No file resource carries its text inline: each names its template in files/, and the build packs files/
+// into the one archive the controller reads the templates back from (novox/hq ADR 0349 §2).
+func TestEveryFileTakesItsTextFromATemplate(t *testing.T) {
+	raw, err := os.ReadFile(filepath.Join(moduleDir, "module.json"))
+	if err != nil {
+		t.Fatal(err)
+	}
+	var m struct {
+		Resources []map[string]any `json:"resources"`
+		Build     struct {
+			Artifacts []map[string]any `json:"artifacts"`
+		} `json:"build"`
+	}
+	if err := json.Unmarshal(raw, &m); err != nil {
+		t.Fatal(err)
+	}
+	for _, r := range m.Resources {
+		if _, inline := r["content"]; inline {
+			t.Errorf("resource %v keeps its text inline: keep it in files/ and name it as the template", r["id"])
+		}
+		if r["type"] == "file" {
+			templateText(t, r)
+		}
+	}
+	packs := 0
+	for _, a := range m.Build.Artifacts {
+		if a["kind"] == "archive" && a["from"] == "files" {
+			packs++
+			if a["name"] != "files" {
+				t.Errorf("the templates archive is named %v, not files", a["name"])
+			}
+		}
+	}
+	if packs != 1 {
+		t.Errorf("the build packs files/ into %d archives, not one", packs)
+	}
+}

modules/records/files/config.json

@@ -0,0 +1 @@
+{}

modules/records/files/origin

@@ -0,0 +1 @@
+${bound:git:scheme}://${bound:git:at}:${bound:git:port}

modules/records/module.json

@@ -29,6 +29,15 @@
       }
     ]
   },
+  "config": {
+    "repository": {
+      "type": "string",
+      "description": "The repository the records module keeps a checkout of and serves the record from, as owner/name on the mesh's forge; the operator's, with no default (novox/hq ADR 0112).",
+      "pattern": "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+",
+      "trusted": true,
+      "required": true
+    }
+  },
   "resources": [
     {
       "id": "mesh-state",
@@ -47,7 +56,8 @@
       "type": "file",
       "path": "${dir:mesh-state}/config.json",
       "mode": "0600",
-      "content": "{}\n",
+      "template": "files/config.json",
+      "takes-config": ["repository"],
       "merge": "json"
     },
     {
@@ -55,7 +65,7 @@
       "type": "file",
       "path": "${dir:mesh-state}/origin",
       "mode": "0600",
-      "content": "${bound:git:scheme}://${bound:git:at}:${bound:git:port}\n"
+      "template": "files/origin"
     },
     {
       "id": "git",
@@ -80,6 +90,11 @@
           "MESH_RECORDS_ORIGIN_FILE": "${dir:mesh-state}/origin",
           "MESH_RECORDS_DIR": "${dir:checkout}"
         }
+      },
+      {
+        "name": "files",
+        "kind": "archive",
+        "from": "files"
       }
     ]
   }