Merge lp:~jelmer/brz/gitea into lp:brz/3.3

[Jelmer Vernooij]

Add basic gitea plugin

Add basic gitea plugin

[Jelmer Vernooij (jelmer)]

review: Approve

[The Breezy Bot (the-breezy-bot)]

The attempt to merge lp:~jelmer/brz/gitea into lp:brz/3.3 failed. Command exited with 2.
Below is the output from the failed tests.

Collecting setuptools-gettext
  Using cached setuptools_gettext-0.1.2-py3-none-any.whl (10 kB)
Requirement already satisfied: setuptools>=46.1 in ./lib/python3.11/site-packages (from setuptools-gettext) (66.1.1)
Installing collected packages: setuptools-gettext
Successfully installed setuptools-gettext-0.1.2
Obtaining file:///tmp/tarmac/branch.w5kh4zqy
  Installing build dependencies: started
  Installing build dependencies: finished with status 'done'
  Checking if build backend supports build_editable: started
  Checking if build backend supports build_editable: finished with status 'done'
  Getting requirements to build editable: started
  Getting requirements to build editable: finished with status 'done'
  Preparing editable metadata (pyproject.toml): started
  Preparing editable metadata (pyproject.toml): finished with status 'done'
Requirement already satisfied: patiencediff in /usr/lib/python3/dist-packages (from breezy==3.3.3.dev0) (0.2.3)
Requirement already satisfied: urllib3>=1.24.1 in /usr/lib/python3/dist-packages (from breezy==3.3.3.dev0) (1.26.12)
Requirement already satisfied: fastbencode in /usr/lib/python3/dist-packages (from breezy==3.3.3.dev0) (0.0.12)
Requirement already satisfied: configobj in /usr/lib/python3/dist-packages (from breezy==3.3.3.dev0) (5.1.0.dev0)
Collecting dulwich>=0.21.2
  Using cached dulwich-0.21.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (507 kB)
Requirement already satisfied: merge3 in /usr/lib/python3/dist-packages (from breezy==3.3.3.dev0) (0.0.8)
Requirement already satisfied: pyyaml in /usr/lib/python3/dist-packages (from breezy==3.3.3.dev0) (6.0)
Requirement already satisfied: launchpadlib>=1.6.3 in /usr/lib/python3/dist-packages (from breezy==3.3.3.dev0) (1.11.0)
Collecting python-subunit
  Using cached python_subunit-1.4.2-py3-none-any.whl (106 kB)
Collecting testscenarios
  Using cached testscenarios-0.5.0-py2.py3-none-any.whl (21 kB)
Collecting testtools
  Using cached testtools-2.5.0-py3-none-any.whl (181 kB)
Requirement already satisfied: flake8 in /usr/lib/python3/dist-packages (from breezy==3.3.3.dev0) (5.0.4)
Requirement already satisfied: gpg in /usr/lib/python3/dist-packages (from breezy==3.3.3.dev0) (1.18.0)
Collecting fastimport
  Using cached fastimport-0.9.14-py2.py3-none-any.whl
Requirement already satisfied: paramiko in /usr/local/lib/python3.11/dist-packages (from breezy==3.3.3.dev0) (2.12.0)
Requirement already satisfied: setuptools in ./lib/python3.11/site-packages (from breezy==3.3.3.dev0) (66.1.1)
Collecting docutils
  Using cached docutils-0.19-py3-none-any.whl (570 kB)
Collecting sphinx
  Using cached sphinx-6.1.3-py3-none-any.whl (3.0 MB)
Collecting sphinx-epytext
  Using cached sphinx_epytext-0.0.4-py3-none-any.whl
Requirement already satisfied: httplib2 in /usr/lib/python3/dist-packages (from launchpadlib>=1.6.3->breezy==3.3.3.dev0) (0.20.4)
Requirement already satisfied: lazr.restfulclient>=0.14.2 in /usr/lib/python3/dist-packages (from launchpadlib>=1.6.3->breezy==3.3.3.dev0) (0.14.5)
Requirement already satisfied: l...

[Martin Packman (gz)]

