/brz/remove-bazaar

# Copyright (C) 2005, 2006, 2007 Canonical Ltd

# -*- coding: utf-8 -*-

#

# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

"""Black-box tests for bzr log."""

import os, re

from bzrlib import osutils

from bzrlib.tests.blackbox import ExternalBase

from bzrlib.tests import TestCaseInTempDir, TestCaseWithTransport

from bzrlib.tests.test_log import (

    normalize_log,

    )

from bzrlib.tests import test_log

class TestCaseWithoutPropsHandler(ExternalBase,

                                  test_log.TestCaseWithoutPropsHandler):

    pass

class TestLog(ExternalBase):

    def _prepare(self, path='.', format=None):

        tree = self.make_branch_and_tree(path, format=format)

        self.build_tree(

            [path + '/hello.txt', path + '/goodbye.txt', path + '/meep.txt'])

        tree.add('hello.txt')

        tree.commit(message='message1')

        tree.add('goodbye.txt')

        tree.commit(message='message2')

        tree.add('meep.txt')

        tree.commit(message='message3')

        self.full_log = self.run_bzr(["log", path])[0]

        return tree

    def test_log_null_end_revspec(self):

        self._prepare()

        self.assertTrue('revno: 1\n' in self.full_log)

        self.assertTrue('revno: 2\n' in self.full_log)

        self.assertTrue('revno: 3\n' in self.full_log)

        self.assertTrue('message:\n  message1\n' in self.full_log)

        self.assertTrue('message:\n  message2\n' in self.full_log)

        self.assertTrue('message:\n  message3\n' in self.full_log)

        log = self.run_bzr("log -r 1..")[0]

        self.assertEqualDiff(log, self.full_log)

    def test_log_null_begin_revspec(self):

        self._prepare()

        log = self.run_bzr("log -r ..3")[0]

        self.assertEqualDiff(self.full_log, log)

    def test_log_null_both_revspecs(self):

        self._prepare()

        log = self.run_bzr("log -r ..")[0]

        self.assertEqualDiff(self.full_log, log)

    def test_log_zero_revspec(self):

        self._prepare()

        self.run_bzr_error('bzr: ERROR: Logging revision 0 is invalid.',

                           ['log', '-r0'])

    def test_log_zero_begin_revspec(self):

        self._prepare()

        self.run_bzr_error('bzr: ERROR: Logging revision 0 is invalid.',

                           ['log', '-r0..2'])

    def test_log_zero_end_revspec(self):

        self._prepare()

        self.run_bzr_error('bzr: ERROR: Logging revision 0 is invalid.',

                           ['log', '-r-2..0'])

    def test_log_unsupported_timezone(self):

        self._prepare()

        self.run_bzr_error('bzr: ERROR: Unsupported timezone format "foo", '

                           'options are "utc", "original", "local".',

                           ['log', '--timezone', 'foo'])

    def test_log_negative_begin_revspec_full_log(self):

        self._prepare()

        log = self.run_bzr("log -r -3..")[0]

        self.assertEqualDiff(self.full_log, log)

    def test_log_negative_both_revspec_full_log(self):

        self._prepare()

        log = self.run_bzr("log -r -3..-1")[0]

        self.assertEqualDiff(self.full_log, log)

    def test_log_negative_both_revspec_partial(self):

        self._prepare()

        log = self.run_bzr("log -r -3..-2")[0]

        self.assertTrue('revno: 1\n' in log)

        self.assertTrue('revno: 2\n' in log)

        self.assertTrue('revno: 3\n' not in log)

    def test_log_negative_begin_revspec(self):

        self._prepare()

        log = self.run_bzr("log -r -2..")[0]

        self.assertTrue('revno: 1\n' not in log)

        self.assertTrue('revno: 2\n' in log)

        self.assertTrue('revno: 3\n' in log)

    def test_log_positive_revspecs(self):

        self._prepare()

        log = self.run_bzr("log -r 1..3")[0]

        self.assertEqualDiff(self.full_log, log)

    def test_log_reversed_revspecs(self):

        self._prepare()

        self.run_bzr_error(('bzr: ERROR: Start revision must be older than '

                            'the end revision.\n',),

                           ['log', '-r3..1'])

    def test_log_revno_n_path(self):

        self._prepare(path='branch1')

        self._prepare(path='branch2')

        log = self.run_bzr("log -r revno:2:branch1..revno:3:branch2",

                          retcode=3)[0]

        log = self.run_bzr("log -r revno:1:branch2..revno:3:branch2")[0]

        self.assertEqualDiff(self.full_log, log)

        log = self.run_bzr("log -r revno:1:branch2")[0]

        self.assertTrue('revno: 1\n' in log)

        self.assertTrue('revno: 2\n' not in log)

        self.assertTrue('branch nick: branch2\n' in log)

        self.assertTrue('branch nick: branch1\n' not in log)

    def test_log_nonexistent_revno(self):

        self._prepare()

        (out, err) = self.run_bzr_error(args="log -r 1234",

            error_regexes=["bzr: ERROR: Requested revision: '1234' "

                "does not exist in branch:"])

    def test_log_nonexistent_dotted_revno(self):

        self._prepare()

        (out, err) = self.run_bzr_error(args="log -r 123.123",

            error_regexes=["bzr: ERROR: Requested revision: '123.123' "

                "does not exist in branch:"])

    def test_log_change_revno(self):

        self._prepare()

        expected_log = self.run_bzr("log -r 1")[0]

        log = self.run_bzr("log -c 1")[0]

        self.assertEqualDiff(expected_log, log)

    def test_log_change_nonexistent_revno(self):

        self._prepare()

        (out, err) = self.run_bzr_error(args="log -c 1234",

            error_regexes=["bzr: ERROR: Requested revision: '1234' "

                "does not exist in branch:"])

    def test_log_change_nonexistent_dotted_revno(self):

        self._prepare()

        (out, err) = self.run_bzr_error(args="log -c 123.123",

            error_regexes=["bzr: ERROR: Requested revision: '123.123' "

                "does not exist in branch:"])

    def test_log_change_single_revno(self):

        self._prepare()

        self.run_bzr_error('bzr: ERROR: Option --change does not'

                           ' accept revision ranges',

                           ['log', '--change', '2..3'])

    def test_log_change_incompatible_with_revision(self):

        self._prepare()

        self.run_bzr_error('bzr: ERROR: --revision and --change'

                           ' are mutually exclusive',

                           ['log', '--change', '2', '--revision', '3'])

    def test_log_nonexistent_file(self):

        # files that don't exist in either the basis tree or working tree

        # should give an error

        wt = self.make_branch_and_tree('.')

        out, err = self.run_bzr('log does-not-exist', retcode=3)

        self.assertContainsRe(

            err, 'Path does not have any revision history: does-not-exist')

    def test_log_with_tags(self):

        tree = self._prepare(format='dirstate-tags')

        branch = tree.branch

        branch.tags.set_tag('tag1', branch.get_rev_id(1))

        branch.tags.set_tag('tag1.1', branch.get_rev_id(1))

        branch.tags.set_tag('tag3', branch.last_revision())

        log = self.run_bzr("log -r-1")[0]

        self.assertTrue('tags: tag3' in log)

        log = self.run_bzr("log -r1")[0]

        # I guess that we can't know the order of tags in the output

        # since dicts are unordered, need to check both possibilities

        self.assertContainsRe(log, r'tags: (tag1, tag1\.1|tag1\.1, tag1)')

    def test_merged_log_with_tags(self):

        branch1_tree = self._prepare(path='branch1', format='dirstate-tags')

        branch1 = branch1_tree.branch

        branch2_tree = branch1_tree.bzrdir.sprout('branch2').open_workingtree()

        branch1_tree.commit(message='foobar', allow_pointless=True)

        branch1.tags.set_tag('tag1', branch1.last_revision())

        os.chdir('branch2')

        self.run_bzr('merge ../branch1') # tags don't propagate otherwise

        branch2_tree.commit(message='merge branch 1')

        log = self.run_bzr("log -r-1")[0]

        self.assertContainsRe(log, r'    tags: tag1')

        log = self.run_bzr("log -r3.1.1")[0]

        self.assertContainsRe(log, r'tags: tag1')

    def test_log_limit(self):

        tree = self.make_branch_and_tree('.')

        # We want more commits than our batch size starts at

        for pos in range(10):

            tree.commit("%s" % pos)

        log = self.run_bzr("log --limit 2")[0]

        self.assertNotContainsRe(log, r'revno: 1\n')

        self.assertNotContainsRe(log, r'revno: 2\n')

        self.assertNotContainsRe(log, r'revno: 3\n')

        self.assertNotContainsRe(log, r'revno: 4\n')

        self.assertNotContainsRe(log, r'revno: 5\n')

        self.assertNotContainsRe(log, r'revno: 6\n')

        self.assertNotContainsRe(log, r'revno: 7\n')

        self.assertNotContainsRe(log, r'revno: 8\n')

        self.assertContainsRe(log, r'revno: 9\n')

        self.assertContainsRe(log, r'revno: 10\n')

    def test_log_limit_short(self):

        self._prepare()

        log = self.run_bzr("log -l 2")[0]

        self.assertNotContainsRe(log, r'revno: 1\n')

        self.assertContainsRe(log, r'revno: 2\n')

        self.assertContainsRe(log, r'revno: 3\n')

