/brz/remove-bazaar : contents of breezy/plugins/propose/propose.py at revision 7311.2.7

: (revision 7311.2.7)

To get this branch, use:

bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

# Copyright (C) 2018 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

"""Helper functions for proposing merges."""

from __future__ import absolute_import

from ... import (
    errors,
    hooks,
    registry,
    urlutils,
    )


class NoSuchProject(errors.BzrError):

    _fmt = "Project does not exist: %(project)s."

    def __init__(self, project):
        errors.BzrError.__init__(self)
        self.project = project


class MergeProposalExists(errors.BzrError):

    _fmt = "A merge proposal already exists: %(url)s."

    def __init__(self, url):
        errors.BzrError.__init__(self)
        self.url = url


class UnsupportedHoster(errors.BzrError):

    _fmt = "No supported hoster for %(branch)s."

    def __init__(self, branch):
        errors.BzrError.__init__(self)
        self.branch = branch


class ProposeMergeHooks(hooks.Hooks):
    """Hooks for proposing a merge on Launchpad."""

    def __init__(self):
        hooks.Hooks.__init__(self, __name__, "Proposer.hooks")
        self.add_hook(
            'get_prerequisite',
            "Return the prerequisite branch for proposing as merge.", (3, 0))
        self.add_hook(
            'merge_proposal_body',
            "Return an initial body for the merge proposal message.", (3, 0))


class LabelsUnsupported(errors.BzrError):
    """Labels not supported by this hoster."""

    _fmt = "Labels are not supported by %(hoster)r."

    def __init__(self, hoster):
        errors.BzrError.__init__(self)
        self.hoster = hoster


class PrerequisiteBranchUnsupported(errors.BzrError):
    """Prerequisite branch not supported by this hoster."""

    def __init__(self, hoster):
        errors.BzrError.__init__(self)
        self.hoster = hoster


class HosterLoginRequired(errors.BzrError):
    """Action requires hoster login credentials."""

    _fmt = "Action requires credentials for hosting site %(hoster)r."""

    def __init__(self, hoster):
        errors.BzrError.__init__(self)
        self.hoster = hoster


class MergeProposal(object):
    """A merge proposal.

    :ivar url: URL for the merge proposal
    """

    def __init__(self, url=None):
        self.url = url

    def get_description(self):
        """Get the description of the merge proposal."""
        raise NotImplementedError(self.get_description)

    def set_description(self, description):
        """Set the description of the merge proposal."""
        raise NotImplementedError(self.set_description)

    def get_source_branch_url(self):
        """Return the source branch."""
        raise NotImplementedError(self.get_source_branch_url)

    def get_target_branch_url(self):
        """Return the target branch."""
        raise NotImplementedError(self.get_target_branch_url)

    def close(self):
        """Close the merge proposal (without merging it)."""
        raise NotImplementedError(self.close)

    def is_merged(self):
        """Check whether this merge proposal has been merged."""
        raise NotImplementedError(self.is_merged)


class MergeProposalBuilder(object):
    """Merge proposal creator.

    :param source_branch: Branch to propose for merging
    :param target_branch: Target branch
    """

    hooks = ProposeMergeHooks()

    def __init__(self, source_branch, target_branch):
        self.source_branch = source_branch
        self.target_branch = target_branch

    def get_initial_body(self):
        """Get a body for the proposal for the user to modify.

        :return: a str or None.
        """
        raise NotImplementedError(self.get_initial_body)

    def get_infotext(self):
        """Determine the initial comment for the merge proposal.
        """
        raise NotImplementedError(self.get_infotext)

    def create_proposal(self, description, reviewers=None, labels=None,
                        prerequisite_branch=None):
        """Create a proposal to merge a branch for merging.

        :param description: Description for the merge proposal
        :param reviewers: Optional list of people to ask reviews from
        :param labels: Labels to attach to the proposal
        :param prerequisite_branch: Optional prerequisite branch
        :return: A `MergeProposal` object
        """
        raise NotImplementedError(self.create_proposal)


