Merge pull request #60 from frankbria/feature/project-setup-tests
test(setup): add 36 comprehensive tests for setup.sh
This commit is contained in:
Frank Bria
GitHub
commit
27df19716e
2 changed files with 475 additions and 2 deletions
18
CLAUDE.md
18
CLAUDE.md
|
|
@ -6,7 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
|||
|
||||
This is the Ralph for Claude Code repository - an autonomous AI development loop system that enables continuous development cycles with intelligent exit detection and rate limiting.
|
||||
|
||||
**Version**: v0.9.3 | **Tests**: 165 passing (100% pass rate) | **CI/CD**: GitHub Actions
|
||||
**Version**: v0.9.4 | **Tests**: 201 passing (100% pass rate) | **CI/CD**: GitHub Actions
|
||||
|
||||
## Core Architecture
|
||||
|
||||
|
|
@ -272,7 +272,7 @@ Ralph uses advanced error detection with two-stage filtering to eliminate false
|
|||
|
||||
## Test Suite
|
||||
|
||||
### Test Files (165 tests total)
|
||||
### Test Files (201 tests total)
|
||||
|
||||
| File | Tests | Description |
|
||||
|------|-------|-------------|
|
||||
|
|
@ -284,6 +284,7 @@ Ralph uses advanced error detection with two-stage filtering to eliminate false
|
|||
| `test_loop_execution.bats` | 20 | Integration tests |
|
||||
| `test_edge_cases.bats` | 20 | Edge case handling |
|
||||
| `test_installation.bats` | 14 | Global installation/uninstall workflows |
|
||||
| `test_project_setup.bats` | 36 | Project setup (setup.sh) validation |
|
||||
|
||||
### Running Tests
|
||||
```bash
|
||||
|
|
@ -299,6 +300,19 @@ bats tests/unit/test_cli_parsing.bats
|
|||
|
||||
## Recent Improvements
|
||||
|
||||
### Project Setup Tests (v0.9.4)
|
||||
- Added 36 comprehensive tests for `setup.sh` project initialization script
|
||||
- Tests cover: directory creation, subdirectory structure, template copying, git initialization
|
||||
- Template copying verification for PROMPT.md, @fix_plan.md, @AGENT.md
|
||||
- Git repository validation: .git exists, valid repo, initial commit, correct message
|
||||
- README.md creation and content verification
|
||||
- Custom and default project name handling
|
||||
- Working directory behavior (nested directories, relative paths)
|
||||
- Error handling: missing templates, missing PROMPT.md
|
||||
- Output message validation (startup, completion, next steps)
|
||||
- Edge cases: spaces in names, existing directories
|
||||
- Test count: 201 (up from 165)
|
||||
|
||||
### Installation Tests (v0.9.3)
|
||||
- Added 14 comprehensive tests for `install.sh` global installation script
|
||||
- Tests cover: directory creation, command installation, template copying, lib copying
|
||||
|
|
|
|||
459
tests/integration/test_project_setup.bats
Normal file
459
tests/integration/test_project_setup.bats
Normal file
|
|
@ -0,0 +1,459 @@
|
|||
#!/usr/bin/env bats
|
||||
# Integration tests for Ralph project setup (setup.sh)
|
||||
# Tests directory creation, template copying, git initialization, and README creation
|
||||
|
||||
load '../helpers/test_helper'
|
||||
load '../helpers/fixtures'
|
||||
|
||||
# Store the path to setup.sh from the project root
|
||||
SETUP_SCRIPT=""
|
||||
|
||||
setup() {
|
||||
# Create unique temporary test directory
|
||||
TEST_DIR="$(mktemp -d)"
|
||||
cd "$TEST_DIR"
|
||||
|
||||
# Store setup.sh path (relative to test directory)
|
||||
SETUP_SCRIPT="${BATS_TEST_DIRNAME}/../../setup.sh"
|
||||
|
||||
# Set git author info via environment variables (avoids mutating global config)
|
||||
export GIT_AUTHOR_NAME="Test User"
|
||||
export GIT_AUTHOR_EMAIL="test@example.com"
|
||||
export GIT_COMMITTER_NAME="Test User"
|
||||
export GIT_COMMITTER_EMAIL="test@example.com"
|
||||
|
||||
# Create mock templates directory (simulating ../templates relative to project being created)
|
||||
mkdir -p templates/specs
|
||||
|
||||
# Create mock template files with minimal but valid content
|
||||
cat > templates/PROMPT.md << 'EOF'
|
||||
# Ralph Development Instructions
|
||||
|
||||
## Context
|
||||
You are Ralph, an autonomous AI development agent.
|
||||
|
||||
## Current Objectives
|
||||
1. Follow @fix_plan.md for current priorities
|
||||
2. Implement using best practices
|
||||
3. Run tests after each implementation
|
||||
EOF
|
||||
|
||||
cat > templates/fix_plan.md << 'EOF'
|
||||
# Ralph Fix Plan
|
||||
|
||||
## High Priority
|
||||
- [ ] Initial setup task
|
||||
|
||||
## Medium Priority
|
||||
- [ ] Secondary task
|
||||
|
||||
## Notes
|
||||
- Focus on MVP functionality first
|
||||
EOF
|
||||
|
||||
cat > templates/AGENT.md << 'EOF'
|
||||
# Agent Build Instructions
|
||||
|
||||
## Project Setup
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
## Running Tests
|
||||
```bash
|
||||
npm test
|
||||
```
|
||||
EOF
|
||||
|
||||
# Create a sample spec file
|
||||
cat > templates/specs/sample_spec.md << 'EOF'
|
||||
# Sample Specification
|
||||
This is a sample spec file for testing.
|
||||
EOF
|
||||
}
|
||||
|
||||
teardown() {
|
||||
# Clean up test directory
|
||||
if [[ -n "$TEST_DIR" ]] && [[ -d "$TEST_DIR" ]]; then
|
||||
cd /
|
||||
rm -rf "$TEST_DIR"
|
||||
fi
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Project Directory Creation
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh creates project directory" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
assert_dir_exists "test-project"
|
||||
}
|
||||
|
||||
@test "setup.sh handles project name with hyphens" {
|
||||
run bash "$SETUP_SCRIPT" my-test-project
|
||||
|
||||
assert_success
|
||||
assert_dir_exists "my-test-project"
|
||||
}
|
||||
|
||||
@test "setup.sh handles project name with underscores" {
|
||||
run bash "$SETUP_SCRIPT" my_test_project
|
||||
|
||||
assert_success
|
||||
assert_dir_exists "my_test_project"
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Subdirectory Structure
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh creates all required subdirectories" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
assert_dir_exists "test-project/specs"
|
||||
assert_dir_exists "test-project/specs/stdlib"
|
||||
assert_dir_exists "test-project/src"
|
||||
assert_dir_exists "test-project/examples"
|
||||
assert_dir_exists "test-project/logs"
|
||||
assert_dir_exists "test-project/docs"
|
||||
assert_dir_exists "test-project/docs/generated"
|
||||
}
|
||||
|
||||
@test "setup.sh creates nested docs/generated directory" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
# Verify the nested structure exists
|
||||
[[ -d "test-project/docs/generated" ]]
|
||||
}
|
||||
|
||||
@test "setup.sh creates nested specs/stdlib directory" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
[[ -d "test-project/specs/stdlib" ]]
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Template Copying
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh copies PROMPT.md template" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
assert_file_exists "test-project/PROMPT.md"
|
||||
|
||||
# Verify content matches source
|
||||
diff templates/PROMPT.md test-project/PROMPT.md
|
||||
}
|
||||
|
||||
@test "setup.sh copies fix_plan.md as @fix_plan.md" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
assert_file_exists "test-project/@fix_plan.md"
|
||||
|
||||
# Verify content matches source
|
||||
diff templates/fix_plan.md "test-project/@fix_plan.md"
|
||||
}
|
||||
|
||||
@test "setup.sh copies AGENT.md as @AGENT.md" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
assert_file_exists "test-project/@AGENT.md"
|
||||
|
||||
# Verify content matches source
|
||||
diff templates/AGENT.md "test-project/@AGENT.md"
|
||||
}
|
||||
|
||||
@test "setup.sh copies specs templates if they exist" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
# Verify spec file was copied
|
||||
assert_file_exists "test-project/specs/sample_spec.md"
|
||||
}
|
||||
|
||||
@test "setup.sh handles empty specs directory gracefully" {
|
||||
# Remove spec files
|
||||
rm -f templates/specs/*
|
||||
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
# Should not fail (|| true in script handles this)
|
||||
assert_success
|
||||
assert_dir_exists "test-project/specs"
|
||||
}
|
||||
|
||||
@test "setup.sh handles missing specs directory gracefully" {
|
||||
# Remove specs directory entirely
|
||||
rm -rf templates/specs
|
||||
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
# Should not fail due to || true in script
|
||||
assert_success
|
||||
assert_dir_exists "test-project/specs"
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Git Initialization
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh initializes git repository" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
assert_dir_exists "test-project/.git"
|
||||
}
|
||||
|
||||
@test "setup.sh creates valid git repository" {
|
||||
bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
cd test-project
|
||||
run command git rev-parse --git-dir
|
||||
|
||||
assert_success
|
||||
assert_equal "$output" ".git"
|
||||
}
|
||||
|
||||
@test "setup.sh creates initial git commit" {
|
||||
bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
cd test-project
|
||||
run command git log --oneline
|
||||
|
||||
assert_success
|
||||
# Should have at least one commit
|
||||
[[ -n "$output" ]]
|
||||
}
|
||||
|
||||
@test "setup.sh uses correct initial commit message" {
|
||||
bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
cd test-project
|
||||
run command git log -1 --pretty=%B
|
||||
|
||||
assert_success
|
||||
# Remove trailing whitespace for comparison
|
||||
local commit_msg=$(echo "$output" | tr -d '\n')
|
||||
assert_equal "$commit_msg" "Initial Ralph project setup"
|
||||
}
|
||||
|
||||
@test "setup.sh commits all files in initial commit" {
|
||||
bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
cd test-project
|
||||
run command git status --porcelain
|
||||
|
||||
assert_success
|
||||
# Working tree should be clean (no uncommitted changes)
|
||||
assert_equal "$output" ""
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: README Creation
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh creates README.md" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
assert_file_exists "test-project/README.md"
|
||||
}
|
||||
|
||||
@test "setup.sh README contains project name" {
|
||||
bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
# Verify README contains the project name as heading
|
||||
grep -q "# test-project" test-project/README.md
|
||||
}
|
||||
|
||||
@test "setup.sh README is not empty" {
|
||||
bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
# File should have content
|
||||
[[ -s "test-project/README.md" ]]
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Custom Project Name
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh accepts custom project name as argument" {
|
||||
run bash "$SETUP_SCRIPT" custom-project-name
|
||||
|
||||
assert_success
|
||||
assert_dir_exists "custom-project-name"
|
||||
}
|
||||
|
||||
@test "setup.sh custom project has correct README heading" {
|
||||
bash "$SETUP_SCRIPT" custom-project-name
|
||||
|
||||
grep -q "# custom-project-name" custom-project-name/README.md
|
||||
}
|
||||
|
||||
@test "setup.sh custom project has all subdirectories" {
|
||||
bash "$SETUP_SCRIPT" my-custom-app
|
||||
|
||||
assert_dir_exists "my-custom-app/specs/stdlib"
|
||||
assert_dir_exists "my-custom-app/src"
|
||||
assert_dir_exists "my-custom-app/examples"
|
||||
assert_dir_exists "my-custom-app/logs"
|
||||
assert_dir_exists "my-custom-app/docs/generated"
|
||||
}
|
||||
|
||||
@test "setup.sh custom project has all template files" {
|
||||
bash "$SETUP_SCRIPT" my-custom-app
|
||||
|
||||
assert_file_exists "my-custom-app/PROMPT.md"
|
||||
assert_file_exists "my-custom-app/@fix_plan.md"
|
||||
assert_file_exists "my-custom-app/@AGENT.md"
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Default Project Name
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh uses default project name when none provided" {
|
||||
run bash "$SETUP_SCRIPT"
|
||||
|
||||
assert_success
|
||||
# Default name is "my-project" per line 6 of setup.sh
|
||||
assert_dir_exists "my-project"
|
||||
}
|
||||
|
||||
@test "setup.sh default project has correct README heading" {
|
||||
bash "$SETUP_SCRIPT"
|
||||
|
||||
grep -q "# my-project" my-project/README.md
|
||||
}
|
||||
|
||||
@test "setup.sh default project has all required structure" {
|
||||
bash "$SETUP_SCRIPT"
|
||||
|
||||
# Verify all directories
|
||||
assert_dir_exists "my-project/specs/stdlib"
|
||||
assert_dir_exists "my-project/src"
|
||||
assert_dir_exists "my-project/examples"
|
||||
assert_dir_exists "my-project/logs"
|
||||
assert_dir_exists "my-project/docs/generated"
|
||||
|
||||
# Verify all files
|
||||
assert_file_exists "my-project/PROMPT.md"
|
||||
assert_file_exists "my-project/@fix_plan.md"
|
||||
assert_file_exists "my-project/@AGENT.md"
|
||||
assert_file_exists "my-project/README.md"
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Working Directory Behavior
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh works from nested directory" {
|
||||
# Create a separate working area nested inside TEST_DIR
|
||||
mkdir -p work-area/subdir1/subdir2
|
||||
|
||||
# setup.sh does: cd $PROJECT_NAME && cp ../templates/PROMPT.md .
|
||||
# So templates needs to be in the SAME directory where we run setup.sh
|
||||
# (i.e., a sibling of the project directory that gets created)
|
||||
cp -r templates work-area/subdir1/subdir2/
|
||||
|
||||
cd work-area/subdir1/subdir2
|
||||
|
||||
run bash "$SETUP_SCRIPT" nested-project
|
||||
|
||||
assert_success
|
||||
assert_dir_exists "nested-project"
|
||||
}
|
||||
|
||||
@test "setup.sh creates project in current directory" {
|
||||
# Project should be created relative to where script is run, not where script lives
|
||||
mkdir -p work-area
|
||||
cd work-area
|
||||
|
||||
# Copy templates so they're accessible
|
||||
cp -r "$TEST_DIR/templates" .
|
||||
|
||||
run bash "$SETUP_SCRIPT" local-project
|
||||
|
||||
assert_success
|
||||
# Project should be in work-area directory
|
||||
assert_dir_exists "local-project"
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Output Messages
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh outputs startup message with project name" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
[[ "$output" == *"Setting up Ralph project: test-project"* ]]
|
||||
}
|
||||
|
||||
@test "setup.sh outputs completion message" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
[[ "$output" == *"Project test-project created"* ]]
|
||||
}
|
||||
|
||||
@test "setup.sh outputs next steps guidance" {
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_success
|
||||
[[ "$output" == *"Next steps:"* ]]
|
||||
[[ "$output" == *"PROMPT.md"* ]]
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Error Handling
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh fails if templates directory missing" {
|
||||
# Remove templates directory
|
||||
rm -rf templates
|
||||
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_failure
|
||||
}
|
||||
|
||||
@test "setup.sh fails if PROMPT.md template missing" {
|
||||
# Remove PROMPT.md template
|
||||
rm -f templates/PROMPT.md
|
||||
|
||||
run bash "$SETUP_SCRIPT" test-project
|
||||
|
||||
assert_failure
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Test: Idempotency and Edge Cases
|
||||
# =============================================================================
|
||||
|
||||
@test "setup.sh succeeds when run in an existing directory (idempotent)" {
|
||||
# Create project directory first
|
||||
mkdir -p existing-project
|
||||
|
||||
run bash "$SETUP_SCRIPT" existing-project
|
||||
|
||||
# The script uses mkdir -p which is idempotent, and git init works in existing dirs
|
||||
# Templates will be copied over existing files, so this should succeed
|
||||
[[ $status -eq 0 ]]
|
||||
}
|
||||
|
||||
@test "setup.sh handles project name with spaces by creating directory" {
|
||||
# Project names with spaces should work since the script uses "$PROJECT_NAME" with quotes
|
||||
run bash "$SETUP_SCRIPT" "project with spaces"
|
||||
|
||||
# The script properly quotes variables, so spaces should be handled correctly
|
||||
[[ $status -eq 0 ]]
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue