u-boot/test
Tom Rini 845e10d165 tests: test_dfu.py: Add example udev rule for host_usb_dev_node
If one does not already have a rule to create a custom device node when
a given device enumerates it can be useful to have udev create a
bus path based node to the entry in /dev/bus/usb that was just
enumerated.  Given that DFU itself does not require a /dev entry it is a
good idea to provide a rule that will generate one.

Signed-off-by: Tom Rini <trini@konsulko.com>
2017-07-22 15:36:16 -04:00
..
dm dm: core: Add uclass_first/next_device_check() 2017-07-11 10:08:19 -06:00
env test: env: Add a test of the new regex behavior for attrs 2015-05-21 09:16:18 -04:00
fs fs-test.sh: Update expected results 2016-11-21 14:07:28 -05:00
image test-fit.py: Minor grammar/spelling/clarification tweaks 2017-03-20 18:04:41 -04:00
overlay libfdt: Bring in upstream stringlist functions 2016-10-13 13:54:10 -06:00
py tests: test_dfu.py: Add example udev rule for host_usb_dev_node 2017-07-22 15:36:16 -04:00
stdint test: Add a simple test to detected warnings with uint64_t, uintptr_t 2014-10-27 11:04:01 -04:00
trace trace: Improve the trace test number recognition 2016-02-26 08:53:10 -07:00
cmd_ut.c tests: Introduce DT overlay tests 2016-08-20 11:35:07 -04:00
command_ut.c hush: complete renaming CONFIG_SYS_HUSH_PARSER to CONFIG_HUSH_PARSER 2016-06-24 17:24:34 -04:00
common.sh test: Add a test for command repeat 2014-09-24 18:30:28 -04:00
compression.c Add support for LZ4 decompression algorithm 2015-10-11 17:12:10 -04:00
Kconfig tests: Introduce DT overlay tests 2016-08-20 11:35:07 -04:00
Makefile test: Add a test for snprintf() and the banner/version 2017-07-11 10:08:19 -06:00
print_ut.c test: Add a test for snprintf() and the banner/version 2017-07-11 10:08:19 -06:00
README tools/tbot: update README 2017-06-12 08:38:44 -04:00
run test: Update 'make test' to run more tests 2017-06-01 07:03:11 -06:00
time_ut.c test: dm: Move the time test over to the ut command 2015-05-21 09:16:17 -04:00
ut.c test: Record and silence console in tests 2015-11-19 20:27:51 -07:00

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:

    test/run

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


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.