Print more informations from the capsule in case of error or for debugging,
now that we have lambda functions instead of only fixed strings.
While at it, reformat to make the code more readable.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Catch more exceptions during check of the capsule and do not try to print
error or debug messages in that case.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Change all error and debug sanity check entries to lambda functions, which
receive the capsule as parameter.
No functional change in this commit, but this will allow printing not only
fixed error and debug messages, but also variable fields of the capsule.
While at it, document a bit the fields and interfaces.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Quote the paths used in our shell commands to fix the case where those
paths have spaces in them.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Start factorizing our schemas, now that validate.py supports it.
We start with the obvious (but not very useful yet) filename definition, as
a proof of concept.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Enhance the validate.py script to allow referencing other schemas from a
schema, and load the local file with the script.

This will allow us to factorize our schemas.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

We need double quotes for proper multiline strings in YAML.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Reword our asserts to fix the errors reported by flake8, such as the
following:

  ./format-sr-results.py:50:11: E275 missing whitespace after keyword

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Add a verification of the Devicetree blob with dt-validate.

We download, extract and cache the Devicetree bindings automatically.

We add a `--dt-validate' command line option to specify the dt-validate
command, and a `--linux-url' command line option to allow specifying the
URL of the Linux kernel tarball to download.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

We add a `warn-if-not-named' property, to issue warnings when files and
directories are not named according to a pattern.

Using the new property, we relax a bit more the naming of the files in the
configuration to consider more files and issue warnings when we can.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Allow the uefi folder to contain one more file. This suppresses the error
due to generating a `BsaDevTree.dtb.log' file in this folder with dtc.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Allow the acs_results folder to contain one less file. This suppresses one
error in the case where result.md is missing and we re-create it using the
SCT parser.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Enhance check-sr-results.py to attempt re-creating the result.md when it is
missing using the SCT parser.

We add an `sct-parser-result-md' property to the configuration file and we
add a `--parser' command line option to specify the SCT parser command.

The unit test copes with both cases of parser.py being in the $PATH or not.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

The `array-of-strings' definition is unused; remove it.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

We verify that capsule GUIDs are found in the ESRT.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Make our Guid frozen to forbid assigning to the members directly and to
make it hashable, which allows to add it to a set for example.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Add a `--print-guid' option to request printing of the image type id GUID
on its own line to stdout. We preserve the default behaviour of not
printing it.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

We add a valid Devicetree blob to the mockup directory structure and
perform more validation of the Devicetree checking.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

We use dtc to check the captured Devicetree blob. For that, we add a new
`--dtc' command line option to allow specifying the dtc command line, and a
new `devicetree' property to the configuration file and schema.

Then we use dt-parser.py to check the dtc log. For that, we add a new
`--dt-parser' command line option to allow specifying the dt-parser command
line.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Also, remove the python cache files erroneously captured in commit
f4dcfe98 ("check-sr-results: rework overlay conditions").

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Check that capsule-tool is available in the prerequisites phase.
If capsule-tool invocation fails, we know this is an error therefore deal
with it gracefully.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Print more validation messages to stdout instead of using logging. This is
to ease calling capsule-tool.py from other scripts and facilitate parsing.

Update check-sr-results.py accordingly.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Use capsule-tool.py to verify UEFI Capsules.
We add a new uefi-capsule directive and a new --capsule-tool option.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

This is to avoid breaking IR v1.x.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Auto-select the "old" ir1 config when detected.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

We use guid-tool.py for that.

While at it add a `mockup' tree to start verifying that we catch some types
of IR 2.0 issues.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Use more elaborated rules to describe the YAML files to validate with
schemas, to expose parallelism.

While at it, cleanup the tests logs with `make clean'.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Add new directives `min-entries' and `max-entries' to the directories
checks. This is better than the documented-but-not-implemented
`can-be-empty' directive.
Use those directives to check the results.

While at it, remove a couple of wildcards to strengthen the checks and
follow the template more closely.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

This is the GUID.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

This avoids a false-positive error.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

All our caller and callee scripts understand the --debug option, and we are
running them in shells, which makes it easy to pass the option; therefore
add it.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

When the capsule is so broken that we cannot even parse it, Construct
raises an exception. Handle that exception more gracefully.
Test a few of those cases in the unit test.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Align a bit to what we do in check-sr-results.py.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Adapt the default configuration to the results produced by the ACS-IR 2.0
BET-0.

We copy the old configuration, to be able to check "old" IR v1.x results.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Now that we want to determine the SystemReady version of results based on
more than the EBBR sequence file, change the `ebbr_seq_files' condition to
more generic `when-any' and `when-all' conditions.
Only minimal functional change in the messages is expected.
We test a bit in the unit test.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Allow to specify the configuration filename and allow empty configuration.

This is to enable more testing, therefore while at it, add a (mostly empty)
unit test.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Simplify even more our run() wrapper interface and use it to call our
`identify.py' script, too.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Let's just print `Unknown' and return normally.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

This script is only intended to be imported from other scripts and not run
by itself.

Document that a bit in the README and run doctest if run by itself rather
than doing nothing.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>