tests

Hitch Testing Framework

A simple, clean testing framework for Hitch that avoids complexity and provides easy-to-use utilities for testing git operations and Hitch functionality.

Quick Start

func TestYourFeature(t *testing.T) {
    testRepo := tests.NewTestRepo(t)
    defer testRepo.Cleanup()

    // Create files and commits
    testRepo.CreateFile("README.md", "# Test")
    testRepo.AddAndCommit("Initial commit")

    // Create branches
    testRepo.CreateBranch("feature/test")
    testRepo.AssertCurrentBranch("feature/test")

    // Setup Hitch metadata
    testRepo.CreateBasicHitchMetadata()
    testRepo.AssertFileExists(".hitch/metadata.json")
}

Available Methods

Repository Setup

• NewTestRepo(t *testing.T) - Creates a fresh temporary git repository
• SetupGitConfig() - Configures git user for the test repo
• Cleanup() - Removes temporary files

File Operations

• CreateFile(path, content string) - Creates a file with content
• AssertFileExists(path string) - Verifies a file exists
• AssertFileContains(path, content string) - Verifies file contains content

Git Operations

• AddAndCommit(message string) - Stage and commit all changes
• CreateBranch(name string) - Create and switch to new branch
• Checkout(branch string) - Switch to existing branch
• GetCurrentBranch() string - Get current branch name
• AssertCurrentBranch(expected string) - Verify current branch

Hitch Metadata

• CreateBasicHitchMetadata() - Creates standard dev/prod environments
• WriteHitchFile(content string) - Write custom metadata JSON

Design Principles

1. Simple over complex - Uses direct git commands, not go-git
2. Secure by default - Uses 0600 file permissions
3. Fast execution - Tests run in < 1 second
4. Clean isolation - Each test gets a fresh repository
5. Easy assertions - Built-in helpers for common verifications

Best Practices

• Always call defer testRepo.Cleanup() immediately after NewTestRepo()
• Use assertion helpers instead of manual checks for cleaner tests
• Use CreateBasicHitchMetadata() for standard Hitch setup
• Keep tests focused on single behaviors
• Use descriptive commit messages in AddAndCommit()

Adding New Tests

1. Create a new test function following Go conventions
2. Use the helper methods for common operations
3. Add assertions to verify expected behavior
4. Follow the existing patterns in example_test.go

The framework is designed to be extended as needed while keeping simplicity and avoiding the complexity that caused issues with the previous test system.