[v2,4/4] testsuite: improve documentation for running Python unittests

Message ID 20261026143132.1067398-4-clara.kowalsky@siemens.com
State New
Headers show
Series [v2,1/4] testsuite: fix run_privileged_cmd in image account extension unit test | expand

Commit Message

Clara Kowalsky Oct. 26, 2026, 2:31 p.m. UTC
Update the command for running unittests and fix some typos.

Signed-off-by: Clara Kowalsky <clara.kowalsky@siemens.com>
---
 testsuite/unittests/README.md | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

Patch

diff --git a/testsuite/unittests/README.md b/testsuite/unittests/README.md
index 75a3bb01..22e6b6d1 100644
--- a/testsuite/unittests/README.md
+++ b/testsuite/unittests/README.md
@@ -1,20 +1,31 @@ 
 # Isar Unittests
 
-The unittest python module adds some simple infrastructure that allows to
-unittest python functions defined in bitbake files.
+The unittest Python module adds some simple infrastructure that allows to
+unittest Python functions defined in BitBake files.
 
 ## Running the tests
 
-You can run the tests using avocado with `avocado --show=app,test run testsuite/unittests/`
-or by using the buildin module with `python3 -m unittest discover testsuite/unittests/`
+Run all Python unit tests with:
+
+```sh
+scripts/run-tests.sh -t unittest
+```
+
+Or by using the built-in module: `python3 -m unittest discover testsuite/unittests/`.
+
+Run a specific test by its unittest name:
+
+```sh
+scripts/run-tests.sh -t unittest -p test=test_image_account_extension.TestImageAccountExtensionImageCreateUsers.test_new_user
+```
 
 ## Creating new tests
 
 See the [unittest documentation](https://docs.python.org/3/library/unittest.html)
 on how to create a test module and name it test_*bitbake_module_name*.py
 
-Use the function `load_function(file_name: str, function_name: str) -> Callable`
-in the bitbake module to load the function.
+Use `load_function(file_name, function_name)` from `bitbake.py` to load regular
+Python functions from BitBake files.
 
 Example:
 ```python