class Hoster(object):
    """A hosting site manager.
    """

    # Does this hoster support arbitrary labels being attached to merge
    # proposals?
    supports_merge_proposal_labels = None

    # The base_url that would be visible to users. I.e. https://github.com/
    # rather than https://api.github.com/
    base_url = None

    def publish_derived(self, new_branch, base_branch, name, project=None,
                        owner=None, revision_id=None, overwrite=False,
                        allow_lossy=True):
        """Publish a branch to the site, derived from base_branch.

        :param base_branch: branch to derive the new branch from
        :param new_branch: branch to publish
        :return: resulting branch, public URL
        :raise HosterLoginRequired: Action requires a hoster login, but none is
            known.
        """
        raise NotImplementedError(self.publish)

    def get_derived_branch(self, base_branch, name, project=None, owner=None):
        """Get a derived branch ('a fork').
        """
        raise NotImplementedError(self.get_derived_branch)

    def get_push_url(self, branch):
        """Get the push URL for a branch."""
        raise NotImplementedError(self.get_push_url)

    def get_proposer(self, source_branch, target_branch):
        """Get a merge proposal creator.

        :note: source_branch does not have to be hosted by the hoster.

        :param source_branch: Source branch
        :param target_branch: Target branch
        :return: A MergeProposalBuilder object
        """
        raise NotImplementedError(self.get_proposer)

    def iter_proposals(self, source_branch, target_branch, status='open'):
        """Get a merge proposal for a specified branch tuple.

        :param source_branch: Source branch
        :param target_branch: Target branch
        :param status: Status of proposals to iterate over
        :return: Iterate over MergeProposal object
        """
        raise NotImplementedError(self.iter_proposals)

    def hosts(self, branch):
        """Return true if this hoster hosts given branch."""
        raise NotImplementedError(self.hosts)

    @classmethod
    def probe_from_branch(cls, branch):
        """Create a Hoster object if this hoster knows about a branch."""
        url = urlutils.split_segment_parameters(branch.user_url)[0]
        return cls.probe_from_url(url)

    @classmethod
    def probe_from_url(cls, url):
        """Create a Hoster object if this hoster knows about a URL."""
        raise NotImplementedError(cls.probe_from_url)

    # TODO(jelmer): Some way of cleaning up old branch proposals/branches

    def iter_my_proposals(self, status='open'):
        """Iterate over the proposals created by the currently logged in user.

        :param status: Only yield proposals with this status
            (one of: 'open', 'closed', 'merged', 'all')
        :return: Iterator over MergeProposal objects
        :raise HosterLoginRequired: Action requires a hoster login, but none is
            known.
        """
        raise NotImplementedError(self.iter_my_proposals)

    @classmethod
    def iter_instances(cls):
        """Iterate instances.

        :return: Hoster instances
        """
        raise NotImplementedError(cls.iter_instances)


def get_hoster(branch, possible_hosters=None):
    """Find the hoster for a branch."""
    if possible_hosters:
        for hoster in possible_hosters:
            if hoster.hosts(branch):
                return hoster
    for name, hoster_cls in hosters.items():
        try:
            hoster = hoster_cls.probe_from_branch(branch)
        except UnsupportedHoster:
            pass
        else:
            if possible_hosters is not None:
                possible_hosters.append(hoster)
            return hoster
    raise UnsupportedHoster(branch)


hosters = registry.Registry()
hosters.register_lazy(
    "launchpad", "breezy.plugins.propose.launchpad",
    "Launchpad")
hosters.register_lazy(
    "github", "breezy.plugins.propose.github",
    "GitHub")
hosters.register_lazy(
    "gitlab", "breezy.plugins.propose.gitlabs",
    "GitLab")

