Skip to content

Fix base_ref retrieval in GitUtils for better pull request handling #76

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
fernandosantos-br merged 4 commits into from
Jul 23, 2025
Merged

Fix base_ref retrieval in GitUtils for better pull request handling #76

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fd8898c
Fix base_ref retrieval in GitUtils for better pull request handling
fernandomatsuosantos Jul 23, 2025
cefb4f5
Remove unnecessary debug logging for missing base_ref in GitUtils
fernandomatsuosantos Jul 23, 2025
5e9b77a
Enhance base_ref retrieval in GitUtils for Azure Pipelines and other …
fernandomatsuosantos Jul 23, 2025
bcf256a
Fix environment variable names for Azure Pipelines in GitUtils
fernandomatsuosantos Jul 23, 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
67 changes: 41 additions & 26 deletions src/codeql_wrapper/infrastructure/git_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def get_git_info(
+ self.repo.remotes.origin.url.split("/")[-1].replace(".git", ""),
commit_sha=commit_sha,
current_ref=current_ref_resolved,
base_ref=self.get_base_ref(base_ref),
base_ref=self.get_base_ref(base_ref, current_ref_resolved),
remote_url=self.repo.remotes.origin.url,
is_git_repository=True,
working_dir=Path(self.repo.working_dir),
Expand Down Expand Up @@ -183,14 +183,19 @@ def get_git_ref(self, current_ref: Optional[str]) -> str:
self.logger.debug("Using provided current_ref")
ref = current_ref
elif os.getenv("GITHUB_REF"):
# GITHUB
self.logger.debug("Using GITHUB_REF environment variable")
ref = os.getenv("GITHUB_REF")
elif os.getenv("CI_COMMIT_REF_NAME"):
self.logger.debug("Using CI_COMMIT_REF_NAME environment variable")
ref = os.getenv("CI_COMMIT_REF_NAME")
elif os.getenv("BITBUCKET_BRANCH"):
self.logger.debug("Using BITBUCKET_BRANCH environment variable")
ref = os.getenv("BITBUCKET_BRANCH")
elif os.getenv("DRONE_PULL_REQUEST"):
# HARNESS
self.logger.debug("Using DRONE_PULL_REQUEST environment variable")
drone_pr = os.getenv("DRONE_PULL_REQUEST")
ref = f"refs/pull/{drone_pr}/merge"
self.logger.debug(f"Constructed Drone PR ref: {ref}")
elif os.getenv("BUILD_SOURCEBRANCH"):
# AZURE PIPELINES
self.logger.debug("Using BUILD_SOURCEBRANCH environment variable")
ref = os.getenv("BUILD_SOURCEBRANCH")
elif not self.repo.head.is_detached:
self.logger.debug("Using repository metadata (Not Detached HEAD state)")
ref = self.repo.head.ref.path
Expand All @@ -200,29 +205,39 @@ def get_git_ref(self, current_ref: Optional[str]) -> str:

return ref

def get_base_ref(self, base_ref: Optional[str] = None) -> Optional[str]:
def get_base_ref(
self, base_ref: Optional[str] = None, current_ref: Optional[str] = None
) -> Optional[str]:
ref = None

if base_ref:
self.logger.debug("Using provided base_ref")
ref = base_ref
elif os.getenv("GITHUB_BASE_REF"):
self.logger.debug("Using GITHUB_BASE_REF environment variable")
ref = os.getenv("GITHUB_BASE_REF")
elif os.getenv("CI_MERGE_REQUEST_TARGET_BRANCH_NAME"):
self.logger.debug(
"Using CI_MERGE_REQUEST_TARGET_BRANCH_NAME environment variable"
)
ref = os.getenv("CI_MERGE_REQUEST_TARGET_BRANCH_NAME")
elif os.getenv("BITBUCKET_PR_DESTINATION_BRANCH"):
self.logger.debug(
"Using BITBUCKET_PR_DESTINATION_BRANCH environment variable"
)
ref = os.getenv("BITBUCKET_PR_DESTINATION_BRANCH")

if ref is None:
self.logger.debug(
"No base_ref provided or found in environment variables - will analyze all files"
)
elif current_ref and current_ref.startswith("refs/pull/"):
# For pull request events
if os.getenv("GITHUB_BASE_REF"):
# GITHUB
self.logger.debug("Using GITHUB_BASE_REF environment variable")
get_base_ref = os.getenv("GITHUB_BASE_REF")
ref = f"origin/{get_base_ref}"
self.logger.debug(f"base_ref: {ref}")
elif os.getenv("DRONE_TARGET_BRANCH"):
# HARNESS
self.logger.debug("Using DRONE_TARGET_BRANCH environment variable")
get_base_ref = os.getenv("DRONE_TARGET_BRANCH")
ref = f"origin/{get_base_ref}"
self.logger.debug(f"base_ref: {ref}")
elif os.getenv("SYSTEM_PULLREQUEST_TARGETBRANCHNAME"):
# AZURE PIPELINES
self.logger.debug(
"Using SYSTEM_PULLREQUEST_TARGETBRANCHNAME environment variable"
)
get_base_ref = os.getenv("SYSTEM_PULLREQUEST_TARGETBRANCHNAME")
ref = f"origin/{get_base_ref}"
self.logger.debug(f"base_ref: {ref}")
else:
# For push events
self.logger.debug("Using HEAD^ as base_ref")
ref = "HEAD^"

return ref
Loading