~bzr-pqm/bzr/bzr.dev

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

import os

from bzrlib import errors, pack, shelf, tests, transform, workingtree

EMPTY_SHELF = ("Bazaar pack format 1 (introduced in 0.18)\n"

               "B23\n"

               "metadata\n\n"

               "d11:revision_id5:null:e"

               "B159\n"

               "attribs\n\n"

               "d10:_id_numberi0e18:_new_executabilityde7:_new_idde"

               "9:_new_namede11:_new_parentde16:_non_present_idsde"

               "17:_removed_contentsle11:_removed_idle14:_tree_path_idsdeeE")

class TestPrepareShelf(tests.TestCaseWithTransport):

    def test_shelve_rename(self):

        tree = self.make_branch_and_tree('.')

        self.build_tree(['foo'])

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

        tree.commit('foo')

        tree.rename_one('foo', 'bar')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('rename', 'foo-id', 'foo', 'bar')],

                          list(creator.iter_shelvable()))

        creator.shelve_rename('foo-id')

        work_trans_id = creator.work_transform.trans_id_file_id('foo-id')

        self.assertEqual('foo', creator.work_transform.final_name(

                         work_trans_id))

        shelf_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')

        self.assertEqual('bar', creator.shelf_transform.final_name(

                         shelf_trans_id))

    def test_shelve_move(self):

        tree = self.make_branch_and_tree('.')

        self.build_tree(['foo/', 'bar/', 'foo/baz'])

        tree.add(['foo', 'bar', 'foo/baz'], ['foo-id', 'bar-id', 'baz-id'])

        tree.commit('foo')

        tree.rename_one('foo/baz', 'bar/baz')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('rename', 'baz-id', 'foo/baz', 'bar/baz')],

                         list(creator.iter_shelvable()))

        creator.shelve_rename('baz-id')

        work_trans_id = creator.work_transform.trans_id_file_id('baz-id')

        work_foo = creator.work_transform.trans_id_file_id('foo-id')

        self.assertEqual(work_foo, creator.work_transform.final_parent(

                         work_trans_id))

        shelf_trans_id = creator.shelf_transform.trans_id_file_id('baz-id')

        shelf_bar = creator.shelf_transform.trans_id_file_id('bar-id')

        self.assertEqual(shelf_bar, creator.shelf_transform.final_parent(

                         shelf_trans_id))

        creator.transform()

        self.assertEqual('foo/baz', tree.id2path('baz-id'))

    def assertShelvedFileEqual(self, expected_content, creator, file_id):

        s_trans_id = creator.shelf_transform.trans_id_file_id(file_id)

        shelf_file = creator.shelf_transform._limbo_name(s_trans_id)

        self.assertFileEqual(expected_content, shelf_file)

    def test_shelve_content_change(self):

        tree = self.make_branch_and_tree('.')

        tree.lock_write()

        self.addCleanup(tree.unlock)

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

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

        tree.commit('Committed foo')

        self.build_tree_contents([('foo', 'b\na\nc\n')])

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('modify text', 'foo-id')],

                         list(creator.iter_shelvable()))

        creator.shelve_lines('foo-id', ['a\n', 'c\n'])

        creator.transform()

        self.assertFileEqual('a\nc\n', 'foo')

        self.assertShelvedFileEqual('b\na\n', creator, 'foo-id')

    def test_shelve_creation(self):

        tree = self.make_branch_and_tree('.')

        tree.lock_write()

        self.addCleanup(tree.unlock)

        tree.commit('Empty tree')

        self.build_tree_contents([('foo', 'a\n'), ('bar/',)])

        tree.add(['foo', 'bar'], ['foo-id', 'bar-id'])

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('add file', 'bar-id', 'directory', 'bar'),

                          ('add file', 'foo-id', 'file', 'foo')],

                          sorted(list(creator.iter_shelvable())))

        creator.shelve_creation('foo-id')

        creator.shelve_creation('bar-id')

        creator.transform()

        self.assertRaises(StopIteration,

                          tree.iter_entries_by_dir(['foo-id']).next)

        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')

        self.assertEqual('foo-id',

                         creator.shelf_transform.final_file_id(s_trans_id))

        self.failIfExists('foo')

        self.failIfExists('bar')

        self.assertShelvedFileEqual('a\n', creator, 'foo-id')

        s_bar_trans_id = creator.shelf_transform.trans_id_file_id('bar-id')

        self.assertEqual('directory',

            creator.shelf_transform.final_kind(s_bar_trans_id))

    def test_shelve_symlink_creation(self):

        self.requireFeature(tests.SymlinkFeature)

        tree = self.make_branch_and_tree('.')

        tree.lock_write()

        self.addCleanup(tree.unlock)

        tree.commit('Empty tree')

        os.symlink('bar', 'foo')

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

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('add file', 'foo-id', 'symlink', 'foo')],

                         list(creator.iter_shelvable()))

        creator.shelve_creation('foo-id')

        creator.transform()

        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')

        self.failIfExists('foo')

        limbo_name = creator.shelf_transform._limbo_name(s_trans_id)

        self.assertEqual('bar', os.readlink(limbo_name))

    def test_shelve_symlink_target_change(self):

        self.requireFeature(tests.SymlinkFeature)

        tree = self.make_branch_and_tree('.')

        tree.lock_write()

        self.addCleanup(tree.unlock)

        os.symlink('bar', 'foo')

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

        tree.commit("commit symlink")

        os.unlink("foo")

        os.symlink('baz', 'foo')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('modify target', 'foo-id', 'foo', 'bar', 'baz')],

                         list(creator.iter_shelvable()))

        creator.shelve_modify_target('foo-id')

        creator.transform()

        self.assertEqual('bar', os.readlink('foo'))

        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')

        limbo_name = creator.shelf_transform._limbo_name(s_trans_id)

        self.assertEqual('baz', os.readlink(limbo_name))

    def test_shelve_creation_no_contents(self):

        tree = self.make_branch_and_tree('.')

        tree.lock_write()

        self.addCleanup(tree.unlock)

        tree.commit('Empty tree')

        self.build_tree(['foo'])

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

        os.unlink('foo')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('add file', 'foo-id', None, 'foo')],

                         sorted(list(creator.iter_shelvable())))

        creator.shelve_creation('foo-id')

        creator.transform()

        self.assertRaises(StopIteration,

                          tree.iter_entries_by_dir(['foo-id']).next)

        self.assertShelvedFileEqual('', creator, 'foo-id')

        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')

        self.assertEqual('foo-id',

                         creator.shelf_transform.final_file_id(s_trans_id))

        self.failIfExists('foo')

    def test_shelve_deletion(self):

        tree = self.make_branch_and_tree('tree')

        tree.lock_write()

        self.addCleanup(tree.unlock)

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

        tree.add(['foo', 'foo/bar'], ['foo-id', 'bar-id'])

        tree.commit('Added file and directory')

        tree.unversion(['foo-id', 'bar-id'])

        os.unlink('tree/foo/bar')

        os.rmdir('tree/foo')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('delete file', 'bar-id', 'file', 'foo/bar'),

                          ('delete file', 'foo-id', 'directory', 'foo')],

                          sorted(list(creator.iter_shelvable())))

        creator.shelve_deletion('foo-id')

        creator.shelve_deletion('bar-id')

        creator.transform()

        self.assertTrue('foo-id' in tree)

        self.assertTrue('bar-id' in tree)

        self.assertFileEqual('baz', 'tree/foo/bar')

    def test_shelve_delete_contents(self):

        tree = self.make_branch_and_tree('tree')

        self.build_tree(['tree/foo',])

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

        tree.commit('Added file and directory')

        os.unlink('tree/foo')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('delete file', 'foo-id', 'file', 'foo')],

                         sorted(list(creator.iter_shelvable())))

        creator.shelve_deletion('foo-id')

        creator.transform()

        self.failUnlessExists('tree/foo')

    def test_shelve_change_kind(self):

        tree = self.make_branch_and_tree('tree')

        self.build_tree_contents([('tree/foo', 'bar')])

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

        tree.commit('Added file and directory')

        os.unlink('tree/foo')

        os.mkdir('tree/foo')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('change kind', 'foo-id', 'file', 'directory',

                           'foo')], sorted(list(creator.iter_shelvable())))

        creator.shelve_content_change('foo-id')

        creator.transform()

        self.assertFileEqual('bar', 'tree/foo')

        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')

        self.assertEqual('directory',

                         creator.shelf_transform._new_contents[s_trans_id])

    def test_shelve_unversion(self):

        tree = self.make_branch_and_tree('tree')

        self.build_tree(['tree/foo',])

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

        tree.commit('Added file and directory')

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

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        self.assertEqual([('delete file', 'foo-id', 'file', 'foo')],

                         sorted(list(creator.iter_shelvable())))

        creator.shelve_deletion('foo-id')

        creator.transform()

        self.failUnlessExists('tree/foo')

    def test_shelve_serialization(self):

        tree = self.make_branch_and_tree('.')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        shelf_file = open('shelf', 'wb')

        self.addCleanup(shelf_file.close)

        try:

            creator.write_shelf(shelf_file)

        finally:

            shelf_file.close()

        self.assertFileEqual(EMPTY_SHELF, 'shelf')

    def test_write_shelf(self):

        tree = self.make_branch_and_tree('tree')

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

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

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        list(creator.iter_shelvable())

        creator.shelve_creation('foo-id')

        shelf_file = open('shelf', 'wb')

        try:

            creator.write_shelf(shelf_file)

        finally:

            shelf_file.close()

        parser = pack.ContainerPushParser()

        shelf_file = open('shelf', 'rb')

        try:

            parser.accept_bytes(shelf_file.read())

        finally:

            shelf_file.close()

        tt = transform.TransformPreview(tree)

        self.addCleanup(tt.finalize)

        records = iter(parser.read_pending_records())

        #skip revision-id

        records.next()

        tt.deserialize(records)

    def test_shelve_unversioned(self):

        tree = self.make_branch_and_tree('tree')

        self.assertRaises(errors.PathsNotVersionedError,

                          shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])

        # We should be able to lock/unlock the tree if ShelfCreator cleaned

        # after itself.

        wt = workingtree.WorkingTree.open('tree')

        wt.lock_tree_write()

        wt.unlock()

        # And a second tentative should raise the same error (no

        # limbo/pending_deletion leftovers).

        self.assertRaises(errors.PathsNotVersionedError,

                          shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])

