Skip to content

Conversation

@tmleman
Copy link

@tmleman tmleman commented Nov 17, 2025

No description provided.

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 <[email protected]>
…ructions

Add initial documentation for SOF's new ztest-based unit testing
framework.
This provides developers with essential information to get started with
ztest while the migration from CMocka is ongoing.

Content includes:
- Overview of ztest migration and current status
- Prerequisites and required tools
- Step-by-step workspace setup with west
- Instructions for building and running tests with Twister
- Placeholders for future sections (writing tests, architecture, notes)

Related: thesofproject/sof#10110

Signed-off-by: Tomasz Leman <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants