Documentation updates for IncludeOS v0.15.0#16
Open
staiyeba wants to merge 16 commits intoincludeos:masterfrom
Open
Documentation updates for IncludeOS v0.15.0#16staiyeba wants to merge 16 commits intoincludeos:masterfrom
staiyeba wants to merge 16 commits intoincludeos:masterfrom
Conversation
Contributor
mnordsletten
left a comment
mnordsletten
left a comment
There was a problem hiding this comment.
A few small things here :)
in_depth/Testing.rst
Outdated
|
|
||
| All the tests are grouped by categories as listed in the folder. The unit tests for each of the categories of tests are located under ``IncludeOS/test/<category>/unit/<test-name>.cpp``. | ||
|
|
||
| To run all the unit tests simultaneously do: |
Contributor
There was a problem hiding this comment.
This does not actually run the tests. Only installs them. Ready for cmake.
Contributor
There was a problem hiding this comment.
See here how they are actually run (before we started doing coverage at the same time)
https://github.com/includeos/IncludeOS/blob/3fa07fd5377043d660d46c17399643592323ec5f/Jenkinsfile
Contributor
Author
There was a problem hiding this comment.
Separated this into two sections as follows:
To install and build the unit tests do:
::
$ conan install IncludeOS/test -pr gcc-7.3.0-linux-x86_64 -s build_type=Debug
$ . ./activate.sh
Then to run the unit tests in random order do;
::
$ ctest --schedule-random
If you want to get the coverage report for the unit tests as well do:
::
# build with coverage
$ . ./activate.sh && cmake -DCOVERAGE=ON -DCODECOV_HTMLOUTPUTDIR=<your-coverage-dir> IncludeOS/test
# build and test with coverage
$ . ./activate.sh && make -j nproc coverage
After running the unit tests, you can then view the coverage report in html format
in the path you specified.
We can remove the section on coverage if it's not something we are concentrating on yet.
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
2 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.
Please review this PR when IncludeOS v0.15.0 release has been made.