Tom Rini 9f9ecd3e4d Merge https://gitlab.denx.de/u-boot/custodians/u-boot-marvell преди 3 години
..
cmd 550a9e7902 cmd: Update the memory-search command преди 3 години
dm 4cf56ec07f pci: pci-uclass: Add multi entry support for memory regions преди 3 години
env f7ae49fc4f common: Drop log.h from common header преди 4 години
fs 84f0415201 Consistently use nproc for counting the CPUs преди 4 години
image 280fafff16 test: Update test-imagetools.sh to match new syntax преди 5 години
lib 5bba77e48b test: unit test for efi_dp_check_length() преди 3 години
log 3c21d7738a log: don't show function by default преди 3 години
optee f7ae49fc4f common: Drop log.h from common header преди 4 години
overlay f7ae49fc4f common: Drop log.h from common header преди 4 години
py 8ee3a24fdc Merge branch '2020-08-24-misc-improvements' преди 3 години
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 395041b2fd test: log functions with CONFIG_LOG=n преди 4 години
Makefile bdded2015c cmd: Add a memory-search command преди 3 години
README 499fde5c23 test: Add a 'make qcheck' target for quicker testing преди 5 години
bloblist.c 0914011310 command: Remove the cmd_tbl_t typedef преди 4 години
cmd_ut.c 550a9e7902 cmd: Update the memory-search command преди 3 години
command_ut.c f7ae49fc4f common: Drop log.h from common header преди 4 години
common.sh 84f0415201 Consistently use nproc for counting the CPUs преди 4 години
compression.c f91f366bd5 test: Use ut_asserteq_mem() where possible преди 4 години
nokia_rx51_test.sh 6cfd09d4ed Nokia RX-51: Add automated test for running RX-51 build in qemu преди 4 години
print_ut.c f7ae49fc4f common: Drop log.h from common header преди 4 години
run 6bb74de7ed patman: Add a 'test' subcommand преди 3 години
str_ut.c 0914011310 command: Remove the cmd_tbl_t typedef преди 4 години
time_ut.c c05ed00afb common: Drop linux/delay.h from common header преди 4 години
unicode_ut.c f91f366bd5 test: Use ut_asserteq_mem() where possible преди 4 години
ut.c 33d7edfd5f test: Add a way to check part of a console line or skip it преди 3 години

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.