fix: improve Git info extraction and error handling in analyze function #60

Perdiga · 2025-07-17T19:06:10Z

No description provided.

…l and poethepoet

…nch in GitInfo

…tils

…g and improved logic

…ethod signature

…_files method

…ethod

Copilot

Pull Request Overview

This PR refactors Git information extraction and improves error handling in the analyze function. The main purpose is to improve the robustness of Git operations by switching from subprocess-based Git commands to using the GitPython library and restructuring the CLI architecture with proper separation of concerns.

Key changes include:

Replacement of subprocess-based Git operations with GitPython library for more reliable Git integration
Restructuring of the CLI module from a single file to a proper package structure with separate command modules
Enhancement of error handling in CodeQL installation process with fallback mechanisms

Reviewed Changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/codeql_wrapper/infrastructure/language_detector.py	Simplifies parameter types by removing Union[str, Path] and using Path directly
src/codeql_wrapper/infrastructure/git_utils.py	Major refactor to use GitPython instead of subprocess calls for Git operations
src/codeql_wrapper/infrastructure/codeql_installer.py	Improves error handling with fallback version when GitHub API fails
src/codeql_wrapper/entrypoints/cli/install.py	New dedicated install command module with improved user feedback
src/codeql_wrapper/entrypoints/cli/cli.py	New main CLI entry point with proper command registration
src/codeql_wrapper/entrypoints/cli/analyze.py	New dedicated analyze command module with comprehensive validation
src/codeql_wrapper/entrypoints/cli/init.py	Package initialization for CLI entrypoints
src/codeql_wrapper/entrypoints/init.py	Package initialization for entrypoints
src/codeql_wrapper/domain/use_cases/sarif_upload_use_case.py	Removes GitHub authentication stdin parameter from command
src/codeql_wrapper/domain/use_cases/codeql_analysis_use_case.py	Updates Git integration to use new GitUtils class and improves project detection logic
src/codeql_wrapper/domain/entities/codeql_analysis.py	Makes git_info a required field and reorders imports
src/codeql_wrapper/cli.py	Removes legacy monolithic CLI file
src/codeql_wrapper/main.py	Updates import path to new CLI structure
pyproject.toml	Updates dependencies and script entry points for new CLI structure

Comments suppressed due to low confidence (3)

src/codeql_wrapper/infrastructure/git_utils.py:141

[nitpick] The error message could be more specific about what type of ref is expected and provide examples of valid environment variables.

            raise Exception("No ref provided or found in environment variables")

src/codeql_wrapper/infrastructure/git_utils.py:166

[nitpick] Similar to the previous error message, this could be more descriptive about what constitutes a valid base_ref and list the environment variables that are checked.

            raise Exception("No base_ref provided or found in environment variables")

src/codeql_wrapper/infrastructure/codeql_installer.py:160

[nitpick] The error message could be more helpful by suggesting how to install CodeQL or providing a link to installation instructions.

            raise Exception("CodeQL is not installed")

Copilot · 2025-07-21T21:18:55Z

src/codeql_wrapper/infrastructure/git_utils.py

+            repository=self.repo.remotes.origin.url.split("/")[-2]
+            + "/"
+            + self.repo.remotes.origin.url.split("/")[-1].replace(".git", ""),


The repository name extraction using string splitting is fragile and could fail with different URL formats. Consider using urllib.parse or a more robust URL parsing method.

Suggested change

repository=self.repo.remotes.origin.url.split("/")[-2]

+ "/"

+ self.repo.remotes.origin.url.split("/")[-1].replace(".git", ""),

repository=self._extract_repository_name(self.repo.remotes.origin.url),

Copilot · 2025-07-21T21:18:56Z

src/codeql_wrapper/entrypoints/cli/install.py

