LocalAI/core/services/addons/manager_test.go

// SPDX-License-Identifier: MIT
package addons

import (
	"archive/tar"
	"bytes"
	"context"
	"crypto/sha256"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"io/fs"
	"net/http"
	"net/http/httptest"
	"os"
	"path/filepath"
	"strings"
	"sync"
	"sync/atomic"
	"testing"
	"time"

	"github.com/mudler/LocalAI/core/services/addons/catalog"
	"github.com/mudler/LocalAI/core/services/addons/packages"
	"github.com/mudler/LocalAI/core/services/studio/files"
	"github.com/mudler/LocalAI/core/services/studio/workspace/blob"
	"github.com/mudler/LocalAI/core/services/studio/workspace/gormstore"
	"github.com/mudler/LocalAI/pkg/addons/contract"
	"github.com/mudler/LocalAI/pkg/sqlitedb"
	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"
	"gorm.io/gorm"
)

func TestLifecycle(t *testing.T) {
	// The owner pins every component of its root and refuses a symbolic link on
	// the path. A temporary directory on macOS lies behind one, so the specs use
	// its resolved path.
	if dir, err := filepath.EvalSymlinks(os.TempDir()); err == nil {
		t.Setenv("TMPDIR", dir)
	}
	RegisterFailHandler(Fail)
	RunSpecs(t, "Addon lifecycle")
}

var ctx = context.Background()
var actor = contract.Actor{UserID: "admin", CredentialID: "key", Mode: "named-user"}

func fixture() (OwnerConfig, catalog.Catalog, *packages.Installer) {
	manifest, e := os.ReadFile("../../../tests/addons/fixtures/packages/manifest.json")
	Expect(e).NotTo(HaveOccurred())
	return fixtureFor(manifest)
}

// uiFixture is the package fixture with a UI that accepts the given SDK range.
func uiFixture(min, max uint64) (OwnerConfig, catalog.Catalog, *packages.Installer) {
	manifest, e := os.ReadFile("../../../tests/addons/fixtures/packages/manifest.json")
	Expect(e).NotTo(HaveOccurred())
	var m contract.Manifest
	Expect(json.Unmarshal(manifest, &m)).To(Succeed())
	m.Capabilities.UI = &contract.UI{Entry: "ui.js", SDK: contract.VersionRange{Min: min, Max: max}, Pages: []string{"home"}, MainPage: "home"}
	manifest, e = json.Marshal(m)
	Expect(e).NotTo(HaveOccurred())
	return fixtureFor(manifest)
}

func fixtureFor(manifest []byte) (OwnerConfig, catalog.Catalog, *packages.Installer) {
	return fixtureWithDigest(manifest, "")
}

// fixtureWithDigest is fixtureFor with a library that lists the given digest
// for the package, so the package it serves does not match its entry.
func fixtureWithDigest(manifest []byte, digest string) (OwnerConfig, catalog.Catalog, *packages.Installer) {
	return fixtureWithFiles(manifest, digest, nil)
}

// fixtureWithFiles is fixtureWithDigest with more package files, which are
// not executable.
func fixtureWithFiles(manifest []byte, digest string, files map[string][]byte) (OwnerConfig, catalog.Catalog, *packages.Installer) {
	root := GinkgoT().TempDir()
	var e error
	var b bytes.Buffer
	tw := tar.NewWriter(&b)
	for name, data := range map[string][]byte{"manifest.json": manifest, "bin/sample": []byte("binary"), "ui.js": []byte("export {}")} {
		Expect(tw.WriteHeader(&tar.Header{Name: name, Mode: 0755, Size: int64(len(data))})).To(Succeed())
		_, e = tw.Write(data)
		Expect(e).NotTo(HaveOccurred())
	}
	for name, data := range files {
		Expect(tw.WriteHeader(&tar.Header{Name: name, Mode: 0644, Size: int64(len(data))})).To(Succeed())
		_, e = tw.Write(data)
		Expect(e).NotTo(HaveOccurred())
	}
	Expect(tw.Close()).To(Succeed())
	artifact := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { _, _ = w.Write(b.Bytes()) }))
	DeferCleanup(artifact.Close)
	if digest == "" {
		digest = fmt.Sprintf("sha256:%x", sha256.Sum256(b.Bytes()))
	}
	release := catalog.Release{ID: "sample", Name: "Sample", Version: "1.2.3", Artifact: artifact.URL + "/package.tar", Digest: digest, OS: "linux", Arch: "amd64"}
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		_ = catalog.WriteIndex(w, []catalog.Release{release})
	}))
	DeferCleanup(server.Close)
	sources, e := catalog.NewSources(filepath.Join(root, "sources.json"), admin, catalog.CredentialResolver{})
	Expect(e).NotTo(HaveOccurred())
	Expect(sources.Save(ctx, actor, catalog.Source{ID: "test", Name: "Test", URL: server.URL, Enabled: true, AllowLoopbackHTTP: true})).To(Succeed())
	_, e = sources.Refresh(ctx, "test")
	Expect(e).NotTo(HaveOccurred())
	c := catalog.Catalog{Sources: sources, TargetOS: "linux", TargetArch: "amd64"}
	cfg := OwnerConfig{InstanceID: "owner", OwnerID: "owner", OwnerAddress: "https://owner.example", StorageID: "disk-one", Root: filepath.Join(root, "owner")}
	i := &packages.Installer{Root: filepath.Join(cfg.Root, "packages"), Catalog: c, Host: contract.HostCompatibility{Host: 1, API: 1, Protocol: 1, SDK: 1, DataFormat: 1, OS: "linux", Arch: "amd64"}}
	DeferCleanup(func() {
		_ = filepath.Walk(root, func(p string, info os.FileInfo, e error) error {
			if e == nil && info.IsDir() {
				_ = os.Chmod(p, 0700)
			}
			return nil
		})
	})
	return cfg, c, i
}
func admin(_ context.Context, a contract.Actor) error {
	if a != actor {
		return errors.New("denied")
	}
	return nil
}
func open(cfg OwnerConfig, c catalog.Catalog, i *packages.Installer) *Manager {
	m, e := NewManager(ctx, cfg, c, i, admin)
	Expect(e).NotTo(HaveOccurred())
	DeferCleanup(func() { Expect(m.Close()).To(Succeed()) })
	return m
}
func command(id, action string) LifecycleCommand {
	return LifecycleCommand{OperationID: id, AddonID: "sample", Action: action, SourceID: "test", Version: "1.2.3"}
}

