README.md 6.04 KB
Newer Older
Jeff Booher-Kaeding's avatar
Jeff Booher-Kaeding committed
1
# SCT_Parser
2

Vincent Stehlé's avatar
Vincent Stehlé committed
3
This is an external parser script for UEFI SCT. (WIP)
4

5
It's designed to read a `.ekl` results log from an UEFI SCT run, and a generated `.seq` from UEFI SCT configurator.
Jeff Booher-Kaeding's avatar
V1.0?    
Jeff Booher-Kaeding committed
6

7
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.
8
9


10
## Usage
Vincent Stehlé's avatar
Vincent Stehlé committed
11
Usage to generate a "result md" is such. `python3 parser.py <log_file.ekl> <seq_file.seq>`
12
If you do no provided any command line arguments it will use `sample.ekl` and `sample.seq`.
Vincent Stehlé's avatar
Vincent Stehlé committed
13
The output filename can be specified with `--md <filename>`.
Jeffrey Booher-Kaeding's avatar
Jeffrey Booher-Kaeding committed
14

Vincent Stehlé's avatar
Vincent Stehlé committed
15
An online help is available with the `-h` option.
Jeff Booher-Kaeding's avatar
V1.0?    
Jeff Booher-Kaeding committed
16

17
### Custom search
Vincent Stehlé's avatar
Vincent Stehlé committed
18
For a custom Key:value search, the next two arguments *MUST be included together.* The program will search and display files that met that constraint, without the crosscheck, and display the names, guid, and key:value to the command line. `python3 parser.py <file.ekl> <file.seq> <search key> <search value>`
Jeff Booher-Kaeding's avatar
V1.0?    
Jeff Booher-Kaeding committed
19

Vincent Stehlé's avatar
Vincent Stehlé committed
20
you can use the `test_dict` below to see available keys.
21

Vincent Stehlé's avatar
Vincent Stehlé committed
22
### Sorting data
23

Vincent Stehlé's avatar
Vincent Stehlé committed
24
25
26
It is possible to sort the tests data before output using
the `--sort <key1,key2,...>` option.
Sorting the test data helps when comparing results with diff.
27

Vincent Stehlé's avatar
Vincent Stehlé committed
28
Example command:
29

Vincent Stehlé's avatar
Vincent Stehlé committed
30
31
32
33
``` {.sh}
$ ./parser.py --sort \
      'group,descr,set guid,test set,sub set,guid,name,log' ...
```
34

Vincent Stehlé's avatar
Vincent Stehlé committed
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
## Configuration file

It is possible to use a configuration file with command line option `--config
<filename>`.
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:

``` {.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>).

### Configuration file format

The configuration file is in YAML format (see <https://yaml.org>).
It contains a list of rules:

``` {.yaml}
- rule: name/description (optional)
  criteria:
    key1: value1
    key2: value2
    ...
  update:
    key3: value3
    key4: value4
    ...
- rule...
```

### Rule processing

The rules will be applied to each test one by one in the following manner:

* An attempt is made at matching all the keys/values of the rule's 'criteria'
  dict to the keys/values of the test dict. Matching test and criteria is done
  with a "relaxed" comparison (more below).
  - If there is no match, processing moves on to the next rule.
  - If there is a match:
    1. The test dict is updated with the 'update' dict of the rule.
    2. An 'Updated by' key is set in the test dict to the rule name.
    3. Finally, no more rule is applied to that test.

A test value and a criteria value match if the criteria value string is present
anywhere in the test value string.
For example, the test value "abcde" matches the criteria value "cd".

You can use `--debug` to see more details about which rules are applied to the
tests.

### Sample

A `sample.yaml` configuration file is provided as example, to use with the
`sample.ekl` and `sample.seq` files.

Try it with:

``` {.sh}
$ ./parser.py --config sample.yaml ...
```

100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
### Generating a configuration template

To ease the writing of yaml configurations, there is a `--template` option to
generate a configuration "template" from the results of a run:

``` {.sh}
$ ./parser.py --template template.yaml ...
```

This generated configuration can then be further edited manually.

* Tests with result "PASS" are omitted.
* The following tests fields are omitted from the generated rule "criteria":
  "iteration", "start date" and "start time".
* The generated rule "criteria" "log" field is filtered to remove the leading
  path before C filename.

Jeffrey Booher-Kaeding's avatar
Jeffrey Booher-Kaeding committed
117
118
## Notes
### Known Issues:
Jeff Booher-Kaeding's avatar
V1.0?    
Jeff Booher-Kaeding committed
119
* "comment" is currently not implemented, as formatting is not currently consistent, should reflect the comments from the test.
120
121
* some SCT tests have shared GUIDs,
* some lines in ekl file follow Different naming Conventions
Vincent Stehlé's avatar
Vincent Stehlé committed
122
* some tests in the sequence file are not strongly Associated with the test spec.
123

124
125
126
127
### Documentation

It is possible to convert this `README.md` into `README.pdf` with pandoc using
`make doc`. See `make help`.
128

129
130
### TODO:
* double check concatenation of all `.ekl` logs, preliminary tests show small Divergence between them and `summary.ekl` found in `Overall` folder. Cat.sh will generate this file.
131
* look into large number of dropped tests.
132
133
134


### db structure:
Vincent Stehlé's avatar
Vincent Stehlé committed
135
``` {.python}
136
137
138
139
tests = [
    test_dict,
    est_dict2...
]
Jeff Booher-Kaeding's avatar
V1.0?    
Jeff Booher-Kaeding committed
140

141
142
143
144
test_dict = {
   "name": "some test",
   "result": "pass/fail",
   "group": "some group",
Vincent Stehlé's avatar
Vincent Stehlé committed
145
   "test set": "some set",
146
147
148
   "sub set": "some subset",
   "set guid": "XXXXXX",
   "guid": "XXXXXX",
Jeff Booher-Kaeding's avatar
V1.0?    
Jeff Booher-Kaeding committed
149
   "comment": "some comment",
150
151
152
153
   "log": "full log output"
}


Vincent Stehlé's avatar
Vincent Stehlé committed
154
seqs = {
155
156
157
158
159
160
161
162
163
164
    <guid> : seq_dict
    <guid2> : seq_dict2...
}

seq_dict = {
                "name": "set name",
                "guid": "set guid",
                "Iteration": "some hex/num of how many times to run",
                "rev": "some hex/numb",
                "Order": "some hex/num"
Jeff Booher-Kaeding's avatar
V1.0?    
Jeff Booher-Kaeding committed
165
}
166
```
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197

#### Spurious tests

Spurious tests are tests, which were run according to the log file but were not
meant to be run according to the sequence file.

We force the "result" fields of those tests to "SPURIOUS".

#### Dropped tests sets

Dropped tests sets are the tests sets, which were were meant to be run according
to the sequence file but for which no test have been run according to the log
file.

We create artificial tests entries for those dropped tests sets, with the
"result" fields set to "DROPPED". We convert some fields coming from the
sequence file, and auto-generate others:

``` {.python}
dropped_test_dict = {
   "name": "",
   "result": "DROPPED",
   "group": "Unknown",
   "test set": "",
   "sub set": <name from sequence file>,
   "set guid": <guid from sequence file>,
   "revision": <rev from sequence file>,
   "guid": "",
   "log": ""
}
```
198
199
200
201
202
203
204
205

#### Skipped tests sets

Skipped tests sets are the tests sets, which were considered but had zero of
their test run according to the log file.

We create artificial tests entries for those dropped tests sets, with the
"result" fields set to "SKIPPED".