Skip to content

Commit 2b8bc21

Browse files
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>
1 parent ebf548e commit 2b8bc21

3 files changed

Lines changed: 32 additions & 13 deletions

File tree

Documentation/guides/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Guides
1616
pysimcoder.rst
1717
customboards.rst
1818
customapps.rst
19-
citests.rst
2019
zerolatencyinterrupts.rst
2120
fortify.rst
2221
nestedinterrupts.rst
Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Running CI Test Locally
77

88
NuttX automatically runs continuous integration (CI) tests on
99
`simulator <https://nuttx.apache.org/docs/latest/guides/simulator.html>`__
10-
target when new pull request is submitted. To avoid the tests failing you can
11-
also run them locally on your computer prior to submitting new pull request.
10+
and QEMU targets when new pull request is submitted. To avoid the tests failing
11+
you can also run them locally on your computer prior to submitting new pull request.
1212
This page describes the step by step manual to do so.
1313

1414
Configuring NuttX
@@ -24,14 +24,6 @@ compiled followingly.
2424
$ ./tools/configure.sh sim:citest
2525
$ make
2626
27-
Now you can run the simulator to check the configuration was successful.
28-
29-
.. code-block:: console
30-
31-
$ ./nuttx
32-
login: admin
33-
password: Administrator
34-
3527
You should see NuttX shell with built in test applications. Now you can exit
3628
the simulator.
3729

@@ -41,8 +33,9 @@ the simulator.
4133
$
4234
$ # we're back at the Linux prompt.
4335
44-
Running CI Tests
45-
================
36+
37+
Running CI Tests with ``tools/ci/testrun``
38+
==========================================
4639

4740
Running CI tests locally requires Minicom and Python 3.6 or newer to be
4841
installed on the system. Other requirements can be installed with following
@@ -64,3 +57,22 @@ by following command.
6457
6558
Where nuttx-path is an absolute path to NuttX root directory and log-path is
6659
a user defined directory to which tests log are saved.
60+
61+
CI with NTFC
62+
============
63+
64+
NTFC (NuttX Test Framework for Community) enables automated testing for NuttX
65+
across simulator, QEMU, and real hardware via serial interface. The framework
66+
automatically detects available applications in NuttX images and executes
67+
applicable tests using pytest-based test cases.
68+
69+
The framework and official test cases are available at:
70+
71+
- https://github.com/szafonimateusz-mi/nuttx-ntfc
72+
- https://github.com/szafonimateusz-mi/nuttx-testing
73+
74+
Detailed documentation is available in the framework repository.
75+
76+
CI migration to NTFC is in progress. Configurations currently using NTFC:
77+
78+
- ``sim/citest``

Documentation/testing/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=======
2+
Testing
3+
=======
4+
5+
This page contains information related to NuttX testing.
6+
7+
.. toctree::
8+
citests.rst

0 commit comments

Comments
 (0)