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

modules/zfs/cmd/zfs-tools/manifest_test.go

@@ -130,7 +130,7 @@ func TestExactlyOneScrubScheduleAndNoSettingInAUnitFile(t *testing.T) {
 	}
 	for _, c := range []string{"weekly", "monthly"} {
 		d := byID["distribution-"+c]
-		if d["unit"] != "zfs-scrub-"+c+"@${setting:scrub-pool}.timer" || d["state"] != "stopped" || d["boot"] != "disabled" {
+		if d["unit"] != "zfs-scrub-"+c+"@${config:scrub-pool}.timer" || d["state"] != "stopped" || d["boot"] != "disabled" {
 			t.Errorf("the distribution's %s timer: %v", c, d)
 		}
 		if order["scrub-run"] > order["distribution-"+c] {
@@ -143,22 +143,24 @@ func TestExactlyOneScrubScheduleAndNoSettingInAUnitFile(t *testing.T) {
 			t.Errorf("the module writes a unit file of its own: %s", p)
 		}
 	}
-	if strings.Contains(raw, "scrub-day}") && !strings.Contains(byID["scrub-config"]["content"].(string), "${setting:scrub-day}") {
+	// The configuration's text is its template's (novox/hq ADR 0349 §2): the manifest itself names none of them.
+	conf := templateText(t, byID["scrub-config"])
+	if strings.Contains(raw, "scrub-day}") || !strings.Contains(conf, "${config:scrub-day}") {
 		t.Errorf("the day reaches something other than the configuration")
 	}
-	if n := strings.Count(raw, "${setting:scrub-day}") + strings.Count(raw, "${setting:scrub-time}") + strings.Count(raw, "${setting:scrub-cadence}"); n != 3 {
+	if n := strings.Count(conf, "${config:scrub-day}") + strings.Count(conf, "${config:scrub-time}") + strings.Count(conf, "${config:scrub-cadence}"); n != 3 {
 		t.Errorf("the day, time and cadence are written %d times; only into the configuration", n)
 	}
-	var settings struct {
-		Settings map[string]map[string]any `json:"settings"`
+	var declared struct {
+		Config map[string]map[string]any `json:"config"`
 	}
-	json.Unmarshal([]byte(raw), &settings)
-	if settings.Settings["scrub-cadence"]["default"] != "weekly" || settings.Settings["scrub-day"]["default"] != "Mon" ||
-		settings.Settings["scrub-time"]["default"] != "00:00" {
-		t.Errorf("defaults: %v", settings.Settings)
+	json.Unmarshal([]byte(raw), &declared)
+	if declared.Config["scrub-cadence"]["default"] != "weekly" || declared.Config["scrub-day"]["default"] != "Mon" ||
+		declared.Config["scrub-time"]["default"] != "00:00" {
+		t.Errorf("defaults: %v", declared.Config)
 	}
-	if _, has := settings.Settings["scrub-pool"]; has {
-		t.Errorf("the pool is the operator's value, with no default (ADR 0112, ADR 0262)")
+	if p := declared.Config["scrub-pool"]; p["required"] != true || p["default"] != nil {
+		t.Errorf("the pool is the operator's value: required, with no default (ADR 0112, ADR 0348 §4): %v", p)
 	}
 }
 
@@ -166,8 +168,8 @@ func TestExactlyOneScrubScheduleAndNoSettingInAUnitFile(t *testing.T) {
 // operator's choice): the units the node-engine is sent and the configuration the run reads.
 func TestTheHomeServersComposedUnitsAndConfiguration(t *testing.T) {
 	m, _ := readManifest(t)
-	fill := strings.NewReplacer("${setting:scrub-pool}", "storage", "${setting:scrub-cadence}", "monthly",
-		"${setting:scrub-day}", "Mon", "${setting:scrub-time}", "00:00")
+	fill := strings.NewReplacer("${config:scrub-pool}", "storage", "${config:scrub-cadence}", "monthly",
+		"${config:scrub-day}", "Mon", "${config:scrub-time}", "00:00")
 	var units []string
 	var conf string
 	for _, r := range m.Resources {
@@ -177,7 +179,7 @@ func TestTheHomeServersComposedUnitsAndConfiguration(t *testing.T) {
 		case r["type"] == "process" && r["schedule"] != nil:
 			units = append(units, r["name"].(string)+".timer running/enabled (the node-engine's, every quarter of an hour)")
 		case r["id"] == "scrub-config":
-			conf = fill.Replace(r["content"].(string))
+			conf = fill.Replace(templateText(t, r))
 		}
 	}
 	want := []string{"zfs-mesh-scrub.timer running/enabled (the node-engine's, every quarter of an hour)",

modules/zfs/cmd/zfs-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)
+	}
+}