Produce an understanable error when remediation collections goes wrong

[matejak]

At least name the rule and the remediation type.

Review Hints:

If you run the build of e.g. sle15 product on a Python2 system, you will get an encoding error that will point you out to the file that contains a non-ASCII character. Generally, you can introduce any fatal error to the remediation s.a. non-matching Jinja control characters, and you will see the improved error handling in action. (although in case of Jinja errors, there would already be a pointer given by Jinja, but there are other things that can go wrong that crash without telling details).

[github-actions]

Start a new ephemeral environment with changes proposed in this pull request:

Fedora Environment

Oracle Linux 8 Environment

[codeclimate]

Code Climate has analyzed commit a0543e6 and detected 2 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Duplication	2

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 49.9% (0.0% change).

View more on Code Climate.

[jan-cerny]

I have broken a remediation for a rule by breaking the platform and it has failed completely:

[5/11] [rhel9-content] collecting all fixes
FAILED: rhel9/collect-remediations-rhel9 /home/jcerny/work/git/scap-security-guide/build/rhel9/collect-remediations-rhel9 
cd /home/jcerny/work/git/scap-security-guide/build/rhel9 && env PYTHONPATH=/home/jcerny/work/git/scap-security-guide /usr/bin/python3 /home/jcerny/work/git/scap-security-guide/build-scripts/collect_remediations.py --resolved-rules-dir /home/jcerny/work/git/scap-security-guide/build/rhel9/rules --build-config-yaml /home/jcerny/work/git/scap-security-guide/build/build_config.yml --product-yaml /home/jcerny/work/git/scap-security-guide/products/rhel9/product.yml --remediation-type bash --remediation-type ansible --remediation-type puppet --remediation-type anaconda --remediation-type ignition --remediation-type kubernetes --remediation-type blueprint --output-dir /home/jcerny/work/git/scap-security-guide/build/rhel9/fixes --fixes-from-templates-dir /home/jcerny/work/git/scap-security-guide/build/rhel9/fixes_from_templates --platforms-dir /home/jcerny/work/git/scap-security-guide/build/rhel9/platforms --cpe-items-dir /home/jcerny/work/git/scap-security-guide/build/rhel9/cpe_items && /usr/bin/cmake -E touch /home/jcerny/work/git/scap-security-guide/build/rhel9/collect-remediations-rhel9
Traceback (most recent call last):
  File "/home/jcerny/work/git/scap-security-guide/build-scripts/collect_remediations.py", line 115, in collect_remediations
    process_remediation(
  File "/home/jcerny/work/git/scap-security-guide/build-scripts/collect_remediations.py", line 95, in process_remediation
    fix = remediation.process(remediation_obj, env_yaml, cpe_platforms)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/jcerny/work/git/scap-security-guide/ssg/build_remediations.py", line 186, in process
    raise RuntimeError(
RuntimeError: The '/home/jcerny/work/git/scap-security-guide/linux_os/guide/system/selinux/selinux_state/bash/shared.sh' remediation script does not contain the platform identifier!

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/jcerny/work/git/scap-security-guide/build-scripts/collect_remediations.py", line 160, in <module>
    main()
  File "/home/jcerny/work/git/scap-security-guide/build-scripts/collect_remediations.py", line 153, in main
    collect_remediations(
  File "/home/jcerny/work/git/scap-security-guide/build-scripts/collect_remediations.py", line 121, in collect_remediations
    raise RuntimeError(msg)
RuntimeError: Failed to dispatch bash remediation for selinux_state: The '/home/jcerny/work/git/scap-security-guide/linux_os/guide/system/selinux/selinux_state/bash/shared.sh' remediation script does not contain the platform identifier!
ninja: build stopped: subcommand failed.