From 0d91d4e5841e0c44bfe5964092c0c9121d725e26 Mon Sep 17 00:00:00 2001 From: Srijan Saurav Date: Fri, 13 Sep 2024 09:38:05 +0530 Subject: [PATCH 1/4] add logs for sanitised issue count and issue map --- run_community_analyzer.py | 1 + sarif-parser/src/sarif_parser/__init__.py | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/run_community_analyzer.py b/run_community_analyzer.py index b6ab0acb..8a761e22 100644 --- a/run_community_analyzer.py +++ b/run_community_analyzer.py @@ -69,6 +69,7 @@ def main(argv: list[str] | None = None) -> None: args = parser.parse_args(argv, namespace=CommunityAnalyzerArgs) # analyzer name is mandatory in case of community analyzers but not custom analyzers if analyzer_name := args.analyzer: + logger.info("Fetching issue map for: %s", analyzer_name) issue_map_path = get_issue_map(analyzer_name) modified_files = get_files_to_analyze(code_path) diff --git a/sarif-parser/src/sarif_parser/__init__.py b/sarif-parser/src/sarif_parser/__init__.py index 8f55099e..84518899 100644 --- a/sarif-parser/src/sarif_parser/__init__.py +++ b/sarif-parser/src/sarif_parser/__init__.py @@ -57,6 +57,7 @@ def parse( deepsource_issues: list[Issue] = [] total_report_issues = 0 + issue_count_in_issues_map = 0 for run in sarif_data["runs"]: total_report_issues += len(run["results"]) for issue in run["results"]: @@ -122,8 +123,10 @@ def parse( logger.info( "Total issues in SARIF report: %s. \n" "Issues extracted for the run in files sent for analysis: %s", + "Sanitized issues count with IDs in issue map: %s", total_report_issues, len(deepsource_issues), + issue_count_in_issues_map, ) return deepsource_issues @@ -174,6 +177,9 @@ def run_sarif_parser( sentry.raise_info( f"Could not find issue map at {issue_map_path} for analyzer." ) + logger.warning( + "Could not find issue map at %s for analyzer.", issue_map_path + ) # Run parser deepsource_issues = [] From e0f3e9cede0421d0bbdef4955a40ef623038c359 Mon Sep 17 00:00:00 2001 From: "deepsource-autofix[bot]" <62050782+deepsource-autofix[bot]@users.noreply.github.com> Date: Fri, 13 Sep 2024 04:09:19 +0000 Subject: [PATCH 2/4] style: format code with Black and isort This commit fixes the style issues introduced in 0d91d4e according to the output from Black and isort. Details: https://github.com/DeepSourceCorp/community-analyzers/pull/35 --- sarif-parser/src/sarif_parser/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/sarif-parser/src/sarif_parser/__init__.py b/sarif-parser/src/sarif_parser/__init__.py index 84518899..1ce30291 100644 --- a/sarif-parser/src/sarif_parser/__init__.py +++ b/sarif-parser/src/sarif_parser/__init__.py @@ -1,4 +1,5 @@ """sarif-parser - Parse SARIF reports and covert them to DeepSource issues.""" + from __future__ import annotations import hashlib From 83fbc9b84d5905ef1ee83dc9296048a2f62f6bf6 Mon Sep 17 00:00:00 2001 From: Srijan Saurav Date: Fri, 13 Sep 2024 09:41:24 +0530 Subject: [PATCH 3/4] fix logger call --- sarif-parser/src/sarif_parser/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sarif-parser/src/sarif_parser/__init__.py b/sarif-parser/src/sarif_parser/__init__.py index 1ce30291..7e2bb16e 100644 --- a/sarif-parser/src/sarif_parser/__init__.py +++ b/sarif-parser/src/sarif_parser/__init__.py @@ -123,8 +123,8 @@ def parse( logger.info( "Total issues in SARIF report: %s. \n" - "Issues extracted for the run in files sent for analysis: %s", - "Sanitized issues count with IDs in issue map: %s", + "Issues extracted for the run in files sent for analysis: %s. \n" + "Sanitized issues count with IDs in issue map: %s.", total_report_issues, len(deepsource_issues), issue_count_in_issues_map, From bc6f0250ae39b5f31a0d92c92bb143e677bca87a Mon Sep 17 00:00:00 2001 From: Srijan Saurav Date: Fri, 13 Sep 2024 12:40:11 +0530 Subject: [PATCH 4/4] fix: remove argv from arguments --- run_community_analyzer.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/run_community_analyzer.py b/run_community_analyzer.py index 8a761e22..40ee6046 100644 --- a/run_community_analyzer.py +++ b/run_community_analyzer.py @@ -51,7 +51,7 @@ def get_files_to_analyze(code_path: str) -> set[str]: } -def main(argv: list[str] | None = None) -> None: +def main() -> None: """Runs the CLI.""" code_path = os.getenv("CODE_PATH", "/code") toolbox_path = os.getenv("TOOLBOX_PATH", "/toolbox") @@ -65,12 +65,12 @@ def main(argv: list[str] | None = None) -> None: help="Which community analyzer to run. Example: 'kube-linter'", required=False, ) - if argv: - args = parser.parse_args(argv, namespace=CommunityAnalyzerArgs) - # analyzer name is mandatory in case of community analyzers but not custom analyzers - if analyzer_name := args.analyzer: - logger.info("Fetching issue map for: %s", analyzer_name) - issue_map_path = get_issue_map(analyzer_name) + args = parser.parse_args(argv, namespace=CommunityAnalyzerArgs) + + # analyzer name is mandatory in case of community analyzers but not custom analyzers + if analyzer_name := args.analyzer: + logger.info("Fetching issue map for: %s", analyzer_name) + issue_map_path = get_issue_map(analyzer_name) modified_files = get_files_to_analyze(code_path) run_sarif_parser(