From 14cb309e688e4c702af08cd9727593e1195beb06 Mon Sep 17 00:00:00 2001 From: Matteo Golin Date: Wed, 4 Mar 2026 17:40:45 -0500 Subject: [PATCH] docs/testing/citests: Expand CI testing documentation The citests.rst now documents how to run the CI test suites locally (the same way they are done in NuttX GitHub CI). Other pages are created for different parts of NuttX testing. Signed-off-by: Matteo Golin --- Documentation/testing/citests.rst | 38 ++++--------------------------- Documentation/testing/index.rst | 9 +++++++- 2 files changed, 13 insertions(+), 34 deletions(-) diff --git a/Documentation/testing/citests.rst b/Documentation/testing/citests.rst index 22d2ed1dc6d..f6c7bc47c47 100644 --- a/Documentation/testing/citests.rst +++ b/Documentation/testing/citests.rst @@ -1,11 +1,11 @@ .. include:: /substitutions.rst .. _citests: -======================= -Running CI Test Locally -======================= +====================================== +Running CI Runtime Test Suites Locally +====================================== -NuttX automatically runs continuous integration (CI) tests on +NuttX automatically runs continuous integration (CI) tests on `simulator `__ 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. @@ -48,7 +48,7 @@ set of commands. $ cd .. $ cd script -Now you have everything prepared to run CI tests. The tests themself are run +Now you have everything prepared to run CI tests. The tests themselves are run by following command. .. code-block:: console @@ -57,31 +57,3 @@ 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: - -- risc-v/qemu-rv: ``rv-virt/citest64`` -- risc-v/qemu-rv: ``rv-virt/citest`` -- sim/sim: ``sim/citest`` -- arm/imx6: ``sabre-6quad/citest`` -- arm64/qemu: ``qemu-armv8a/citest`` -- arm64/qemu: ``qemu-armv8a/citest_smp`` - -NTFC exports test logs as CI artifacts. This allows test logs (including ``ostest`` -output) to be downloaded directly from the CI for all targets where the ``citest`` -configuration is enabled. diff --git a/Documentation/testing/index.rst b/Documentation/testing/index.rst index d5824a97426..540448039e5 100644 --- a/Documentation/testing/index.rst +++ b/Documentation/testing/index.rst @@ -4,5 +4,12 @@ Testing This page contains information related to NuttX testing. +For information about included NuttX testing applications, please see +:doc:`/applications/testing/index`. + .. toctree:: - citests.rst + + nuttx-ci.rst + citests.rst + ntfc.rst + nxdart.rst