~bzr-pqm/bzr/bzr.dev

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

#

# 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

import os

from cStringIO import StringIO

from bzrlib import (

    errors,

    log,

    registry,

    revision,

    revisionspec,

    symbol_versioning,

    tests,

    )

class TestLogMixin(object):

    def wt_commit(self, wt, message, **kwargs):

        """Use some mostly fixed values for commits to simplify tests.

        Tests can use this function to get some commit attributes. The time

        stamp is incremented at each commit.

        """

        if getattr(self, 'timestamp', None) is None:

            self.timestamp = 1132617600 # Mon 2005-11-22 00:00:00 +0000

        else:

            self.timestamp += 1 # 1 second between each commit

        kwargs.setdefault('timestamp', self.timestamp)

        kwargs.setdefault('timezone', 0) # UTC

        kwargs.setdefault('committer', 'Joe Foo <joe@foo.com>')

        return wt.commit(message, **kwargs)

class TestCaseForLogFormatter(tests.TestCaseWithTransport, TestLogMixin):

    def setUp(self):

        super(TestCaseForLogFormatter, self).setUp()

        # keep a reference to the "current" custom prop. handler registry

        self.properties_handler_registry = log.properties_handler_registry

        # Use a clean registry for log

        log.properties_handler_registry = registry.Registry()

        def restore():

            log.properties_handler_registry = self.properties_handler_registry

        self.addCleanup(restore)

    def assertFormatterResult(self, result, branch, formatter_class,

                              formatter_kwargs=None, show_log_kwargs=None):

        logfile = self.make_utf8_encoded_stringio()

        if formatter_kwargs is None:

            formatter_kwargs = {}

        formatter = formatter_class(to_file=logfile, **formatter_kwargs)

        if show_log_kwargs is None:

            show_log_kwargs = {}

        log.show_log(branch, formatter, **show_log_kwargs)

        self.assertEqualDiff(result, logfile.getvalue())

    def make_standard_commit(self, branch_nick, **kwargs):

        wt = self.make_branch_and_tree('.')

        wt.lock_write()

        self.addCleanup(wt.unlock)

        self.build_tree(['a'])

        wt.add(['a'])

        wt.branch.nick = branch_nick

        kwargs.setdefault('committer', 'Lorem Ipsum <test@example.com>')

        kwargs.setdefault('authors', ['John Doe <jdoe@example.com>'])

        self.wt_commit(wt, 'add a', **kwargs)

        return wt

    def make_commits_with_trailing_newlines(self, wt):

        """Helper method for LogFormatter tests"""

        b = wt.branch

        b.nick = 'test'

        self.build_tree_contents([('a', 'hello moto\n')])

        self.wt_commit(wt, 'simple log message', rev_id='a1')

        self.build_tree_contents([('b', 'goodbye\n')])

        wt.add('b')

        self.wt_commit(wt, 'multiline\nlog\nmessage\n', rev_id='a2')

        self.build_tree_contents([('c', 'just another manic monday\n')])

        wt.add('c')

        self.wt_commit(wt, 'single line with trailing newline\n', rev_id='a3')

        return b

    def _prepare_tree_with_merges(self, with_tags=False):

        wt = self.make_branch_and_memory_tree('.')

        wt.lock_write()

        self.addCleanup(wt.unlock)

        wt.add('')

        self.wt_commit(wt, 'rev-1', rev_id='rev-1')

        self.wt_commit(wt, 'rev-merged', rev_id='rev-2a')

        wt.set_parent_ids(['rev-1', 'rev-2a'])

        wt.branch.set_last_revision_info(1, 'rev-1')

        self.wt_commit(wt, 'rev-2', rev_id='rev-2b')

        if with_tags:

            branch = wt.branch

            branch.tags.set_tag('v0.2', 'rev-2b')

            self.wt_commit(wt, 'rev-3', rev_id='rev-3')

            branch.tags.set_tag('v1.0rc1', 'rev-3')

            branch.tags.set_tag('v1.0', 'rev-3')

        return wt

