/brz/remove-bazaar

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

"""Tests of the parent related functions of WorkingTrees."""

from io import BytesIO

import os

from ... import (

    errors,

    revision as _mod_revision,

    )

from ...bzr.inventory import (

    Inventory,

    InventoryFile,

    InventoryDirectory,

    InventoryLink,

    )

from ...bzr.inventorytree import (

    InventoryRevisionTree,

    InventoryTree,

    )

from ...tests import TestNotApplicable

from ..per_workingtree import TestCaseWithWorkingTree

from .. import (

    features,

    )

from ...uncommit import uncommit

class TestParents(TestCaseWithWorkingTree):

    def assertConsistentParents(self, expected, tree):

        """Check that the parents found are as expected.

        This test helper also checks that they are consistent with

        the pre-get_parent_ids() api - which is now deprecated.

        """

        self.assertEqual(expected, tree.get_parent_ids())

        if expected == []:

            self.assertEqual(_mod_revision.NULL_REVISION,

                             _mod_revision.ensure_null(tree.last_revision()))

        else:

            self.assertEqual(expected[0], tree.last_revision())

class TestGetParents(TestParents):

    def test_get_parents(self):

        t = self.make_branch_and_tree('.')

        self.assertEqual([], t.get_parent_ids())

class TestSetParents(TestParents):

    def test_set_no_parents(self):

        t = self.make_branch_and_tree('.')

        t.set_parent_trees([])

        self.assertEqual([], t.get_parent_ids())

        # now give it a real parent, and then set it to no parents again.

        t.commit('first post')

        t.set_parent_trees([])

        self.assertConsistentParents([], t)

    def test_set_null_parent(self):

        t = self.make_branch_and_tree('.')

        self.assertRaises(errors.ReservedId, t.set_parent_ids, [b'null:'],

                          allow_leftmost_as_ghost=True)

        self.assertRaises(errors.ReservedId, t.set_parent_trees,

                          [(b'null:', None)], allow_leftmost_as_ghost=True)

    def test_set_one_ghost_parent_rejects(self):

        t = self.make_branch_and_tree('.')

        self.assertRaises(errors.GhostRevisionUnusableHere,

                          t.set_parent_trees, [(b'missing-revision-id', None)])

    def test_set_one_ghost_parent_force(self):

        t = self.make_branch_and_tree('.')

        if t._format.supports_leftmost_parent_id_as_ghost:

            t.set_parent_trees([(b'missing-revision-id', None)],

                               allow_leftmost_as_ghost=True)

            self.assertConsistentParents([b'missing-revision-id'], t)

        else:

            self.assertRaises(errors.GhostRevisionUnusableHere,

                              t.set_parent_trees, [(b'missing-revision-id', None)])

            self.assertConsistentParents([], t)

    def test_set_two_parents_one_ghost(self):

        t = self.make_branch_and_tree('.')

        revision_in_repo = t.commit('first post')

        # remove the tree's history

        uncommit(t.branch, tree=t)

        rev_tree = t.branch.repository.revision_tree(revision_in_repo)

        if t._format.supports_righthand_parent_id_as_ghost:

            t.set_parent_trees([(revision_in_repo, rev_tree),

                                (b'another-missing', None)])

            self.assertConsistentParents(

                [revision_in_repo, b'another-missing'], t)

        else:

            self.assertRaises(errors.GhostRevisionUnusableHere,

                              t.set_parent_trees, [(revision_in_repo, rev_tree),

                                                   (b'another-missing', None)])

    def test_set_three_parents(self):

        t = self.make_branch_and_tree('.')

        first_revision = t.commit('first post')

        uncommit(t.branch, tree=t)

        second_revision = t.commit('second post')

        uncommit(t.branch, tree=t)

        third_revision = t.commit('third post')

        uncommit(t.branch, tree=t)

        rev_tree1 = t.branch.repository.revision_tree(first_revision)

        rev_tree2 = t.branch.repository.revision_tree(second_revision)

        rev_tree3 = t.branch.repository.revision_tree(third_revision)

        t.set_parent_trees([(first_revision, rev_tree1),

                            (second_revision, rev_tree2),

                            (third_revision, rev_tree3)])

        self.assertConsistentParents(

            [first_revision, second_revision, third_revision], t)

    def test_set_no_parents_ids(self):

        t = self.make_branch_and_tree('.')

        t.set_parent_ids([])

        self.assertEqual([], t.get_parent_ids())

        # now give it a real parent, and then set it to no parents again.

        t.commit('first post')

        t.set_parent_ids([])

        self.assertConsistentParents([], t)

    def test_set_one_ghost_parent_ids_rejects(self):

        t = self.make_branch_and_tree('.')

        self.assertRaises(errors.GhostRevisionUnusableHere,

                          t.set_parent_ids, [b'missing-revision-id'])

    def test_set_one_ghost_parent_ids_force(self):

        t = self.make_branch_and_tree('.')

        if t._format.supports_leftmost_parent_id_as_ghost:

            t.set_parent_ids([b'missing-revision-id'],

                             allow_leftmost_as_ghost=True)

            self.assertConsistentParents([b'missing-revision-id'], t)

        else:

            self.assertRaises(

                errors.GhostRevisionUnusableHere, t.set_parent_ids,

                [b'missing-revision-id'], allow_leftmost_as_ghost=True)

    def test_set_two_parents_one_ghost_ids(self):

        t = self.make_branch_and_tree('.')

        revision_in_repo = t.commit('first post')

        # remove the tree's history

        uncommit(t.branch, tree=t)

        rev_tree = t.branch.repository.revision_tree(revision_in_repo)

        if t._format.supports_righthand_parent_id_as_ghost:

            t.set_parent_ids([revision_in_repo, b'another-missing'])

            self.assertConsistentParents(

                [revision_in_repo, b'another-missing'], t)

        else:

            self.assertRaises(errors.GhostRevisionUnusableHere,

                              t.set_parent_ids, [revision_in_repo, b'another-missing'])

    def test_set_three_parents_ids(self):

        t = self.make_branch_and_tree('.')

        first_revision = t.commit('first post')

        uncommit(t.branch, tree=t)

        second_revision = t.commit('second post')

        uncommit(t.branch, tree=t)

        third_revision = t.commit('third post')

        uncommit(t.branch, tree=t)

        rev_tree1 = t.branch.repository.revision_tree(first_revision)

        rev_tree2 = t.branch.repository.revision_tree(second_revision)

        rev_tree3 = t.branch.repository.revision_tree(third_revision)

        t.set_parent_ids([first_revision, second_revision, third_revision])

        self.assertConsistentParents(

            [first_revision, second_revision, third_revision], t)

    def test_set_duplicate_parent_ids(self):

        t = self.make_branch_and_tree('.')

        rev1 = t.commit('first post')

        uncommit(t.branch, tree=t)

        rev2 = t.commit('second post')

        uncommit(t.branch, tree=t)

        rev3 = t.commit('third post')

        uncommit(t.branch, tree=t)

        t.set_parent_ids([rev1, rev2, rev2, rev3])

        # We strip the duplicate, but preserve the ordering

        self.assertConsistentParents([rev1, rev2, rev3], t)

    def test_set_duplicate_parent_trees(self):

        t = self.make_branch_and_tree('.')

        rev1 = t.commit('first post')

        uncommit(t.branch, tree=t)

        rev2 = t.commit('second post')

        uncommit(t.branch, tree=t)

        rev3 = t.commit('third post')

        uncommit(t.branch, tree=t)

        rev_tree1 = t.branch.repository.revision_tree(rev1)

        rev_tree2 = t.branch.repository.revision_tree(rev2)

        rev_tree3 = t.branch.repository.revision_tree(rev3)

        t.set_parent_trees([(rev1, rev_tree1), (rev2, rev_tree2),

                            (rev2, rev_tree2), (rev3, rev_tree3)])

        # We strip the duplicate, but preserve the ordering

        self.assertConsistentParents([rev1, rev2, rev3], t)

    def test_set_parent_ids_in_ancestry(self):

        t = self.make_branch_and_tree('.')

        rev1 = t.commit('first post')

        rev2 = t.commit('second post')

        rev3 = t.commit('third post')

        # Reset the tree, back to rev1

        t.set_parent_ids([rev1])

        t.branch.set_last_revision_info(1, rev1)

        self.assertConsistentParents([rev1], t)

        t.set_parent_ids([rev1, rev2, rev3])

        # rev2 is in the ancestry of rev3, so it will be filtered out

        self.assertConsistentParents([rev1, rev3], t)

        # Order should be preserved, and the first revision should always be

        # kept

        t.set_parent_ids([rev2, rev3, rev1])

        self.assertConsistentParents([rev2, rev3], t)

    def test_set_parent_trees_in_ancestry(self):

        t = self.make_branch_and_tree('.')

        rev1 = t.commit('first post')

        rev2 = t.commit('second post')

        rev3 = t.commit('third post')

        # Reset the tree, back to rev1

        t.set_parent_ids([rev1])

        t.branch.set_last_revision_info(1, rev1)

        self.assertConsistentParents([rev1], t)

        rev_tree1 = t.branch.repository.revision_tree(rev1)

        rev_tree2 = t.branch.repository.revision_tree(rev2)

        rev_tree3 = t.branch.repository.revision_tree(rev3)

        t.set_parent_trees([(rev1, rev_tree1), (rev2, rev_tree2),

                            (rev3, rev_tree3)])

        # rev2 is in the ancestry of rev3, so it will be filtered out

        self.assertConsistentParents([rev1, rev3], t)

        # Order should be preserved, and the first revision should always be

        # kept

        t.set_parent_trees([(rev2, rev_tree2), (rev1, rev_tree1),

                            (rev3, rev_tree3)])

        self.assertConsistentParents([rev2, rev3], t)

    def test_unicode_symlink(self):

        # this tests bug #272444

        self.requireFeature(features.SymlinkFeature)

        self.requireFeature(features.UnicodeFilenameFeature)

        tree = self.make_branch_and_tree('tree1')

        # The link points to a file whose name is an omega

        # U+03A9 GREEK CAPITAL LETTER OMEGA

        # UTF-8: ce a9  UTF-16BE: 03a9  Decimal: Ω

        target = u'\u03a9'

        link_name = u'\N{Euro Sign}link'

        os.symlink(target, 'tree1/' + link_name)

        tree.add([link_name])

        revision1 = tree.commit('added a link to a Unicode target')

        revision2 = tree.commit('this revision will be discarded')

        tree.set_parent_ids([revision1])

        tree.lock_read()

        self.addCleanup(tree.unlock)

        # Check that the symlink target is safely round-tripped in the trees.

        self.assertEqual(target, tree.get_symlink_target(link_name))

        basis = tree.basis_tree()

        self.assertEqual(target, basis.get_symlink_target(link_name))

