diff --git a/Documentation/testing/ntfc.rst b/Documentation/testing/ntfc.rst new file mode 100644 index 00000000000..c593bb3e11d --- /dev/null +++ b/Documentation/testing/ntfc.rst @@ -0,0 +1,29 @@ +========================================= +NTFC (NuttX Test Framework for Community) +========================================= + +NTFC enables automated testing for NuttX across :doc:`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/apache/nuttx-ntfc +- https://github.com/apache/nuttx-ntfc-testing + +Detailed documentation is available in the framework repository. + +CI migration to NTFC is in progress. Configurations currently using NTFC: + +- :doc:`risc-v/qemu-rv `: ``rv-virt/citest64`` +- :doc:`risc-v/qemu-rv `: ``rv-virt/citest`` +- :doc:`sim/sim `: ``sim/citest`` +- :doc:`arm/imx6 `: ``sabre-6quad/citest`` +- :doc:`arm64/qemu `: ``qemu-armv8a/citest`` +- :doc:`arm64/qemu `: ``qemu-armv8a/citest_smp`` + +NTFC exports test logs as CI artifacts. This allows test logs (including +:doc:`ostest ` output) to be downloaded +directly from the CI for all targets where the ``citest`` configuration is +enabled.