added pr labels for gitlab and github, and merge parameters for gitlab

Author: espanov

.pylintrc

@@ -435,7 +435,7 @@ valid-metaclass-classmethod-first-arg=cls
 max-args=5
 
 # Maximum number of attributes for a class (see R0902).
-max-attributes=12
+max-attributes=14
 
 # Maximum number of boolean expressions in an if statement (see R0916).
 max-bool-expr=5

gitopscli/cliparser.py

@@ -25,6 +25,7 @@ def parse_args(raw_args: List[str]) -> Tuple[bool, CommandArgs]:
 
     args = vars(parser.parse_args(raw_args))
     args = __deduce_empty_git_provider_from_git_provider_url(args, parser.error)
+    __check_compatibility_args(args, parser.error)
 
     verbose = args.pop("verbose", False)
     command_args = __create_command_args(args)
@@ -112,6 +113,15 @@ def __create_deploy_parser() -> ArgumentParser:
         type=__parse_bool,
         default=False,
     )
+    parser.add_argument(
+        "--pr-labels", help="JSON object pr labels (Gitlab, Github supported)", type=__parse_yaml, default=None
+    )
+    parser.add_argument(
+        "--gitlab-merge-parameters",
+        help="JSON object pr parameters (only Gitlab supported)",
+        type=__parse_yaml,
+        default=None,
+    )
     __add_verbose_arg(parser)
     return parser
 