var _ = Describe("a package that does not match its library entry", func() {
	It("fails the install and says the package could not be verified, without installing anything", func() {
		manifest, e := os.ReadFile("../../../tests/addons/fixtures/packages/manifest.json")
		Expect(e).NotTo(HaveOccurred())
		cfg, c, i := fixtureWithDigest(manifest, "sha256:"+strings.Repeat("0", 64))
		m := open(cfg, c, i)
		_, e = m.Submit(ctx, actor, command("op-digest", "install"))
		Expect(e).To(MatchError(ErrOperationFailed))
		Expect(e).To(MatchError(packages.ErrPackage))
		Expect(m.journal.Addons["sample"].Installed).To(BeFalse())
	})
})

var _ = Describe("designated owner lifecycle", func() {
	It("carries the SDK refusal text to the caller of a failed install and keeps the generic error", func() {
		cfg, c, i := uiFixture(2, 2) // the installer host provides SDK 1
		m := open(cfg, c, i)
		_, e := m.Submit(ctx, actor, command("op-sdk", "install"))
		Expect(e).To(MatchError(ErrOperationFailed))
		Expect(e.Error()).To(ContainSubstring("the add-on needs SDK 2 to 2 and this host provides SDK 1"))
		// The same operation ID again returns the stored failure, without the text.
		_, e = m.Submit(ctx, actor, command("op-sdk", "install"))
		Expect(e).To(MatchError(ErrOperationFailed))
		Expect(e.Error()).NotTo(ContainSubstring("SDK"))
	})

	It("installs an add-on whose SDK range contains the host SDK", func() {
		cfg, c, i := uiFixture(1, 2)
		m := open(cfg, c, i)
		st, e := m.Submit(ctx, actor, command("op-sdk-ok", "install"))
		Expect(e).NotTo(HaveOccurred())
		Expect(st.Phase).To(Equal("completed"))
	})

	It("rejects symlinked package roots without touching external staging", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		external := GinkgoT().TempDir()
		stage := filepath.Join(external, "stage-sentinel")
		DeferCleanup(func() { _ = os.Chmod(stage, 0700) })
		Expect(os.Mkdir(stage, 0700)).To(Succeed())
		sentinel := filepath.Join(stage, "keep")
		Expect(os.WriteFile(sentinel, []byte("keep"), 0400)).To(Succeed())
		Expect(os.Chmod(stage, 0500)).To(Succeed())
		Expect(os.Symlink(external, i.Root)).To(Succeed())
		err := m.Reconcile(ctx)
		data, e := os.ReadFile(sentinel)
		Expect(e).NotTo(HaveOccurred())
		Expect(string(data)).To(Equal("keep"))
		info, e := os.Stat(stage)
		Expect(e).NotTo(HaveOccurred())
		Expect(info.Mode().Perm()).To(Equal(os.FileMode(0500)))
		Expect(err).To(HaveOccurred())
	})

	It("recovers every durable journal boundary without replaying publication", func() {
		for _, boundary := range []string{"intent", "published", "prepared", "applied", "completed"} {
			cfg, c, i := fixture()
			m := open(cfg, c, i)
			m.boundary = func(phase string) error {
				if phase == boundary {
					return errors.New("crash")
				}
				return nil
			}
			_, e := m.Submit(ctx, actor, command("install", "install"))
			Expect(e).To(HaveOccurred())
			Expect(m.Close()).To(Succeed())
			m = open(cfg, c, i)
			Expect(m.Reconcile(ctx)).To(Succeed())
			s, e := m.Status(ctx, "sample")
			Expect(e).NotTo(HaveOccurred())
			Expect(s.Installed).To(Equal(boundary != "intent" && boundary != "published"))
			Expect(s.ObservedHealth).To(Equal("stopped"))
			op, e := m.Submit(ctx, actor, command("install", "install"))
			if boundary == "intent" || boundary == "published" {
				Expect(e).To(MatchError(ErrOperationFailed))
				Expect(op.Phase).To(Equal("failed"))
			} else {
				Expect(e).NotTo(HaveOccurred())
				Expect(op.Phase).To(Equal("completed"))
				Expect(s.Generation).To(Equal(uint64(1)))
			}
		}
	})
	It("removes abandoned staging without removing published packages on recovery", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		abandoned := filepath.Join(i.Root, "stage-abandoned")
		Expect(os.MkdirAll(abandoned, 0700)).To(Succeed())
		Expect(os.WriteFile(filepath.Join(abandoned, "partial"), []byte("partial"), 0400)).To(Succeed())
		Expect(os.Chmod(abandoned, 0500)).To(Succeed())
		_, e := m.Submit(ctx, actor, command("one", "install"))
		Expect(e).NotTo(HaveOccurred())
		s, e := m.Status(ctx, "sample")
		Expect(e).NotTo(HaveOccurred())
		Expect(m.Reconcile(ctx)).To(Succeed())
		Expect(abandoned).NotTo(BeADirectory())
		Expect(s.Generations[0].Receipt.Directory).To(BeADirectory())
	})
	It("keeps immutable history on successful upgrade and reinstallation", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		for n, action := range []string{"install", "upgrade", "uninstall", "install"} {
			_, e := m.Submit(ctx, actor, command(fmt.Sprint(n), action))
			Expect(e).NotTo(HaveOccurred())
		}
		s, e := m.Status(ctx, "sample")
		Expect(e).NotTo(HaveOccurred())
		Expect(s.Generation).To(Equal(uint64(3)))
		Expect(s.Generations).To(HaveLen(3))
		for n, g := range s.Generations {
			Expect(g.Number).To(Equal(uint64(n + 1)))
			Expect(filepath.Join(g.Receipt.Directory, "receipt.json")).To(BeAnExistingFile())
		}
	})

	It("stamps the first install, keeps the time over an upgrade and stamps it again after an uninstall", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		_, e := m.Submit(ctx, actor, command("0", "install"))
		Expect(e).NotTo(HaveOccurred())
		s, e := m.Status(ctx, "sample")
		Expect(e).NotTo(HaveOccurred())
		first, perr := time.Parse(time.RFC3339, s.InstalledAt)
		Expect(perr).NotTo(HaveOccurred())
		Expect(s.InstalledAt).To(HaveSuffix("Z"), "UTC")
		Expect(first).To(BeTemporally("~", time.Now(), time.Minute))
		_, e = m.Submit(ctx, actor, command("1", "upgrade"))
		Expect(e).NotTo(HaveOccurred())
		s, _ = m.Status(ctx, "sample")
		Expect(s.Generation).To(Equal(uint64(2)))
		Expect(s.InstalledAt).To(Equal(first.UTC().Format(time.RFC3339)))
		list, e := m.Installed(ctx, actor)
		Expect(e).NotTo(HaveOccurred())
		Expect(list[0].InstalledAt).To(Equal(s.InstalledAt))
		_, e = m.Submit(ctx, actor, command("2", "uninstall"))
		Expect(e).NotTo(HaveOccurred())
		_, e = m.Submit(ctx, actor, command("3", "install"))
		Expect(e).NotTo(HaveOccurred())
		s, _ = m.Status(ctx, "sample")
		again, perr := time.Parse(time.RFC3339, s.InstalledAt)
		Expect(perr).NotTo(HaveOccurred())
		Expect(again).To(BeTemporally(">=", first))
	})

	It("excludes competing owners and rejects conflicting durable identities", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		_, e := NewManager(ctx, cfg, c, i, admin)
		Expect(e).To(HaveOccurred())
		Expect(m.Close()).To(Succeed())
		cfg.StorageID = "other"
		_, e = NewManager(ctx, cfg, c, i, admin)
		Expect(e).To(HaveOccurred())
		cfg.StorageID = "disk-one"
		cfg.OwnerID = "other"
		cfg.InstanceID = "other"
		_, e = NewManager(ctx, cfg, c, i, admin)
		Expect(e).To(HaveOccurred())
	})
	It("never opens replica roots or elects an absent owner", func() {
		cfg, c, i := fixture()
		cfg.InstanceID = "frontend"
		cfg.Root = filepath.Join(cfg.Root, "must-not-exist")
		m := open(cfg, c, i)
		_, e := m.Submit(ctx, actor, command("x", "install"))
		Expect(e).To(MatchError(ErrNotOwner))
		_, e = m.Status(ctx, "sample")
		Expect(e).To(MatchError(ErrNotOwner))
		Expect(m.Reconcile(ctx)).To(MatchError(ErrNotOwner))
		Expect(cfg.Root).NotTo(BeADirectory())
		cfg.SharedStorage = true
		_, e = NewManager(ctx, cfg, c, i, admin)
		Expect(e).To(HaveOccurred())
		cfg.SharedStorage = false
		cfg.OwnerID = ""
		_, e = NewManager(ctx, cfg, c, i, admin)
		Expect(e).To(HaveOccurred())
	})
	It("needs a state root for the owner only", func() {
		cfg, c, i := fixture()
		cfg.InstanceID = "frontend"
		cfg.Root = ""
		m := open(cfg, c, i)
		_, e := m.Status(ctx, "sample")
		Expect(e).To(MatchError(ErrNotOwner))
		cfg.InstanceID = cfg.OwnerID
		_, e = NewManager(ctx, cfg, c, i, admin)
		Expect(e).To(MatchError(ErrConfiguration))
		cfg.Root = "relative/root"
		_, e = NewManager(ctx, cfg, c, i, admin)
		Expect(e).To(MatchError(ErrConfiguration))
	})
	It("refuses commands and asset reads for an add-on ID the host serves as a route", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		for _, id := range contract.ReservedAddonIDs() {
			cmd := command("reserved-"+id, "install")
			cmd.AddonID = id
			_, e := m.Submit(ctx, actor, cmd)
			Expect(e).To(MatchError(ErrConflict), id)
			_, e = m.CatalogDetails(ctx, actor, "local", id, "1.0.0")
			Expect(e).To(HaveOccurred(), id)
		}
	})
	It("binds duplicate operation IDs to actor and command and serializes conflicts", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		cmd := command("one", "install")
		a, e := m.Submit(ctx, actor, cmd)
		Expect(e).NotTo(HaveOccurred())
		b, e := m.Submit(ctx, actor, cmd)
		Expect(e).NotTo(HaveOccurred())
		Expect(b).To(Equal(a))
		cmd.Action = "uninstall"
		_, e = m.Submit(ctx, actor, cmd)
		Expect(e).To(MatchError(ErrConflict))
		var wg sync.WaitGroup
		for _, action := range []string{"enable", "disable"} {
			wg.Add(1)
			go func(action string) {
				defer GinkgoRecover()
				defer wg.Done()
				_, e := m.Submit(ctx, actor, command(action, action))
				Expect(e).NotTo(HaveOccurred())
			}(action)
		}
		wg.Wait()
		s, e := m.Status(ctx, "sample")
		Expect(e).NotTo(HaveOccurred())
		Expect(s.Generation).To(Equal(uint64(1)))
	})
	It("retains generations identity data and grants across uninstall and restart", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		_, e := m.Submit(ctx, actor, command("one", "install"))
		Expect(e).NotTo(HaveOccurred())
		s, e := m.Status(ctx, "sample")
		Expect(e).NotTo(HaveOccurred())
		Expect(os.MkdirAll(s.DataDirectory, 0700)).To(Succeed())
		Expect(os.WriteFile(filepath.Join(s.DataDirectory, "sentinel"), []byte("data"), 0600)).To(Succeed())
		Expect(os.WriteFile(s.GrantsPath, []byte("grants"), 0600)).To(Succeed())
		_, e = m.Submit(ctx, actor, command("two", "enable"))
		Expect(e).NotTo(HaveOccurred())
		Expect(m.Close()).To(Succeed())
		m = open(cfg, c, i)
		Expect(m.Reconcile(ctx)).To(Succeed())
		enabled, e := m.Status(ctx, "sample")
		Expect(e).NotTo(HaveOccurred())
		Expect(enabled.DesiredEnabled).To(BeTrue())
		Expect(enabled.StartEligible).To(BeTrue())
		Expect(enabled.ObservedHealth).To(Equal("stopped"))
		_, e = m.Submit(ctx, actor, command("three", "uninstall"))
		Expect(e).NotTo(HaveOccurred())
		after, e := m.Status(ctx, "sample")
		Expect(e).NotTo(HaveOccurred())
		Expect(after.Installed).To(BeFalse())
		Expect(after.DesiredEnabled).To(BeFalse())
		Expect(after.Identity).To(Equal(s.Identity))
		Expect(after.Generations).To(Equal(s.Generations))
		Expect(filepath.Join(s.DataDirectory, "sentinel")).To(BeAnExistingFile())
		Expect(s.GrantsPath).To(BeAnExistingFile())
		Expect(s.Generations[0].Receipt.Directory).To(BeADirectory())
	})
	It("preserves old packages and active generation on manager upgrade failure", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		_, e := m.Submit(ctx, actor, command("one", "install"))
		Expect(e).NotTo(HaveOccurred())
		before, e := m.Status(ctx, "sample")
		Expect(e).NotTo(HaveOccurred())
		i.MaxBytes = 1
		_, e = m.Submit(ctx, actor, command("two", "upgrade"))
		Expect(e).To(HaveOccurred())
		after, e := m.Status(ctx, "sample")
		Expect(e).NotTo(HaveOccurred())
		Expect(after).To(Equal(before))
		Expect(filepath.Join(before.Generations[0].Receipt.Directory, "bin/sample")).To(BeAnExistingFile())
	})
	It("requires current authoritative administration even for idempotent retries", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		_, e := m.Submit(ctx, contract.Actor{UserID: "admin", Mode: "admin"}, command("one", "install"))
		Expect(e).To(MatchError(ErrForbidden))
		_, e = m.Submit(ctx, actor, command("one", "install"))
		Expect(e).NotTo(HaveOccurred())
		m.admin = func(context.Context, contract.Actor) error { return errors.New("revoked") }
		_, e = m.Submit(ctx, actor, command("one", "install"))
		Expect(e).To(MatchError(ErrForbidden))
	})
})

