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

modules/hostname/cmd/hostname-tools/hostsfile_test.go

@@ -304,7 +304,7 @@ func TestTheMachinesNameIsTheOperatorsSetting(t *testing.T) {
 		if r["path"] != "/etc/hostname" {
 			continue
 		}
-		if r["id"] != "name" || r["into"] != nil || r["content"] != "${setting:hostname}\n" {
+		if r["id"] != "name" || r["into"] != nil || templateText(t, r) != "${config:hostname}\n" {
 			t.Errorf("/etc/hostname is not written whole from the hostname setting: %v", r)
 		}
 		return

modules/hostname/cmd/hostname-tools/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/hostname/files/hostname

@@ -0,0 +1 @@
+${config:hostname}

modules/hostname/files/hosts

@@ -0,0 +1,7 @@
+# The machine's own names (module hostname, novox/hq ADR 0199, ADR 0223). Every line outside this
+# block is the operator's: kept across every push, changed through the node-hostname verbs add and
+# remove, and given back when this module goes. The mesh's names are not here: the mesh's resolver
+# answers them.
+127.0.0.1	localhost
+::1	localhost
+127.0.1.1	${machine:name}

modules/hostname/module.json

@@ -12,6 +12,14 @@
       ]
     }
   ],
+    "config": {
+      "hostname": {
+        "type": "string",
+        "description": "The machine's host name, written to /etc/hostname: the operator's name for this machine, with no default (novox/hq ADR 0112).",
+        "trusted": true,
+        "required": true
+      }
+    },
   "resources": [
     {
       "id": "own",
@@ -20,14 +28,14 @@
       "mode": "0644",
       "into": "block",
       "at": "start",
-      "content": "# The machine's own names (module hostname, novox/hq ADR 0199, ADR 0223). Every line outside this\n# block is the operator's: kept across every push, changed through the node-hostname verbs add and\n# remove, and given back when this module goes. The mesh's names are not here: the mesh's resolver\n# answers them.\n127.0.0.1\tlocalhost\n::1\tlocalhost\n127.0.1.1\t${machine:name}\n"
+      "template": "files/hosts"
     },
     {
       "id": "name",
       "type": "file",
       "path": "/etc/hostname",
       "mode": "0644",
-      "content": "${setting:hostname}\n"
+      "template": "files/hostname"
     }
   ],
   "build": {
@@ -42,6 +50,11 @@
         "loads": [
           "hostname-tools"
         ]
+      },
+      {
+        "name": "files",
+        "kind": "archive",
+        "from": "files"
       }
     ]
   }