@@ -301,6 +311,15 @@ def __deduce_empty_git_provider_from_git_provider_url(
     return updated_args
 
 
+def __check_compatibility_args(args: Dict[str, Any], error: Callable[[str], NoReturn]) -> None:
+    if "git_provider" not in args:
+        return
+    if args.get("pr_labels") and args["git_provider"] == GitProvider.BITBUCKET:
+        error("Cannot use --pr-labels with --git-provider bitbucket-server")
+    if args.get("gitlab_merge_parameters") and args["git_provider"] != GitProvider.GITLAB:
+        error("Can use --gitlab_merge_parameters only with --git-provider gitlab")
+
+
 def __create_command_args(args: Dict[str, Any]) -> CommandArgs:
     args = dict(args)
     command = args.pop("command")

gitopscli/commands/deploy.py

@@ -28,6 +28,8 @@ class Args(GitApiConfig):
         auto_merge: bool
         json: bool
 
+        pr_labels: Any
+        gitlab_merge_parameters: Any
         merge_method: Literal["squash", "rebase", "merge"] = "merge"
 
     def __init__(self, args: Args) -> None:
@@ -53,9 +55,15 @@ def execute(self) -> None:
         if self.__args.create_pr:
             title, description = self.__create_pull_request_title_and_description(updated_values)
             pr_id = git_repo_api.create_pull_request_to_default_branch(pr_branch, title, description).pr_id
-
+            if self.__args.pr_labels:
+                git_repo_api.add_pull_request_label(pr_id, self.__args.pr_labels)
             if self.__args.auto_merge:
-                git_repo_api.merge_pull_request(pr_id, self.__args.merge_method)
+                if self.__args.gitlab_merge_parameters:
+                    git_repo_api.merge_pull_request_with_parameters(
+                        pr_id, self.__args.gitlab_merge_parameters, self.__args.merge_method
+                    )
+                else:
+                    git_repo_api.merge_pull_request(pr_id, self.__args.merge_method)
                 git_repo_api.delete_branch(pr_branch)
 
         if self.__args.json:

gitopscli/git_api/bitbucket_git_repo_api_adapter.py

@@ -1,4 +1,4 @@
-from typing import Optional, Literal
+from typing import Dict, Any, Optional, Literal
 import requests
 
 from atlassian import Bitbucket
@@ -108,3 +108,14 @@ def get_pull_request_branch(self, pr_id: int) -> str:
     def __get_default_branch(self) -> str:
         default_branch = self.__bitbucket.get_default_branch(self.__organisation, self.__repository_name)
         return str(default_branch["id"])
+
+    def merge_pull_request_with_parameters(
+        self,
+        pr_id: int,
+        gitlab_merge_parameters: Dict[str, Any],
+        merge_method: Literal["squash", "rebase", "merge"] = "merge",
+    ) -> None:
+        pass
+
+    def add_pull_request_label(self, pr_id: int, pr_labels: Dict[str, Any]) -> None:
+        pass

gitopscli/git_api/git_repo_api.py

@@ -1,5 +1,5 @@
 from abc import ABCMeta, abstractmethod
-from typing import NamedTuple, Optional, Literal
+from typing import Any, Dict, NamedTuple, Optional, Literal
 
 
 class GitRepoApi(metaclass=ABCMeta):
@@ -50,3 +50,16 @@ def get_branch_head_hash(self, branch: str) -> str:
     @abstractmethod
     def get_pull_request_branch(self, pr_id: int) -> str:
         ...
+
+    @abstractmethod
+    def add_pull_request_label(self, pr_id: int, pr_labels: Dict[str, Any]) -> None:
+        ...
+
+    @abstractmethod
+    def merge_pull_request_with_parameters(
+        self,
+        pr_id: int,
+        gitlab_merge_parameters: Dict[str, Any],
+        merge_method: Literal["squash", "rebase", "merge"] = "merge",
+    ) -> None:
+        ...

gitopscli/git_api/git_repo_api_logging_proxy.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Optional, Literal
+from typing import Any, Dict, Optional, Literal
 from .git_repo_api import GitRepoApi
 
 
@@ -50,3 +50,16 @@ def get_branch_head_hash(self, branch: str) -> str:
 
     def get_pull_request_branch(self, pr_id: int) -> str:
         return self.__api.get_pull_request_branch(pr_id)
+
+    def add_pull_request_label(self, pr_id: int, pr_labels: Dict[str, Any]) -> None:
+        logging.info("Adding labels for pull request %s with content: %s", pr_id, pr_labels)
+        self.__api.add_pull_request_label(pr_id, pr_labels)
+
+    def merge_pull_request_with_parameters(
+        self,
+        pr_id: int,
+        gitlab_merge_parameters: Dict[str, Any],
+        merge_method: Literal["squash", "rebase", "merge"] = "merge",
+    ) -> None:
+        logging.info("Merging pull request %s with parameters %s", pr_id, gitlab_merge_parameters)
+        self.__api.merge_pull_request_with_parameters(pr_id, gitlab_merge_parameters, merge_method=merge_method)

gitopscli/git_api/github_git_repo_api_adapter.py

@@ -1,4 +1,4 @@
-from typing import Optional, Literal
+from typing import Any, Dict, Union, Optional, Literal
 
 from github import (
     Github,
@@ -88,3 +88,15 @@ def __get_repo(self) -> Repository.Repository:
             raise GitOpsException(
                 f"Repository '{self.__organisation}/{self.__repository_name}' does not exist."
             ) from ex
+
+    def add_pull_request_label(self, pr_id: int, pr_labels: Union[str, Any]) -> None:
+        pull_request = self.__get_pull_request(pr_id)
+        pull_request.set_labels(pr_labels)
+
+    def merge_pull_request_with_parameters(
+        self,
+        pr_id: int,
+        gitlab_merge_parameters: Dict[str, Any],
+        merge_method: Literal["squash", "rebase", "merge"] = "merge",
+    ) -> None:
+        pass

gitopscli/git_api/gitlab_git_repo_api_adapter.py

@@ -1,4 +1,4 @@
-from typing import Optional, Literal
+from typing import Any, Dict, Optional, Literal
 import logging
 import time
 import requests
@@ -97,8 +97,40 @@ def get_pull_request_branch(self, pr_id: int) -> str:
         return str(merge_request.source_branch)
 
     def __get_default_branch(self) -> str:
-        branches = self.__project.branches.list()
+        branches = self.__project.branches.list(all=True)
         default_branch = next(filter(lambda x: x.default, branches), None)
         if default_branch is None:
             raise GitOpsException("Default branch does not exist")
         return str(default_branch.name)
+
+    def add_pull_request_label(self, pr_id: int, pr_labels: Dict[str, Any]) -> None:
+        merge_request = self.__project.mergerequests.get(pr_id)
+        merge_request.labels = pr_labels
+        merge_request.save()
+
+    def merge_pull_request_with_parameters(
+        self,
+        pr_id: int,
+        gitlab_merge_parameters: Dict[str, Any],
+        merge_method: Literal["squash", "rebase", "merge"] = "merge",
+    ) -> None:
+        merge_request = self.__project.mergerequests.get(pr_id)
+
+        max_retries = MAX_MERGE_RETRIES
+        while max_retries > 0:
+            try:
+                if merge_method == "rebase":
+                    merge_request.rebase(gitlab_merge_parameters)
+                    return
+                merge_request.merge(gitlab_merge_parameters)
+                return
+            except gitlab.exceptions.GitlabMRClosedError as ex:
+                # "Branch cannot be merged" error can occur if the server
+                # is still processing the merge request internally
+                max_retries -= 1
+                logging.warning(
+                    "Retry merging pull request. Attempts: (%s/%s)", MAX_MERGE_RETRIES - max_retries, MAX_MERGE_RETRIES
+                )
+                if max_retries == 0:
+                    raise GitOpsException("Error merging pull request: 'Branch cannot be merged'") from ex
+                time.sleep(2.5)

mypy.ini

@@ -17,6 +17,7 @@ exclude = (?x)(
     build/lib/*/*
     | tests/*
     | venv/Scripts/*
+    | venv/bin/*
   )
 
 

tests/commands/test_deploy.py

@@ -68,6 +68,8 @@ def test_happy_flow(self, mock_print):
             git_provider_url=None,
             commit_message=None,
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         DeployCommand(args).execute()
 
@@ -106,6 +108,8 @@ def test_create_pr_single_value_change_happy_flow_with_output(self, mock_print):
             git_provider_url=None,
             commit_message=None,
             json=True,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         DeployCommand(args).execute()
 
@@ -156,6 +160,8 @@ def test_create_pr_multiple_value_changes_happy_flow_with_output(self, mock_prin
             git_provider_url=None,
             commit_message=None,
             json=True,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         DeployCommand(args).execute()
 
@@ -212,6 +218,8 @@ def test_create_pr_and_merge_happy_flow(self, mock_print):
             git_provider_url=None,
             commit_message=None,
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         DeployCommand(args).execute()
 
@@ -259,6 +267,8 @@ def test_single_commit_happy_flow(self, mock_print):
             git_provider_url=None,
             commit_message=None,
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         DeployCommand(args).execute()
 
@@ -300,6 +310,8 @@ def test_single_commit_single_value_change_happy_flow(self, mock_print):
             git_provider_url=None,
             commit_message=None,
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         DeployCommand(args).execute()
 
@@ -335,6 +347,8 @@ def test_commit_message_multiple_value_changes_happy_flow(self, mock_print):
             git_provider_url=None,
             commit_message="testcommit",
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         DeployCommand(args).execute()
 
@@ -374,6 +388,8 @@ def test_clone_error(self):
             git_provider_url=None,
             commit_message=None,
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         with pytest.raises(GitOpsException) as ex:
             DeployCommand(args).execute()
@@ -404,6 +420,8 @@ def test_file_not_found(self):
             git_provider_url=None,
             commit_message=None,
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         with pytest.raises(GitOpsException) as ex:
             DeployCommand(args).execute()
@@ -436,6 +454,8 @@ def test_file_parse_error(self):
             git_provider_url=None,
             commit_message=None,
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         with pytest.raises(GitOpsException) as ex:
             DeployCommand(args).execute()
@@ -468,6 +488,8 @@ def test_key_not_found(self):
             git_provider_url=None,
             commit_message=None,
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         with pytest.raises(GitOpsException) as ex:
             DeployCommand(args).execute()
@@ -500,6 +522,8 @@ def test_nothing_to_update(self):
             git_provider_url=None,
             commit_message=None,
             json=False,
+            pr_labels=None,
+            gitlab_merge_parameters=None,
         )
         DeployCommand(args).execute()