name: test-vulkan-extension
description: Add a test case for a particular Vulkan extension
metadata:
short-description: Generate a new Vulkan extension test case
- Check that we were told which Vulkan extension we are supposed to check. If this was not specified, ask.
- Check that we were told which test or common code to use as a starting point or if we should make a test
from scratch. If this was not specified, ask.
- Download the extension text from
https://docs.vulkan.org/refpages/latest/refpages/source/<extension name>.html and read it.
- If you cannot download the extension text due to sandbox permission issues, ask user to add the following to their
~/.codex/config.toml:
[network]
enable_domain_allowlist = true
domain_allowlist = [
"docs.vulkan.org",
"github.com",
"api.github.com"
]
- Check that we have a test for each new Vulkan command and struct defined in the given extension, if possible. If there are
features gated by enable flags, make sure we only run these gates features when they are supported. Sometimes creating
a new test is the right choice, sometimes we can just insert usage into existing tests.
- If we can verify some generated output with
vkAssertBuffer, that's is good.
- Try to use
test_set_name and test_marker_mention with any new object handles so that we can test this works as well.
- If the test generates a visual image, consider adding an
-i option for user to dump the image to disk for verification.
- Run
make -j 6 in the build directory. Fix any build issues.
- Run
./<test name> -v --cpu from the build directory and fix any validation issues.
- Run the test with
VK_INSTANCE_LAYERS=VK_LAYER_LUNARG_api_dump environment variable set to verify that the new commands
we wanted to test actually got executed.
- Make note of any commands and structs you could not add to the test, things you find that did not make sense, and suggest the
best improvement that could be made to make the test even better.
- Make sure usage detection of this extension is in
src/usagetracker/vulkan_feature_detect.cpp and
src/usagetracker/vulkan_feature_detect.h. You can use the skill
$vulkan-extension-detection to add this if missing.
By