The tests in the folder can be run locally and automatically by GitHub CI.
Install requirements by:
scripts/install-prerequisites.sh
- Run all executable tests with
./tests/main.py test
. - Build all build-only tests with
./tests/main.py build
. - Clean prior test build, build all build-only tests,
run executable tests, and generate code coverage
report
./tests/main.py --clean --report build test
.
For full information on running tests run: ./tests/main.py --help
.
GitHub's CI automatically runs these tests on pushes and pull requests to master
and releasev8.*
branches.
src
Source files of the teststest_cases
The written tests,test_runners
Generated automatically from the files intest_cases
.- other miscellaneous files and folders
ref_imgs
- Reference images for screenshot comparereport
- Coverage report. Generated if thereport
flag was passed to./main.py
unity
Source files of the test engine
New test needs to be added into the src/test_cases
folder. The name of the files should look like test_<name>.c
. The basic skeleton of a test file copy _test_template.c
.
See the list of asserts here.
There are some custom, LVGL specific asserts:
TEST_ASSERT_EQUAL_SCREENSHOT("image1.png")
Render the active screen and compare its content with an image in theref_imgs
folder. If the compare failslvgl/test_screenshot_error.h
is created with the content of the frame buffer as an image. To see the that image#include "test_screenshot_error.h"
and calltest_screenshot_error_show();
.TEST_ASSERT_EQUAL_COLOR(color1, color2)
Compare two colors.
The reference images can be taken by copy-pasting the test code in to LVGL simulator and saving the screen. LVGL needs to
- 800x480 resolution
- 32 bit color depth
LV_USE_PERF_MONITOR
andLV_USE_MEM_MONITOR
disabled- use the default theme, with the default color (don't set a theme manually)