0.431.1 by Jelmer Vernooĳ Start work on propose command.	1	# Copyright (C) 2018 Breezy Developers
	2	#
	3	# This program is free software; you can redistribute it and/or modify
	4	# it under the terms of the GNU General Public License as published by
	5	# the Free Software Foundation; either version 2 of the License, or
	6	# (at your option) any later version.
	7	#
	8	# This program is distributed in the hope that it will be useful,
	9	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	# GNU General Public License for more details.
	12	#
	13	# You should have received a copy of the GNU General Public License
	14	# along with this program; if not, write to the Free Software
	15	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	16
	17	"""Helper functions for proposing merges."""
	18
	19	from __future__ import absolute_import
	20
	21	from ... import (
	22	errors,
	23	hooks,
	24	registry,
7268.12.3 by Jelmer Vernooĳ Add missing import.	25	urlutils,
0.431.1 by Jelmer Vernooĳ Start work on propose command.	26	)
	27
	28
0.431.38 by Jelmer Vernooĳ Add NoSuchProject.	29	class NoSuchProject(errors.BzrError):
	30
	31	_fmt = "Project does not exist: %(project)s."
	32
	33	def __init__(self, project):
	34	errors.BzrError.__init__(self)
	35	self.project = project
	36
	37
0.431.2 by Jelmer Vernooĳ Add launchpad implementation.	38	class MergeProposalExists(errors.BzrError):
	39
	40	_fmt = "A merge proposal already exists: %(url)s."
	41
	42	def __init__(self, url):
	43	errors.BzrError.__init__(self)
	44	self.url = url
	45
	46
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	47	class UnsupportedHoster(errors.BzrError):
	48
	49	_fmt = "No supported hoster for %(branch)s."
	50
	51	def __init__(self, branch):
	52	errors.BzrError.__init__(self)
	53	self.branch = branch
	54
	55
0.431.1 by Jelmer Vernooĳ Start work on propose command.	56	class ProposeMergeHooks(hooks.Hooks):
	57	"""Hooks for proposing a merge on Launchpad."""
	58
	59	def __init__(self):
	60	hooks.Hooks.__init__(self, __name__, "Proposer.hooks")
0.431.57 by Jelmer Vernooĳ Cleanups.	61	self.add_hook(
0.431.57 by Jelmer Vernooĳ Cleanups.	62	'get_prerequisite',
0.431.1 by Jelmer Vernooĳ Start work on propose command.	63	"Return the prerequisite branch for proposing as merge.", (3, 0))
0.431.57 by Jelmer Vernooĳ Cleanups.	64	self.add_hook(
0.431.57 by Jelmer Vernooĳ Cleanups.	65	'merge_proposal_body',
0.431.1 by Jelmer Vernooĳ Start work on propose command.	66	"Return an initial body for the merge proposal message.", (3, 0))
	67
	68
0.431.13 by Jelmer Vernooĳ Add support for labels on merge proposals.	69	class LabelsUnsupported(errors.BzrError):
	70	"""Labels not supported by this hoster."""
	71
	72	_fmt = "Labels are not supported by %(hoster)r."
	73
	74	def __init__(self, hoster):
	75	errors.BzrError.__init__(self)
	76	self.hoster = hoster
	77
	78
0.431.56 by Jelmer Vernooĳ Add support for prerequisite branches.	79	class PrerequisiteBranchUnsupported(errors.BzrError):
	80	"""Prerequisite branch not supported by this hoster."""
	81
	82	def __init__(self, hoster):
	83	errors.BzrError.__init__(self)
	84	self.hoster = hoster
	85
	86
7268.8.1 by Jelmer Vernooĳ Add HosterLoginRequired exception.	87	class HosterLoginRequired(errors.BzrError):
	88	"""Action requires hoster login credentials."""
	89
7268.8.2 by Jelmer Vernooĳ Handle GitHub errors.	90	_fmt = "Action requires credentials for hosting site %(hoster)r."""
7268.8.2 by Jelmer Vernooĳ Handle GitHub errors.	91
7268.8.1 by Jelmer Vernooĳ Add HosterLoginRequired exception.	92	def __init__(self, hoster):
	93	errors.BzrError.__init__(self)
	94	self.hoster = hoster
	95
	96
