~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2006, 2007 Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""Tests of the dirstate functionality being built for WorkingTreeFormat4."""

import bisect

import os

from bzrlib import (

    dirstate,

    errors,

    inventory,

    memorytree,

    osutils,

    revision as _mod_revision,

    tests,

    )

from bzrlib.tests import test_osutils

# TODO:

# TESTS to write:

# general checks for NOT_IN_MEMORY error conditions.

# set_path_id on a NOT_IN_MEMORY dirstate

# set_path_id  unicode support

# set_path_id  setting id of a path not root

# set_path_id  setting id when there are parents without the id in the parents

# set_path_id  setting id when there are parents with the id in the parents

# set_path_id  setting id when state is not in memory

# set_path_id  setting id when state is in memory unmodified

# set_path_id  setting id when state is in memory modified

def load_tests(basic_tests, module, loader):

    suite = loader.suiteClass()

    dir_reader_tests, remaining_tests = tests.split_suite_by_condition(

        basic_tests, tests.condition_isinstance(TestCaseWithDirState))

    tests.multiply_tests(dir_reader_tests,

                         test_osutils.dir_reader_scenarios(), suite)

    suite.addTest(remaining_tests)

    return suite

class TestCaseWithDirState(tests.TestCaseWithTransport):

    """Helper functions for creating DirState objects with various content."""

    # Set by load_tests

    _dir_reader_class = None

    _native_to_unicode = None # Not used yet

    def setUp(self):

        tests.TestCaseWithTransport.setUp(self)

        # Save platform specific info and reset it

        cur_dir_reader = osutils._selected_dir_reader

        def restore():

            osutils._selected_dir_reader = cur_dir_reader

        self.addCleanup(restore)

        osutils._selected_dir_reader = self._dir_reader_class()

    def create_empty_dirstate(self):

        """Return a locked but empty dirstate"""

        state = dirstate.DirState.initialize('dirstate')

        return state

    def create_dirstate_with_root(self):

        """Return a write-locked state with a single root entry."""

        packed_stat = 'AAAAREUHaIpFB2iKAAADAQAtkqUAAIGk'

        root_entry_direntry = ('', '', 'a-root-value'), [

            ('d', '', 0, False, packed_stat),

            ]

        dirblocks = []

        dirblocks.append(('', [root_entry_direntry]))

        dirblocks.append(('', []))

        state = self.create_empty_dirstate()

        try:

            state._set_data([], dirblocks)

            state._validate()

        except:

            state.unlock()

            raise

        return state

    def create_dirstate_with_root_and_subdir(self):

        """Return a locked DirState with a root and a subdir"""

        packed_stat = 'AAAAREUHaIpFB2iKAAADAQAtkqUAAIGk'

        subdir_entry = ('', 'subdir', 'subdir-id'), [

            ('d', '', 0, False, packed_stat),

            ]

        state = self.create_dirstate_with_root()

        try:

            dirblocks = list(state._dirblocks)

            dirblocks[1][1].append(subdir_entry)

            state._set_data([], dirblocks)

        except:

            state.unlock()

            raise

        return state

    def create_complex_dirstate(self):

        """This dirstate contains multiple files and directories.

         /        a-root-value

         a/       a-dir

         b/       b-dir

         c        c-file

         d        d-file

         a/e/     e-dir

         a/f      f-file

         b/g      g-file

         b/h\xc3\xa5  h-\xc3\xa5-file  #This is u'\xe5' encoded into utf-8

        Notice that a/e is an empty directory.

        :return: The dirstate, still write-locked.

        """

        packed_stat = 'AAAAREUHaIpFB2iKAAADAQAtkqUAAIGk'

        null_sha = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

        root_entry = ('', '', 'a-root-value'), [

            ('d', '', 0, False, packed_stat),

            ]

        a_entry = ('', 'a', 'a-dir'), [

            ('d', '', 0, False, packed_stat),

            ]

        b_entry = ('', 'b', 'b-dir'), [

            ('d', '', 0, False, packed_stat),

            ]

        c_entry = ('', 'c', 'c-file'), [

            ('f', null_sha, 10, False, packed_stat),

            ]

        d_entry = ('', 'd', 'd-file'), [

            ('f', null_sha, 20, False, packed_stat),

            ]

        e_entry = ('a', 'e', 'e-dir'), [

            ('d', '', 0, False, packed_stat),

            ]

        f_entry = ('a', 'f', 'f-file'), [

            ('f', null_sha, 30, False, packed_stat),

            ]

        g_entry = ('b', 'g', 'g-file'), [

            ('f', null_sha, 30, False, packed_stat),

            ]

        h_entry = ('b', 'h\xc3\xa5', 'h-\xc3\xa5-file'), [

            ('f', null_sha, 40, False, packed_stat),

            ]

        dirblocks = []

        dirblocks.append(('', [root_entry]))

        dirblocks.append(('', [a_entry, b_entry, c_entry, d_entry]))

        dirblocks.append(('a', [e_entry, f_entry]))

        dirblocks.append(('b', [g_entry, h_entry]))

        state = dirstate.DirState.initialize('dirstate')

        state._validate()

        try:

            state._set_data([], dirblocks)

        except:

            state.unlock()

            raise

        return state

    def check_state_with_reopen(self, expected_result, state):

        """Check that state has current state expected_result.

        This will check the current state, open the file anew and check it

        again.

        This function expects the current state to be locked for writing, and

        will unlock it before re-opening.

        This is required because we can't open a lock_read() while something

        else has a lock_write().

            write => mutually exclusive lock

            read => shared lock

        """

        # The state should already be write locked, since we just had to do

        # some operation to get here.

        self.assertTrue(state._lock_token is not None)

        try:

            self.assertEqual(expected_result[0],  state.get_parent_ids())

            # there should be no ghosts in this tree.

            self.assertEqual([], state.get_ghosts())

            # there should be one fileid in this tree - the root of the tree.

            self.assertEqual(expected_result[1], list(state._iter_entries()))

            state.save()

        finally:

            state.unlock()

        del state

        state = dirstate.DirState.on_file('dirstate')

        state.lock_read()

        try:

            self.assertEqual(expected_result[1], list(state._iter_entries()))

        finally:

            state.unlock()

    def create_basic_dirstate(self):

        """Create a dirstate with a few files and directories.

            a

            b/

              c

              d/

                e

            b-c

            f

        """

        tree = self.make_branch_and_tree('tree')

        paths = ['a', 'b/', 'b/c', 'b/d/', 'b/d/e', 'b-c', 'f']

        file_ids = ['a-id', 'b-id', 'c-id', 'd-id', 'e-id', 'b-c-id', 'f-id']

        self.build_tree(['tree/' + p for p in paths])

        tree.set_root_id('TREE_ROOT')

        tree.add([p.rstrip('/') for p in paths], file_ids)

        tree.commit('initial', rev_id='rev-1')

        revision_id = 'rev-1'

        # a_packed_stat = dirstate.pack_stat(os.stat('tree/a'))

        t = self.get_transport('tree')

        a_text = t.get_bytes('a')

        a_sha = osutils.sha_string(a_text)

        a_len = len(a_text)

        # b_packed_stat = dirstate.pack_stat(os.stat('tree/b'))

        # c_packed_stat = dirstate.pack_stat(os.stat('tree/b/c'))

        c_text = t.get_bytes('b/c')

        c_sha = osutils.sha_string(c_text)

        c_len = len(c_text)

        # d_packed_stat = dirstate.pack_stat(os.stat('tree/b/d'))

        # e_packed_stat = dirstate.pack_stat(os.stat('tree/b/d/e'))

        e_text = t.get_bytes('b/d/e')

        e_sha = osutils.sha_string(e_text)

        e_len = len(e_text)

        b_c_text = t.get_bytes('b-c')

        b_c_sha = osutils.sha_string(b_c_text)

        b_c_len = len(b_c_text)

        # f_packed_stat = dirstate.pack_stat(os.stat('tree/f'))

        f_text = t.get_bytes('f')

        f_sha = osutils.sha_string(f_text)

        f_len = len(f_text)

        null_stat = dirstate.DirState.NULLSTAT

        expected = {

            '':(('', '', 'TREE_ROOT'), [

                  ('d', '', 0, False, null_stat),

                  ('d', '', 0, False, revision_id),

                ]),

            'a':(('', 'a', 'a-id'), [

                   ('f', '', 0, False, null_stat),

                   ('f', a_sha, a_len, False, revision_id),

                 ]),

            'b':(('', 'b', 'b-id'), [

                  ('d', '', 0, False, null_stat),

                  ('d', '', 0, False, revision_id),

                 ]),

            'b/c':(('b', 'c', 'c-id'), [

                    ('f', '', 0, False, null_stat),

                    ('f', c_sha, c_len, False, revision_id),

                   ]),

            'b/d':(('b', 'd', 'd-id'), [

                    ('d', '', 0, False, null_stat),

                    ('d', '', 0, False, revision_id),

                   ]),

            'b/d/e':(('b/d', 'e', 'e-id'), [

                      ('f', '', 0, False, null_stat),

                      ('f', e_sha, e_len, False, revision_id),

                     ]),

            'b-c':(('', 'b-c', 'b-c-id'), [

                      ('f', '', 0, False, null_stat),

                      ('f', b_c_sha, b_c_len, False, revision_id),

                     ]),

            'f':(('', 'f', 'f-id'), [

                  ('f', '', 0, False, null_stat),

                  ('f', f_sha, f_len, False, revision_id),

                 ]),

        }

        state = dirstate.DirState.from_tree(tree, 'dirstate')

        try:

            state.save()

        finally:

            state.unlock()

        # Use a different object, to make sure nothing is pre-cached in memory.

        state = dirstate.DirState.on_file('dirstate')

        state.lock_read()

        self.addCleanup(state.unlock)

        self.assertEqual(dirstate.DirState.NOT_IN_MEMORY,

                         state._dirblock_state)

        # This is code is only really tested if we actually have to make more

        # than one read, so set the page size to something smaller.

        # We want it to contain about 2.2 records, so that we have a couple

        # records that we can read per attempt

        state._bisect_page_size = 200

        return tree, state, expected

    def create_duplicated_dirstate(self):

        """Create a dirstate with a deleted and added entries.

        This grabs a basic_dirstate, and then removes and re adds every entry

        with a new file id.

        """

        tree, state, expected = self.create_basic_dirstate()

        # Now we will just remove and add every file so we get an extra entry

        # per entry. Unversion in reverse order so we handle subdirs

        tree.unversion(['f-id', 'b-c-id', 'e-id', 'd-id', 'c-id', 'b-id', 'a-id'])

        tree.add(['a', 'b', 'b/c', 'b/d', 'b/d/e', 'b-c', 'f'],

                 ['a-id2', 'b-id2', 'c-id2', 'd-id2', 'e-id2', 'b-c-id2', 'f-id2'])

        # Update the expected dictionary.

        for path in ['a', 'b', 'b/c', 'b/d', 'b/d/e', 'b-c', 'f']:

            orig = expected[path]

            path2 = path + '2'

            # This record was deleted in the current tree

            expected[path] = (orig[0], [dirstate.DirState.NULL_PARENT_DETAILS,

                                        orig[1][1]])

            new_key = (orig[0][0], orig[0][1], orig[0][2]+'2')

            # And didn't exist in the basis tree

            expected[path2] = (new_key, [orig[1][0],

                                         dirstate.DirState.NULL_PARENT_DETAILS])

        # We will replace the 'dirstate' file underneath 'state', but that is

        # okay as lock as we unlock 'state' first.

        state.unlock()

        try:

            new_state = dirstate.DirState.from_tree(tree, 'dirstate')

            try:

                new_state.save()

            finally:

                new_state.unlock()

        finally:

            # But we need to leave state in a read-lock because we already have

            # a cleanup scheduled

            state.lock_read()

        return tree, state, expected

    def create_renamed_dirstate(self):

        """Create a dirstate with a few internal renames.

        This takes the basic dirstate, and moves the paths around.

        """

        tree, state, expected = self.create_basic_dirstate()

        # Rename a file

        tree.rename_one('a', 'b/g')

        # And a directory

        tree.rename_one('b/d', 'h')

        old_a = expected['a']

        expected['a'] = (old_a[0], [('r', 'b/g', 0, False, ''), old_a[1][1]])

        expected['b/g'] = (('b', 'g', 'a-id'), [old_a[1][0],

                                                ('r', 'a', 0, False, '')])

        old_d = expected['b/d']

        expected['b/d'] = (old_d[0], [('r', 'h', 0, False, ''), old_d[1][1]])

        expected['h'] = (('', 'h', 'd-id'), [old_d[1][0],

                                             ('r', 'b/d', 0, False, '')])

        old_e = expected['b/d/e']

        expected['b/d/e'] = (old_e[0], [('r', 'h/e', 0, False, ''),

                             old_e[1][1]])

        expected['h/e'] = (('h', 'e', 'e-id'), [old_e[1][0],

                                                ('r', 'b/d/e', 0, False, '')])

        state.unlock()

        try:

            new_state = dirstate.DirState.from_tree(tree, 'dirstate')

            try:

                new_state.save()

            finally:

                new_state.unlock()

        finally:

            state.lock_read()

        return tree, state, expected

class TestTreeToDirState(TestCaseWithDirState):

    def test_empty_to_dirstate(self):

        """We should be able to create a dirstate for an empty tree."""

        # There are no files on disk and no parents

        tree = self.make_branch_and_tree('tree')

        expected_result = ([], [

            (('', '', tree.get_root_id()), # common details

             [('d', '', 0, False, dirstate.DirState.NULLSTAT), # current tree

             ])])

        state = dirstate.DirState.from_tree(tree, 'dirstate')

        state._validate()

        self.check_state_with_reopen(expected_result, state)

    def test_1_parents_empty_to_dirstate(self):

        # create a parent by doing a commit

        tree = self.make_branch_and_tree('tree')

        rev_id = tree.commit('first post').encode('utf8')

        root_stat_pack = dirstate.pack_stat(os.stat(tree.basedir))

        expected_result = ([rev_id], [

            (('', '', tree.get_root_id()), # common details

             [('d', '', 0, False, dirstate.DirState.NULLSTAT), # current tree

              ('d', '', 0, False, rev_id), # first parent details

             ])])

        state = dirstate.DirState.from_tree(tree, 'dirstate')

        self.check_state_with_reopen(expected_result, state)

        state.lock_read()

        try:

            state._validate()

        finally:

            state.unlock()

    def test_2_parents_empty_to_dirstate(self):

        # create a parent by doing a commit

        tree = self.make_branch_and_tree('tree')

        rev_id = tree.commit('first post')

        tree2 = tree.bzrdir.sprout('tree2').open_workingtree()

        rev_id2 = tree2.commit('second post', allow_pointless=True)

        tree.merge_from_branch(tree2.branch)

        expected_result = ([rev_id, rev_id2], [

            (('', '', tree.get_root_id()), # common details

             [('d', '', 0, False, dirstate.DirState.NULLSTAT), # current tree

              ('d', '', 0, False, rev_id), # first parent details

              ('d', '', 0, False, rev_id), # second parent details

             ])])

        state = dirstate.DirState.from_tree(tree, 'dirstate')

        self.check_state_with_reopen(expected_result, state)

        state.lock_read()

        try:

            state._validate()

        finally:

            state.unlock()

    def test_empty_unknowns_are_ignored_to_dirstate(self):

        """We should be able to create a dirstate for an empty tree."""

        # There are no files on disk and no parents

        tree = self.make_branch_and_tree('tree')

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

        expected_result = ([], [

            (('', '', tree.get_root_id()), # common details

             [('d', '', 0, False, dirstate.DirState.NULLSTAT), # current tree

             ])])

        state = dirstate.DirState.from_tree(tree, 'dirstate')

        self.check_state_with_reopen(expected_result, state)

    def get_tree_with_a_file(self):

        tree = self.make_branch_and_tree('tree')

        self.build_tree(['tree/a file'])

        tree.add('a file', 'a-file-id')

        return tree

    def test_non_empty_no_parents_to_dirstate(self):

        """We should be able to create a dirstate for an empty tree."""

        # There are files on disk and no parents

        tree = self.get_tree_with_a_file()

        expected_result = ([], [

            (('', '', tree.get_root_id()), # common details

             [('d', '', 0, False, dirstate.DirState.NULLSTAT), # current tree

             ]),

            (('', 'a file', 'a-file-id'), # common

             [('f', '', 0, False, dirstate.DirState.NULLSTAT), # current

             ]),

            ])

        state = dirstate.DirState.from_tree(tree, 'dirstate')

        self.check_state_with_reopen(expected_result, state)

    def test_1_parents_not_empty_to_dirstate(self):

        # create a parent by doing a commit

        tree = self.get_tree_with_a_file()

        rev_id = tree.commit('first post').encode('utf8')

        # change the current content to be different this will alter stat, sha

        # and length:

        self.build_tree_contents([('tree/a file', 'new content\n')])

        expected_result = ([rev_id], [

            (('', '', tree.get_root_id()), # common details

             [('d', '', 0, False, dirstate.DirState.NULLSTAT), # current tree

              ('d', '', 0, False, rev_id), # first parent details

             ]),

            (('', 'a file', 'a-file-id'), # common

             [('f', '', 0, False, dirstate.DirState.NULLSTAT), # current

              ('f', 'c3ed76e4bfd45ff1763ca206055bca8e9fc28aa8', 24, False,

               rev_id), # first parent

             ]),

            ])

        state = dirstate.DirState.from_tree(tree, 'dirstate')

        self.check_state_with_reopen(expected_result, state)

    def test_2_parents_not_empty_to_dirstate(self):

        # create a parent by doing a commit

        tree = self.get_tree_with_a_file()

        rev_id = tree.commit('first post').encode('utf8')

        tree2 = tree.bzrdir.sprout('tree2').open_workingtree()

        # change the current content to be different this will alter stat, sha

        # and length:

        self.build_tree_contents([('tree2/a file', 'merge content\n')])

        rev_id2 = tree2.commit('second post').encode('utf8')

        tree.merge_from_branch(tree2.branch)

        # change the current content to be different this will alter stat, sha

        # and length again, giving us three distinct values:

        self.build_tree_contents([('tree/a file', 'new content\n')])

        expected_result = ([rev_id, rev_id2], [

            (('', '', tree.get_root_id()), # common details

             [('d', '', 0, False, dirstate.DirState.NULLSTAT), # current tree

              ('d', '', 0, False, rev_id), # first parent details

              ('d', '', 0, False, rev_id), # second parent details

             ]),

            (('', 'a file', 'a-file-id'), # common

             [('f', '', 0, False, dirstate.DirState.NULLSTAT), # current

              ('f', 'c3ed76e4bfd45ff1763ca206055bca8e9fc28aa8', 24, False,

               rev_id), # first parent

              ('f', '314d796174c9412647c3ce07dfb5d36a94e72958', 14, False,

               rev_id2), # second parent

             ]),

            ])

        state = dirstate.DirState.from_tree(tree, 'dirstate')

        self.check_state_with_reopen(expected_result, state)

    def test_colliding_fileids(self):

        # test insertion of parents creating several entries at the same path.

        # we used to have a bug where they could cause the dirstate to break

        # its ordering invariants.

        # create some trees to test from

        parents = []

        for i in range(7):

            tree = self.make_branch_and_tree('tree%d' % i)

            self.build_tree(['tree%d/name' % i,])

            tree.add(['name'], ['file-id%d' % i])

            revision_id = 'revid-%d' % i

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

            parents.append((revision_id,

                tree.branch.repository.revision_tree(revision_id)))

        # now fold these trees into a dirstate

        state = dirstate.DirState.initialize('dirstate')

        try:

            state.set_parent_trees(parents, [])

            state._validate()

        finally:

            state.unlock()

class TestDirStateOnFile(TestCaseWithDirState):

    def test_construct_with_path(self):

        tree = self.make_branch_and_tree('tree')

        state = dirstate.DirState.from_tree(tree, 'dirstate.from_tree')

        # we want to be able to get the lines of the dirstate that we will

        # write to disk.

        lines = state.get_lines()

        state.unlock()

        self.build_tree_contents([('dirstate', ''.join(lines))])

        # get a state object

        # no parents, default tree content

        expected_result = ([], [

            (('', '', tree.get_root_id()), # common details

             # current tree details, but new from_tree skips statting, it

             # uses set_state_from_inventory, and thus depends on the

             # inventory state.

             [('d', '', 0, False, dirstate.DirState.NULLSTAT),

             ])

            ])

        state = dirstate.DirState.on_file('dirstate')

        state.lock_write() # check_state_with_reopen will save() and unlock it

        self.check_state_with_reopen(expected_result, state)

    def test_can_save_clean_on_file(self):

        tree = self.make_branch_and_tree('tree')

        state = dirstate.DirState.from_tree(tree, 'dirstate')

        try:

            # doing a save should work here as there have been no changes.

            state.save()

            # TODO: stat it and check it hasn't changed; may require waiting

            # for the state accuracy window.

        finally:

            state.unlock()

    def test_can_save_in_read_lock(self):

        self.build_tree(['a-file'])

        state = dirstate.DirState.initialize('dirstate')

        try:

            # No stat and no sha1 sum.

            state.add('a-file', 'a-file-id', 'file', None, '')

            state.save()

        finally:

            state.unlock()

        # Now open in readonly mode

        state = dirstate.DirState.on_file('dirstate')

        state.lock_read()

        try:

            entry = state._get_entry(0, path_utf8='a-file')

            # The current size should be 0 (default)

            self.assertEqual(0, entry[1][0][2])

            # We should have a real entry.

            self.assertNotEqual((None, None), entry)

            # Make sure everything is old enough

            state._sha_cutoff_time()

            state._cutoff_time += 10

            # Change the file length

            self.build_tree_contents([('a-file', 'shorter')])

            sha1sum = dirstate.update_entry(state, entry, 'a-file',

                os.lstat('a-file'))

            # new file, no cached sha:

            self.assertEqual(None, sha1sum)

            # The dirblock has been updated

            self.assertEqual(7, entry[1][0][2])

            self.assertEqual(dirstate.DirState.IN_MEMORY_MODIFIED,

                             state._dirblock_state)

            del entry

            # Now, since we are the only one holding a lock, we should be able

            # to save and have it written to disk

            state.save()

        finally:

            state.unlock()

        # Re-open the file, and ensure that the state has been updated.

        state = dirstate.DirState.on_file('dirstate')

        state.lock_read()

        try:

            entry = state._get_entry(0, path_utf8='a-file')