Introduction: Are You Still Using Excel for Requirements? It’s Time to Upgrade!
In embedded systems and projects like Zephyr RTOS, Requirements Management is often the key to project success or failure. The traditional method of managing requirements with Excel is not only inefficient but also prone to errors. Today, we introduce a lightweight command-line tool designed specifically for developers—raiz. It not only helps you easily manage requirements but also automatically associates test cases and generates traceability reports, making it the “Swiss Army Knife” for requirements management for embedded developers.
1. What is raiz? Why Should You Pay Attention?
raiz is a simple yet powerful command-line requirements management tool designed for projects that require high traceability and coverage. It supports:
- Requirements definition and management (functional, non-functional, constraints)
- Integration with Robot Framework for automatic test case association
- Generation of traceability reports (console/JSON)
- SQLite database support, stable and efficient
- Automatic renumbering, eliminating the need for manual ID maintenance
It is particularly suitable for projects like embedded systems and Zephyr RTOS that have high traceability requirements.
2. Simple Installation, Ready to Use
The installation of raiz is very straightforward, requiring just one command:
pip install raiz
That’s right, it’s that user-friendly, even Python beginners can easily get started!
3. Requirements Definition: YAML Format, Clear and Intuitive
All requirements are stored in a<span>requirements.yaml</span> file, formatted as follows:
- id: REQ-001
description: "The system should support Bluetooth communication."
type: Functional
domain: Bluetooth
linked_tests: []
raiz will automatically number the requirements and support automatic renumbering, so you no longer have to worry about ID conflicts.
4. Seamless Integration with Robot Framework, One-Click Test Case Binding
In Robot Framework tests, simply add the corresponding requirement ID tag to the test case, for example:
*** Test Cases ***
Bluetooth Connection Test
[Tags] REQ-001
Perform Connection Operation
After running the tests, raiz will automatically generate a traceability report, informing you which requirements have been tested and which have not been covered, and even provide statistics on pass rates and coverage!
5. Command-Line Operations: Simple and Efficient, Developer-Friendly
The CLI commands of raiz are designed to be very intuitive, for example:
- Add Requirement:
<span>raiz add</span> - Delete Requirement:
<span>raiz rm 3</span> - View All Requirements:
<span>raiz show all</span> - Generate Traceability Report:
<span>raiz trace --fmt json</span>
You can also filter reports by domain or type, making it very suitable for managing large projects.
6. Practical Demonstration: From Requirements to Testing in One Go
Let’s look at a complete usage process:
- Add Requirement:
raiz add
After entering the description, type, and domain, raiz will automatically generate the<span>REQ-XXX</span> ID.
-
Write Robot Framework tests and tag them with requirement labels.
-
Run the tests to generate
<span>output.xml</span>. -
Use raiz to generate the traceability report:
raiz trace --fmt console --domain Bluetooth
You will see the following output:
Requirement ID: REQ-001
Description: The system should support Bluetooth communication
Test Case: Bluetooth Connection Test [PASS]
7. Future Prospects: Continuous Feature Enhancements
raiz is currently undergoing rapid iteration, with future plans including:
- Support for ReqIF format (industry-standard requirements exchange format)
- Integration with Zephyr RTOS testing framework
- Providing more comprehensive documentation and Wiki
Although it currently has few stars, its potential is already beginning to shine.
Conclusion: Say Goodbye to Excel, Embrace raiz!
If you are struggling with requirements management for embedded projects, raiz is definitely a tool worth trying. It is lightweight, efficient, and deeply integrated with Robot Framework, helping you achieve a complete loop from requirements definition to test coverage.
Project Address:https://github.com/daleonpz/raiz[1]
Stop using Excel, give raiz a try! 🚀
📌 Follow Us for more technical insights in the embedded and automation testing fields!📌 Share and Like to let more developers see this treasure tool!
References
[1]
https://github.com/daleonpz/raiz: https://github.com/daleonpz/raiz