Skip to content

Latest commit

 

History

History
 
 

tests

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
device_profiles
device_profiles
 
 
layers
layers
 
 
positive
positive
 
 
CMakeLists.txt
CMakeLists.txt
 
 
README.md
README.md
 
 
icd-spv.h
icd-spv.h
 
 
layer_validation_tests.cpp
layer_validation_tests.cpp
 
 
layer_validation_tests.h
layer_validation_tests.h
 
 
test_common.h
test_common.h
 
 
vk_layer_validation_tests.vcxproj.user
vk_layer_validation_tests.vcxproj.user
 
 
vkerrormonitor.cpp
vkerrormonitor.cpp
 
 
vkerrormonitor.h
vkerrormonitor.h
 
 
vklayertests_amd_best_practices.cpp
vklayertests_amd_best_practices.cpp
 
 
vklayertests_android_hardware_buffer.cpp
vklayertests_android_hardware_buffer.cpp
 
 
vklayertests_arm_best_practices.cpp
vklayertests_arm_best_practices.cpp
 
 
vklayertests_best_practices.cpp
vklayertests_best_practices.cpp
 
 
vklayertests_buffer_image_memory_sampler.cpp
vklayertests_buffer_image_memory_sampler.cpp
 
 
vklayertests_command.cpp
vklayertests_command.cpp
 
 
vklayertests_debug_printf.cpp
vklayertests_debug_printf.cpp
 
 
vklayertests_descriptor_renderpass_framebuffer.cpp
vklayertests_descriptor_renderpass_framebuffer.cpp
 
 
vklayertests_dynamic_rendering.cpp
vklayertests_dynamic_rendering.cpp
 
 
vklayertests_gpu.cpp
vklayertests_gpu.cpp
 
 
vklayertests_graphics_library.cpp
vklayertests_graphics_library.cpp
 
 
vklayertests_imageless_framebuffer.cpp
vklayertests_imageless_framebuffer.cpp
 
 
vklayertests_instanceless.cpp
vklayertests_instanceless.cpp
 
 
vklayertests_nvidia_best_practices.cpp
vklayertests_nvidia_best_practices.cpp
 
 
vklayertests_others.cpp
vklayertests_others.cpp
 
 
vklayertests_pipeline_shader.cpp
vklayertests_pipeline_shader.cpp
 
 
vklayertests_portability_subset.cpp
vklayertests_portability_subset.cpp
 
 
vklayertests_ray_tracing.cpp
vklayertests_ray_tracing.cpp
 
 
vklayertests_ray_tracing_gpu.cpp
vklayertests_ray_tracing_gpu.cpp
 
 
vklayertests_ray_tracing_pipeline.cpp
vklayertests_ray_tracing_pipeline.cpp
 
 
vklayertests_viewport_inheritance.cpp
vklayertests_viewport_inheritance.cpp
 
 
vklayertests_wsi.cpp
vklayertests_wsi.cpp
 
 
vkrenderframework.cpp
vkrenderframework.cpp
 
 
vkrenderframework.h
vkrenderframework.h
 
 
vksyncvaltests.cpp
vksyncvaltests.cpp
 
 
vktestbinding.cpp
vktestbinding.cpp
 
 
vktestbinding.h
vktestbinding.h
 
 
vktestframework.cpp
vktestframework.cpp
 
 
vktestframework.h
vktestframework.h
 
 
vktestframeworkandroid.cpp
vktestframeworkandroid.cpp
 
 
vktestframeworkandroid.h
vktestframeworkandroid.h
 
 

README.md

Validation Layers Tests

The Validation Layers use Google Test (gtest) for testing the Validation Layers. This helps make sure all new changes are correct and prevent regressions.

The following is information how to setup and run the tests. There is seperate documentation for creating tests.

Building the tests

Make sure -DBUILD_TESTS was passed into the CMake command when generating the project

Different Categories of tests

The tests are grouped into different categories. Some of the main test categories are:

Running Test on Linux

IMPORTANT Make sure you have the correct VK_LAYER_PATH set on Linux

export VK_LAYER_PATH=/path/to/Vulkan-ValidationLayers/build/layers/

To run the tests

cd build

# Run all the test
./tests/vk_layer_validation_tests

# Run with certain VkPhysicalDevice
# see --help for more options
./tests/vk_layer_validation_tests --device-index 1

# Run a single test
./tests/vk_layer_validation_tests --gtest_filter=VkLayerTest.BufferExtents

# Run a multiple tests with a patter
./tests/vk_layer_validation_tests --gtest_filter=*Buffer*

Running Test on Android

cd build-android

# Optional
adb uninstall com.example.VulkanLayerValidationTests

adb install -r bin/VulkanLayerValidationTests.apk

# Runs all test
adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity

# Run test with gtest_filter
adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.VulkanLayerValidationTests/android.app.NativeActivity --es args --gtest_filter="*AndroidHardwareBuffer*"

Alternatively, you can use the test_APK script to install and run the layer validation tests:

test_APK.sh -s <serial number> -p <plaform name> -f <gtest_filter>

To view to logging while running in a separate terminal run

adb logcat -c && adb logcat *:S VulkanLayerValidationTests

Or the files can be pulled off the device with

adb shell cat /sdcard/Android/data/com.example.VulkanLayerValidationTests/files/out.txt
adb shell cat /sdcard/Android/data/com.example.VulkanLayerValidationTests/files/err.txt

Running Test on MacOS

Clone and build the MoltenVK repository.

You will have to direct the loader from Vulkan-Loader to the MoltenVK ICD:

export VK_ICD_FILENAMES=<path to MoltenVK repository>/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json

Running Tests on MockICD and Profiles layer

To allow a much higher coverage of testing the Validation Layers a test writer can use the Profile layer. More details here, but the main idea is the layer intercepts the Physical Device queries allowing testing of much more device properties. The Mock ICD is a "null driver" that is used to handle the Vulkan calls as the Validation Layers mostly only care about input "input" of the driver. If your tests relies on the "output" of the driver (such that a driver/implementation is correctly doing what it should do with valid input), then it might be worth looking into the Vulkan CTS instead.

The Profile Layer can be found in the Vulkan SDK, otherwise, they will need to be cloned from Vulkan Profiles. The MockICD can be built from source in Vulkan-Tools

NOTE: While using the MockICD and Profiles layer the test will not be able to use Device Profiles API (VK_LAYER_LUNARG_device_profile_api) at the same time.

  • If a feature is needed, it can be adjusted in the profile JSON
  • Allowing both adds complexity due to the order the layers must be in, while adding little over value to test coverage

Here is an example of setting up and running the Profile layer with MockICD on a Linux environment

export VULKAN_SDK=/path/to/vulkansdk
export VVL=/path/to/Vulkan-ValidationLayers

# Add built Vulkan Validation Layers... remember it was Rule #1
export VK_LAYER_PATH=$VVL/build/layers/

# This step can be skipped if the Vulkan SDK is properly installed
# Add path for Profile Layer
export VK_LAYER_PATH=$VK_LAYER_PATH:$VULKAN_SDK/etc/vulkan/explicit_layer.d/
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$VULKAN_SDK/lib/

# Set MockICD to be driver
export VK_ICD_FILENAMES=/path/to/Vulkan-Tools/build/icd/VkICD_mock_icd.json
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/Vulkan-Tools/build/icd/

# Set Layers, the order here is VERY IMPORTANT otherwise the test will see the
# profile layer but the layer won't see it and have a different value
export VK_INSTANCE_LAYERS=VK_LAYER_KHRONOS_validation:VK_LAYER_KHRONOS_profiles

# Set the device profile to a valid json file
#    These are generated from https://github.com/KhronosGroup/Vulkan-Profiles
#    Also can found on https://vulkan.gpuinfo.org/ and downloaded from any device
# A set of profiles for CI are in the tests/device_profiles folder
export VK_KHRONOS_PROFILES_PROFILE_FILE=$VVL/tests/device_profiles/profile.json

# Expose all the parts of the profile layer
export VK_KHRONOS_PROFILES_SIMULATE_CAPABILITIES=SIMULATE_API_VERSION_BIT,SIMULATE_FEATURES_BIT,SIMULATE_PROPERTIES_BIT,SIMULATE_EXTENSIONS_BIT,SIMULATE_FORMATS_BIT

# MockICD exposes VK_KHR_portability_subset but most tests are not testing for it
export VK_KHRONOS_PROFILES_EMULATE_PORTABILITY=false

# By default the Profile Layer logs warnings that mostly likely won't be useful for
# the usecase the Validation Layers tests are using it for
export VK_KHRONOS_PROFILES_DEBUG_REPORTS=DEBUG_REPORT_ERROR_BIT

# Running tests just as normal
$VVL/build/tests/vk_layer_validation_tests --gtest_filter=TestName