Draft: just for test and troubleshoot an error - will close it
Description
Recommendation
Requester
-
If this change modifies benchmark functions: - The function:
-
Name matches the name
of the yaml recommendation -
Returns a dict
containing:-
True
orFalse
(if the check passed/failed) -
None
for skipped checks - a
str
with the reason why (e.g.{None: 'This check requires validation'}
)
-
-
The docstring
contains the id and title of the recommendation to check
-
- Limitations:
-
Any limitations for the function are added to docs/limitations.md
-
- If this change modifies recommendations:
-
Ensure approval from CODEOWNERS
is obtained
-
- The function:
-
All unit tests pass before requesting review -
Remove Draft phase from the MR
Reviewer
-
If this change modifies benchmark functions: -
The function(s) satisfy the recommendation (see the audit
section in the yaml file)- i.e. does this function address the recommendation benchmark check
-
-
All tests have passed successfully
Local validation
To validate changes to benchmark functions for this merge request, follow the below:
validation steps
Clone the repo:
git clone git@gitlab.com:gitlab-com/gl-security/security-operations/sirt/automation/cis-benchmark-scanner.git
cd cis-benchmark-scanner
Checkout into the merge request branch:
git checkout $branchRequestingToMerge
Install the version in the merge request:
make
make install
Validate the function(s) against a project:
gitlabcis https://gitlab.example.com/path/to/project
To test a single benchmark functon:
gitlabcis https://gitlab.example.com/path/to/project \
-ids 1.1.1 1.1.2
Edited by Mitra Jozenazemian