0.431.3 by Jelmer Vernooĳ Add a MergeProposal object.	97	class MergeProposal(object):
	98	"""A merge proposal.
	99
	100	:ivar url: URL for the merge proposal
	101	"""
	102
	103	def __init__(self, url=None):
	104	self.url = url
	105
0.431.39 by Jelmer Vernooĳ Extend the merge proposal abstraction a bit.	106	def get_description(self):
	107	"""Get the description of the merge proposal."""
	108	raise NotImplementedError(self.get_description)
	109
	110	def set_description(self, description):
	111	"""Set the description of the merge proposal."""
	112	raise NotImplementedError(self.set_description)
	113
0.431.64 by Jelmer Vernooĳ Add get_source_branch_url/get_target_branch_url methods.	114	def get_source_branch_url(self):
	115	"""Return the source branch."""
	116	raise NotImplementedError(self.get_source_branch_url)
	117
	118	def get_target_branch_url(self):
	119	"""Return the target branch."""
	120	raise NotImplementedError(self.get_target_branch_url)
	121
0.431.39 by Jelmer Vernooĳ Extend the merge proposal abstraction a bit.	122	def close(self):
	123	"""Close the merge proposal (without merging it)."""
	124	raise NotImplementedError(self.close)
	125
0.431.46 by Jelmer Vernooĳ Add MergeProposal.is_merged.	126	def is_merged(self):
	127	"""Check whether this merge proposal has been merged."""
	128	raise NotImplementedError(self.is_merged)
	129
0.431.3 by Jelmer Vernooĳ Add a MergeProposal object.	130
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	131	class MergeProposalBuilder(object):
0.431.1 by Jelmer Vernooĳ Start work on propose command.	132	"""Merge proposal creator.
	133
	134	:param source_branch: Branch to propose for merging
	135	:param target_branch: Target branch
	136	"""
	137
	138	hooks = ProposeMergeHooks()
	139
	140	def __init__(self, source_branch, target_branch):
	141	self.source_branch = source_branch
	142	self.target_branch = target_branch
	143
0.431.2 by Jelmer Vernooĳ Add launchpad implementation.	144	def get_initial_body(self):
	145	"""Get a body for the proposal for the user to modify.
	146
	147	:return: a str or None.
	148	"""
	149	raise NotImplementedError(self.get_initial_body)
	150
	151	def get_infotext(self):
	152	"""Determine the initial comment for the merge proposal.
	153	"""
	154	raise NotImplementedError(self.get_infotext)
	155
0.431.56 by Jelmer Vernooĳ Add support for prerequisite branches.	156	def create_proposal(self, description, reviewers=None, labels=None,
	157	prerequisite_branch=None):
0.431.1 by Jelmer Vernooĳ Start work on propose command.	158	"""Create a proposal to merge a branch for merging.
0.431.2 by Jelmer Vernooĳ Add launchpad implementation.	159
0.431.2 by Jelmer Vernooĳ Add launchpad implementation.	160	:param description: Description for the merge proposal
0.431.5 by Jelmer Vernooĳ Initial work on gitlab support.	161	:param reviewers: Optional list of people to ask reviews from
0.431.13 by Jelmer Vernooĳ Add support for labels on merge proposals.	162	:param labels: Labels to attach to the proposal
0.431.56 by Jelmer Vernooĳ Add support for prerequisite branches.	163	:param prerequisite_branch: Optional prerequisite branch
0.431.3 by Jelmer Vernooĳ Add a MergeProposal object.	164	:return: A `MergeProposal` object
0.431.1 by Jelmer Vernooĳ Start work on propose command.	165	"""
	166	raise NotImplementedError(self.create_proposal)
	167
	168
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	169	class Hoster(object):
	170	"""A hosting site manager.
	171	"""
	172
