base-layer/releasekit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

Check the exact publication record filename before writing

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-02 22:17:59 +00:00
parent 0d19a5546f
commit d2b1329095
3 changed files with 57 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
internal/publish/record.go
View File

@@ -59,21 +59,16 @@ func SaveEvidence(repositoryDir, override string, evidence Evidence) (string, er
}
func saveEvidenceInDir(repositoryDir, root, override, recordDir string, evidence Evidence) (string, error) {
return saveEvidenceNamed(repositoryDir, root, override, recordDir, evidence, proposedRecordPath)
}
func saveEvidenceNamed(repositoryDir, root, override, recordDir string, evidence Evidence, nextPath func(string) (string, error)) (string, error) {
if evidence.RecordedAt == "" {
evidence.RecordedAt = time.Now().UTC().Format(time.RFC3339Nano)
}
if err := os.MkdirAll(recordDir, 0o700); err != nil {
return "", &RecoveryError{Kind: "record_write", cause: fmt.Errorf("create record directory %q: %w", recordDir, err)}
}
if override != "" && root != "" {
path, pathErr := proposedRecordPath(recordDir)
if pathErr != nil {
return "", &RecoveryError{Kind: "record_write", cause: pathErr}
}
if err := rejectUnignoredWorktreePath(repositoryDir, root, path); err != nil {
return "", &RecoveryError{Kind: "record_write", cause: err}
}
}
evidenceJSON, err := json.Marshal(evidence)
if err != nil {
return "", &RecoveryError{Kind: "record_write", cause: fmt.Errorf("encode publication evidence: %w", err)}
@@ -83,11 +78,15 @@ func saveEvidenceInDir(repositoryDir, root, override, recordDir string, evidence
return "", &RecoveryError{Kind: "record_write", cause: fmt.Errorf("encode publication evidence: %w", err)}
}
for attempt := 0; attempt < 5; attempt++ {
var nonce [16]byte
if _, err := rand.Read(nonce[:]); err != nil {
path, err := nextPath(recordDir)
if err != nil {
return "", &RecoveryError{Kind: "record_write", cause: fmt.Errorf("name publication record: %w", err)}
}
path := filepath.Join(recordDir, "attempt-"+hex.EncodeToString(nonce[:])+".json")
if override != "" && root != "" {
if err := rejectUnignoredWorktreePath(repositoryDir, root, path); err != nil {
return "", &RecoveryError{Kind: "record_write", cause: err}
}
}
file, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0o600)
if errors.Is(err, os.ErrExist) {
continue

41
internal/publish/record_test.go
View File

@@ -157,6 +157,47 @@ func TestSaveEvidenceRejectsUnignoredOverrideInsideWorktree(t *testing.T) {
}
}
func TestSaveEvidenceChecksEachActualFilename(t *testing.T) {
repo := recordRepo(t)
if err := os.WriteFile(filepath.Join(repo, ".gitignore"), []byte("selective/attempt-[0-7]*.json\n"), 0600); err != nil {
t.Fatal(err)
}
recordGit(t, repo, "add", ".gitignore")
recordGit(t, repo, "commit", "-qm", "Selective ignore")
dir := filepath.Join(repo, "selective")
next := func(name string) func(string) (string, error) {
return func(directory string) (string, error) { return filepath.Join(directory, name), nil }
}
path, err := saveEvidenceNamed(repo, repo, dir, dir, Evidence{Tag: "v1.0.0"}, next("attempt-0.json"))
if err != nil {
t.Fatal(err)
}
recordGit(t, repo, "check-ignore", "--", path)
// A collision must validate the replacement name as well.
calls := 0
_, err = saveEvidenceNamed(repo, repo, dir, dir, Evidence{Tag: "v2.0.0"}, func(directory string) (string, error) {
calls++
name := "attempt-0.json"
if calls > 1 {
name = "attempt-c.json"
}
return filepath.Join(directory, name), nil
})
if err == nil || calls != 2 {
t.Fatalf("unignored replacement: calls=%d error=%v", calls, err)
}
if _, err := os.Stat(filepath.Join(dir, "attempt-c.json")); !errors.Is(err, os.ErrNotExist) {
t.Fatalf("unignored file was created: %v", err)
}
if status := recordGit(t, repo, "status", "--porcelain"); status != "" {
t.Fatalf("recording dirtied candidate: %s", status)
}
loaded, err := LoadEvidence(path)
if err != nil || loaded.Tag != "v1.0.0" {
t.Fatalf("collision changed original record: %#v, %v", loaded, err)
}
}
func TestListAttemptsReturnsReadableRecordsAndDiagnosticsInPathOrder(t *testing.T) {
repo := recordRepo(t)
directory := filepath.Join(t.TempDir(), "attempts")