var _ = Describe("read-only lifecycle operation lookup", func() {
	It("binds lifecycle lookup to current admin and original actor without writes or repair", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		_, e := m.Submit(ctx, actor, command("lookup-install", "install"))
		Expect(e).NotTo(HaveOccurred())
		before, e := os.ReadFile(filepath.Join(cfg.Root, "journal.json"))
		Expect(e).NotTo(HaveOccurred())
		m.boundary = func(string) error { Fail("lookup must not persist"); return nil }
		s, e := m.OperationStatus(ctx, actor, "lookup-install")
		Expect(e).NotTo(HaveOccurred())
		Expect(s.Phase).To(Equal("completed"))
		Expect(s.RuntimeState).To(Equal("not-observed"))
		s.AddonID = "changed"
		s, e = m.OperationStatus(ctx, actor, "lookup-install")
		Expect(e).NotTo(HaveOccurred())
		Expect(s.AddonID).To(Equal("sample"))
		_, e = m.OperationStatus(ctx, actor, "missing")
		Expect(e).To(Equal(ErrOperationNotFound))
		other := actor
		other.UserID = "other"
		m.admin = func(context.Context, contract.Actor) error { return nil }
		_, e = m.OperationStatus(ctx, other, "lookup-install")
		Expect(e).To(Equal(ErrOperationNotFound))
		op := m.journal.Operations["lookup-install"]
		op.Actor = contract.Actor{}
		m.journal.Operations["legacy"] = op
		_, e = m.OperationStatus(ctx, actor, "legacy")
		Expect(e).To(Equal(ErrOperationNotFound))
		m.runtimeRecoveryRequired = true
		s, e = m.OperationStatus(ctx, actor, "lookup-install")
		Expect(e).NotTo(HaveOccurred())
		Expect(s.RuntimeState).To(Equal("recovery-required"))
		m.admin = func(context.Context, contract.Actor) error { return ErrForbidden }
		_, e = m.OperationStatus(ctx, actor, "lookup-install")
		Expect(e).To(Equal(ErrForbidden))
		after, e := os.ReadFile(filepath.Join(cfg.Root, "journal.json"))
		Expect(e).NotTo(HaveOccurred())
		Expect(after).To(Equal(before))
	})
})

