class TestWithVkValidationLayer

Default Googletest fixture for checking Vulkan validation errors, warnings and performance

warnings.

Usage:

1) Tests need to use this as its test fixture:

using TestSuiteName = escher::test::TestWithVkValidationLayer;

VK_TEST_F(TestSuiteName, TestCaseName) {

... // Test body

}

or derive directly from this class:

class DerivedTest: public escher::test::TestWithVkValidationLayer {

... // Class definition

};

VK_TEST_F(DerivedTest, TestCaseName) {

... // Test body

}

Note that if |SetUp()| is overridden, |TestWithVkValidationlayer::SetUp()| should be called in

its beginning; if |TearDown()| is overridden, |TestWithVkValidationlayer::TearDown()| should

be called in the end. See the documentation of |SetUp()| and |TearDown()| below for details.

2) For all |TestWithVkValidationLayer| tests, after the test ends, it will check if there are

Vulkan validation debug reports. The test will fail if there is any Vulkan validation error /

warning / performance warning.

To suppress the after-test validation check, run the following macro in the end of the test

body:

REMOVE_VK_VALIDATION_DEBUG_UTILS_MESSAGES()

or macro with specified message flags:

REMOVE_VK_VALIDATION_ERRORS()

REMOVE_VK_VALIDATION_WARNINGS()

REMOVE_VK_VALIDATION_PERFORMANCE_WARNINGS()

All the above macros can be only used when test fixture has

|vk_debug_utils_message_collector()|, like this class and classes derived from this class.

3) Besides, one can also use the following macros to check Vulkan validation messages:

ASSERT_NO_VULKAN_VALIDATION_[ERROR-TYPE]()

EXPECT_NO_VULKAN_VALIDATION_[ERROR-TYPE]()

ASSERT_VULKAN_VALIDATION_[ERROR-TYPE]_[PRED](MAXIMUM_ERRORS)

EXPECT_VULKAN_VALIDATION_[ERROR-TYPE]_[PRED](MAXIMUM_ERRORS)

where

[ERROR-TYPE] := {ERRORS, WARNINGS, PERFORMANCE_WARNINGS},

[PRED] := {LE, LT, GE, GT, EQ, NE}.

There are also macros ASSERT_VULKAN_VALIDATION_OK() and EXPECT_VULKAN_VALIDATION_OK()

checking if there is any message belonging to errors, warnings or performance warnings.

Example:

using TestSuite = escher::test::TestWithVkValidationLayer;

VK_TEST_F(TestSuite, TestName) {

auto escher = escher::test::GetEscher();

... // some Vulkan operations

ASSERT_NO_VULKAN_VALIDATION_ERRORS()

<

<

"Optional error message";

... // some Vulkan operations

ASSERT_NO_VULKAN_VALIDATION_WARNINGS(1);

}

All the above macros can be only used when test fixture has

|vk_debug_utils_message_collector()|, like this class and classes derived from this class.

4) Since this class has a |VkDebugUtilsMessengerCallbackRegistry| instance, it can also support

optional

debug report callback functions by deriving this class and setting up extra callback

functions in its constructor.