Skip to content

Commit

Permalink
feat(doc): include bao test framework introduction
Browse files Browse the repository at this point in the history
Signed-off-by: Diogo21Costa <[email protected]>
  • Loading branch information
Diogo21Costa committed Dec 18, 2023
1 parent 005c822 commit 020fe09
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
19 changes: 18 additions & 1 deletion source/development/testing.rst
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.

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.

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
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,5 @@ subdirectory
scalability
codebase
unix
baremetal
freeRTOS

0 comments on commit 020fe09

Please sign in to comment.