Refactor tests to use more of std::filesystem

Because the tests didn't use std::filesystem originally, there was a lot
of logic that had to be re-implemented with OS specific function calls.

Now that std::filesystem is in use, many things can be refactored:
* Replace create_folder with std::filesystem::create_directories
* Replace delete_folder & delete_folder_contents with
  std::filesystem::remove_all
* Lazily create folders on first use, resulting in many fewer filesystem
  operations
* FolderManager::copy_file is a wrapper around std::filesystem::copy_file
* FolderManager::remove is a wrapper around std::filesystem::remove
* Each test uses a separate directory, allowing parallel test execution
* FolderManager::add_symlink wraps around std::filesystem::create_symlink,
  allows for easier usage of symlinks in tests
* Use switch in FrameworkEnvironment::add_icd() for consistency
* Use error code filesystem calls to get better error messages
* Don't make changes to the filesystem when running death tests
* Move fs::FolderManager to test_environment since the type was only in
  test_util so that the shim could get access to it. Now a function
  pointer is used.

Author: charles-lunarg

tests/framework/framework_config.h.in

@@ -77,8 +77,8 @@
 #if _WIN32 || _WIN64
 #define DUMMY_BINARY_WINDOWS_64 "${CMAKE_CURRENT_SOURCE_DIR}/data/binaries/dummy_library_pe_64.dll"
 #define DUMMY_BINARY_WINDOWS_32 "${CMAKE_CURRENT_SOURCE_DIR}/data/binaries/dummy_library_pe_32.dll"
-#define BAD_DUMMY_BINARY_WINDOWS_64 "${CMAKE_CURRENT_SOURCE_DIR}/data/binaries/libdummy_library_elf_64.dll"
-#define BAD_DUMMY_BINARY_WINDOWS_32 "${CMAKE_CURRENT_SOURCE_DIR}/data/binaries/libdummy_library_elf_32.dll"
+#define BAD_DUMMY_BINARY_WINDOWS_64 "${CMAKE_CURRENT_SOURCE_DIR}/data/binaries/dummy_library_elf_64.dll"
+#define BAD_DUMMY_BINARY_WINDOWS_32 "${CMAKE_CURRENT_SOURCE_DIR}/data/binaries/dummy_library_elf_32.dll"
 #endif
 #if defined(__linux__) || defined(__APPLE__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__GNU__) || defined(__QNX__)
 #define DUMMY_BINARY_LINUX_64 "${CMAKE_CURRENT_SOURCE_DIR}/data/binaries/libdummy_library_elf_64.so"

tests/framework/shim/shim.h

@@ -29,6 +29,7 @@
 
 #include "test_util.h"
 
+#include <unordered_map>
 #include <unordered_set>
 #include <stdlib.h>
 
