Add validation test tool to verify load-save byte likeness

Author: Bo98

.github/workflows/main.yml

@@ -41,7 +41,13 @@ jobs:
           if [ "$RUNNER_OS" == "Windows" ]; then
             export CMAKE_GENERATOR=Ninja
           fi
-          cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} -DCMAKE_INSTALL_PREFIX=install -DLIBBNDL_BUILD_TOOLS=ON -DLIBBNDL_BUILD_UI=ON -DLIBBNDL_INSTALL_UI=ON
+          cmake -S. -Bbuild \
+            -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
+            -DCMAKE_INSTALL_PREFIX=install \
+            -DLIBBNDL_BUILD_TOOLS=ON \
+            -DLIBBNDL_BUILD_UI=ON \
+            -DLIBBNDL_INSTALL_UI=ON \
+            -DLIBBNDL_BUILD_VALIDATIONTEST=ON
           cmake --build build
           cmake --install build
 

CMakePresets.json

@@ -20,7 +20,8 @@
       "installDir": "${sourceDir}/out/install/${presetName}",
       "cacheVariables": {
         "LIBBNDL_BUILD_TOOLS": "ON",
-        "LIBBNDL_INSTALL_TOOLS": "ON"
+        "LIBBNDL_INSTALL_TOOLS": "ON",
+        "LIBBNDL_BUILD_VALIDATIONTEST": "ON"
       }
     },
     {
@@ -414,7 +415,7 @@
   ],
   "vendor": {
     "qt-project.org/Presets": {
-      "checksum": "YMZgAov16/vL9KShMbHsAB8IkfY="
+      "checksum": "Vvury/6B6y8sAEcGfFRgwMMpPdE="
     }
   }
 }

tools/CMakeLists.txt

@@ -6,3 +6,8 @@ option(LIBBNDL_BUILD_UI "Build UI tools" OFF)
 if(LIBBNDL_BUILD_UI)
     add_subdirectory(bndl_edit)
 endif()
+
+option(LIBBNDL_BUILD_VALIDATIONTEST "Build validation test tool" OFF)
+if(LIBBNDL_BUILD_VALIDATIONTEST)
+    add_subdirectory(bndl_validationtest)
+endif()

tools/bndl_validationtest/CMakeLists.txt

@@ -0,0 +1,19 @@
+add_executable(bndl_validationtest main.cpp)
+
+target_link_libraries(bndl_validationtest PRIVATE libbndl cxxopts::cxxopts pugixml::pugixml)
+target_compile_definitions(bndl_validationtest PRIVATE PUGIXML_HEADER_ONLY PUGIXML_NO_XPATH)
+
+set_property(TARGET bndl_validationtest PROPERTY CXX_STANDARD 20)
+
+if(MSVC)
+    target_compile_options(bndl_validationtest PRIVATE "/W4" "/Zc:throwingNew" "/EHsc")
+endif()
+
+add_custom_command(TARGET bndl_validationtest POST_BUILD
+                   COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:libbndl> $<TARGET_FILE_DIR:bndl_validationtest>)
+
+if(LIBBNDL_INSTALL_TOOLS)
+    install(TARGETS bndl_validationtest RUNTIME DESTINATION bin
+                                        LIBRARY DESTINATION lib
+                                        ARCHIVE DESTINATION lib)
+endif()

tools/bndl_validationtest/main.cpp

@@ -0,0 +1,76 @@
+#include <libbndl/bundle.hpp>
+#include <filesystem>
+#include <fstream>
+#include <iostream>
+
+static bool identicalFiles(const std::filesystem::path &path1, const std::filesystem::path &path2)
+{
+	std::ifstream file1(path1, std::ifstream::binary | std::ifstream::ate);
+	std::ifstream file2(path2, std::ifstream::binary | std::ifstream::ate);
+
+	if (file1.fail() || file2.fail()) {
+		return false;
+	}
+
+	if (file1.tellg() != file2.tellg()) {
+		return false;
+	}
+
+	file1.seekg(0, std::ifstream::beg);
+	file2.seekg(0, std::ifstream::beg);
+	return std::equal(std::istreambuf_iterator<char>(file1.rdbuf()), std::istreambuf_iterator<char>(), std::istreambuf_iterator<char>(file2.rdbuf()));
+}
+
+int main(int argc, char **argv)
+{
+	if (argc != 2)
+	{
+		std::cerr << "Invalid arguments\n";
+		return 1;
+	}
+
+	const auto dir = std::filesystem::path(argv[1]);
+	if (!std::filesystem::is_directory(dir))
+	{
+		std::cerr << "Invalid directory\n";
+		return 2;
+	}
+
+	// This is just a test tool so not to bothered about the scenario where this already exists.
+	const auto outputFile = std::filesystem::temp_directory_path() / "bndl_validationtest.bndl";
+	
+	std::filesystem::remove(outputFile);
+
+	for (const auto &entry : std::filesystem::recursive_directory_iterator(dir))
+	{
+		if (!std::filesystem::is_regular_file(entry))
+			continue;
+
+		const auto path = entry.path();
+
+		libbndl::Bundle bundle;
+
+		if (!bundle.Load(path.string()))
+		{
+			auto ext = path.extension().string();
+			std::transform(ext.begin(), ext.end(), ext.begin(), [](auto c) { return std::tolower(c, std::locale::classic()); });
+
+			// If it looks like a bundle let's be vocal about it
+			if (ext == ".bndl" || ext == ".bundle")
+				std::cerr << "Failed to load likely bundle: " << path << '\n';
+
+			continue;
+		}
+
+		if (!bundle.Save(outputFile.string()))
+		{
+			std::cerr << "Failed to save bundle: " << path << '\n';
+		}
+		else if (!identicalFiles(path, outputFile))
+		{
+			std::cerr << "Did not produce identical output on save: " << path << '\n';
+		}
+
+		std::filesystem::remove(outputFile);
+	}
+}