simslim-mirror/profiles_test.go

package simslim

import (
	"reflect"
	"strings"
	"testing"
)

// forbiddenLabels deadlock or wedge a simulator when disabled and must never be
// managed. nanoregistryd wedges CoreSimulator so every simctl operation hangs;
// sleepd makes SpringBoard retry-storm itself to death; the rest were observed
// to break boot. They are deliberately absent from Categories.
var forbiddenLabels = []string{
	"com.apple.nanoregistryd",
	"com.apple.nanoregistrylaunchd",
	"com.apple.nanoprefsyncd.2",
	"com.apple.nanotimekitcompaniond",
	"com.apple.nanobackupd",
	"com.apple.sleepd",
	"com.apple.appprotectiond",
	"com.apple.ManagedSettingsAgent",
	"com.apple.managedconfiguration.profiled",
	"com.apple.mobiletimerd",
	"com.apple.routined",
	"com.apple.biomed",
	"com.apple.biomesyncd",
	"com.apple.dmd",
	"com.apple.donotdisturbd",
}

func TestManagedExcludesForbidden(t *testing.T) {
	managed := managedSet()
	for _, l := range forbiddenLabels {
		if managed[l] {
			t.Errorf("forbidden daemon %q is in a category; it must never be managed", l)
		}
	}
}

func TestNoDuplicateLabels(t *testing.T) {
	seen := map[string]string{}
	for _, c := range Categories {
		for _, l := range c.Labels {
			if prev, ok := seen[l]; ok {
				t.Errorf("label %q appears in both %q and %q", l, prev, c.ID)
			}
			seen[l] = c.ID
		}
	}
}

func TestEveryServiceHasShortDescription(t *testing.T) {
	known := map[string]bool{}
	for _, category := range Categories {
		if len(category.ServiceDescriptions) != len(category.Labels) {
			t.Errorf("category %q has %d labels but %d service descriptions", category.ID, len(category.Labels), len(category.ServiceDescriptions))
		}
		for _, label := range category.Labels {
			known[label] = true
			description, ok := category.ServiceDescriptions[label]
			if !ok || strings.TrimSpace(description) == "" {
				t.Errorf("service %q has no user-facing description", label)
			}
			if strings.ContainsAny(description, "\r\n") {
				t.Errorf("service %q description must stay on one logical line", label)
			}
			if len(description) > 90 {
				t.Errorf("service %q description is too long (%d characters)", label, len(description))
			}
		}
	}
	for label := range serviceDescriptionByLabel {
		if !known[label] {
			t.Errorf("description exists for unmanaged service %q", label)
		}
	}
}

func TestRequiredEnabledLabelsAreNeverSlimmed(t *testing.T) {
	slimmable := SlimmableSet()
	managed := managedSet()
	profile := Profile{ExceptCategories: map[string]bool{}, Keep: map[string]bool{}}
	desired := profile.Desired()
	for _, category := range Categories {
		for _, service := range category.AlwaysEnabled {
			if slimmable[service.Label] || desired[service.Label] {
				t.Errorf("required daemon %q is included in a slim profile", service.Label)
			}
			if !managed[service.Label] {
				t.Errorf("required daemon %q is missing from the repair allowlist", service.Label)
			}
			if service.Reason == "" {
				t.Errorf("required daemon %q has no user-facing reason", service.Label)
			}
		}
	}
}

func TestDeltaRepairsRequiredEnabledLabels(t *testing.T) {
	current := map[string]bool{"com.apple.sharingd": true}
	desired := Profile{ExceptCategories: map[string]bool{}, Keep: map[string]bool{}}.Desired()
	toDisable, toEnable := delta(current, desired, managedSet())
	if len(toDisable) == 0 {
		t.Fatal("full profile should still disable slimmable labels")
	}
	if !reflect.DeepEqual(toEnable, []string{"com.apple.sharingd"}) {
		t.Errorf("toEnable = %v, want [com.apple.sharingd]", toEnable)
	}
}

func TestCategoriesHaveUserImpactMetadata(t *testing.T) {
	for _, c := range Categories {
		if c.Downside == "" {
			t.Errorf("category %q has no downside description", c.ID)
		}
		if c.ApproxMemoryMB <= 0 {
			t.Errorf("category %q has invalid approximate memory %d MB", c.ID, c.ApproxMemoryMB)
		}
	}
}

func TestCategoryByID(t *testing.T) {
	for _, c := range Categories {
		got, ok := CategoryByID(c.ID)
		if !ok {
			t.Errorf("CategoryByID(%q) not found", c.ID)
			continue
		}
		if got.ID != c.ID {
			t.Errorf("CategoryByID(%q) returned category %q", c.ID, got.ID)
		}
	}
	if _, ok := CategoryByID("nope"); ok {
		t.Error("CategoryByID(\"nope\") should not resolve an unknown ID")
	}
}

func TestDelta(t *testing.T) {
	managed := map[string]bool{"a": true, "b": true, "c": true}
	cases := []struct {
		name             string
		current, desired map[string]bool
		wantDisable      []string
		wantEnable       []string
	}{
		{
			name:        "enable all from stock",
			current:     map[string]bool{},
			desired:     map[string]bool{"a": true, "b": true, "c": true},
			wantDisable: []string{"a", "b", "c"},
		},
		{
			name:       "restore all to stock",
			current:    map[string]bool{"a": true, "b": true, "c": true},
			desired:    map[string]bool{},
			wantEnable: []string{"a", "b", "c"},
		},
		{
			name:    "already in desired state",
			current: map[string]bool{"a": true, "b": true},
			desired: map[string]bool{"a": true, "b": true},
		},
		{
			name:        "profile edit adds and removes",
			current:     map[string]bool{"a": true, "b": true},
			desired:     map[string]bool{"b": true, "c": true},
			wantDisable: []string{"c"},
			wantEnable:  []string{"a"},
		},
		{
			name:    "unmanaged desired label is ignored",
			current: map[string]bool{},
			desired: map[string]bool{"x": true},
		},
		{
			name:    "unmanaged disabled label is left alone",
			current: map[string]bool{"x": true},
			desired: map[string]bool{},
		},
	}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			gotDisable, gotEnable := delta(tc.current, tc.desired, managed)
			if !equalSlices(gotDisable, tc.wantDisable) {
				t.Errorf("toDisable = %v, want %v", gotDisable, tc.wantDisable)
			}
			if !equalSlices(gotEnable, tc.wantEnable) {
				t.Errorf("toEnable = %v, want %v", gotEnable, tc.wantEnable)
			}
		})
	}
}

func equalSlices(a, b []string) bool {
	if len(a) == 0 && len(b) == 0 {
		return true
	}
	return reflect.DeepEqual(a, b)
}