Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(doc): include bao test framework introduction #71

Open
wants to merge 2 commits into
base: wip/testing
Choose a base branch
from
Open

feat(doc): include bao test framework introduction #71

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
020fe09
feat(doc): include bao test framework introduction
Diogo21Costa Dec 18, 2023
60c63b4
fix(doc): improve readability
Diogo21Costa Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion source/development/testing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
Testing
=======

The primary goal of the Bao Test Framework is to provide the infrastructure for the testing process
of Bao Project components. It encompasses three core components: (i) a C library designed for
real-time test handling, (ii) a build system based on Nix, and (iii) a Python Tool for
comprehensive test management.

1. **C Library** - This library that streamlines testing by providing macros, pre-processed logging
prompts, and an entry-point-based system, aiming to facilitating the integration of developer
tests in the software stack, such as the hypervisor or guest components.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. **C Library** - This library that streamlines testing by providing macros, pre-processed logging
prompts, and an entry-point-based system, aiming to facilitating the integration of developer
tests in the software stack, such as the hypervisor or guest components.
1. **C Library** - This library provides a framework for writing tests. It defines (i) a runtime that automates the invocation of function unit tests and (ii) an API that mainly provides a way of outputing test results in a standard format that can be parsed by the Python Tool (see below).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, fixed!


2. **Nix Build System** - The Nix Build System introduces an abstraction layer for system builds,
facilitating a modular construction of the software stack for comprehensive testing. It
encompasses a series of nix recipes that allow the compilation and build of three distinct
layers: (i) the hypervisor, (ii) multiple guests (e.g., baremetal, freeRTOS, etc.), and (iii)
the firmware.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. **Nix Build System** - The Nix Build System introduces an abstraction layer for system builds,
facilitating a modular construction of the software stack for comprehensive testing. It
encompasses a series of nix recipes that allow the compilation and build of three distinct
layers: (i) the hypervisor, (ii) multiple guests (e.g., baremetal, freeRTOS, etc.), and (iii)
the firmware.
2. **Nix Build System** - The Nix Build System introduces an abstraction layer for system builds,
facilitating a modular construction of the target software stack used for testing. It
encompasses a series of nix recipes that allow the compilation and build of three distinct
layers: (i) the hypervisor, (ii) multiple guests (e.g., baremetal, freeRTOS, etc.), and (iii)
the firmware.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, fixed!


3. **Python Tool** - A command line tool that drives the framework by managing both the Nix Build
System and the C code library components to build testing artifacts, automating their deployment
in the target platform, and gathering, analyzing and outputting the final results.

Test Framework Overview
-----------------------
Expand Down
2 changes: 2 additions & 0 deletions source/spelling_wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,5 @@ subdirectory
scalability
codebase
unix
baremetal
freeRTOS
Loading