Merge pull request openSUSE#1966 from dmach/git-obs-pr-list-filter-label

Add filtering by label to 'git-obs pr list'

Author: dmach

behave/features/git-pr.feature

@@ -113,6 +113,40 @@ Scenario: Get a pull request
         """
 
 
+@destructive
+Scenario: Get a pull request with labels
+   Given I execute git-obs with args "api -X POST /repos/pool/test-GitPkgA/labels --data='{{"name": "bug", "color": "cc0000"}}'"
+     And I execute git-obs with args "api -X POST /repos/pool/test-GitPkgA/labels --data='{{"name": "feature", "color": "00cc00"}}'"
+     And I execute git-obs with args "api -X POST /repos/pool/test-GitPkgA/issues/1/labels --data='{{"labels": ["bug", "feature"]}}'"
+    When I execute git-obs with args "pr get pool/test-GitPkgA#1"
+    Then the exit code is 0
+     And stdout matches
+        """
+        ID          : pool/test-GitPkgA#1
+        URL         : http://localhost:{context.podman.container.ports[gitea_http]}/pool/test-GitPkgA/pulls/1
+        Title       : Change version
+        State       : open
+        Labels      : bug feature
+        Draft       : no
+        Merged      : no
+        Allow edit  : no
+        Author      : Admin \([email protected]\)
+        Source      : Admin/test-GitPkgA, branch: factory, commit: .*
+        Target      : pool/test-GitPkgA, branch: factory, commit: .*
+        Description : some text
+        """
+     And stderr is
+        """
+        Using the following Gitea settings:
+         * Config path: {context.git_obs.config}
+         * Login (name of the entry in the config file): admin
+         * URL: http://localhost:{context.podman.container.ports[gitea_http]}
+         * User: Admin
+
+        Total entries: 1
+        """
+
+
 @destructive
 Scenario: Get a pull request that doesn't exist
     When I execute git-obs with args "pr get does-not/exist#1"

osc/commands_git/api.py

@@ -15,7 +15,7 @@ def init_arguments(self):
         self.add_argument(
             "-X",
             "--method",
-            choices=["GET", "HEAD", "POST", "PATCH", "PUT"],
+            choices=["GET", "HEAD", "POST", "PATCH", "PUT", "DELETE"],
             default="GET",
         )
         self.add_argument(

osc/commands_git/pr_list.py

@@ -43,6 +43,12 @@ def init_arguments(self):
             action="store_true",
             help="Filter by draft flag. Exclude pull requests with draft flag set.",
         )
+        self.add_argument(
+            "--label",
+            dest="labels",
+            action="append",
+            help="Filter by label. Can be specified multiple times.",
+        )
         self.add_argument(
             "--export",
             action="store_true",
@@ -62,6 +68,11 @@ def run(self, args):
             if args.no_draft:
                 pr_obj_list = [i for i in pr_obj_list if not i.draft]
 
+            if args.labels:
+                # keep pull requests that contain at least one specified label
+                specified_labels = set(args.labels)
+                pr_obj_list = [pr for pr in pr_obj_list if not specified_labels.isdisjoint(pr.labels)]
+
             if args.target_branches:
                 pr_obj_list = [i for i in pr_obj_list if i.base_branch in args.target_branches]
 

osc/gitea_api/connection.py

@@ -127,7 +127,7 @@ def request(
         if self.login.token:
             headers["Authorization"] = f"token {self.login.token}"
 
-        if json_data:
+        if json_data and isinstance(json_data, dict):
             json_data = dict(((key, value) for key, value in json_data.items() if value is not None))
 
         body = json.dumps(json_data) if json_data else None

osc/gitea_api/pr.py

@@ -1,5 +1,6 @@
 import functools
 import re
+from typing import Dict
 from typing import List
 from typing import Optional
 from typing import Tuple
@@ -262,6 +263,10 @@ def url(self) -> str:
         # HACK: search API returns issues, the URL needs to be transformed to a pull request URL
         return re.sub(r"^(.*)/api/v1/repos/(.+/.+)/issues/([0-9]+)$", r"\1/\2/pulls/\3", self._data["url"])
 
+    @property
+    def labels(self) -> List[str]:
+        return [label["name"] for label in self._data.get("labels", [])]
+
     def to_human_readable_string(self):
         from osc.output import KeyValueTable
 
@@ -273,6 +278,8 @@ def yes_no(value):
         table.add("URL", self.url)
         table.add("Title", self.title)
         table.add("State", self.state)
+        if self.labels:
+            table.add("Labels", " ".join(self.labels))
         if self.is_pull_request:
             table.add("Draft", yes_no(self.draft))
             table.add("Merged", yes_no(self.merged))
@@ -698,3 +705,96 @@ def reopen(
         response = conn.request("PATCH", url, json_data=json_data, context={"owner": owner, "repo": repo})
         obj = cls(response.json(), response=response, conn=conn)
         return obj
+
+    @classmethod
+    def _get_label_ids(cls, conn: Connection, owner: str, repo: str) -> Dict[str, int]:
+        """
+        Helper to map labels to their IDs
+        """
+        result = {}
+        url = conn.makeurl("repos", owner, repo, "labels")
+        response = conn.request("GET", url)
+        labels = response.json()
+        for label in labels:
+            result[label["id"]] = label["name"]
+        return result
+
+    @classmethod
+    def add_labels(
+        cls,
+        conn: Connection,
+        owner: str,
+        repo: str,
+        number: int,
+        labels: List[str],
+    ) -> "GiteaHTTPResponse":
+        """
+        Add one or more labels to a pull request.
+
+        :param conn: Gitea Connection instance.
+        :param owner: Owner of the repo.
+        :param repo: Name of the repo.
+        :param number: Number of the pull request.
+        :param labels: A list of label names to add.
+        """
+        from .exceptions import GitObsRuntimeError
+
+        label_id_list = []
+        invalid_labels = []
+        label_name_id_map = cls._get_label_ids(conn, owner, repo)
+        for label in labels:
+            label_id = label_name_id_map.get(label, None)
+            if not label_id:
+                invalid_labels.append(label)
+                continue
+            label_id_list.append(label_id)
+        if invalid_labels:
+            msg = f"The following labels do not exist in {owner}/{repo}: {' '.join(invalid_labels)}"
+            raise GitObsRuntimeError(msg)
+
+        url = conn.makeurl("repos", owner, repo, "issues", str(number), "labels")
+        json_data = {
+            "labels": label_id_list,
+        }
+        return conn.request("POST", url, json_data=json_data)
+
+    @classmethod
+    def remove_labels(
+        cls,
+        conn: Connection,
+        owner: str,
+        repo: str,
+        number: int,
+        labels: List[str],
+    ):
+        """
+        Remove labels from a pull request.
+
+        :param conn: Gitea Connection instance.
+        :param owner: Owner of the repo.
+        :param repo: Name of the repo.
+        :param number: Number of the pull request.
+        :param labels: A list of label names to remove.
+        """
+        from .exceptions import GitObsRuntimeError
+
+        label_id_list = []
+        invalid_labels = []
+        label_name_id_map = cls._get_label_ids(conn, owner, repo)
+        for label in labels:
+            label_id = label_name_id_map.get(label, None)
+            if not label_id:
+                invalid_labels.append(label)
+                continue
+            label_id_list.append(label_id)
+        if invalid_labels:
+            msg = f"The following labels do not exist in {owner}/{repo}: {' '.join(invalid_labels)}"
+            raise GitObsRuntimeError(msg)
+
+        # DELETE /repos/<owner>/<repo>/issues/<number>/labels with data == {"labels": [1, 2, 3, ...]} doesn't work and always deletes all labels.
+        # Retrieving all labels, filtering them and sending back is prone to race conditions.
+        # Let's trigger DELETE /repos/<owner>/<repo>/issues/<number>/labels/<id> instead to stay at the safe side.
+
+        for label_id in label_id_list:
+            url = conn.makeurl("repos", owner, repo, "issues", str(number), "labels", str(label_id))
+            conn.request("DELETE", url)