class TestLogVerbose(TestCaseWithTransport):

    def setUp(self):

        super(TestLogVerbose, self).setUp()

        tree = self.make_branch_and_tree('.')

        self.build_tree(['hello.txt'])

        tree.add('hello.txt')

        tree.commit(message='message1')

    def assertUseShortDeltaFormat(self, cmd):

        log = self.run_bzr(cmd)[0]

        # Check that we use the short status format

        self.assertContainsRe(log, '(?m)^A  hello.txt$')

        self.assertNotContainsRe(log, '(?m)^added:$')

    def assertUseLongDeltaFormat(self, cmd):

        log = self.run_bzr(cmd)[0]

        # Check that we use the long status format

        self.assertNotContainsRe(log, '(?m)^A  hello.txt$')

        self.assertContainsRe(log, '(?m)^added:$')

    def test_log_short_verbose(self):

        self.assertUseShortDeltaFormat(['log', '--short', '-v'])

    def test_log_short_verbose_verbose(self):

        self.assertUseLongDeltaFormat(['log', '--short', '-vv'])

    def test_log_long_verbose(self):

        # Check that we use the long status format, ignoring the verbosity

        # level

        self.assertUseLongDeltaFormat(['log', '--long', '-v'])

    def test_log_long_verbose_verbose(self):

        # Check that we use the long status format, ignoring the verbosity

        # level

        self.assertUseLongDeltaFormat(['log', '--long', '-vv'])

