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
32 The test script supports either:
44 can use the Python `virtualenv` script to locally install more up-to-date
71 running the test script.
73 The test script will attach to U-Boot, execute all valid tests for the board,
123   not interpreted by the test script in any way, but rather is simply passed
126 - `--build` indicates that the test script should compile U-Boot itself
141 test.py script passes all command-line arguments directly to `pytest` for
185 This script provides access to the U-Boot console. The script's stdin/stdout
187 indefinitely, until killed. The test suite will run this script in parallel
190 This script may be implemented e.g. by exec()ing `cu`, `kermit`, `conmux`, etc.
193 you would likely spawn that simulator from this script. However, note that
194 `u-boot-test-reset` may be called multiple times per test script run, and must
205 suite calls this hook script for that purpose.
207 This script should perform the entire flashing process synchronously; the
208 script should only exit once flashing is complete, and a board reset will
211 It is conceivable that this script will do nothing. This might be useful in
219   required. If this feature is used, the `u-boot-test-reset` script should
224 hook script appropriately.
226 This script will typically be implemented by calling out to some SoC- or
231 Whenever the test suite needs to reset the target board, this script is
234 this script again to restore U-Boot to an operational state before running the
237 This script will likely be implemented by communicating with some form of
240 The semantics of this script require that when it is executed, U-Boot will
242 to flash, pulsing the board's reset signal is likely all this script need do.
243 However, in some scenarios, this script may perform other actions. For
262 to provide board-specific information to the test script. Any global value
273 machine running the test script.
277 board-specific and board-identity-specific information to the test script. Any
282 should set `$PYTHONPATH` prior to running the test script to allow these
312 then you would likely invoke the test script as follows:
322 If you want the test script to compile U-Boot for you too, then you likely
323 need to set `$CROSS_COMPILE` to allow this, and invoke the test script as