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

fix(overworld): stabilize palette and tilemap saves

Browse Source
This commit is contained in:
scawful
2025-12-22 14:29:43 -05:00
parent ffc3ddd854
commit e733bc78d6
5 changed files with 102 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
test/e2e/overworld/overworld_e2e_test.cc
View File

@@ -6,6 +6,7 @@
#include <vector>
#include "rom/rom.h"
#include "test/test_utils.h"
#include "testing.h"
#include "zelda3/overworld/overworld.h"
#include "zelda3/overworld/overworld_map.h"
@@ -26,19 +27,21 @@ namespace test {
*/
class OverworldE2ETest : public ::testing::Test {
protected:
static int FindPrimaryMapId(const zelda3::Overworld& overworld) {
for (int i = 0; i < static_cast<int>(overworld.overworld_maps().size());
i++) {
if (overworld.overworld_map(i)->parent() == i) {
return i;
}
}
return 0;
}
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_;
}
yaze::test::TestRomManager::SkipIfRomMissing(
yaze::test::RomRole::kVanilla, "OverworldE2ETest");
vanilla_rom_path_ =
yaze::test::TestRomManager::GetRomPath(yaze::test::RomRole::kVanilla);
// Create test ROM copies
vanilla_test_path_ = "test_vanilla_e2e.sfc";
@@ -46,7 +49,9 @@ class OverworldE2ETest : public ::testing::Test {
golden_data_path_ = "golden_data_e2e.h";
// Copy vanilla ROM for testing
std::filesystem::copy_file(vanilla_rom_path_, vanilla_test_path_);
std::filesystem::copy_file(
vanilla_rom_path_, vanilla_test_path_,
std::filesystem::copy_options::overwrite_existing);
}
void TearDown() override {
@@ -64,9 +69,29 @@ class OverworldE2ETest : public ::testing::Test {
// Helper to extract golden data from ROM
absl::Status ExtractGoldenData(const std::string& rom_path,
const std::string& output_path) {
const std::vector<std::filesystem::path> candidates = {
"overworld_golden_data_extractor",
"bin/overworld_golden_data_extractor",
"bin/Debug/overworld_golden_data_extractor",
"../bin/overworld_golden_data_extractor",
"../bin/Debug/overworld_golden_data_extractor",
};
std::string extractor_path;
for (const auto& candidate : candidates) {
if (std::filesystem::exists(candidate)) {
extractor_path = candidate.string();
break;
}
}
if (extractor_path.empty()) {
return absl::NotFoundError(
"overworld_golden_data_extractor not found. "
"Build target overworld_golden_data_extractor.");
}
// Run the golden data extractor
std::string command =
"./overworld_golden_data_extractor " + rom_path + " " + output_path;
extractor_path + " " + rom_path + " " + output_path;
int result = system(command.c_str());
if (result != 0) {
@@ -135,7 +160,8 @@ TEST_F(OverworldE2ETest, LoadVanillaOverworldData) {
// 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);
EXPECT_TRUE(*asm_version == 0xFF || *asm_version == 0x00)
<< "Vanilla ROM should have ASM version 0xFF or 0x00";
// Validate expansion flags for vanilla
EXPECT_FALSE(overworld.expanded_tile16());
@@ -229,13 +255,14 @@ TEST_F(OverworldE2ETest, OverworldEditPersistence) {
ASSERT_TRUE(status.ok());
// Make some edits to overworld maps
auto* map0 = overworld.mutable_overworld_map(0);
const int map_id = FindPrimaryMapId(overworld);
auto* map0 = overworld.mutable_overworld_map(map_id);
uint8_t original_gfx = map0->area_graphics();
uint8_t original_palette = map0->main_palette();
uint8_t original_palette = map0->area_palette();
// Change graphics and palette
map0->set_area_graphics(0x01);
map0->set_main_palette(0x02);
map0->set_area_palette(0x02);
// Save the changes
auto save_maps_status = overworld.SaveOverworldMaps();
@@ -253,9 +280,9 @@ TEST_F(OverworldE2ETest, OverworldEditPersistence) {
zelda3::Overworld reloaded_overworld(reloaded_rom.get());
ASSERT_OK(reloaded_overworld.Load(reloaded_rom.get()));
const auto& reloaded_map0 = reloaded_overworld.overworld_map(0);
const auto& reloaded_map0 = reloaded_overworld.overworld_map(map_id);
EXPECT_EQ(reloaded_map0->area_graphics(), 0x01);
EXPECT_EQ(reloaded_map0->main_palette(), 0x02);
EXPECT_EQ(reloaded_map0->area_palette(), 0x02);
}
// Test 5: Validate coordinate calculations match ZScream exactly

35
test/e2e/rom_dependent/cross_editor_integrity_test.cc
View File

@@ -28,6 +28,16 @@ namespace test {
*/
class CrossEditorIntegrityTest : public EditorSaveTestBase {
protected:
static int FindPrimaryMapId(const zelda3::Overworld& overworld) {
for (int i = 0; i < static_cast<int>(overworld.overworld_maps().size());
i++) {
if (overworld.overworld_map(i)->parent() == i) {
return i;
}
}
return 0;
}
void SetUp() override {
EditorSaveTestBase::SetUp();
@@ -102,9 +112,10 @@ TEST_F(CrossEditorIntegrityTest, Overworld_Plus_Palette) {
ASSERT_OK(overworld.Load(rom_.get()));
// --- Overworld Edit ---
auto* map5 = overworld.mutable_overworld_map(5);
uint8_t original_palette_id = map5->main_palette();
map5->set_main_palette((original_palette_id + 1) % 8);
const int map_id = FindPrimaryMapId(overworld);
auto* map5 = overworld.mutable_overworld_map(map_id);
uint8_t original_palette_id = map5->area_palette();
map5->set_area_palette((original_palette_id + 1) % 8);
// --- Palette Edit ---
const uint32_t palette_offset = 0xDE6C8; // Overworld main palette
@@ -126,7 +137,7 @@ TEST_F(CrossEditorIntegrityTest, Overworld_Plus_Palette) {
ASSERT_OK(reloaded_ow.Load(reloaded.get()));
// Verify overworld edit
EXPECT_EQ(reloaded_ow.overworld_map(5)->main_palette(),
EXPECT_EQ(reloaded_ow.overworld_map(map_id)->area_palette(),
(original_palette_id + 1) % 8)
<< "Overworld palette ID edit should persist";
@@ -373,10 +384,16 @@ TEST_F(CrossEditorIntegrityTest, LargeScale_CombinedEdits) {
// Edit many overworld maps
const int num_map_edits = 50;
std::map<int, uint8_t> expected_gfx;
for (int i = 0; i < num_map_edits; ++i) {
auto* map = overworld.mutable_overworld_map(i);
expected_gfx[i] = (map->area_graphics() + i) % 256;
map->set_area_graphics(expected_gfx[i]);
for (int map_id = 0;
map_id < static_cast<int>(overworld.overworld_maps().size()) &&
static_cast<int>(expected_gfx.size()) < num_map_edits;
++map_id) {
if (overworld.overworld_map(map_id)->parent() != map_id) {
continue;
}
auto* map = overworld.mutable_overworld_map(map_id);
expected_gfx[map_id] = (map->area_graphics() + map_id) % 256;
map->set_area_graphics(expected_gfx[map_id]);
}
// Edit many palette colors
@@ -410,7 +427,7 @@ TEST_F(CrossEditorIntegrityTest, LargeScale_CombinedEdits) {
map_verified++;
}
}
EXPECT_EQ(map_verified, num_map_edits)
EXPECT_EQ(map_verified, static_cast<int>(expected_gfx.size()))
<< "All map edits should persist";
// Verify palette edits

16
test/e2e/rom_dependent/rom_version_test.cc
View File

@@ -28,6 +28,16 @@ namespace test {
*/
class RomVersionTest : public MultiVersionEditorSaveTest {
protected:
static int FindPrimaryMapId(const zelda3::Overworld& overworld) {
for (int i = 0; i < static_cast<int>(overworld.overworld_maps().size());
i++) {
if (overworld.overworld_map(i)->parent() == i) {
return i;
}
}
return 0;
}
// Version-specific address constants
struct VersionAddresses {
uint32_t overworld_gfx_ptr1;
@@ -337,7 +347,8 @@ TEST_F(RomVersionTest, MultipleCycles_Stability) {
<< "Map count mismatch on cycle " << cycle;
// Make a modification
auto* map = overworld.mutable_overworld_map(cycle % 160);
const int map_id = FindPrimaryMapId(overworld);
auto* map = overworld.mutable_overworld_map(map_id);
uint8_t new_value = static_cast<uint8_t>(cycle);
map->set_area_graphics(new_value);
@@ -353,7 +364,8 @@ TEST_F(RomVersionTest, MultipleCycles_Stability) {
ASSERT_OK(final_ow.Load(rom.get()));
// Verify last modification persisted
EXPECT_EQ(final_ow.overworld_map((num_cycles - 1) % 160)->area_graphics(),
const int map_id = FindPrimaryMapId(final_ow);
EXPECT_EQ(final_ow.overworld_map(map_id)->area_graphics(),
static_cast<uint8_t>(num_cycles - 1));
}