MayaTheShy/Starworld
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: update README for clarity and structure in test suite documentation

Browse Source
This commit is contained in:
MayaTheShy
2025-11-09 00:10:29 -05:00
parent 99e8198f06
commit 98e527099b
1 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
tests/README.md
View File

@@ -1,12 +1,24 @@
This folder contains a minimal C++ test harness for starworld. # Starworld Test Suite
Build target: stardust-tests This folder contains the C++ test harness for Starworld.
What it checks: ## Build Target
- Protocol signature stability: compares NLPacket::computeProtocolVersionSignature() against the expected value for the vendored Overte commit.
- Domain discovery parsing: validates that JSON containing Vircadia- or Overte-style fields is parsed into host/port pairs correctly.
Run: `starworld-tests` - Built alongside the main executable
./build/stardust-tests
## What It Tests
1. **Protocol signature stability**: Compares `NLPacket::computeProtocolVersionSignature()` against the expected value for the vendored Overte protocol
2. **Domain discovery parsing**: Validates JSON parsing from Vircadia/Overte metaverse directories into host/port pairs
## Running Tests
```bash
./build/starworld-tests
```
Exit code 0 indicates PASS. Exit code 0 indicates PASS.
## Test Files
- `TestHarness.cpp` - Main test implementation with protocol and discovery tests