Enable linting for eval used globally and disable tactically in the single
place where we legitimately use it.

[Backport commit 5270ff8e.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Enable some more linting options and modify the parser accordingly.

[Backport commit 43e3dd79.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

The jsonschema and packaging python modules are optional; relax checking
accordingly.

[Backport commit a2a2123a.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Make the yaml module mandatory for the sake of simplicity.

[Backport commit 7b70fd44.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Remove all the warnings from the disable list, which do not show up with
our scripts.

[Backport commit 9b4cc4bd.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

No functional change.

[Backport commit 8bb12e62.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

- Fix a few pylint warnings.
- Add a `.pylint.rc' file with our pylint settings.
- Add pylint to `make check'.
- Install pylint in the CI.

[Backport commit 5082b6de.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Add typing annotations to parser.py, which allows us to verify python
scripts with stricter mypy settings by default.

[Backport commit ebd6c333.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

We need a container with a recent version of Ubuntu to run mypy in strict
mode.

[Backport commit 371a2992.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

This is a first attempt at static checking our python scripts, to prepare
adding more type annotations in the future.

- Rework bits to make mypy happy.
- Check all scripts with mypy in `make check'.
- Mention mypy in the README and in `make help'.
- Add mypy install to the CI files.

[Backport commit c2674ceb.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Loosen the pattern for classification of one SCT SetState() warning to also
apply when there is a device path.

[Backport commit a87bc1d0.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

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

Mention that this is the ir1 branch of the template, to be used for IR 1.x
certifications.

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

Update the github workflow yaml file to better match what is done on
gitlab.

[Backport and adapt commit bc16b547.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Mention that gitlab.arm.com is where the latest version is.

[Backport commit 97c8a3b0.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Add a CI job to generate the README.pdf.

[Backported commit 54e8cb99.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Add a .gitlab-ci.yml file to run `make check' as CI.

[Backported commit b8b29b65.]
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

Commit d01c0501 ("Add 32b ACS sequence file") only added the
identification of ACS-IR v22.10_IR_32b_0.7_BETA-0 EBBR.seq to the database.
This is enough to allow proper detection, but is not a complete capture of
the files.

Add a copy of the ACS-IR v22.10_IR_32b_0.7_BETA-0 sequence files under the
contrib folder and update the EBBR_manual.seq database entry for
completeness.

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

When running the new 32b ACS-IR, new Simple Text Input Ex and HII Database
failures are caught. Triage them automatically after analysis.

While at it, update one comment in the config file to better match the
reality and update the schema.

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

Sort enum arrays in the JSON schema, to "stabilize" the file layout a bit.

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

Add the EBBR sequence file from the ACS-IR v22.10_IR_32b_0.7_BETA-0.

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

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

  ./parser.py:374:11: E275 missing whitespace after keyword

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

We have a system where the warning related with SetState() and the simple
text input ex protocol happens with a device path. Relax the rule to also
classify that case as ACS limitation.

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

IR 1.1 certifications should use the ir1 branch so that development can
continue on the main branch.

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

Deal with empty config gracefully. This allows to pass e.g. /dev/null as
config without crashing the parser.

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

schema + BBSR seq file

See merge request !11

Add the BBSR sequence file from the Security interface extension ACS
v21.10_SIE_REL1.0.

While at it, fix sequence files permissions.

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

We know all the valid values for many fields of the configuration rules.
Refine the schema to constrain the EBBR.yaml config file a bit more.

This means we are giving up the ability to mention only a sub-string for
those fields in the config file, which we were not doing anyway.

Also, forbid additional properties where we can.

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

Schema + minors

See merge request !10

- Add a jsonschema describing requirements on the configuration file.
- Add a --validate-config and a --schema parser options to make use of the
  schema.
- Add a check for the EBBR.yaml configuration in `make check'.
- Document in the README.

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

Even tparm() can fail on some platforms; make the whole colors probing part
more robust by catching exceptions.

Reported-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>

setafb must be bytes, as we will decode() it later on.

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

Colors and SetState

See merge request !9

Add red/yellow/green colors to more messages.

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

Re-classify warnings issued by the SCT regarding SetState() returning
unsupported as known ACS limitations and drop the known SCT limitation
category. Also, add a reference to the corresponding edk2-test bug entry.

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

This fixes some crashes when using e.g. `--uniq --print --fields <list
without count in it>'.

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

Colors and plurals

See merge request !8

Deal with plural in a better way, in a couple of additional non-debug
places. While at it, update the README.

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

Now that we have colors, use them in our summary line. While at it, deal
more nicely with plurals.

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

Add some colors to our logging messages. We convert a couple of remaining
cases not using the logging facility for error messages.

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