class LogCatcher(log.LogFormatter):

    """Pull log messages into a list rather than displaying them.

    To simplify testing we save logged revisions here rather than actually

    formatting anything, so that we can precisely check the result without

    being dependent on the formatting.

    """

    supports_merge_revisions = True

    supports_delta = True

    supports_diff = True

    preferred_levels = 0

    def __init__(self, *args, **kwargs):

        kwargs.update(dict(to_file=None))

        super(LogCatcher, self).__init__(*args, **kwargs)

        self.revisions = []

    def log_revision(self, revision):

        self.revisions.append(revision)

class TestShowLog(tests.TestCaseWithTransport):

    def checkDelta(self, delta, **kw):

        """Check the filenames touched by a delta are as expected.

        Caller only have to pass in the list of files for each part, all

        unspecified parts are considered empty (and checked as such).

        """

        for n in 'added', 'removed', 'renamed', 'modified', 'unchanged':

            # By default we expect an empty list

            expected = kw.get(n, [])

            # strip out only the path components

            got = [x[0] for x in getattr(delta, n)]

            self.assertEqual(expected, got)

    def assertInvalidRevisonNumber(self, br, start, end):

        lf = LogCatcher()

        self.assertRaises(errors.InvalidRevisionNumber,

                          log.show_log, br, lf,

                          start_revision=start, end_revision=end)

    def test_cur_revno(self):

        wt = self.make_branch_and_tree('.')

        b = wt.branch

        lf = LogCatcher()

        wt.commit('empty commit')

        log.show_log(b, lf, verbose=True, start_revision=1, end_revision=1)

        # Since there is a single revision in the branch all the combinations

        # below should fail.

        self.assertInvalidRevisonNumber(b, 2, 1)

        self.assertInvalidRevisonNumber(b, 1, 2)

        self.assertInvalidRevisonNumber(b, 0, 2)

        self.assertInvalidRevisonNumber(b, 1, 0)

        self.assertInvalidRevisonNumber(b, -1, 1)

        self.assertInvalidRevisonNumber(b, 1, -1)

    def test_empty_branch(self):

        wt = self.make_branch_and_tree('.')

        lf = LogCatcher()

        log.show_log(wt.branch, lf)

        # no entries yet

        self.assertEqual([], lf.revisions)

    def test_empty_commit(self):

        wt = self.make_branch_and_tree('.')

        wt.commit('empty commit')

        lf = LogCatcher()

        log.show_log(wt.branch, lf, verbose=True)

        revs = lf.revisions

        self.assertEqual(1, len(revs))

        self.assertEqual('1', revs[0].revno)

        self.assertEqual('empty commit', revs[0].rev.message)

        self.checkDelta(revs[0].delta)

    def test_simple_commit(self):

        wt = self.make_branch_and_tree('.')

        wt.commit('empty commit')

        self.build_tree(['hello'])

        wt.add('hello')

        wt.commit('add one file',

                  committer=u'\u013d\xf3r\xe9m \xcdp\u0161\xfam '

                            u'<test@example.com>')

        lf = LogCatcher()

        log.show_log(wt.branch, lf, verbose=True)

        self.assertEqual(2, len(lf.revisions))

        # first one is most recent

        log_entry = lf.revisions[0]

        self.assertEqual('2', log_entry.revno)

        self.assertEqual('add one file', log_entry.rev.message)

        self.checkDelta(log_entry.delta, added=['hello'])

    def test_commit_message_with_control_chars(self):

        wt = self.make_branch_and_tree('.')

        msg = u"All 8-bit chars: " +  ''.join([unichr(x) for x in range(256)])

        msg = msg.replace(u'\r', u'\n')

        wt.commit(msg)

        lf = LogCatcher()

        log.show_log(wt.branch, lf, verbose=True)

        committed_msg = lf.revisions[0].rev.message

        if wt.branch.repository._serializer.squashes_xml_invalid_characters:

            self.assertNotEqual(msg, committed_msg)

            self.assertTrue(len(committed_msg) > len(msg))

        else:

            self.assertEqual(msg, committed_msg)

    def test_commit_message_without_control_chars(self):

        wt = self.make_branch_and_tree('.')

        # escaped.  As ElementTree apparently does some kind of

        # newline conversion, neither LF (\x0A) nor CR (\x0D) are

        # included in the test commit message, even though they are

        # valid XML 1.0 characters.

        msg = "\x09" + ''.join([unichr(x) for x in range(0x20, 256)])

        wt.commit(msg)

        lf = LogCatcher()

        log.show_log(wt.branch, lf, verbose=True)

        committed_msg = lf.revisions[0].rev.message

        self.assertEqual(msg, committed_msg)

    def test_deltas_in_merge_revisions(self):

        """Check deltas created for both mainline and merge revisions"""

        wt = self.make_branch_and_tree('parent')

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

        wt.add('file1')

        wt.add('file2')

        wt.commit(message='add file1 and file2')

        self.run_bzr('branch parent child')

        os.unlink('child/file1')

        file('child/file2', 'wb').write('hello\n')

        self.run_bzr(['commit', '-m', 'remove file1 and modify file2',

            'child'])

        os.chdir('parent')

        self.run_bzr('merge ../child')

        wt.commit('merge child branch')

        os.chdir('..')

        b = wt.branch

        lf = LogCatcher()

        lf.supports_merge_revisions = True

        log.show_log(b, lf, verbose=True)

        revs = lf.revisions

        self.assertEqual(3, len(revs))

        logentry = revs[0]

        self.assertEqual('2', logentry.revno)

        self.assertEqual('merge child branch', logentry.rev.message)

        self.checkDelta(logentry.delta, removed=['file1'], modified=['file2'])

        logentry = revs[1]

        self.assertEqual('1.1.1', logentry.revno)

        self.assertEqual('remove file1 and modify file2', logentry.rev.message)

        self.checkDelta(logentry.delta, removed=['file1'], modified=['file2'])

        logentry = revs[2]

        self.assertEqual('1', logentry.revno)

        self.assertEqual('add file1 and file2', logentry.rev.message)

        self.checkDelta(logentry.delta, added=['file1', 'file2'])

