backend-infra-engineer: Release v0.3.2 snapshot
This commit is contained in:
176
test/e2e/README.md
Normal file
176
test/e2e/README.md
Normal file
@@ -0,0 +1,176 @@
|
||||
# End-to-End (E2E) Tests
|
||||
|
||||
This directory contains E2E tests using ImGui Test Engine to validate complete user workflows.
|
||||
|
||||
## Active Tests
|
||||
|
||||
### ✅ Working Tests
|
||||
|
||||
1. **framework_smoke_test.cc** - Basic framework validation
|
||||
2. **canvas_selection_test.cc** - Canvas selection and copy/paste workflow
|
||||
3. **dungeon_editor_smoke_test.cc** - Dungeon editor UI navigation and interaction
|
||||
4. **overworld/overworld_e2e_test.cc** - Overworld editor workflows
|
||||
5. **rom_dependent/e2e_rom_test.cc** - ROM-dependent functionality tests
|
||||
6. **zscustomoverworld/zscustomoverworld_upgrade_test.cc** - ZSCustomOverworld upgrade tests
|
||||
|
||||
### 📝 Dungeon Editor Smoke Test
|
||||
|
||||
**File**: `dungeon_editor_smoke_test.cc`
|
||||
**Status**: ✅ Working and registered
|
||||
|
||||
Tests complete dungeon editor workflow:
|
||||
- ROM loading
|
||||
- Editor window opening
|
||||
- Room selection (0x00, 0x01, 0x02)
|
||||
- Canvas interaction
|
||||
- Tab navigation (Object Selector, Room Graphics, Object Editor, Entrances)
|
||||
- Mode button verification (Select, Insert, Edit)
|
||||
- Detailed logging at each step
|
||||
|
||||
## Running Tests
|
||||
|
||||
### All E2E Tests (GUI Mode)
|
||||
```bash
|
||||
./build/bin/yaze_test --show-gui
|
||||
```
|
||||
|
||||
### Specific Test Category
|
||||
```bash
|
||||
./build/bin/yaze_test --show-gui --gtest_filter="E2ETest*"
|
||||
```
|
||||
|
||||
### Dungeon Editor Test Only
|
||||
```bash
|
||||
./build/bin/yaze_test --show-gui --gtest_filter="*DungeonEditorSmokeTest"
|
||||
```
|
||||
|
||||
## Test Development
|
||||
|
||||
### Creating New Tests
|
||||
|
||||
Follow the pattern in `dungeon_editor_smoke_test.cc`:
|
||||
|
||||
```cpp
|
||||
#include "e2e/my_new_test.h"
|
||||
#include "test_utils.h"
|
||||
#include "app/core/controller.h"
|
||||
|
||||
void E2ETest_MyNewTest(ImGuiTestContext* ctx) {
|
||||
// Load ROM
|
||||
yaze::test::gui::LoadRomInTest(ctx, "zelda3.sfc");
|
||||
|
||||
// Open editor
|
||||
yaze::test::gui::OpenEditorInTest(ctx, "My Editor");
|
||||
|
||||
// Test interactions with logging
|
||||
ctx->LogInfo("Starting test...");
|
||||
ctx->WindowFocus("My Editor");
|
||||
ctx->ItemClick("MyButton");
|
||||
ctx->LogInfo("Test completed");
|
||||
}
|
||||
```
|
||||
|
||||
### Register in yaze_test.cc
|
||||
|
||||
```cpp
|
||||
#include "e2e/my_new_test.h"
|
||||
|
||||
// In RunGuiMode():
|
||||
ImGuiTest* my_test = IM_REGISTER_TEST(engine, "E2ETest", "MyNewTest");
|
||||
my_test->TestFunc = E2ETest_MyNewTest;
|
||||
my_test->UserData = &controller;
|
||||
```
|
||||
|
||||
### ImGui Test Engine API
|
||||
|
||||
Key methods available:
|
||||
- `ctx->WindowFocus("WindowName")` - Focus a window
|
||||
- `ctx->SetRef("WindowName")` - Set reference window for relative queries
|
||||
- `ctx->ItemClick("ButtonName")` - Click an item
|
||||
- `ctx->ItemExists("ItemName")` - Check if item exists
|
||||
- `ctx->LogInfo("message", ...)` - Log information
|
||||
- `ctx->LogWarning("message", ...)` - Log warning
|
||||
- `ctx->LogError("message", ...)` - Log error
|
||||
- `ctx->Yield()` - Yield to allow UI to update
|
||||
|
||||
Full API: `src/lib/imgui_test_engine/imgui_te_engine.h`
|
||||
|
||||
## Test Logging
|
||||
|
||||
Tests log detailed information during execution. View logs:
|
||||
- In GUI mode: Check ImGui Test Engine window
|
||||
- In CI mode: Check console output
|
||||
- Look for lines starting with date/time stamps
|
||||
|
||||
Example log output:
|
||||
```
|
||||
2025-10-04 14:03:38 INFO: === Starting Dungeon Editor E2E Test ===
|
||||
2025-10-04 14:03:38 INFO: Loading ROM...
|
||||
2025-10-04 14:03:38 INFO: ROM loaded successfully
|
||||
2025-10-04 14:03:38 INFO: Opening Dungeon Editor...
|
||||
```
|
||||
|
||||
## Test Infrastructure
|
||||
|
||||
### File Organization
|
||||
```
|
||||
test/e2e/
|
||||
├── README.md (this file)
|
||||
├── framework_smoke_test.{cc,h}
|
||||
├── canvas_selection_test.{cc,h}
|
||||
├── dungeon_editor_smoke_test.{cc,h} ← Latest dungeon test
|
||||
├── overworld/
|
||||
│ └── overworld_e2e_test.cc
|
||||
├── rom_dependent/
|
||||
│ └── e2e_rom_test.cc
|
||||
└── zscustomoverworld/
|
||||
└── zscustomoverworld_upgrade_test.cc
|
||||
```
|
||||
|
||||
### Helper Functions
|
||||
|
||||
Available in `test_utils.h`:
|
||||
- `yaze::test::gui::LoadRomInTest(ctx, "zelda3.sfc")` - Load ROM for testing
|
||||
- `yaze::test::gui::OpenEditorInTest(ctx, "Editor Name")` - Open an editor window
|
||||
|
||||
## Future Test Ideas
|
||||
|
||||
Potential tests to add:
|
||||
- [ ] Object placement workflow
|
||||
- [ ] Object property editing
|
||||
- [ ] Layer visibility toggling
|
||||
- [ ] Save workflow validation
|
||||
- [ ] Sprite editor workflows
|
||||
- [ ] Palette editor workflows
|
||||
- [ ] Music editor workflows
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Test Crashes in GUI Mode
|
||||
- Ensure ROM exists at `assets/zelda3.sfc`
|
||||
- Check logs for specific error messages
|
||||
- Try running without `--show-gui` first
|
||||
|
||||
### Tests Not Found
|
||||
- Verify test is registered in `yaze_test.cc`
|
||||
- Check that files are added to CMakeLists.txt
|
||||
- Rebuild: `make -C build yaze_test`
|
||||
|
||||
### ImGui Items Not Found
|
||||
- Use `ctx->ItemExists("ItemName")` to check availability
|
||||
- Ensure window is focused with `ctx->WindowFocus()`
|
||||
- Check actual widget IDs in source code (look for `##` suffixes)
|
||||
|
||||
## References
|
||||
|
||||
- **ImGui Test Engine**: `src/lib/imgui_test_engine/`
|
||||
- **Test Registration**: `test/yaze_test.cc`
|
||||
- **Test Utilities**: `test/test_utils.h`
|
||||
- **Working Examples**: See existing tests in this directory
|
||||
|
||||
## Status
|
||||
|
||||
**Current State**: E2E testing infrastructure is working with 6+ active tests.
|
||||
**Test Coverage**: Basic workflows covered; opportunity for expansion.
|
||||
**Stability**: Tests run reliably in both GUI and CI modes.
|
||||
|
||||
76
test/e2e/canvas_selection_test.cc
Normal file
76
test/e2e/canvas_selection_test.cc
Normal file
@@ -0,0 +1,76 @@
|
||||
#define IMGUI_DEFINE_MATH_OPERATORS
|
||||
#include "e2e/canvas_selection_test.h"
|
||||
#include "app/controller.h"
|
||||
#include "test_utils.h"
|
||||
|
||||
void E2ETest_CanvasSelectionTest(ImGuiTestContext* ctx)
|
||||
{
|
||||
yaze::test::gui::LoadRomInTest(ctx, "zelda3.sfc");
|
||||
yaze::Controller* controller = (yaze::Controller*)ctx->Test->UserData;
|
||||
yaze::zelda3::Overworld* overworld = controller->overworld();
|
||||
|
||||
// 1. Open the Overworld Editor
|
||||
yaze::test::gui::OpenEditorInTest(ctx, "Overworld Editor");
|
||||
|
||||
// 2. Find the canvas
|
||||
ctx->WindowFocus("Overworld Editor");
|
||||
ctx->ItemClick("##Canvas");
|
||||
|
||||
// 3. Get the original tile data
|
||||
// We'll check the 2x2 tile area at the paste location (600, 300)
|
||||
// The tile at (600, 300) is at (75, 37) in tile coordinates.
|
||||
// The overworld map is 128x128 tiles.
|
||||
uint16_t orig_tile1 = overworld->GetTile(75, 37);
|
||||
uint16_t orig_tile2 = overworld->GetTile(76, 37);
|
||||
uint16_t orig_tile3 = overworld->GetTile(75, 38);
|
||||
uint16_t orig_tile4 = overworld->GetTile(76, 38);
|
||||
|
||||
// 4. Perform a rectangle selection that crosses a 512px boundary
|
||||
// The canvas is 1024x1024, with the top-left at (0,0).
|
||||
// We'll select a 2x2 tile area from (510, 256) to (514, 258).
|
||||
// This will cross the 512px boundary.
|
||||
ctx->MouseMoveToPos(ImVec2(510, 256));
|
||||
ctx->MouseDown(0);
|
||||
ctx->MouseMoveToPos(ImVec2(514, 258));
|
||||
ctx->MouseUp(0);
|
||||
|
||||
// 5. Copy the selection
|
||||
ctx->KeyDown(ImGuiKey_LeftCtrl);
|
||||
ctx->KeyPress(ImGuiKey_C);
|
||||
ctx->KeyUp(ImGuiKey_LeftCtrl);
|
||||
|
||||
// 6. Paste the selection
|
||||
ctx->MouseMoveToPos(ImVec2(600, 300));
|
||||
ctx->KeyDown(ImGuiKey_LeftCtrl);
|
||||
ctx->KeyPress(ImGuiKey_V);
|
||||
ctx->KeyUp(ImGuiKey_LeftCtrl);
|
||||
|
||||
// 7. Verify that the pasted tiles are correct
|
||||
uint16_t new_tile1 = overworld->GetTile(75, 37);
|
||||
uint16_t new_tile2 = overworld->GetTile(76, 37);
|
||||
uint16_t new_tile3 = overworld->GetTile(75, 38);
|
||||
uint16_t new_tile4 = overworld->GetTile(76, 38);
|
||||
|
||||
// The bug is that the selection wraps around, so the pasted tiles are incorrect.
|
||||
// We expect the new tiles to be different from the original tiles.
|
||||
IM_CHECK_NE(orig_tile1, new_tile1);
|
||||
IM_CHECK_NE(orig_tile2, new_tile2);
|
||||
IM_CHECK_NE(orig_tile3, new_tile3);
|
||||
IM_CHECK_NE(orig_tile4, new_tile4);
|
||||
|
||||
// We also expect the pasted tiles to be the same as the selected tiles.
|
||||
// The selected tiles are at (63, 32) and (64, 32), (63, 33) and (64, 33).
|
||||
uint16_t selected_tile1 = overworld->GetTile(63, 32);
|
||||
uint16_t selected_tile2 = overworld->GetTile(64, 32);
|
||||
uint16_t selected_tile3 = overworld->GetTile(63, 33);
|
||||
uint16_t selected_tile4 = overworld->GetTile(64, 33);
|
||||
|
||||
IM_CHECK_EQ(new_tile1, selected_tile1);
|
||||
IM_CHECK_EQ(new_tile2, selected_tile2);
|
||||
IM_CHECK_EQ(new_tile3, selected_tile3);
|
||||
IM_CHECK_EQ(new_tile4, selected_tile4);
|
||||
|
||||
ctx->LogInfo("Original tiles: %d, %d, %d, %d", orig_tile1, orig_tile2, orig_tile3, orig_tile4);
|
||||
ctx->LogInfo("Selected tiles: %d, %d, %d, %d", selected_tile1, selected_tile2, selected_tile3, selected_tile4);
|
||||
ctx->LogInfo("New tiles: %d, %d, %d, %d", new_tile1, new_tile2, new_tile3, new_tile4);
|
||||
}
|
||||
8
test/e2e/canvas_selection_test.h
Normal file
8
test/e2e/canvas_selection_test.h
Normal file
@@ -0,0 +1,8 @@
|
||||
#ifndef YAZE_TEST_E2E_CANVAS_SELECTION_TEST_H
|
||||
#define YAZE_TEST_E2E_CANVAS_SELECTION_TEST_H
|
||||
|
||||
#include "imgui_test_engine/imgui_te_context.h"
|
||||
|
||||
void E2ETest_CanvasSelectionTest(ImGuiTestContext* ctx);
|
||||
|
||||
#endif // YAZE_TEST_E2E_CANVAS_SELECTION_TEST_H
|
||||
124
test/e2e/dungeon_editor_smoke_test.cc
Normal file
124
test/e2e/dungeon_editor_smoke_test.cc
Normal file
@@ -0,0 +1,124 @@
|
||||
#include "e2e/dungeon_editor_smoke_test.h"
|
||||
#include "test_utils.h"
|
||||
#include "app/controller.h"
|
||||
#include "imgui_test_engine/imgui_te_context.h"
|
||||
|
||||
/**
|
||||
* @brief Quick smoke test for DungeonEditorV2
|
||||
*
|
||||
* Tests the card-based architecture:
|
||||
* - Independent windows (cards) can be opened/closed
|
||||
* - Room cards function correctly
|
||||
* - Basic navigation works
|
||||
*/
|
||||
void E2ETest_DungeonEditorV2SmokeTest(ImGuiTestContext* ctx)
|
||||
{
|
||||
ctx->LogInfo("=== Starting DungeonEditorV2 Smoke Test ===");
|
||||
|
||||
// Load ROM first
|
||||
ctx->LogInfo("Loading ROM...");
|
||||
yaze::test::gui::LoadRomInTest(ctx, "zelda3.sfc");
|
||||
ctx->LogInfo("ROM loaded successfully");
|
||||
|
||||
// Open the Dungeon Editor
|
||||
ctx->LogInfo("Opening Dungeon Editor...");
|
||||
yaze::test::gui::OpenEditorInTest(ctx, "Dungeon");
|
||||
ctx->LogInfo("Dungeon Editor opened");
|
||||
|
||||
// Test 1: Control Panel Access
|
||||
ctx->LogInfo("--- Test 1: Control Panel ---");
|
||||
if (ctx->WindowInfo("Dungeon Controls").Window != nullptr) {
|
||||
ctx->WindowFocus("Dungeon Controls");
|
||||
ctx->LogInfo("Dungeon Controls panel is visible");
|
||||
} else {
|
||||
ctx->LogWarning("Dungeon Controls panel not visible - may be minimized");
|
||||
}
|
||||
|
||||
// Test 2: Open Room Selector Card
|
||||
ctx->LogInfo("--- Test 2: Room Selector Card ---");
|
||||
if (ctx->WindowInfo("Dungeon Controls").Window != nullptr) {
|
||||
ctx->SetRef("Dungeon Controls");
|
||||
ctx->ItemClick("Rooms"); // Toggle checkbox
|
||||
ctx->Yield();
|
||||
ctx->LogInfo("Toggled Room Selector visibility");
|
||||
}
|
||||
|
||||
// Test 3: Open Room Matrix Card
|
||||
ctx->LogInfo("--- Test 3: Room Matrix Card ---");
|
||||
if (ctx->WindowInfo("Dungeon Controls").Window != nullptr) {
|
||||
ctx->SetRef("Dungeon Controls");
|
||||
ctx->ItemClick("Matrix"); // Toggle checkbox
|
||||
ctx->Yield();
|
||||
ctx->LogInfo("Toggled Room Matrix visibility");
|
||||
}
|
||||
|
||||
// Test 4: Open a Room Card
|
||||
ctx->LogInfo("--- Test 4: Room Card ---");
|
||||
// Try to open room 0 by clicking in room selector
|
||||
if (ctx->WindowInfo("Room Selector").Window != nullptr) {
|
||||
ctx->SetRef("Room Selector");
|
||||
// Look for selectable room items
|
||||
if (ctx->ItemExists("Room 0x00")) {
|
||||
ctx->ItemDoubleClick("Room 0x00");
|
||||
ctx->Yield(2);
|
||||
ctx->LogInfo("Opened Room 0x00 card");
|
||||
|
||||
// Verify room card exists
|
||||
if (ctx->WindowInfo("Room 0x00").Window != nullptr) {
|
||||
ctx->LogInfo("Room 0x00 card successfully opened");
|
||||
ctx->SetRef("Room 0x00");
|
||||
|
||||
// Test 5: Per-Room Layer Controls
|
||||
ctx->LogInfo("--- Test 5: Per-Room Layer Controls ---");
|
||||
if (ctx->ItemExists("Show BG1")) {
|
||||
ctx->LogInfo("Found per-room BG1 control");
|
||||
// Toggle it
|
||||
ctx->ItemClick("Show BG1");
|
||||
ctx->Yield();
|
||||
ctx->ItemClick("Show BG1"); // Toggle back
|
||||
ctx->Yield();
|
||||
ctx->LogInfo("Per-room layer controls functional");
|
||||
}
|
||||
} else {
|
||||
ctx->LogWarning("Room card did not open");
|
||||
}
|
||||
} else {
|
||||
ctx->LogWarning("Room 0x00 not found in selector");
|
||||
}
|
||||
} else {
|
||||
ctx->LogWarning("Room Selector card not visible");
|
||||
}
|
||||
|
||||
// Test 6: Object Editor Card
|
||||
ctx->LogInfo("--- Test 6: Object Editor Card ---");
|
||||
if (ctx->WindowInfo("Dungeon Controls").Window != nullptr) {
|
||||
ctx->SetRef("Dungeon Controls");
|
||||
ctx->ItemClick("Objects"); // Toggle checkbox
|
||||
ctx->Yield();
|
||||
ctx->LogInfo("Toggled Object Editor visibility");
|
||||
}
|
||||
|
||||
// Test 7: Palette Editor Card
|
||||
ctx->LogInfo("--- Test 7: Palette Editor Card ---");
|
||||
if (ctx->WindowInfo("Dungeon Controls").Window != nullptr) {
|
||||
ctx->SetRef("Dungeon Controls");
|
||||
ctx->ItemClick("Palette"); // Toggle checkbox
|
||||
ctx->Yield();
|
||||
ctx->LogInfo("Toggled Palette Editor visibility");
|
||||
}
|
||||
|
||||
// Test 8: Independent Cards can be closed
|
||||
ctx->LogInfo("--- Test 8: Close Independent Cards ---");
|
||||
// Close room card if it's open
|
||||
if (ctx->WindowInfo("Room 0x00").Window != nullptr) {
|
||||
ctx->WindowClose("Room 0x00");
|
||||
ctx->Yield();
|
||||
ctx->LogInfo("Closed Room 0x00 card");
|
||||
}
|
||||
|
||||
// Final verification
|
||||
ctx->LogInfo("=== DungeonEditorV2 Smoke Test Completed Successfully ===");
|
||||
ctx->LogInfo("Card-based architecture is functional");
|
||||
ctx->LogInfo("Independent windows can be opened and closed");
|
||||
ctx->LogInfo("Per-room settings are accessible");
|
||||
}
|
||||
18
test/e2e/dungeon_editor_smoke_test.h
Normal file
18
test/e2e/dungeon_editor_smoke_test.h
Normal file
@@ -0,0 +1,18 @@
|
||||
#ifndef YAZE_TEST_E2E_DUNGEON_EDITOR_SMOKE_TEST_H
|
||||
#define YAZE_TEST_E2E_DUNGEON_EDITOR_SMOKE_TEST_H
|
||||
|
||||
#include "imgui_test_engine/imgui_te_context.h"
|
||||
|
||||
/**
|
||||
* @brief Quick smoke test for DungeonEditorV2 card-based UI
|
||||
*
|
||||
* Tests basic functionality:
|
||||
* - Opening dungeon editor
|
||||
* - Opening independent cards (Rooms, Matrix, Objects, etc.)
|
||||
* - Opening room cards
|
||||
* - Basic interaction with canvas
|
||||
*/
|
||||
void E2ETest_DungeonEditorV2SmokeTest(ImGuiTestContext* ctx);
|
||||
|
||||
#endif // YAZE_TEST_E2E_DUNGEON_EDITOR_SMOKE_TEST_H
|
||||
|
||||
1139
test/e2e/dungeon_object_rendering_e2e_tests.cc
Normal file
1139
test/e2e/dungeon_object_rendering_e2e_tests.cc
Normal file
File diff suppressed because it is too large
Load Diff
16
test/e2e/framework_smoke_test.cc
Normal file
16
test/e2e/framework_smoke_test.cc
Normal file
@@ -0,0 +1,16 @@
|
||||
#include "e2e/framework_smoke_test.h"
|
||||
#include "test_utils.h"
|
||||
#include "imgui.h"
|
||||
#include "imgui_test_engine/imgui_te_context.h"
|
||||
|
||||
// Smoke test for the E2E testing framework.
|
||||
// This test is run by the `test-gui` command.
|
||||
// It opens a window, clicks a button, and verifies that the button was clicked.
|
||||
// The GUI for this test is rendered in `test/yaze_test.cc`.
|
||||
void E2ETest_FrameworkSmokeTest(ImGuiTestContext* ctx)
|
||||
{
|
||||
yaze::test::gui::LoadRomInTest(ctx, "zelda3.sfc");
|
||||
ctx->SetRef("Hello World Window");
|
||||
ctx->ItemClick("Button");
|
||||
ctx->ItemCheck("Clicked 1 times");
|
||||
}
|
||||
8
test/e2e/framework_smoke_test.h
Normal file
8
test/e2e/framework_smoke_test.h
Normal file
@@ -0,0 +1,8 @@
|
||||
#ifndef YAZE_TEST_E2E_FRAMEWORK_SMOKE_TEST_H
|
||||
#define YAZE_TEST_E2E_FRAMEWORK_SMOKE_TEST_H
|
||||
|
||||
#include "imgui_test_engine/imgui_te_context.h"
|
||||
|
||||
void E2ETest_FrameworkSmokeTest(ImGuiTestContext* ctx);
|
||||
|
||||
#endif // YAZE_TEST_E2E_FRAMEWORK_SMOKE_TEST_H
|
||||
426
test/e2e/overworld/overworld_e2e_test.cc
Normal file
426
test/e2e/overworld/overworld_e2e_test.cc
Normal file
@@ -0,0 +1,426 @@
|
||||
#include <gtest/gtest.h>
|
||||
#include <filesystem>
|
||||
#include <memory>
|
||||
#include <vector>
|
||||
#include <string>
|
||||
|
||||
#include "app/rom.h"
|
||||
#include "zelda3/overworld/overworld.h"
|
||||
#include "zelda3/overworld/overworld_map.h"
|
||||
#include "testing.h"
|
||||
|
||||
namespace yaze {
|
||||
namespace test {
|
||||
|
||||
/**
|
||||
* @brief Comprehensive End-to-End Overworld Test Suite
|
||||
*
|
||||
* This test suite validates the complete overworld editing workflow:
|
||||
* 1. Load vanilla ROM and extract golden data
|
||||
* 2. Apply ZSCustomOverworld ASM patches
|
||||
* 3. Make various edits to overworld data
|
||||
* 4. Validate edits are correctly saved and loaded
|
||||
* 5. Compare before/after states using golden data
|
||||
* 6. Test integration with existing test infrastructure
|
||||
*/
|
||||
class OverworldE2ETest : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
// Skip tests if ROM is not available
|
||||
if (getenv("YAZE_SKIP_ROM_TESTS")) {
|
||||
GTEST_SKIP() << "ROM tests disabled";
|
||||
}
|
||||
|
||||
// Get ROM path from environment or use default
|
||||
const char* rom_path_env = getenv("YAZE_TEST_ROM_PATH");
|
||||
vanilla_rom_path_ = rom_path_env ? rom_path_env : "zelda3.sfc";
|
||||
|
||||
if (!std::filesystem::exists(vanilla_rom_path_)) {
|
||||
GTEST_SKIP() << "Test ROM not found: " << vanilla_rom_path_;
|
||||
}
|
||||
|
||||
// Create test ROM copies
|
||||
vanilla_test_path_ = "test_vanilla_e2e.sfc";
|
||||
edited_test_path_ = "test_edited_e2e.sfc";
|
||||
golden_data_path_ = "golden_data_e2e.h";
|
||||
|
||||
// Copy vanilla ROM for testing
|
||||
std::filesystem::copy_file(vanilla_rom_path_, vanilla_test_path_);
|
||||
}
|
||||
|
||||
void TearDown() override {
|
||||
// Clean up test files
|
||||
std::vector<std::string> test_files = {
|
||||
vanilla_test_path_, edited_test_path_, golden_data_path_
|
||||
};
|
||||
|
||||
for (const auto& file : test_files) {
|
||||
if (std::filesystem::exists(file)) {
|
||||
std::filesystem::remove(file);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Helper to extract golden data from ROM
|
||||
absl::Status ExtractGoldenData(const std::string& rom_path,
|
||||
const std::string& output_path) {
|
||||
// Run the golden data extractor
|
||||
std::string command = "./overworld_golden_data_extractor " + rom_path + " " + output_path;
|
||||
int result = system(command.c_str());
|
||||
|
||||
if (result != 0) {
|
||||
return absl::InternalError("Failed to extract golden data");
|
||||
}
|
||||
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
// Helper to validate ROM against golden data
|
||||
bool ValidateROMAgainstGoldenData(Rom& rom, const std::string& /* golden_data_path */) {
|
||||
// This would load the generated golden data header and compare values
|
||||
// For now, we'll do basic validation
|
||||
|
||||
// Check basic ROM properties
|
||||
if (rom.title().empty()) return false;
|
||||
if (rom.size() < 1024*1024) return false; // At least 1MB
|
||||
|
||||
// Check ASM version
|
||||
auto asm_version = rom.ReadByte(0x140145);
|
||||
if (!asm_version.ok()) return false;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string vanilla_rom_path_;
|
||||
std::string vanilla_test_path_;
|
||||
std::string edited_test_path_;
|
||||
std::string golden_data_path_;
|
||||
};
|
||||
|
||||
// Test 1: Extract golden data from vanilla ROM
|
||||
TEST_F(OverworldE2ETest, ExtractVanillaGoldenData) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Extract golden data
|
||||
ASSERT_OK(ExtractGoldenData(vanilla_test_path_, golden_data_path_));
|
||||
|
||||
// Verify golden data file was created
|
||||
EXPECT_TRUE(std::filesystem::exists(golden_data_path_));
|
||||
|
||||
// Validate ROM against golden data
|
||||
EXPECT_TRUE(ValidateROMAgainstGoldenData(*rom, golden_data_path_));
|
||||
}
|
||||
|
||||
// Test 2: Load and validate vanilla overworld data
|
||||
TEST_F(OverworldE2ETest, LoadVanillaOverworldData) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
zelda3::Overworld overworld(rom.get());
|
||||
auto status = overworld.Load(rom.get());
|
||||
ASSERT_TRUE(status.ok());
|
||||
|
||||
// Validate basic overworld structure
|
||||
EXPECT_TRUE(overworld.is_loaded());
|
||||
|
||||
const auto& maps = overworld.overworld_maps();
|
||||
EXPECT_EQ(maps.size(), 160);
|
||||
|
||||
// Validate that we have a vanilla ROM (ASM version 0xFF)
|
||||
auto asm_version = rom->ReadByte(0x140145);
|
||||
ASSERT_TRUE(asm_version.ok());
|
||||
EXPECT_EQ(*asm_version, 0xFF);
|
||||
|
||||
// Validate expansion flags for vanilla
|
||||
EXPECT_FALSE(overworld.expanded_tile16());
|
||||
EXPECT_FALSE(overworld.expanded_tile32());
|
||||
|
||||
// Validate data structures
|
||||
const auto& entrances = overworld.entrances();
|
||||
const auto& exits = overworld.exits();
|
||||
const auto& holes = overworld.holes();
|
||||
const auto& items = overworld.all_items();
|
||||
|
||||
EXPECT_EQ(entrances.size(), 129);
|
||||
EXPECT_EQ(exits->size(), 0x4F);
|
||||
EXPECT_EQ(holes.size(), 0x13);
|
||||
EXPECT_GE(items.size(), 0);
|
||||
|
||||
// Validate sprite data (3 game states)
|
||||
const auto& sprites = overworld.all_sprites();
|
||||
EXPECT_EQ(sprites.size(), 3);
|
||||
}
|
||||
|
||||
// Test 3: Apply ZSCustomOverworld v3 ASM and validate changes
|
||||
TEST_F(OverworldE2ETest, ApplyZSCustomOverworldV3) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Apply ZSCustomOverworld v3 ASM
|
||||
// This would typically be done through the editor, but we can simulate it
|
||||
ASSERT_OK(rom->WriteByte(0x140145, 0x03)); // Set ASM version to v3
|
||||
|
||||
// Enable v3 features
|
||||
ASSERT_OK(rom->WriteByte(0x140146, 0x01)); // Enable main palettes
|
||||
ASSERT_OK(rom->WriteByte(0x140147, 0x01)); // Enable area-specific BG
|
||||
ASSERT_OK(rom->WriteByte(0x140148, 0x01)); // Enable subscreen overlay
|
||||
ASSERT_OK(rom->WriteByte(0x140149, 0x01)); // Enable animated GFX
|
||||
ASSERT_OK(rom->WriteByte(0x14014A, 0x01)); // Enable custom tile GFX groups
|
||||
ASSERT_OK(rom->WriteByte(0x14014B, 0x01)); // Enable mosaic
|
||||
|
||||
// Save the modified ROM
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = edited_test_path_}));
|
||||
|
||||
// Reload and validate
|
||||
std::unique_ptr<Rom> reloaded_rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(reloaded_rom->LoadFromFile(edited_test_path_));
|
||||
|
||||
// Validate ASM version was applied
|
||||
auto asm_version = reloaded_rom->ReadByte(0x140145);
|
||||
ASSERT_TRUE(asm_version.ok());
|
||||
EXPECT_EQ(*asm_version, 0x03);
|
||||
|
||||
// Validate feature flags
|
||||
auto main_palettes = reloaded_rom->ReadByte(0x140146);
|
||||
auto area_bg = reloaded_rom->ReadByte(0x140147);
|
||||
auto subscreen_overlay = reloaded_rom->ReadByte(0x140148);
|
||||
auto animated_gfx = reloaded_rom->ReadByte(0x140149);
|
||||
auto custom_tiles = reloaded_rom->ReadByte(0x14014A);
|
||||
auto mosaic = reloaded_rom->ReadByte(0x14014B);
|
||||
|
||||
ASSERT_TRUE(main_palettes.ok());
|
||||
ASSERT_TRUE(area_bg.ok());
|
||||
ASSERT_TRUE(subscreen_overlay.ok());
|
||||
ASSERT_TRUE(animated_gfx.ok());
|
||||
ASSERT_TRUE(custom_tiles.ok());
|
||||
ASSERT_TRUE(mosaic.ok());
|
||||
|
||||
EXPECT_EQ(*main_palettes, 0x01);
|
||||
EXPECT_EQ(*area_bg, 0x01);
|
||||
EXPECT_EQ(*subscreen_overlay, 0x01);
|
||||
EXPECT_EQ(*animated_gfx, 0x01);
|
||||
EXPECT_EQ(*custom_tiles, 0x01);
|
||||
EXPECT_EQ(*mosaic, 0x01);
|
||||
|
||||
// Load overworld and validate v3 features are detected
|
||||
zelda3::Overworld overworld(reloaded_rom.get());
|
||||
auto status = overworld.Load(reloaded_rom.get());
|
||||
ASSERT_TRUE(status.ok());
|
||||
|
||||
// v3 should have expanded features available
|
||||
EXPECT_TRUE(overworld.expanded_tile16());
|
||||
EXPECT_TRUE(overworld.expanded_tile32());
|
||||
}
|
||||
|
||||
// Test 4: Make overworld edits and validate persistence
|
||||
TEST_F(OverworldE2ETest, OverworldEditPersistence) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Load overworld
|
||||
zelda3::Overworld overworld(rom.get());
|
||||
auto status = overworld.Load(rom.get());
|
||||
ASSERT_TRUE(status.ok());
|
||||
|
||||
// Make some edits to overworld maps
|
||||
auto* map0 = overworld.mutable_overworld_map(0);
|
||||
uint8_t original_gfx = map0->area_graphics();
|
||||
uint8_t original_palette = map0->main_palette();
|
||||
|
||||
// Change graphics and palette
|
||||
map0->set_area_graphics(0x01);
|
||||
map0->set_main_palette(0x02);
|
||||
|
||||
// Save the changes
|
||||
auto save_maps_status = overworld.SaveOverworldMaps();
|
||||
ASSERT_TRUE(save_maps_status.ok());
|
||||
auto save_props_status = overworld.SaveMapProperties();
|
||||
ASSERT_TRUE(save_props_status.ok());
|
||||
|
||||
// Save ROM
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = edited_test_path_}));
|
||||
|
||||
// Reload ROM and validate changes persisted
|
||||
std::unique_ptr<Rom> reloaded_rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(reloaded_rom->LoadFromFile(edited_test_path_));
|
||||
|
||||
zelda3::Overworld reloaded_overworld(reloaded_rom.get());
|
||||
ASSERT_OK(reloaded_overworld.Load(reloaded_rom.get()));
|
||||
|
||||
const auto& reloaded_map0 = reloaded_overworld.overworld_map(0);
|
||||
EXPECT_EQ(reloaded_map0->area_graphics(), 0x01);
|
||||
EXPECT_EQ(reloaded_map0->main_palette(), 0x02);
|
||||
}
|
||||
|
||||
// Test 5: Validate coordinate calculations match ZScream exactly
|
||||
TEST_F(OverworldE2ETest, CoordinateCalculationValidation) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
zelda3::Overworld overworld(rom.get());
|
||||
ASSERT_OK(overworld.Load(rom.get()));
|
||||
|
||||
const auto& entrances = overworld.entrances();
|
||||
EXPECT_EQ(entrances.size(), 129);
|
||||
|
||||
// Test coordinate calculation for first 10 entrances
|
||||
for (int i = 0; i < std::min(10, static_cast<int>(entrances.size())); i++) {
|
||||
const auto& entrance = entrances[i];
|
||||
|
||||
// ZScream coordinate calculation logic
|
||||
uint16_t map_pos = entrance.map_pos_;
|
||||
uint16_t map_id = entrance.map_id_;
|
||||
|
||||
int position = map_pos >> 1;
|
||||
int x_coord = position % 64;
|
||||
int y_coord = position >> 6;
|
||||
int expected_x = (x_coord * 16) + (((map_id % 64) - (((map_id % 64) / 8) * 8)) * 512);
|
||||
int expected_y = (y_coord * 16) + (((map_id % 64) / 8) * 512);
|
||||
|
||||
EXPECT_EQ(entrance.x_, expected_x) << "Entrance " << i << " X coordinate mismatch";
|
||||
EXPECT_EQ(entrance.y_, expected_y) << "Entrance " << i << " Y coordinate mismatch";
|
||||
}
|
||||
|
||||
// Test hole coordinate calculation with 0x400 offset
|
||||
const auto& holes = overworld.holes();
|
||||
EXPECT_EQ(holes.size(), 0x13);
|
||||
|
||||
for (int i = 0; i < std::min(5, static_cast<int>(holes.size())); i++) {
|
||||
const auto& hole = holes[i];
|
||||
|
||||
// ZScream hole coordinate calculation with 0x400 offset
|
||||
uint16_t map_pos = hole.map_pos_;
|
||||
uint16_t map_id = hole.map_id_;
|
||||
|
||||
int position = map_pos >> 1;
|
||||
int x_coord = position % 64;
|
||||
int y_coord = position >> 6;
|
||||
int expected_x = (x_coord * 16) + (((map_id % 64) - (((map_id % 64) / 8) * 8)) * 512);
|
||||
int expected_y = (y_coord * 16) + (((map_id % 64) / 8) * 512);
|
||||
|
||||
EXPECT_EQ(hole.x_, expected_x) << "Hole " << i << " X coordinate mismatch";
|
||||
EXPECT_EQ(hole.y_, expected_y) << "Hole " << i << " Y coordinate mismatch";
|
||||
EXPECT_TRUE(hole.is_hole_) << "Hole " << i << " should be marked as hole";
|
||||
}
|
||||
}
|
||||
|
||||
// Test 6: Comprehensive before/after validation
|
||||
TEST_F(OverworldE2ETest, BeforeAfterValidation) {
|
||||
// Extract golden data from vanilla ROM
|
||||
ASSERT_OK(ExtractGoldenData(vanilla_test_path_, golden_data_path_));
|
||||
|
||||
// Load vanilla ROM and make some changes
|
||||
std::unique_ptr<Rom> vanilla_rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(vanilla_rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Store some original values for comparison
|
||||
auto original_asm_version = vanilla_rom->ReadByte(0x140145);
|
||||
auto original_graphics_0 = vanilla_rom->ReadByte(0x7C9C); // First map graphics
|
||||
auto original_palette_0 = vanilla_rom->ReadByte(0x7D1C); // First map palette
|
||||
|
||||
ASSERT_TRUE(original_asm_version.ok());
|
||||
ASSERT_TRUE(original_graphics_0.ok());
|
||||
ASSERT_TRUE(original_palette_0.ok());
|
||||
|
||||
// Make changes
|
||||
auto write1 = vanilla_rom->WriteByte(0x140145, 0x03); // Apply v3 ASM
|
||||
ASSERT_TRUE(write1.ok());
|
||||
auto write2 = vanilla_rom->WriteByte(0x7C9C, 0x01); // Change first map graphics
|
||||
ASSERT_TRUE(write2.ok());
|
||||
auto write3 = vanilla_rom->WriteByte(0x7D1C, 0x02); // Change first map palette
|
||||
ASSERT_TRUE(write3.ok());
|
||||
|
||||
// Save modified ROM
|
||||
ASSERT_OK(vanilla_rom->SaveToFile(Rom::SaveSettings{.filename = edited_test_path_}));
|
||||
|
||||
// Reload and validate changes
|
||||
std::unique_ptr<Rom> modified_rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(modified_rom->LoadFromFile(edited_test_path_));
|
||||
|
||||
auto modified_asm_version = modified_rom->ReadByte(0x140145);
|
||||
auto modified_graphics_0 = modified_rom->ReadByte(0x7C9C);
|
||||
auto modified_palette_0 = modified_rom->ReadByte(0x7D1C);
|
||||
|
||||
ASSERT_TRUE(modified_asm_version.ok());
|
||||
ASSERT_TRUE(modified_graphics_0.ok());
|
||||
ASSERT_TRUE(modified_palette_0.ok());
|
||||
|
||||
// Validate changes were applied
|
||||
EXPECT_EQ(*modified_asm_version, 0x03);
|
||||
EXPECT_EQ(*modified_graphics_0, 0x01);
|
||||
EXPECT_EQ(*modified_palette_0, 0x02);
|
||||
|
||||
// Validate original values were different
|
||||
EXPECT_NE(*original_asm_version, *modified_asm_version);
|
||||
EXPECT_NE(*original_graphics_0, *modified_graphics_0);
|
||||
EXPECT_NE(*original_palette_0, *modified_palette_0);
|
||||
}
|
||||
|
||||
// Test 7: Integration with RomDependentTestSuite
|
||||
TEST_F(OverworldE2ETest, RomDependentTestSuiteIntegration) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Test that our overworld loading works with RomDependentTestSuite patterns
|
||||
zelda3::Overworld overworld(rom.get());
|
||||
auto status = overworld.Load(rom.get());
|
||||
ASSERT_TRUE(status.ok());
|
||||
|
||||
// Validate ROM-dependent features work correctly
|
||||
EXPECT_TRUE(overworld.is_loaded());
|
||||
|
||||
const auto& maps = overworld.overworld_maps();
|
||||
EXPECT_EQ(maps.size(), 160);
|
||||
|
||||
// Test that we can access the same data structures as RomDependentTestSuite
|
||||
for (int i = 0; i < std::min(10, static_cast<int>(maps.size())); i++) {
|
||||
const auto& map = maps[i];
|
||||
|
||||
// Verify map properties are accessible
|
||||
EXPECT_GE(map.area_graphics(), 0);
|
||||
EXPECT_GE(map.main_palette(), 0);
|
||||
EXPECT_GE(map.area_size(), zelda3::AreaSizeEnum::SmallArea);
|
||||
EXPECT_LE(map.area_size(), zelda3::AreaSizeEnum::TallArea);
|
||||
}
|
||||
|
||||
// Test that sprite data is accessible (matches RomDependentTestSuite expectations)
|
||||
const auto& sprites = overworld.all_sprites();
|
||||
EXPECT_EQ(sprites.size(), 3); // Three game states
|
||||
|
||||
// Test that item data is accessible
|
||||
const auto& items = overworld.all_items();
|
||||
EXPECT_GE(items.size(), 0);
|
||||
|
||||
// Test that entrance/exit data is accessible
|
||||
const auto& entrances = overworld.entrances();
|
||||
const auto& exits = overworld.exits();
|
||||
EXPECT_EQ(entrances.size(), 129);
|
||||
EXPECT_EQ(exits->size(), 0x4F);
|
||||
}
|
||||
|
||||
// Test 8: Performance and stability testing
|
||||
TEST_F(OverworldE2ETest, PerformanceAndStability) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Test multiple load/unload cycles
|
||||
for (int cycle = 0; cycle < 5; cycle++) {
|
||||
zelda3::Overworld overworld(rom.get());
|
||||
auto status = overworld.Load(rom.get());
|
||||
ASSERT_TRUE(status.ok()) << "Load failed on cycle " << cycle;
|
||||
|
||||
// Validate basic structure
|
||||
const auto& maps = overworld.overworld_maps();
|
||||
EXPECT_EQ(maps.size(), 160) << "Map count mismatch on cycle " << cycle;
|
||||
|
||||
const auto& entrances = overworld.entrances();
|
||||
EXPECT_EQ(entrances.size(), 129) << "Entrance count mismatch on cycle " << cycle;
|
||||
|
||||
const auto& exits = overworld.exits();
|
||||
EXPECT_EQ(exits->size(), 0x4F) << "Exit count mismatch on cycle " << cycle;
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace test
|
||||
} // namespace yaze
|
||||
272
test/e2e/rom_dependent/e2e_rom_test.cc
Normal file
272
test/e2e/rom_dependent/e2e_rom_test.cc
Normal file
@@ -0,0 +1,272 @@
|
||||
#include <gtest/gtest.h>
|
||||
#include <filesystem>
|
||||
#include <fstream>
|
||||
#include <memory>
|
||||
#include <vector>
|
||||
#include <string>
|
||||
|
||||
#include "app/rom.h"
|
||||
#include "app/transaction.h"
|
||||
#include "testing.h"
|
||||
|
||||
namespace yaze {
|
||||
namespace test {
|
||||
|
||||
/**
|
||||
* @brief Comprehensive End-to-End ROM testing suite
|
||||
*
|
||||
* This test suite validates the complete ROM editing workflow:
|
||||
* 1. Load vanilla ROM
|
||||
* 2. Apply various edits (ROM data, graphics, etc.)
|
||||
* 3. Save changes
|
||||
* 4. Reload ROM and verify edits persist
|
||||
* 5. Verify no data corruption occurred
|
||||
*/
|
||||
class E2ERomDependentTest : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
// Skip tests if ROM is not available
|
||||
if (getenv("YAZE_SKIP_ROM_TESTS")) {
|
||||
GTEST_SKIP() << "ROM tests disabled";
|
||||
}
|
||||
|
||||
// Get ROM path from environment or use default
|
||||
const char* rom_path_env = getenv("YAZE_TEST_ROM_PATH");
|
||||
vanilla_rom_path_ = rom_path_env ? rom_path_env : "zelda3.sfc";
|
||||
|
||||
if (!std::filesystem::exists(vanilla_rom_path_)) {
|
||||
GTEST_SKIP() << "Test ROM not found: " << vanilla_rom_path_;
|
||||
}
|
||||
|
||||
// Create test ROM copies
|
||||
test_rom_path_ = "test_rom_edit.sfc";
|
||||
backup_rom_path_ = "test_rom_backup.sfc";
|
||||
|
||||
// Copy vanilla ROM for testing
|
||||
std::filesystem::copy_file(vanilla_rom_path_, test_rom_path_);
|
||||
std::filesystem::copy_file(vanilla_rom_path_, backup_rom_path_);
|
||||
}
|
||||
|
||||
void TearDown() override {
|
||||
// Clean up test files
|
||||
if (std::filesystem::exists(test_rom_path_)) {
|
||||
std::filesystem::remove(test_rom_path_);
|
||||
}
|
||||
if (std::filesystem::exists(backup_rom_path_)) {
|
||||
std::filesystem::remove(backup_rom_path_);
|
||||
}
|
||||
}
|
||||
|
||||
// Helper to load ROM and verify basic integrity
|
||||
static absl::Status LoadAndVerifyROM(const std::string& path, std::unique_ptr<Rom>& rom) {
|
||||
rom = std::make_unique<Rom>();
|
||||
RETURN_IF_ERROR(rom->LoadFromFile(path));
|
||||
|
||||
// Basic ROM integrity checks
|
||||
EXPECT_EQ(rom->size(), 0x200000) << "ROM size should be 2MB";
|
||||
EXPECT_NE(rom->data(), nullptr) << "ROM data should not be null";
|
||||
|
||||
// Check ROM header
|
||||
auto header_byte = rom->ReadByte(0x7FC0);
|
||||
RETURN_IF_ERROR(header_byte.status());
|
||||
EXPECT_EQ(*header_byte, 0x21) << "ROM should be LoROM format";
|
||||
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
// Helper to verify ROM data integrity by comparing checksums
|
||||
static bool VerifyROMIntegrity(const std::string& path1, const std::string& path2,
|
||||
const std::vector<uint32_t>& exclude_ranges = {}) {
|
||||
std::ifstream file1(path1, std::ios::binary);
|
||||
std::ifstream file2(path2, std::ios::binary);
|
||||
|
||||
if (!file1.is_open() || !file2.is_open()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
file1.seekg(0, std::ios::end);
|
||||
file2.seekg(0, std::ios::end);
|
||||
|
||||
size_t size1 = file1.tellg();
|
||||
size_t size2 = file2.tellg();
|
||||
|
||||
if (size1 != size2) {
|
||||
return false;
|
||||
}
|
||||
|
||||
file1.seekg(0);
|
||||
file2.seekg(0);
|
||||
|
||||
std::vector<char> buffer1(size1);
|
||||
std::vector<char> buffer2(size2);
|
||||
|
||||
file1.read(buffer1.data(), size1);
|
||||
file2.read(buffer2.data(), size2);
|
||||
|
||||
// Compare byte by byte, excluding specified ranges
|
||||
for (size_t i = 0; i < size1; i++) {
|
||||
bool in_exclude_range = false;
|
||||
for (const auto& range : exclude_ranges) {
|
||||
if (i >= (range & 0xFFFFFF) && i < ((range >> 24) & 0xFF)) {
|
||||
in_exclude_range = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!in_exclude_range && buffer1[i] != buffer2[i]) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string vanilla_rom_path_;
|
||||
std::string test_rom_path_;
|
||||
std::string backup_rom_path_;
|
||||
};
|
||||
|
||||
// Test basic ROM loading and saving
|
||||
TEST_F(E2ERomDependentTest, BasicROMLoadSave) {
|
||||
std::unique_ptr<Rom> rom;
|
||||
ASSERT_OK(LoadAndVerifyROM(vanilla_rom_path_, rom));
|
||||
|
||||
// Save ROM to test path
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = test_rom_path_}));
|
||||
|
||||
// Verify saved ROM matches original
|
||||
EXPECT_TRUE(VerifyROMIntegrity(vanilla_rom_path_, test_rom_path_));
|
||||
}
|
||||
|
||||
// Test ROM data editing workflow
|
||||
TEST_F(E2ERomDependentTest, ROMDataEditWorkflow) {
|
||||
std::unique_ptr<Rom> rom;
|
||||
ASSERT_OK(LoadAndVerifyROM(vanilla_rom_path_, rom));
|
||||
|
||||
// Get initial state
|
||||
auto initial_byte = rom->ReadByte(0x1000);
|
||||
ASSERT_TRUE(initial_byte.ok());
|
||||
|
||||
// Make edits
|
||||
ASSERT_OK(rom->WriteByte(0x1000, 0xAA));
|
||||
ASSERT_OK(rom->WriteByte(0x2000, 0xBB));
|
||||
ASSERT_OK(rom->WriteWord(0x3000, 0xCCDD));
|
||||
|
||||
// Save changes
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = test_rom_path_}));
|
||||
|
||||
// Reload and verify
|
||||
std::unique_ptr<Rom> reloaded_rom;
|
||||
ASSERT_OK(LoadAndVerifyROM(test_rom_path_, reloaded_rom));
|
||||
|
||||
auto byte1 = reloaded_rom->ReadByte(0x1000);
|
||||
ASSERT_OK(byte1.status());
|
||||
EXPECT_EQ(*byte1, 0xAA);
|
||||
|
||||
auto byte2 = reloaded_rom->ReadByte(0x2000);
|
||||
ASSERT_OK(byte2.status());
|
||||
EXPECT_EQ(*byte2, 0xBB);
|
||||
|
||||
auto word1 = reloaded_rom->ReadWord(0x3000);
|
||||
ASSERT_OK(word1.status());
|
||||
EXPECT_EQ(*word1, 0xCCDD);
|
||||
|
||||
// Verify other data wasn't corrupted
|
||||
EXPECT_NE(*byte1, *initial_byte);
|
||||
}
|
||||
|
||||
// Test transaction system with multiple edits
|
||||
TEST_F(E2ERomDependentTest, TransactionSystem) {
|
||||
std::unique_ptr<Rom> rom;
|
||||
ASSERT_OK(LoadAndVerifyROM(vanilla_rom_path_, rom));
|
||||
|
||||
// Create transaction
|
||||
auto transaction = std::make_unique<yaze::Transaction>(*rom);
|
||||
|
||||
// Make multiple edits in transaction
|
||||
transaction->WriteByte(0x1000, 0xAA);
|
||||
transaction->WriteByte(0x2000, 0xBB);
|
||||
transaction->WriteWord(0x3000, 0xCCDD);
|
||||
|
||||
// Commit the transaction
|
||||
ASSERT_OK(transaction->Commit());
|
||||
|
||||
// Commit transaction
|
||||
ASSERT_OK(transaction->Commit());
|
||||
|
||||
// Save ROM
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = test_rom_path_}));
|
||||
|
||||
// Reload and verify all changes
|
||||
std::unique_ptr<Rom> reloaded_rom;
|
||||
ASSERT_OK(LoadAndVerifyROM(test_rom_path_, reloaded_rom));
|
||||
|
||||
auto byte1 = reloaded_rom->ReadByte(0x1000);
|
||||
ASSERT_OK(byte1.status());
|
||||
EXPECT_EQ(*byte1, 0xAA);
|
||||
|
||||
auto byte2 = reloaded_rom->ReadByte(0x2000);
|
||||
ASSERT_OK(byte2.status());
|
||||
EXPECT_EQ(*byte2, 0xBB);
|
||||
|
||||
auto word1 = reloaded_rom->ReadWord(0x3000);
|
||||
ASSERT_OK(word1.status());
|
||||
EXPECT_EQ(*word1, 0xCCDD);
|
||||
}
|
||||
|
||||
// Test ROM corruption detection
|
||||
TEST_F(E2ERomDependentTest, CorruptionDetection) {
|
||||
std::unique_ptr<Rom> rom;
|
||||
ASSERT_OK(LoadAndVerifyROM(vanilla_rom_path_, rom));
|
||||
|
||||
// Corrupt some data
|
||||
ASSERT_OK(rom->WriteByte(0x1000, 0xFF)); // Corrupt some data
|
||||
ASSERT_OK(rom->WriteByte(0x2000, 0xAA)); // Corrupt more data
|
||||
|
||||
// Save corrupted ROM
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = test_rom_path_}));
|
||||
|
||||
// Verify corruption is detected
|
||||
std::unique_ptr<Rom> reloaded_rom;
|
||||
ASSERT_OK(LoadAndVerifyROM(test_rom_path_, reloaded_rom));
|
||||
|
||||
auto corrupt_byte1 = reloaded_rom->ReadByte(0x1000);
|
||||
ASSERT_OK(corrupt_byte1.status());
|
||||
EXPECT_EQ(*corrupt_byte1, 0xFF);
|
||||
|
||||
auto corrupt_byte2 = reloaded_rom->ReadByte(0x2000);
|
||||
ASSERT_OK(corrupt_byte2.status());
|
||||
EXPECT_EQ(*corrupt_byte2, 0xAA);
|
||||
}
|
||||
|
||||
// Test large-scale editing without corruption
|
||||
TEST_F(E2ERomDependentTest, LargeScaleEditing) {
|
||||
std::unique_ptr<Rom> rom;
|
||||
ASSERT_OK(LoadAndVerifyROM(vanilla_rom_path_, rom));
|
||||
|
||||
// Edit multiple areas
|
||||
for (int i = 0; i < 10; i++) {
|
||||
ASSERT_OK(rom->WriteByte(0x1000 + i, i % 16));
|
||||
ASSERT_OK(rom->WriteByte(0x2000 + i, (i + 1) % 16));
|
||||
}
|
||||
|
||||
// Save and reload
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = test_rom_path_}));
|
||||
|
||||
std::unique_ptr<Rom> reloaded_rom;
|
||||
ASSERT_OK(LoadAndVerifyROM(test_rom_path_, reloaded_rom));
|
||||
|
||||
// Verify all changes
|
||||
for (int i = 0; i < 10; i++) {
|
||||
auto byte1 = reloaded_rom->ReadByte(0x1000 + i);
|
||||
ASSERT_OK(byte1.status());
|
||||
EXPECT_EQ(*byte1, i % 16);
|
||||
|
||||
auto byte2 = reloaded_rom->ReadByte(0x2000 + i);
|
||||
ASSERT_OK(byte2.status());
|
||||
EXPECT_EQ(*byte2, (i + 1) % 16);
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace test
|
||||
} // namespace yaze
|
||||
377
test/e2e/zscustomoverworld/zscustomoverworld_upgrade_test.cc
Normal file
377
test/e2e/zscustomoverworld/zscustomoverworld_upgrade_test.cc
Normal file
@@ -0,0 +1,377 @@
|
||||
#include <gtest/gtest.h>
|
||||
#include <filesystem>
|
||||
#include <memory>
|
||||
#include <vector>
|
||||
#include <string>
|
||||
#include <map>
|
||||
|
||||
#include "app/rom.h"
|
||||
#include "testing.h"
|
||||
|
||||
namespace yaze {
|
||||
namespace test {
|
||||
|
||||
/**
|
||||
* @brief ZSCustomOverworld upgrade testing suite
|
||||
*
|
||||
* This test suite validates ZSCustomOverworld version upgrades:
|
||||
* 1. Vanilla -> v2 upgrade with proper address changes
|
||||
* 2. v2 -> v3 upgrade with expanded features
|
||||
* 3. Address validation for each version
|
||||
* 4. Save compatibility between versions
|
||||
* 5. Feature enablement/disablement
|
||||
*/
|
||||
class ZSCustomOverworldUpgradeTest : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
// Skip tests if ROM is not available
|
||||
if (getenv("YAZE_SKIP_ROM_TESTS")) {
|
||||
GTEST_SKIP() << "ROM tests disabled";
|
||||
}
|
||||
|
||||
// Get ROM path from environment or use default
|
||||
const char* rom_path_env = getenv("YAZE_TEST_ROM_PATH");
|
||||
vanilla_rom_path_ = rom_path_env ? rom_path_env : "zelda3.sfc";
|
||||
|
||||
if (!std::filesystem::exists(vanilla_rom_path_)) {
|
||||
GTEST_SKIP() << "Test ROM not found: " << vanilla_rom_path_;
|
||||
}
|
||||
|
||||
// Create test ROM copies for each version
|
||||
vanilla_test_path_ = "test_vanilla.sfc";
|
||||
v2_test_path_ = "test_v2.sfc";
|
||||
v3_test_path_ = "test_v3.sfc";
|
||||
|
||||
// Copy vanilla ROM for testing
|
||||
std::filesystem::copy_file(vanilla_rom_path_, vanilla_test_path_);
|
||||
|
||||
// Define version-specific addresses and features
|
||||
InitializeVersionData();
|
||||
}
|
||||
|
||||
void TearDown() override {
|
||||
// Clean up test files
|
||||
std::vector<std::string> test_files = {
|
||||
vanilla_test_path_, v2_test_path_, v3_test_path_
|
||||
};
|
||||
|
||||
for (const auto& file : test_files) {
|
||||
if (std::filesystem::exists(file)) {
|
||||
std::filesystem::remove(file);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void InitializeVersionData() {
|
||||
// Vanilla ROM addresses and values
|
||||
vanilla_data_ = {
|
||||
{"version_flag", {0x140145, 0xFF}}, // OverworldCustomASMHasBeenApplied
|
||||
{"message_ids", {0x3F51D, 0x00}}, // Message ID table start
|
||||
{"area_graphics", {0x7C9C, 0x00}}, // Area graphics table
|
||||
{"area_palettes", {0x7D1C, 0x00}}, // Area palettes table
|
||||
{"screen_sizes", {0x1788D, 0x01}}, // Screen sizes table
|
||||
{"sprite_sets", {0x7A41, 0x00}}, // Sprite sets table
|
||||
{"sprite_palettes", {0x7B41, 0x00}}, // Sprite palettes table
|
||||
};
|
||||
|
||||
// v2 ROM addresses and values
|
||||
v2_data_ = {
|
||||
{"version_flag", {0x140145, 0x02}}, // v2 version
|
||||
{"message_ids", {0x1417F8, 0x00}}, // Expanded message ID table
|
||||
{"area_graphics", {0x7C9C, 0x00}}, // Same as vanilla
|
||||
{"area_palettes", {0x7D1C, 0x00}}, // Same as vanilla
|
||||
{"screen_sizes", {0x1788D, 0x01}}, // Same as vanilla
|
||||
{"sprite_sets", {0x7A41, 0x00}}, // Same as vanilla
|
||||
{"sprite_palettes", {0x7B41, 0x00}}, // Same as vanilla
|
||||
{"main_palettes", {0x140160, 0x00}}, // New v2 feature
|
||||
};
|
||||
|
||||
// v3 ROM addresses and values
|
||||
v3_data_ = {
|
||||
{"version_flag", {0x140145, 0x03}}, // v3 version
|
||||
{"message_ids", {0x1417F8, 0x00}}, // Same as v2
|
||||
{"area_graphics", {0x7C9C, 0x00}}, // Same as vanilla
|
||||
{"area_palettes", {0x7D1C, 0x00}}, // Same as vanilla
|
||||
{"screen_sizes", {0x1788D, 0x01}}, // Same as vanilla
|
||||
{"sprite_sets", {0x7A41, 0x00}}, // Same as vanilla
|
||||
{"sprite_palettes", {0x7B41, 0x00}}, // Same as vanilla
|
||||
{"main_palettes", {0x140160, 0x00}}, // Same as v2
|
||||
{"bg_colors", {0x140000, 0x00}}, // New v3 feature
|
||||
{"subscreen_overlays", {0x140340, 0x00}}, // New v3 feature
|
||||
{"animated_gfx", {0x1402A0, 0x00}}, // New v3 feature
|
||||
{"custom_tiles", {0x140480, 0x00}}, // New v3 feature
|
||||
};
|
||||
}
|
||||
|
||||
// Helper to apply version-specific patches
|
||||
absl::Status ApplyVersionPatch(Rom& rom, const std::string& version) {
|
||||
const auto* data = &vanilla_data_;
|
||||
if (version == "v2") {
|
||||
data = &v2_data_;
|
||||
} else if (version == "v3") {
|
||||
data = &v3_data_;
|
||||
}
|
||||
|
||||
// Apply version-specific data
|
||||
for (const auto& [key, value] : *data) {
|
||||
RETURN_IF_ERROR(rom.WriteByte(value.first, value.second));
|
||||
}
|
||||
|
||||
// Apply version-specific features
|
||||
if (version == "v2") {
|
||||
// Enable v2 features
|
||||
RETURN_IF_ERROR(rom.WriteByte(0x140146, 0x01)); // Enable main palettes
|
||||
} else if (version == "v3") {
|
||||
// Enable v3 features
|
||||
RETURN_IF_ERROR(rom.WriteByte(0x140146, 0x01)); // Enable main palettes
|
||||
RETURN_IF_ERROR(rom.WriteByte(0x140147, 0x01)); // Enable area-specific BG
|
||||
RETURN_IF_ERROR(rom.WriteByte(0x140148, 0x01)); // Enable subscreen overlay
|
||||
RETURN_IF_ERROR(rom.WriteByte(0x140149, 0x01)); // Enable animated GFX
|
||||
RETURN_IF_ERROR(rom.WriteByte(0x14014A, 0x01)); // Enable custom tile GFX groups
|
||||
RETURN_IF_ERROR(rom.WriteByte(0x14014B, 0x01)); // Enable mosaic
|
||||
}
|
||||
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
// Helper to validate version-specific addresses
|
||||
bool ValidateVersionAddresses(Rom& rom, const std::string& version) {
|
||||
const auto* data = &vanilla_data_;
|
||||
if (version == "v2") {
|
||||
data = &v2_data_;
|
||||
} else if (version == "v3") {
|
||||
data = &v3_data_;
|
||||
}
|
||||
|
||||
for (const auto& [key, value] : *data) {
|
||||
auto byte_value = rom.ReadByte(value.first);
|
||||
if (!byte_value.ok() || *byte_value != value.second) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string vanilla_rom_path_;
|
||||
std::string vanilla_test_path_;
|
||||
std::string v2_test_path_;
|
||||
std::string v3_test_path_;
|
||||
|
||||
std::map<std::string, std::pair<uint32_t, uint8_t>> vanilla_data_;
|
||||
std::map<std::string, std::pair<uint32_t, uint8_t>> v2_data_;
|
||||
std::map<std::string, std::pair<uint32_t, uint8_t>> v3_data_;
|
||||
};
|
||||
|
||||
// Test vanilla ROM baseline
|
||||
TEST_F(ZSCustomOverworldUpgradeTest, VanillaBaseline) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Validate vanilla addresses
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*rom, "vanilla"));
|
||||
|
||||
// Verify version flag
|
||||
auto version_byte = rom->ReadByte(0x140145);
|
||||
ASSERT_TRUE(version_byte.ok());
|
||||
EXPECT_EQ(*version_byte, 0xFF);
|
||||
}
|
||||
|
||||
// Test vanilla to v2 upgrade
|
||||
TEST_F(ZSCustomOverworldUpgradeTest, VanillaToV2Upgrade) {
|
||||
// Load vanilla ROM
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Apply v2 patch
|
||||
ASSERT_OK(ApplyVersionPatch(*rom, "v2"));
|
||||
|
||||
// Validate v2 addresses
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*rom, "v2"));
|
||||
|
||||
// Save v2 ROM
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = v2_test_path_}));
|
||||
|
||||
// Reload and verify
|
||||
std::unique_ptr<Rom> reloaded_rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(reloaded_rom->LoadFromFile(v2_test_path_));
|
||||
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*reloaded_rom, "v2"));
|
||||
auto version_byte = reloaded_rom->ReadByte(0x140145);
|
||||
ASSERT_TRUE(version_byte.ok());
|
||||
EXPECT_EQ(*version_byte, 0x02);
|
||||
}
|
||||
|
||||
// Test v2 to v3 upgrade
|
||||
TEST_F(ZSCustomOverworldUpgradeTest, V2ToV3Upgrade) {
|
||||
// Load vanilla ROM
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Apply v2 patch first
|
||||
ASSERT_OK(ApplyVersionPatch(*rom, "v2"));
|
||||
|
||||
// Apply v3 patch
|
||||
ASSERT_OK(ApplyVersionPatch(*rom, "v3"));
|
||||
|
||||
// Validate v3 addresses
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*rom, "v3"));
|
||||
|
||||
// Save v3 ROM
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = v3_test_path_}));
|
||||
|
||||
// Reload and verify
|
||||
std::unique_ptr<Rom> reloaded_rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(reloaded_rom->LoadFromFile(v3_test_path_));
|
||||
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*reloaded_rom, "v3"));
|
||||
auto version_byte = reloaded_rom->ReadByte(0x140145);
|
||||
ASSERT_TRUE(version_byte.ok());
|
||||
EXPECT_EQ(*version_byte, 0x03);
|
||||
}
|
||||
|
||||
// Test direct vanilla to v3 upgrade
|
||||
TEST_F(ZSCustomOverworldUpgradeTest, VanillaToV3Upgrade) {
|
||||
// Load vanilla ROM
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Apply v3 patch directly
|
||||
ASSERT_OK(ApplyVersionPatch(*rom, "v3"));
|
||||
|
||||
// Validate v3 addresses
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*rom, "v3"));
|
||||
|
||||
// Save v3 ROM
|
||||
ASSERT_OK(rom->SaveToFile(Rom::SaveSettings{.filename = v3_test_path_}));
|
||||
|
||||
// Reload and verify
|
||||
std::unique_ptr<Rom> reloaded_rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(reloaded_rom->LoadFromFile(v3_test_path_));
|
||||
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*reloaded_rom, "v3"));
|
||||
auto version_byte = reloaded_rom->ReadByte(0x140145);
|
||||
ASSERT_TRUE(version_byte.ok());
|
||||
EXPECT_EQ(*version_byte, 0x03);
|
||||
}
|
||||
|
||||
// Test address validation for each version
|
||||
TEST_F(ZSCustomOverworldUpgradeTest, AddressValidation) {
|
||||
// Test vanilla addresses
|
||||
std::unique_ptr<Rom> vanilla_rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(vanilla_rom->LoadFromFile(vanilla_test_path_));
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*vanilla_rom, "vanilla"));
|
||||
|
||||
// Test v2 addresses
|
||||
ASSERT_OK(ApplyVersionPatch(*vanilla_rom, "v2"));
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*vanilla_rom, "v2"));
|
||||
|
||||
// Test v3 addresses
|
||||
ASSERT_OK(ApplyVersionPatch(*vanilla_rom, "v3"));
|
||||
EXPECT_TRUE(ValidateVersionAddresses(*vanilla_rom, "v3"));
|
||||
}
|
||||
|
||||
// Test feature enablement/disablement
|
||||
TEST_F(ZSCustomOverworldUpgradeTest, FeatureToggle) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
ASSERT_OK(ApplyVersionPatch(*rom, "v3"));
|
||||
|
||||
// Test feature flags
|
||||
auto main_palettes = rom->ReadByte(0x140146);
|
||||
auto area_bg = rom->ReadByte(0x140147);
|
||||
auto subscreen_overlay = rom->ReadByte(0x140148);
|
||||
auto animated_gfx = rom->ReadByte(0x140149);
|
||||
auto custom_tiles = rom->ReadByte(0x14014A);
|
||||
auto mosaic = rom->ReadByte(0x14014B);
|
||||
|
||||
ASSERT_TRUE(main_palettes.ok());
|
||||
ASSERT_TRUE(area_bg.ok());
|
||||
ASSERT_TRUE(subscreen_overlay.ok());
|
||||
ASSERT_TRUE(animated_gfx.ok());
|
||||
ASSERT_TRUE(custom_tiles.ok());
|
||||
ASSERT_TRUE(mosaic.ok());
|
||||
|
||||
EXPECT_EQ(*main_palettes, 0x01); // Main palettes enabled
|
||||
EXPECT_EQ(*area_bg, 0x01); // Area-specific BG enabled
|
||||
EXPECT_EQ(*subscreen_overlay, 0x01); // Subscreen overlay enabled
|
||||
EXPECT_EQ(*animated_gfx, 0x01); // Animated GFX enabled
|
||||
EXPECT_EQ(*custom_tiles, 0x01); // Custom tile GFX groups enabled
|
||||
EXPECT_EQ(*mosaic, 0x01); // Mosaic enabled
|
||||
|
||||
// Disable some features
|
||||
ASSERT_OK(rom->WriteByte(0x140147, 0x00)); // Disable area-specific BG
|
||||
ASSERT_OK(rom->WriteByte(0x140149, 0x00)); // Disable animated GFX
|
||||
|
||||
// Verify features are disabled
|
||||
auto disabled_area_bg = rom->ReadByte(0x140147);
|
||||
auto disabled_animated_gfx = rom->ReadByte(0x140149);
|
||||
ASSERT_TRUE(disabled_area_bg.ok());
|
||||
ASSERT_TRUE(disabled_animated_gfx.ok());
|
||||
|
||||
EXPECT_EQ(*disabled_area_bg, 0x00);
|
||||
EXPECT_EQ(*disabled_animated_gfx, 0x00);
|
||||
|
||||
// Re-enable features
|
||||
ASSERT_OK(rom->WriteByte(0x140147, 0x01));
|
||||
ASSERT_OK(rom->WriteByte(0x140149, 0x01));
|
||||
|
||||
// Verify features are re-enabled
|
||||
auto reenabled_area_bg = rom->ReadByte(0x140147);
|
||||
auto reenabled_animated_gfx = rom->ReadByte(0x140149);
|
||||
ASSERT_TRUE(reenabled_area_bg.ok());
|
||||
ASSERT_TRUE(reenabled_animated_gfx.ok());
|
||||
|
||||
EXPECT_EQ(*reenabled_area_bg, 0x01);
|
||||
EXPECT_EQ(*reenabled_animated_gfx, 0x01);
|
||||
}
|
||||
|
||||
// Test data integrity during upgrades
|
||||
TEST_F(ZSCustomOverworldUpgradeTest, DataIntegrity) {
|
||||
std::unique_ptr<Rom> rom = std::make_unique<Rom>();
|
||||
ASSERT_OK(rom->LoadFromFile(vanilla_test_path_));
|
||||
|
||||
// Store some original data
|
||||
auto original_graphics = rom->ReadByte(0x7C9C);
|
||||
auto original_palette = rom->ReadByte(0x7D1C);
|
||||
auto original_sprite_set = rom->ReadByte(0x7A41);
|
||||
|
||||
ASSERT_TRUE(original_graphics.ok());
|
||||
ASSERT_TRUE(original_palette.ok());
|
||||
ASSERT_TRUE(original_sprite_set.ok());
|
||||
|
||||
// Upgrade to v3
|
||||
ASSERT_OK(ApplyVersionPatch(*rom, "v3"));
|
||||
|
||||
// Verify original data is preserved
|
||||
auto preserved_graphics = rom->ReadByte(0x7C9C);
|
||||
auto preserved_palette = rom->ReadByte(0x7D1C);
|
||||
auto preserved_sprite_set = rom->ReadByte(0x7A41);
|
||||
|
||||
ASSERT_TRUE(preserved_graphics.ok());
|
||||
ASSERT_TRUE(preserved_palette.ok());
|
||||
ASSERT_TRUE(preserved_sprite_set.ok());
|
||||
|
||||
EXPECT_EQ(*preserved_graphics, *original_graphics);
|
||||
EXPECT_EQ(*preserved_palette, *original_palette);
|
||||
EXPECT_EQ(*preserved_sprite_set, *original_sprite_set);
|
||||
|
||||
// Verify new v3 data is initialized
|
||||
auto bg_colors = rom->ReadByte(0x140000);
|
||||
auto subscreen_overlays = rom->ReadByte(0x140340);
|
||||
auto animated_gfx = rom->ReadByte(0x1402A0);
|
||||
auto custom_tiles = rom->ReadByte(0x140480);
|
||||
|
||||
ASSERT_TRUE(bg_colors.ok());
|
||||
ASSERT_TRUE(subscreen_overlays.ok());
|
||||
ASSERT_TRUE(animated_gfx.ok());
|
||||
ASSERT_TRUE(custom_tiles.ok());
|
||||
|
||||
EXPECT_EQ(*bg_colors, 0x00); // BG colors
|
||||
EXPECT_EQ(*subscreen_overlays, 0x00); // Subscreen overlays
|
||||
EXPECT_EQ(*animated_gfx, 0x00); // Animated GFX
|
||||
EXPECT_EQ(*custom_tiles, 0x00); // Custom tiles
|
||||
}
|
||||
|
||||
} // namespace test
|
||||
} // namespace yaze
|
||||
Reference in New Issue
Block a user