eric/distributor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Support catalog maintenance commands

Browse Source
This commit is contained in:
Eric Rakestraw
2026-06-19 15:58:36 +00:00
parent 91b72478d5
commit cf7e62733e
8 changed files with 295 additions and 349 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
internal/cli/prune_test.go
View File

@@ -3,11 +3,14 @@ package cli
import (
"bytes"
"context"
"encoding/json"
"os"
"path/filepath"
"strings"
"testing"
"time"
"gitea.maximumdirect.net/eric/distributor/internal/bundle"
"gitea.maximumdirect.net/eric/distributor/internal/state"
"gitea.maximumdirect.net/eric/distributor/internal/storage"
"gitea.maximumdirect.net/eric/distributor/internal/testutil"
@@ -73,7 +76,6 @@ func TestExecutePruneRejectsInvalidFlags(t *testing.T) {
}
func TestExecutePruneDryRunReportsWithoutWriting(t *testing.T) {
t.Skip("catalog prune execution is covered by the catalog maintenance work")
destinationRoot, configPath := writePruneLocalFixture(t)
var stdout, stderr bytes.Buffer
@@ -93,9 +95,10 @@ func TestExecutePruneDryRunReportsWithoutWriting(t *testing.T) {
}
assertLocalFile(t, filepath.Join(destinationRoot, "report.md"), "# Report\nSunny.\n")
assertLocalFile(t, filepath.Join(destinationRoot, "summary.txt"), "Summary\n")
assertLocalFile(t, filepath.Join(destinationRoot, "html.txt"), "other")
assertLocalFile(t, filepath.Join(destinationRoot, "extra.txt"), "unmanaged")
destinationState := testutil.ReadDestinationState(t, filepath.Join(destinationRoot, storage.StateFileName))
if got := strings.Join(state.ManagedOutputPaths(destinationState), ","); got != "report.md,summary.txt" {
catalog := readLocalCatalogState(t, filepath.Join(destinationRoot, storage.StateFileName))
if got := strings.Join(state.CatalogManagedOutputPaths(catalog), ","); got != "report.md,summary.txt,html.txt" {
t.Fatalf("state outputs = %q, want original outputs", got)
}
if stderr.Len() != 0 {
@@ -104,7 +107,6 @@ func TestExecutePruneDryRunReportsWithoutWriting(t *testing.T) {
}
func TestExecutePruneJSONReport(t *testing.T) {
t.Skip("catalog prune execution is covered by the catalog maintenance work")
_, configPath := writePruneLocalFixture(t)
var stdout, stderr bytes.Buffer
@@ -138,7 +140,6 @@ func TestExecutePruneJSONReport(t *testing.T) {
}
func TestExecutePruneApplyDeletesManagedOutputs(t *testing.T) {
t.Skip("catalog prune execution is covered by the catalog maintenance work")
destinationRoot, configPath := writePruneLocalFixture(t)
var stdout, stderr bytes.Buffer
@@ -162,13 +163,14 @@ func TestExecutePruneApplyDeletesManagedOutputs(t *testing.T) {
if _, err := os.Stat(filepath.Join(destinationRoot, "summary.txt")); !os.IsNotExist(err) {
t.Fatalf("summary.txt stat error = %v, want not exist", err)
}
assertLocalFile(t, filepath.Join(destinationRoot, "html.txt"), "other")
assertLocalFile(t, filepath.Join(destinationRoot, "extra.txt"), "unmanaged")
if _, err := os.Stat(filepath.Join(destinationRoot, storage.StateFileName)); err != nil {
t.Fatalf("state file stat error = %v", err)
}
destinationState := testutil.ReadDestinationState(t, filepath.Join(destinationRoot, storage.StateFileName))
if got := state.ManagedOutputPaths(destinationState); len(got) != 0 {
t.Fatalf("state outputs = %#v, want none", got)
catalog := readLocalCatalogState(t, filepath.Join(destinationRoot, storage.StateFileName))
if got := strings.Join(state.CatalogManagedOutputPaths(catalog), ","); got != "html.txt" {
t.Fatalf("state outputs = %q, want html.txt", got)
}
if stderr.Len() != 0 {
t.Fatalf("stderr = %q, want empty", stderr.String())
@@ -180,13 +182,16 @@ func writePruneLocalFixture(t *testing.T) (string, string) {
sourceRoot := t.TempDir()
destinationRoot := t.TempDir()
manifest := testutil.WriteSourceBundle(t, sourceRoot, "", testutil.BundleOptions{})
testutil.WriteDestinationState(t, destinationRoot, "", manifest, testutil.DestinationStateOptions{})
writeCatalogDestinationState(t, destinationRoot, manifest, true)
for _, file := range testutil.DefaultSourceFiles() {
path := filepath.Join(destinationRoot, filepath.FromSlash(file.Path))
if err := os.WriteFile(path, []byte(file.Data), 0o600); err != nil {
t.Fatalf("write destination output: %v", err)
}
}
if err := os.WriteFile(filepath.Join(destinationRoot, "html.txt"), []byte("other"), 0o600); err != nil {
t.Fatalf("write other owner output: %v", err)
}
if err := os.WriteFile(filepath.Join(destinationRoot, "extra.txt"), []byte("unmanaged"), 0o600); err != nil {
t.Fatalf("write unmanaged output: %v", err)
}
@@ -211,3 +216,71 @@ pipelines:
}
return destinationRoot, configPath
}
func writeCatalogDestinationState(t *testing.T, root string, manifest bundle.Manifest, includeOtherOwner bool) {
t.Helper()
createdAt := time.Date(2026, 6, 8, 12, 0, 0, 0, time.UTC)
source := state.CatalogSourceIdentity{ID: manifest.ID, Digest: manifest.Digest, Created: manifest.Created}
outputs := []state.CatalogOutputFile{{
Path: "report.md",
PipelineID: "reports",
DestinationID: "archive",
Source: source,
Kind: state.OutputKindSource,
SHA256: manifest.Files[0].SHA256,
Size: manifest.Files[0].Size,
CreatedAt: createdAt,
UpdatedAt: createdAt,
}, {
Path: "summary.txt",
PipelineID: "reports",
DestinationID: "archive",
Source: source,
Kind: state.OutputKindSource,
SHA256: manifest.Files[1].SHA256,
Size: manifest.Files[1].Size,
CreatedAt: createdAt,
UpdatedAt: createdAt,
}}
if includeOtherOwner {
outputs = append(outputs, state.CatalogOutputFile{
Path: "html.txt",
PipelineID: "reports",
DestinationID: "html",
Source: source,
Kind: state.OutputKindSource,
SHA256: manifest.Files[0].SHA256,
Size: manifest.Files[0].Size,
CreatedAt: createdAt,
UpdatedAt: createdAt,
})
}
catalog := state.CatalogState{
SchemaVersion: state.CatalogSchemaVersion,
DistributorVersion: "test",
CreatedAt: createdAt,
UpdatedAt: createdAt,
State: state.StatePolicy{Mode: state.StateModeCatalog},
Outputs: outputs,
}
data, err := json.MarshalIndent(catalog, "", " ")
if err != nil {
t.Fatalf("marshal catalog state: %v", err)
}
if err := os.WriteFile(filepath.Join(root, storage.StateFileName), append(data, '\n'), 0o600); err != nil {
t.Fatalf("write catalog state: %v", err)
}
}
func readLocalCatalogState(t *testing.T, path string) state.CatalogState {
t.Helper()
data, err := os.ReadFile(path)
if err != nil {
t.Fatalf("read catalog state: %v", err)
}
catalog, err := state.ParseCatalog(data)
if err != nil {
t.Fatalf("parse catalog state: %v", err)
}
return catalog
}

18
internal/cli/reconcile_state_test.go
View File

@@ -14,7 +14,6 @@ import (
)
func TestExecuteReconcileStateAppliesByDefault(t *testing.T) {
t.Skip("catalog reconcile-state execution is covered by the catalog maintenance work")
_, destinationRoot, configPath := writeReconcileStateLocalFixture(t)
if err := os.WriteFile(filepath.Join(destinationRoot, "report.md"), []byte("# Report\nSunny.\n"), 0o600); err != nil {
t.Fatalf("write managed output: %v", err)
@@ -37,9 +36,9 @@ func TestExecuteReconcileStateAppliesByDefault(t *testing.T) {
if !strings.Contains(stdout.String(), "status=changed") {
t.Fatalf("stdout = %q, want changed status", stdout.String())
}
destinationState := testutil.ReadDestinationState(t, filepath.Join(destinationRoot, storage.StateFileName))
if got := strings.Join(state.ManagedOutputPaths(destinationState), ","); got != "report.md" {
t.Fatalf("state outputs = %q, want report.md", got)
catalog := readLocalCatalogState(t, filepath.Join(destinationRoot, storage.StateFileName))
if got := strings.Join(state.CatalogManagedOutputPaths(catalog), ","); got != "report.md,html.txt" {
t.Fatalf("state outputs = %q, want report.md,html.txt", got)
}
assertLocalFile(t, filepath.Join(destinationRoot, "extra.txt"), "unmanaged")
if stderr.Len() != 0 {
@@ -48,7 +47,6 @@ func TestExecuteReconcileStateAppliesByDefault(t *testing.T) {
}
func TestExecuteReconcileStateDryRunReportsWithoutWriting(t *testing.T) {
t.Skip("catalog reconcile-state execution is covered by the catalog maintenance work")
_, destinationRoot, configPath := writeReconcileStateLocalFixture(t)
if err := os.WriteFile(filepath.Join(destinationRoot, "report.md"), []byte("# Report\nSunny.\n"), 0o600); err != nil {
t.Fatalf("write managed output: %v", err)
@@ -69,8 +67,8 @@ func TestExecuteReconcileStateDryRunReportsWithoutWriting(t *testing.T) {
if !strings.Contains(stdout.String(), "status=would_change") {
t.Fatalf("stdout = %q, want would_change status", stdout.String())
}
destinationState := testutil.ReadDestinationState(t, filepath.Join(destinationRoot, storage.StateFileName))
if got := strings.Join(state.ManagedOutputPaths(destinationState), ","); got != "report.md,summary.txt" {
catalog := readLocalCatalogState(t, filepath.Join(destinationRoot, storage.StateFileName))
if got := strings.Join(state.CatalogManagedOutputPaths(catalog), ","); got != "report.md,summary.txt,html.txt" {
t.Fatalf("state outputs = %q, want original outputs", got)
}
if stderr.Len() != 0 {
@@ -79,7 +77,6 @@ func TestExecuteReconcileStateDryRunReportsWithoutWriting(t *testing.T) {
}
func TestExecuteReconcileStateJSONReport(t *testing.T) {
t.Skip("catalog reconcile-state execution is covered by the catalog maintenance work")
_, destinationRoot, configPath := writeReconcileStateLocalFixture(t)
if err := os.WriteFile(filepath.Join(destinationRoot, "report.md"), []byte("# Report\nSunny.\n"), 0o600); err != nil {
t.Fatalf("write managed output: %v", err)
@@ -176,7 +173,10 @@ func writeReconcileStateLocalFixture(t *testing.T) (string, string, string) {
sourceRoot := t.TempDir()
destinationRoot := t.TempDir()
manifest := testutil.WriteSourceBundle(t, sourceRoot, "", testutil.BundleOptions{})
testutil.WriteDestinationState(t, destinationRoot, "", manifest, testutil.DestinationStateOptions{})
writeCatalogDestinationState(t, destinationRoot, manifest, true)
if err := os.WriteFile(filepath.Join(destinationRoot, "html.txt"), []byte("other"), 0o600); err != nil {
t.Fatalf("write other owner output: %v", err)
}
configPath := testutil.WriteMinimalLocalConfig(t, sourceRoot, destinationRoot)
return sourceRoot, destinationRoot, configPath
}