Address checks

Author: Nikolas Philips

gitopscli/git_api/azure_devops_git_repo_api_adapter.py

@@ -2,16 +2,12 @@
 
 from azure.devops.connection import Connection
 from azure.devops.credentials import BasicAuthentication
-from azure.devops.v7_1.git import GitClient
 from azure.devops.v7_1.git.models import (
+    Comment,
     GitPullRequest,
     GitPullRequestCommentThread,
     GitPullRequestCompletionOptions,
-    GitRef,
     GitRefUpdate,
-    GitRefUpdateResult,
-    GitRepository,
-    Comment,
 )
 from msrest.exceptions import ClientException
 
@@ -22,7 +18,7 @@
 
 class AzureDevOpsGitRepoApiAdapter(GitRepoApi):
     """Azure DevOps SDK adapter for GitOps CLI operations."""
-    
+
     def __init__(
         self,
         git_provider_url: str,
@@ -40,10 +36,10 @@ def __init__(
         self.__password = password
         self.__project_name = organisation  # In Azure DevOps, "organisation" param is actually the project
         self.__repository_name = repository_name
-        
+
         if not password:
             raise GitOpsException("Password (Personal Access Token) is required for Azure DevOps")
-        
+
         # Create connection using Basic Authentication with PAT
         credentials = BasicAuthentication(self.__username, password)
         self.__connection = Connection(base_url=self.__base_url, creds=credentials)
@@ -79,36 +75,32 @@ def create_pull_request(
             # Ensure branch names have proper refs/ prefix
             source_ref = from_branch if from_branch.startswith("refs/") else f"refs/heads/{from_branch}"
             target_ref = to_branch if to_branch.startswith("refs/") else f"refs/heads/{to_branch}"
-            
+
             pull_request = GitPullRequest(
                 source_ref_name=source_ref,
                 target_ref_name=target_ref,
                 title=title,
                 description=description,
             )
-            
+
             created_pr = self.__git_client.create_pull_request(
                 git_pull_request_to_create=pull_request,
                 repository_id=self.__repository_name,
                 project=self.__project_name,
             )
-            
-            return GitRepoApi.PullRequestIdAndUrl(
-                pr_id=created_pr.pull_request_id,
-                url=created_pr.url
-            )
-            
+
+            return GitRepoApi.PullRequestIdAndUrl(pr_id=created_pr.pull_request_id, url=created_pr.url)
+
         except ClientException as ex:
             error_msg = str(ex)
             if "401" in error_msg:
                 raise GitOpsException("Bad credentials") from ex
-            elif "404" in error_msg:
+            if "404" in error_msg:
                 raise GitOpsException(
                     f"Repository '{self.__project_name}/{self.__repository_name}' does not exist"
                 ) from ex
-            else:
-                raise GitOpsException(f"Error creating pull request: {error_msg}") from ex
-        except Exception as ex:
+            raise GitOpsException(f"Error creating pull request: {error_msg}") from ex
+        except Exception as ex:  # noqa: BLE001
             raise GitOpsException(f"Error connecting to '{self.__base_url}'") from ex
 
     def merge_pull_request(
@@ -124,7 +116,7 @@ def merge_pull_request(
                 pull_request_id=pr_id,
                 project=self.__project_name,
             )
-            
+
             # Map merge methods to Azure DevOps completion options
             completion_options = GitPullRequestCompletionOptions()
             if merge_method == "squash":
@@ -133,132 +125,134 @@ def merge_pull_request(
                 completion_options.merge_strategy = "rebase"
             else:  # merge
                 completion_options.merge_strategy = "noFastForward"
-                
+
             # Apply any additional merge parameters
             if merge_parameters:
                 for key, value in merge_parameters.items():
                     setattr(completion_options, key, value)
-            
+
             # Update the pull request to complete it
             pr_update = GitPullRequest(
                 status="completed",
                 last_merge_source_commit=pr.last_merge_source_commit,
                 completion_options=completion_options,
             )
-            
+
             self.__git_client.update_pull_request(
                 git_pull_request_to_update=pr_update,
                 repository_id=self.__repository_name,
                 pull_request_id=pr_id,
                 project=self.__project_name,
             )
-            
+
         except ClientException as ex:
             error_msg = str(ex)
             if "401" in error_msg:
                 raise GitOpsException("Bad credentials") from ex
-            elif "404" in error_msg:
+            if "404" in error_msg:
                 raise GitOpsException(f"Pull request with ID '{pr_id}' does not exist") from ex
-            else:
-                raise GitOpsException(f"Error merging pull request: {error_msg}") from ex
-        except Exception as ex:
+            raise GitOpsException(f"Error merging pull request: {error_msg}") from ex
+        except Exception as ex:  # noqa: BLE001
             raise GitOpsException(f"Error connecting to '{self.__base_url}'") from ex
 
-    def add_pull_request_comment(self, pr_id: int, text: str, parent_id: int | None = None) -> None:
+    def add_pull_request_comment(self, pr_id: int, text: str, parent_id: int | None = None) -> None:  # noqa: ARG002
         try:
             comment = Comment(content=text, comment_type="text")
             thread = GitPullRequestCommentThread(
                 comments=[comment],
                 status="active",
             )
-            
+
             # Azure DevOps doesn't support direct reply to comments in the same way as other platforms
             # parent_id is ignored for now
-            
+
             self.__git_client.create_thread(
                 comment_thread=thread,
                 repository_id=self.__repository_name,
                 pull_request_id=pr_id,
                 project=self.__project_name,
             )
-            
+
         except ClientException as ex:
             error_msg = str(ex)
             if "401" in error_msg:
                 raise GitOpsException("Bad credentials") from ex
-            elif "404" in error_msg:
+            if "404" in error_msg:
                 raise GitOpsException(f"Pull request with ID '{pr_id}' does not exist") from ex
-            else:
-                raise GitOpsException(f"Error adding comment: {error_msg}") from ex
-        except Exception as ex:
+            raise GitOpsException(f"Error adding comment: {error_msg}") from ex
+        except Exception as ex:  # noqa: BLE001
             raise GitOpsException(f"Error connecting to '{self.__base_url}'") from ex
 
     def delete_branch(self, branch: str) -> None:
+        def _raise_branch_not_found() -> None:
+            raise GitOpsException(f"Branch '{branch}' does not exist")
+
         try:
             # Get the branch reference first
             refs = self.__git_client.get_refs(
                 repository_id=self.__repository_name,
                 project=self.__project_name,
                 filter=f"heads/{branch}",
             )
-            
+
             if not refs:
-                raise GitOpsException(f"Branch '{branch}' does not exist")
-            
+                _raise_branch_not_found()
+
             branch_ref = refs[0]
-            
+
             # Create ref update to delete the branch
             ref_update = GitRefUpdate(
                 name=f"refs/heads/{branch}",
                 old_object_id=branch_ref.object_id,
                 new_object_id="0000000000000000000000000000000000000000",
             )
-            
+
             self.__git_client.update_refs(
                 ref_updates=[ref_update],
                 repository_id=self.__repository_name,
                 project=self.__project_name,
             )
-            
+
         except GitOpsException:
             # Re-raise GitOpsException without modification
             raise
         except ClientException as ex:
             error_msg = str(ex)
             if "401" in error_msg:
                 raise GitOpsException("Bad credentials") from ex
-            elif "404" in error_msg:
+            if "404" in error_msg:
                 raise GitOpsException(f"Branch '{branch}' does not exist") from ex
-            else:
-                raise GitOpsException(f"Error deleting branch: {error_msg}") from ex
-        except Exception as ex:
+            raise GitOpsException(f"Error deleting branch: {error_msg}") from ex
+        except Exception as ex:  # noqa: BLE001
             raise GitOpsException(f"Error connecting to '{self.__base_url}'") from ex
 
     def get_branch_head_hash(self, branch: str) -> str:
+        def _raise_branch_not_found() -> None:
+            raise GitOpsException(f"Branch '{branch}' does not exist")
+
         try:
             refs = self.__git_client.get_refs(
                 repository_id=self.__repository_name,
                 project=self.__project_name,
                 filter=f"heads/{branch}",
             )
-            
+
             if not refs:
-                raise GitOpsException(f"Branch '{branch}' does not exist")
-            
-            return refs[0].object_id
-            
+                _raise_branch_not_found()
+
+            return str(refs[0].object_id)
+
         except GitOpsException:
             # Re-raise GitOpsException without modification
             raise
         except ClientException as ex:
             error_msg = str(ex)
             if "401" in error_msg:
                 raise GitOpsException("Bad credentials") from ex
-            elif "404" in error_msg:
+            if "404" in error_msg:
                 raise GitOpsException(f"Branch '{branch}' does not exist") from ex
-            else:
-                raise GitOpsException(f"Error getting branch hash: {error_msg}") from ex
-        except Exception as ex:
+            raise GitOpsException(f"Error getting branch hash: {error_msg}") from ex
+        except Exception as ex:  # noqa: BLE001
             raise GitOpsException(f"Error connecting to '{self.__base_url}'") from ex
 
     def get_pull_request_branch(self, pr_id: int) -> str:
@@ -268,22 +262,21 @@ def get_pull_request_branch(self, pr_id: int) -> str:
                 pull_request_id=pr_id,
                 project=self.__project_name,
             )
-            
+
             # Extract branch name from sourceRefName (remove refs/heads/ prefix)
-            source_ref = pr.source_ref_name
+            source_ref = str(pr.source_ref_name)
             if source_ref.startswith("refs/heads/"):
                 return source_ref[11:]  # Remove "refs/heads/" prefix
             return source_ref
-            
+
         except ClientException as ex:
             error_msg = str(ex)
             if "401" in error_msg:
                 raise GitOpsException("Bad credentials") from ex
-            elif "404" in error_msg:
+            if "404" in error_msg:
                 raise GitOpsException(f"Pull request with ID '{pr_id}' does not exist") from ex
-            else:
-                raise GitOpsException(f"Error getting pull request: {error_msg}") from ex
-        except Exception as ex:
+            raise GitOpsException(f"Error getting pull request: {error_msg}") from ex
+        except Exception as ex:  # noqa: BLE001
             raise GitOpsException(f"Error connecting to '{self.__base_url}'") from ex
 
     def add_pull_request_label(self, pr_id: int, pr_labels: list[str]) -> None:
@@ -298,22 +291,21 @@ def __get_default_branch(self) -> str:
                 repository_id=self.__repository_name,
                 project=self.__project_name,
             )
-            
+
             default_branch = repo.default_branch or "refs/heads/main"
             # Remove refs/heads/ prefix if present
             if default_branch.startswith("refs/heads/"):
                 return default_branch[11:]
             return default_branch
-            
+
         except ClientException as ex:
             error_msg = str(ex)
             if "401" in error_msg:
                 raise GitOpsException("Bad credentials") from ex
-            elif "404" in error_msg:
+            if "404" in error_msg:
                 raise GitOpsException(
                     f"Repository '{self.__project_name}/{self.__repository_name}' does not exist"
                 ) from ex
-            else:
-                raise GitOpsException(f"Error getting repository info: {error_msg}") from ex
-        except Exception as ex:
-            raise GitOpsException(f"Error connecting to '{self.__base_url}'") from ex
+            raise GitOpsException(f"Error getting repository info: {error_msg}") from ex
+        except Exception as ex:  # noqa: BLE001
+            raise GitOpsException(f"Error connecting to '{self.__base_url}'") from ex

pyproject.toml

@@ -54,6 +54,7 @@ ignore = [
     "PLR0913", # https://docs.astral.sh/ruff/rules/too-many-arguments/
     "D", # https://docs.astral.sh/ruff/rules/#pydocstyle-d
     "COM812", # https://docs.astral.sh/ruff/rules/missing-trailing-comma/ (clashes with formatter)
+    "ISC001", # https://docs.astral.sh/ruff/rules/single-line-implicit-string-concatenation/ (clashes with formatter)
     "EM101", # https://docs.astral.sh/ruff/rules/raw-string-in-exception/
     "EM102", # https://docs.astral.sh/ruff/rules/f-string-in-exception/
     "S101", # https://docs.astral.sh/ruff/rules/assert/
@@ -66,5 +67,9 @@ ignore = [
     "S106", # https://docs.astral.sh/ruff/rules/hardcoded-password-func-arg/
     "S108", # https://docs.astral.sh/ruff/rules/hardcoded-temp-file/
     "ANN", # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
-    "PT009" # https://docs.astral.sh/ruff/rules/pytest-unittest-assertion/
+    "PT009", # https://docs.astral.sh/ruff/rules/pytest-unittest-assertion/
+    "SLF001", # https://docs.astral.sh/ruff/rules/private-member-access/ (needed for testing private methods)
+]
+"gitopscli/git_api/azure_devops_git_repo_api_adapter.py" = [
+    "TRY300", # https://docs.astral.sh/ruff/rules/try-consider-else/ (conflicts with RET505)
 ]