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

"""Tests for repository commit builder."""

from copy import copy

import errno

import os

import sys

from bzrlib import (

    errors,

    inventory,

    osutils,

    repository,

    revision as _mod_revision,

    tests,

    )

from bzrlib.graph import Graph

from bzrlib.tests.per_repository import test_repository

class TestCommitBuilder(test_repository.TestCaseWithRepository):

    def test_get_commit_builder(self):

        branch = self.make_branch('.')

        branch.repository.lock_write()

        builder = branch.repository.get_commit_builder(

            branch, [], branch.get_config())

        self.assertIsInstance(builder, repository.CommitBuilder)

        self.assertTrue(builder.random_revid)

        branch.repository.commit_write_group()

        branch.repository.unlock()

    def record_root(self, builder, tree):

        if builder.record_root_entry is True:

            tree.lock_read()

            try:

                ie = tree.inventory.root

            finally:

                tree.unlock()

            parent_tree = tree.branch.repository.revision_tree(

                              _mod_revision.NULL_REVISION)

            parent_invs = []

            builder.record_entry_contents(ie, parent_invs, '', tree,

                tree.path_content_summary(''))

    def test_finish_inventory(self):

        tree = self.make_branch_and_tree(".")

        tree.lock_write()

        try:

            builder = tree.branch.get_commit_builder([])

            self.record_root(builder, tree)

            builder.finish_inventory()

            tree.branch.repository.commit_write_group()

        finally:

            tree.unlock()

    def test_abort(self):

        tree = self.make_branch_and_tree(".")

        tree.lock_write()

        try:

            builder = tree.branch.get_commit_builder([])

            self.record_root(builder, tree)

            builder.finish_inventory()

            builder.abort()

        finally:

            tree.unlock()

    def test_commit_message(self):

        tree = self.make_branch_and_tree(".")

        tree.lock_write()

        try:

            builder = tree.branch.get_commit_builder([])

            self.record_root(builder, tree)

            builder.finish_inventory()

            rev_id = builder.commit('foo bar blah')

        finally:

            tree.unlock()

        rev = tree.branch.repository.get_revision(rev_id)

        self.assertEqual('foo bar blah', rev.message)

    def test_commit_with_revision_id(self):

        tree = self.make_branch_and_tree(".")

        tree.lock_write()

        try:

            # use a unicode revision id to test more corner cases.

            # The repository layer is meant to handle this.

            revision_id = u'\xc8abc'.encode('utf8')

            try:

                try:

                    builder = tree.branch.get_commit_builder([],

                        revision_id=revision_id)

                except errors.NonAsciiRevisionId:

                    revision_id = 'abc'

                    builder = tree.branch.get_commit_builder([],

                        revision_id=revision_id)

            except errors.CannotSetRevisionId:

                # This format doesn't support supplied revision ids

                return

            self.assertFalse(builder.random_revid)

            self.record_root(builder, tree)

            builder.finish_inventory()

            self.assertEqual(revision_id, builder.commit('foo bar'))

        finally:

            tree.unlock()

        self.assertTrue(tree.branch.repository.has_revision(revision_id))

        # the revision id must be set on the inventory when saving it. This

        # does not precisely test that - a repository that wants to can add it

        # on deserialisation, but thats all the current contract guarantees

        # anyway.

        self.assertEqual(revision_id,

            tree.branch.repository.get_inventory(revision_id).revision_id)

    def test_commit_without_root_errors(self):

        tree = self.make_branch_and_tree(".")

        tree.lock_write()

        try:

            self.build_tree(['foo'])

            tree.add('foo', 'foo-id')

            entry = tree.inventory['foo-id']

            builder = tree.branch.get_commit_builder([])

            self.assertRaises(errors.RootMissing,

                builder.record_entry_contents, entry, [], 'foo', tree,

                    tree.path_content_summary('foo'))

            builder.abort()

        finally:

            tree.unlock()

    def test_commit_unchanged_root(self):

        tree = self.make_branch_and_tree(".")

        old_revision_id = tree.commit('')

        tree.lock_write()

        parent_tree = tree.basis_tree()

        parent_tree.lock_read()

        self.addCleanup(parent_tree.unlock)

        builder = tree.branch.get_commit_builder([parent_tree.inventory])

        try:

            ie = inventory.make_entry('directory', '', None,

                    tree.get_root_id())

            delta, version_recorded, fs_hash = builder.record_entry_contents(

                ie, [parent_tree.inventory], '', tree,

                tree.path_content_summary(''))

            self.assertFalse(version_recorded)

            # if the repository format recorded a new root revision, that

            # should be in the delta

            got_new_revision = ie.revision != old_revision_id

            if got_new_revision:

                self.assertEqual(

                    ('', '', ie.file_id, ie),

                    delta)

                self.assertEqual(delta, builder.basis_delta[-1])

            else:

                self.assertEqual(None, delta)

            # Directories do not get hashed.

            self.assertEqual(None, fs_hash)

            builder.abort()

        except:

            builder.abort()

            tree.unlock()

            raise

        else:

            tree.unlock()

    def test_commit(self):

        tree = self.make_branch_and_tree(".")

        tree.lock_write()

        try:

            builder = tree.branch.get_commit_builder([])

            self.record_root(builder, tree)

            builder.finish_inventory()

            rev_id = builder.commit('foo bar')

        finally:

            tree.unlock()

        self.assertNotEqual(None, rev_id)

        self.assertTrue(tree.branch.repository.has_revision(rev_id))

        # the revision id must be set on the inventory when saving it. This does not

        # precisely test that - a repository that wants to can add it on deserialisation,

        # but thats all the current contract guarantees anyway.

        self.assertEqual(rev_id, tree.branch.repository.get_inventory(rev_id).revision_id)

    def test_record_delete(self):

        tree = self.make_branch_and_tree(".")

        self.build_tree(["foo"])

        tree.add(["foo"], ["foo-id"])

        rev_id = tree.commit("added foo")

        # Remove the inventory details for foo-id, because

        # record_entry_contents ends up copying root verbatim.

        tree.unversion(["foo-id"])

        tree.lock_write()

        try:

            basis = tree.branch.repository.revision_tree(rev_id)

            builder = tree.branch.get_commit_builder([rev_id])

            try:

                builder.recording_deletes()

                if builder.record_root_entry is True:

                    parent_invs = [basis.inventory]

                    del basis.inventory.root.children['foo']

                    builder.record_entry_contents(basis.inventory.root,

                        parent_invs, '', tree, tree.path_content_summary(''))

                builder.record_delete("foo", "foo-id")

                self.assertEqual(("foo", None, "foo-id", None),

                    builder.basis_delta[-1])

                builder.finish_inventory()

                rev_id2 = builder.commit('delete foo')

            except:

                tree.branch.repository.abort_write_group()

                raise

        finally:

            tree.unlock()

        rev_tree = builder.revision_tree()

        rev_tree.lock_read()

        self.addCleanup(rev_tree.unlock)

        self.assertFalse(rev_tree.path2id('foo'))

    def test_record_delete_without_notification(self):

        tree = self.make_branch_and_tree(".")

        self.build_tree(["foo"])

        tree.add(["foo"], ["foo-id"])

        rev_id = tree.commit("added foo")

        tree.lock_write()

        try:

            builder = tree.branch.get_commit_builder([rev_id])

            try:

                self.record_root(builder, tree)

                self.assertRaises(AssertionError,

                    builder.record_delete, "foo", "foo-id")

            finally:

                tree.branch.repository.abort_write_group()

        finally:

            tree.unlock()

    def test_revision_tree(self):

        tree = self.make_branch_and_tree(".")

        tree.lock_write()

        try:

            builder = tree.branch.get_commit_builder([])

            self.record_root(builder, tree)

            builder.finish_inventory()

            rev_id = builder.commit('foo bar')

        finally:

            tree.unlock()

        rev_tree = builder.revision_tree()

        # Just a couple simple tests to ensure that it actually follows

        # the RevisionTree api.

        self.assertEqual(rev_id, rev_tree.get_revision_id())

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

    def test_root_entry_has_revision(self):

        # test the root revision created and put in the basis

        # has the right rev id.

        tree = self.make_branch_and_tree('.')

        rev_id = tree.commit('message')

        basis_tree = tree.basis_tree()

        basis_tree.lock_read()

        self.addCleanup(basis_tree.unlock)

        self.assertEqual(rev_id, basis_tree.inventory.root.revision)

    def _get_revtrees(self, tree, revision_ids):

        tree.lock_read()

        try:

            trees = list(tree.branch.repository.revision_trees(revision_ids))

            for _tree in trees:

                _tree.lock_read()

                self.addCleanup(_tree.unlock)

            return trees

        finally:

            tree.unlock()

    def test_last_modified_revision_after_commit_root_unchanged(self):

        # commiting without changing the root does not change the 

        # last modified except on non-rich-root-repositories.

        tree = self.make_branch_and_tree('.')

        rev1 = tree.commit('')

        rev2 = tree.commit('')

        tree1, tree2 = self._get_revtrees(tree, [rev1, rev2])

        self.assertEqual(rev1, tree1.inventory.root.revision)

        if tree.branch.repository.supports_rich_root():

            self.assertEqual(rev1, tree2.inventory.root.revision)

        else:

            self.assertEqual(rev2, tree2.inventory.root.revision)

    def _add_commit_check_unchanged(self, tree, name):

        tree.add([name], [name + 'id'])

        rev1 = tree.commit('')

        rev2 = self.mini_commit(tree, name, name, False, False)

        tree1, tree2 = self._get_revtrees(tree, [rev1, rev2])

        self.assertEqual(rev1, tree1.inventory[name + 'id'].revision)

        self.assertEqual(rev1, tree2.inventory[name + 'id'].revision)

        file_id = name + 'id'

        expected_graph = {}

        expected_graph[(file_id, rev1)] = ()

        self.assertFileGraph(expected_graph, tree, (file_id, rev1))

    def test_last_modified_revision_after_commit_dir_unchanged(self):

        # committing without changing a dir does not change the last modified.

        tree = self.make_branch_and_tree('.')

        self.build_tree(['dir/'])

        self._add_commit_check_unchanged(tree, 'dir')

    def test_last_modified_revision_after_commit_dir_contents_unchanged(self):

        # committing without changing a dir does not change the last modified

        # of the dir even the dirs contents are changed.

        tree = self.make_branch_and_tree('.')

        self.build_tree(['dir/'])

        tree.add(['dir'], ['dirid'])

        rev1 = tree.commit('')

        self.build_tree(['dir/content'])

        tree.add(['dir/content'], ['contentid'])

        rev2 = tree.commit('')

        tree1, tree2 = self._get_revtrees(tree, [rev1, rev2])

        self.assertEqual(rev1, tree1.inventory['dirid'].revision)

        self.assertEqual(rev1, tree2.inventory['dirid'].revision)

        file_id = 'dirid'

        expected_graph = {}

        expected_graph[(file_id, rev1)] = ()

        self.assertFileGraph(expected_graph, tree, (file_id, rev1))

    def test_last_modified_revision_after_commit_file_unchanged(self):

        # committing without changing a file does not change the last modified.

        tree = self.make_branch_and_tree('.')

        self.build_tree(['file'])

        self._add_commit_check_unchanged(tree, 'file')

    def test_last_modified_revision_after_commit_link_unchanged(self):

        # committing without changing a link does not change the last modified.

        self.requireFeature(tests.SymlinkFeature)

        tree = self.make_branch_and_tree('.')

        os.symlink('target', 'link')

        self._add_commit_check_unchanged(tree, 'link')

    def _add_commit_renamed_check_changed(self, tree, name,

        expect_fs_hash=False):

        def rename():

            tree.rename_one(name, 'new_' + name)

        self._add_commit_change_check_changed(tree, name, rename,

            expect_fs_hash=expect_fs_hash)

    def test_last_modified_revision_after_rename_dir_changes(self):

        # renaming a dir changes the last modified.

        tree = self.make_branch_and_tree('.')

        self.build_tree(['dir/'])

        self._add_commit_renamed_check_changed(tree, 'dir')

    def test_last_modified_revision_after_rename_file_changes(self):

        # renaming a file changes the last modified.

        tree = self.make_branch_and_tree('.')

        self.build_tree(['file'])

        self._add_commit_renamed_check_changed(tree, 'file',

            expect_fs_hash=True)

    def test_last_modified_revision_after_rename_link_changes(self):

        # renaming a link changes the last modified.

        self.requireFeature(tests.SymlinkFeature)

        tree = self.make_branch_and_tree('.')

        os.symlink('target', 'link')

        self._add_commit_renamed_check_changed(tree, 'link')

    def _add_commit_reparent_check_changed(self, tree, name,

        expect_fs_hash=False):

        self.build_tree(['newparent/'])

        tree.add(['newparent'])

        def reparent():

            tree.rename_one(name, 'newparent/new_' + name)

        self._add_commit_change_check_changed(tree, name, reparent,

            expect_fs_hash=expect_fs_hash)

    def test_last_modified_revision_after_reparent_dir_changes(self):

        # reparenting a dir changes the last modified.

        tree = self.make_branch_and_tree('.')

        self.build_tree(['dir/'])

        self._add_commit_reparent_check_changed(tree, 'dir')

    def test_last_modified_revision_after_reparent_file_changes(self):

        # reparenting a file changes the last modified.

        tree = self.make_branch_and_tree('.')

        self.build_tree(['file'])

        self._add_commit_reparent_check_changed(tree, 'file',

            expect_fs_hash=True)

    def test_last_modified_revision_after_reparent_link_changes(self):

        # reparenting a link changes the last modified.

        self.requireFeature(tests.SymlinkFeature)

        tree = self.make_branch_and_tree('.')

        os.symlink('target', 'link')

        self._add_commit_reparent_check_changed(tree, 'link')

    def _add_commit_change_check_changed(self, tree, name, changer,

        expect_fs_hash=False):

        tree.add([name], [name + 'id'])

        rev1 = tree.commit('')

        changer()

        rev2 = self.mini_commit(tree, name, tree.id2path(name + 'id'),

            expect_fs_hash=expect_fs_hash)

        tree1, tree2 = self._get_revtrees(tree, [rev1, rev2])

        self.assertEqual(rev1, tree1.inventory[name + 'id'].revision)

        self.assertEqual(rev2, tree2.inventory[name + 'id'].revision)

        file_id = name + 'id'

        expected_graph = {}

        expected_graph[(file_id, rev1)] = ()

        expected_graph[(file_id, rev2)] = ((file_id, rev1),)

        self.assertFileGraph(expected_graph, tree, (file_id, rev2))

    def mini_commit(self, tree, name, new_name, records_version=True,

        delta_against_basis=True, expect_fs_hash=False):

        """Perform a miniature commit looking for record entry results.

        :param tree: The tree to commit.

        :param name: The path in the basis tree of the tree being committed.

        :param new_name: The path in the tree being committed.

        :param records_version: True if the commit of new_name is expected to

            record a new version.

        :param delta_against_basis: True of the commit of new_name is expected

            to have a delta against the basis.

        :param expect_fs_hash: True or false to indicate whether we expect a

            file hash to be returned from the record_entry_contents call.

        """

        tree.lock_write()

        try:

            # mini manual commit here so we can check the return of

            # record_entry_contents.

            parent_ids = tree.get_parent_ids()

            builder = tree.branch.get_commit_builder(parent_ids)

            parent_tree = tree.basis_tree()

            parent_tree.lock_read()

            self.addCleanup(parent_tree.unlock)

            parent_invs = [parent_tree.inventory]

            for parent_id in parent_ids[1:]:

                parent_invs.append(tree.branch.repository.revision_tree(

                    parent_id).inventory)

            # root

            builder.record_entry_contents(

                inventory.make_entry('directory', '', None,

                    tree.get_root_id()), parent_invs, '', tree,

                    tree.path_content_summary(''))

            def commit_id(file_id):

                old_ie = tree.inventory[file_id]

                path = tree.id2path(file_id)

                ie = inventory.make_entry(tree.kind(file_id), old_ie.name,

                    old_ie.parent_id, file_id)

                return builder.record_entry_contents(ie, parent_invs, path,

                    tree, tree.path_content_summary(path))

            file_id = tree.path2id(new_name)

            parent_id = tree.inventory[file_id].parent_id

            if parent_id != tree.get_root_id():

                commit_id(parent_id)

            # because a change of some sort is meant to have occurred,

            # recording the entry must return True.

            delta, version_recorded, fs_hash = commit_id(file_id)

            if records_version:

                self.assertTrue(version_recorded)

            else:

                self.assertFalse(version_recorded)

            if expect_fs_hash:

                tree_file_stat = tree.get_file_with_stat(file_id)

                tree_file_stat[0].close()

                self.assertEqual(2, len(fs_hash))

                self.assertEqual(tree.get_file_sha1(file_id), fs_hash[0])

                self.assertEqualStat(tree_file_stat[1], fs_hash[1])

            else:

                self.assertEqual(None, fs_hash)

            new_entry = builder.new_inventory[file_id]

            if delta_against_basis:

                expected_delta = (name, new_name, file_id, new_entry)

                self.assertEqual(expected_delta, builder.basis_delta[-1])

            else:

                expected_delta = None

            self.assertEqual(expected_delta, delta)

            builder.finish_inventory()

            rev2 = builder.commit('')

        except:

            builder.abort()

            tree.unlock()

            raise

        try:

            tree.set_parent_ids([rev2])

        finally:

            tree.unlock()

        return rev2

    def assertFileGraph(self, expected_graph, tree, tip):

        # all the changes that have occured should be in the ancestry

        # (closest to a public per-file graph API we have today)

        tree.lock_read()

        self.addCleanup(tree.unlock)

        graph = dict(Graph(tree.branch.repository.texts).iter_ancestry([tip]))

        self.assertEqual(expected_graph, graph)

    def test_last_modified_revision_after_content_file_changes(self):

        # altering a file changes the last modified.

        tree = self.make_branch_and_tree('.')

        self.build_tree(['file'])

        def change_file():

            tree.put_file_bytes_non_atomic('fileid', 'new content')

        self._add_commit_change_check_changed(tree, 'file', change_file,

            expect_fs_hash=True)

    def test_last_modified_revision_after_content_link_changes(self):

        # changing a link changes the last modified.

        self.requireFeature(tests.SymlinkFeature)

        tree = self.make_branch_and_tree('.')

        os.symlink('target', 'link')

        def change_link():

            os.unlink('link')

            os.symlink('newtarget', 'link')

        self._add_commit_change_check_changed(tree, 'link', change_link)

    def _commit_sprout(self, tree, name):

        tree.add([name], [name + 'id'])

        rev_id = tree.commit('')

        return rev_id, tree.bzrdir.sprout('t2').open_workingtree()

    def _rename_in_tree(self, tree, name):

        tree.rename_one(name, 'new_' + name)

        return tree.commit('')

    def _commit_sprout_rename_merge(self, tree1, name, expect_fs_hash=False):

        rev1, tree2 = self._commit_sprout(tree1, name)

        # change both sides equally

        rev2 = self._rename_in_tree(tree1, name)

        rev3 = self._rename_in_tree(tree2, name)

        tree1.merge_from_branch(tree2.branch)

        rev4 = self.mini_commit(tree1, 'new_' + name, 'new_' + name,

            expect_fs_hash=expect_fs_hash)

        tree3, = self._get_revtrees(tree1, [rev4])

        self.assertEqual(rev4, tree3.inventory[name + 'id'].revision)

        file_id = name + 'id'

        expected_graph = {}

        expected_graph[(file_id, rev1)] = ()

        expected_graph[(file_id, rev2)] = ((file_id, rev1),)

        expected_graph[(file_id, rev3)] = ((file_id, rev1),)

        expected_graph[(file_id, rev4)] = ((file_id, rev2), (file_id, rev3),)

        self.assertFileGraph(expected_graph, tree1, (file_id, rev4))

    def test_last_modified_revision_after_merge_dir_changes(self):

        # merge a dir changes the last modified.

        tree1 = self.make_branch_and_tree('t1')

        self.build_tree(['t1/dir/'])

        self._commit_sprout_rename_merge(tree1, 'dir')

    def test_last_modified_revision_after_merge_file_changes(self):

        # merge a file changes the last modified.

        tree1 = self.make_branch_and_tree('t1')

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

        self._commit_sprout_rename_merge(tree1, 'file', expect_fs_hash=True)

    def test_last_modified_revision_after_merge_link_changes(self):

        # merge a link changes the last modified.

        self.requireFeature(tests.SymlinkFeature)

        tree1 = self.make_branch_and_tree('t1')

        os.symlink('target', 't1/link')

        self._commit_sprout_rename_merge(tree1, 'link')

    def _commit_sprout_rename_merge_converged(self, tree1, name):

        rev1, tree2 = self._commit_sprout(tree1, name)

        # change on the other side to merge back

        rev2 = self._rename_in_tree(tree2, name)

        tree1.merge_from_branch(tree2.branch)

        rev3 = self.mini_commit(tree1, name, 'new_' + name, False)

        tree3, = self._get_revtrees(tree1, [rev2])

        self.assertEqual(rev2, tree3.inventory[name + 'id'].revision)

        file_id = name + 'id'

        expected_graph = {}

        expected_graph[(file_id, rev1)] = ()

        expected_graph[(file_id, rev2)] = ((file_id, rev1),)

        self.assertFileGraph(expected_graph, tree1, (file_id, rev2))

    def test_last_modified_revision_after_converged_merge_dir_changes(self):

        # merge a dir changes the last modified.

        tree1 = self.make_branch_and_tree('t1')

        self.build_tree(['t1/dir/'])

        self._commit_sprout_rename_merge_converged(tree1, 'dir')

    def test_last_modified_revision_after_converged_merge_file_changes(self):

        # merge a file changes the last modified.

        tree1 = self.make_branch_and_tree('t1')

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

        self._commit_sprout_rename_merge_converged(tree1, 'file')

    def test_last_modified_revision_after_converged_merge_link_changes(self):

        # merge a link changes the last modified.

        self.requireFeature(tests.SymlinkFeature)

        tree1 = self.make_branch_and_tree('t1')

        os.symlink('target', 't1/link')

        self._commit_sprout_rename_merge_converged(tree1, 'link')

    def make_dir(self, name):

        self.build_tree([name + '/'])

    def make_file(self, name):

        self.build_tree([name])

    def make_link(self, name):

        self.requireFeature(tests.SymlinkFeature)

        os.symlink('target', name)

    def _check_kind_change(self, make_before, make_after, expect_fs_hash=False):