Skip to content
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

Jump to bottom

Explain the calculation of the score #200

Merged
merged 3 commits into from
Jul 18, 2023
Merged

Explain the calculation of the score #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a50db8
Parse system attribute from score element
Honny1 Jul 3, 2023
d7478ee
Add explanation of score computation
Honny1 Jul 3, 2023
ecf3bc5
Show explanation of score computation in report
Honny1 Jul 3, 2023
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
5 changes: 5 additions & 0 deletions openscap_report/report_generators/html_templates/css/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,11 @@ footer {
max-width: fit-content;
}

.tooltip-box-score-position {
top: 8px !important;
left: 102px !important;
}

.clickable-element {
text-decoration: underline dotted;
}
Expand Down
8 changes: 7 additions & 1 deletion openscap_report/report_generators/html_templates/template_report.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,14 @@ <h2 class="pf-c-title pf-m-2xl">Severity of failed rules</h2>
{% endif %}
</div>
<br>
<div class="tooltip-wrapper" style="position: relative;">
<h2 class="pf-c-title pf-m-2xl">Score&nbsp;<i class="pf-icon pf-icon-help" aria-hidden="true"></i></h2>
<div class="pf-c-tooltip pf-m-right-top tooltip-box-right-side tooltip-box-score-position" role="tooltip">
<div class="pf-c-tooltip__arrow"></div>
<div class="pf-c-tooltip__content tooltip__content-width">{{ report.scan_result.get_explanation_of_score_computation() }}</div>
</div>
</div>

<h2 class="pf-c-title pf-m-2xl">Score</h2>
{% include 'score_bar.html' %}
<br>

Expand Down
31 changes: 31 additions & 0 deletions openscap_report/scap_results_parser/data_structures/result_of_scan.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,37 @@
"start_time",
"end_time",
"test_system",
"score_system",
"score",
"score_max",
]

SCORE_COMPUTATION_EXPLANATIONS = {
"urn:xccdf:scoring:default": (
"The default model score computation algorithm simply computes a normalized weighted sum "
"at each tree node, omitting Rules and Groups that are not selected, and Groups that have "
"no selected Rules under them. (Visualization of Groups in report is not implemented yet.)"
),
"urn:xccdf:scoring:flat": (
"The flat model simply computes the sum of the weights for the Rules that passed "
"as the score, and the sum of the weights of all the applicable Rules as "
"the maximum possible score. This model is simple and easy to compute, "
"but scores between different target systems may not be directly comparable "
"because the maximum score can vary."
),
"urn:xccdf:scoring:flat-unweighted": (
"The flat unweighted model simply computes the sum of the Rules that passed as the score, "
"and the sum of all the applicable Rules as the maximum possible score. This model is "
"simple and easy to compute, but scores between different target systems may not be "
"directly comparable because the maximum score can vary."
),
"urn:xccdf:scoring:absolute": (
"The absolute model gives a score of 1 only when all applicable rules "
"in the benchmark pass. It is computed by applying the Flat Model "
"and returning 1 if s==m, and 0 otherwise."
)
}


@dataclass
class ResultOfScan: # pylint: disable=R0902
Expand All @@ -38,8 +65,12 @@ class ResultOfScan: # pylint: disable=R0902
start_time: str = ""
end_time: str = ""
test_system: str = ""
score_system: str = ""
score: float = 0.0
score_max: float = 0.0

def as_dict(self):
return asdict(self)

def get_explanation_of_score_computation(self):
return SCORE_COMPUTATION_EXPLANATIONS[self.score_system]
1 change: 1 addition & 0 deletions openscap_report/scap_results_parser/parsers/scan_result_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ def get_test_result(self):
"start_time": self.test_results_el.get("start-time"),
"end_time": self.test_results_el.get("end-time"),
"test_system": self.test_results_el.get("test-system"),
"score_system": score_el.get("system"),
"score": float(score_el.text),
"score_max": float(score_el.get("maximum")),
"benchmark_url": self.benchmark_el.get("href"),
Expand Down