Skip to content

TESTING.md

Latest commit

 

History

History
113 lines (84 loc) · 2.54 KB

TESTING.md

File metadata and controls

113 lines (84 loc) · 2.54 KB

Testing Strategy

How to test and validate claude-code-java scripts

Current Approach: Simple Test Script

For MVP phase, we use a simple bash test script that validates all setup scripts work correctly.

Running Tests

./scripts/test-all.sh

What It Tests

Script Validations
link-skills.sh Creates .claude/, symlink points to workspace
generate-claude-md.sh Creates CLAUDE.md with content
configure-mcp.sh Template file exists

Test Philosophy

  • Tests run in a temporary directory (auto-cleaned)
  • Zero external dependencies
  • Fast execution (< 2 seconds)
  • Clear pass/fail output

Future Options

Option 1: bats-core (Recommended for growth)

bats-core - Bash Automated Testing System

When to adopt:

  • 10+ test cases
  • Multiple contributors
  • Want better test organization (describe/it blocks)

Example:

@test "link-skills creates symlink" {
    run ./scripts/link-skills.sh "$TEST_DIR"
    [ "$status" -eq 0 ]
    [ -L "$TEST_DIR/.claude/skills" ]
}

Install: npm install -g bats or brew install bats-core

Option 2: GitHub Actions CI

When to adopt:

  • Project is public on GitHub
  • Want automatic validation on PRs
  • Multiple contributors

Example workflow (.github/workflows/test.yml):

name: Test
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: chmod +x scripts/*.sh
      - run: ./scripts/test-all.sh

Option 3: Pre-commit Hook

When to adopt:

  • Want to catch issues before commit
  • Local-only validation

Setup:

# .git/hooks/pre-commit
#!/bin/bash
./scripts/test-all.sh || exit 1

Decision Framework

Phase Recommended Approach
MVP (now) Simple test script
v0.3+ with contributors Add bats-core
Public release Add GitHub Actions
Team adoption Add pre-commit hooks

Adding New Tests

When adding a new script, add corresponding tests to test-all.sh:

# Test N: new-script.sh
echo "Testing new-script.sh..."
"$SCRIPT_DIR/new-script.sh" "$TEST_DIR" > /dev/null 2>&1
check "[ -f '$TEST_DIR/expected-output' ]" "expected output created"
echo ""

Manual Testing Checklist

For changes that are hard to automate:

  • Run setup-project.sh on a real Java project
  • Verify skills symlink works in Claude Code
  • Test on fresh directory (no existing .claude/)
  • Test on directory with existing .claude/skills