From 8334f732ba0f1d0e3f139cd91226b2e9878d3189 Mon Sep 17 00:00:00 2001
From: Jesse Talavera-Greenberg <jesse@jesse.tg>
Date: Thu, 7 Sep 2023 22:03:15 -0400
Subject: [PATCH] Write tests to ensure that wfcsettings.bin doesn't overwrite
 anything it shouldn't

---
 test/CMakeLists.txt      | 38 +++++++++++++++++++++++++++++++++++---
 test/python/retroarch.py | 29 ++++++++++++++++++++++++++++-
 2 files changed, 63 insertions(+), 4 deletions(-)

diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
index f24b00d6..1c8f497e 100644
--- a/test/CMakeLists.txt
+++ b/test/CMakeLists.txt
@@ -1,4 +1,4 @@
-find_package(Python3 COMPONENTS Interpreter)
+find_package(Python3 3.8 REQUIRED COMPONENTS Interpreter)
 
 if (NOT RETROARCH)
     find_program(RETROARCH retroarch)
@@ -47,7 +47,7 @@ include(CMakePrintHelpers)
 
 function(add_retroarch_test)
     set(options WILL_FAIL ARM7_BIOS ARM9_BIOS ARM7_DSI_BIOS ARM9_DSI_BIOS NDS_FIRMWARE DSI_FIRMWARE DSI_NAND)
-    set(oneValueArgs NAME MAX_FRAMES CONTENT)
+    set(oneValueArgs NAME MAX_FRAMES CONTENT REQUIRE_FILE_SIZE_UNCHANGED REQUIRE_FILE_CREATED)
     set(multiValueArgs CORE_OPTION PASS_REGULAR_EXPRESSION FAIL_REGULAR_EXPRESSION SKIP_REGULAR_EXPRESSION)
     cmake_parse_arguments(PARSE_ARGV 0 RETRO "${options}" "${oneValueArgs}" "${multiValueArgs}")
 
@@ -69,6 +69,14 @@ function(add_retroarch_test)
         list(APPEND REQUIRED_FILES "${RETRO_CONTENT}")
     endif()
 
+    if (RETRO_REQUIRE_FILE_SIZE_UNCHANGED)
+        list(APPEND ENVIRONMENT "REQUIRE_FILE_SIZE_UNCHANGED=${RETRO_REQUIRE_FILE_SIZE_UNCHANGED}")
+    endif()
+
+    if (RETRO_REQUIRE_FILE_CREATED)
+        list(APPEND ENVIRONMENT "REQUIRE_FILE_CREATED=${RETRO_REQUIRE_FILE_CREATED}")
+    endif()
+
     list(APPEND ENVIRONMENT "RETROARCH=${RETROARCH}")
     list(APPEND ENVIRONMENT ${RETRO_CORE_OPTION}) # Not an omission, this is already a list
 
@@ -464,11 +472,35 @@ add_retroarch_test(
     WILL_FAIL
 )
 
+### Using wfcsettings.bin
+
+# See https://github.com/JesseTG/melonds-ds/issues/59
+add_retroarch_test(
+    NAME "Native firmware is not overwritten by contents of wfcsettings.bin"
+    MAX_FRAMES 6
+    CORE_OPTION "melonds_console_mode=ds"
+    CORE_OPTION "melonds_firmware_nds_path=melonDS DS/firmware.bin"
+    ARM7_BIOS
+    ARM9_BIOS
+    NDS_FIRMWARE
+    REQUIRE_FILE_SIZE_UNCHANGED "system/melonDS DS/firmware.bin"
+)
+
+add_retroarch_test(
+    NAME "Core saves wi-fi settings to wfcsettings.bin when using built-in firmware"
+    CONTENT "${CMAKE_BINARY_DIR}/mkds.nds"
+    MAX_FRAMES 6
+    CORE_OPTION "melonds_console_mode=ds"
+    CORE_OPTION "melonds_firmware_nds_path=/builtin"
+    ARM7_BIOS
+    ARM9_BIOS
+    REQUIRE_FILE_CREATED "system/melonDS DS/wfcsettings.bin"
+)
+
 # TODO: Write the following test capabilities:
 # - Copying a system file to a particular location
 # - Select a GBA ROM
 # - Select a GBA save file
-# - Select a different test script
 
 # TODO: Write the following tests:
 
diff --git a/test/python/retroarch.py b/test/python/retroarch.py
index f7ce480b..a9eb20da 100644
--- a/test/python/retroarch.py
+++ b/test/python/retroarch.py
@@ -95,4 +95,31 @@ def retroarch():
 
 
 if __name__ == "__main__":
-    sys.exit(retroarch())
+    require_file_size_unchanged = os.environ.get("REQUIRE_FILE_SIZE_UNCHANGED", None)
+    required_file_size: int | None = None
+    if require_file_size_unchanged is not None:
+        # If there's a file whose size we must ensure didn't change...
+        require_file_size_unchanged = os.path.join(tempdir, require_file_size_unchanged)
+        stat = os.stat(require_file_size_unchanged)
+        assert stat is not None
+        required_file_size = stat.st_size
+
+    require_file_created = os.environ.get("REQUIRE_FILE_CREATED", None)
+    if require_file_created is not None:
+        # If there's a file that we must ensure is newly-created...
+        require_file_created = os.path.join(tempdir, require_file_created)
+        assert not os.access(require_file_created, os.F_OK)
+
+    returnCode = retroarch()
+
+    if require_file_size_unchanged is not None:
+        # If there's a file whose size we must ensure didn't change...
+        stat = os.stat(require_file_size_unchanged)
+        assert stat is not None
+        assert stat.st_size == required_file_size
+
+    if require_file_created is not None:
+        # If there's a file that we must ensure is newly-created...
+        assert os.access(require_file_created, os.F_OK)
+
+    sys.exit(returnCode)