Ramon Fried f2a55acfcf test: pci_ep: add basic pci_ep tests преди 5 години
..
dm f2a55acfcf test: pci_ep: add basic pci_ep tests преди 4 години
env 0efe2b8f9e test: env: Enable env unit tests by default преди 5 години
fs 734e207c5e fs-test.sh: Update to use 'host' not 'sb' преди 5 години
image 280fafff16 test: Update test-imagetools.sh to match new syntax преди 5 години
lib 8334431651 test: call hexdump tests via `ut lib` преди 5 години
log cdd140af5c log: Add helpers for common log levels преди 5 години
overlay 5766a27176 tests: enable DT overlay tests by default преди 5 години
py 0b1da53e53 test/py: not all boards support UEFI runtime reset преди 4 години
stdint dee37fc99d Remove <inttypes.h> includes and PRI* usages in printf() entirely преди 5 години
trace 83d290c56f SPDX: Convert all of our single license tags to Linux Kernel style преди 6 години
Kconfig 2dd0111adc test: provide unit test for memory functions преди 5 години
Makefile 919e7a8fb6 test: Add a simple test for bloblist преди 5 години
README 499fde5c23 test: Add a 'make qcheck' target for quicker testing преди 5 години
bloblist.c 919e7a8fb6 test: Add a simple test for bloblist преди 5 години
cmd_ut.c 2dd0111adc test: provide unit test for memory functions преди 5 години
command_ut.c 83d290c56f SPDX: Convert all of our single license tags to Linux Kernel style преди 6 години
common.sh 129acd4c75 test: Add a test for command repeat преди 9 години
compression.c 83d290c56f SPDX: Convert all of our single license tags to Linux Kernel style преди 6 години
print_ut.c 3bad256f5b lib/vsprintf: allow printing upper case GUIDs преди 5 години
run 499fde5c23 test: Add a 'make qcheck' target for quicker testing преди 5 години
time_ut.c 83d290c56f SPDX: Convert all of our single license tags to Linux Kernel style преди 6 години
unicode_ut.c bc19681acf test: adjust names of Unicode test functions преди 5 години
ut.c 83d290c56f SPDX: Convert all of our single license tags to Linux Kernel style преди 6 години

README

Testing in U-Boot
=================

U-Boot has a large amount of code. This file describes how this code is
tested and what tests you should write when adding a new feature.


Running tests
-------------

To run most tests on sandbox, type this:

make check

in the U-Boot directory. Note that only the pytest suite is run using this
command.

Some tests take ages to run. To run just the quick ones, type this:

make qcheck


Sandbox
-------
U-Boot can be built as a user-space application (e.g. for Linux). This
allows test to be executed without needing target hardware. The 'sandbox'
target provides this feature and it is widely used in tests.


Pytest Suite
------------

Many tests are available using the pytest suite, in test/py. This can run
either on sandbox or on real hardware. It relies on the U-Boot console to
inject test commands and check the result. It is slower to run than C code,
but provides the ability to unify lots of tests and summarise their results.

You can run the tests on sandbox with:

./test/py/test.py --bd sandbox --build

This will produce HTML output in build-sandbox/test-log.html

See test/py/README.md for more information about the pytest suite.


tbot
----

Tbot provides a way to execute tests on target hardware. It is intended for
trying out both U-Boot and Linux (and potentially other software) on a
number of boards automatically. It can be used to create a continuous test
environment. See http://www.tbot.tools for more information.


Ad-hoc tests
------------

There are several ad-hoc tests which run outside the pytest environment:

test/fs - File system test (shell script)
test/image - FIT and legacy image tests (shell script and Python)
test/stdint - A test that stdint.h can be used in U-Boot (shell script)
trace - Test for the tracing feature (shell script)

TODO: Move these into pytest.


When to write tests
-------------------

If you add code to U-Boot without a test you are taking a risk. Even if you
perform thorough manual testing at the time of submission, it may break when
future changes are made to U-Boot. It may even break when applied to mainline,
if other changes interact with it. A good mindset is that untested code
probably doesn't work and should be deleted.

You can assume that the Pytest suite will be run before patches are accepted
to mainline, so this provides protection against future breakage.

On the other hand there is quite a bit of code that is not covered with tests,
or is covered sparingly. So here are some suggestions:

- If you are adding a new uclass, add a sandbox driver and a test that uses it
- If you are modifying code covered by an existing test, add a new test case
to cover your changes
- If the code you are modifying has not tests, consider writing one. Even a
very basic test is useful, and may be picked up and enhanced by others. It
is much easier to add onto a test - writing a new large test can seem
daunting to most contributors.


Future work
-----------

Converting existing shell scripts into pytest tests.