Cleanup tests ICD creation

Reformulate how tests create test ICD's to simplify and reduce clutter.
Moves ManifestICD out of the TestCreateDetails and put it as a separate
argument to make it easier to configure the Manifest & the configuration
of the binary.

Author: charles-lunarg

tests/framework/test_environment.cpp

@@ -334,10 +334,15 @@ FrameworkEnvironment::~FrameworkEnvironment() {
     platform_shim->is_during_destruction = true;
 }
 
-TestICD& FrameworkEnvironment::add_icd(TestICDDetails icd_details) noexcept {
+TestICD& FrameworkEnvironment::add_icd(std::filesystem::path const& path, ManifestOptions args, ManifestICD manifest) noexcept {
+    manifest.set_lib_path(path);
+
+    if (args.json_name.empty()) {
+        args.json_name = "test_icd.json";
+    }
     size_t cur_icd_index = icds.size();
     fs::Folder* fs_ptr = &get_folder(ManifestLocation::driver);
-    switch (icd_details.discovery_type) {
+    switch (args.discovery_type) {
         case (ManifestDiscoveryType::env_var):
         case (ManifestDiscoveryType::add_env_var):
             fs_ptr = &get_folder(ManifestLocation::driver_env_var);
@@ -368,44 +373,44 @@ TestICD& FrameworkEnvironment::add_icd(TestICDDetails icd_details) noexcept {
     }
     auto& folder = *fs_ptr;
 
-    if (!icd_details.is_fake) {
-        std::filesystem::path new_lib_name = icd_details.icd_manifest.lib_path.stem();
+    if (!args.is_fake) {
+        std::filesystem::path new_lib_name = manifest.lib_path.stem();
         new_lib_name += "_";
         new_lib_name += std::to_string(cur_icd_index);
-        new_lib_name += icd_details.icd_manifest.lib_path.extension();
-        auto new_driver_location = folder.copy_file(icd_details.icd_manifest.lib_path, new_lib_name);
+        new_lib_name += manifest.lib_path.extension();
+        auto new_driver_location = folder.copy_file(manifest.lib_path, new_lib_name);
 
 #if TESTING_COMMON_UNIX_PLATFORMS
-        if (icd_details.library_path_type == LibraryPathType::default_search_paths) {
+        if (args.library_path_type == LibraryPathType::default_search_paths) {
             platform_shim->add_system_library(new_lib_name, new_driver_location);
         }
 #endif
 #if defined(WIN32)
-        if (icd_details.library_path_type == LibraryPathType::default_search_paths) {
+        if (args.library_path_type == LibraryPathType::default_search_paths) {
             SetDefaultDllDirectories(LOAD_LIBRARY_SEARCH_USER_DIRS);
             AddDllDirectory(new_driver_location.parent_path().native().c_str());
         }
 #endif
         icds.push_back(TestICDHandle(new_driver_location));
         icds.back().reset();
-        if (icd_details.library_path_type == LibraryPathType::relative) {
-            icd_details.icd_manifest.lib_path = std::filesystem::path(".") / new_lib_name;
-        } else if (icd_details.library_path_type == LibraryPathType::default_search_paths) {
-            icd_details.icd_manifest.lib_path = new_lib_name;
+        if (args.library_path_type == LibraryPathType::relative) {
+            manifest.lib_path = std::filesystem::path(".") / new_lib_name;
+        } else if (args.library_path_type == LibraryPathType::default_search_paths) {
+            manifest.lib_path = new_lib_name;
         } else {
-            icd_details.icd_manifest.lib_path = new_driver_location;
+            manifest.lib_path = new_driver_location;
         }
     }
-    if (icd_details.discovery_type != ManifestDiscoveryType::none) {
-        std::filesystem::path new_manifest_path = icd_details.json_name.stem();
-        if (!icd_details.disable_icd_inc) {
+    if (args.discovery_type != ManifestDiscoveryType::none) {
+        std::filesystem::path new_manifest_path = args.json_name.stem();
+        if (!args.disable_name_increment) {
             new_manifest_path += "_";
             new_manifest_path += std::to_string(cur_icd_index);
         }
         new_manifest_path += ".json";
-        icds.back().manifest_path = folder.write_manifest(new_manifest_path, icd_details.icd_manifest.get_manifest_str());
+        icds.back().manifest_path = folder.write_manifest(new_manifest_path, manifest.get_manifest_str());
         icds.back().shimmed_manifest_path = icds.back().manifest_path;
-        switch (icd_details.discovery_type) {
+        switch (args.discovery_type) {
             case (ManifestDiscoveryType::generic):
 #if defined(WIN32)
                 platform_shim->add_manifest_to_registry(ManifestCategory::icd, icds.back().manifest_path);
@@ -424,14 +429,14 @@ TestICD& FrameworkEnvironment::add_icd(TestICDDetails icd_details) noexcept {
 #endif
                 break;
             case (ManifestDiscoveryType::env_var):
-                if (icd_details.is_dir) {
+                if (args.is_dir) {
                     env_var_vk_icd_filenames.add_to_list(folder.location());
                 } else {
                     env_var_vk_icd_filenames.add_to_list(folder.location() / new_manifest_path);
                 }
                 break;
             case (ManifestDiscoveryType::add_env_var):
-                if (icd_details.is_dir) {
+                if (args.is_dir) {
                     add_env_var_vk_icd_filenames.add_to_list(folder.location());
                 } else {
                     add_env_var_vk_icd_filenames.add_to_list(folder.location() / new_manifest_path);

tests/framework/test_environment.h

@@ -436,15 +436,10 @@ struct TestBinaryHandle {
 using TestICDHandle = TestBinaryHandle<TestICD, GetTestICDFunc, GetNewTestICDFunc>;
 using TestLayerHandle = TestBinaryHandle<TestLayer, GetTestLayerFunc, GetNewTestLayerFunc>;
 
-struct TestICDDetails {
-    TestICDDetails(ManifestICD icd_manifest) noexcept : icd_manifest(icd_manifest) {}
-    TestICDDetails(std::filesystem::path icd_binary_path, uint32_t api_version = VK_API_VERSION_1_0) noexcept {
-        icd_manifest.set_lib_path(icd_binary_path).set_api_version(api_version);
-    }
-    BUILDER_VALUE(ManifestICD, icd_manifest);
-    BUILDER_VALUE_WITH_DEFAULT(std::filesystem::path, json_name, "test_icd");
+struct ManifestOptions {
+    BUILDER_VALUE(std::filesystem::path, json_name);
     // Uses the json_name without modification - default is to append _1 in the json file to distinguish drivers
-    BUILDER_VALUE(bool, disable_icd_inc);
+    BUILDER_VALUE(bool, disable_name_increment);
     BUILDER_VALUE_WITH_DEFAULT(ManifestDiscoveryType, discovery_type, ManifestDiscoveryType::generic);
     BUILDER_VALUE(bool, is_fake);
     // If discovery type is env-var, is_dir controls whether to use the path to the file or folder the manifest is in
@@ -487,7 +482,9 @@ struct FrameworkEnvironment {
     FrameworkEnvironment(const FrameworkEnvironment&) = delete;
     FrameworkEnvironment& operator=(const FrameworkEnvironment&) = delete;
 
-    TestICD& add_icd(TestICDDetails icd_details) noexcept;
+    TestICD& add_icd(std::filesystem::path const& path, ManifestOptions args = ManifestOptions{},
+                     ManifestICD manifest = ManifestICD{}) noexcept;
+
     void add_implicit_layer(ManifestLayer layer_manifest, const std::string& json_name) noexcept;
     void add_implicit_layer(TestLayerDetails layer_details) noexcept;
     void add_explicit_layer(ManifestLayer layer_manifest, const std::string& json_name) noexcept;

tests/framework/util/manifest_builders.h

@@ -50,7 +50,7 @@ struct ManifestVersion {
 // ManifestICD builder
 struct ManifestICD {
     BUILDER_VALUE(ManifestVersion, file_format_version)
-    BUILDER_VALUE(uint32_t, api_version)
+    BUILDER_VALUE_WITH_DEFAULT(uint32_t, api_version, VK_API_VERSION_1_0)
     BUILDER_VALUE(std::filesystem::path, lib_path)
     BUILDER_VALUE(bool, is_portability_driver)
     BUILDER_VALUE(std::string, library_arch)

tests/loader_alloc_callback_tests.cpp

@@ -25,9 +25,9 @@
  * Author: Charles Giessen <[email protected]>
  */
 
+#include "manifest_builders.h"
 #include "test_environment.h"
 
-#include <fstream>
 #include <mutex>
 
 struct MemoryTrackerSettings {
@@ -184,7 +184,7 @@ class MemoryTracker {
 // a CreateInstance/DestroyInstance call pair.
 TEST(Allocation, Instance) {
     FrameworkEnvironment env{};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2));
+    env.add_icd(TEST_ICD_PATH_VERSION_2);
 
     MemoryTracker tracker;
     {
@@ -198,7 +198,7 @@ TEST(Allocation, Instance) {
 // a CreateInstance/DestroyInstance call pair with a call to GetInstanceProcAddr.
 TEST(Allocation, GetInstanceProcAddr) {
     FrameworkEnvironment env{};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2));
+    env.add_icd(TEST_ICD_PATH_VERSION_2);
 
     MemoryTracker tracker;
     {
@@ -216,7 +216,7 @@ TEST(Allocation, GetInstanceProcAddr) {
 // a vkEnumeratePhysicalDevices call pair.
 TEST(Allocation, EnumeratePhysicalDevices) {
     FrameworkEnvironment env{};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2)).add_physical_device("physical_device_0");
+    env.add_icd(TEST_ICD_PATH_VERSION_2).add_physical_device("physical_device_0");
 
     MemoryTracker tracker;
     {
@@ -239,7 +239,7 @@ TEST(Allocation, EnumeratePhysicalDevices) {
 // allocators used on both the instance and device.
 TEST(Allocation, InstanceAndDevice) {
     FrameworkEnvironment env{};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2))
+    env.add_icd(TEST_ICD_PATH_VERSION_2)
         .add_physical_device(PhysicalDevice{"physical_device_0"}
                                  .add_queue_family_properties({{VK_QUEUE_GRAPHICS_BIT, 1, 0, {1, 1, 1}}, false})
                                  .finish());
@@ -288,7 +288,7 @@ TEST(Allocation, InstanceAndDevice) {
 // allocators used on only the instance and not the device.
 TEST(Allocation, InstanceButNotDevice) {
     FrameworkEnvironment env{};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2))
+    env.add_icd(TEST_ICD_PATH_VERSION_2)
         .add_physical_device(PhysicalDevice{"physical_device_0"}
                                  .add_queue_family_properties({{VK_QUEUE_GRAPHICS_BIT, 1, 0, {1, 1, 1}}, false})
                                  .finish());
@@ -337,7 +337,7 @@ TEST(Allocation, InstanceButNotDevice) {
 // allocators used on only the device and not the instance.
 TEST(Allocation, DeviceButNotInstance) {
     FrameworkEnvironment env{};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2))
+    env.add_icd(TEST_ICD_PATH_VERSION_2)
         .add_physical_device(PhysicalDevice{"physical_device_0"}
                                  .add_queue_family_properties({{VK_QUEUE_GRAPHICS_BIT, 1, 0, {1, 1, 1}}, false})
                                  .finish());
@@ -394,7 +394,7 @@ TEST(Allocation, DeviceButNotInstance) {
 // one of the out-of-memory conditions trigger.
 TEST(Allocation, CreateInstanceIntentionalAllocFail) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2));
+    env.add_icd(TEST_ICD_PATH_VERSION_2);
 
     const char* layer_name = "VK_LAYER_implicit";
     env.add_implicit_layer(ManifestLayer{}.add_layer(ManifestLayer::LayerDescription{}
@@ -424,7 +424,7 @@ TEST(Allocation, CreateInstanceIntentionalAllocFail) {
 // one of the out-of-memory conditions trigger and there are invalid jsons in the same folder
 TEST(Allocation, CreateInstanceIntentionalAllocFailInvalidManifests) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2));
+    env.add_icd(TEST_ICD_PATH_VERSION_2);
 
     std::vector<std::string> invalid_jsons;
     invalid_jsons.push_back(",");
@@ -472,7 +472,7 @@ TEST(Allocation, CreateInstanceIntentionalAllocFailInvalidManifests) {
 // one of the out-of-memory conditions trigger.
 TEST(Allocation, CreateSurfaceIntentionalAllocFail) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2)).setup_WSI();
+    env.add_icd(TEST_ICD_PATH_VERSION_2).setup_WSI();
 
     const char* layer_name = "VK_LAYER_implicit";
     env.add_implicit_layer(ManifestLayer{}.add_layer(ManifestLayer::LayerDescription{}
@@ -517,7 +517,7 @@ TEST(Allocation, CreateSurfaceIntentionalAllocFail) {
 // one of the out-of-memory conditions trigger.
 TEST(Allocation, CreateInstanceIntentionalAllocFailWithSettingsFilePresent) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2));
+    env.add_icd(TEST_ICD_PATH_VERSION_2);
 
     const char* layer_name = "VK_LAYER_implicit";
     env.add_implicit_layer(ManifestLayer{}.add_layer(ManifestLayer::LayerDescription{}
@@ -554,7 +554,7 @@ TEST(Allocation, CreateInstanceIntentionalAllocFailWithSettingsFilePresent) {
 // one of the out-of-memory conditions trigger.
 TEST(Allocation, CreateSurfaceIntentionalAllocFailWithSettingsFilePresent) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2)).setup_WSI();
+    env.add_icd(TEST_ICD_PATH_VERSION_2).setup_WSI();
 
     const char* layer_name = "VK_LAYER_implicit";
     env.add_implicit_layer(ManifestLayer{}.add_layer(ManifestLayer::LayerDescription{}
@@ -605,7 +605,7 @@ TEST(Allocation, CreateSurfaceIntentionalAllocFailWithSettingsFilePresent) {
 // one of the out-of-memory conditions trigger.
 TEST(Allocation, DriverEnvVarIntentionalAllocFail) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails{TEST_ICD_PATH_VERSION_2}.set_discovery_type(ManifestDiscoveryType::env_var));
+    env.add_icd(TEST_ICD_PATH_VERSION_2, ManifestOptions{}.set_discovery_type(ManifestDiscoveryType::env_var));
 
     const char* layer_name = "VK_LAYER_implicit";
     env.add_implicit_layer(ManifestLayer{}.add_layer(ManifestLayer::LayerDescription{}
@@ -639,7 +639,7 @@ TEST(Allocation, DriverEnvVarIntentionalAllocFail) {
 // may fail.
 TEST(Allocation, CreateDeviceIntentionalAllocFail) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2))
+    env.add_icd(TEST_ICD_PATH_VERSION_2)
         .add_physical_device(PhysicalDevice{"physical_device_0"}
                                  .add_queue_family_properties({{VK_QUEUE_GRAPHICS_BIT, 1, 0, {1, 1, 1}}, false})
                                  .finish())
@@ -709,19 +709,18 @@ TEST(Allocation, CreateInstanceDeviceIntentionalAllocFail) {
     uint32_t num_physical_devices = 4;
     uint32_t num_implicit_layers = 3;
     for (uint32_t i = 0; i < num_physical_devices; i++) {
-        env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2)
-                        .icd_manifest.set_is_portability_driver(false)
-                        .set_library_arch(sizeof(void*) == 8 ? "64" : "32"))
+        env.add_icd(TEST_ICD_PATH_VERSION_2, {},
+                    ManifestICD{}.set_is_portability_driver(false).set_library_arch(sizeof(void*) == 8 ? "64" : "32"))
             .set_icd_api_version(VK_API_VERSION_1_1)
             .add_instance_extension("VK_KHR_get_physical_device_properties2")
             .add_and_get_physical_device("physical_device_0")
             .add_queue_family_properties({{VK_QUEUE_GRAPHICS_BIT, 1, 0, {1, 1, 1}}, false})
             .add_extensions({"VK_EXT_one", "VK_EXT_two", "VK_EXT_three", "VK_EXT_four", "VK_EXT_five"});
     }
 
-    env.add_icd(TestICDDetails(CURRENT_PLATFORM_DUMMY_BINARY_WRONG_TYPE).set_is_fake(true));
+    env.add_icd(CURRENT_PLATFORM_DUMMY_BINARY_WRONG_TYPE, ManifestOptions{}.set_is_fake(true));
 
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_7).set_discovery_type(ManifestDiscoveryType::none));
+    env.add_icd(TEST_ICD_PATH_VERSION_7, ManifestOptions{}.set_discovery_type(ManifestDiscoveryType::none));
 
     VkDirectDriverLoadingInfoLUNARG ddl_info{};
     ddl_info.sType = VK_STRUCTURE_TYPE_DIRECT_DRIVER_LOADING_INFO_LUNARG;
@@ -827,8 +826,8 @@ TEST(Allocation, CreateInstanceDeviceIntentionalAllocFail) {
 // an incompatible driver exists
 TEST(TryLoadWrongBinaries, CreateInstanceIntentionalAllocFail) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2));
-    env.add_icd(TestICDDetails(CURRENT_PLATFORM_DUMMY_BINARY_WRONG_TYPE).set_is_fake(true));
+    env.add_icd(TEST_ICD_PATH_VERSION_2);
+    env.add_icd(CURRENT_PLATFORM_DUMMY_BINARY_WRONG_TYPE, ManifestOptions{}.set_is_fake(true));
 
     const char* layer_name = "VK_LAYER_implicit";
     env.add_implicit_layer(ManifestLayer{}.add_layer(ManifestLayer::LayerDescription{}
@@ -859,7 +858,7 @@ TEST(TryLoadWrongBinaries, CreateInstanceIntentionalAllocFail) {
 // leak memory if one of the out-of-memory conditions trigger.
 TEST(Allocation, EnumeratePhysicalDevicesIntentionalAllocFail) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2));
+    env.add_icd(TEST_ICD_PATH_VERSION_2);
 
     const char* layer_name = "VK_LAYER_implicit";
     env.add_implicit_layer(ManifestLayer{}.add_layer(ManifestLayer::LayerDescription{}
@@ -970,8 +969,8 @@ TEST(Allocation, EnumeratePhysicalDevicesIntentionalAllocFail) {
 // leak memory if one of the out-of-memory conditions trigger.
 TEST(Allocation, CreateInstanceDeviceWithDXGIDriverIntentionalAllocFail) {
     FrameworkEnvironment env{FrameworkSettings{}.set_log_filter("error,warn")};
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_6).set_discovery_type(ManifestDiscoveryType::null_dir));
-    env.add_icd(TestICDDetails(TEST_ICD_PATH_VERSION_2));
+    env.add_icd(TEST_ICD_PATH_VERSION_6, ManifestOptions{}.set_discovery_type(ManifestDiscoveryType::null_dir));
+    env.add_icd(TEST_ICD_PATH_VERSION_2);
 
     for (uint32_t i = 0; i < 2; i++) {
         auto& driver = env.get_test_icd(i);