Commit 207b05f6 authored by Vincent Stehlé's avatar Vincent Stehlé
Browse files

README.md: add a few links



We put the links definitions in the same section as the first use, to
facilitate reading the README.md directly.
Signed-off-by: Vincent Stehlé's avatarVincent Stehlé <vincent.stehle@arm.com>
parent 3e5f44ce
# SCT_Parser # SCT_Parser
This is an external parser script for UEFI SCT. (WIP) This is an external parser script for [UEFI SCT]. (WIP)
It's designed to read a `.ekl` results log from an UEFI SCT run, and a generated `.seq` from UEFI SCT configurator. It's designed to read a `.ekl` results log from an [UEFI SCT] run, and a
generated `.seq` from [UEFI SCT] configurator.
It will proceed to generate a Markdown file listing number of failures, passes, each test from the sequence file set that was Silently dropped, and a list of all failures and warnings. It will proceed to generate a Markdown file listing number of failures, passes, each test from the sequence file set that was Silently dropped, and a list of all failures and warnings.
[UEFI SCT]: https://uefi.org/testtools
## Usage ## Usage
Usage to generate a "result md" is such. `python3 parser.py <log_file.ekl> <seq_file.seq>` Usage to generate a "result md" is such. `python3 parser.py <log_file.ekl> <seq_file.seq>`
...@@ -123,19 +125,20 @@ It is possible to use a configuration file with command line option `--config ...@@ -123,19 +125,20 @@ It is possible to use a configuration file with command line option `--config
This configuration file describes operations to perform on the tests results, This configuration file describes operations to perform on the tests results,
such as marking tests as false positives or waiving failures. such as marking tests as false positives or waiving failures.
Example command for EBBR: Example command for [EBBR]:
``` {.sh} ``` {.sh}
$ ./parser.py --config EBBR.yaml /path/to/Summary.ekl EBBR.seq ... $ ./parser.py --config EBBR.yaml /path/to/Summary.ekl EBBR.seq ...
``` ```
You need to install the PyYAML module for this to work (see You need to install the [PyYAML] module for this to work.
<https://github.com/yaml/pyyaml>).
[EBBR]: https://github.com/ARM-software/ebbr
[PyYAML]: https://github.com/yaml/pyyaml
### Configuration file format ### Configuration file format
The configuration file is in YAML format (see <https://yaml.org>). The configuration file is in [YAML] format. It contains a list of rules:
It contains a list of rules:
``` {.yaml} ``` {.yaml}
- rule: name/description (optional) - rule: name/description (optional)
...@@ -150,6 +153,8 @@ It contains a list of rules: ...@@ -150,6 +153,8 @@ It contains a list of rules:
- rule... - rule...
``` ```
[YAML]: https://yaml.org
### Rule processing ### Rule processing
The rules will be applied to each test one by one in the following manner: The rules will be applied to each test one by one in the following manner:
...@@ -201,7 +206,7 @@ This generated configuration can then be further edited manually. ...@@ -201,7 +206,7 @@ This generated configuration can then be further edited manually.
## Notes ## Notes
### Known Issues: ### Known Issues:
* "comment" is currently not implemented, as formatting is not currently consistent, should reflect the comments from the test. * "comment" is currently not implemented, as formatting is not currently consistent, should reflect the comments from the test.
* some SCT tests have shared GUIDs, * some [UEFI SCT] tests have shared GUIDs,
* some lines in ekl file follow Different naming Conventions * some lines in ekl file follow Different naming Conventions
* some tests in the sequence file are not strongly Associated with the test spec. * some tests in the sequence file are not strongly Associated with the test spec.
...@@ -213,7 +218,7 @@ It is possible to convert this `README.md` into `README.pdf` with pandoc using ...@@ -213,7 +218,7 @@ It is possible to convert this `README.md` into `README.pdf` with pandoc using
### Sanity checks ### Sanity checks
To perform sanity checks, run `make check`. For the moment this runs `yamllint`, To perform sanity checks, run `make check`. For the moment this runs `yamllint`,
which will inspect all YAML files and report errors. See `make help`. which will inspect all [YAML] files and report errors. See `make help`.
### db structure: ### db structure:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment