Populate _rule_id virtual template parameter in Automatus #11943
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Templates have an implicit (virtual) parameter `_rule_id` that
contains rule ID of the currently processed rule. This parameter
is added by the build system and is passed to template preprocessing
function. However, this parameter isn't set in when invoking the
templating subsystem Automatus when resolving templated TSs.
This causes some of the template preprocessing functions to traceback
when testing templated rules in Automatus.
Addressing:
```
Traceback (most recent call last):
File "/home/jcerny/work/git/scap-security-guide/tests/automatus.py", line 518, in <module>
main()
File "/home/jcerny/work/git/scap-security-guide/tests/automatus.py", line 514, in main
options.func(options)
File "/home/jcerny/work/git/scap-security-guide/tests/ssg_test_suite/rule.py", line 676, in perform_rule_check
checker.test_target()
File "/home/jcerny/work/git/scap-security-guide/tests/ssg_test_suite/oscap.py", line 685, in test_target
self._test_target()
File "/home/jcerny/work/git/scap-security-guide/tests/ssg_test_suite/rule.py", line 444, in _test_target
test_content_by_rule_id = self._get_test_content_by_rule_id(
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jcerny/work/git/scap-security-guide/tests/ssg_test_suite/rule.py", line 427, in _get_test_content_by_rule_id
rule_test_content = self._get_rule_test_content(rule)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jcerny/work/git/scap-security-guide/tests/ssg_test_suite/rule.py", line 409, in _get_rule_test_content
all_tests = self._load_all_tests(rule)
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jcerny/work/git/scap-security-guide/tests/ssg_test_suite/rule.py", line 399, in _load_all_tests
templated_tests = common.load_templated_tests(
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jcerny/work/git/scap-security-guide/tests/ssg_test_suite/common.py", line 494, in load_templated_tests
test = load_test(path, template, local_env_yaml)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jcerny/work/git/scap-security-guide/tests/ssg_test_suite/common.py", line 506, in load_test
template_parameters = maybe_template.preprocess(template_vars, "tests")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jcerny/work/git/scap-security-guide/tests/../ssg/templates.py", line 95, in preprocess
parameters = self._preprocess_with_template_module(parameters, lang)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jcerny/work/git/scap-security-guide/tests/../ssg/templates.py", line 112, in _preprocess_with_template_module
parameters = preprocess_mod.preprocess(parameters.copy(), lang)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jcerny/work/git/scap-security-guide/shared/templates/audit_rules_watch/template.py", line 3, in preprocess
data["key"] = data["_rule_id"]
~~~~^^^^^^^^^^^^
KeyError: '_rule_id'
```
Fixes: ComplianceAsCode#11940
jan-cerny
added
the
productization-issue
|
Start a new ephemeral environment with changes proposed in this pull request: Fedora Environment Oracle Linux 8 Environment |
|
🤖 A k8s content image for this PR is available at: Click here to see how to deploy itIf you alread have Compliance Operator deployed: Otherwise deploy the content and operator together by checking out ComplianceAsCode/compliance-operator and: |
|
Code Climate has analyzed commit 8df9cbc and detected 0 issues on this pull request. 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 59.4% (0.0% change). View more on Code Climate. |
Mab879
approved these changes
May 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Templates have an implicit (virtual) parameter
_rule_idthat contains rule ID of the currently processed rule. This parameter is added by the build system and is passed to template preprocessing function. However, this parameter isn't set in when invoking the templating subsystem Automatus when resolving templated TSs. This causes some of the template preprocessing functions to traceback when testing templated rules in Automatus.Addressing:
Fixes: #11940