Tom Rini 1e6d9f515d Merge tag 'u-boot-amlogic-20200511' of https://gitlab.denx.de/u-boot/custodians/u-boot-amlogic 4 jaren geleden
..
dm 1e6d9f515d Merge tag 'u-boot-amlogic-20200511' of https://gitlab.denx.de/u-boot/custodians/u-boot-amlogic 4 jaren geleden
env 4ad4edfe77 cmd_ut: add a parameter prefix to the function cmd_ut_category 4 jaren geleden
fs 84f0415201 Consistently use nproc for counting the CPUs 4 jaren geleden
image 280fafff16 test: Update test-imagetools.sh to match new syntax 5 jaren geleden
lib e3f5c9cb0f lib/crypto, efi_loader: move some headers to include/crypto 4 jaren geleden
log be51c3ca08 test: fix naming of test functions in the log test suite 4 jaren geleden
optee 4ad4edfe77 cmd_ut: add a parameter prefix to the function cmd_ut_category 4 jaren geleden
overlay 4ad4edfe77 cmd_ut: add a parameter prefix to the function cmd_ut_category 4 jaren geleden
py d0ba026bd2 test: describe naming conventions for macro UNIT_TEST 4 jaren geleden
stdint dee37fc99d Remove <inttypes.h> includes and PRI* usages in printf() entirely 5 jaren geleden
trace 83d290c56f SPDX: Convert all of our single license tags to Linux Kernel style 6 jaren geleden
Kconfig 395041b2fd test: log functions with CONFIG_LOG=n 4 jaren geleden
Makefile 4f04d54981 test: Add the beginnings of some string tests 4 jaren geleden
README 499fde5c23 test: Add a 'make qcheck' target for quicker testing 5 jaren geleden
bloblist.c b83994dec7 bloblist: Zero records when adding 4 jaren geleden
cmd_ut.c 4f04d54981 test: Add the beginnings of some string tests 4 jaren geleden
command_ut.c 288b29e44d common: Move command functions out of common.h 4 jaren geleden
common.sh 84f0415201 Consistently use nproc for counting the CPUs 4 jaren geleden
compression.c 6cc8e545b7 test: typo decompression 4 jaren geleden
print_ut.c 3bad256f5b lib/vsprintf: allow printing upper case GUIDs 5 jaren geleden
run 76160801b0 Add a 'make tcheck' option to test tools 4 jaren geleden
str_ut.c fdc79a6b12 lib: Add a function to convert a string to upper case 4 jaren geleden
time_ut.c 1045315df0 common: Move get_ticks() function out of common.h 4 jaren geleden
unicode_ut.c efe3b5c8df test: unit test for u16_strsize() 4 jaren geleden
ut.c 400175b0a7 test: Add a way to check each line of console output 4 jaren geleden

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.