doc: update citests.rst and move to Testing

update citests.rst and move page from Guides to Testing

Signed-off-by: p-szafonimateusz <p-szafonimateusz@xiaomi.com>
This commit is contained in:
p-szafonimateusz
2026-01-02 12:33:15 +01:00
committed by Alan C. Assis
parent b88f86ba5d
commit e1fb0498b2
4 changed files with 33 additions and 13 deletions
-1
View File
@@ -16,7 +16,6 @@ Guides
pysimcoder.rst
customboards.rst
customapps.rst
citests.rst
zerolatencyinterrupts.rst
fortify.rst
nestedinterrupts.rst
+1
View File
@@ -37,6 +37,7 @@ Last Updated: |today|
reference/index.rst
faq/index.rst
debugging/index.rst
testing/index.rst
guides/index.rst
standards/index.rst
glossary.rst
@@ -7,8 +7,8 @@ Running CI Test Locally
NuttX automatically runs continuous integration (CI) tests on
`simulator <https://nuttx.apache.org/docs/latest/guides/simulator.html>`__
target when new pull request is submitted. To avoid the tests failing you can
also run them locally on your computer prior to submitting new pull request.
and QEMU targets when a new pull request is submitted. To avoid the tests failing
you can also run them locally on your computer prior to submitting a new pull request.
This page describes the step by step manual to do so.
Configuring NuttX
@@ -24,14 +24,6 @@ compiled followingly.
$ ./tools/configure.sh sim:citest
$ make
Now you can run the simulator to check the configuration was successful.
.. code-block:: console
$ ./nuttx
login: admin
password: Administrator
You should see NuttX shell with built in test applications. Now you can exit
the simulator.
@@ -41,8 +33,9 @@ the simulator.
$
$ # we're back at the Linux prompt.
Running CI Tests
================
Running CI Tests with ``tools/ci/testrun``
==========================================
Running CI tests locally requires Minicom and Python 3.6 or newer to be
installed on the system. Other requirements can be installed with following
@@ -64,3 +57,22 @@ by following command.
Where nuttx-path is an absolute path to NuttX root directory and log-path is
a user defined directory to which tests log are saved.
CI with NTFC
============
NTFC (NuttX Test Framework for Community) enables automated testing for NuttX
across simulator, QEMU, and real hardware via serial interface. The framework
automatically detects available applications in NuttX images and executes
applicable tests using pytest-based test cases.
The framework and official test cases are available at:
- https://github.com/szafonimateusz-mi/nuttx-ntfc
- https://github.com/szafonimateusz-mi/nuttx-testing
Detailed documentation is available in the framework repository.
CI migration to NTFC is in progress. Configurations currently using NTFC:
- ``sim/citest``
+8
View File
@@ -0,0 +1,8 @@
=======
Testing
=======
This page contains information related to NuttX testing.
.. toctree::
citests.rst