Add a description to the SystemReady Devicetree categories#635
Open
vstehle wants to merge 2 commits intoARM-software:mainfrom
Open
Add a description to the SystemReady Devicetree categories#635vstehle wants to merge 2 commits intoARM-software:mainfrom
vstehle wants to merge 2 commits intoARM-software:mainfrom
Conversation
Add a JSON schema describing the format of test_categoryDT.json.
The following example command can be used for validation, from the
common/log_parser folder:
$ check-jsonschema --schemafile test_categoryDT-schema.json \
test_categoryDT.json
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
Add a `Description' field to each test suite in test_categoryDT.json. This is meant to help test engineers better understand the implication of each test suite's failures on system quality. The JSON format does not allow to break long lines. Therefore, to keep the file human-readable, the description is recorded as an array of strings, with one string corresponding to one sentence. While at it, update the schema. Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
Contributor
Author
|
Hi @chetan-rathore and @pergar01, could you please have a look? Test suites are never perfectly documented regarding what they test exactly. Therefore, feel free to add even more details. |
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
1 participant
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.
This is done in two steps:
test_categoryDT.jsonas it isUltimately those descriptions should end up into the tests results JSON and HTML files, to be visible by test engineers.
The schema is not applicable to
test_category.jsonas the formats differ.