Skip to content

Commit 17b3995

Browse files
author
Developer
committed
docs: clarify Advanced CID API testing documentation
- Distinguish unit tests from integration tests in test commands - Add section for running real S5 portal integration tests - Document node test/integration/test-advanced-cid-real.js usage - Note test characteristics (real portal, delays, duration) Improves clarity between: - Unit tests (74 tests, mocked, fast) - Integration tests (18 tests, real portal, comprehensive)
1 parent 63a0b67 commit 17b3995

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ npm run test:ui # Run tests with UI
442442
npm run test:coverage # Generate coverage report
443443

444444
# Run specific test suites
445-
npm run test:run test/fs/cid-utils.test.ts test/fs/fs5-advanced.test.ts # Advanced CID API (74 tests)
445+
npm run test:run test/fs/cid-utils.test.ts test/fs/fs5-advanced.test.ts # Advanced CID API unit tests (74 tests)
446446
```
447447

448448
### Test Organization
@@ -460,6 +460,25 @@ npm run test:run test/fs/cid-utils.test.ts test/fs/fs5-advanced.test.ts # Advan
460460
- Tests that connect to real S5 portals (e.g., s5.vup.cx)
461461
- Use real seed phrases and portal registration
462462

463+
### Running Real S5 Portal Integration Tests
464+
465+
For comprehensive testing with real S5 infrastructure, use the standalone integration test scripts:
466+
467+
```bash
468+
# Build the project first
469+
npm run build
470+
471+
# Run Advanced CID API integration tests with real S5 portal
472+
node test/integration/test-advanced-cid-real.js
473+
```
474+
475+
**Note:** These tests:
476+
- Connect to real S5 portals (default: https://s5.vup.cx)
477+
- Use actual registry operations with 5+ second propagation delays
478+
- Run sequentially to avoid registry conflicts
479+
- Generate temporary test files (auto-cleaned)
480+
- Take ~2 minutes to complete (18 tests)
481+
463482
## Media Processing Tests & Demos
464483

465484
### Phase 5 Media Processing Foundation

0 commit comments

Comments
 (0)