class TestAddParent(TestParents):

    def test_add_first_parent_id(self):

        """Test adding the first parent id"""

        tree = self.make_branch_and_tree('.')

        first_revision = tree.commit('first post')

        uncommit(tree.branch, tree=tree)

        tree.add_parent_tree_id(first_revision)

        self.assertConsistentParents([first_revision], tree)

    def test_add_first_parent_id_ghost_rejects(self):

        """Test adding the first parent id - as a ghost"""

        tree = self.make_branch_and_tree('.')

        self.assertRaises(errors.GhostRevisionUnusableHere,

                          tree.add_parent_tree_id, b'first-revision')

    def test_add_first_parent_id_ghost_force(self):

        """Test adding the first parent id - as a ghost"""

        tree = self.make_branch_and_tree('.')

        try:

            tree.add_parent_tree_id(

                b'first-revision', allow_leftmost_as_ghost=True)

        except errors.GhostRevisionUnusableHere:

            self.assertFalse(tree._format.supports_leftmost_parent_id_as_ghost)

        else:

            self.assertTrue(tree._format.supports_leftmost_parent_id_as_ghost)

            self.assertConsistentParents([b'first-revision'], tree)

    def test_add_second_parent_id_with_ghost_first(self):

        """Test adding the second parent when the first is a ghost."""

        tree = self.make_branch_and_tree('.')

        try:

            tree.add_parent_tree_id(

                b'first-revision', allow_leftmost_as_ghost=True)

        except errors.GhostRevisionUnusableHere:

            self.assertFalse(tree._format.supports_leftmost_parent_id_as_ghost)

        else:

            tree.add_parent_tree_id(b'second')

            self.assertConsistentParents([b'first-revision', b'second'], tree)

    def test_add_second_parent_id(self):

        """Test adding the second parent id"""

        tree = self.make_branch_and_tree('.')

        first_revision = tree.commit('first post')

        uncommit(tree.branch, tree=tree)

        second_revision = tree.commit('second post')

        tree.add_parent_tree_id(first_revision)

        self.assertConsistentParents([second_revision, first_revision], tree)

    def test_add_second_parent_id_ghost(self):

        """Test adding the second parent id - as a ghost"""

        tree = self.make_branch_and_tree('.')

        first_revision = tree.commit('first post')

        if tree._format.supports_righthand_parent_id_as_ghost:

            tree.add_parent_tree_id(b'second')

            self.assertConsistentParents([first_revision, b'second'], tree)

        else:

            self.assertRaises(errors.GhostRevisionUnusableHere,

                              tree.add_parent_tree_id, b'second')

    def test_add_first_parent_tree(self):

        """Test adding the first parent id"""

        tree = self.make_branch_and_tree('.')

        first_revision = tree.commit('first post')

        uncommit(tree.branch, tree=tree)

        tree.add_parent_tree((first_revision,

                              tree.branch.repository.revision_tree(first_revision)))

        self.assertConsistentParents([first_revision], tree)

    def test_add_first_parent_tree_ghost_rejects(self):

        """Test adding the first parent id - as a ghost"""

        tree = self.make_branch_and_tree('.')

        self.assertRaises(errors.GhostRevisionUnusableHere,

                          tree.add_parent_tree, (b'first-revision', None))

    def test_add_first_parent_tree_ghost_force(self):

        """Test adding the first parent id - as a ghost"""

        tree = self.make_branch_and_tree('.')

        try:

            tree.add_parent_tree((b'first-revision', None),

                                 allow_leftmost_as_ghost=True)

        except errors.GhostRevisionUnusableHere:

            self.assertFalse(tree._format.supports_leftmost_parent_id_as_ghost)

        else:

            self.assertTrue(tree._format.supports_leftmost_parent_id_as_ghost)

            self.assertConsistentParents([b'first-revision'], tree)

    def test_add_second_parent_tree(self):

        """Test adding the second parent id"""

        tree = self.make_branch_and_tree('.')

        first_revision = tree.commit('first post')

        uncommit(tree.branch, tree=tree)

        second_revision = tree.commit('second post')

        tree.add_parent_tree((first_revision,

                              tree.branch.repository.revision_tree(first_revision)))

        self.assertConsistentParents([second_revision, first_revision], tree)

    def test_add_second_parent_tree_ghost(self):

        """Test adding the second parent id - as a ghost"""

        tree = self.make_branch_and_tree('.')

        first_revision = tree.commit('first post')

        if tree._format.supports_righthand_parent_id_as_ghost:

            tree.add_parent_tree((b'second', None))

            self.assertConsistentParents([first_revision, b'second'], tree)

        else:

            self.assertRaises(errors.GhostRevisionUnusableHere,

                              tree.add_parent_tree, (b'second', None))

