EVOLUTION-MANAGER

Edit File: bazaar.py

"""A client for Bazaar and Breezy."""

from __future__ import unicode_literals

import logging
import os
import re

import six

from rbtools.clients import SCMClient, RepositoryInfo
from rbtools.clients.errors import TooManyRevisionsError
from rbtools.utils.checks import check_install
from rbtools.utils.diffs import filter_diff, normalize_patterns
from rbtools.utils.process import execute

USING_PARENT_PREFIX = 'Using parent branch '

class BazaarClient(SCMClient):
    """A client for Bazaar and Breezy.

This is a wrapper that fetches repository information and generates
    compatible diffs.

It supports the legacy Bazaar client, as well as the modern Breezy.

Version Changed:
        2.0.1:
        Added support for Breezy.
    """

name = 'Bazaar'
    supports_diff_exclude_patterns = True
    can_branch = True

INDEX_FILE_RE = re.compile(b"===.+'(.+?)'\n")

# Regular expression that matches the path to the current branch.
    #
    # For branches with shared repositories, Bazaar reports
    # "repository branch: /foo", but for standalone branches it reports
    # "branch root: /foo".
    BRANCH_REGEX = (
        r'\w*(repository branch|branch root|checkout root|checkout of branch):'
        r' (?P<branch_path>.+)$')

# Revision separator (two ..s without escaping, and not followed by a /).
    # This is the same regex used in bzrlib/option.py:_parse_revision_spec.
    REVISION_SEPARATOR_REGEX = re.compile(r'\.\.(?![\\/])')

def __init__(self, **kwargs):
        """Initialize the client.

Args:
            **kwargs (dict):
                Keyword arguments to pass through to the base class.
        """
        super(BazaarClient, self).__init__(**kwargs)

# The command used to execute bzr. This will be 'brz' if Breezy
        # is used. This will be updated later.
        self.bzr = 'bzr'

# Separately (since either bzr or brz might be used), we want to
        # maintain a flag indicating if this is Breezy, since it changes
        # some semantics.
        self.is_breezy = False

def get_repository_info(self):
        """Return repository information for the current working tree.

Returns:
            rbtools.clients.RepositoryInfo:
            The repository info structure.
        """
        if check_install(['brz', 'help']):
            # This is Breezy.
            self.bzr = 'brz'
            self.is_breezy = True
        elif check_install(['bzr', 'help']):
            # This is either a legacy Bazaar (aliased to bzr) or the
            # modern Breezy. Let's find out.
            version = execute(['bzr', '--version'],
                              ignore_errors=True)

self.is_breezy = version.startswith('Breezy')
            self.bzr = 'bzr'
        else:
            logging.debug('Unable to execute "brz help" or "bzr help": '
                          'skipping Bazaar')
            return None

bzr_info = execute([self.bzr, 'info'], ignore_errors=True)

if 'ERROR: Not a branch:' in bzr_info:
            # This is not a branch:
            repository_info = None
        elif '(format: git)' in bzr_info:
            # This is a Git repository, which Breezy will happily use, but
            # we want to prioritize Git.
            repository_info = None
        else:
            # This is a branch, let's get its attributes:
            branch_match = re.search(self.BRANCH_REGEX, bzr_info, re.MULTILINE)

path = branch_match.group('branch_path')

if path == '.':
                path = os.getcwd()

repository_info = RepositoryInfo(
                path=path,
                base_path='/',  # Diffs are always relative to the root.
                local_path=path,
                supports_parent_diffs=True)

return repository_info

def parse_revision_spec(self, revisions=[]):
        """Parse the given revision spec.

Args:
            revisions (list of unicode, optional):
                A list of revisions as specified by the user. Items in the
                list do not necessarily represent a single revision, since the
                user can use SCM-native syntaxes such as ``r1..r2`` or
                ``r1:r2``. SCMTool-specific overrides of this method are
                expected to deal with such syntaxes.

Raises:
            rbtools.clients.errors.InvalidRevisionSpecError:
                The given revisions could not be parsed.

rbtools.clients.errors.TooManyRevisionsError:
                The specified revisions list contained too many revisions.

Returns:
            dict:
            A dictionary with the following keys:

``base`` (:py:class:`unicode`):
                A revision to use as the base of the resulting diff.

``tip`` (:py:class:`unicode`):
                A revision to use as the tip of the resulting diff.

``parent_base`` (:py:class:`unicode`, optional):
                The revision to use as the base of a parent diff.

These will be used to generate the diffs to upload to Review Board
            (or print). The diff for review will include the changes in (base,
            tip], and the parent diff (if necessary) will include (parent,
            base].

If a single revision is passed in, this will return the parent of
            that revision for "base" and the passed-in revision for "tip".

If zero revisions are passed in, this will return the current HEAD
            as 'tip', and the upstream branch as 'base', taking into account
            parent branches explicitly specified via --parent.
        """
        n_revs = len(revisions)
        result = {}

if n_revs == 0:
            # No revisions were passed in--start with HEAD, and find the
            # submit branch automatically.
            result['tip'] = self._get_revno()
            result['base'] = self._get_revno('ancestor:')
        elif n_revs == 1 or n_revs == 2:
            # If there's a single argument, try splitting it on '..'
            if n_revs == 1:
                revisions = self.REVISION_SEPARATOR_REGEX.split(revisions[0])
                n_revs = len(revisions)

if n_revs == 1:
                # Single revision. Extract the parent of that revision to use
                # as the base.
                result['base'] = self._get_revno('before:' + revisions[0])
                result['tip'] = self._get_revno(revisions[0])
            elif n_revs == 2:
                # Two revisions.
                result['base'] = self._get_revno(revisions[0])
                result['tip'] = self._get_revno(revisions[1])
            else:
                raise TooManyRevisionsError

