/brz/remove-bazaar

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

"""Tests for bzrdir implementations - tests a bzrdir format."""

from cStringIO import StringIO

import re

import bzrlib

from bzrlib import (

    bzrdir,

    errors,

    graph,

    remote,

    repository,

    )

from bzrlib.delta import TreeDelta

from bzrlib.inventory import Inventory, InventoryDirectory

from bzrlib.repofmt.weaverepo import (

    RepositoryFormat5,

    RepositoryFormat6,

    RepositoryFormat7,

    )

from bzrlib.revision import NULL_REVISION, Revision

from bzrlib.smart import server

from bzrlib.symbol_versioning import one_two

from bzrlib.tests import (

    KnownFailure,

    TestCaseWithTransport,

    TestNotApplicable,

    TestSkipped,

    )

from bzrlib.tests.repository_implementations import TestCaseWithRepository

from bzrlib.transport import get_transport

from bzrlib.upgrade import upgrade

from bzrlib.workingtree import WorkingTree

class TestRepositoryMakeBranchAndTree(TestCaseWithRepository):

    def test_repository_format(self):

        # make sure the repository on tree.branch is of the desired format,

        # because developers use this api to setup the tree, branch and 

        # repository for their tests: having it now give the right repository

        # type would invalidate the tests.

        tree = self.make_branch_and_tree('repo')

        self.assertIsInstance(tree.branch.repository._format,

            self.repository_format.__class__)

