OpenWriterControle/scripts/tests/README.md
Darren Hinde bf02ad0d5c
refactor: Rename repository to OpenAgents Control (#100)
* refactor: Rename repository to OpenAgents Control

Update all project references from "OpenAgents" to "OpenAgents Control":
- Updated core config files (package.json, registry.json)
- Updated documentation (README.md, docs/)
- Updated scripts (install.sh, update.sh, test scripts)
- Updated agent and command files
- Updated integrations and packages
- Updated all GitHub URLs to use OpenAgentsControl

Naming convention:
- Display name: "OpenAgents Control"
- Repository URL: OpenAgentsControl

* feat: Enable subagent-to-subagent delegation (ContextScout integration)

Allow coding-related subagents to call ContextScout for context discovery:
- CoderAgent: Can now discover coding standards on-demand
- TestEngineer: Can now discover test coverage and TDD guidelines
- CodeReviewer: Can now discover code review and security patterns
- BuildAgent: Can now discover build validation standards
- DocWriter: Can now discover documentation formatting guidelines

Changes per subagent:
- Added `task: true` to tools section
- Added permission allowlist for ContextScout only (deny all other delegation)
- Added Context Discovery workflow section with when-to-call guidance

This enables subagents to be self-sufficient for finding relevant standards
instead of relying on orchestrator to provide all context files.

Benefits:
- Subagents can discover what they need when context isn't explicit
- Maintains security (only ContextScout allowed via task tool)
- Follows existing patterns (uses task tool like main agents)

* fix: Set OPENCODE_BRANCH in CI tests to use PR branch for downloads

- Add OPENCODE_BRANCH environment variable to E2E tests
- Add OPENCODE_BRANCH environment variable to profile smoke tests
- Ensures tests download files from the PR branch instead of main
- Fixes E2E test failures after repository rename to OpenAgentsControl
2026-01-18 09:31:35 +00:00

272 lines
6.6 KiB
Markdown

# OpenCode Installer Tests
This directory contains test scripts for validating the OpenCode installer functionality and compatibility.
**CI Integration:** These tests run automatically via `.github/workflows/installer-checks.yml` on any PR that modifies `install.sh`, `update.sh`, or `registry.json`.
## Quick Start
```bash
# Run all installer tests
for test in scripts/tests/test-*.sh; do bash "$test"; done
# Run specific test
bash scripts/tests/test-non-interactive.sh
```
## Available Tests
### 1. Compatibility Test (`test-compatibility.sh`)
Tests the installer's compatibility across different platforms and bash versions.
**Run locally:**
```bash
bash scripts/tests/test-compatibility.sh
```
**Run remotely:**
```bash
curl -fsSL https://raw.githubusercontent.com/darrenhinde/OpenAgentsControl/main/scripts/tests/test-compatibility.sh | bash
```
**What it tests:**
- ✅ Bash version (3.2+ required)
- ✅ Required dependencies (curl, jq)
- ✅ Script syntax validation
- ✅ Help command functionality
- ✅ List command functionality
- ✅ Profile argument parsing (with and without dashes)
- ✅ Array operations
- ✅ Parameter expansion
- ✅ Temp directory operations
- ✅ File operations
- ✅ Network connectivity
**Expected output:**
```
╔════════════════════════════════════════════════════════════════╗
║ OpenCode Installer Compatibility Test ║
╚════════════════════════════════════════════════════════════════╝
System Information:
Platform: macOS
Bash Version: 3.2.57(1)-release
Shell: /bin/bash
[12 tests run...]
╔════════════════════════════════════════════════════════════════╗
║ All Tests Passed! ✓ ║
╚════════════════════════════════════════════════════════════════╝
```
---
### 2. Non-Interactive Mode Test (`test-non-interactive.sh`)
**Critical test** - validates piped execution (`curl | bash`) scenarios.
**Run locally:**
```bash
bash scripts/tests/test-non-interactive.sh
```
**What it tests:**
- ✅ Fresh install via pipe (simulates `curl | bash -s profile`)
- ✅ Collision handling in non-interactive mode
- ✅ All profiles work non-interactively
- ✅ stdin detection and TTY handling
- ✅ NON_INTERACTIVE flag behavior
- ✅ Error handling without user input
**Why this matters:** Catches bugs where interactive prompts fail silently when stdin is not a terminal.
---
### 3. End-to-End Installation Test (`test-e2e-install.sh`)
Full installation workflow validation.
**Run locally:**
```bash
bash scripts/tests/test-e2e-install.sh
```
**What it tests:**
- ✅ Essential profile installs expected files
- ✅ Developer profile installs expected files
- ✅ Custom installation directory works
- ✅ Skip existing files strategy preserves user content
- ✅ File content validity (not empty/corrupted)
- ✅ Directory structure correctness
- ✅ Registry consistency
- ✅ Help and list commands
---
### 4. Collision Detection Test (`test-collision-detection.sh`)
Tests the installer's file collision detection and handling strategies.
**Run locally:**
```bash
bash scripts/tests/test-collision-detection.sh
```
**What it tests:**
- ✅ Detection of existing files
- ✅ Skip existing strategy
- ✅ Overwrite strategy
- ✅ Backup & overwrite strategy
- ✅ Collision reporting
- ✅ File grouping by type
---
## Running All Tests
```bash
# From repository root
for test in scripts/tests/test-*.sh; do
echo "Running $test..."
bash "$test"
echo ""
done
```
---
## Test Requirements
All tests require:
- Bash 3.2 or higher
- curl (for network tests)
- jq (for JSON parsing tests)
- Internet connection (for remote fetch tests)
---
## Adding New Tests
When adding new test scripts:
1. **Naming convention:** `test-<feature>.sh`
2. **Make executable:** `chmod +x scripts/tests/test-<feature>.sh`
3. **Add shebang:** `#!/usr/bin/env bash`
4. **Use colors:** Follow existing color scheme (GREEN, RED, YELLOW)
5. **Exit codes:** Exit 0 on success, 1 on failure
6. **Documentation:** Update this README
**Example test structure:**
```bash
#!/usr/bin/env bash
set -e
GREEN='\033[0;32m'
RED='\033[0;31m'
NC='\033[0m'
echo "Testing feature X..."
# Test 1
if [[ condition ]]; then
echo -e "${GREEN}✓${NC} Test 1 passed"
else
echo -e "${RED}✗${NC} Test 1 failed"
exit 1
fi
echo "All tests passed!"
```
---
## CI/CD Integration
These tests can be integrated into CI/CD pipelines:
**GitHub Actions example:**
```yaml
name: Test Installer
on: [push, pull_request]
jobs:
test:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, macos-latest]
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: |
if [[ "$OSTYPE" == "darwin"* ]]; then
brew install jq
else
sudo apt-get install -y jq
fi
- name: Run compatibility tests
run: bash scripts/tests/test-compatibility.sh
```
---
## Troubleshooting Tests
### Test fails with "command not found"
Install missing dependencies:
```bash
# macOS
brew install curl jq
# Ubuntu/Debian
sudo apt-get install curl jq
# Fedora/RHEL
sudo dnf install curl jq
```
### Network tests fail
Check internet connectivity:
```bash
curl -I https://github.com
```
### Permission errors
Make sure scripts are executable:
```bash
chmod +x scripts/tests/*.sh
```
---
## Test Coverage
Current test coverage:
- ✅ Platform compatibility (macOS, Linux, Windows)
- ✅ Bash version compatibility (3.2+)
- ✅ Argument parsing
- ✅ File collision handling
- ✅ Network operations
- ✅ File system operations
- ✅ Non-interactive/piped execution
- ✅ Profile installation end-to-end
- ✅ Registry validation
- ✅ Error handling scenarios
Future test additions:
- [ ] Component dependency resolution
- [ ] Rollback functionality
- [ ] Windows (Git Bash) specific tests
---
## Contributing
When contributing tests:
1. Ensure tests are idempotent (can run multiple times)
2. Clean up temporary files/directories
3. Provide clear success/failure messages
4. Test on multiple platforms if possible
5. Update this README with new test documentation