In order for the script to work you will need to install and add to your Path:
Python 3.x
imagemagick
git
cmake
- (Optional)
adb
if you plan to use Android
You will also need to have built the Vulkan Best Practices in 64 bit, with the CMake flag VKB_BUILD_SAMPLES
, VKB_BUILD_TESTS
, and VKB_SYMLINKS
set to ON
, and in addition to this install a working .apk
onto a device if you plan on testing on Android.
Before you begin a system test on Android, ensure that the device is held in landscape, and there isn't an instance of Vulkan Best Practice running already.
- From the root of the project:
cd tests/system_test
- To run:
python system_test.py -B <build dir> -C <Debug|Release>
2.1. e.g.python system_test.py -Bbuild/windows -CRelease
(build path is relative to root)
2.2. To target just testing on desktop, add a-D
flag, or to target just Android, an-A
flag. If no flag is specified it will run for both.
2.3. To run a specific sub test(s), use the-S
flag (e.g.python system_test.py ... -S sponza bonza
runs sponza and bonza)
We currently support FHD resolutions (2280x1080), if testing on another device or resolution the test may fail.
There is a test for the generate_sample
script, to ensure that it generates a sample that builds within the project.
cd tests/generate_sample
python generate_sample_test.py
It will print out the result of the test