Skip to content

Commit e3e8e7f

Browse files
authored
Explain output of compliance test. (#1076)
Signed-off-by: Thomas Güttler <thomas.guettler@syself.com>
1 parent 91effc1 commit e3e8e7f

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

Tests/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,17 @@ pip install -r kaas/requirements.txt
4848
Given a kubeconfig file `path/to/kubeconfig.yaml`, run
4949

5050
```shell
51-
./scs-compliance-check.py -v -a kubeconfig=path/to/kubeconfig.yaml -a subject_root=. -s SUBJECT scs-compatible-kaas.yaml
51+
./scs-compliance-check.py -v -a kubeconfig=path/to/kubeconfig.yaml -a subject_root=. -s SUBJECT -o report.yaml scs-compatible-kaas.yaml
5252
```
5353

54-
Replace `SUBJECT` with an arbitrary, but meaningful subject name.
55-
Also, please note that the check will always use the `current-context` of the kubeconfig and will
56-
fail if it isn't set.
54+
Replace `SUBJECT` with an arbitrary, but meaningful subject name. Also, please note that the check
55+
will always use the `current-context` of the kubeconfig and will fail if it isn't set.
56+
57+
A report in YAML format will be created.
58+
59+
Additionally, the directory `sono-results` will be generated. It contains a JUnit XML file:
60+
`plugins/e2e/results/global/junit_01.xml`. You can render it to HTML with a tool like junit2html.
61+
This might give you hints as to why a test failed.
5762

5863
## Usage information (help output)
5964

0 commit comments

Comments
 (0)