mesh-catalog/modules/openrazer/cmd/openrazer-tools/manifest_test.go

package main

import (
	"encoding/json"
	"os"
	"path/filepath"
	"reflect"
	"strings"
	"testing"
)

// openrazer's shape (novox/hq ADR 0207, ADR 0208, ADR 0210): the three official packages of the
// driver, the daemon and its client library, no seat, no display (the daemon needs none), no start of
// its own (D-Bus activation through the package's unit is the one start), nothing of the tray's (the
// polychromatic module's), and the Go bundle serving exactly the listed openrazer_ 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"`
	Contributions []struct {
		Seat    string `json:"seat"`
		Kind    string `json:"kind"`
		Content string `json:"content"`
	} `json:"contributions"`
	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"))
	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 {
		t.Fatalf("module.json: %v", err)
	}
	return m, string(raw)
}

func TestTheToolsAgreeWithTheManifest(t *testing.T) {
	m, raw := readManifest(t)
	served := map[string]bool{}
	for _, tool := range tools() {
		served[tool.Name] = true
		if !strings.HasPrefix(tool.Name, "openrazer_") || strings.TrimSpace(tool.Description) == "" {
			t.Errorf("%s: prefixed %s and described", tool.Name, "openrazer_")
		}
	}
	for _, name := range m.Tools {
		if !served[name] {
			t.Errorf("module.json lists %s, which the bundle does not serve", name)
		}
		delete(served, name)
	}
	for name := range served {
		t.Errorf("the bundle serves %s, which module.json does not list", name)
	}
	if len(m.Build.Artifacts) != 1 {
		t.Fatalf("%v", m.Build.Artifacts)
	}
	b := m.Build.Artifacts[0]
	if b["kind"] != "bundle" || b["language"] != "go" || b["system"] != "arch" ||
		b["from"] != "cmd/openrazer-tools" || b["binary"] != "openrazer-tools" {
		t.Errorf("the Go tools bundle: %v", b)
	}
	s := strings.ToLower(raw)
	for _, never := range []string{"/home/", "jochen", "g14", "shanks", "novox.be", "http", "password", "token"} {
		if strings.Contains(s, never) {
			t.Errorf("module.json names %q", never)
		}
	}
}

func TestItInstallsTheStackAndStartsNothing(t *testing.T) {
	m, raw := readManifest(t)
	if m.Module != "openrazer" || m.Requires != nil || !reflect.DeepEqual(m.Capabilities, []string{"package-manager"}) {
		t.Fatalf("%+v", m)
	}
	var pkgs []string
	var accounts []map[string]any
	for i, r := range m.Resources {
		switch r["type"] {
		case "package":
			if len(accounts) > 0 {
				t.Errorf("a package after the account: the group is the driver's package's to make first: %v", r)
			}
			pkgs = append(pkgs, r["package"].(string))
		case "user":
			accounts = append(accounts, m.Resources[i])
		default:
			t.Errorf("only packages and the account's group: %v", r)
		}
	}
	if !reflect.DeepEqual(pkgs, packages) {
		t.Fatalf("%v", pkgs)
	}
	// The operator's account in the driver's group, and nothing else of the account: its shell and home
	// are the login shell's module's (novox/hq ADR 0252). Written after the packages, so the group the
	// driver's package makes exists when the account is put in it.
	want := map[string]any{"id": "account", "type": "user", "name": "${machine:account}", "groups": []any{group}}
	if len(accounts) != 1 || !reflect.DeepEqual(accounts[0], want) {
		t.Fatalf("the account: %v, want %v", accounts, want)
	}
	if m.Claims != nil || m.Seats != nil || m.Environment != nil || m.Shell != nil || m.Contributions != nil {
		t.Fatal("it holds no seat, sets no environment and adds no start")
	}
	// The tray is polychromatic's, from outside the official repositories; the kernel headers DKMS
	// builds against are the kernel's.
	for _, never := range []string{"polychromatic", "linux-headers", "\"dkms\"", "\"shell\"", "\"home\""} {
		if strings.Contains(raw, never) {
			t.Errorf("module.json names %s", never)
		}
	}
}