Skip to content

Cleanup codeql optional markdown #31

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
jfrogdixit merged 1 commit into from
Jun 30, 2025
+4 −19
Merged

Cleanup codeql optional markdown #31

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
2 changes: 1 addition & 1 deletion .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ updates:
- package-ecosystem: "pip"
directory: "/examples/dependabot"
schedule:
interval: "daily"
interval: "monthly"
21 changes: 3 additions & 18 deletions examples/codeql/sarif_to_markdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,13 @@
class SeverityFormatter:
"""Handles severity-related formatting and conversions."""

EMOJI_MAP = {
'error': '🔴',
'warning': '🟡',
'note': '🔵',
'none': '⚪'
}

CVSS_RANGES = [
(9.0, 'Critical'),
(7.0, 'High'),
(4.0, 'Medium'),
(0.0, 'Low')
]

@classmethod
def get_emoji(cls, level: str) -> str:
return cls.EMOJI_MAP.get(level.lower(), cls.EMOJI_MAP['none'])

@classmethod
def get_cvss_rating(cls, security_severity: Any) -> str:
if not security_severity:
Expand All @@ -62,7 +51,7 @@ def add_header(self) -> None:
codeql_version = tool_info.get('version', 'unknown')

self.sections.extend([
"# 🔍 CodeQL Security Analysis Report",
"# CodeQL Security Analysis Report",
"\n## Scan Details",
f"**Scan Type**: CodeQL Static Analysis\n",
f"**Scan Date**: {datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S UTC')}\n",
Expand Down Expand Up @@ -127,8 +116,7 @@ def add_summary(self) -> None:

for severity in ['error', 'warning', 'note', 'none']:
count = severity_count.get(severity, 0)
emoji = self.formatter.get_emoji(severity)
self.sections.append(f"- {emoji} **{severity.title()}**: {count}")
self.sections.append(f"- **{severity.title()}**: {count}")


def add_query_info(self) -> None:
Expand All @@ -151,8 +139,6 @@ def add_query_info(self) -> None:
self.sections.append(f"- **CVSS Score**: {cvss}")

severity = properties.get('problem.severity', 'none')
emoji = self.formatter.get_emoji(severity)
self.sections.append(f"- **Severity**: {emoji} {severity.title()}")

if 'tags' in properties:
tags = ', '.join(f'`{tag}`' for tag in properties['tags'])
Expand Down Expand Up @@ -184,12 +170,11 @@ def add_findings(self) -> None:
rule_severity = rule.get('properties', {}).get('problem.severity', 'none')
severity = result.get('level', rule_severity)

emoji = self.formatter.get_emoji(severity)
location = self._format_location(result.get('locations', []))
message = result.get('message', {}).get('text', 'No description available')

self.sections.append(
f"| {emoji} {severity.title()} | {rule_name} | {location} | {message} |"
f"| {severity.title()} | {rule_name} | {location} | {message} |"
)
def _format_location(self, locations: List[Dict]) -> str:
if not locations:
Expand Down