class TestLogMerges(TestCaseWithoutPropsHandler):

    def _prepare(self):

        parent_tree = self.make_branch_and_tree('parent')

        parent_tree.commit(message='first post', allow_pointless=True)

        child_tree = parent_tree.bzrdir.sprout('child').open_workingtree()

        child_tree.commit(message='branch 1', allow_pointless=True)

        smaller_tree = \

                child_tree.bzrdir.sprout('smallerchild').open_workingtree()

        smaller_tree.commit(message='branch 2', allow_pointless=True)

        child_tree.merge_from_branch(smaller_tree.branch)

        child_tree.commit(message='merge branch 2')

        parent_tree.merge_from_branch(child_tree.branch)

        parent_tree.commit(message='merge branch 1')

        os.chdir('parent')

    def test_merges_are_indented_by_level(self):

        self._prepare()

        out,err = self.run_bzr('log')

        self.assertEqual('', err)

        log = normalize_log(out)

        self.assertEqualDiff(log, """\

------------------------------------------------------------

revno: 2

committer: Lorem Ipsum <test@example.com>

branch nick: parent

timestamp: Just now

message:

  merge branch 1

    ------------------------------------------------------------

    revno: 1.1.2

    committer: Lorem Ipsum <test@example.com>

    branch nick: child

    timestamp: Just now

    message:

      merge branch 2

        ------------------------------------------------------------

        revno: 1.2.1

        committer: Lorem Ipsum <test@example.com>

        branch nick: smallerchild

        timestamp: Just now

        message:

          branch 2

    ------------------------------------------------------------

    revno: 1.1.1

    committer: Lorem Ipsum <test@example.com>

    branch nick: child

    timestamp: Just now

    message:

      branch 1

------------------------------------------------------------

revno: 1

committer: Lorem Ipsum <test@example.com>

branch nick: parent

timestamp: Just now

message:

  first post

""")

    def test_merges_single_merge_rev(self):

        self._prepare()

        out,err = self.run_bzr('log -r1.1.2')

        self.assertEqual('', err)

        log = normalize_log(out)

        self.assertEqualDiff(log, """\

------------------------------------------------------------

revno: 1.1.2

committer: Lorem Ipsum <test@example.com>

branch nick: child

timestamp: Just now

message:

  merge branch 2

    ------------------------------------------------------------

    revno: 1.2.1

    committer: Lorem Ipsum <test@example.com>

    branch nick: smallerchild

    timestamp: Just now

    message:

      branch 2

""")

    def test_merges_partial_range(self):

        self._prepare()

        out, err = self.run_bzr('log -r1.1.1..1.1.2')

        self.assertEqual('', err)

        log = normalize_log(out)

        self.assertEqualDiff(log, """\

------------------------------------------------------------

revno: 1.1.2

committer: Lorem Ipsum <test@example.com>

branch nick: child

timestamp: Just now

message:

  merge branch 2

    ------------------------------------------------------------

    revno: 1.2.1

    committer: Lorem Ipsum <test@example.com>

    branch nick: smallerchild

    timestamp: Just now

    message:

      branch 2

------------------------------------------------------------

revno: 1.1.1

committer: Lorem Ipsum <test@example.com>

branch nick: child

timestamp: Just now

message:

  branch 1

""")

    def test_merges_nonsupporting_formatter(self):

        self._prepare()

        err_msg = 'Selected log formatter only supports mainline revisions.'

        # The single revision case is tested in the core tests

        # since all standard formatters support single merge revisions.

        out,err = self.run_bzr('log --short -r1..1.1.2', retcode=3)

        self.assertContainsRe(err, err_msg)

        out,err = self.run_bzr('log --short -r1.1.1..1.1.2', retcode=3)

        self.assertContainsRe(err, err_msg)

