feat(doc): include bao test framework introduction#71
Open
Diogo21Costa wants to merge 2 commits into
Open
Conversation
Diogo21Costa
requested review from
danielRep,
josecm and
miguelafsilva5
as code owners
danielRep
previously approved these changes
Oct 23, 2023
danielRep
left a comment
danielRep
left a comment
Member
There was a problem hiding this comment.
Nothing to add @Diogo21Costa , seems good to me as a small introduction to the document, since the next section I assume you will explain the "architecture" of the framework.
Member
|
Does this PR supersedes #65 ? |
josecm
requested changes
Oct 26, 2023
Member
Author
danielRep
requested changes
Oct 27, 2023
josecm
requested changes
Oct 27, 2023
danielRep
previously approved these changes
Nov 20, 2023
josecm
reviewed
Dec 7, 2023
josecm
left a comment
josecm
left a comment
Member
There was a problem hiding this comment.
To be completely honest, the C library and Nix build system descriptions are a bit confusing. From these descriptions I would not get what they are meant to do.
Member
Author
danielRep
requested changes
Dec 16, 2023
danielRep
left a comment
danielRep
left a comment
Member
There was a problem hiding this comment.
Please rebase it with main and solve the checker issues.
danielRep
force-pushed
the
wip/testing
branch
from
cabeb59 to
005c822
Compare
Diogo21Costa
force-pushed
the
feat/testing-introduction
branch
from
8c0fa76 to
f2160d8
Compare
danielRep
requested changes
Dec 18, 2023
Diogo21Costa
force-pushed
the
feat/testing-introduction
branch
from
f2160d8 to
198690e
Compare
Signed-off-by: Diogo21Costa <diogoandreveigacosta@gmail.com>
Diogo21Costa
force-pushed
the
feat/testing-introduction
branch
from
198690e to
020fe09
Compare
danielRep
previously approved these changes
Dec 18, 2023
Member
@Diogo21Costa TBH, I still think these descriptions are confusing, especially the C library one. Using simpler language, with fewer adjectives and more straight-to-the-point ideas, would be best. |
josecm
requested changes
Feb 1, 2024
Comment on lines
+8
to
+10
| 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. |
Member
There was a problem hiding this comment.
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). |
Comment on lines
+12
to
+16
| 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. |
Member
There was a problem hiding this comment.
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. |
Signed-off-by: Diogo Costa <diogoandreveigacosta@gmail.com>
danielRep
approved these changes
Mar 27, 2024
DavidMCerdeira
approved these changes
Sep 4, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Description
In this pull request, I'm adding content to the "Overview" section of the Bao test framework documentation.
This update focuses solely on the "Overview" section, providing an overview of the core components of the Bao test framework.
Do you have any suggestions or feedback concerning the content provided in the overview section?