diff --git a/Documentation/guides/index.rst b/Documentation/guides/index.rst index 95457185b80..f1e11bc9a45 100644 --- a/Documentation/guides/index.rst +++ b/Documentation/guides/index.rst @@ -16,7 +16,6 @@ Guides pysimcoder.rst customboards.rst customapps.rst - citests.rst zerolatencyinterrupts.rst fortify.rst nestedinterrupts.rst diff --git a/Documentation/index.rst b/Documentation/index.rst index 1443b326365..dc7773ccb6e 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -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 diff --git a/Documentation/guides/citests.rst b/Documentation/testing/citests.rst similarity index 63% rename from Documentation/guides/citests.rst rename to Documentation/testing/citests.rst index 0d3b73fa8bc..dbbffb05096 100644 --- a/Documentation/guides/citests.rst +++ b/Documentation/testing/citests.rst @@ -7,8 +7,8 @@ Running CI Test Locally NuttX automatically runs continuous integration (CI) tests on `simulator `__ -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`` diff --git a/Documentation/testing/index.rst b/Documentation/testing/index.rst new file mode 100644 index 00000000000..d5824a97426 --- /dev/null +++ b/Documentation/testing/index.rst @@ -0,0 +1,8 @@ +======= +Testing +======= + +This page contains information related to NuttX testing. + +.. toctree:: + citests.rst