README.mdâĸ2.46 kB
# Test Documentation
This folder contains all documentation related to testing MCP ABAP ADT handlers.
## đ Documentation Files
### [TESTING_GUIDE.md](TESTING_GUIDE.md)
Complete guide for running tests:
- Quick start instructions
- YAML-based test configuration
- Test helper utilities
- Running tests (single, multiple, all)
- Adding new tests
- Troubleshooting
### [TEST_INFRASTRUCTURE.md](TEST_INFRASTRUCTURE.md)
Technical overview of the test infrastructure:
- What was implemented (YAML config, test-helper, test runner)
- File structure
- Usage examples
- Benefits and advantages
- Migration path for legacy tests
- Test coverage status
### [CREATE_DOMAIN_TOOL.md](CREATE_DOMAIN_TOOL.md)
Documentation for the CreateDomain MCP tool:
- Complete API reference
- Workflow steps (lock â create â check â unlock â activate â verify)
- Session management architecture
- Input parameters and response format
- Error handling
- Testing examples
### [test-config.yaml.template](test-config.yaml.template)
Template for test configuration:
- Copy to `tests/test-config.yaml` before running tests
- Update transport requests and system-specific values
- Enable/disable test cases as needed
## đ Quick Start
1. **Create test configuration**:
```bash
cp doc/tests/test-config.yaml.template tests/test-config.yaml
```
2. **Update configuration**:
- Edit `tests/test-config.yaml`
- Set real transport request
- Enable desired test cases
3. **Run tests**:
```bash
npm run build
node tests/run-all-tests.js --list # See all tests
node tests/test-create-domain.js # Run single test
node tests/run-all-tests.js # Run all enabled
```
## đ Related Files
Test scripts are located in: `tests/`
- `test-helper.js` - Common utilities
- `run-all-tests.js` - Universal test runner
- `test-*.js` - Individual handler tests
- `test-config.yaml` - Your local config (not in git)
- `test-config.yaml.template` - Template for config
## â ī¸ Important Notes
- **Never commit** `tests/test-config.yaml` (contains transport requests)
- **Always use template** to create new test config
- **Update transport requests** before running write operations
- **Build before testing**: `npm run build`
## đ See Also
- [Main README](../../../README.md) - Project overview
- [CHANGELOG](../../../CHANGELOG.md) - Version history
- [Architecture Documentation](../../architecture/) - System architecture and design