Read each module's own manifest through mesh-sdk's catalogue reader (H-A-498)
The fifteen desktop modules' tools tests failed on every manifest with "json: unknown field class": a test helper copied into each module decoded module.json into its own struct, refusing unknown fields. Manifest strictness is the catalog check's alone, and the manifest's form is a contract read through mesh-sdk's catalogue package, so the copied `manifest` struct and its reader go from the fifteen desktop modules and pacman; each test reads module.json with catalogue.Decode and asserts only the module's own promises (claims, files, tools) on catalogue.Manifest. Builds: design 47 H2 H-A-498, H-A-498 addendum
This commit is contained in:
@@ -1,12 +1,13 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
||||
)
|
||||
|
||||
// slack's shape (novox/hq ADR 0208, ADR 0210, ADR 0212, ADR 0182): no package (Slack comes from the
|
||||
@@ -14,46 +15,17 @@ import (
|
||||
// its own machine; one contribution to node-display-session that is both Slack's one start and its
|
||||
// window rules; and the Go bundle serving exactly the listed slack_ tools.
|
||||
|
||||
type manifest struct {
|
||||
Module string `json:"module"`
|
||||
Version string `json:"version"`
|
||||
Capabilities []string `json:"capabilities"`
|
||||
Requires []string `json:"requires"`
|
||||
Tools []string `json:"tools"`
|
||||
Resources []map[string]any `json:"resources"`
|
||||
Claims []any `json:"claims"`
|
||||
Seats []any `json:"seats"`
|
||||
Shell []any `json:"shell"`
|
||||
Moved bool `json:"moved"`
|
||||
Contributions []any `json:"contributions"`
|
||||
Items []struct {
|
||||
Collection string `json:"collection"`
|
||||
Name string `json:"name"`
|
||||
Template string `json:"template"`
|
||||
} `json:"items"`
|
||||
Environment any `json:"environment"`
|
||||
Build struct {
|
||||
Artifacts []map[string]any `json:"artifacts"`
|
||||
} `json:"build"`
|
||||
}
|
||||
|
||||
func readManifest(t *testing.T) (manifest, string) {
|
||||
t.Helper()
|
||||
raw, err := os.ReadFile(filepath.Join("..", "..", "module.json"))
|
||||
func TestItInstallsNothingAndOwnsNoFile(t *testing.T) {
|
||||
manifestJSON, err := os.ReadFile(filepath.Join("..", "..", "module.json"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
dec := json.NewDecoder(strings.NewReader(string(raw)))
|
||||
dec.DisallowUnknownFields()
|
||||
var m manifest
|
||||
if err := dec.Decode(&m); err != nil {
|
||||
// manifest strictness is the catalog check's (H-A-498): the SDK's reader sets an unknown field aside.
|
||||
m, err := catalogue.Decode(manifestJSON)
|
||||
if err != nil {
|
||||
t.Fatalf("module.json: %v", err)
|
||||
}
|
||||
return m, string(raw)
|
||||
}
|
||||
|
||||
func TestItInstallsNothingAndOwnsNoFile(t *testing.T) {
|
||||
m, raw := readManifest(t)
|
||||
raw := string(manifestJSON)
|
||||
if m.Module != "slack" || !reflect.DeepEqual(m.Requires, []string{"x11-display"}) {
|
||||
t.Fatalf("%+v", m)
|
||||
}
|
||||
@@ -61,7 +33,7 @@ func TestItInstallsNothingAndOwnsNoFile(t *testing.T) {
|
||||
if m.Resources != nil || m.Capabilities != nil {
|
||||
t.Fatalf("no package, no file: %v %v", m.Resources, m.Capabilities)
|
||||
}
|
||||
if m.Claims != nil || m.Seats != nil || m.Environment != nil || m.Shell != nil {
|
||||
if m.Claims != nil || m.DefinesSeats != nil || m.Environment != nil || m.Shell != nil {
|
||||
t.Fatal("it holds no seat, sets no environment and adds no session code")
|
||||
}
|
||||
// Slack's own setting writes ~/.config/autostart/slack.desktop (a link): never the module's.
|
||||
@@ -73,7 +45,15 @@ func TestItInstallsNothingAndOwnsNoFile(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestTheOneContributionIsTheStartAndTheWindowRules(t *testing.T) {
|
||||
m, _ := readManifest(t)
|
||||
manifestJSON, err := os.ReadFile(filepath.Join("..", "..", "module.json"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
// manifest strictness is the catalog check's (H-A-498): the SDK's reader sets an unknown field aside.
|
||||
m, err := catalogue.Decode(manifestJSON)
|
||||
if err != nil {
|
||||
t.Fatalf("module.json: %v", err)
|
||||
}
|
||||
content := displayLines(t, m)
|
||||
if !strings.HasSuffix(content, "\n") {
|
||||
t.Fatalf("%q", content)
|
||||
@@ -121,7 +101,16 @@ func TestTheOneContributionIsTheStartAndTheWindowRules(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestTheToolsAgreeWithTheManifest(t *testing.T) {
|
||||
m, raw := readManifest(t)
|
||||
manifestJSON, err := os.ReadFile(filepath.Join("..", "..", "module.json"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
// manifest strictness is the catalog check's (H-A-498): the SDK's reader sets an unknown field aside.
|
||||
m, err := catalogue.Decode(manifestJSON)
|
||||
if err != nil {
|
||||
t.Fatalf("module.json: %v", err)
|
||||
}
|
||||
raw := string(manifestJSON)
|
||||
served := map[string]bool{}
|
||||
for _, tool := range tools() {
|
||||
served[tool.Name] = true
|
||||
@@ -142,8 +131,8 @@ func TestTheToolsAgreeWithTheManifest(t *testing.T) {
|
||||
t.Fatalf("%v", m.Build.Artifacts)
|
||||
}
|
||||
b := m.Build.Artifacts[0]
|
||||
if b["kind"] != "bundle" || b["language"] != "go" || b["system"] != "arch" ||
|
||||
b["from"] != "cmd/slack-tools" || b["binary"] != "slack-tools" {
|
||||
if b.Kind != "bundle" || b.Language != "go" || b.System != "arch" ||
|
||||
b.From != "cmd/slack-tools" || b.Binary != "slack-tools" {
|
||||
t.Errorf("the Go tools bundle: %v", b)
|
||||
}
|
||||
s := strings.ToLower(raw)
|
||||
@@ -156,7 +145,7 @@ func TestTheToolsAgreeWithTheManifest(t *testing.T) {
|
||||
|
||||
// displayLines is the module's lines for the window manager: the text of the template of its one item of the
|
||||
// collection contribution:node-display-session:config (design 57 L3, issue 848).
|
||||
func displayLines(t *testing.T, m manifest) string {
|
||||
func displayLines(t *testing.T, m catalogue.Manifest) string {
|
||||
t.Helper()
|
||||
if !m.Moved || len(m.Contributions) != 0 || len(m.Items) != 1 ||
|
||||
m.Items[0].Collection != "contribution:node-display-session:config" {
|
||||
|
||||
@@ -7,6 +7,8 @@ import (
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
||||
)
|
||||
|
||||
// Slack's settings as Slack writes them, with keys no answer may carry.
|
||||
@@ -108,7 +110,15 @@ func newSlack(t *testing.T) (*fake, map[string]string) {
|
||||
}
|
||||
|
||||
func contribution(t *testing.T) string {
|
||||
m, _ := readManifest(t)
|
||||
manifestJSON, err := os.ReadFile(filepath.Join("..", "..", "module.json"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
// manifest strictness is the catalog check's (H-A-498): the SDK's reader sets an unknown field aside.
|
||||
m, err := catalogue.Decode(manifestJSON)
|
||||
if err != nil {
|
||||
t.Fatalf("module.json: %v", err)
|
||||
}
|
||||
return displayLines(t, m)
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user