def subst_dates(string):

    """Replace date strings with constant values."""

    return re.sub(r'\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-\+]\d{4}',

                  'YYYY-MM-DD HH:MM:SS +ZZZZ', string)

class TestLogDiff(TestCaseWithoutPropsHandler):

    def _prepare(self):

        parent_tree = self.make_branch_and_tree('parent')

        self.build_tree(['parent/file1', 'parent/file2'])

        parent_tree.add('file1')

        parent_tree.add('file2')

        parent_tree.commit(message='first post',

            timestamp=1132586655, timezone=36000,

            committer='Lorem Ipsum <test@example.com>')

        child_tree = parent_tree.bzrdir.sprout('child').open_workingtree()

        self.build_tree_contents([('child/file2', 'hello\n')])

        child_tree.commit(message='branch 1',

            timestamp=1132586700, timezone=36000,

            committer='Lorem Ipsum <test@example.com>')

        parent_tree.merge_from_branch(child_tree.branch)

        parent_tree.commit(message='merge branch 1',

            timestamp=1132586800, timezone=36000,

            committer='Lorem Ipsum <test@example.com>')

        os.chdir('parent')

    def test_log_show_diff_long(self):

        self._prepare()

        out,err = self.run_bzr('log -p')

        self.assertEqual('', err)

        log = normalize_log(out)

        self.assertEqualDiff(subst_dates(log), """\

------------------------------------------------------------

revno: 2

committer: Lorem Ipsum <test@example.com>

branch nick: parent

timestamp: Just now

message:

  merge branch 1

diff:

=== modified file 'file2'

--- file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

+++ file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

@@ -1,1 +1,1 @@

-contents of parent/file2

+hello

    ------------------------------------------------------------

    revno: 1.1.1

    committer: Lorem Ipsum <test@example.com>

    branch nick: child

    timestamp: Just now

    message:

      branch 1

    diff:

    === modified file 'file2'

    --- file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

    +++ file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

    @@ -1,1 +1,1 @@

    -contents of parent/file2

    +hello

------------------------------------------------------------

revno: 1

committer: Lorem Ipsum <test@example.com>

branch nick: parent

timestamp: Just now

message:

  first post

diff:

=== added file 'file1'

--- file1\tYYYY-MM-DD HH:MM:SS +ZZZZ

+++ file1\tYYYY-MM-DD HH:MM:SS +ZZZZ

@@ -0,0 +1,1 @@

+contents of parent/file1

=== added file 'file2'

--- file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

+++ file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

@@ -0,0 +1,1 @@

+contents of parent/file2

""")

    def test_log_show_diff_short(self):

        self._prepare()

        out,err = self.run_bzr('log -p --short')

        self.assertEqual('', err)

        log = normalize_log(out)

        self.assertEqualDiff(subst_dates(log), """\

    2 Lorem Ipsum\t2005-11-22 [merge]

      merge branch 1

      === modified file 'file2'

      --- file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

      +++ file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

      @@ -1,1 +1,1 @@

      -contents of parent/file2

      +hello

    1 Lorem Ipsum\t2005-11-22

      first post

      === added file 'file1'

      --- file1\tYYYY-MM-DD HH:MM:SS +ZZZZ

      +++ file1\tYYYY-MM-DD HH:MM:SS +ZZZZ

      @@ -0,0 +1,1 @@

      +contents of parent/file1

      === added file 'file2'

      --- file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

      +++ file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

      @@ -0,0 +1,1 @@

      +contents of parent/file2

""")

    def test_log_show_diff_line(self):

        self._prepare()

        out,err = self.run_bzr('log -p --line')

        self.assertEqual('', err)

        log = normalize_log(out)

        # Not supported by this formatter so expect plain output

        self.assertEqualDiff(subst_dates(log), """\

2: Lorem Ipsum 2005-11-22 merge branch 1

1: Lorem Ipsum 2005-11-22 first post

""")

    def test_log_show_diff_file(self):

        """Only the diffs for the given file are to be shown"""

        self._prepare()

        out,err = self.run_bzr('log -p --short file2')

        self.assertEqual('', err)

        log = normalize_log(out)

        self.assertEqualDiff(subst_dates(log), """\

    2 Lorem Ipsum\t2005-11-22 [merge]

      merge branch 1

      === modified file 'file2'

      --- file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

      +++ file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

      @@ -1,1 +1,1 @@

      -contents of parent/file2

      +hello

    1 Lorem Ipsum\t2005-11-22

      first post

      === added file 'file2'

      --- file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

      +++ file2\tYYYY-MM-DD HH:MM:SS +ZZZZ

      @@ -0,0 +1,1 @@

      +contents of parent/file2

""")

        out,err = self.run_bzr('log -p --short file1')

        self.assertEqual('', err)

        log = normalize_log(out)

        self.assertEqualDiff(subst_dates(log), """\

    1 Lorem Ipsum\t2005-11-22

      first post

      === added file 'file1'

      --- file1\tYYYY-MM-DD HH:MM:SS +ZZZZ

      +++ file1\tYYYY-MM-DD HH:MM:SS +ZZZZ

      @@ -0,0 +1,1 @@

      +contents of parent/file1

""")

