Files
notarius/internal/core/debugbundle/bundle_test.go

141 lines
4.2 KiB
Go
Raw Normal View History

package debugbundle
import (
"errors"
"os"
"path/filepath"
"sync"
"testing"
"time"
)
func TestAllocateStartsOneDirectoryWithRelativeLatest(t *testing.T) {
t.Chdir(t.TempDir())
started := time.Unix(42, 0).UTC()
bundle, err := Allocate("debug root ", "run-first", started)
if err != nil {
t.Fatal(err)
}
if !filepath.IsAbs(bundle.Path()) || bundle.RunID() != "run-first" || bundle.CreatedAt() != started {
t.Fatalf("bundle=%#v", bundle)
}
names, err := os.ReadDir(bundle.Path())
if err != nil || len(names) != 0 {
t.Fatalf("unexpected summary/trace hierarchy: %v %v", names, err)
}
target, err := os.Readlink(filepath.Join(filepath.Dir(bundle.Path()), "latest"))
if err != nil || target != bundle.RunID() || filepath.IsAbs(target) {
t.Fatalf("latest=%q %v", target, err)
}
}
func TestAllocateRetainsExistingBundleOnCollision(t *testing.T) {
parent := t.TempDir()
bundle, err := Allocate(parent, "first", time.Now())
if err != nil {
t.Fatal(err)
}
sentinel := filepath.Join(bundle.Path(), "sentinel")
if err := os.WriteFile(sentinel, []byte("existing evidence"), 0o600); err != nil {
t.Fatal(err)
}
if _, err := Allocate(parent, "first", time.Now()); !errors.Is(err, os.ErrExist) {
t.Fatalf("collision=%v", err)
}
got, err := os.ReadFile(sentinel)
if err != nil || string(got) != "existing evidence" {
t.Fatalf("evidence=%q %v", got, err)
}
target, err := os.Readlink(filepath.Join(parent, "latest"))
if err != nil || target != "first" {
t.Fatalf("collision changed latest: %q %v", target, err)
}
}
func TestAllocateRejectsUnsafeRunIDsBeforeCreatingParent(t *testing.T) {
for _, id := range []string{"", ".", "..", "../escape", "/absolute", " spaced ", string([]byte{'a', 92, 'b'})} {
t.Run(id, func(t *testing.T) {
parent := filepath.Join(t.TempDir(), "debug")
if _, err := Allocate(parent, id, time.Now()); err == nil {
t.Fatal("unsafe run ID accepted")
}
if _, err := os.Stat(parent); !os.IsNotExist(err) {
t.Fatalf("parent exists: %v", err)
}
})
}
}
func TestAllocateFailureLeavesAvailableDataWithoutFallbackOrDeletion(t *testing.T) {
t.Run("parent is a file", func(t *testing.T) {
parent := filepath.Join(t.TempDir(), "debug")
if err := os.WriteFile(parent, []byte("existing"), 0o600); err != nil {
t.Fatal(err)
}
if bundle, err := Allocate(parent, "run", time.Now()); err == nil || bundle != nil {
t.Fatalf("bundle=%#v error=%v", bundle, err)
}
got, err := os.ReadFile(parent)
if err != nil || string(got) != "existing" {
t.Fatalf("parent changed: %q %v", got, err)
}
})
t.Run("latest cannot be replaced", func(t *testing.T) {
parent := t.TempDir()
latest := filepath.Join(parent, "latest")
if err := os.Mkdir(latest, 0o700); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(latest, "sentinel"), []byte("existing"), 0o600); err != nil {
t.Fatal(err)
}
bundle, err := Allocate(parent, "run", time.Now())
if err == nil || bundle == nil {
t.Fatalf("available bundle lost: %#v %v", bundle, err)
}
if _, err := os.Stat(bundle.Path()); err != nil {
t.Fatal(err)
}
if got, err := os.ReadFile(filepath.Join(latest, "sentinel")); err != nil || string(got) != "existing" {
t.Fatalf("latest directory changed: %q %v", got, err)
}
names, err := os.ReadDir(parent)
if err != nil || len(names) != 2 {
t.Fatalf("temporary link left behind: %v %v", names, err)
}
})
}
func TestConcurrentAllocationLeavesAllSessionsAndAValidLatestLink(t *testing.T) {
parent := t.TempDir()
const sessions = 8
var wg sync.WaitGroup
failures := make(chan error, sessions)
for i := range sessions {
wg.Add(1)
go func(i int) {
defer wg.Done()
_, err := Allocate(parent, time.Unix(int64(i), 0).Format("150405"), time.Now())
failures <- err
}(i)
}
wg.Wait()
close(failures)
for err := range failures {
if err != nil {
t.Fatal(err)
}
}
names, err := os.ReadDir(parent)
if err != nil || len(names) != sessions+1 {
t.Fatalf("sessions=%v %v", names, err)
}
target, err := os.Readlink(filepath.Join(parent, "latest"))
if err != nil || filepath.IsAbs(target) {
t.Fatalf("latest=%q %v", target, err)
}
if info, err := os.Stat(filepath.Join(parent, target)); err != nil || !info.IsDir() {
t.Fatalf("latest target unavailable: %v", err)
}
}