class TestRepository(TestCaseWithRepository):

    def test_clone_to_default_format(self):

        #TODO: Test that cloning a repository preserves all the information

        # such as signatures[not tested yet] etc etc.

        # when changing to the current default format.

        tree_a = self.make_branch_and_tree('a')

        self.build_tree(['a/foo'])

        tree_a.add('foo', 'file1')

        tree_a.commit('rev1', rev_id='rev1')

        bzrdirb = self.make_bzrdir('b')

        repo_b = tree_a.branch.repository.clone(bzrdirb)

        tree_b = repo_b.revision_tree('rev1')

        tree_b.lock_read()

        self.addCleanup(tree_b.unlock)

        tree_b.get_file_text('file1')

        rev1 = repo_b.get_revision('rev1')

    def test_iter_inventories_is_ordered(self):

        # just a smoke test

        tree = self.make_branch_and_tree('a')

        first_revision = tree.commit('')

        second_revision = tree.commit('')

        tree.lock_read()

        self.addCleanup(tree.unlock)

        revs = (first_revision, second_revision)

        invs = tree.branch.repository.iter_inventories(revs)

        for rev_id, inv in zip(revs, invs):

            self.assertEqual(rev_id, inv.revision_id)

            self.assertIsInstance(inv, Inventory)

    def test_supports_rich_root(self):

        tree = self.make_branch_and_tree('a')

        tree.commit('')

        second_revision = tree.commit('')

        inv = tree.branch.repository.revision_tree(second_revision).inventory

        rich_root = (inv.root.revision != second_revision)

        self.assertEqual(rich_root,

                         tree.branch.repository.supports_rich_root())

    def test_clone_specific_format(self):

        """todo"""

    def test_format_initialize_find_open(self):

        # loopback test to check the current format initializes to itself.

        if not self.repository_format.is_supported():

            # unsupported formats are not loopback testable

            # because the default open will not open them and

            # they may not be initializable.

            return

        # supported formats must be able to init and open

        t = get_transport(self.get_url())

        readonly_t = get_transport(self.get_readonly_url())

        made_control = self.bzrdir_format.initialize(t.base)

        made_repo = self.repository_format.initialize(made_control)

        self.assertEqual(made_control, made_repo.bzrdir)

        # find it via bzrdir opening:

        opened_control = bzrdir.BzrDir.open(readonly_t.base)

        direct_opened_repo = opened_control.open_repository()

        self.assertEqual(direct_opened_repo.__class__, made_repo.__class__)

        self.assertEqual(opened_control, direct_opened_repo.bzrdir)

        self.assertIsInstance(direct_opened_repo._format,

                              self.repository_format.__class__)

        # find it via Repository.open

        opened_repo = repository.Repository.open(readonly_t.base)

        self.failUnless(isinstance(opened_repo, made_repo.__class__))

        self.assertEqual(made_repo._format.__class__,

                         opened_repo._format.__class__)

        # if it has a unique id string, can we probe for it ?

        try:

            self.repository_format.get_format_string()

        except NotImplementedError:

            return

        self.assertEqual(self.repository_format,

                         repository.RepositoryFormat.find_format(opened_control))

    def test_create_repository(self):

        # bzrdir can construct a repository for itself.

        if not self.bzrdir_format.is_supported():

            # unsupported formats are not loopback testable

            # because the default open will not open them and

            # they may not be initializable.

            return

        t = get_transport(self.get_url())

        made_control = self.bzrdir_format.initialize(t.base)

        made_repo = made_control.create_repository()

        # Check that we have a repository object.

        made_repo.has_revision('foo')

        self.assertEqual(made_control, made_repo.bzrdir)

    def test_create_repository_shared(self):

        # bzrdir can construct a shared repository.

        if not self.bzrdir_format.is_supported():

            # unsupported formats are not loopback testable

            # because the default open will not open them and

            # they may not be initializable.

            return

        t = get_transport(self.get_url())

        made_control = self.bzrdir_format.initialize(t.base)

        try:

            made_repo = made_control.create_repository(shared=True)

        except errors.IncompatibleFormat:

            # not all repository formats understand being shared, or

            # may only be shared in some circumstances.

            return

        # Check that we have a repository object.

        made_repo.has_revision('foo')

        self.assertEqual(made_control, made_repo.bzrdir)

        self.assertTrue(made_repo.is_shared())

    def test_revision_tree(self):

        wt = self.make_branch_and_tree('.')

        wt.set_root_id('fixed-root')

        wt.commit('lala!', rev_id='revision-1', allow_pointless=True)

        tree = wt.branch.repository.revision_tree('revision-1')

        self.assertEqual('revision-1', tree.inventory.root.revision) 

        expected = InventoryDirectory('fixed-root', '', None)

        expected.revision = 'revision-1'

        self.assertEqual([('', 'V', 'directory', 'fixed-root', expected)],

                         list(tree.list_files(include_root=True)))

        tree = wt.branch.repository.revision_tree(None)

        self.assertEqual([], list(tree.list_files(include_root=True)))

        tree = wt.branch.repository.revision_tree(NULL_REVISION)

        self.assertEqual([], list(tree.list_files(include_root=True)))

    def test_get_revision_delta(self):

        tree_a = self.make_branch_and_tree('a')

        self.build_tree(['a/foo'])

        tree_a.add('foo', 'file1')

        tree_a.commit('rev1', rev_id='rev1')

        self.build_tree(['a/vla'])

        tree_a.add('vla', 'file2')

        tree_a.commit('rev2', rev_id='rev2')

        delta = tree_a.branch.repository.get_revision_delta('rev1')

        self.assertIsInstance(delta, TreeDelta)

        self.assertEqual([('foo', 'file1', 'file')], delta.added)

        delta = tree_a.branch.repository.get_revision_delta('rev2')

        self.assertIsInstance(delta, TreeDelta)

        self.assertEqual([('vla', 'file2', 'file')], delta.added)

    def test_clone_bzrdir_repository_revision(self):

        # make a repository with some revisions,

        # and clone it, this should not have unreferenced revisions.

        # also: test cloning with a revision id of NULL_REVISION -> empty repo.

        raise TestSkipped('revision limiting is not implemented yet.')

    def test_clone_repository_basis_revision(self):

        raise TestSkipped('the use of a basis should not add noise data to the result.')

    def test_clone_shared_no_tree(self):

        # cloning a shared repository keeps it shared

        # and preserves the make_working_tree setting.

        made_control = self.make_bzrdir('source')

        try:

            made_repo = made_control.create_repository(shared=True)

        except errors.IncompatibleFormat:

            # not all repository formats understand being shared, or

            # may only be shared in some circumstances.

            return

        try:

            made_repo.set_make_working_trees(False)

        except NotImplementedError:

            # the repository does not support having its tree-making flag

            # toggled.

            return

        result = made_control.clone(self.get_url('target'))

        # Check that we have a repository object.

        made_repo.has_revision('foo')

        self.assertEqual(made_control, made_repo.bzrdir)

        self.assertTrue(result.open_repository().is_shared())

        self.assertFalse(result.open_repository().make_working_trees())

    def test_upgrade_preserves_signatures(self):

        wt = self.make_branch_and_tree('source')

        wt.commit('A', allow_pointless=True, rev_id='A')

        repo = wt.branch.repository

        repo.lock_write()

        repo.start_write_group()

        repo.sign_revision('A', bzrlib.gpg.LoopbackGPGStrategy(None))

        repo.commit_write_group()

        repo.unlock()

        old_signature = repo.get_signature_text('A')

        try:

            old_format = bzrdir.BzrDirFormat.get_default_format()

            # This gives metadir branches something they can convert to.

            # it would be nice to have a 'latest' vs 'default' concept.

            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')

            upgrade(repo.bzrdir.root_transport.base, format=format)

        except errors.UpToDateFormat:

            # this is in the most current format already.

            return

        except errors.BadConversionTarget, e:

            raise TestSkipped(str(e))

        wt = WorkingTree.open(wt.basedir)

        new_signature = wt.branch.repository.get_signature_text('A')

        self.assertEqual(old_signature, new_signature)

    def test_format_description(self):

        repo = self.make_repository('.')

        text = repo._format.get_format_description()

        self.failUnless(len(text))

    def test_format_supports_external_lookups(self):

        repo = self.make_repository('.')

        self.assertSubset(

            [repo._format.supports_external_lookups], (True, False))

    def assertMessageRoundtrips(self, message):

        """Assert that message roundtrips to a repository and back intact."""

        tree = self.make_branch_and_tree('.')

        tree.commit(message, rev_id='a', allow_pointless=True)

        rev = tree.branch.repository.get_revision('a')

        # we have to manually escape this as we dont try to

        # roundtrip xml invalid characters at this point.

        # when escaping is moved to the serialiser, this test

        # can check against the literal message rather than

        # this escaped version.

        escaped_message, escape_count = re.subn(

            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',

            lambda match: match.group(0).encode('unicode_escape'),

            message)

        escaped_message= re.sub('\r', '\n', escaped_message)

        self.assertEqual(rev.message, escaped_message)

        # insist the class is unicode no matter what came in for 

        # consistency.

        self.assertIsInstance(rev.message, unicode)

    def test_commit_unicode_message(self):

        # a siple unicode message should be preserved

        self.assertMessageRoundtrips(u'foo bar gamm\xae plop')

    def test_commit_unicode_control_characters(self):

        # a unicode message with control characters should roundtrip too.

        self.assertMessageRoundtrips(

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

    def test_check_repository(self):

        """Check a fairly simple repository's history"""

        tree = self.make_branch_and_tree('.')

        tree.commit('initial empty commit', rev_id='a-rev',

                    allow_pointless=True)

        result = tree.branch.repository.check()

        # writes to log; should accept both verbose or non-verbose

        result.report_results(verbose=True)

        result.report_results(verbose=False)

    def test_get_revisions(self):

        tree = self.make_branch_and_tree('.')

        tree.commit('initial empty commit', rev_id='a-rev',

                    allow_pointless=True)

        tree.commit('second empty commit', rev_id='b-rev',

                    allow_pointless=True)

        tree.commit('third empty commit', rev_id='c-rev',

                    allow_pointless=True)

        repo = tree.branch.repository

        revision_ids = ['a-rev', 'b-rev', 'c-rev']

        revisions = repo.get_revisions(revision_ids)

        assert len(revisions) == 3, repr(revisions)

        zipped = zip(revisions, revision_ids)

        self.assertEqual(len(zipped), 3)

        for revision, revision_id in zipped:

            self.assertEqual(revision.revision_id, revision_id)

            self.assertEqual(revision, repo.get_revision(revision_id))

    def test_root_entry_has_revision(self):

        tree = self.make_branch_and_tree('.')

        tree.commit('message', rev_id='rev_id')

        rev_tree = tree.branch.repository.revision_tree(tree.last_revision())

        self.assertEqual('rev_id', rev_tree.inventory.root.revision)

    def DISABLED_DELETE_OR_FIX_BEFORE_MERGE_test_create_basis_inventory(self):

        # Needs testing here because differences between repo and working tree

        # basis inventory formats can lead to bugs.

        t = self.make_branch_and_tree('.')

        b = t.branch

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

        t.add('a')

        t.commit('a', rev_id='r1')

        t._control_files.get_utf8('basis-inventory-cache')

        basis_inv = t.basis_tree().inventory

        self.assertEquals('r1', basis_inv.revision_id)

        store_inv = b.repository.get_inventory('r1')

        self.assertEquals(store_inv._byid, basis_inv._byid)

        open('b', 'wb').write('b\n')

        t.add('b')

        t.commit('b', rev_id='r2')

        t._control_files.get_utf8('basis-inventory-cache')

        basis_inv_txt = t.read_basis_inventory()

        basis_inv = bzrlib.xml7.serializer_v7.read_inventory_from_string(basis_inv_txt)

        self.assertEquals('r2', basis_inv.revision_id)

        store_inv = b.repository.get_inventory('r2')

        self.assertEquals(store_inv._byid, basis_inv._byid)

    def test_upgrade_from_format4(self):

        from bzrlib.tests.test_upgrade import _upgrade_dir_template

        if self.repository_format.get_format_description() \

            == "Repository format 4":

            raise TestSkipped('Cannot convert format-4 to itself')

        if isinstance(self.repository_format, remote.RemoteRepositoryFormat):

            return # local conversion to/from RemoteObjects is irrelevant.

        self.build_tree_contents(_upgrade_dir_template)

        old_repodir = bzrlib.bzrdir.BzrDir.open_unsupported('.')

        old_repo_format = old_repodir.open_repository()._format

        format = self.repository_format._matchingbzrdir

        try:

            format.repository_format = self.repository_format

        except AttributeError:

            pass

        upgrade('.', format)

    def test_pointless_commit(self):

        tree = self.make_branch_and_tree('.')

        self.assertRaises(errors.PointlessCommit, tree.commit, 'pointless',

                          allow_pointless=False)

        tree.commit('pointless', allow_pointless=True)

    def test_format_attributes(self):

        """All repository formats should have some basic attributes."""

        # create a repository to get a real format instance, not the 

        # template from the test suite parameterization.

        repo = self.make_repository('.')

        repo._format.rich_root_data

        repo._format.supports_tree_reference

    def test_get_data_stream_deprecated(self):

        # If get_data_stream is present it must be deprecated

        tree = self.make_branch_and_tree('t')

        self.build_tree(['t/foo'])

        tree.add('foo', 'file1')

        tree.commit('message', rev_id='rev_id')

        repo = tree.branch.repository

        try:

            stream = self.applyDeprecated(one_two, repo.get_data_stream,

                ['rev_id'])

        except NotImplementedError:

            raise TestNotApplicable("%s doesn't support get_data_stream"

                % repo._format)

        except AttributeError:

            pass

    def test_get_data_stream_for_search(self):

        # Make a repo with a revision

        tree = self.make_branch_and_tree('t')

        self.build_tree(['t/foo'])

        tree.add('foo', 'file1')

        tree.commit('message', rev_id='rev_id')

        repo = tree.branch.repository

        # Get a data stream (a file-like object) for that revision

        search = graph.SearchResult(set(['rev_id']), set([NULL_REVISION]), 1,

            set(['rev_id']))

        try:

            stream = repo.get_data_stream_for_search(search)

        except NotImplementedError:

            raise TestNotApplicable("%s doesn't support get_data_stream"

                % repo._format)

        # The data stream is a iterator that yields (name, versioned_file)

        # pairs for:

        #   * the file knit (or knits; if this repo has rich roots there will

        #     be a file knit for that as well as for 'file1').

        #   * the inventory knit

        #   * the revisions knit

        # in that order.

        expected_record_names = [

            ('file', 'file1'),

            ('inventory',),

            ('signatures',),

            ('revisions',)]

        streamed_names = []

        for name, bytes in stream:

            streamed_names.append(name)

        if repo.supports_rich_root():

            # Check for the root versioned file in the stream, then remove it

            # from streamed_names so we can compare that with

            # expected_record_names.

            # Note that the file knits can be in any order, so this test is

            # written to allow that.

            inv = repo.get_inventory('rev_id')

            expected_record_name = ('file', inv.root.file_id)

            self.assertTrue(expected_record_name in streamed_names)

            streamed_names.remove(expected_record_name)

        self.assertEqual(expected_record_names, streamed_names)

    def test_insert_data_stream(self):

        tree = self.make_branch_and_tree('source')

        self.build_tree(['source/foo'])

        tree.add('foo', 'file1')

        tree.commit('message', rev_id='rev_id')

        source_repo = tree.branch.repository

        dest_repo = self.make_repository('dest')

        search = dest_repo.search_missing_revision_ids(source_repo,

            revision_id='rev_id')

        try:

            stream = source_repo.get_data_stream_for_search(search)

        except NotImplementedError, e:

            # Not all repositories support streaming.

            self.assertContainsRe(str(e), 'get_data_stream_for_search')

            raise TestSkipped('This format does not support streaming.')

        dest_repo.lock_write()

        try:

            dest_repo.start_write_group()

            try:

                dest_repo.insert_data_stream(stream)

            except:

                dest_repo.abort_write_group()

                raise

            else:

                dest_repo.commit_write_group()

        finally:

            dest_repo.unlock()

        # reopen to be sure it was added.

        dest_repo = dest_repo.bzrdir.open_repository()

        self.assertTrue(dest_repo.has_revision('rev_id'))

        # insert the same data stream again, should be no-op

        stream = source_repo.get_data_stream_for_search(search)

        dest_repo.lock_write()

        try:

            dest_repo.start_write_group()

            try:

                dest_repo.insert_data_stream(stream)

            except:

                dest_repo.abort_write_group()

                raise

            else:

                dest_repo.commit_write_group()

        finally:

            dest_repo.unlock()

        # try to insert data stream with invalid key

        stream = [[('bogus-key',), '']]

        self.assertRaises(errors.RepositoryDataStreamError,

                          dest_repo.insert_data_stream, stream)

    def test_get_serializer_format(self):

        repo = self.make_repository('.')

        format = repo.get_serializer_format()

        self.assertEqual(repo._serializer.format_num, format)

    def test_iter_files_bytes(self):

        tree = self.make_branch_and_tree('tree')

        self.build_tree_contents([('tree/file1', 'foo'),

                                  ('tree/file2', 'bar')])

        tree.add(['file1', 'file2'], ['file1-id', 'file2-id'])

        tree.commit('rev1', rev_id='rev1')

        self.build_tree_contents([('tree/file1', 'baz')])

        tree.commit('rev2', rev_id='rev2')

        repository = tree.branch.repository

        repository.lock_read()

        self.addCleanup(repository.unlock)

        extracted = dict((i, ''.join(b)) for i, b in

                         repository.iter_files_bytes(

                         [('file1-id', 'rev1', 'file1-old'),

                          ('file1-id', 'rev2', 'file1-new'),

                          ('file2-id', 'rev1', 'file2'),

                         ]))

        self.assertEqual('foo', extracted['file1-old'])

        self.assertEqual('bar', extracted['file2'])

        self.assertEqual('baz', extracted['file1-new'])

        self.assertRaises(errors.RevisionNotPresent, list,

                          repository.iter_files_bytes(

                          [('file1-id', 'rev3', 'file1-notpresent')]))

        self.assertRaises((errors.RevisionNotPresent, errors.NoSuchId), list,

                          repository.iter_files_bytes(

                          [('file3-id', 'rev3', 'file1-notpresent')]))

    def test_item_keys_introduced_by(self):

        # Make a repo with one revision and one versioned file.

        tree = self.make_branch_and_tree('t')

        self.build_tree(['t/foo'])

        tree.add('foo', 'file1')

        tree.commit('message', rev_id='rev_id')

        repo = tree.branch.repository

        # Item keys will be in this order, for maximum convenience for

        # generating data to insert into knit repository:

        #   * files

        #   * inventory

        #   * signatures

        #   * revisions

        expected_item_keys = [

            ('file', 'file1', ['rev_id']),

            ('inventory', None, ['rev_id']),

            ('signatures', None, []),

            ('revisions', None, ['rev_id'])]

        item_keys = list(repo.item_keys_introduced_by(['rev_id']))

        item_keys = [

            (kind, file_id, list(versions))

            for (kind, file_id, versions) in item_keys]

        if repo.supports_rich_root():

            # Check for the root versioned file in the item_keys, then remove

            # it from streamed_names so we can compare that with

            # expected_record_names.

            # Note that the file keys can be in any order, so this test is

            # written to allow that.

            inv = repo.get_inventory('rev_id')

            root_item_key = ('file', inv.root.file_id, ['rev_id'])

            self.assertTrue(root_item_key in item_keys)

            item_keys.remove(root_item_key)

        self.assertEqual(expected_item_keys, item_keys)

    def test_get_graph(self):

        """Bare-bones smoketest that all repositories implement get_graph."""

        repo = self.make_repository('repo')

        repo.lock_read()

        self.addCleanup(repo.unlock)

        repo.get_graph()

    def test_graph_ghost_handling(self):

        tree = self.make_branch_and_tree('here')

        tree.lock_write()

        self.addCleanup(tree.unlock)

        tree.commit('initial commit', rev_id='rev1')

        tree.add_parent_tree_id('ghost')

        tree.commit('commit-with-ghost', rev_id='rev2')

        graph = tree.branch.repository.get_graph()

        parents = graph.get_parent_map(['ghost', 'rev2'])

        self.assertTrue('ghost' not in parents)

        self.assertEqual(parents['rev2'], ('rev1', 'ghost'))

    def test_parent_map_type(self):

        tree = self.make_branch_and_tree('here')

        tree.lock_write()

        self.addCleanup(tree.unlock)

        tree.commit('initial commit', rev_id='rev1')

        tree.commit('next commit', rev_id='rev2')

        graph = tree.branch.repository.get_graph()

        parents = graph.get_parent_map([NULL_REVISION, 'rev1', 'rev2'])

        for value in parents.values():

            self.assertIsInstance(value, tuple)

    def test_implements_revision_graph_can_have_wrong_parents(self):

        """All repositories should implement

        revision_graph_can_have_wrong_parents, so that check and reconcile can

        work correctly.

        """

        repo = self.make_repository('.')

        # This should work, not raise NotImplementedError:

        if not repo.revision_graph_can_have_wrong_parents():

            return

        repo.lock_read()

        self.addCleanup(repo.unlock)

        # This repo must also implement

        # _find_inconsistent_revision_parents and

        # _check_for_inconsistent_revision_parents.  So calling these

        # should not raise NotImplementedError.

        list(repo._find_inconsistent_revision_parents())

        repo._check_for_inconsistent_revision_parents()

    def test_add_signature_text(self):

        repo = self.make_repository('repo')

        repo.lock_write()

        self.addCleanup(repo.unlock)

        self.addCleanup(repo.commit_write_group)

        repo.start_write_group()