7260.1.1 by Jelmer Vernooĳ Add .base_url property to Hoster.	173	# Does this hoster support arbitrary labels being attached to merge
	174	# proposals?
0.431.13 by Jelmer Vernooĳ Add support for labels on merge proposals.	175	supports_merge_proposal_labels = None
	176
7260.1.1 by Jelmer Vernooĳ Add .base_url property to Hoster.	177	# The base_url that would be visible to users. I.e. https://github.com/
	178	# rather than https://api.github.com/
	179	base_url = None
	180
0.431.20 by Jelmer Vernooĳ publish -> publish_derived.	181	def publish_derived(self, new_branch, base_branch, name, project=None,
0.431.51 by Jelmer Vernooĳ Allow fallback to lossy by default.	182	owner=None, revision_id=None, overwrite=False,
	183	allow_lossy=True):
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	184	"""Publish a branch to the site, derived from base_branch.
	185
	186	:param base_branch: branch to derive the new branch from
	187	:param new_branch: branch to publish
0.432.3 by Jelmer Vernooĳ Publish command works for github.	188	:return: resulting branch, public URL
7268.8.1 by Jelmer Vernooĳ Add HosterLoginRequired exception.	189	:raise HosterLoginRequired: Action requires a hoster login, but none is
	190	known.
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	191	"""
	192	raise NotImplementedError(self.publish)
	193
0.431.22 by Jelmer Vernooĳ Add Hoster.get_derived_branch.	194	def get_derived_branch(self, base_branch, name, project=None, owner=None):
0.431.31 by Jelmer Vernooĳ Drop autopropose command.	195	"""Get a derived branch ('a fork').
0.431.31 by Jelmer Vernooĳ Drop autopropose command.	196	"""
0.431.22 by Jelmer Vernooĳ Add Hoster.get_derived_branch.	197	raise NotImplementedError(self.get_derived_branch)
0.431.22 by Jelmer Vernooĳ Add Hoster.get_derived_branch.	198
0.431.28 by Jelmer Vernooĳ Implement Hoster.get_push_url.	199	def get_push_url(self, branch):
	200	"""Get the push URL for a branch."""
	201	raise NotImplementedError(self.get_push_url)
	202
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	203	def get_proposer(self, source_branch, target_branch):
	204	"""Get a merge proposal creator.
	205
0.431.31 by Jelmer Vernooĳ Drop autopropose command.	206	:note: source_branch does not have to be hosted by the hoster.
0.431.31 by Jelmer Vernooĳ Drop autopropose command.	207
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	208	:param source_branch: Source branch
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	209	:param target_branch: Target branch
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	210	:return: A MergeProposalBuilder object
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	211	"""
	212	raise NotImplementedError(self.get_proposer)
	213
