Unverified Commit 06eb8813 authored by Jeff Booher-Kaeding's avatar Jeff Booher-Kaeding Committed by GitHub
Browse files

Merge pull request #14 from vstehle/master

Update EBBR config
parents 3284de5f 11e36912
This diff is collapsed.
# 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.
[UEFI SCT]: https://uefi.org/testtools
## Usage
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
This configuration file describes operations to perform on the tests results,
such as marking tests as false positives or waiving failures.
Example command for EBBR:
Example command for [EBBR]:
``` {.sh}
$ ./parser.py --config EBBR.yaml /path/to/Summary.ekl EBBR.seq ...
```
You need to install the PyYAML module for this to work (see
<https://github.com/yaml/pyyaml>).
You need to install the [PyYAML] module for this to work.
[EBBR]: https://github.com/ARM-software/ebbr
[PyYAML]: https://github.com/yaml/pyyaml
### Configuration file format
The configuration file is in YAML format (see <https://yaml.org>).
It contains a list of rules:
The configuration file is in [YAML] format. It contains a list of rules:
``` {.yaml}
- rule: name/description (optional)
......@@ -150,6 +153,8 @@ It contains a list of rules:
- rule...
```
[YAML]: https://yaml.org
### Rule processing
The rules will be applied to each test one by one in the following manner:
......@@ -198,10 +203,30 @@ This generated configuration can then be further edited manually.
* The generated rule "criteria" "log" field is filtered to remove the leading
path before C filename.
### EBBR configuration
The `EBBR.yaml` file is a configuration file meant for [EBBR] testing. It can
override the result of some tests with the following ones:
-------------------------------------------------------------------------------
Result Description
------------------------- ----------------------------------------------------
`IGNORED` False-positive test failure, not mandated by [EBBR]
and too fine-grained to be removed from the
`EBBR.seq` sequence file.
`KNOWN U-BOOT LIMITATION` Genuine bugs, which much ultimately be fixed.
We know about them; they are due to U-Boot FAT
filesystem implementation limitations and they do
not prevent an OS to boot.
-------------------------------------------------------------------------------
Some of the rules just add a `comments` field with some help text.
## Notes
### Known Issues:
* "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 tests in the sequence file are not strongly Associated with the test spec.
......@@ -213,7 +238,7 @@ It is possible to convert this `README.md` into `README.pdf` with pandoc using
### Sanity checks
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:
......
Markdown is supported
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