var _ = Describe("cancellable operation observation", func() {
	It("cancels status lookup while a lifecycle writer holds the journal lock", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		m.mu.Lock()
		ctx, cancel := context.WithCancel(context.Background())
		cancel()
		done := make(chan error, 1)
		go func() { _, e := m.OperationStatus(ctx, actor, "unknown"); done <- e }()
		defer m.mu.Unlock()
		Eventually(done).Should(Receive(Equal(context.Canceled)))
	})
})

var _ = Describe("owner identity file", func() {
	acquire := func(cfg OwnerConfig) error {
		release, e := (OwnerGuard{Config: cfg}).Acquire(ctx)
		if e == nil {
			Expect(release()).To(Succeed())
		}
		return e
	}
	identityPath := func(cfg OwnerConfig) string { return filepath.Join(cfg.Root, "identity.json") }

	It("writes the owner and storage only, with no address", func() {
		cfg, _, _ := fixture()
		Expect(acquire(cfg)).To(Succeed())
		b, e := os.ReadFile(identityPath(cfg))
		Expect(e).NotTo(HaveOccurred())
		var fields map[string]any
		Expect(json.Unmarshal(b, &fields)).To(Succeed())
		Expect(fields).To(Equal(map[string]any{"OwnerID": "owner", "StorageID": "disk-one"}))
	})
	It("loads a file written in the old format with an address", func() {
		cfg, _, _ := fixture()
		Expect(os.MkdirAll(cfg.Root, 0700)).To(Succeed())
		Expect(os.WriteFile(identityPath(cfg), []byte(`{"OwnerID":"owner","Address":"https://old.example","StorageID":"disk-one"}`), 0600)).To(Succeed())
		Expect(acquire(cfg)).To(Succeed())
	})
	It("loads when only the address changed", func() {
		cfg, _, _ := fixture()
		Expect(acquire(cfg)).To(Succeed())
		cfg.OwnerAddress = "https://moved.example:8443"
		Expect(acquire(cfg)).To(Succeed())
	})
	It("refuses a changed owner ID", func() {
		cfg, _, _ := fixture()
		Expect(acquire(cfg)).To(Succeed())
		cfg.OwnerID, cfg.InstanceID = "owner-two", "owner-two"
		Expect(acquire(cfg)).To(MatchError(ErrConfiguration))
	})
	It("refuses a changed storage ID", func() {
		cfg, _, _ := fixture()
		Expect(acquire(cfg)).To(Succeed())
		cfg.StorageID = "disk-two"
		Expect(acquire(cfg)).To(MatchError(ErrConfiguration))
	})
})

// failureCode is the code of the typed cause of a failed operation, or "".
func failureCode(e error) string {
	var c *FailureCause
	if errors.As(e, &c) {
		return c.Code
	}
	return ""
}

var _ = Describe("the cause of a failed install", func() {
	// withSource adds a library with the given ID and URL to the fixture.
	withSource := func(c catalog.Catalog, id, url string) {
		Expect(c.Sources.Save(ctx, actor, catalog.Source{ID: id, Name: id, URL: url, Enabled: true, AllowLoopbackHTTP: true})).To(Succeed())
	}
	// only makes the fixture's own library stop listing the add-on, so that a
	// second library with the same index does not conflict with it.
	only := func(c catalog.Catalog, url string) {
		Expect(c.Sources.Save(ctx, actor, catalog.Source{ID: "test", Name: "test", URL: url, Enabled: false, AllowLoopbackHTTP: true})).To(Succeed())
	}
	libraryURL := func(c catalog.Catalog) string {
		s, e := c.Sources.Get(ctx, actor, "test")
		Expect(e).NotTo(HaveOccurred())
		return s.URL
	}

	It("names a release that the library does not list", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		cmd := command("op-missing", "install")
		cmd.Version = "9.9.9"
		_, e := m.Submit(ctx, actor, cmd)
		Expect(e).To(MatchError(ErrOperationFailed))
		Expect(failureCode(e)).To(Equal(CauseReleaseNotFound))
	})

	It("names two libraries that list the same add-on", func() {
		cfg, c, i := fixture()
		withSource(c, "twin", libraryURL(c))
		_, e := c.Sources.Refresh(ctx, "twin")
		Expect(e).NotTo(HaveOccurred())
		m := open(cfg, c, i)
		_, e = m.Submit(ctx, actor, command("op-twin", "install"))
		Expect(e).To(MatchError(ErrOperationFailed))
		Expect(failureCode(e)).To(Equal(CauseLibraryConflict))
	})

	It("names a library that cannot be read", func() {
		cfg, c, i := fixture()
		dead := httptest.NewServer(http.NotFoundHandler())
		url := dead.URL
		dead.Close()
		withSource(c, "dead", url)
		m := open(cfg, c, i)
		cmd := command("op-dead", "install")
		cmd.SourceID = "dead"
		_, e := m.Submit(ctx, actor, cmd)
		Expect(e).To(MatchError(ErrOperationFailed))
		Expect(failureCode(e)).To(Equal(CauseLibraryUnavailable))
	})

	It("reads the library on demand when the startup refresh has not filled the cache", func() {
		cfg, c, i := fixture()
		url := libraryURL(c)
		only(c, url)
		withSource(c, "cold", url) // never refreshed
		m := open(cfg, c, i)
		cmd := command("op-cold", "install")
		cmd.SourceID = "cold"
		_, e := m.Submit(ctx, actor, cmd)
		Expect(e).NotTo(HaveOccurred())
		Expect(m.journal.Addons["sample"].Installed).To(BeTrue())
	})

	It("reads the library again when the startup refresh failed", func() {
		cfg, c, i := fixture()
		upstream := libraryURL(c)
		only(c, upstream)
		var calls atomic.Int32
		flaky := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
			if calls.Add(1) == 1 {
				http.Error(w, "starting", http.StatusServiceUnavailable)
				return
			}
			resp, err := http.Get(upstream)
			if err != nil {
				http.Error(w, err.Error(), http.StatusBadGateway)
				return
			}
			defer func() { _ = resp.Body.Close() }()
			_, _ = io.Copy(w, resp.Body)
		}))
		DeferCleanup(flaky.Close)
		withSource(c, "flaky", flaky.URL)
		_, e := c.Sources.Refresh(ctx, "flaky") // the startup refresh: it fails
		Expect(e).To(HaveOccurred())
		m := open(cfg, c, i)
		cmd := command("op-flaky", "install")
		cmd.SourceID = "flaky"
		_, e = m.Submit(ctx, actor, cmd)
		Expect(e).NotTo(HaveOccurred())
	})
})