class UpdateToOneParentViaDeltaTests(TestCaseWithWorkingTree):

    """Tests for the update_basis_by_delta call.

    This is intuitively defined as 'apply an inventory delta to the basis and

    discard other parents', but for trees that have an inventory that is not

    managed as a tree-by-id, the implementation requires roughly duplicated

    tests with those for apply_inventory_delta on the main tree.

    """

    def assertDeltaApplicationResultsInExpectedBasis(self, tree, revid, delta,

                                                     expected_inventory):

        with tree.lock_write():

            tree.update_basis_by_delta(revid, delta)

        # check the last revision was adjusted to rev_id

        self.assertEqual(revid, tree.last_revision())

        # check the parents are what we expect

        self.assertEqual([revid], tree.get_parent_ids())

        # check that the basis tree has the inventory we expect from applying

        # the delta.

        result_basis = tree.basis_tree()

        with result_basis.lock_read():

            self.assertEqual(expected_inventory, result_basis.root_inventory)

    def make_inv_delta(self, old, new):

        """Make an inventory delta from two inventories."""

        old_ids = set(old._byid)

        new_ids = set(new._byid)

        adds = new_ids - old_ids

        deletes = old_ids - new_ids

        common = old_ids.intersection(new_ids)

        delta = []

        for file_id in deletes:

            delta.append((old.id2path(file_id), None, file_id, None))

        for file_id in adds:

            delta.append((None, new.id2path(file_id),

                          file_id, new.get_entry(file_id)))

        for file_id in common:

            if old.get_entry(file_id) != new.get_entry(file_id):

                delta.append((old.id2path(file_id), new.id2path(file_id),

                              file_id, new.get_entry(file_id)))

        return delta

    def fake_up_revision(self, tree, revid, shape):

        if not isinstance(tree, InventoryTree):

            raise TestNotApplicable("test requires inventory tree")

        class ShapeTree(InventoryRevisionTree):

            def __init__(self, shape):

                self._repository = tree.branch.repository

                self._inventory = shape

            def get_file_text(self, path):

                file_id = self.path2id(path)

                ie = self.root_inventory.get_entry(file_id)

                if ie.kind != "file":

                    return b""

                return b'a' * ie.text_size

            def get_file(self, path):

                return BytesIO(self.get_file_text(path))

        with tree.lock_write():

            if shape.root.revision is None:

                shape.root.revision = revid

            builder = tree.branch.get_commit_builder(

                parents=[],

                timestamp=0,

                timezone=None,

                committer="Foo Bar <foo@example.com>",

                revision_id=revid)

            shape_tree = ShapeTree(shape)

            base_tree = tree.branch.repository.revision_tree(

                _mod_revision.NULL_REVISION)

            changes = shape_tree.iter_changes(

                base_tree)

            list(builder.record_iter_changes(

                shape_tree, base_tree.get_revision_id(), changes))

            builder.finish_inventory()

            builder.commit("Message")

    def add_entry(self, inv, rev_id, entry):

        entry.revision = rev_id

        inv.add(entry)

    def add_dir(self, inv, rev_id, file_id, parent_id, name):

        new_dir = InventoryDirectory(file_id, name, parent_id)

        self.add_entry(inv, rev_id, new_dir)

    def add_file(self, inv, rev_id, file_id, parent_id, name, sha, size):

        new_file = InventoryFile(file_id, name, parent_id)

        new_file.text_sha1 = sha

        new_file.text_size = size

        self.add_entry(inv, rev_id, new_file)

    def add_link(self, inv, rev_id, file_id, parent_id, name, target):

        new_link = InventoryLink(file_id, name, parent_id)

        new_link.symlink_target = target

        self.add_entry(inv, rev_id, new_link)

    def add_new_root(self, new_shape, old_revid, new_revid):

        if self.bzrdir_format.repository_format.rich_root_data:

            self.add_dir(new_shape, old_revid, b'root-id', None, '')

        else:

            self.add_dir(new_shape, new_revid, b'root-id', None, '')

    def assertTransitionFromBasisToShape(self, basis_shape, basis_revid,

                                         new_shape, new_revid, extra_parent=None, set_current_inventory=True):

        # set the inventory revision ids.

        basis_shape.revision_id = basis_revid

        new_shape.revision_id = new_revid

        delta = self.make_inv_delta(basis_shape, new_shape)

        tree = self.make_branch_and_tree('tree')

        # the shapes need to be in the tree's repository to be able to set them

        # as a parent, but the file content is not needed.

        if basis_revid is not None:

            self.fake_up_revision(tree, basis_revid, basis_shape)

            parents = [basis_revid]

            if extra_parent is not None:

                parents.append(extra_parent)

            tree.set_parent_ids(parents)

        self.fake_up_revision(tree, new_revid, new_shape)

        if set_current_inventory:

            # give tree an inventory of new_shape

            tree._write_inventory(new_shape)

        self.assertDeltaApplicationResultsInExpectedBasis(tree, new_revid,

                                                          delta, new_shape)

        # The tree should be internally consistent; while this is a moderately

        # large hammer, this is a particularly sensitive area of code, so the

        # extra assurance is well worth it.

        tree._validate()

        # If tree.branch is remote

        if tree.user_url != tree.branch.user_url:

            # We have a lightweight checkout, delete both locations

            tree.branch.controldir.root_transport.delete_tree('.')

        tree.controldir.root_transport.delete_tree('.')

    def test_no_parents_just_root(self):

        """Test doing an empty commit - no parent, set a root only."""

        basis_shape = Inventory(root_id=None)  # empty tree

        new_shape = Inventory()  # tree with a root

        self.assertTransitionFromBasisToShape(basis_shape, None, new_shape,

                                              b'new_parent')

    def test_no_parents_full_tree(self):

        """Test doing a regular initial commit with files and dirs."""

        basis_shape = Inventory(root_id=None)  # empty tree

        revid = b'new-parent'

        new_shape = Inventory(root_id=None)

        self.add_dir(new_shape, revid, b'root-id', None, '')

        self.add_link(new_shape, revid, b'link-id',

                      b'root-id', 'link', 'target')

        self.add_file(new_shape, revid, b'file-id', b'root-id', 'file', b'1' * 32,

                      12)

        self.add_dir(new_shape, revid, b'dir-id', b'root-id', 'dir')

        self.add_file(new_shape, revid, b'subfile-id', b'dir-id', 'subfile',

                      b'2' * 32, 24)

        self.assertTransitionFromBasisToShape(basis_shape, None, new_shape,

                                              revid)

    def test_file_content_change(self):

        old_revid = b'old-parent'

        basis_shape = Inventory(root_id=None)

        self.add_dir(basis_shape, old_revid, b'root-id', None, '')

        self.add_file(basis_shape, old_revid, b'file-id', b'root-id', 'file',

                      b'1' * 32, 12)

        new_revid = b'new-parent'

        new_shape = Inventory(root_id=None)

        self.add_new_root(new_shape, old_revid, new_revid)

        self.add_file(new_shape, new_revid, b'file-id', b'root-id', 'file',

                      b'2' * 32, 24)

        self.assertTransitionFromBasisToShape(basis_shape, old_revid,

                                              new_shape, new_revid)

    def test_link_content_change(self):

        old_revid = b'old-parent'

        basis_shape = Inventory(root_id=None)

        self.add_dir(basis_shape, old_revid, b'root-id', None, '')

        self.add_link(basis_shape, old_revid, b'link-id', b'root-id', 'link',

                      'old-target')

        new_revid = b'new-parent'

        new_shape = Inventory(root_id=None)

        self.add_new_root(new_shape, old_revid, new_revid)