scawful/yaze
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update ROM test paths and envs

Browse Source
This commit is contained in:
scawful
2025-12-22 14:50:57 -05:00
parent 42ae359abc
commit 319e903f24
22 changed files with 102 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/public/cli/test-commands.md
View File

@@ -152,6 +152,8 @@ z3ed test-status --format json
### Sample Output (JSON)
```json
{
"rom_vanilla": "not set",
"rom_expanded": "not set",
"rom_path": "not set",
"skip_rom_tests": false,
"ui_tests_enabled": false,
@@ -167,7 +169,9 @@ The test commands respect these environment variables:
| Variable | Description |
|----------|-------------|
| `YAZE_TEST_ROM_PATH` | Path to Zelda3 ROM for ROM-dependent tests |
| `YAZE_TEST_ROM_VANILLA` | Path to vanilla Zelda3 ROM for ROM-dependent tests |
| `YAZE_TEST_ROM_EXPANDED` | Path to expanded Zelda3 ROM (ZSCustom/OOS) |
| `YAZE_TEST_ROM_PATH` | Legacy ROM path (vanilla fallback) |
| `YAZE_SKIP_ROM_TESTS` | Set to `1` to skip ROM tests |
| `YAZE_ENABLE_UI_TESTS` | Set to `1` to enable UI tests |
@@ -200,7 +204,7 @@ if [ $? -eq 0 ]; then echo "All tests passed"; fi
### With ROM Tests
```bash
# Set ROM path
export YAZE_TEST_ROM_PATH=/path/to/zelda3.sfc
export YAZE_TEST_ROM_VANILLA=/path/to/alttp_vanilla.sfc
# Configure with ROM tests enabled
cmake --preset mac-dev -DYAZE_ENABLE_ROM_TESTS=ON

2
docs/public/developer/debugging-guide.md
View File

@@ -108,7 +108,7 @@ The `yaze_test` executable is used to run the project's suite of unit, integrati
./build/bin/yaze_test --unit
# Run tests that require a ROM file
./build/bin/yaze_test --rom-dependent --rom-path /path/to/zelda3.sfc
./build/bin/yaze_test --rom-dependent --rom-vanilla /path/to/alttp_vanilla.sfc
```
- **Run GUI-based E2E Tests**:

4
docs/public/developer/testing-guide.md
View File

@@ -78,7 +78,7 @@ cmake --build build --target yaze_test
./build/bin/yaze_test --e2e --show-gui
# Run ROM-dependent tests
./build/bin/yaze_test --rom-dependent --rom-path /path/to/zelda3.sfc
./build/bin/yaze_test --rom-dependent --rom-vanilla /path/to/alttp_vanilla.sfc
# Run by pattern
./build/bin/yaze_test "*Asar*"
@@ -91,7 +91,7 @@ cmake --build build --target yaze_test
```bash
# Configure with ROM tests
cmake --preset mac-dev -DYAZE_TEST_ROM_PATH=/path/to/zelda3.sfc
cmake --preset mac-dev -DYAZE_TEST_ROM_VANILLA_PATH=/path/to/alttp_vanilla.sfc
# Build
cmake --build --preset mac-dev --target yaze_test

13
docs/public/developer/testing-quick-start.md
View File

@@ -66,8 +66,8 @@ Run the **complete test suite** before pushing if:
# Run all tests (may take 5+ minutes)
./build/bin/yaze_test
# Include ROM-dependent tests (requires zelda3.sfc)
./build/bin/yaze_test --rom-dependent --rom-path /path/to/zelda3.sfc
# Include ROM-dependent tests (requires alttp_vanilla.sfc)
./build/bin/yaze_test --rom-dependent --rom-vanilla /path/to/alttp_vanilla.sfc
# Run E2E GUI tests (headless)
./build/bin/yaze_test --e2e
@@ -107,10 +107,10 @@ cmake --build build --target yaze_test
**Fix**:
```bash
# Set environment variable
export YAZE_TEST_ROM_PATH=/path/to/zelda3.sfc
export YAZE_TEST_ROM_VANILLA=/path/to/alttp_vanilla.sfc
# Or pass directly to test runner
./build/bin/yaze_test --rom-path /path/to/zelda3.sfc
./build/bin/yaze_test --rom-vanilla /path/to/alttp_vanilla.sfc
```
### 4. E2E/GUI Test Failures
@@ -177,7 +177,7 @@ git push
```bash
# Run everything including ROM tests and E2E
./build/bin/yaze_test --rom-dependent --rom-path zelda3.sfc
./build/bin/yaze_test --rom-dependent --rom-vanilla roms/alttp_vanilla.sfc
./build/bin/yaze_test --e2e
# Check code formatting
@@ -238,7 +238,8 @@ Customize test behavior with these environment variables:
```bash
# Path to test ROM file
export YAZE_TEST_ROM_PATH=/path/to/zelda3.sfc
export YAZE_TEST_ROM_VANILLA=/path/to/alttp_vanilla.sfc
export YAZE_TEST_ROM_EXPANDED=/path/to/oos168.sfc
# Skip ROM-dependent tests entirely
export YAZE_SKIP_ROM_TESTS=1

4
docs/public/reference/changelog.md
View File

@@ -20,8 +20,8 @@
**ROM Auto-Discovery**:
- Tests now automatically discover ROMs in common locations (roms/, ../roms/, etc.)
- Searches for common filenames: zelda3.sfc, alttp_vanilla.sfc, vanilla.sfc
- Environment variable `YAZE_TEST_ROM_PATH` still takes precedence if set
- Searches for common vanilla filenames: alttp_vanilla.sfc, Legend of Zelda, The - A Link to the Past (USA).sfc
- Legacy environment variable `YAZE_TEST_ROM_PATH` is still supported as a fallback
**Overworld Regression Tests**:
- Added 9 new regression tests for save function version checks