Files
gastown/internal/polecat/manager_test.go
Adam Zionts 02390251fc feat: Add configurable polecat branch naming (#825)
feat: Add configurable polecat branch naming

Adds polecat_branch_template configuration for custom branch naming patterns.

Template variables supported:
- {user}: git config user.name  
- {year}/{month}: date (YY/MM format)
- {name}: polecat name
- {issue}: issue ID without prefix
- {description}: sanitized issue title
- {timestamp}: unique timestamp

Maintains backward compatibility - empty template uses existing format.
2026-01-21 20:53:12 -08:00

761 lines
22 KiB
Go

package polecat
import (
"os"
"os/exec"
"path/filepath"
"sort"
"strings"
"testing"
"github.com/steveyegge/gastown/internal/git"
"github.com/steveyegge/gastown/internal/rig"
)
func TestStateIsActive(t *testing.T) {
tests := []struct {
state State
active bool
}{
{StateWorking, true},
{StateDone, false},
{StateStuck, false},
// Legacy active state is treated as active
{StateActive, true},
}
for _, tt := range tests {
if got := tt.state.IsActive(); got != tt.active {
t.Errorf("%s.IsActive() = %v, want %v", tt.state, got, tt.active)
}
}
}
func TestStateIsWorking(t *testing.T) {
tests := []struct {
state State
working bool
}{
{StateActive, false},
{StateWorking, true},
{StateDone, false},
{StateStuck, false},
}
for _, tt := range tests {
if got := tt.state.IsWorking(); got != tt.working {
t.Errorf("%s.IsWorking() = %v, want %v", tt.state, got, tt.working)
}
}
}
func TestPolecatSummary(t *testing.T) {
p := &Polecat{
Name: "Toast",
State: StateWorking,
Issue: "gt-abc",
}
summary := p.Summary()
if summary.Name != "Toast" {
t.Errorf("Name = %q, want Toast", summary.Name)
}
if summary.State != StateWorking {
t.Errorf("State = %v, want StateWorking", summary.State)
}
if summary.Issue != "gt-abc" {
t.Errorf("Issue = %q, want gt-abc", summary.Issue)
}
}
func TestListEmpty(t *testing.T) {
root := t.TempDir()
r := &rig.Rig{
Name: "test-rig",
Path: root,
}
m := NewManager(r, git.NewGit(root), nil)
polecats, err := m.List()
if err != nil {
t.Fatalf("List: %v", err)
}
if len(polecats) != 0 {
t.Errorf("polecats count = %d, want 0", len(polecats))
}
}
func TestGetNotFound(t *testing.T) {
root := t.TempDir()
r := &rig.Rig{
Name: "test-rig",
Path: root,
}
m := NewManager(r, git.NewGit(root), nil)
_, err := m.Get("nonexistent")
if err != ErrPolecatNotFound {
t.Errorf("Get = %v, want ErrPolecatNotFound", err)
}
}
func TestRemoveNotFound(t *testing.T) {
root := t.TempDir()
r := &rig.Rig{
Name: "test-rig",
Path: root,
}
m := NewManager(r, git.NewGit(root), nil)
err := m.Remove("nonexistent", false)
if err != ErrPolecatNotFound {
t.Errorf("Remove = %v, want ErrPolecatNotFound", err)
}
}
func TestPolecatDir(t *testing.T) {
r := &rig.Rig{
Name: "test-rig",
Path: "/home/user/ai/test-rig",
}
m := NewManager(r, git.NewGit(r.Path), nil)
dir := m.polecatDir("Toast")
expected := "/home/user/ai/test-rig/polecats/Toast"
if filepath.ToSlash(dir) != expected {
t.Errorf("polecatDir = %q, want %q", dir, expected)
}
}
func TestAssigneeID(t *testing.T) {
r := &rig.Rig{
Name: "test-rig",
Path: "/home/user/ai/test-rig",
}
m := NewManager(r, git.NewGit(r.Path), nil)
id := m.assigneeID("Toast")
expected := "test-rig/Toast"
if id != expected {
t.Errorf("assigneeID = %q, want %q", id, expected)
}
}
// Note: State persistence tests removed - state is now derived from beads assignee field.
// Integration tests should verify beads-based state management.
func TestGetReturnsWorkingWithoutBeads(t *testing.T) {
// When beads is not available, Get should return StateWorking
// (assume the polecat is doing something if it exists)
//
// Skip if bd is installed - the test assumes bd is unavailable, but when bd
// is present it queries beads and returns actual state instead of defaulting.
if _, err := exec.LookPath("bd"); err == nil {
t.Skip("skipping: bd is installed, test requires bd to be unavailable")
}
root := t.TempDir()
polecatDir := filepath.Join(root, "polecats", "Test")
if err := os.MkdirAll(polecatDir, 0755); err != nil {
t.Fatalf("mkdir: %v", err)
}
// Create mayor/rig directory for beads (but no actual beads)
mayorRigDir := filepath.Join(root, "mayor", "rig")
if err := os.MkdirAll(mayorRigDir, 0755); err != nil {
t.Fatalf("mkdir mayor/rig: %v", err)
}
r := &rig.Rig{
Name: "test-rig",
Path: root,
}
m := NewManager(r, git.NewGit(root), nil)
// Get should return polecat with StateWorking (assume active if beads unavailable)
polecat, err := m.Get("Test")
if err != nil {
t.Fatalf("Get: %v", err)
}
if polecat.Name != "Test" {
t.Errorf("Name = %q, want Test", polecat.Name)
}
if polecat.State != StateWorking {
t.Errorf("State = %v, want StateWorking (beads not available)", polecat.State)
}
}
func TestListWithPolecats(t *testing.T) {
root := t.TempDir()
// Create some polecat directories (state is now derived from beads, not state files)
for _, name := range []string{"Toast", "Cheedo"} {
polecatDir := filepath.Join(root, "polecats", name)
if err := os.MkdirAll(polecatDir, 0755); err != nil {
t.Fatalf("mkdir: %v", err)
}
}
if err := os.MkdirAll(filepath.Join(root, "polecats", ".claude"), 0755); err != nil {
t.Fatalf("mkdir .claude: %v", err)
}
// Create mayor/rig for beads path
mayorRig := filepath.Join(root, "mayor", "rig")
if err := os.MkdirAll(mayorRig, 0755); err != nil {
t.Fatalf("mkdir mayor/rig: %v", err)
}
r := &rig.Rig{
Name: "test-rig",
Path: root,
}
m := NewManager(r, git.NewGit(root), nil)
polecats, err := m.List()
if err != nil {
t.Fatalf("List: %v", err)
}
if len(polecats) != 2 {
t.Errorf("polecats count = %d, want 2", len(polecats))
}
}
// Note: TestSetState, TestAssignIssue, and TestClearIssue were removed.
// These operations now require a running beads instance and are tested
// via integration tests. The unit tests here focus on testing the basic
// polecat lifecycle operations that don't require beads.
func TestSetStateWithoutBeads(t *testing.T) {
// SetState should not error when beads is not available
root := t.TempDir()
polecatDir := filepath.Join(root, "polecats", "Test")
if err := os.MkdirAll(polecatDir, 0755); err != nil {
t.Fatalf("mkdir: %v", err)
}
// Create mayor/rig for beads path
mayorRig := filepath.Join(root, "mayor", "rig")
if err := os.MkdirAll(mayorRig, 0755); err != nil {
t.Fatalf("mkdir mayor/rig: %v", err)
}
r := &rig.Rig{
Name: "test-rig",
Path: root,
}
m := NewManager(r, git.NewGit(root), nil)
// SetState should succeed (no-op when no issue assigned)
err := m.SetState("Test", StateActive)
if err != nil {
t.Errorf("SetState: %v (expected no error when no beads/issue)", err)
}
}
func TestClearIssueWithoutAssignment(t *testing.T) {
// ClearIssue should not error when no issue is assigned
root := t.TempDir()
polecatDir := filepath.Join(root, "polecats", "Test")
if err := os.MkdirAll(polecatDir, 0755); err != nil {
t.Fatalf("mkdir: %v", err)
}
// Create mayor/rig for beads path
mayorRig := filepath.Join(root, "mayor", "rig")
if err := os.MkdirAll(mayorRig, 0755); err != nil {
t.Fatalf("mkdir mayor/rig: %v", err)
}
r := &rig.Rig{
Name: "test-rig",
Path: root,
}
m := NewManager(r, git.NewGit(root), nil)
// ClearIssue should succeed even when no issue assigned
err := m.ClearIssue("Test")
if err != nil {
t.Errorf("ClearIssue: %v (expected no error when no assignment)", err)
}
}
// NOTE: TestInstallCLAUDETemplate tests were removed.
// We no longer write CLAUDE.md to worktrees - Gas Town context is injected
// ephemerally via SessionStart hook (gt prime) to prevent leaking internal
// architecture into project repos.
func TestAddWithOptions_HasAgentsMD(t *testing.T) {
// This test verifies that AGENTS.md exists in polecat worktrees after creation.
// AGENTS.md is critical for polecats to "land the plane" properly.
root := t.TempDir()
// Create mayor/rig directory structure (this acts as repo base when no .repo.git)
mayorRig := filepath.Join(root, "mayor", "rig")
if err := os.MkdirAll(mayorRig, 0755); err != nil {
t.Fatalf("mkdir mayor/rig: %v", err)
}
// Initialize git repo in mayor/rig
cmd := exec.Command("git", "init")
cmd.Dir = mayorRig
if out, err := cmd.CombinedOutput(); err != nil {
t.Fatalf("git init: %v\n%s", err, out)
}
// Create AGENTS.md with test content
agentsMDContent := []byte("# AGENTS.md\n\nTest content for polecats.\n")
agentsMDPath := filepath.Join(mayorRig, "AGENTS.md")
if err := os.WriteFile(agentsMDPath, agentsMDContent, 0644); err != nil {
t.Fatalf("write AGENTS.md: %v", err)
}
// Commit AGENTS.md so it's part of the repo
mayorGit := git.NewGit(mayorRig)
if err := mayorGit.Add("AGENTS.md"); err != nil {
t.Fatalf("git add: %v", err)
}
if err := mayorGit.Commit("Add AGENTS.md"); err != nil {
t.Fatalf("git commit: %v", err)
}
// AddWithOptions needs origin/main to exist. Add self as origin and create tracking ref.
cmd = exec.Command("git", "remote", "add", "origin", mayorRig)
cmd.Dir = mayorRig
if out, err := cmd.CombinedOutput(); err != nil {
t.Fatalf("git remote add: %v\n%s", err, out)
}
// When using a local directory as remote, fetch doesn't create tracking branches.
// Create origin/main manually since AddWithOptions expects origin/main by default.
cmd = exec.Command("git", "update-ref", "refs/remotes/origin/main", "HEAD")
cmd.Dir = mayorRig
if out, err := cmd.CombinedOutput(); err != nil {
t.Fatalf("git update-ref: %v\n%s", err, out)
}
// Create rig pointing to root
r := &rig.Rig{
Name: "rig",
Path: root,
}
m := NewManager(r, git.NewGit(root), nil)
// Create polecat via AddWithOptions
polecat, err := m.AddWithOptions("TestAgent", AddOptions{})
if err != nil {
t.Fatalf("AddWithOptions: %v", err)
}
// Verify AGENTS.md exists in the worktree
worktreeAgentsMD := filepath.Join(polecat.ClonePath, "AGENTS.md")
if _, err := os.Stat(worktreeAgentsMD); os.IsNotExist(err) {
t.Errorf("AGENTS.md does not exist in worktree at %s", worktreeAgentsMD)
}
// Verify content matches
content, err := os.ReadFile(worktreeAgentsMD)
if err != nil {
t.Fatalf("read worktree AGENTS.md: %v", err)
}
gotContent := strings.ReplaceAll(string(content), "\r\n", "\n")
wantContent := strings.ReplaceAll(string(agentsMDContent), "\r\n", "\n")
if gotContent != wantContent {
t.Errorf("AGENTS.md content = %q, want %q", gotContent, wantContent)
}
}
func TestAddWithOptions_AgentsMDFallback(t *testing.T) {
// This test verifies the fallback: if AGENTS.md is not in git,
// it should be copied from mayor/rig.
root := t.TempDir()
// Create mayor/rig directory structure
mayorRig := filepath.Join(root, "mayor", "rig")
if err := os.MkdirAll(mayorRig, 0755); err != nil {
t.Fatalf("mkdir mayor/rig: %v", err)
}
// Initialize git repo in mayor/rig WITHOUT AGENTS.md in git
cmd := exec.Command("git", "init")
cmd.Dir = mayorRig
if out, err := cmd.CombinedOutput(); err != nil {
t.Fatalf("git init: %v\n%s", err, out)
}
// Create a dummy file and commit (repo needs at least one commit)
dummyPath := filepath.Join(mayorRig, "README.md")
if err := os.WriteFile(dummyPath, []byte("# Test\n"), 0644); err != nil {
t.Fatalf("write README.md: %v", err)
}
mayorGit := git.NewGit(mayorRig)
if err := mayorGit.Add("README.md"); err != nil {
t.Fatalf("git add: %v", err)
}
if err := mayorGit.Commit("Initial commit"); err != nil {
t.Fatalf("git commit: %v", err)
}
// AddWithOptions needs origin/main to exist. Add self as origin and create tracking ref.
cmd = exec.Command("git", "remote", "add", "origin", mayorRig)
cmd.Dir = mayorRig
if out, err := cmd.CombinedOutput(); err != nil {
t.Fatalf("git remote add: %v\n%s", err, out)
}
// When using a local directory as remote, fetch doesn't create tracking branches.
// Create origin/main manually since AddWithOptions expects origin/main by default.
cmd = exec.Command("git", "update-ref", "refs/remotes/origin/main", "HEAD")
cmd.Dir = mayorRig
if out, err := cmd.CombinedOutput(); err != nil {
t.Fatalf("git update-ref: %v\n%s", err, out)
}
// Now create AGENTS.md in mayor/rig (but NOT committed to git)
// This simulates the fallback scenario
agentsMDContent := []byte("# AGENTS.md\n\nFallback content.\n")
agentsMDPath := filepath.Join(mayorRig, "AGENTS.md")
if err := os.WriteFile(agentsMDPath, agentsMDContent, 0644); err != nil {
t.Fatalf("write AGENTS.md: %v", err)
}
// Create rig pointing to root
r := &rig.Rig{
Name: "rig",
Path: root,
}
m := NewManager(r, git.NewGit(root), nil)
// Create polecat via AddWithOptions
polecat, err := m.AddWithOptions("TestFallback", AddOptions{})
if err != nil {
t.Fatalf("AddWithOptions: %v", err)
}
// Verify AGENTS.md exists in the worktree (via fallback copy)
worktreeAgentsMD := filepath.Join(polecat.ClonePath, "AGENTS.md")
if _, err := os.Stat(worktreeAgentsMD); os.IsNotExist(err) {
t.Errorf("AGENTS.md does not exist in worktree (fallback failed) at %s", worktreeAgentsMD)
}
// Verify content matches the fallback source
content, err := os.ReadFile(worktreeAgentsMD)
if err != nil {
t.Fatalf("read worktree AGENTS.md: %v", err)
}
gotContent := strings.ReplaceAll(string(content), "\r\n", "\n")
wantContent := strings.ReplaceAll(string(agentsMDContent), "\r\n", "\n")
if gotContent != wantContent {
t.Errorf("AGENTS.md content = %q, want %q", gotContent, wantContent)
}
}
// TestReconcilePoolWith tests all permutations of directory and session existence.
// This is the core allocation policy logic.
//
// Truth table:
// HasDir | HasSession | Result
// -------|------------|------------------
// false | false | available (not in-use)
// true | false | in-use (normal finished polecat)
// false | true | orphan → kill session, available
// true | true | in-use (normal working polecat)
func TestReconcilePoolWith(t *testing.T) {
t.Parallel()
tests := []struct {
name string
namesWithDirs []string
namesWithSessions []string
wantInUse []string // names that should be marked in-use
wantOrphans []string // sessions that should be killed
}{
{
name: "no dirs, no sessions - all available",
namesWithDirs: []string{},
namesWithSessions: []string{},
wantInUse: []string{},
wantOrphans: []string{},
},
{
name: "has dir, no session - in use",
namesWithDirs: []string{"toast"},
namesWithSessions: []string{},
wantInUse: []string{"toast"},
wantOrphans: []string{},
},
{
name: "no dir, has session - orphan killed",
namesWithDirs: []string{},
namesWithSessions: []string{"nux"},
wantInUse: []string{},
wantOrphans: []string{"nux"},
},
{
name: "has dir, has session - in use",
namesWithDirs: []string{"capable"},
namesWithSessions: []string{"capable"},
wantInUse: []string{"capable"},
wantOrphans: []string{},
},
{
name: "mixed: one with dir, one orphan session",
namesWithDirs: []string{"toast"},
namesWithSessions: []string{"toast", "nux"},
wantInUse: []string{"toast"},
wantOrphans: []string{"nux"},
},
{
name: "multiple dirs, no sessions",
namesWithDirs: []string{"toast", "nux", "capable"},
namesWithSessions: []string{},
wantInUse: []string{"capable", "nux", "toast"},
wantOrphans: []string{},
},
{
name: "multiple orphan sessions",
namesWithDirs: []string{},
namesWithSessions: []string{"slit", "rictus"},
wantInUse: []string{},
wantOrphans: []string{"rictus", "slit"},
},
{
name: "complex: dirs, valid sessions, orphan sessions",
namesWithDirs: []string{"toast", "capable"},
namesWithSessions: []string{"toast", "nux", "slit"},
wantInUse: []string{"capable", "toast"},
wantOrphans: []string{"nux", "slit"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Create temporary directory for pool state
tmpDir, err := os.MkdirTemp("", "reconcile-test-*")
if err != nil {
t.Fatal(err)
}
defer func() { _ = os.RemoveAll(tmpDir) }()
// Create rig and manager (nil tmux for unit test)
// Use "myrig" which hashes to mad-max theme
r := &rig.Rig{
Name: "myrig",
Path: tmpDir,
}
m := NewManager(r, nil, nil)
// Call ReconcilePoolWith
m.ReconcilePoolWith(tt.namesWithDirs, tt.namesWithSessions)
// Verify in-use names
gotInUse := m.namePool.ActiveNames()
sort.Strings(gotInUse)
sort.Strings(tt.wantInUse)
if len(gotInUse) != len(tt.wantInUse) {
t.Errorf("in-use count: got %d, want %d", len(gotInUse), len(tt.wantInUse))
}
for i := range tt.wantInUse {
if i >= len(gotInUse) || gotInUse[i] != tt.wantInUse[i] {
t.Errorf("in-use names: got %v, want %v", gotInUse, tt.wantInUse)
break
}
}
// Verify orphans would be identified correctly
// (actual killing requires tmux, tested separately)
dirSet := make(map[string]bool)
for _, name := range tt.namesWithDirs {
dirSet[name] = true
}
var gotOrphans []string
for _, name := range tt.namesWithSessions {
if !dirSet[name] {
gotOrphans = append(gotOrphans, name)
}
}
sort.Strings(gotOrphans)
sort.Strings(tt.wantOrphans)
if len(gotOrphans) != len(tt.wantOrphans) {
t.Errorf("orphan count: got %d, want %d", len(gotOrphans), len(tt.wantOrphans))
}
for i := range tt.wantOrphans {
if i >= len(gotOrphans) || gotOrphans[i] != tt.wantOrphans[i] {
t.Errorf("orphans: got %v, want %v", gotOrphans, tt.wantOrphans)
break
}
}
})
}
}
// TestReconcilePoolWith_Allocation verifies that allocation respects reconciled state.
func TestReconcilePoolWith_Allocation(t *testing.T) {
t.Parallel()
tmpDir, err := os.MkdirTemp("", "reconcile-alloc-test-*")
if err != nil {
t.Fatal(err)
}
defer func() { _ = os.RemoveAll(tmpDir) }()
// Use "myrig" which hashes to mad-max theme
r := &rig.Rig{
Name: "myrig",
Path: tmpDir,
}
m := NewManager(r, nil, nil)
// Mark first few pool names as in-use via directories
// (furiosa, nux, slit are first 3 in mad-max theme)
m.ReconcilePoolWith([]string{"furiosa", "nux", "slit"}, []string{})
// First allocation should skip in-use names
name, err := m.namePool.Allocate()
if err != nil {
t.Fatalf("Allocate: %v", err)
}
// Should get "rictus" (4th in mad-max theme), not furiosa/nux/slit
if name == "furiosa" || name == "nux" || name == "slit" {
t.Errorf("allocated in-use name %q, should have skipped", name)
}
if name != "rictus" {
t.Errorf("expected rictus (4th name), got %q", name)
}
}
// TestReconcilePoolWith_OrphanDoesNotBlockAllocation verifies orphan sessions
// don't prevent name allocation (they're killed, freeing the name).
func TestReconcilePoolWith_OrphanDoesNotBlockAllocation(t *testing.T) {
t.Parallel()
tmpDir, err := os.MkdirTemp("", "reconcile-orphan-test-*")
if err != nil {
t.Fatal(err)
}
defer func() { _ = os.RemoveAll(tmpDir) }()
// Use "myrig" which hashes to mad-max theme
r := &rig.Rig{
Name: "myrig",
Path: tmpDir,
}
m := NewManager(r, nil, nil)
// furiosa has orphan session (no dir) - should NOT block allocation
m.ReconcilePoolWith([]string{}, []string{"furiosa"})
// furiosa should be available (orphan session killed, name freed)
name, err := m.namePool.Allocate()
if err != nil {
t.Fatalf("Allocate: %v", err)
}
if name != "furiosa" {
t.Errorf("expected furiosa (orphan freed), got %q", name)
}
}
func TestBuildBranchName(t *testing.T) {
tmpDir := t.TempDir()
// Initialize a git repo for config access
gitCmd := exec.Command("git", "init")
gitCmd.Dir = tmpDir
if err := gitCmd.Run(); err != nil {
t.Fatalf("git init: %v", err)
}
// Set git user.name for testing
configCmd := exec.Command("git", "config", "user.name", "testuser")
configCmd.Dir = tmpDir
if err := configCmd.Run(); err != nil {
t.Fatalf("git config: %v", err)
}
tests := []struct {
name string
template string
issue string
want string
}{
{
name: "default_with_issue",
template: "", // Empty template = default behavior
issue: "gt-123",
want: "polecat/alpha/gt-123@", // timestamp suffix varies
},
{
name: "default_without_issue",
template: "",
issue: "",
want: "polecat/alpha-", // timestamp suffix varies
},
{
name: "custom_template_user_year_month",
template: "{user}/{year}/{month}/fix",
issue: "",
want: "testuser/", // year/month will vary
},
{
name: "custom_template_with_name",
template: "feature/{name}",
issue: "",
want: "feature/alpha",
},
{
name: "custom_template_with_issue",
template: "work/{issue}",
issue: "gt-456",
want: "work/456",
},
{
name: "custom_template_with_timestamp",
template: "feature/{name}-{timestamp}",
issue: "",
want: "feature/alpha-", // timestamp suffix varies
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Create rig with test template
r := &rig.Rig{
Name: "test-rig",
Path: tmpDir,
}
// Override system defaults for this test if template is set
if tt.template != "" {
origDefault := rig.SystemDefaults["polecat_branch_template"]
rig.SystemDefaults["polecat_branch_template"] = tt.template
defer func() {
rig.SystemDefaults["polecat_branch_template"] = origDefault
}()
}
g := git.NewGit(tmpDir)
m := NewManager(r, g, nil)
got := m.buildBranchName("alpha", tt.issue)
// For default templates, just check prefix since timestamp varies
if tt.template == "" {
if !strings.HasPrefix(got, tt.want) {
t.Errorf("buildBranchName() = %q, want prefix %q", got, tt.want)
}
} else {
// For custom templates with time-varying fields, check prefix
if strings.Contains(tt.template, "{year}") || strings.Contains(tt.template, "{month}") || strings.Contains(tt.template, "{timestamp}") {
if !strings.HasPrefix(got, tt.want) {
t.Errorf("buildBranchName() = %q, want prefix %q", got, tt.want)
}
} else {
if got != tt.want {
t.Errorf("buildBranchName() = %q, want %q", got, tt.want)
}
}
}
})
}
}