class TestShortLogFormatter(TestCaseForLogFormatter):

    def test_trailing_newlines(self):

        wt = self.make_branch_and_tree('.')

        b = self.make_commits_with_trailing_newlines(wt)

        self.assertFormatterResult("""\

    3 Joe Foo\t2005-11-22

      single line with trailing newline

    2 Joe Foo\t2005-11-22

      multiline

      log

      message

    1 Joe Foo\t2005-11-22

      simple log message

""",

            b, log.ShortLogFormatter)

    def test_short_log_with_merges(self):

        wt = self._prepare_tree_with_merges()

        self.assertFormatterResult("""\

    2 Joe Foo\t2005-11-22 [merge]

      rev-2

    1 Joe Foo\t2005-11-22

      rev-1

""",

            wt.branch, log.ShortLogFormatter)

    def test_short_log_with_merges_and_advice(self):

        wt = self._prepare_tree_with_merges()

        self.assertFormatterResult("""\

    2 Joe Foo\t2005-11-22 [merge]

      rev-2

    1 Joe Foo\t2005-11-22

      rev-1

Use --include-merges or -n0 to see merged revisions.

""",

            wt.branch, log.ShortLogFormatter,

            formatter_kwargs=dict(show_advice=True))

    def test_short_log_with_merges_and_range(self):

        wt = self._prepare_tree_with_merges()

        self.wt_commit(wt, 'rev-3a', rev_id='rev-3a')

        wt.branch.set_last_revision_info(2, 'rev-2b')

        wt.set_parent_ids(['rev-2b', 'rev-3a'])

        self.wt_commit(wt, 'rev-3b', rev_id='rev-3b')

        self.assertFormatterResult("""\

    3 Joe Foo\t2005-11-22 [merge]

      rev-3b

    2 Joe Foo\t2005-11-22 [merge]

      rev-2

""",

            wt.branch, log.ShortLogFormatter,

            show_log_kwargs=dict(start_revision=2, end_revision=3))

    def test_short_log_with_tags(self):

        wt = self._prepare_tree_with_merges(with_tags=True)

        self.assertFormatterResult("""\

    3 Joe Foo\t2005-11-22 {v1.0, v1.0rc1}

      rev-3

    2 Joe Foo\t2005-11-22 {v0.2} [merge]

      rev-2

    1 Joe Foo\t2005-11-22

      rev-1

""",

            wt.branch, log.ShortLogFormatter)

    def test_short_log_single_merge_revision(self):

        wt = self._prepare_tree_with_merges()

        revspec = revisionspec.RevisionSpec.from_string('1.1.1')

        rev = revspec.in_history(wt.branch)

        self.assertFormatterResult("""\

      1.1.1 Joe Foo\t2005-11-22

            rev-merged

""",

            wt.branch, log.ShortLogFormatter,

            show_log_kwargs=dict(start_revision=rev, end_revision=rev))

