feat: Add comprehensive test coverage documentation for dungeon editor
- Introduced detailed reports on unit, integration, and E2E test coverage for the dungeon editor. - Documented test results, including pass rates and identified issues, to enhance visibility into testing outcomes. - Implemented performance optimizations for the graphics system, significantly improving loading times and user experience. - Updated the smoke test for the dungeon editor to cover complete UI workflows and interactions. - Enhanced integration tests to utilize real ROM data, ensuring more reliable test execution.
This commit is contained in:
scawful
@@ -3,45 +3,90 @@
|
||||
#include "app/core/controller.h"
|
||||
#include "imgui_test_engine/imgui_te_context.h"
|
||||
|
||||
// Simple smoke test for dungeon editor
|
||||
// Verifies that the editor opens and basic UI elements are present
|
||||
// Comprehensive E2E test for dungeon editor
|
||||
// Tests the complete workflow: open editor -> select room -> view objects -> interact with UI
|
||||
void E2ETest_DungeonEditorSmokeTest(ImGuiTestContext* ctx)
|
||||
{
|
||||
ctx->LogInfo("=== Starting Dungeon Editor E2E 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 Editor");
|
||||
ctx->LogInfo("Dungeon Editor opened");
|
||||
|
||||
// Focus on the dungeon editor window
|
||||
ctx->WindowFocus("Dungeon Editor");
|
||||
|
||||
// Log that we opened the editor
|
||||
ctx->LogInfo("Dungeon Editor window opened successfully");
|
||||
|
||||
// Verify the 3-column layout exists
|
||||
// Check for Room Selector on the left
|
||||
ctx->SetRef("Dungeon Editor");
|
||||
ctx->LogInfo("Dungeon Editor window focused");
|
||||
|
||||
// Check basic tabs exist
|
||||
// Test 1: Room Selection
|
||||
ctx->LogInfo("--- Test 1: Room Selection ---");
|
||||
ctx->ItemClick("Rooms##TabItemButton");
|
||||
ctx->LogInfo("Room selector tab clicked");
|
||||
ctx->LogInfo("Clicked Rooms tab");
|
||||
|
||||
// Check that we can see room list
|
||||
// Room 0 should exist in any valid zelda3.sfc
|
||||
ctx->ItemClick("Room 0x00");
|
||||
ctx->LogInfo("Selected room 0x00");
|
||||
// Try to select different rooms
|
||||
const char* test_rooms[] = {"Room 0x00", "Room 0x01", "Room 0x02"};
|
||||
for (const char* room_name : test_rooms) {
|
||||
if (ctx->ItemExists(room_name)) {
|
||||
ctx->ItemClick(room_name);
|
||||
ctx->LogInfo("Selected %s", room_name);
|
||||
ctx->Yield(); // Give time for UI to update
|
||||
} else {
|
||||
ctx->LogWarning("%s not found in room list", room_name);
|
||||
}
|
||||
}
|
||||
|
||||
// Verify canvas is present (center column)
|
||||
// The canvas should be focusable
|
||||
ctx->ItemClick("##Canvas");
|
||||
ctx->LogInfo("Canvas clicked");
|
||||
// Test 2: Canvas Interaction
|
||||
ctx->LogInfo("--- Test 2: Canvas Interaction ---");
|
||||
if (ctx->ItemExists("##Canvas")) {
|
||||
ctx->ItemClick("##Canvas");
|
||||
ctx->LogInfo("Canvas clicked successfully");
|
||||
} else {
|
||||
ctx->LogError("Canvas not found!");
|
||||
}
|
||||
|
||||
// Check Object Selector tab on right
|
||||
// Test 3: Object Selector
|
||||
ctx->LogInfo("--- Test 3: Object Selector ---");
|
||||
ctx->ItemClick("Object Selector##TabItemButton");
|
||||
ctx->LogInfo("Object selector tab clicked");
|
||||
ctx->LogInfo("Object Selector tab clicked");
|
||||
|
||||
// Log success
|
||||
ctx->LogInfo("Dungeon Editor smoke test completed successfully");
|
||||
// Try to access room graphics tab
|
||||
ctx->ItemClick("Room Graphics##TabItemButton");
|
||||
ctx->LogInfo("Room Graphics tab clicked");
|
||||
|
||||
// Go back to Object Selector
|
||||
ctx->ItemClick("Object Selector##TabItemButton");
|
||||
ctx->LogInfo("Returned to Object Selector tab");
|
||||
|
||||
// Test 4: Object Editor tab
|
||||
ctx->LogInfo("--- Test 4: Object Editor ---");
|
||||
ctx->ItemClick("Object Editor##TabItemButton");
|
||||
ctx->LogInfo("Object Editor tab clicked");
|
||||
|
||||
// Check if mode buttons exist
|
||||
const char* mode_buttons[] = {"Select", "Insert", "Edit"};
|
||||
for (const char* button : mode_buttons) {
|
||||
if (ctx->ItemExists(button)) {
|
||||
ctx->LogInfo("Found mode button: %s", button);
|
||||
}
|
||||
}
|
||||
|
||||
// Test 5: Entrance Selector
|
||||
ctx->LogInfo("--- Test 5: Entrance Selector ---");
|
||||
ctx->ItemClick("Entrances##TabItemButton");
|
||||
ctx->LogInfo("Entrances tab clicked");
|
||||
|
||||
// Return to rooms
|
||||
ctx->ItemClick("Rooms##TabItemButton");
|
||||
ctx->LogInfo("Returned to Rooms tab");
|
||||
|
||||
// Final verification
|
||||
ctx->LogInfo("=== Dungeon Editor E2E Test Completed Successfully ===");
|
||||
ctx->LogInfo("All UI elements accessible and functional");
|
||||
}
|
||||
|
||||
|
||||
@@ -8,7 +8,10 @@ namespace test {
|
||||
|
||||
using namespace yaze::zelda3;
|
||||
|
||||
// Test cases using real ROM
|
||||
// ============================================================================
|
||||
// Basic Room Loading Tests
|
||||
// ============================================================================
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, LoadRoomFromRealRom) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
EXPECT_NE(room.rom(), nullptr);
|
||||
@@ -16,10 +19,24 @@ TEST_F(DungeonEditorIntegrationTest, LoadRoomFromRealRom) {
|
||||
EXPECT_FALSE(room.GetTileObjects().empty());
|
||||
}
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, LoadMultipleRooms) {
|
||||
// Test loading several different rooms
|
||||
for (int room_id : {0x00, 0x01, 0x02, 0x10, 0x20}) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), room_id);
|
||||
EXPECT_NE(room.rom(), nullptr) << "Failed to load room " << std::hex << room_id;
|
||||
room.LoadObjects();
|
||||
// Some rooms may be empty, but loading should not fail
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, DungeonEditorInitialization) {
|
||||
ASSERT_TRUE(dungeon_editor_->Load().ok());
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Object Encoding/Decoding Tests
|
||||
// ============================================================================
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, ObjectEncodingRoundTrip) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
room.LoadObjects();
|
||||
@@ -29,5 +46,174 @@ TEST_F(DungeonEditorIntegrationTest, ObjectEncodingRoundTrip) {
|
||||
EXPECT_EQ(encoded[encoded.size()-1], 0xFF); // Terminator
|
||||
}
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, EncodeType1Object) {
|
||||
// Type 1: xxxxxxss yyyyyyss iiiiiiii (ID < 0x100)
|
||||
zelda3::RoomObject obj(0x10, 5, 7, 0x12, 0); // id, x, y, size, layer
|
||||
auto bytes = obj.EncodeObjectToBytes();
|
||||
|
||||
// Verify encoding format
|
||||
EXPECT_EQ((bytes.b1 >> 2), 5) << "X coordinate should be in upper 6 bits of b1";
|
||||
EXPECT_EQ((bytes.b2 >> 2), 7) << "Y coordinate should be in upper 6 bits of b2";
|
||||
EXPECT_EQ(bytes.b3, 0x10) << "Object ID should be in b3";
|
||||
}
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, EncodeType2Object) {
|
||||
// Type 2: 111111xx xxxxyyyy yyiiiiii (ID >= 0x100 && < 0x200)
|
||||
zelda3::RoomObject obj(0x150, 12, 8, 0, 0);
|
||||
auto bytes = obj.EncodeObjectToBytes();
|
||||
|
||||
// Verify Type 2 marker
|
||||
EXPECT_EQ((bytes.b1 & 0xFC), 0xFC) << "Type 2 objects should have 111111 prefix";
|
||||
}
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, EncodeType3Object) {
|
||||
// Type 3: xxxxxxii yyyyyyii 11111iii (ID >= 0xF00)
|
||||
zelda3::RoomObject obj(0xF23, 3, 4, 0, 0);
|
||||
auto bytes = obj.EncodeObjectToBytes();
|
||||
|
||||
// Verify Type 3 encoding
|
||||
EXPECT_EQ((bytes.b3 >> 4), 0xF2) << "Type 3 high nibbles should be in b3";
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Object Manipulation Tests
|
||||
// ============================================================================
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, AddObjectToRoom) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
room.LoadObjects();
|
||||
|
||||
size_t initial_count = room.GetTileObjects().size();
|
||||
|
||||
// Add a new object
|
||||
zelda3::RoomObject new_obj(0x20, 10, 10, 0x12, 0);
|
||||
new_obj.set_rom(rom_.get());
|
||||
auto status = room.AddObject(new_obj);
|
||||
|
||||
EXPECT_TRUE(status.ok()) << "Failed to add object: " << status.message();
|
||||
EXPECT_EQ(room.GetTileObjects().size(), initial_count + 1);
|
||||
}
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, RemoveObjectFromRoom) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
room.LoadObjects();
|
||||
|
||||
size_t initial_count = room.GetTileObjects().size();
|
||||
ASSERT_GT(initial_count, 0) << "Room should have at least one object";
|
||||
|
||||
// Remove first object
|
||||
auto status = room.RemoveObject(0);
|
||||
|
||||
EXPECT_TRUE(status.ok()) << "Failed to remove object: " << status.message();
|
||||
EXPECT_EQ(room.GetTileObjects().size(), initial_count - 1);
|
||||
}
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, UpdateObjectInRoom) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
room.LoadObjects();
|
||||
|
||||
ASSERT_FALSE(room.GetTileObjects().empty());
|
||||
|
||||
// Update first object's position
|
||||
zelda3::RoomObject updated_obj = room.GetTileObjects()[0];
|
||||
updated_obj.x_ = 15;
|
||||
updated_obj.y_ = 15;
|
||||
|
||||
auto status = room.UpdateObject(0, updated_obj);
|
||||
|
||||
EXPECT_TRUE(status.ok()) << "Failed to update object: " << status.message();
|
||||
EXPECT_EQ(room.GetTileObjects()[0].x_, 15);
|
||||
EXPECT_EQ(room.GetTileObjects()[0].y_, 15);
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Object Validation Tests
|
||||
// ============================================================================
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, ValidateObjectBounds) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
|
||||
// Test objects within valid bounds
|
||||
zelda3::RoomObject valid_obj(0x10, 0, 0, 0, 0);
|
||||
EXPECT_TRUE(room.ValidateObject(valid_obj));
|
||||
|
||||
zelda3::RoomObject valid_obj2(0x10, 31, 31, 0, 0);
|
||||
EXPECT_TRUE(room.ValidateObject(valid_obj2));
|
||||
|
||||
// Test objects outside bounds
|
||||
zelda3::RoomObject invalid_obj(0x10, 32, 32, 0, 0);
|
||||
EXPECT_FALSE(room.ValidateObject(invalid_obj));
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Save/Load Round-Trip Tests
|
||||
// ============================================================================
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, SaveAndReloadRoom) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
room.LoadObjects();
|
||||
|
||||
size_t original_count = room.GetTileObjects().size();
|
||||
|
||||
// Encode objects
|
||||
auto encoded = room.EncodeObjects();
|
||||
EXPECT_FALSE(encoded.empty());
|
||||
|
||||
// Create a new room and decode
|
||||
auto room2 = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
room2.LoadObjects();
|
||||
|
||||
// Verify object count matches
|
||||
EXPECT_EQ(room2.GetTileObjects().size(), original_count);
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Object Rendering Tests
|
||||
// ============================================================================
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, RenderObjectWithTiles) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
room.LoadObjects();
|
||||
|
||||
ASSERT_FALSE(room.GetTileObjects().empty());
|
||||
|
||||
// Ensure tiles are loaded for first object
|
||||
auto& obj = room.GetTileObjects()[0];
|
||||
const_cast<zelda3::RoomObject&>(obj).set_rom(rom_.get());
|
||||
const_cast<zelda3::RoomObject&>(obj).EnsureTilesLoaded();
|
||||
|
||||
EXPECT_FALSE(obj.tiles_.empty()) << "Object should have tiles after loading";
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Multi-Layer Tests
|
||||
// ============================================================================
|
||||
|
||||
TEST_F(DungeonEditorIntegrationTest, ObjectsOnDifferentLayers) {
|
||||
auto room = zelda3::LoadRoomFromRom(rom_.get(), kTestRoomId);
|
||||
|
||||
// Add objects on different layers
|
||||
zelda3::RoomObject obj_bg1(0x10, 5, 5, 0, 0); // Layer 0 (BG2)
|
||||
zelda3::RoomObject obj_bg2(0x11, 6, 6, 0, 1); // Layer 1 (BG1)
|
||||
zelda3::RoomObject obj_bg3(0x12, 7, 7, 0, 2); // Layer 2 (BG3)
|
||||
|
||||
room.AddObject(obj_bg1);
|
||||
room.AddObject(obj_bg2);
|
||||
room.AddObject(obj_bg3);
|
||||
|
||||
// Encode and verify layer separation
|
||||
auto encoded = room.EncodeObjects();
|
||||
|
||||
// Should have layer terminators (0xFF 0xFF between layers)
|
||||
int terminator_count = 0;
|
||||
for (size_t i = 0; i < encoded.size() - 1; i++) {
|
||||
if (encoded[i] == 0xFF && encoded[i+1] == 0xFF) {
|
||||
terminator_count++;
|
||||
}
|
||||
}
|
||||
|
||||
EXPECT_GE(terminator_count, 2) << "Should have at least 2 layer terminators";
|
||||
}
|
||||
|
||||
} // namespace test
|
||||
} // namespace yaze
|
||||
|
||||
Reference in New Issue
Block a user