+            instalation_message = (
+                f"CodeQL is already installed (version: {current_version})"
+            )
+        else:
+            instalation_message = f"CodeQL {installed_version} installed successfully!"
+
+        click.echo(
+            click.style("SUCCESS:", fg="green", bold=True) + f" {instalation_message}"


There is a spelling error: 'instalation_message' should be 'installation_message'.

Suggested change

instalation_message = (

f"CodeQL is already installed (version: {current_version})"

)

else:

instalation_message = f"CodeQL {installed_version} installed successfully!"

click.echo(

click.style("SUCCESS:", fg="green", bold=True) + f" {instalation_message}"

installation_message = (

f"CodeQL is already installed (version: {current_version})"

)

else:

installation_message = f"CodeQL {installed_version} installed successfully!"

click.echo(

click.style("SUCCESS:", fg="green", bold=True) + f" {installation_message}"

Copilot · 2025-07-21T21:18:56Z

src/codeql_wrapper/infrastructure/git_utils.py

+                origin.set_url(
+                    (
+                        f"https://x-access-token:{os.getenv('GITHUB_TOKEN')}"
+                        f"@github.com/{origin.url.split('/')[-2]}/"
+                        f"{origin.url.split('/')[-1]}"
+                    )
+                )


Setting Git remote URL with authentication token in the URL could expose the token in Git logs or error messages. Consider using Git credential helpers or other secure authentication methods.

Copilot · 2025-07-21T21:18:56Z

src/codeql_wrapper/domain/use_cases/codeql_analysis_use_case.py

                for config_index, project in enumerate(projects_config):
-                    project_path = Path(project.get("path", ""))
+                    project_path = Path(
+                        request.git_info.working_dir, project.get("path", "")


Using request.git_info.working_dir as the base path may cause issues if the working directory differs from the repository path. This could lead to incorrect project paths being constructed.

Suggested change

request.git_info.working_dir, project.get("path", "")

request.repository_path, project.get("path", "")

fix: improve Git info extraction and error handling in analyze function

2291f90

Copilot AI review requested due to automatic review settings July 17, 2025 19:06

This comment was marked as outdated.

Sign in to view

fix lint

c828152

Perdiga temporarily deployed to release July 17, 2025 19:11 — with GitHub Actions Inactive

Perdiga added 4 commits July 17, 2025 17:18

refector git diff

39d6868

fix: refactor get_git_info to store and log GitInfo before returning

c90489f

fix lint

dc68830

feat: update Python version to 3.9 and add new dependencies for paste…

a7950ab

…l and poethepoet

Perdiga temporarily deployed to release July 17, 2025 20:31 — with GitHub Actions Inactive

Perdiga added 2 commits July 17, 2025 17:52

fix: enable search for parent directories when initializing Repo

09873d3

fix: remove unnecessary whitespace in GitUtils initialization

db668e7

Perdiga temporarily deployed to release July 17, 2025 20:56 — with GitHub Actions Inactive

fix: update logic for handling changed files and set default base bra…

ea94923

…nch in GitInfo

Perdiga temporarily deployed to release July 17, 2025 21:33 — with GitHub Actions Inactive

Perdiga added 3 commits July 17, 2025 18:41

fix: add debug logging for repository path in GitUtils initialization

a45c616

fix: improve initialization and handling of current reference in GitU…

1ed10be

…tils

fix: lint

5678e90

Perdiga temporarily deployed to release July 17, 2025 21:58 — with GitHub Actions Inactive

fix: enhance fetch_repo logic and add debug logging for local references

9557151

Perdiga temporarily deployed to release July 17, 2025 22:28 — with GitHub Actions Inactive

Perdiga added 2 commits July 17, 2025 19:37

fix: comment out fetch logic in fetch_repo method

965d9e0

fix: refactor is_pr method to improve remote PR detection

a263223

Perdiga temporarily deployed to release July 17, 2025 22:58 — with GitHub Actions Inactive

fernandomatsuosantos added 2 commits July 17, 2025 20:16

fix: enhance get_diff_files and fetch_repo methods with error handlin…

1c0db57

…g and improved logic

fix: improve logging format in get_diff_files and update fetch_repo m…

f6a4937

…ethod signature

fernandosantos-br temporarily deployed to release July 17, 2025 23:53 — with GitHub Actions Inactive

fix: add logging for changed files in CodeQL analysis use case

ff02c90

Perdiga temporarily deployed to release July 18, 2025 00:24 — with GitHub Actions Inactive

Perdiga temporarily deployed to release July 18, 2025 00:29 — with GitHub Actions Inactive

fix: add debug logging for project comparison in _project_has_changed…

c53de49

…_files method

fernandosantos-br temporarily deployed to release July 18, 2025 00:42 — with GitHub Actions Inactive

fix: resolve project path using repository path in _detect_projects m…

f81510d

…ethod

fernandosantos-br temporarily deployed to release July 18, 2025 00:52 — with GitHub Actions Inactive

Perdiga added 2 commits July 17, 2025 22:18

fix: fix monorepo relative path

35fe898

fix lint

5e0fd23

Perdiga temporarily deployed to release July 18, 2025 01:20 — with GitHub Actions Inactive

Perdiga temporarily deployed to release July 18, 2025 01:32 — with GitHub Actions Inactive

Perdiga temporarily deployed to release July 18, 2025 01:34 — with GitHub Actions Inactive

Changed files filtering is enabled but no base o

cf6b83e

Perdiga temporarily deployed to release July 18, 2025 01:38 — with GitHub Actions Inactive

Perdiga added 3 commits July 21, 2025 11:12

cli refactor

9362a6c

fix upload sarif with wrong ref

0f7fc5e

Fix lint issues

4b9c4a7

Perdiga temporarily deployed to release July 21, 2025 14:38 — with GitHub Actions Inactive

improve how to handle ref and base ref

39ca5ca

Perdiga temporarily deployed to release July 21, 2025 19:08 — with GitHub Actions Inactive

Perdiga added 3 commits July 21, 2025 16:45

fix ref and base ref

3847ee2

fix lint

083e98a

add token to the url before fetch

b8cba37

Perdiga temporarily deployed to release July 21, 2025 20:13 — with GitHub Actions Inactive

fix logic when ref is a pull request

56eea8e

Perdiga temporarily deployed to release July 21, 2025 21:01 — with GitHub Actions Inactive

Perdiga requested a review from Copilot July 21, 2025 21:17

Improve get_git_info debug logs

6855c54

Copilot AI reviewed Jul 21, 2025

View reviewed changes

fix lint issues

a085680

Perdiga merged commit 8fcfd41 into main Jul 21, 2025
2 checks passed

fernandosantos-br deleted the feature/only-changed-files branch July 22, 2025 18:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: improve Git info extraction and error handling in analyze function #60

fix: improve Git info extraction and error handling in analyze function #60

Uh oh!

Perdiga commented Jul 17, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 21, 2025

Uh oh!

Copilot AI Jul 21, 2025

Uh oh!

Copilot AI Jul 21, 2025

Uh oh!

Copilot AI Jul 21, 2025

Uh oh!

Uh oh!

Uh oh!

	request.git_info.working_dir, project.get("path", "")
	request.repository_path, project.get("path", "")

fix: improve Git info extraction and error handling in analyze function #60

fix: improve Git info extraction and error handling in analyze function #60

Uh oh!

Conversation

Perdiga commented Jul 17, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!