unit_tests: Add ztest documentation structure and mark CMocka as legacy

tmleman · tmleman · commit dcc8b7c98f54 · 2025-11-17T15:15:22.000+01:00
Prepare documentation for the ongoing migration from CMocka to Zephyr's native ztest framework for SOF unit tests. Changes: - Create new unit_tests_ztest.rst placeholder for upcoming ztest documentation - Add deprecation notice to unit_tests.rst indicating CMocka is legacy - Add informational note to xtrun/index.rst about the testing framework transition - Update developer_guides/index.rst to include new ztest documentation entry The CMocka-based tests are being phased out as part of the migration to ztest. This commit adds notices to inform developers that new tests should use ztest, while existing CMocka documentation remains available during the transition period. The new ztest documentation page is positioned before the legacy CMocka documentation in the index for better discoverability. Related: thesofproject/sof#10110 Signed-off-by: Tomasz Leman <tomasz.m.leman@intel.com>
diff --git a/developer_guides/index.rst b/developer_guides/index.rst
@@ -11,6 +11,7 @@ terminology before reading further.
 
    introduction
    firmware/index
+   unit_tests_ztest
    unit_tests
    xtrun/index
    topology/topology
diff --git a/developer_guides/unit_tests.rst b/developer_guides/unit_tests.rst
@@ -1,7 +1,16 @@
 .. _unit_tests:
 
-Unit Tests
-##########
+Unit Tests (Legacy CMocka)
+###########################
+
+.. warning::
+   **DEPRECATED: This documentation describes the legacy CMocka-based unit testing framework.**
+   
+   SOF is migrating to Zephyr's native ztest framework. The CMocka tests are being phased out
+   and will be removed once the migration is complete.
+   
+   **For new unit tests, please use the ztest framework.** See :doc:`unit_tests_ztest` for
+   the current testing approach.
 
 Prerequisites
 *************
diff --git a/developer_guides/unit_tests_ztest.rst b/developer_guides/unit_tests_ztest.rst
@@ -0,0 +1,5 @@
+.. _unit_tests_ztest:
+
+Unit Tests with Ztest
+######################
+
diff --git a/developer_guides/xtrun/index.rst b/developer_guides/xtrun/index.rst
@@ -55,6 +55,10 @@ intrinsics (such as HiFi3) in your C programs.
 Unit tests
 **********
 
+.. note::
+   **This section describes legacy CMocka-based unit tests.** SOF is migrating to Zephyr's
+   ztest framework. For current unit testing practices, see :doc:`../unit_tests_ztest`.
+
 In the SOF project, ``xt-run`` is used as the executor for unit tests.
 
 The below example shows how you can add a simple unit test case for a sample
