test/py/README.md

6 console interface. A single top-level script exists to execute or attach to the
7 U-Boot console, run the entire script of tests against it, and summarize the
10 - Testing is performed in the same way a user or script would interact with
38 The test script supports either:
50 can use the Python `virtualenv` script to locally install more up-to-date
77 running the test script.
79 The test script will attach to U-Boot, execute all valid tests for the board,
129   not interpreted by the test script in any way, but rather is simply passed
132 - `--build` indicates that the test script should compile U-Boot itself
147 test.py script passes all command-line arguments directly to `pytest` for
191 This script provides access to the U-Boot console. The script's stdin/stdout
193 indefinitely, until killed. The test suite will run this script in parallel
196 This script may be implemented e.g. by exec()ing `cu`, `kermit`, `conmux`, etc.
199 you would likely spawn that simulator from this script. However, note that
200 `u-boot-test-reset` may be called multiple times per test script run, and must
211 suite calls this hook script for that purpose.
213 This script should perform the entire flashing process synchronously; the
214 script should only exit once flashing is complete, and a board reset will
217 It is conceivable that this script will do nothing. This might be useful in
225   required. If this feature is used, the `u-boot-test-reset` script should
230 hook script appropriately.
232 This script will typically be implemented by calling out to some SoC- or
237 Whenever the test suite needs to reset the target board, this script is
240 this script again to restore U-Boot to an operational state before running the
243 This script will likely be implemented by communicating with some form of
246 The semantics of this script require that when it is executed, U-Boot will
248 to flash, pulsing the board's reset signal is likely all this script need do.
249 However, in some scenarios, this script may perform other actions. For
268 to provide board-specific information to the test script. Any global value
279 machine running the test script.
283 board-specific and board-identity-specific information to the test script. Any
288 should set `$PYTHONPATH` prior to running the test script to allow these
318 then you would likely invoke the test script as follows:
328 If you want the test script to compile U-Boot for you too, then you likely
329 need to set `$CROSS_COMPILE` to allow this, and invoke the test script as