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

90 lines
2.3 KiB
Go

// Package debugbundle allocates explicitly requested per-run debug directories.
package debugbundle
import (
"fmt"
"os"
"path/filepath"
"strings"
"time"
)
type Bundle struct {
path string
createdAt time.Time
}
// Allocate starts a capture session. A link failure returns the already-created
// bundle as well as the error so callers can identify and retain available data.
func Allocate(parent, runID string, startedAt time.Time) (*Bundle, error) {
if parent == "" {
return nil, fmt.Errorf("debug parent must not be empty")
}
if err := validateRunID(runID); err != nil {
return nil, err
}
parent, err := filepath.Abs(parent)
if err != nil {
return nil, fmt.Errorf("resolve debug parent: %w", err)
}
if err := os.MkdirAll(parent, 0o700); err != nil {
return nil, fmt.Errorf("create debug parent %q: %w", parent, err)
}
directory := filepath.Join(parent, runID)
if err := os.Mkdir(directory, 0o700); err != nil {
return nil, fmt.Errorf("create debug bundle %q: %w", directory, err)
}
bundle := &Bundle{path: directory, createdAt: startedAt}
if err := updateLatest(parent, runID); err != nil {
return bundle, fmt.Errorf("update debug latest for %q: %w", directory, err)
}
return bundle, nil
}
func updateLatest(parent, runID string) error {
temporary, err := os.CreateTemp(parent, ".latest-*")
if err != nil {
return err
}
name := temporary.Name()
defer os.Remove(name)
if err := temporary.Close(); err != nil {
return err
}
if err := os.Remove(name); err != nil {
return err
}
if err := os.Symlink(runID, name); err != nil {
return err
}
return os.Rename(name, filepath.Join(parent, "latest"))
}
func validateRunID(runID string) error {
if runID == "" {
return fmt.Errorf("debug run ID must not be empty")
}
if runID != strings.TrimSpace(runID) || strings.ContainsAny(runID, `/\\`) || filepath.IsAbs(runID) || filepath.Clean(runID) != runID || runID == "." || runID == ".." {
return fmt.Errorf("debug run ID %q must be one safe path component", runID)
}
return nil
}
func (b *Bundle) Path() string {
if b == nil {
return ""
}
return b.path
}
func (b *Bundle) RunID() string {
if b == nil {
return ""
}
return filepath.Base(b.path)
}
func (b *Bundle) CreatedAt() time.Time {
if b == nil {
return time.Time{}
}
return b.createdAt
}