Skip to content

include omitted evaluation detail to reports #684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 15, 2025
Merged

include omitted evaluation detail to reports #684

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b23a90d
include omitted evaluation detail to reports
isabella-mont Apr 22, 2025
01a06aa
Added OmittedEvaluation Information to JSON
isabella-mont Apr 23, 2025
7faae7a
Added OmittedEvaluation Information to JSON
isabella-mont Apr 23, 2025
306b3bb
Corrected Trailing Whitespace
isabella-mont Apr 23, 2025
bfc5b5f
Merge remote-tracking branch 'origin/main' into 520-omitted-rego
isabella-mont Apr 30, 2025
6a24890
Added Blank Field for Omitted Values for failure
isabella-mont May 5, 2025
b7c20c0
Reverted orchestrator.py to match main
isabella-mont May 5, 2025
11feac0
Removed Omit from summary stats
isabella-mont May 6, 2025
4db0feb
Removed OmittedEvaluationResult and OmittedEvaluationDetails from report
isabella-mont May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 34 additions & 6 deletions scubagoggles/reporter/reporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,22 +543,40 @@ def rego_json_to_ind_reports(self,
'Requirement': requirement,
'Result': 'Error - Test results missing',
'Criticality': '-',
'Details': f'Report issue on {issues_link}'})
'Details': f'Report issue on {issues_link}',
'OmittedEvaluationResult': 'N/A',
'OmittedEvaluationDetails': 'N/A'
})
log.error('No test results found for Control Id %s',
control_id)
continue

if self._is_control_omitted(control_id):
# Handle the case where the control was omitted
report_stats['Omit'] += 1
rationale = self._get_omission_rationale(control_id)

omitted_result = 'N/A'
omitted_details = 'N/A'

for test in tests:
result = self._get_test_result(test['RequirementMet'],
test['Criticality'],
test['NoSuchEvent'])
details = test['ReportDetails']
omitted_result = result
omitted_details = details

table_data.append({
'Control ID': control_id,
'Requirement': requirement,
'Result': 'Omitted',
'Criticality': tests[0]['Criticality'],
'Details': f'Test omitted by user. {rationale}'
'Details': f'Test omitted by user. {rationale}',
'OmittedEvaluationResult': omitted_result,
'OmittedEvaluationDetails': omitted_details
})
continue

for test in tests:
failed_prereqs = self._get_failed_prereqs(test)
if len(failed_prereqs) > 0:
Expand All @@ -569,7 +587,9 @@ def rego_json_to_ind_reports(self,
'Requirement': requirement,
'Result': 'Error',
'Criticality': test['Criticality'],
'Details': failed_details})
'Details': failed_details,
'OmittedEvaluationResult': 'N/A',
'OmittedEvaluationDetails': 'N/A'})
continue

if control_id.startswith('GWS.COMMONCONTROLS.13.1'):
Expand All @@ -594,7 +614,9 @@ def rego_json_to_ind_reports(self,
'Requirement': requirement,
'Result': result,
'Criticality': test['Criticality'],
'Details': details})
'Details': details,
'OmittedEvaluationResult': 'N/A',
'OmittedEvaluationDetails': 'N/A'})
markdown_group_name = '-'.join(baseline_group['GroupName'].split())
group_reference_url = (f'{self._github_url}/blob/{Version.current}/'
f'scubagoggles/baselines/{product}.md'
Expand All @@ -606,7 +628,13 @@ def rego_json_to_ind_reports(self,
fragments.append(f'<h2>{product_upper}-'
f'{baseline_group["GroupNumber"]} '
f'{markdown_link}</h2>')
fragments.append(self.create_html_table(table_data))

filtered_table_data = [
{k: v for k, v in row.items()
if k not in ('OmittedEvaluationResult', 'OmittedEvaluationDetails')}
for row in table_data
]
fragments.append(self.create_html_table(filtered_table_data))
results_data.update({'GroupName': baseline_group['GroupName']})
results_data.update({'GroupNumber': baseline_group['GroupNumber']})
results_data.update({'GroupReferenceURL': group_reference_url})
Expand Down