class TestUnshelver(tests.TestCaseWithTransport):

    def test_make_merger(self):

        tree = self.make_branch_and_tree('tree')

        tree.commit('first commit')

        self.build_tree_contents([('tree/foo', 'bar')])

        tree.lock_write()

        self.addCleanup(tree.unlock)

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

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        list(creator.iter_shelvable())

        creator.shelve_creation('foo-id')

        shelf_file = open('shelf-file', 'w+b')

        try:

            creator.write_shelf(shelf_file)

            creator.transform()

            shelf_file.seek(0)

            unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)

            unshelver.make_merger().do_merge()

            self.assertFileEqual('bar', 'tree/foo')

        finally:

            shelf_file.close()

    def test_unshelve_changed(self):

        tree = self.make_branch_and_tree('tree')

        tree.lock_write()

        self.addCleanup(tree.unlock)

        self.build_tree_contents([('tree/foo', 'a\nb\nc\n')])

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

        tree.commit('first commit')

        self.build_tree_contents([('tree/foo', 'a\nb\nd\n')])

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        list(creator.iter_shelvable())

        creator.shelve_lines('foo-id', ['a\n', 'b\n', 'c\n'])

        shelf_file = open('shelf', 'w+b')

        self.addCleanup(shelf_file.close)

        creator.write_shelf(shelf_file)

        creator.transform()

        self.build_tree_contents([('tree/foo', 'z\na\nb\nc\n')])

        shelf_file.seek(0)

        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)

        unshelver.make_merger().do_merge()

        self.assertFileEqual('z\na\nb\nd\n', 'tree/foo')

    def test_unshelve_deleted(self):

        tree = self.make_branch_and_tree('tree')

        tree.lock_write()

        self.addCleanup(tree.unlock)

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

        tree.add(['foo', 'foo/bar'], ['foo-id', 'bar-id'])

        tree.commit('Added file and directory')

        tree.unversion(['foo-id', 'bar-id'])

        os.unlink('tree/foo/bar')

        os.rmdir('tree/foo')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        list(creator.iter_shelvable())

        creator.shelve_deletion('foo-id')

        creator.shelve_deletion('bar-id')

        shelf_file = open('shelf', 'w+b')

        self.addCleanup(shelf_file.close)

        creator.write_shelf(shelf_file)

        creator.transform()

        creator.finalize()

        # validate the test setup

        self.assertTrue('foo-id' in tree)

        self.assertTrue('bar-id' in tree)

        self.assertFileEqual('baz', 'tree/foo/bar')

        shelf_file.seek(0)

        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)

        unshelver.make_merger().do_merge()

        self.assertFalse('foo-id' in tree)

        self.assertFalse('bar-id' in tree)

    def test_unshelve_base(self):

        tree = self.make_branch_and_tree('tree')

        tree.lock_write()

        self.addCleanup(tree.unlock)

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

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        manager = tree.get_shelf_manager()

        shelf_id, shelf_file = manager.new_shelf()

        try:

            creator.write_shelf(shelf_file)

        finally:

            shelf_file.close()

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

        shelf_file = manager.read_shelf(1)

        self.addCleanup(shelf_file.close)

        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)

        self.addCleanup(unshelver.finalize)

        self.assertEqual('rev1', unshelver.base_tree.get_revision_id())

    def test_unshelve_serialization(self):

        tree = self.make_branch_and_tree('.')

        self.build_tree_contents([('shelf', EMPTY_SHELF)])

        shelf_file = open('shelf', 'rb')

        self.addCleanup(shelf_file.close)

        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)

    def test_corrupt_shelf(self):

        tree = self.make_branch_and_tree('.')

        self.build_tree_contents([('shelf', EMPTY_SHELF.replace('metadata',

                                                                'foo'))])

        shelf_file = open('shelf', 'rb')

        self.addCleanup(shelf_file.close)

        e = self.assertRaises(errors.ShelfCorrupt,

                              shelf.Unshelver.from_tree_and_shelf, tree,

                              shelf_file)

        self.assertEqual('Shelf corrupt.', str(e))

