Skip to content

fix: Add missing comparator for VulnerabilityAnalysis #812

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 2 commits into from
May 10, 2025
Merged

fix: Add missing comparator for VulnerabilityAnalysis #812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00fd744
Add test for VulnerabilityAnalysis sorting
May 9, 2025
ce25586
Add missing VulnerabilityAnalysis comparator for sorting
May 9, 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
5 changes: 5 additions & 0 deletions cyclonedx/model/vulnerability.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,11 @@ def __eq__(self, other: object) -> bool:
return self.__comparable_tuple() == other.__comparable_tuple()
return False

def __lt__(self, other: Any) -> bool:
if isinstance(other, VulnerabilityAnalysis):
return self.__comparable_tuple() < other.__comparable_tuple()
return NotImplemented

def __hash__(self) -> int:
return hash(self.__comparable_tuple())

Expand Down
29 changes: 28 additions & 1 deletion tests/test_model_vulnerability.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,18 @@
from unittest import TestCase

from cyclonedx.model import XsUri
from cyclonedx.model.impact_analysis import ImpactAnalysisAffectedStatus
from cyclonedx.model.impact_analysis import (
ImpactAnalysisAffectedStatus,
ImpactAnalysisJustification,
ImpactAnalysisResponse,
ImpactAnalysisState,
)
from cyclonedx.model.vulnerability import (
BomTarget,
BomTargetVersionRange,
Vulnerability,
VulnerabilityAdvisory,
VulnerabilityAnalysis,
VulnerabilityRating,
VulnerabilityReference,
VulnerabilityScoreSource,
Expand Down Expand Up @@ -334,3 +340,24 @@ def test_sort(self) -> None:
sorted_targets = sorted(targets)
expected_targets = reorder(targets, expected_order)
self.assertListEqual(sorted_targets, expected_targets)


class TestModelVulnerabilityAnalysis(TestCase):

def test_sort(self) -> None:
# expected sort order: ([state], [justification], [responses], [detail], [first_issued], [last_updated])
expected_order = [3, 1, 0, 2, 5, 4]
analyses = [
VulnerabilityAnalysis(state=ImpactAnalysisState.EXPLOITABLE),
VulnerabilityAnalysis(state=ImpactAnalysisState.EXPLOITABLE,
responses=[ImpactAnalysisResponse.CAN_NOT_FIX]),
VulnerabilityAnalysis(state=ImpactAnalysisState.NOT_AFFECTED,
justification=ImpactAnalysisJustification.CODE_NOT_PRESENT),
VulnerabilityAnalysis(state=ImpactAnalysisState.EXPLOITABLE,
justification=ImpactAnalysisJustification.REQUIRES_ENVIRONMENT),
VulnerabilityAnalysis(first_issued=datetime(2024, 4, 4), last_updated=datetime(2025, 5, 5)),
VulnerabilityAnalysis(first_issued=datetime(2023, 3, 3), last_updated=datetime(2023, 3, 3)),
]
sorted_analyses = sorted(analyses)
expected_analyses = reorder(analyses, expected_order)
self.assertListEqual(sorted_analyses, expected_analyses)