var _ = Describe("the skills of a package", func() {
	type call struct {
		id    string
		files int
	}
	It("copies them at install, upgrade and owner start, and removes them at uninstall", func() {
		manifest, e := os.ReadFile("../../../tests/addons/fixtures/packages/manifest.json")
		Expect(e).NotTo(HaveOccurred())
		var mf contract.Manifest
		Expect(json.Unmarshal(manifest, &mf)).To(Succeed())
		mf.Capabilities.SkillDefinitions = []contract.SkillDefinition{{Name: "sample"}}
		manifest, e = json.Marshal(mf)
		Expect(e).NotTo(HaveOccurred())
		cfg, c, i := fixtureWithFiles(manifest, "", map[string][]byte{
			"skills/sample/SKILL.md": []byte("---\nname: sample\ndescription: Use for samples.\n---\nBody.\n"),
		})
		m := open(cfg, c, i)
		var mu sync.Mutex
		var calls []call
		record := func(_ context.Context, id string, r *packages.PackageReceipt) error {
			mu.Lock()
			defer mu.Unlock()
			n := -1
			if r != nil {
				fsys, err := packages.SkillFS(*r)
				Expect(err).NotTo(HaveOccurred())
				data, err := fs.ReadFile(fsys, "sample/SKILL.md")
				Expect(err).NotTo(HaveOccurred())
				n = len(data)
			}
			calls = append(calls, call{id, n})
			return nil
		}
		m.SetSkillSync(ctx, record)
		Expect(calls).To(BeEmpty(), "nothing is installed yet")
		_, e = m.Submit(ctx, actor, command("one", "install"))
		Expect(e).NotTo(HaveOccurred())
		Expect(calls).To(HaveLen(1))
		Expect(calls[0].id).To(Equal("sample"))
		Expect(calls[0].files).To(BeNumerically(">", 0))
		ids, e := m.InstalledSkillIDs(ctx)
		Expect(e).NotTo(HaveOccurred())
		Expect(ids).To(Equal([]string{"sample"}))

		_, e = m.Submit(ctx, actor, command("two", "disable"))
		Expect(e).NotTo(HaveOccurred())
		Expect(calls).To(HaveLen(1), "a stop leaves the files: the turn decides what is offered")
		_, e = m.Submit(ctx, actor, command("three", "upgrade"))
		Expect(e).NotTo(HaveOccurred())
		Expect(calls).To(HaveLen(2))

		// Owner start: the hook runs for every add-on the journal knows.
		calls = nil
		m.SetSkillSync(ctx, record)
		Expect(calls).To(HaveLen(1))

		_, e = m.Submit(ctx, actor, command("four", "uninstall"))
		Expect(e).NotTo(HaveOccurred())
		Expect(calls[len(calls)-1]).To(Equal(call{"sample", -1}), "uninstall removes the skills")
		ids, e = m.InstalledSkillIDs(ctx)
		Expect(e).NotTo(HaveOccurred())
		Expect(ids).To(BeEmpty())
	})

	It("installs upgrades and uninstalls the actual Sandbox document skills through verified receipts", func() {
		// Keep the existing sample lifecycle transport/executable fixture; use the
		// first-party Sandbox declarations and every byte of its real skill tree.
		data, err := os.ReadFile("../../../addons/sandbox/manifest.json")
		Expect(err).NotTo(HaveOccurred())
		var sandbox contract.Manifest
		Expect(json.Unmarshal(data, &sandbox)).To(Succeed())
		data, err = os.ReadFile("../../../tests/addons/fixtures/packages/manifest.json")
		Expect(err).NotTo(HaveOccurred())
		var manifest contract.Manifest
		Expect(json.Unmarshal(data, &manifest)).To(Succeed())
		manifest.Capabilities.SkillDefinitions = sandbox.Capabilities.SkillDefinitions
		data, err = json.Marshal(manifest)
		Expect(err).NotTo(HaveOccurred())
		tree := os.DirFS("../../../addons/sandbox/skills")
		archive := map[string][]byte{}
		Expect(fs.WalkDir(tree, ".", func(path string, entry fs.DirEntry, err error) error {
			if err != nil {
				return err
			}
			if entry.IsDir() {
				return nil
			}
			body, err := fs.ReadFile(tree, path)
			if err != nil {
				return err
			}
			archive["skills/"+path] = body
			return nil
		})).To(Succeed())
		Expect(archive).NotTo(BeEmpty())
		cfg, c, installer := fixtureWithFiles(data, "", archive)
		manager := open(cfg, c, installer)
		db, err := sqlitedb.Open("file:"+filepath.Join(GinkgoT().TempDir(), "workspace.db")+"?_busy_timeout=5000&_txlock=immediate", &gorm.Config{})
		Expect(err).NotTo(HaveOccurred())
		raw, err := db.DB()
		Expect(err).NotTo(HaveOccurred())
		DeferCleanup(raw.Close)
		blobs, err := blob.NewFS(filepath.Join(GinkgoT().TempDir(), "blobs"))
		Expect(err).NotTo(HaveOccurred())
		store, err := gormstore.New(db, blobs, gormstore.Options{Admin: files.AdminPrincipal})
		Expect(err).NotTo(HaveOccurred())
		materialized := files.New(store)
		Expect(materialized.EnsureHome(ctx, "alice")).To(Succeed())
		var receipts []packages.PackageReceipt
		manager.SetSkillSync(ctx, func(ctx context.Context, id string, receipt *packages.PackageReceipt) error {
			if receipt == nil {
				return materialized.RemoveAddonSkills(ctx, id)
			}
			Expect(receipt.Skills).To(HaveLen(4))
			verified, err := packages.SkillFS(*receipt)
			if err != nil {
				return err
			}
			n := 0
			for _, skill := range receipt.Skills {
				var notice bool
				for _, file := range skill.Files {
					want := archive["skills/"+skill.Name+"/"+file.Path]
					Expect(want).NotTo(BeNil())
					Expect(file.Size).To(Equal(int64(len(want))))
					Expect(file.SHA256).To(Equal(fmt.Sprintf("%x", sha256.Sum256(want))))
					got, err := fs.ReadFile(verified, skill.Name+"/"+file.Path)
					Expect(err).NotTo(HaveOccurred())
					Expect(got).To(Equal(want))
					n++
					notice = notice || file.Path == "notice.txt"
				}
				Expect(notice).To(BeTrue(), skill.Name)
			}
			Expect(n).To(Equal(len(archive)), "receipt must cover every actual file")
			receipts = append(receipts, *receipt)
			return materialized.SyncAddonSkills(ctx, id, verified)
		})
		check := func() {
			for _, name := range []string{"docx", "pptx", "pdf", "xlsx"} {
				_, body, err := materialized.ReadAddonSkill(ctx, "alice", "sample", name)
				Expect(err).NotTo(HaveOccurred())
				Expect(body).NotTo(BeEmpty())
			}
			ids, err := materialized.AddonSkillIDs(ctx)
			Expect(err).NotTo(HaveOccurred())
			Expect(ids).To(Equal([]string{"sample"}))
		}
		_, err = manager.Submit(ctx, actor, command("sandbox-tree-install", "install"))
		Expect(err).NotTo(HaveOccurred())
		check()
		_, err = manager.Submit(ctx, actor, command("sandbox-tree-stop", "disable"))
		Expect(err).NotTo(HaveOccurred())
		_, err = manager.Submit(ctx, actor, command("sandbox-tree-upgrade", "upgrade"))
		Expect(err).NotTo(HaveOccurred())
		Expect(receipts).To(HaveLen(2))
		Expect(receipts[1].Directory).NotTo(Equal(receipts[0].Directory))
		Expect(receipts[1].Skills).To(Equal(receipts[0].Skills))
		check()
		_, err = manager.Submit(ctx, actor, command("sandbox-tree-uninstall", "uninstall"))
		Expect(err).NotTo(HaveOccurred())
		ids, err := materialized.AddonSkillIDs(ctx)
		Expect(err).NotTo(HaveOccurred())
		Expect(ids).To(BeEmpty())
		for _, name := range []string{"docx", "pptx", "pdf", "xlsx"} {
			_, _, err = materialized.ReadAddonSkill(ctx, "alice", "sample", name)
			Expect(err).To(HaveOccurred())
		}
	})

	It("never fails the operation when the copy fails", func() {
		cfg, c, i := fixture()
		m := open(cfg, c, i)
		m.SetSkillSync(ctx, func(context.Context, string, *packages.PackageReceipt) error { return errors.New("store down") })
		_, e := m.Submit(ctx, actor, command("one", "install"))
		Expect(e).NotTo(HaveOccurred())
	})
})