mirror of https://github.com/lvgl/lvgl.git synced 2024-12-04 15:14:03 +08:00

History

Gabor Kiss-Vamosi c7b26a27b6 test(fs): fix typo, change rd -> r in fopen		2023-03-17 16:34:58 +01:00
..
makefile	ci: add LV_USE_DEV_VERSION to the makefile build	2023-02-23 09:50:14 +01:00
ref_imgs	ci(test): add unit test for lv_list (#4032 )	2023-03-04 17:02:08 +01:00
src	test(fs): fix typo, change rd -> r in fopen	2023-03-17 16:34:58 +01:00
unity	arch(driver): new driver architecture with new color format support	2023-02-20 20:50:58 +01:00
.gitignore	fix(fs): fix cached file read	2023-02-27 22:17:50 +01:00
CMakeLists.txt	arch(driver): new driver architecture with new color format support	2023-02-20 20:50:58 +01:00
config.yml	feat(test) first experiement with Unity test engine	2021-06-18 14:13:41 +02:00
main.py	test(main.py): add cli option to select test suite (#4023 )	2023-03-02 09:51:55 +01:00
README.md	ci(test): automatically create missing reference images for TEST_ASSERT_EQUAL_SCREENSHOT	2022-09-21 22:10:20 +02:00

README.md

Tests for LVGL

The tests in the folder can be run locally and automatically by GitHub CI.

Running locally

Requirements (Linux)

Install requirements by:

scripts/install-prerequisites.sh

Run test

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.

Running automatically

GitHub's CI automatically runs these tests on pushes and pull requests to master and releasev8.* branches.

Directory structure

src Source files of the tests
- test_cases The written tests,
- test_runners Generated automatically from the files in test_cases.
- other miscellaneous files and folders
ref_imgs - Reference images for screenshot compare
report - Coverage report. Generated if the report flag was passed to ./main.py
unity Source files of the test engine

Add new tests

Create new test file

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.

Asserts

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 the ref_imgs folder.
- If the reference image is not found it will be created automatically from the rendered screen.
- If the compare fails lvgl/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 call test_screenshot_error_show();.
TEST_ASSERT_EQUAL_COLOR(color1, color2) Compare two colors.