Cool you've implemented this!

There are some comment references to gitlab, which are presumably
copy/paste rather than meaningful?

On Mon, 6 Feb 2023 at 20:34, Jelmer Vernooij
<email address hidden> wrote:
>
> Review: Approve
>
>
> --
> https://code.launchpad.net/~jelmer/brz/gitea/+merge/436917
> Your team Breezy developers is subscribed to branch lp:brz/3.3.
>

[Jelmer Vernooij (jelmer)]

On Sun, Feb 12, 2023 at 04:21:11PM -0000, Martin Packman wrote:
> Cool you've implemented this!
>
> There are some comment references to gitlab, which are presumably
> copy/paste rather than meaningful?

Yeah, it probably needs a little bit more work.. :)

> On Mon, 6 Feb 2023 at 20:34, Jelmer Vernooij
> <email address hidden> wrote:
> >
> > Review: Approve
> >
> >
> > --
> > https://code.launchpad.net/~jelmer/brz/gitea/+merge/436917
> > Your team Breezy developers is subscribed to branch lp:brz/3.3.
> >
>
> --
> https://code.launchpad.net/~jelmer/brz/gitea/+merge/436917
> You are the owner of lp:~jelmer/brz/gitea.
>

Unmerged revisions

7688. By Jelmer Vernooij on 2023-02-06

Add basic gitea implementation

7687. By Jelmer Vernooij on 2023-02-05

Merge lp:brz/3.3

7686. By Jelmer Vernooij on 2021-03-29

initial work on gitea support

=== added directory 'breezy/plugins/gitea'
=== added file 'breezy/plugins/gitea/__init__.py'
--- breezy/plugins/gitea/__init__.py	1970-01-01 00:00:00 +0000
+++ breezy/plugins/gitea/__init__.py	2023-02-06 20:43:29 +0000
@@ -0,0 +1,36 @@
+# Copyright (C) 2021 Jelmer Vernooij <[e-mail]>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""Management of hosted branches."""
+
+from __future__ import absolute_import
+
+from ... import version_info  # noqa: F401
+from ...commands import plugin_cmds
+from ...commands import plugin_cmds
+
+plugin_cmds.register_lazy("cmd_gitea_login", ["gitea-login"], __name__ + ".cmds")
+
+from ...forge import forges
+forges.register_lazy("gitea", __name__ + '.forge', "Gitea")
+
+
+def test_suite():
+    from unittest import TestSuite
+    from .tests import test_suite
+    result = TestSuite()
+    result.addTest(test_suite())
+    return result

=== added file 'breezy/plugins/gitea/cmds.py'
--- breezy/plugins/gitea/cmds.py	1970-01-01 00:00:00 +0000
+++ breezy/plugins/gitea/cmds.py	2023-02-06 20:43:29 +0000
@@ -0,0 +1,70 @@
+# Copyright (C) 2023 Jelmer Vernooij <[e-mail]>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""Gitea command implementations."""
+
+from ... import (
+    errors,
+    urlutils,
+    )
+from ...commands import Command
+from ...option import (
+    Option,
+    )
+from ...trace import note
+
+
+class cmd_gitea_login(Command):
+    __doc__ = """Log into a Gitea instance.
+
+    This command takes a Gitea/Forgejo instance URL (e.g. https://codehut.org)
+    as well as an optional private token. Private tokens can be created via the
+    web UI.
+
+    :Examples:
+
+      Log into codehut.org (prompts for a token):
+
+         brz gitea-login https://codehut.org/
+    """
+
+    takes_args = ['url', 'private_token?']
+
+    takes_options = [
+        Option('name', help='Name for Gitea site in configuration.',
+               type=str),
+        Option('no-check',
+               "Don't check that the token is valid."),
+        ]
+
+    def run(self, url, private_token=None, name=None, no_check=False):
+        from breezy import ui
+        from .forge import store_gitea_token
+        if name is None:
+            try:
+                name = urlutils.parse_url(url)[3].split('.')[-2]
+            except (ValueError, IndexError):
+                raise errors.CommandError(
+                    'please specify a site name with --name')
+        if private_token is None:
+            note("Please visit %s to obtain a private token.",
+                 urlutils.join(url, "/user/settings/applications"))
+            private_token = ui.ui_factory.get_password('Private token')
+        if not no_check:
+            from breezy.transport import get_transport
+            from .forge import Gitea
+            Gitea(get_transport(url), private_token=private_token)
+        store_gitea_token(name=name, url=url, private_token=private_token)