class TestShelfManager(tests.TestCaseWithTransport):

    def test_get_shelf_manager(self):

        tree = self.make_branch_and_tree('.')

        manager = tree.get_shelf_manager()

        self.assertEqual(tree._transport.base + 'shelf/',

                         manager.transport.base)

    def get_manager(self):

        return self.make_branch_and_tree('.').get_shelf_manager()

    def test_get_shelf_filename(self):

        tree = self.make_branch_and_tree('.')

        manager = tree.get_shelf_manager()

        self.assertEqual('shelf-1', manager.get_shelf_filename(1))

    def test_get_shelf_ids(self):

        tree = self.make_branch_and_tree('.')

        manager = tree.get_shelf_manager()

        self.assertEqual([1, 3], manager.get_shelf_ids(

                         ['shelf-1', 'shelf-02', 'shelf-3']))

    def test_new_shelf(self):

        manager = self.get_manager()

        shelf_id, shelf_file = manager.new_shelf()

        shelf_file.close()

        self.assertEqual(1, shelf_id)

        shelf_id, shelf_file = manager.new_shelf()

        shelf_file.close()

        self.assertEqual(2, shelf_id)

        manager.delete_shelf(1)

        shelf_id, shelf_file = manager.new_shelf()

        shelf_file.close()

        self.assertEqual(3, shelf_id)

    def test_active_shelves(self):

        manager = self.get_manager()

        self.assertEqual([], manager.active_shelves())

        shelf_id, shelf_file = manager.new_shelf()

        shelf_file.close()

        self.assertEqual([1], manager.active_shelves())

    def test_delete_shelf(self):

        manager = self.get_manager()

        shelf_id, shelf_file = manager.new_shelf()

        shelf_file.close()

        self.assertEqual([1], manager.active_shelves())

        manager.delete_shelf(1)

        self.assertEqual([], manager.active_shelves())

    def test_last_shelf(self):

        manager = self.get_manager()

        self.assertIs(None, manager.last_shelf())

        shelf_id, shelf_file = manager.new_shelf()

        shelf_file.close()

        self.assertEqual(1, manager.last_shelf())

    def test_read_shelf(self):

        manager = self.get_manager()

        shelf_id, shelf_file = manager.new_shelf()

        try:

            shelf_file.write('foo')

        finally:

            shelf_file.close()

        shelf_id, shelf_file = manager.new_shelf()

        try:

            shelf_file.write('bar')

        finally:

            shelf_file.close()

        shelf_file = manager.read_shelf(1)

        try:

            self.assertEqual('foo', shelf_file.read())

        finally:

            shelf_file.close()

        shelf_file = manager.read_shelf(2)

        try:

            self.assertEqual('bar', shelf_file.read())

        finally:

            shelf_file.close()

    def test_read_non_existant(self):

        manager = self.get_manager()

        e = self.assertRaises(errors.NoSuchShelfId, manager.read_shelf, 1)

        self.assertEqual('No changes are shelved with id "1".', str(e))

    def test_shelve_changes(self):

        tree = self.make_branch_and_tree('tree')

        tree.commit('no-change commit')

        tree.lock_write()

        self.addCleanup(tree.unlock)

        self.build_tree_contents([('tree/foo', 'bar')])

        self.assertFileEqual('bar', 'tree/foo')

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

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        self.addCleanup(creator.finalize)

        list(creator.iter_shelvable())

        creator.shelve_creation('foo-id')

        shelf_manager = tree.get_shelf_manager()

        shelf_id = shelf_manager.shelve_changes(creator)

        self.failIfExists('tree/foo')

        unshelver = shelf_manager.get_unshelver(shelf_id)

        unshelver.make_merger().do_merge()

        self.assertFileEqual('bar', 'tree/foo')

    def test_get_metadata(self):

        tree = self.make_branch_and_tree('.')

        creator = shelf.ShelfCreator(tree, tree.basis_tree())

        shelf_manager = tree.get_shelf_manager()

        shelf_id = shelf_manager.shelve_changes(creator, 'foo')

        metadata = shelf_manager.get_metadata(shelf_id)

        self.assertEqual('foo', metadata['message'])

        self.assertEqual('null:', metadata['revision_id'])