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

modules/mesh-watcher/cmd/mesh-watcher/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/mesh-watcher/files/settings.json

@@ -0,0 +1,3 @@
+{
+  "telegram-chat-id": ""
+}

modules/mesh-watcher/module.json

@@ -18,6 +18,14 @@
     "watcher_test",
     "watcher_ping"
   ],
+  "config": {
+    "telegram-chat-id": {
+      "type": "string",
+      "description": "The Telegram chat the watcher reports to: the chat's id, a number, or @name of a channel; empty reports to none.",
+      "trusted": true,
+      "default": ""
+    }
+  },
   "resources": [
     {
       "id": "state",
@@ -30,8 +38,9 @@
       "type": "file",
       "path": "${dir:state}/settings.json",
       "mode": "0600",
+      "takes-config": ["telegram-chat-id"],
       "merge": "json",
-      "content": "{\n  \"telegram-chat-id\": \"\"\n}\n"
+      "template": "files/settings.json"
     }
   ],
   "build": {
@@ -50,6 +59,11 @@
           "MESH_WATCHER_SETTINGS": "${dir:state}/settings.json",
           "MESH_WATCHER_TELEGRAM_TOKEN_FILE": "${dir:state}/telegram-token"
         }
+      },
+      {
+        "name": "files",
+        "kind": "archive",
+        "from": "files"
       }
     ]
   }