go-testing-code-review

Go Testing Code Review

This codebase primarily uses the standard testing package (not Ginkgo) for controller and CLI tests; keep the Ginkgo/envtest bullets for when they apply or for cross-repo consistency.

Quick Reference

Issue Type	Reference
Test structure, naming	references/structure.md
Mocking, interfaces	references/mocking.md

Review Checklist

File Organization

• Test file naming: All test files follow *_test.go convention (e.g., reconciler_test.go for reconciler.go)
• Co-location: Unit tests are in the same package as the code they test

Standard Go Testing

• Tests are table-driven with clear case names
• Subtests use t.Run for parallel execution
• Test names describe behavior, not implementation
• Errors include got/want with descriptive message
• Cleanup registered with t.Cleanup
• Parallel tests don't share mutable state
• Mocks use interfaces defined in test file
• Coverage includes edge cases and error paths

Ginkgo/Gomega (BDD Framework)

• Use Describe for test suites, Context for scenarios, It for test cases
• Setup/teardown in BeforeEach/AfterEach for proper isolation
• Assertions use Expect() with matchers (To(), NotTo())
• Complex nested contexts organized logically (not too flat, not too deep)
• Use By() for multi-step test documentation

Kubernetes/Controller Testing

• Controller tests use envtest for realistic API server testing
• Test fixtures cleaned up properly (remove finalizers before deletion)
• Owner references validated on created resources
• Reconciliation loops tested with eventual consistency (Eventually())
• Both success and error paths tested for each reconcile function

Critical Patterns

Table-Driven Tests

// BAD - repetitive
func TestAdd(t *testing.T) {
    if Add(1, 2) != 3 {
        t.Error("wrong")
    }
    if Add(0, 0) != 0 {
        t.Error("wrong")
    }
}

// GOOD
func TestAdd(t *testing.T) {
    tests := []struct {
        name     string
        a, b     int
        want     int
    }{
        {"positive numbers", 1, 2, 3},
        {"zeros", 0, 0, 0},
        {"negative", -1, 1, 0},
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            got := Add(tt.a, tt.b)
            if got != tt.want {
                t.Errorf("Add(%d, %d) = %d, want %d", tt.a, tt.b, got, tt.want)
            }
        })
    }
}