=== added file 'breezy/plugins/gitea/forge.py'
--- breezy/plugins/gitea/forge.py	1970-01-01 00:00:00 +0000
+++ breezy/plugins/gitea/forge.py	2023-02-06 20:43:29 +0000
@@ -0,0 +1,231 @@
+# Copyright (C) 2021 Breezy Developers
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""Support for Gitea."""
+
+from typing import Optional
+
+from ... import errors, urlutils
+
+from ...forge import (
+    determine_title,
+    Forge,
+    UnsupportedForge,
+    PrerequisiteBranchUnsupported,
+    MergeProposal,
+    MergeProposalBuilder,
+    )
+
+from breezy.transport import get_transport
+
+
+class NotGiteaUrl(errors.BzrError):
+
+    _fmt = "Not a Gitea URL: %(url)s"
+
+    def __init__(self, url):
+        errors.BzrError.__init__(self)
+        self.url = url
+
+
+class DifferentGiteaInstances(errors.BzrError):
+
+    _fmt = ("Can't create merge proposals across Gitea instances: "
+            "%(source_host)s and %(target_host)s")
+
+    def __init__(self, source_host, target_host):
+        self.source_host = source_host
+        self.target_host = target_host
+
+
+def store_gitea_token(name, url, private_token):
+    """Store a gitea token in a configuration file."""
+    from breezy.config import AuthenticationConfig
+    auth_config = AuthenticationConfig()
+    auth_config._set_option(name, 'url', url)
+    auth_config._set_option(name, 'private_token', private_token)
+
+
+def iter_tokens():
+    from breezy.config import AuthenticationConfig
+    auth_config = AuthenticationConfig()
+    yield from auth_config._get_config().iteritems()
+
+
+def get_credentials_by_url(url):
+    for name, credentials in iter_tokens():
+        if 'url' not in credentials:
+            continue
+        if credentials['url'].rstrip('/') == url.rstrip('/'):
+            return credentials
+    else:
+        return None
+
+
+def parse_gitea_url(url):
+    (scheme, user, password, host, port, path) = urlutils.parse_url(
+        url)
+    if scheme not in ('git+ssh', 'https', 'http'):
+        raise NotGiteaUrl(url)
+    if not host:
+        raise NotGiteaUrl(url)
+    path = path.strip('/')
+    if path.endswith('.git'):
+        path = path[:-4]
+    return host, path
+
+
+def parse_gitea_branch_url(branch):
+    url = urlutils.strip_segment_parameters(branch.user_url)
+    host, path = parse_gitea_url(url)
+    return host, path, branch.name
+
+
+class Gitea(Forge):
+    """Gitea hoster implementation."""
+
+    supports_merge_proposal_title = True
+    supports_merge_proposal_labels = False
+    supports_merge_proposal_commit_message = False
+    supports_allow_collaboration = False
+    merge_proposal_description_format = 'markdown'
+
+    def __init__(self, transport, private_token):
+        self.transport = transport
+        self.headers = {"Private-Token": private_token}
+        self._current_user = None
+
+    def __repr__(self):
+        return "<Gitea(%r)>" % self.base_url
+
+    @property
+    def base_url(self):
+        return self.transport.base
+
+    @property
+    def base_hostname(self):
+        return urlutils.parse_url(self.base_url)[3]
+
+    def hosts(self, branch):
+        try:
+            (host, _project, _branch_name) = parse_gitea_branch_url(branch)
+        except NotGiteaUrl:
+            return False
+        return self.base_hostname == host
+
+    def iter_my_proposals(self, status='open', author=None):
+        # TODO(jelmer): It's not clear to me how to list all 
+        raise NotImplementedError(self.iter_my_proposals)
+
+    @classmethod
+    def probe_from_url(cls, url, possible_transports=None):
+        try:
+            (host, _project) = parse_gitea_url(url)
+        except NotGiteaUrl as e:
+            raise UnsupportedForge(url) from e
+        transport = get_transport(
+            f'https://{host}', possible_transports=possible_transports)
+        credentials = get_credentials_by_url(transport.base)
+        if credentials is not None:
+            return cls(transport, credentials.get('private_token'))
+        raise UnsupportedForge(url)
+
+    @classmethod
+    def iter_instances(cls):
+        for _name, credentials in iter_tokens():
+            if 'url' not in credentials:
+                continue
+            yield cls(
+                get_transport(credentials['url']),
+                private_token=credentials.get('private_token'))
+
+
+class GiteaMergeProposal(MergeProposal):
+
+    supports_auto_merge = True
+
+    def __init__(self, gitea, pr):
+        self._gitea = gitea
+        self._pr = pr
+
+    def __repr__(self):
+        return "<{} at {!r}>".format(type(self).__name__, self.url)
+
+    def get_web_url(self):
+        return self._pr['html_url']
+
+    @property
+    def url(self):
+        return self._pr['html_url']
+
+    def is_merged(self):
+        return bool(self._pr.get('merged_at'))
+
+    def is_closed(self):
+        return self._pr['state'] == 'closed' and not bool(self._pr.get('merged_at'))
+
+
+class GiteaMergeProposalBuilder(MergeProposalBuilder):
+
+    def __init__(self, gitea, source_branch, target_branch):
+        self.gitea = gitea
+        self.source_branch = source_branch
+        (self.source_host, self.source_project_name, self.source_branch_name) = (
+            parse_gitea_branch_url(source_branch))
+        self.target_branch = target_branch
+        (self.target_host, self.target_project_name, self.target_branch_name) = (
+            parse_gitea_branch_url(target_branch))
+        if self.source_host != self.target_host:
+            raise DifferentGiteaInstances(self.source_host, self.target_host)
+
+    def create_proposal(self, description, title=None, reviewers=None,
+                        labels=None, prerequisite_branch=None,
+                        commit_message=None, work_in_progress=False,
+                        allow_collaboration=False,
+                        delete_source_after_merge: Optional[bool] = None):
+        """Perform the submission."""
+        # https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
+        if prerequisite_branch is not None:
+            raise PrerequisiteBranchUnsupported(self)
+        # Note that commit_message is ignored, since Gitlab doesn't support it.
+        source_project = self.gitea._get_project(self.source_project_name)
+        target_project = self.gitea._get_project(self.target_project_name)
+        if title is None:
+            title = determine_title(description)
+        if work_in_progress:
+            title = 'WIP: %s' % title
+        # TODO(jelmer): Allow setting milestone field
+        # TODO(jelmer): Allow setting squash field
+        kwargs = {
+            'title': title,
+            'head': head,
+            'base': base,
+            'body': description,
+        }
+        if labels:
+            # TODO(jelmer): Labels are apparently integers
+            raise NotImplementedError
+        if reviewers:
+            kwargs['assignees'] = reviewers
+        # TODO(jelmer): add milestone
+        # TODO(jelmer): add due_date
+        merge_request = self.gitea._create_pullrequest(
+            title=title,
+            assignees=reviewers,
+            head="{}:{}".format(self.source_owner, self.source_branch_name),
+            base=self.target_branch_name)
+
+        return GiteaMergeProposal(self.gitea, merge_request)

=== modified file 'breezy/plugins/github/forge.py'
--- breezy/plugins/github/forge.py	2023-01-31 01:05:40 +0000
+++ breezy/plugins/github/forge.py	2023-02-06 20:43:29 +0000
@@ -112,8 +112,6 @@
     def __repr__(self):
         return "<{} at {!r}>".format(type(self).__name__, self.url)
 
-    name = 'GitHub'
-
     def get_web_url(self):
         return self._pr['html_url']