# XXX: I tried to automatically find the parent diff revision here,
            # but I really don't understand the difference between submit
            # branch, parent branch, bound branches, etc. If there's some way
            # to know what to diff against, we could use
            #     'bzr missing --mine-only --my-revision=(base) --line'
            # to see if we need a parent diff.
        else:
            raise TooManyRevisionsError

if self.options.parent_branch:
            result['parent_base'] = result['base']
            result['base'] = self._get_revno(
                'ancestor:%s' % self.options.parent_branch)

return result

def _get_revno(self, revision_spec=None):
        """Convert a revision spec to a revision number.

Args:
            revision_spec (unicode, optional):
                The revision spec to convert.

Returns:
            unicode:
            A new revision spec that contains a revision number instead of a
            symbolic revision.
        """
        command = [self.bzr, 'revno']

if revision_spec:
            command += ['-r', revision_spec]

result = execute(command).strip().split('\n')

if len(result) == 1:
            return 'revno:' + result[0]
        elif len(result) == 2 and result[0].startswith(USING_PARENT_PREFIX):
            branch = result[0][len(USING_PARENT_PREFIX):]
            return 'revno:%s:%s' % (result[1], branch)
        else:
            return None

def diff(self, revisions, include_files=[], exclude_patterns=[],
             extra_args=[], **kwargs):
        """Perform a diff using the given revisions.

If the revision spec is empty, this returns the diff of the current
        branch with respect to its parent. If a single revision is passed in,
        this returns the diff of the change introduced in that revision. If two
        revisions are passed in, this will do a diff between those two
        revisions.

Args:
            revisions (dict):
                A dictionary of revisions, as returned by
                :py:meth:`parse_revision_spec`.

include_files (list of unicode, optional):
                A list of files to whitelist during the diff generation.

exclude_patterns (list of unicode, optional):
                A list of shell-style glob patterns to blacklist during diff
                generation.

extra_args (list, unused):
                Additional arguments to be passed to the diff generation.
                Unused for Bazaar.

**kwargs (dict, unused):
                Unused keyword arguments.

Returns:
            dict:
            A dictionary containing the following keys:

``diff`` (:py:class:`bytes`):
                The contents of the diff to upload.

``parent_diff`` (:py:class:`bytes`, optional):
                The contents of the parent diff, if available.
        """
        exclude_patterns = normalize_patterns(exclude_patterns,
                                              self.get_repository_info().path)

diff = self._get_range_diff(revisions['base'], revisions['tip'],
                                    include_files, exclude_patterns)

if 'parent_base' in revisions:
            parent_diff = self._get_range_diff(
                revisions['parent_base'], revisions['base'], include_files,
                exclude_patterns)
        else:
            parent_diff = None

return {
            'diff': diff,
            'parent_diff': parent_diff,
        }

def _get_range_diff(self, base, tip, include_files, exclude_patterns=[]):
        """Return the diff between 'base' and 'tip'.

Args:
            base (unicode):
                The name of the base revision.

tip (unicode):
                The name of the tip revision.

include_files (list of unicode):
                A list of files to whitelist during the diff generation.

exclude_patterns (list of unicode, optional):
                A list of shell-style glob patterns to blacklist during diff
                generation.

Returns:
            bytes:
            The generated diff contents.
        """
        diff_cmd = [
            self.bzr,
            'diff',
            '-q',
        ]

if self.is_breezy:
            # Turn off the "old/" and "new/" prefixes. This is mostly to
            # ensure consistency with legacy Bazaar and for compatibility
            # with versions of Review Board that expect legacy Bazaar diffs.
            diff_cmd.append('--prefix=:')

diff_cmd += [
            '-r',
            '%s..%s' % (base, tip),
        ] + include_files

diff = execute(diff_cmd, ignore_errors=True, log_output_on_error=False,
                       split_lines=True, results_unicode=False)

if diff:
            if exclude_patterns:
                diff = filter_diff(diff, self.INDEX_FILE_RE, exclude_patterns,
                                   base_dir=self.get_repository_info().path)

return b''.join(diff)
        else:
            return None

def get_raw_commit_message(self, revisions):
        """Extract the commit message based on the provided revision range.

Args:
            revisions (dict):
                A dictionary containing ``base`` and ``tip`` keys.

Returns:
            unicode:
            The commit messages of all commits between (base, tip].
        """
        # The result is content in the form of:
        #
        # 2014-01-02  First Name  <email@address>
        #
        # <tab>line 1
        # <tab>line 2
        # <tab>...
        #
        # 2014-01-02  First Name  <email@address>
        #
        # ...
        log_cmd = [
            self.bzr,
            'log',
            '-r',
            '%s..%s' % (revisions['base'], revisions['tip']),
        ]

# Find out how many commits there are, then log limiting to one fewer.
        # This is because diff treats the range as (r1, r2] while log treats
        # the lange as [r1, r2].
        lines = execute(log_cmd + ['--line'],
                        ignore_errors=True, split_lines=True)
        n_revs = len(lines) - 1

lines = execute(
            log_cmd + ['--gnu-changelog', '-l', six.text_type(n_revs)],
            ignore_errors=True,
            split_lines=True)

message = []

for line in lines:
            # We only care about lines that start with a tab (commit message
            # lines) or blank lines.
            if line.startswith('\t'):
                message.append(line[1:])
            elif not line.strip():
                message.append(line)

return ''.join(message).strip()

def get_current_branch(self):
        """Return the name of the current branch.

Returns:
            unicode:
            A string with the name of the current branch.
        """
        return execute([self.bzr, 'nick'], ignore_errors=True).strip()