docs: update ROM test paths and envs

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

View File

@@ -122,7 +122,7 @@ The script intelligently preserves conditional blocks (if/endif) and excludes co
- Check for `clang-cl`, Ninja, NASM, Visual Studio workloads, and VS Code (optional).
- Validate vcpkg bootstrap status plus `vcpkg/installed` cache contents.
- Warn about missing ROM assets (`zelda3.sfc`, `assets/zelda3.sfc`, etc.).
- Warn about missing ROM assets (`roms/alttp_vanilla.sfc`, etc.).
- Offer `-FixIssues` and `-CleanCache` switches to repair Git config, resync submodules, and wipe stale build directories.
Run the script once per machine (and rerun after major toolchain updates) to ensure presets such as `win-dbg`, `win-ai`, `mac-ai`, and `ci-windows-ai` have everything they need.

View File

@@ -89,9 +89,9 @@ Options:
--cleanup Clean up test files after completion
Examples:
$0 zelda3.sfc
$0 zelda3.sfc --generate-report --cleanup
$0 /path/to/rom.sfc --skip-unit-tests
$0 roms/alttp_vanilla.sfc
$0 roms/alttp_vanilla.sfc --generate-report --cleanup
$0 /path/to/alttp_vanilla.sfc --skip-unit-tests
EOF
}
@@ -233,6 +233,7 @@ run_unit_tests() {
cd "$PROJECT_ROOT"
# Set environment variable for ROM path
export YAZE_TEST_ROM_VANILLA="$ROM_PATH"
export YAZE_TEST_ROM_PATH="$ROM_PATH"
# Run unit tests
@@ -258,6 +259,7 @@ run_integration_tests() {
cd "$PROJECT_ROOT"
# Set environment variable for ROM path
export YAZE_TEST_ROM_VANILLA="$ROM_PATH"
export YAZE_TEST_ROM_PATH="$ROM_PATH"
# Run integration tests
@@ -283,6 +285,7 @@ run_e2e_tests() {
cd "$PROJECT_ROOT"
# Set environment variable for ROM path
export YAZE_TEST_ROM_VANILLA="$ROM_PATH"
export YAZE_TEST_ROM_PATH="$ROM_PATH"
# Run E2E tests

View File

@@ -4,11 +4,15 @@
param(
[string]$YazeBin = "build-windows\bin\Debug\yaze.exe",
[string]$Z3edBin = "build-windows\bin\Debug\z3ed.exe",
[string]$TestRom = "zelda3.sfc"
[string]$TestRom = $env:YAZE_TEST_ROM_VANILLA
)
$ErrorActionPreference = "Continue"
if (-not $TestRom) {
$TestRom = "roms\alttp_vanilla.sfc"
}
function Write-Header {
Write-Host "`n╔════════════════════════════════════════════════════════════════╗" -ForegroundColor Cyan
Write-Host "║ YAZE AI Features Test Suite (Windows) ║" -ForegroundColor Cyan

View File

@@ -15,7 +15,7 @@ NC='\033[0m'
# Configuration
YAZE_BIN="${YAZE_BIN:-./build/bin/yaze}"
Z3ED_BIN="${Z3ED_BIN:-./build/bin/z3ed}"
TEST_ROM="${TEST_ROM:-./zelda3.sfc}"
TEST_ROM="${TEST_ROM:-${YAZE_TEST_ROM_VANILLA:-./roms/alttp_vanilla.sfc}}"
GEMINI_API_KEY="${GEMINI_API_KEY:-}"
SCREENSHOTS_DIR="./test_screenshots"

View File

@@ -5,7 +5,7 @@
set -e
# Configuration
ROM_FILE="${1:-zelda3.sfc}"
ROM_FILE="${1:-roms/alttp_vanilla.sfc}"
BUILD_DIR="build/bin"
LOG_FILE="dungeon_loading_test.log"
@@ -23,7 +23,7 @@ echo ""
# Check if ROM file exists
if [ ! -f "$ROM_FILE" ]; then
echo -e "${RED}ERROR: ROM file not found: $ROM_FILE${NC}"
echo "Usage: $0 [path/to/zelda3.sfc]"
echo "Usage: $0 [path/to/alttp_vanilla.sfc]"
exit 1
fi
@@ -169,4 +169,3 @@ kill $YAZE_PID 2>/dev/null || true
echo "yaze stopped."
exit 0

View File

@@ -91,11 +91,10 @@ echo ""
echo "=== Ready to Test! ==="
echo ""
echo "To start testing:"
echo "1. Terminal 1: ./build/bin/yaze assets/zelda3.sfc --enable-test-harness"
echo "2. Terminal 2: export AI_PROVIDER=ollama && ./build/bin/z3ed agent chat --rom assets/zelda3.sfc"
echo "1. Terminal 1: ./build/bin/yaze roms/alttp_vanilla.sfc --enable-test-harness"
echo "2. Terminal 2: export AI_PROVIDER=ollama && ./build/bin/z3ed agent chat --rom roms/alttp_vanilla.sfc"
echo "3. Try: 'What buttons are available in the Overworld editor?'"
echo ""
echo "Or use Gemini:"
echo "2. Terminal 2: export AI_PROVIDER=gemini && export GEMINI_API_KEY='...' && ./build/bin/z3ed agent chat --rom assets/zelda3.sfc"
echo "2. Terminal 2: export AI_PROVIDER=gemini && export GEMINI_API_KEY='...' && ./build/bin/z3ed agent chat --rom roms/alttp_vanilla.sfc"
echo ""

View File

@@ -426,10 +426,10 @@ function Test-VSCode {
function Test-RomAssets {
Write-Status "Checking for local Zelda 3 ROM assets..." "Step"
$romPaths = @(
"zelda3.sfc",
"assets/zelda3.sfc",
"roms/alttp_vanilla.sfc",
"roms/Legend of Zelda, The - A Link to the Past (USA).sfc",
"assets/zelda3.yaze",
"Roms/zelda3.sfc"
"Roms/alttp_vanilla.sfc"
)
foreach ($relativePath in $romPaths) {
@@ -441,7 +441,7 @@ function Test-RomAssets {
}
}
Write-Status "No ROM asset detected. Place a clean 'zelda3.sfc' in the repo root or assets/ directory." "Warning"
Write-Status "No ROM asset detected. Place a clean 'alttp_vanilla.sfc' in roms/ or set YAZE_TEST_ROM_VANILLA." "Warning"
$script:warnings += "ROM assets missing - GUI workflows that load ROMs will fail until one is provided."
}