class TestLogEncodings(TestCaseInTempDir):

    _mu = u'\xb5'

    _message = u'Message with \xb5'

    # Encodings which can encode mu

    good_encodings = [

        'utf-8',

        'latin-1',

        'iso-8859-1',

        'cp437', # Common windows encoding

        'cp1251', # Alexander Belchenko's windows encoding

        'cp1258', # Common windows encoding

    ]

    # Encodings which cannot encode mu

    bad_encodings = [

        'ascii',

        'iso-8859-2',

        'koi8_r',

    ]

    def setUp(self):

        TestCaseInTempDir.setUp(self)

        self.user_encoding = osutils._cached_user_encoding

    def tearDown(self):

        osutils._cached_user_encoding = self.user_encoding

        TestCaseInTempDir.tearDown(self)

    def create_branch(self):

        bzr = self.run_bzr

        bzr('init')

        open('a', 'wb').write('some stuff\n')

        bzr('add a')

        bzr(['commit', '-m', self._message])

    def try_encoding(self, encoding, fail=False):

        bzr = self.run_bzr

        if fail:

            self.assertRaises(UnicodeEncodeError,

                self._mu.encode, encoding)

            encoded_msg = self._message.encode(encoding, 'replace')

        else:

            encoded_msg = self._message.encode(encoding)

        old_encoding = osutils._cached_user_encoding

        # This test requires that 'run_bzr' uses the current

        # bzrlib, because we override user_encoding, and expect

        # it to be used

        try:

            osutils._cached_user_encoding = 'ascii'

            # We should be able to handle any encoding

            out, err = bzr('log', encoding=encoding)

            if not fail:

                # Make sure we wrote mu as we expected it to exist

                self.assertNotEqual(-1, out.find(encoded_msg))

                out_unicode = out.decode(encoding)

                self.assertNotEqual(-1, out_unicode.find(self._message))

            else:

                self.assertNotEqual(-1, out.find('Message with ?'))

        finally:

            osutils._cached_user_encoding = old_encoding

    def test_log_handles_encoding(self):

        self.create_branch()

        for encoding in self.good_encodings:

            self.try_encoding(encoding)

    def test_log_handles_bad_encoding(self):

        self.create_branch()

        for encoding in self.bad_encodings:

            self.try_encoding(encoding, fail=True)

    def test_stdout_encoding(self):

        bzr = self.run_bzr

        osutils._cached_user_encoding = "cp1251"

        bzr('init')

        self.build_tree(['a'])

        bzr('add a')

        bzr(['commit', '-m', u'\u0422\u0435\u0441\u0442'])

        stdout, stderr = self.run_bzr('log', encoding='cp866')

        message = stdout.splitlines()[-1]

        # explanation of the check:

        # u'\u0422\u0435\u0441\u0442' is word 'Test' in russian

        # in cp866  encoding this is string '\x92\xa5\xe1\xe2'

        # in cp1251 encoding this is string '\xd2\xe5\xf1\xf2'

        # This test should check that output of log command

        # encoded to sys.stdout.encoding

        test_in_cp866 = '\x92\xa5\xe1\xe2'

        test_in_cp1251 = '\xd2\xe5\xf1\xf2'

        # Make sure the log string is encoded in cp866

        self.assertEquals(test_in_cp866, message[2:])

        # Make sure the cp1251 string is not found anywhere

        self.assertEquals(-1, stdout.find(test_in_cp1251))

class TestLogFile(TestCaseWithTransport):

    def test_log_local_branch_file(self):

        """We should be able to log files in local treeless branches"""

        tree = self.make_branch_and_tree('tree')

        self.build_tree(['tree/file'])

        tree.add('file')

        tree.commit('revision 1')

        tree.bzrdir.destroy_workingtree()

        self.run_bzr('log tree/file')

    def prepare_tree(self):

        tree = self.make_branch_and_tree('parent')

        self.build_tree(['parent/file1', 'parent/file2', 'parent/file3'])

        tree.add('file1')

        tree.commit('add file1')

        tree.add('file2')