Skip to content

feat: show alert number in alert list #185

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
jdstrand merged 1 commit into from
Jan 28, 2026
Merged

feat: show alert number in alert list #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 10 additions & 5 deletions cvelib/wizard.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def _checklistItemSortKey(item: str) -> Tuple[str, Tuple[str, int]]:

Sorts first by display name, then by URL with numeric suffix handling.

Example: '- [ ] [axios](https://github.com/.../10) (low)'
Example: '- [ ] [axios (#10)](https://github.com/.../10) (low)'
Returns: ('axios', ('https://github.com/...', 10))
"""
import re
Expand All @@ -78,6 +78,9 @@ def _checklistItemSortKey(item: str) -> Tuple[str, Tuple[str, int]]:
name_match = re.search(r"\] \[([^\]]+)\]", item)
display_name = name_match.group(1) if name_match else ""

# Strip (#number) suffix from display name for sorting purposes
display_name = re.sub(r" \(#\d+\)$", "", display_name)

# Extract and sort URL
url = _extractUrlFromChecklistItem(item)
url_key = _naturalSortKey(url)
Expand Down Expand Up @@ -373,10 +376,12 @@ def _generateIssueDescription(alerts: List[Dict[str, Any]], org: str, repo: str)
):
clauses.append(gh_template_clause_text[alert["type"]])

# Create checklist item
item: str = (
f"- [ ] [{alert['display_name']}]({alert['url']}) ({alert['severity']})"
)
# Create checklist item - extract number from URL if present
display_text: str = alert["display_name"]
url_parts: List[str] = alert["url"].rstrip("/").split("/")
if url_parts and url_parts[-1].isdigit():
display_text = f"{alert['display_name']} (#{url_parts[-1]})"
item: str = f"- [ ] [{display_text}]({alert['url']}) ({alert['severity']})"
if item not in checklist_items:
checklist_items.append(item)

Expand Down
46 changes: 40 additions & 6 deletions tests/test_wizard.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,7 +861,7 @@ def test__generateIssueDescription(self):

# Check key components
self.assertIn("The following alerts were issued:", description)
self.assertIn("- [ ] [github.com/uptrace/bun]", description)
self.assertIn("- [ ] [github.com/uptrace/bun (#86)]", description)
self.assertIn("(medium)", description)
self.assertIn("(low)", description)
self.assertIn("security/medium", description)
Expand Down Expand Up @@ -915,6 +915,40 @@ def test__generateIssueDescription_comprehensive(self):
self.assertIn("(low)", description)
self.assertIn("security/critical", description)

def test__generateIssueDescription_with_number(self):
"""Test generate_issue_description extracts alert number from URL"""
alerts = [
{
"display_name": "lodash",
"severity": "medium",
"type": "dependabot",
"url": "https://github.com/org/repo/security/dependabot/63",
},
{
"display_name": "axios",
"severity": "high",
"type": "dependabot",
"url": "https://github.com/org/repo/security/dependabot/42",
},
{
"display_name": "no-number-pkg",
"severity": "low",
"type": "dependabot",
"url": "https://example.com/no-number-here",
},
]

description = cvelib.wizard._generateIssueDescription(
alerts, "test-org", "test-repo"
)

# Check that numbers extracted from URLs are included in display names
self.assertIn("- [ ] [lodash (#63)]", description)
self.assertIn("- [ ] [axios (#42)]", description)
# URL without numeric suffix should not have (#...) in display
self.assertIn("- [ ] [no-number-pkg]", description)
self.assertNotIn("no-number-pkg (#", description)

def test__generateIssueDescription_sorting(self):
"""Test that checklist items are sorted by display name then URL"""
# Create alerts with various display names and URLs to test sorting
Expand Down Expand Up @@ -968,11 +1002,11 @@ def test__generateIssueDescription_sorting(self):
# 3. Then lodash
# 4. Then zlib
expected_order = [
"- [ ] [axios](https://github.com/org/repo/security/dependabot/1) (medium)",
"- [ ] [axios](https://github.com/org/repo/security/dependabot/2) (low)",
"- [ ] [axios](https://github.com/org/repo/security/dependabot/10) (high)",
"- [ ] [lodash](https://github.com/org/repo/security/dependabot/4) (critical)",
"- [ ] [zlib](https://github.com/org/repo/security/dependabot/3) (high)",
"- [ ] [axios (#1)](https://github.com/org/repo/security/dependabot/1) (medium)",
"- [ ] [axios (#2)](https://github.com/org/repo/security/dependabot/2) (low)",
"- [ ] [axios (#10)](https://github.com/org/repo/security/dependabot/10) (high)",
"- [ ] [lodash (#4)](https://github.com/org/repo/security/dependabot/4) (critical)",
"- [ ] [zlib (#3)](https://github.com/org/repo/security/dependabot/3) (high)",
]

self.assertEqual(checklist_lines, expected_order)
Expand Down