class TestShortLogFormatterWithMergeRevisions(TestCaseForLogFormatter):

    def test_short_merge_revs_log_with_merges(self):

        wt = self._prepare_tree_with_merges()

        # Note that the 1.1.1 indenting is in fact correct given that

        # the revision numbers are right justified within 5 characters

        # for mainline revnos and 9 characters for dotted revnos.

        self.assertFormatterResult("""\

    2 Joe Foo\t2005-11-22 [merge]

      rev-2

          1.1.1 Joe Foo\t2005-11-22

                rev-merged

    1 Joe Foo\t2005-11-22

      rev-1

""",

            wt.branch, log.ShortLogFormatter,

            formatter_kwargs=dict(levels=0))

    def test_short_merge_revs_log_single_merge_revision(self):

        wt = self._prepare_tree_with_merges()

        revspec = revisionspec.RevisionSpec.from_string('1.1.1')

        rev = revspec.in_history(wt.branch)

        self.assertFormatterResult("""\

      1.1.1 Joe Foo\t2005-11-22

            rev-merged

""",

            wt.branch, log.ShortLogFormatter,

            formatter_kwargs=dict(levels=0),

            show_log_kwargs=dict(start_revision=rev, end_revision=rev))

class TestLongLogFormatter(TestCaseForLogFormatter):

    def test_verbose_log(self):

        """Verbose log includes changed files

        bug #4676

        """

        wt = self.make_standard_commit('test_verbose_log', authors=[])

        self.assertFormatterResult('''\

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

revno: 1

committer: Lorem Ipsum <test@example.com>

branch nick: test_verbose_log

timestamp: Tue 2005-11-22 00:00:00 +0000

message:

  add a

added:

  a

''',

            wt.branch, log.LongLogFormatter,

            show_log_kwargs=dict(verbose=True))

    def test_merges_are_indented_by_level(self):

        wt = self.make_branch_and_tree('parent')

        self.wt_commit(wt, 'first post')

        child_wt = wt.bzrdir.sprout('child').open_workingtree()

        self.wt_commit(child_wt, 'branch 1')

        smallerchild_wt = wt.bzrdir.sprout('smallerchild').open_workingtree()

        self.wt_commit(smallerchild_wt, 'branch 2')

        child_wt.merge_from_branch(smallerchild_wt.branch)

        self.wt_commit(child_wt, 'merge branch 2')

        wt.merge_from_branch(child_wt.branch)

        self.wt_commit(wt, 'merge branch 1')

        self.assertFormatterResult("""\

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

revno: 2 [merge]

committer: Joe Foo <joe@foo.com>

branch nick: parent

timestamp: Tue 2005-11-22 00:00:04 +0000

message:

  merge branch 1

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

    revno: 1.1.2 [merge]

    committer: Joe Foo <joe@foo.com>

    branch nick: child

    timestamp: Tue 2005-11-22 00:00:03 +0000

    message:

      merge branch 2

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

        revno: 1.2.1

        committer: Joe Foo <joe@foo.com>

        branch nick: smallerchild

        timestamp: Tue 2005-11-22 00:00:02 +0000

        message:

          branch 2

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

    revno: 1.1.1

    committer: Joe Foo <joe@foo.com>

    branch nick: child

    timestamp: Tue 2005-11-22 00:00:01 +0000

    message:

      branch 1

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

revno: 1

committer: Joe Foo <joe@foo.com>

branch nick: parent

timestamp: Tue 2005-11-22 00:00:00 +0000

message:

  first post

""",

            wt.branch, log.LongLogFormatter,

            formatter_kwargs=dict(levels=0),

            show_log_kwargs=dict(verbose=True))

    def test_verbose_merge_revisions_contain_deltas(self):

        wt = self.make_branch_and_tree('parent')

        self.build_tree(['parent/f1', 'parent/f2'])

        wt.add(['f1','f2'])

        self.wt_commit(wt, 'first post')

        child_wt = wt.bzrdir.sprout('child').open_workingtree()

        os.unlink('child/f1')

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

        self.wt_commit(child_wt, 'removed f1 and modified f2')

        wt.merge_from_branch(child_wt.branch)

        self.wt_commit(wt, 'merge branch 1')

        self.assertFormatterResult("""\

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

revno: 2 [merge]

committer: Joe Foo <joe@foo.com>

branch nick: parent

timestamp: Tue 2005-11-22 00:00:02 +0000

message:

  merge branch 1

removed:

  f1

modified:

  f2

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

    revno: 1.1.1

    committer: Joe Foo <joe@foo.com>

    branch nick: child

    timestamp: Tue 2005-11-22 00:00:01 +0000

    message:

      removed f1 and modified f2

    removed:

      f1

    modified:

      f2

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

revno: 1

committer: Joe Foo <joe@foo.com>

branch nick: parent

timestamp: Tue 2005-11-22 00:00:00 +0000

message:

  first post

added:

  f1

  f2

""",

            wt.branch, log.LongLogFormatter,

            formatter_kwargs=dict(levels=0),

            show_log_kwargs=dict(verbose=True))

    def test_trailing_newlines(self):

        wt = self.make_branch_and_tree('.')

        b = self.make_commits_with_trailing_newlines(wt)

        self.assertFormatterResult("""\

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

revno: 3

committer: Joe Foo <joe@foo.com>

branch nick: test

timestamp: Tue 2005-11-22 00:00:02 +0000

message:

  single line with trailing newline

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

revno: 2

committer: Joe Foo <joe@foo.com>

branch nick: test

timestamp: Tue 2005-11-22 00:00:01 +0000

message:

  multiline

  log

  message

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

revno: 1

committer: Joe Foo <joe@foo.com>

branch nick: test

timestamp: Tue 2005-11-22 00:00:00 +0000

message:

  simple log message

""",

        b, log.LongLogFormatter)

    def test_author_in_log(self):

        """Log includes the author name if it's set in

        the revision properties

        """

        wt = self.make_standard_commit('test_author_log',

            authors=['John Doe <jdoe@example.com>',

                     'Jane Rey <jrey@example.com>'])

        self.assertFormatterResult("""\

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

revno: 1

author: John Doe <jdoe@example.com>, Jane Rey <jrey@example.com>

committer: Lorem Ipsum <test@example.com>

branch nick: test_author_log

timestamp: Tue 2005-11-22 00:00:00 +0000

message:

  add a

""",

        wt.branch, log.LongLogFormatter)

    def test_properties_in_log(self):

        """Log includes the custom properties returned by the registered

        handlers.

        """

        wt = self.make_standard_commit('test_properties_in_log')

        def trivial_custom_prop_handler(revision):

            return {'test_prop':'test_value'}

        # Cleaned up in setUp()

        log.properties_handler_registry.register(

            'trivial_custom_prop_handler',

            trivial_custom_prop_handler)

        self.assertFormatterResult("""\

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

revno: 1

test_prop: test_value

author: John Doe <jdoe@example.com>

committer: Lorem Ipsum <test@example.com>

branch nick: test_properties_in_log

timestamp: Tue 2005-11-22 00:00:00 +0000

message:

  add a

""",

            wt.branch, log.LongLogFormatter)

    def test_properties_in_short_log(self):

        """Log includes the custom properties returned by the registered

        handlers.

        """

        wt = self.make_standard_commit('test_properties_in_short_log')