@@ -135,10 +136,12 @@ struct FrameworkEnvironment;  // forward declaration
 // defined in the .cpp wont be found by the rest of the application
 struct PlatformShim {
     PlatformShim() { fputs_stderr_log.reserve(65536); }
-    PlatformShim(std::vector<fs::FolderManager>* folders) : folders(folders) { fputs_stderr_log.reserve(65536); }
+    PlatformShim(GetFoldersFunc get_folders_by_name_function) : get_folders_by_name_function(get_folders_by_name_function) {
+        fputs_stderr_log.reserve(65536);
+    }
 
     // Used to get info about which drivers & layers have been added to folders
-    std::vector<fs::FolderManager>* folders;
+    GetFoldersFunc get_folders_by_name_function;
 
     // Captures the output to stderr from fputs & fputc - aka the output of loader_log()
     std::string fputs_stderr_log;
@@ -214,6 +217,8 @@ struct PlatformShim {
 
     std::filesystem::path query_default_redirect_path(ManifestCategory category);
 
+    void set_app_package_path(std::filesystem::path const& path);
+
     std::unordered_map<std::string, std::filesystem::path> redirection_map;
     std::unordered_map<std::string, std::filesystem::path> dlopen_redirection_map;
     std::unordered_set<std::string> known_path_set;
@@ -233,17 +238,14 @@ struct PlatformShim {
 std::vector<std::string> parse_env_var_list(std::string const& var);
 std::string category_path_name(ManifestCategory category);
 
-std::vector<std::filesystem::path> get_folder_contents(std::vector<fs::FolderManager>* folders,
-                                                       std::filesystem::path folder_name) noexcept;
-
 extern "C" {
 // dynamically link on windows and macos
 #if defined(WIN32) || defined(__APPLE__)
-using PFN_get_platform_shim = PlatformShim* (*)(std::vector<fs::FolderManager>* folders);
+using PFN_get_platform_shim = PlatformShim* (*)(GetFoldersFunc get_folders_by_name_function);
 #define GET_PLATFORM_SHIM_STR "get_platform_shim"
 
 #elif defined(__linux__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__GNU__) || defined(__QNX__)
 // statically link on linux
-PlatformShim* get_platform_shim(std::vector<fs::FolderManager>* folders);
+PlatformShim* get_platform_shim(GetFoldersFunc get_folders_by_name_function);
 #endif
 }

tests/framework/shim/shim_common.cpp

@@ -58,16 +58,6 @@ std::vector<std::string> parse_env_var_list(std::string const& var) {
     return items;
 }
 
-std::vector<std::filesystem::path> get_folder_contents(std::vector<fs::FolderManager>* folders,
-                                                       std::filesystem::path folder_name) noexcept {
-    for (auto& folder : *folders) {
-        if (folder.location() == folder_name) {
-            return folder.get_files();
-        }
-    }
-    return {};
-}
-
 #if defined(WIN32)
 
 D3DKMT_Adapter& D3DKMT_Adapter::add_driver_manifest_path(std::filesystem::path const& src) { return add_path(src, driver_paths); }
@@ -191,6 +181,8 @@ void PlatformShim::add_manifest([[maybe_unused]] ManifestCategory category, [[ma
 void PlatformShim::add_unsecured_manifest([[maybe_unused]] ManifestCategory category,
                                           [[maybe_unused]] std::filesystem::path const& path) {}
 
+void PlatformShim::set_app_package_path(std::filesystem::path const& path) {}
+
 void parse_and_add_env_var_override(std::vector<std::string>& paths, std::string env_var_contents) {
     auto parsed_paths = parse_env_var_list(env_var_contents);
     paths.insert(paths.end(), parsed_paths.begin(), parsed_paths.end());

tests/framework/shim/unix_shim.cpp

@@ -36,13 +36,13 @@
 PlatformShim platform_shim;
 extern "C" {
 #if defined(__linux__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__GNU__) || defined(__QNX__)
-PlatformShim* get_platform_shim(std::vector<fs::FolderManager>* folders) {
-    platform_shim = PlatformShim(folders);
+PlatformShim* get_platform_shim(GetFoldersFunc get_folders_by_name_function) {
+    platform_shim = PlatformShim(get_folders_by_name_function);
     return &platform_shim;
 }
 #elif defined(__APPLE__)
-FRAMEWORK_EXPORT PlatformShim* get_platform_shim(std::vector<fs::FolderManager>* folders) {
-    platform_shim = PlatformShim(folders);
+FRAMEWORK_EXPORT PlatformShim* get_platform_shim(GetFoldersFunc get_folders_by_name_function) {
+    platform_shim = PlatformShim(get_folders_by_name_function);
     return &platform_shim;
 }
 #endif
@@ -205,7 +205,7 @@ FRAMEWORK_EXPORT struct dirent* READDIR_FUNC_NAME(DIR* dir_stream) {
         if (it->is_fake_path) {
             real_path = platform_shim.redirection_map.at(it->folder_path);
         }
-        auto filenames = get_folder_contents(platform_shim.folders, real_path);
+        auto filenames = platform_shim.get_folders_by_name_function(real_path.c_str());
 
         // Add the dirent structures in the order they appear in the FolderManager
         // Ignore anything which wasn't in the FolderManager

tests/framework/shim/windows_shim.cpp

@@ -512,8 +512,8 @@ BOOL WINAPI DllMain([[maybe_unused]] HINSTANCE hinst, DWORD dwReason, [[maybe_un
     }
     return TRUE;
 }
-FRAMEWORK_EXPORT PlatformShim *get_platform_shim(std::vector<fs::FolderManager> *folders) {
-    platform_shim = PlatformShim(folders);
+FRAMEWORK_EXPORT PlatformShim *get_platform_shim(GetFoldersFunc get_folders_by_name_function) {
+    platform_shim = PlatformShim(get_folders_by_name_function);
     return &platform_shim;
 }
 }