mcp-abap-adt

# Tests Directory This directory contains test scripts for the MCP ABAP ADT server functionality. ## 📖 Full Documentation **Complete testing documentation is available in**: [`doc/tests/`](../doc/tests/README.md) Including: - [Testing Guide](../doc/tests/TESTING_GUIDE.md) - Complete instructions - [Test Infrastructure](../doc/tests/TEST_INFRASTRUCTURE.md) - Technical overview - [CreateDomain Tool](../doc/tests/CREATE_DOMAIN_TOOL.md) - Handler documentation - [Config Template](../doc/tests/test-config.yaml.template) - YAML template ## 🎯 YAML-Based Testing (Recommended) All tests now support centralized configuration via `test-config.yaml`. This provides: - **One place** for all test parameters - **Easy updates** for transport requests and system-specific values - **Consistent testing** across all handlers - **Command-line override** still available for ad-hoc testing ### Quick Start 1. **Create test configuration from template**: ```bash cp test-config.yaml.template test-config.yaml ``` 2. **Update test parameters** in `test-config.yaml`: ```yaml create_domain: test_cases: - name: "basic_char_domain" enabled: true params: domain_name: "ZZ_TEST_MCP_01" transport_request: "<YOUR_TRANSPORT>" # ⚠️ UPDATE THIS! ``` 3. **Run a single test**: ```bash node tests/test-create-domain.js ``` 4. **Run all enabled tests**: ```bash node tests/run-all-tests.js ``` 5. **List available tests**: ```bash node tests/run-all-tests.js --list ``` ### Test Helper Common utilities in `test-helper.js`: - `getEnabledTestCase(handlerName)` - Load test from YAML - `printTestHeader()`, `printTestParams()`, `printTestResult()` - Formatted output - `validateTransportRequest()` - Warn about default transport values ### Example Test Structure ```javascript const { handleMyHandler } = require('../dist/handlers/handleMyHandler'); const { getEnabledTestCase, printTestHeader, printTestParams, printTestResult } = require('./test-helper'); async function main() { const testCase = getEnabledTestCase('my_handler'); printTestHeader('MyHandler', testCase); printTestParams(testCase.params); const result = await handleMyHandler(testCase.params); if (!printTestResult(result, 'MyHandler')) { process.exit(1); } } main(); ``` ## ⚠️ Important - `test-config.yaml` is **not tracked in git** (contains transport requests) - Always use `test-config.yaml.template` as starting point - Update transport requests before running write operations - Run `npm run build` before testing ## 🌐 Cloud vs S4HANA Compatibility Tests are configured to support both Cloud and S4HANA environments: - **Cloud-compatible tests** (enabled: true): Use FUGR (Function Groups) and CLAS/OC (Classes) - **S4HANA-only tests** (enabled: false): Use PROG/P (Programs) - can be enabled for on-premise systems - **Test configs** include both variants where applicable (e.g., `get_prog_full_code` has both FUGR and PROG/P test cases) To enable S4HANA tests, set `enabled: true` in `test-config.yaml` for the corresponding test cases. ## Test Categories ### Activation Tests - `test-activate-object.js` - **Group activation** of 2-3 related ABAP objects - Uses `/sap/bc/adt/activation/runs` endpoint - Designed for activating 2-3 related objects together (not mass activation) - Configure in `test-config.yaml` under `activate_object` section **Example usage**: ```bash # Configure 2-3 objects in test-config.yaml: # activate_object: # objects: # - name: "ZCL_TEST_MCP_01" # uri: "/sap/bc/adt/oo/classes/zcl_test_mcp_01" # type: "CLAS/OC" # - name: "Z_TEST_PROGRAM_01" # uri: "/sap/bc/adt/programs/programs/z_test_program_01" # type: "PROG/P" # preaudit: false # Run the test node tests/test-activate-object.js ``` See [README_GROUP_ACTIVATION.md](README_GROUP_ACTIVATION.md) for detailed guide. ### Enhancement Tests - `test-enhancement-by-name.js` - Test getting enhancements by specific name - `test-enhancement-timeout.js` - Test enhancement timeout handling - `test-enhancement-timeout-optimized.js` - Optimized enhancement timeout tests - `test-get-enhancements.js` - General enhancement retrieval tests - `test-rm07docs-enhancements.js` - Comprehensive RM07DOCS enhancement tests - `test-rm07docs-fast.js` - Fast timeout tests for RM07DOCS ### Include Tests - `test-get-includes-list.js` - Test include list retrieval (uses test-helper, supports Cloud/FUGR and S4HANA/PROG) - `test-includes-list-timeout.js` - Test include list timeout handling ### Program/Function Group Tests - `test-get-program.js` - Test program retrieval (S4HANA only, disabled in Cloud) - `test-get-prog-full-code.js` - Test full code retrieval with includes (Cloud: FUGR, S4HANA: PROG/P) - `test-sapmv45a-large-program.js` - Test large program handling (SAPMV45A, S4HANA only) - `test-sapmv45a-large-program-fixed.js` - Fixed version of large program test (S4HANA only) ### Object List/Structure Tests - `test-get-objects-list.js` - Test objects list retrieval (uses test-helper, supports Cloud/FUGR and S4HANA/PROG) - `test-get-object-structure.js` - Test object structure retrieval (uses test-helper) - `test-node-structure.js` - Test SAP node structure API - `test-related-objects.js` - Test related objects functionality - `test-simplified-related-types.js` - Simplified related types test ### Infrastructure Tests - `test-csrf.js` - Test CSRF token handling - `test-list-tools.js` - Test MCP tools listing - `test-stdio.js` - Test STDIO communication - `test-simple-timeout.js` - Simple timeout functionality test - `test-two-step-approach.js` - Test two-step processing approach ## Running Tests ### Individual Tests ```bash # Run specific test node tests/test-rm07docs-fast.js # Run enhancement tests node tests/test-get-enhancements.js node tests/test-rm07docs-enhancements.js # Run include tests node tests/test-get-includes-list.js node tests/test-includes-list-timeout.js ``` ### Quick Performance Tests ```bash # Fast RM07DOCS tests (recommended for development) node tests/test-rm07docs-fast.js # Comprehensive RM07DOCS tests node tests/test-rm07docs-enhancements.js # Large program tests (SAPMV45A) node tests/test-sapmv45a-large-program-fixed.js ``` ## Test Requirements All tests require: 1. **Environment file**: `.env` file in the project root with SAP connection details 2. **Built server**: Run `npm run build` before testing 3. **SAP system access**: Valid SAP credentials and accessible SAP system ## Environment Setup Create `.env` file in project root: ```env SAP_BASE_URL=https://your-sap-system.com:port SAP_USERNAME=your-username SAP_PASSWORD=your-password SAP_CLIENT=100 ``` ## Test Results Interpretation ### Success Indicators - ✅ **Success messages** with timing information - 📊 **Object counts** (objects analyzed, enhancements found) - ⏱️ **Performance metrics** (duration in milliseconds) ### Failure Indicators - ❌ **Error messages** with specific error details - 🚨 **Timeout warnings** indicating performance issues - ⚠️ **Partial results** when some operations fail ### Performance Benchmarks **RM07DOCS (Small Program):** - Without nested: ~1-2 seconds - With nested: ~6-7 seconds **SAPMV45A (Large Program):** - Without nested: ~3-5 seconds - With nested: ~15-30 seconds (depending on timeout) ## Troubleshooting ### Common Issues 1. **Connection Errors** - Check `.env` file configuration - Verify SAP system accessibility - Confirm credentials are correct 2. **Timeout Errors** - Increase timeout values in test parameters - Check network connectivity - Consider using non-nested mode for faster results 3. **Authentication Errors** - Verify username/password in `.env` - Check if account is locked - Confirm client number is correct ### Debug Mode Add debug logging by setting environment variable: ```bash DEBUG=1 node tests/test-name.js ``` ## Contributing When adding new tests: 1. Follow naming convention: `test-feature-name.js` 2. Include comprehensive error handling 3. Add timeout controls for long-running operations 4. Document expected results and performance benchmarks 5. Update this README with test description