0.431.68 by Jelmer Vernooĳ Add status to other Hosters.	214	def iter_proposals(self, source_branch, target_branch, status='open'):
0.431.35 by Jelmer Vernooĳ Add Hoster.get_proposal.	215	"""Get a merge proposal for a specified branch tuple.
	216
	217	:param source_branch: Source branch
	218	:param target_branch: Target branch
0.431.68 by Jelmer Vernooĳ Add status to other Hosters.	219	:param status: Status of proposals to iterate over
0.431.67 by Jelmer Vernooĳ Support multiple merge proposals per branch.	220	:return: Iterate over MergeProposal object
0.431.35 by Jelmer Vernooĳ Add Hoster.get_proposal.	221	"""
0.431.67 by Jelmer Vernooĳ Support multiple merge proposals per branch.	222	raise NotImplementedError(self.iter_proposals)
0.431.35 by Jelmer Vernooĳ Add Hoster.get_proposal.	223
0.433.1 by Jelmer Vernooĳ Add Hoster.hosts.	224	def hosts(self, branch):
	225	"""Return true if this hoster hosts given branch."""
	226	raise NotImplementedError(self.hosts)
	227
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	228	@classmethod
7268.12.1 by Jelmer Vernooĳ Split out probe_from_url.	229	def probe_from_branch(cls, branch):
0.432.9 by Jelmer Vernooĳ Drop is_compatible nonesense.	230	"""Create a Hoster object if this hoster knows about a branch."""
7268.12.1 by Jelmer Vernooĳ Split out probe_from_url.	231	url = urlutils.split_segment_parameters(branch.user_url)[0]
	232	return cls.probe_from_url(url)
	233
	234	@classmethod
	235	def probe_from_url(cls, url):
	236	"""Create a Hoster object if this hoster knows about a URL."""
	237	raise NotImplementedError(cls.probe_from_url)
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	238
0.432.4 by Jelmer Vernooĳ Some work on gitlab.	239	# TODO(jelmer): Some way of cleaning up old branch proposals/branches
0.432.4 by Jelmer Vernooĳ Some work on gitlab.	240
0.431.66 by Jelmer Vernooĳ Add support for status argument.	241	def iter_my_proposals(self, status='open'):
0.431.63 by Jelmer Vernooĳ Add 'brz my-proposals' command.	242	"""Iterate over the proposals created by the currently logged in user.
0.431.63 by Jelmer Vernooĳ Add 'brz my-proposals' command.	243
0.431.66 by Jelmer Vernooĳ Add support for status argument.	244	:param status: Only yield proposals with this status
0.431.66 by Jelmer Vernooĳ Add support for status argument.	245	(one of: 'open', 'closed', 'merged', 'all')
0.431.63 by Jelmer Vernooĳ Add 'brz my-proposals' command.	246	:return: Iterator over MergeProposal objects
7268.8.1 by Jelmer Vernooĳ Add HosterLoginRequired exception.	247	:raise HosterLoginRequired: Action requires a hoster login, but none is
	248	known.
0.431.63 by Jelmer Vernooĳ Add 'brz my-proposals' command.	249	"""
	250	raise NotImplementedError(self.iter_my_proposals)
	251
	252	@classmethod
	253	def iter_instances(cls):
	254	"""Iterate instances.
	255
	256	:return: Hoster instances
	257	"""
	258	raise NotImplementedError(cls.iter_instances)
	259
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	260
0.433.1 by Jelmer Vernooĳ Add Hoster.hosts.	261	def get_hoster(branch, possible_hosters=None):
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	262	"""Find the hoster for a branch."""
0.433.1 by Jelmer Vernooĳ Add Hoster.hosts.	263	if possible_hosters:
	264	for hoster in possible_hosters:
	265	if hoster.hosts(branch):
	266	return hoster
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	267	for name, hoster_cls in hosters.items():
0.432.9 by Jelmer Vernooĳ Drop is_compatible nonesense.	268	try:
7268.12.1 by Jelmer Vernooĳ Split out probe_from_url.	269	hoster = hoster_cls.probe_from_branch(branch)
0.432.9 by Jelmer Vernooĳ Drop is_compatible nonesense.	270	except UnsupportedHoster:
0.432.9 by Jelmer Vernooĳ Drop is_compatible nonesense.	271	pass
0.433.1 by Jelmer Vernooĳ Add Hoster.hosts.	272	else:
	273	if possible_hosters is not None:
	274	possible_hosters.append(hoster)
	275	return hoster
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	276	raise UnsupportedHoster(branch)
	277
	278
	279	hosters = registry.Registry()
	280	hosters.register_lazy(
7211.13.7 by Jelmer Vernooĳ Fix formatting.	281	"launchpad", "breezy.plugins.propose.launchpad",
	282	"Launchpad")
	283	hosters.register_lazy(
	284	"github", "breezy.plugins.propose.github",
	285	"GitHub")
	286	hosters.register_lazy(
	287	"gitlab", "breezy.plugins.propose.gitlabs",
	288	"GitLab")