~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test__dirstate_helpers.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 14:01:20 UTC
  • mfrom: (3280.2.5 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080316140120-i3yq8yr1l66m11h7
Start 1.4 development

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2011 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Tests for the compiled dirstate helpers."""
18
18
 
19
19
import bisect
20
20
import os
21
 
import time
22
21
 
23
22
from bzrlib import (
24
23
    dirstate,
25
 
    errors,
26
 
    osutils,
27
24
    tests,
28
25
    )
29
 
from bzrlib.tests import (
30
 
    test_dirstate,
31
 
    )
32
 
from bzrlib.tests.test_osutils import dir_reader_scenarios
33
 
from bzrlib.tests.scenarios import (
34
 
    load_tests_apply_scenarios,
35
 
    multiply_scenarios,
36
 
    )
37
 
from bzrlib.tests import (
38
 
    features,
39
 
    )
40
 
 
41
 
 
42
 
load_tests = load_tests_apply_scenarios
43
 
 
44
 
 
45
 
compiled_dirstate_helpers_feature = features.ModuleAvailableFeature(
46
 
    'bzrlib._dirstate_helpers_pyx')
47
 
 
48
 
 
49
 
# FIXME: we should also parametrize against SHA1Provider !
50
 
 
51
 
ue_scenarios = [('dirstate_Python',
52
 
    {'update_entry': dirstate.py_update_entry})]
53
 
if compiled_dirstate_helpers_feature.available():
54
 
    update_entry = compiled_dirstate_helpers_feature.module.update_entry
55
 
    ue_scenarios.append(('dirstate_Pyrex', {'update_entry': update_entry}))
56
 
 
57
 
pe_scenarios = [('dirstate_Python',
58
 
    {'_process_entry': dirstate.ProcessEntryPython})]
59
 
if compiled_dirstate_helpers_feature.available():
60
 
    process_entry = compiled_dirstate_helpers_feature.module.ProcessEntryC
61
 
    pe_scenarios.append(('dirstate_Pyrex', {'_process_entry': process_entry}))
 
26
from bzrlib.tests import test_dirstate
 
27
 
 
28
 
 
29
class _CompiledDirstateHelpersFeature(tests.Feature):
 
30
    def _probe(self):
 
31
        try:
 
32
            import bzrlib._dirstate_helpers_c
 
33
        except ImportError:
 
34
            return False
 
35
        return True
 
36
 
 
37
    def feature_name(self):
 
38
        return 'bzrlib._dirstate_helpers_c'
 
39
 
 
40
CompiledDirstateHelpersFeature = _CompiledDirstateHelpersFeature()
62
41
 
63
42
 
64
43
class TestBisectPathMixin(object):
217
196
 
218
197
 
219
198
class TestBisectPathLeft(tests.TestCase, TestBisectPathMixin):
220
 
    """Run all Bisect Path tests against _bisect_path_left."""
 
199
    """Run all Bisect Path tests against _bisect_path_left_py."""
221
200
 
222
201
    def get_bisect_path(self):
223
 
        from bzrlib._dirstate_helpers_py import _bisect_path_left
224
 
        return _bisect_path_left
 
202
        from bzrlib._dirstate_helpers_py import _bisect_path_left_py
 
203
        return _bisect_path_left_py
225
204
 
226
205
    def get_bisect(self):
227
206
        return bisect.bisect_left, 0
228
207
 
229
208
 
230
209
class TestCompiledBisectPathLeft(TestBisectPathLeft):
231
 
    """Run all Bisect Path tests against _bisect_path_lect"""
 
210
    """Run all Bisect Path tests against _bisect_path_right_c"""
232
211
 
233
 
    _test_needs_features = [compiled_dirstate_helpers_feature]
 
212
    _test_needs_features = [CompiledDirstateHelpersFeature]
234
213
 
235
214
    def get_bisect_path(self):
236
 
        from bzrlib._dirstate_helpers_pyx import _bisect_path_left
237
 
        return _bisect_path_left
 
215
        from bzrlib._dirstate_helpers_c import _bisect_path_left_c
 
216
        return _bisect_path_left_c
238
217
 
239
218
 
240
219
class TestBisectPathRight(tests.TestCase, TestBisectPathMixin):
241
 
    """Run all Bisect Path tests against _bisect_path_right"""
 
220
    """Run all Bisect Path tests against _bisect_path_right_py"""
242
221
 
243
222
    def get_bisect_path(self):
244
 
        from bzrlib._dirstate_helpers_py import _bisect_path_right
245
 
        return _bisect_path_right
 
223
        from bzrlib._dirstate_helpers_py import _bisect_path_right_py
 
224
        return _bisect_path_right_py
246
225
 
247
226
    def get_bisect(self):
248
227
        return bisect.bisect_right, -1
249
228
 
250
229
 
251
230
class TestCompiledBisectPathRight(TestBisectPathRight):
252
 
    """Run all Bisect Path tests against _bisect_path_right"""
 
231
    """Run all Bisect Path tests against _bisect_path_right_c"""
253
232
 
254
 
    _test_needs_features = [compiled_dirstate_helpers_feature]
 
233
    _test_needs_features = [CompiledDirstateHelpersFeature]
255
234
 
256
235
    def get_bisect_path(self):
257
 
        from bzrlib._dirstate_helpers_pyx import _bisect_path_right
258
 
        return _bisect_path_right
 
236
        from bzrlib._dirstate_helpers_c import _bisect_path_right_c
 
237
        return _bisect_path_right_c
259
238
 
260
239
 
261
240
class TestBisectDirblock(tests.TestCase):
272
251
 
273
252
    def get_bisect_dirblock(self):
274
253
        """Return an implementation of bisect_dirblock"""
275
 
        from bzrlib._dirstate_helpers_py import bisect_dirblock
276
 
        return bisect_dirblock
 
254
        from bzrlib._dirstate_helpers_py import bisect_dirblock_py
 
255
        return bisect_dirblock_py
277
256
 
278
257
    def assertBisect(self, dirblocks, split_dirblocks, path, *args, **kwargs):
279
258
        """Assert that bisect_split works like bisect_left on the split paths.
363
342
    compiled version.
364
343
    """
365
344
 
366
 
    _test_needs_features = [compiled_dirstate_helpers_feature]
 
345
    _test_needs_features = [CompiledDirstateHelpersFeature]
367
346
 
368
347
    def get_bisect_dirblock(self):
369
 
        from bzrlib._dirstate_helpers_pyx import bisect_dirblock
370
 
        return bisect_dirblock
 
348
        from bzrlib._dirstate_helpers_c import bisect_dirblock_c
 
349
        return bisect_dirblock_c
371
350
 
372
351
 
373
352
class TestCmpByDirs(tests.TestCase):
382
361
 
383
362
    def get_cmp_by_dirs(self):
384
363
        """Get a specific implementation of cmp_by_dirs."""
385
 
        from bzrlib._dirstate_helpers_py import cmp_by_dirs
386
 
        return cmp_by_dirs
 
364
        from bzrlib._dirstate_helpers_py import cmp_by_dirs_py
 
365
        return cmp_by_dirs_py
387
366
 
388
367
    def assertCmpByDirs(self, expected, str1, str2):
389
368
        """Compare the two strings, in both directions.
485
464
class TestCompiledCmpByDirs(TestCmpByDirs):
486
465
    """Test the pyrex implementation of cmp_by_dirs"""
487
466
 
488
 
    _test_needs_features = [compiled_dirstate_helpers_feature]
 
467
    _test_needs_features = [CompiledDirstateHelpersFeature]
489
468
 
490
469
    def get_cmp_by_dirs(self):
491
 
        from bzrlib._dirstate_helpers_pyx import cmp_by_dirs
492
 
        return cmp_by_dirs
 
470
        from bzrlib._dirstate_helpers_c import cmp_by_dirs_c
 
471
        return cmp_by_dirs_c
493
472
 
494
473
 
495
474
class TestCmpPathByDirblock(tests.TestCase):
504
483
 
505
484
    def get_cmp_path_by_dirblock(self):
506
485
        """Get a specific implementation of _cmp_path_by_dirblock."""
507
 
        from bzrlib._dirstate_helpers_py import _cmp_path_by_dirblock
508
 
        return _cmp_path_by_dirblock
 
486
        from bzrlib._dirstate_helpers_py import _cmp_path_by_dirblock_py
 
487
        return _cmp_path_by_dirblock_py
509
488
 
510
489
    def assertCmpPathByDirblock(self, paths):
511
490
        """Compare all paths and make sure they evaluate to the correct order.
636
615
class TestCompiledCmpPathByDirblock(TestCmpPathByDirblock):
637
616
    """Test the pyrex implementation of _cmp_path_by_dirblock"""
638
617
 
639
 
    _test_needs_features = [compiled_dirstate_helpers_feature]
 
618
    _test_needs_features = [CompiledDirstateHelpersFeature]
640
619
 
641
620
    def get_cmp_by_dirs(self):
642
 
        from bzrlib._dirstate_helpers_pyx import _cmp_path_by_dirblock
643
 
        return _cmp_path_by_dirblock
 
621
        from bzrlib._dirstate_helpers_c import _cmp_path_by_dirblock_c
 
622
        return _cmp_path_by_dirblock_c
644
623
 
645
624
 
646
625
class TestMemRChr(tests.TestCase):
647
626
    """Test memrchr functionality"""
648
627
 
649
 
    _test_needs_features = [compiled_dirstate_helpers_feature]
 
628
    _test_needs_features = [CompiledDirstateHelpersFeature]
650
629
 
651
630
    def assertMemRChr(self, expected, s, c):
652
 
        from bzrlib._dirstate_helpers_pyx import _py_memrchr
 
631
        from bzrlib._dirstate_helpers_c import _py_memrchr
653
632
        self.assertEqual(expected, _py_memrchr(s, c))
654
633
 
655
634
    def test_missing(self):
696
675
    implementation.
697
676
    """
698
677
 
699
 
    # inherits scenarios from test_dirstate
700
 
 
701
678
    def get_read_dirblocks(self):
702
 
        from bzrlib._dirstate_helpers_py import _read_dirblocks
703
 
        return _read_dirblocks
 
679
        from bzrlib._dirstate_helpers_py import _read_dirblocks_py
 
680
        return _read_dirblocks_py
704
681
 
705
682
    def test_smoketest(self):
706
683
        """Make sure that we can create and read back a simple file."""
714
691
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
715
692
                         state._dirblock_state)
716
693
 
717
 
    def test_trailing_garbage(self):
718
 
        tree, state, expected = self.create_basic_dirstate()
719
 
        # On Unix, we can write extra data as long as we haven't read yet, but
720
 
        # on Win32, if you've opened the file with FILE_SHARE_READ, trying to
721
 
        # open it in append mode will fail.
722
 
        state.unlock()
723
 
        f = open('dirstate', 'ab')
724
 
        try:
725
 
            # Add bogus trailing garbage
726
 
            f.write('bogus\n')
727
 
        finally:
728
 
            f.close()
729
 
            state.lock_read()
730
 
        e = self.assertRaises(errors.DirstateCorrupt,
731
 
                              state._read_dirblocks_if_needed)
732
 
        # Make sure we mention the bogus characters in the error
733
 
        self.assertContainsRe(str(e), 'bogus')
734
 
 
735
694
 
736
695
class TestCompiledReadDirblocks(TestReadDirblocks):
737
696
    """Test the pyrex implementation of _read_dirblocks"""
738
697
 
739
 
    _test_needs_features = [compiled_dirstate_helpers_feature]
 
698
    _test_needs_features = [CompiledDirstateHelpersFeature]
740
699
 
741
700
    def get_read_dirblocks(self):
742
 
        from bzrlib._dirstate_helpers_pyx import _read_dirblocks
743
 
        return _read_dirblocks
 
701
        from bzrlib._dirstate_helpers_c import _read_dirblocks_c
 
702
        return _read_dirblocks_c
744
703
 
745
704
 
746
705
class TestUsingCompiledIfAvailable(tests.TestCase):
747
706
    """Check that any compiled functions that are available are the default.
748
707
 
749
708
    It is possible to have typos, etc in the import line, such that
750
 
    _dirstate_helpers_pyx is actually available, but the compiled functions are
 
709
    _dirstate_helpers_c is actually available, but the compiled functions are
751
710
    not being used.
752
711
    """
753
712
 
754
713
    def test_bisect_dirblock(self):
755
 
        if compiled_dirstate_helpers_feature.available():
756
 
            from bzrlib._dirstate_helpers_pyx import bisect_dirblock
 
714
        if CompiledDirstateHelpersFeature.available():
 
715
            from bzrlib._dirstate_helpers_c import bisect_dirblock_c
 
716
            self.assertIs(bisect_dirblock_c, dirstate.bisect_dirblock)
757
717
        else:
758
 
            from bzrlib._dirstate_helpers_py import bisect_dirblock
759
 
        self.assertIs(bisect_dirblock, dirstate.bisect_dirblock)
 
718
            from bzrlib._dirstate_helpers_py import bisect_dirblock_py
 
719
            self.assertIs(bisect_dirblock_py, dirstate.bisect_dirblock)
760
720
 
761
721
    def test__bisect_path_left(self):
762
 
        if compiled_dirstate_helpers_feature.available():
763
 
            from bzrlib._dirstate_helpers_pyx import _bisect_path_left
 
722
        if CompiledDirstateHelpersFeature.available():
 
723
            from bzrlib._dirstate_helpers_c import _bisect_path_left_c
 
724
            self.assertIs(_bisect_path_left_c, dirstate._bisect_path_left)
764
725
        else:
765
 
            from bzrlib._dirstate_helpers_py import _bisect_path_left
766
 
        self.assertIs(_bisect_path_left, dirstate._bisect_path_left)
 
726
            from bzrlib._dirstate_helpers_py import _bisect_path_left_py
 
727
            self.assertIs(_bisect_path_left_py, dirstate._bisect_path_left)
767
728
 
768
729
    def test__bisect_path_right(self):
769
 
        if compiled_dirstate_helpers_feature.available():
770
 
            from bzrlib._dirstate_helpers_pyx import _bisect_path_right
 
730
        if CompiledDirstateHelpersFeature.available():
 
731
            from bzrlib._dirstate_helpers_c import _bisect_path_right_c
 
732
            self.assertIs(_bisect_path_right_c, dirstate._bisect_path_right)
771
733
        else:
772
 
            from bzrlib._dirstate_helpers_py import _bisect_path_right
773
 
        self.assertIs(_bisect_path_right, dirstate._bisect_path_right)
 
734
            from bzrlib._dirstate_helpers_py import _bisect_path_right_py
 
735
            self.assertIs(_bisect_path_right_py, dirstate._bisect_path_right)
774
736
 
775
737
    def test_cmp_by_dirs(self):
776
 
        if compiled_dirstate_helpers_feature.available():
777
 
            from bzrlib._dirstate_helpers_pyx import cmp_by_dirs
 
738
        if CompiledDirstateHelpersFeature.available():
 
739
            from bzrlib._dirstate_helpers_c import cmp_by_dirs_c
 
740
            self.assertIs(cmp_by_dirs_c, dirstate.cmp_by_dirs)
778
741
        else:
779
 
            from bzrlib._dirstate_helpers_py import cmp_by_dirs
780
 
        self.assertIs(cmp_by_dirs, dirstate.cmp_by_dirs)
 
742
            from bzrlib._dirstate_helpers_py import cmp_by_dirs_py
 
743
            self.assertIs(cmp_by_dirs_py, dirstate.cmp_by_dirs)
781
744
 
782
745
    def test__read_dirblocks(self):
783
 
        if compiled_dirstate_helpers_feature.available():
784
 
            from bzrlib._dirstate_helpers_pyx import _read_dirblocks
785
 
        else:
786
 
            from bzrlib._dirstate_helpers_py import _read_dirblocks
787
 
        self.assertIs(_read_dirblocks, dirstate._read_dirblocks)
788
 
 
789
 
    def test_update_entry(self):
790
 
        if compiled_dirstate_helpers_feature.available():
791
 
            from bzrlib._dirstate_helpers_pyx import update_entry
792
 
        else:
793
 
            from bzrlib.dirstate import update_entry
794
 
        self.assertIs(update_entry, dirstate.update_entry)
795
 
 
796
 
    def test_process_entry(self):
797
 
        if compiled_dirstate_helpers_feature.available():
798
 
            from bzrlib._dirstate_helpers_pyx import ProcessEntryC
799
 
            self.assertIs(ProcessEntryC, dirstate._process_entry)
800
 
        else:
801
 
            from bzrlib.dirstate import ProcessEntryPython
802
 
            self.assertIs(ProcessEntryPython, dirstate._process_entry)
803
 
 
804
 
 
805
 
class TestUpdateEntry(test_dirstate.TestCaseWithDirState):
806
 
    """Test the DirState.update_entry functions"""
807
 
 
808
 
    scenarios = multiply_scenarios(
809
 
        dir_reader_scenarios(), ue_scenarios)
810
 
 
811
 
    # Set by load_tests
812
 
    update_entry = None
813
 
 
814
 
    def setUp(self):
815
 
        super(TestUpdateEntry, self).setUp()
816
 
        self.overrideAttr(dirstate, 'update_entry', self.update_entry)
817
 
 
818
 
    def get_state_with_a(self):
819
 
        """Create a DirState tracking a single object named 'a'"""
820
 
        state = test_dirstate.InstrumentedDirState.initialize('dirstate')
821
 
        self.addCleanup(state.unlock)
822
 
        state.add('a', 'a-id', 'file', None, '')
823
 
        entry = state._get_entry(0, path_utf8='a')
824
 
        return state, entry
825
 
 
826
 
    def test_observed_sha1_cachable(self):
827
 
        state, entry = self.get_state_with_a()
828
 
        state.save()
829
 
        atime = time.time() - 10
830
 
        self.build_tree(['a'])
831
 
        statvalue = test_dirstate._FakeStat.from_stat(os.lstat('a'))
832
 
        statvalue.st_mtime = statvalue.st_ctime = atime
833
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
834
 
                         state._dirblock_state)
835
 
        state._observed_sha1(entry, "foo", statvalue)
836
 
        self.assertEqual('foo', entry[1][0][1])
837
 
        packed_stat = dirstate.pack_stat(statvalue)
838
 
        self.assertEqual(packed_stat, entry[1][0][4])
839
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_HASH_MODIFIED,
840
 
                         state._dirblock_state)
841
 
 
842
 
    def test_observed_sha1_not_cachable(self):
843
 
        state, entry = self.get_state_with_a()
844
 
        state.save()
845
 
        oldval = entry[1][0][1]
846
 
        oldstat = entry[1][0][4]
847
 
        self.build_tree(['a'])
848
 
        statvalue = os.lstat('a')
849
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
850
 
                         state._dirblock_state)
851
 
        state._observed_sha1(entry, "foo", statvalue)
852
 
        self.assertEqual(oldval, entry[1][0][1])
853
 
        self.assertEqual(oldstat, entry[1][0][4])
854
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
855
 
                         state._dirblock_state)
856
 
 
857
 
    def test_update_entry(self):
858
 
        state, _ = self.get_state_with_a()
859
 
        tree = self.make_branch_and_tree('tree')
860
 
        tree.lock_write()
861
 
        empty_revid = tree.commit('empty')
862
 
        self.build_tree(['tree/a'])
863
 
        tree.add(['a'], ['a-id'])
864
 
        with_a_id = tree.commit('with_a')
865
 
        self.addCleanup(tree.unlock)
866
 
        state.set_parent_trees(
867
 
            [(empty_revid, tree.branch.repository.revision_tree(empty_revid))],
868
 
            [])
869
 
        entry = state._get_entry(0, path_utf8='a')
870
 
        self.build_tree(['a'])
871
 
        # Add one where we don't provide the stat or sha already
872
 
        self.assertEqual(('', 'a', 'a-id'), entry[0])
873
 
        self.assertEqual(('f', '', 0, False, dirstate.DirState.NULLSTAT),
874
 
                         entry[1][0])
875
 
        # Flush the buffers to disk
876
 
        state.save()
877
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
878
 
                         state._dirblock_state)
879
 
 
880
 
        stat_value = os.lstat('a')
881
 
        packed_stat = dirstate.pack_stat(stat_value)
882
 
        link_or_sha1 = self.update_entry(state, entry, abspath='a',
883
 
                                          stat_value=stat_value)
884
 
        self.assertEqual(None, link_or_sha1)
885
 
 
886
 
        # The dirblock entry should not have computed or cached the file's
887
 
        # sha1, but it did update the files' st_size. However, this is not
888
 
        # worth writing a dirstate file for, so we leave the state UNMODIFIED
889
 
        self.assertEqual(('f', '', 14, False, dirstate.DirState.NULLSTAT),
890
 
                         entry[1][0])
891
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
892
 
                         state._dirblock_state)
893
 
        mode = stat_value.st_mode
894
 
        self.assertEqual([('is_exec', mode, False)], state._log)
895
 
 
896
 
        state.save()
897
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
898
 
                         state._dirblock_state)
899
 
 
900
 
        # Roll the clock back so the file is guaranteed to look too new. We
901
 
        # should still not compute the sha1.
902
 
        state.adjust_time(-10)
903
 
        del state._log[:]
904
 
 
905
 
        link_or_sha1 = self.update_entry(state, entry, abspath='a',
906
 
                                          stat_value=stat_value)
907
 
        self.assertEqual([('is_exec', mode, False)], state._log)
908
 
        self.assertEqual(None, link_or_sha1)
909
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
910
 
                         state._dirblock_state)
911
 
        self.assertEqual(('f', '', 14, False, dirstate.DirState.NULLSTAT),
912
 
                         entry[1][0])
913
 
        state.save()
914
 
 
915
 
        # If it is cachable (the clock has moved forward) but new it still
916
 
        # won't calculate the sha or cache it.
917
 
        state.adjust_time(+20)
918
 
        del state._log[:]
919
 
        link_or_sha1 = dirstate.update_entry(state, entry, abspath='a',
920
 
                                          stat_value=stat_value)
921
 
        self.assertEqual(None, link_or_sha1)
922
 
        self.assertEqual([('is_exec', mode, False)], state._log)
923
 
        self.assertEqual(('f', '', 14, False, dirstate.DirState.NULLSTAT),
924
 
                         entry[1][0])
925
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
926
 
                         state._dirblock_state)
927
 
 
928
 
        # If the file is no longer new, and the clock has been moved forward
929
 
        # sufficiently, it will cache the sha.
930
 
        del state._log[:]
931
 
        state.set_parent_trees(
932
 
            [(with_a_id, tree.branch.repository.revision_tree(with_a_id))],
933
 
            [])
934
 
        entry = state._get_entry(0, path_utf8='a')
935
 
 
936
 
        link_or_sha1 = self.update_entry(state, entry, abspath='a',
937
 
                                          stat_value=stat_value)
938
 
        self.assertEqual('b50e5406bb5e153ebbeb20268fcf37c87e1ecfb6',
939
 
                         link_or_sha1)
940
 
        self.assertEqual([('is_exec', mode, False), ('sha1', 'a')],
941
 
                          state._log)
942
 
        self.assertEqual(('f', link_or_sha1, 14, False, packed_stat),
943
 
                         entry[1][0])
944
 
 
945
 
        # Subsequent calls will just return the cached value
946
 
        del state._log[:]
947
 
        link_or_sha1 = self.update_entry(state, entry, abspath='a',
948
 
                                          stat_value=stat_value)
949
 
        self.assertEqual('b50e5406bb5e153ebbeb20268fcf37c87e1ecfb6',
950
 
                         link_or_sha1)
951
 
        self.assertEqual([], state._log)
952
 
        self.assertEqual(('f', link_or_sha1, 14, False, packed_stat),
953
 
                         entry[1][0])
954
 
 
955
 
    def test_update_entry_symlink(self):
956
 
        """Update entry should read symlinks."""
957
 
        self.requireFeature(features.SymlinkFeature)
958
 
        state, entry = self.get_state_with_a()
959
 
        state.save()
960
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
961
 
                         state._dirblock_state)
962
 
        os.symlink('target', 'a')
963
 
 
964
 
        state.adjust_time(-10) # Make the symlink look new
965
 
        stat_value = os.lstat('a')
966
 
        packed_stat = dirstate.pack_stat(stat_value)
967
 
        link_or_sha1 = self.update_entry(state, entry, abspath='a',
968
 
                                          stat_value=stat_value)
969
 
        self.assertEqual('target', link_or_sha1)
970
 
        self.assertEqual([('read_link', 'a', '')], state._log)
971
 
        # Dirblock is not updated (the link is too new)
972
 
        self.assertEqual([('l', '', 6, False, dirstate.DirState.NULLSTAT)],
973
 
                         entry[1])
974
 
        # The file entry turned into a symlink, that is considered
975
 
        # HASH modified worthy.
976
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_HASH_MODIFIED,
977
 
                         state._dirblock_state)
978
 
 
979
 
        # Because the stat_value looks new, we should re-read the target
980
 
        del state._log[:]
981
 
        link_or_sha1 = self.update_entry(state, entry, abspath='a',
982
 
                                          stat_value=stat_value)
983
 
        self.assertEqual('target', link_or_sha1)
984
 
        self.assertEqual([('read_link', 'a', '')], state._log)
985
 
        self.assertEqual([('l', '', 6, False, dirstate.DirState.NULLSTAT)],
986
 
                         entry[1])
987
 
        state.save()
988
 
        state.adjust_time(+20) # Skip into the future, all files look old
989
 
        del state._log[:]
990
 
        link_or_sha1 = self.update_entry(state, entry, abspath='a',
991
 
                                          stat_value=stat_value)
992
 
        # The symlink stayed a symlink. So while it is new enough to cache, we
993
 
        # don't bother setting the flag, because it is not really worth saving
994
 
        # (when we stat the symlink, we'll have paged in the target.)
995
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
996
 
                         state._dirblock_state)
997
 
        self.assertEqual('target', link_or_sha1)
998
 
        # We need to re-read the link because only now can we cache it
999
 
        self.assertEqual([('read_link', 'a', '')], state._log)
1000
 
        self.assertEqual([('l', 'target', 6, False, packed_stat)],
1001
 
                         entry[1])
1002
 
 
1003
 
        del state._log[:]
1004
 
        # Another call won't re-read the link
1005
 
        self.assertEqual([], state._log)
1006
 
        link_or_sha1 = self.update_entry(state, entry, abspath='a',
1007
 
                                          stat_value=stat_value)
1008
 
        self.assertEqual('target', link_or_sha1)
1009
 
        self.assertEqual([('l', 'target', 6, False, packed_stat)],
1010
 
                         entry[1])
1011
 
 
1012
 
    def do_update_entry(self, state, entry, abspath):
1013
 
        stat_value = os.lstat(abspath)
1014
 
        return self.update_entry(state, entry, abspath, stat_value)
1015
 
 
1016
 
    def test_update_entry_dir(self):
1017
 
        state, entry = self.get_state_with_a()
1018
 
        self.build_tree(['a/'])
1019
 
        self.assertIs(None, self.do_update_entry(state, entry, 'a'))
1020
 
 
1021
 
    def test_update_entry_dir_unchanged(self):
1022
 
        state, entry = self.get_state_with_a()
1023
 
        self.build_tree(['a/'])
1024
 
        state.adjust_time(+20)
1025
 
        self.assertIs(None, self.do_update_entry(state, entry, 'a'))
1026
 
        # a/ used to be a file, but is now a directory, worth saving
1027
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_MODIFIED,
1028
 
                         state._dirblock_state)
1029
 
        state.save()
1030
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
1031
 
                         state._dirblock_state)
1032
 
        # No changes to a/ means not worth saving.
1033
 
        self.assertIs(None, self.do_update_entry(state, entry, 'a'))
1034
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
1035
 
                         state._dirblock_state)
1036
 
        # Change the last-modified time for the directory
1037
 
        t = time.time() - 100.0
1038
 
        try:
1039
 
            os.utime('a', (t, t))
1040
 
        except OSError:
1041
 
            # It looks like Win32 + FAT doesn't allow to change times on a dir.
1042
 
            raise tests.TestSkipped("can't update mtime of a dir on FAT")
1043
 
        saved_packed_stat = entry[1][0][-1]
1044
 
        self.assertIs(None, self.do_update_entry(state, entry, 'a'))
1045
 
        # We *do* go ahead and update the information in the dirblocks, but we
1046
 
        # don't bother setting IN_MEMORY_MODIFIED because it is trivial to
1047
 
        # recompute.
1048
 
        self.assertNotEqual(saved_packed_stat, entry[1][0][-1])
1049
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
1050
 
                         state._dirblock_state)
1051
 
 
1052
 
    def test_update_entry_file_unchanged(self):
1053
 
        state, _ = self.get_state_with_a()
1054
 
        tree = self.make_branch_and_tree('tree')
1055
 
        tree.lock_write()
1056
 
        self.build_tree(['tree/a'])
1057
 
        tree.add(['a'], ['a-id'])
1058
 
        with_a_id = tree.commit('witha')
1059
 
        self.addCleanup(tree.unlock)
1060
 
        state.set_parent_trees(
1061
 
            [(with_a_id, tree.branch.repository.revision_tree(with_a_id))],
1062
 
            [])
1063
 
        entry = state._get_entry(0, path_utf8='a')
1064
 
        self.build_tree(['a'])
1065
 
        sha1sum = 'b50e5406bb5e153ebbeb20268fcf37c87e1ecfb6'
1066
 
        state.adjust_time(+20)
1067
 
        self.assertEqual(sha1sum, self.do_update_entry(state, entry, 'a'))
1068
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_MODIFIED,
1069
 
                         state._dirblock_state)
1070
 
        state.save()
1071
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
1072
 
                         state._dirblock_state)
1073
 
        self.assertEqual(sha1sum, self.do_update_entry(state, entry, 'a'))
1074
 
        self.assertEqual(dirstate.DirState.IN_MEMORY_UNMODIFIED,
1075
 
                         state._dirblock_state)
1076
 
 
1077
 
    def test_update_entry_tree_reference(self):
1078
 
        state = test_dirstate.InstrumentedDirState.initialize('dirstate')
1079
 
        self.addCleanup(state.unlock)
1080
 
        state.add('r', 'r-id', 'tree-reference', None, '')
1081
 
        self.build_tree(['r/'])
1082
 
        entry = state._get_entry(0, path_utf8='r')
1083
 
        self.do_update_entry(state, entry, 'r')
1084
 
        entry = state._get_entry(0, path_utf8='r')
1085
 
        self.assertEqual('t', entry[1][0][0])
1086
 
 
1087
 
    def create_and_test_file(self, state, entry):
1088
 
        """Create a file at 'a' and verify the state finds it during update.
1089
 
 
1090
 
        The state should already be versioning *something* at 'a'. This makes
1091
 
        sure that state.update_entry recognizes it as a file.
1092
 
        """
1093
 
        self.build_tree(['a'])
1094
 
        stat_value = os.lstat('a')
1095
 
        packed_stat = dirstate.pack_stat(stat_value)
1096
 
 
1097
 
        link_or_sha1 = self.do_update_entry(state, entry, abspath='a')
1098
 
        self.assertEqual(None, link_or_sha1)
1099
 
        self.assertEqual([('f', '', 14, False, dirstate.DirState.NULLSTAT)],
1100
 
                         entry[1])
1101
 
        return packed_stat
1102
 
 
1103
 
    def create_and_test_dir(self, state, entry):
1104
 
        """Create a directory at 'a' and verify the state finds it.
1105
 
 
1106
 
        The state should already be versioning *something* at 'a'. This makes
1107
 
        sure that state.update_entry recognizes it as a directory.
1108
 
        """
1109
 
        self.build_tree(['a/'])
1110
 
        stat_value = os.lstat('a')
1111
 
        packed_stat = dirstate.pack_stat(stat_value)
1112
 
 
1113
 
        link_or_sha1 = self.do_update_entry(state, entry, abspath='a')
1114
 
        self.assertIs(None, link_or_sha1)
1115
 
        self.assertEqual([('d', '', 0, False, packed_stat)], entry[1])
1116
 
 
1117
 
        return packed_stat
1118
 
 
1119
 
    # FIXME: Add unicode version
1120
 
    def create_and_test_symlink(self, state, entry):
1121
 
        """Create a symlink at 'a' and verify the state finds it.
1122
 
 
1123
 
        The state should already be versioning *something* at 'a'. This makes
1124
 
        sure that state.update_entry recognizes it as a symlink.
1125
 
 
1126
 
        This should not be called if this platform does not have symlink
1127
 
        support.
1128
 
        """
1129
 
        # caller should care about skipping test on platforms without symlinks
1130
 
        os.symlink('path/to/foo', 'a')
1131
 
 
1132
 
        stat_value = os.lstat('a')
1133
 
        packed_stat = dirstate.pack_stat(stat_value)
1134
 
 
1135
 
        link_or_sha1 = self.do_update_entry(state, entry, abspath='a')
1136
 
        self.assertEqual('path/to/foo', link_or_sha1)
1137
 
        self.assertEqual([('l', 'path/to/foo', 11, False, packed_stat)],
1138
 
                         entry[1])
1139
 
        return packed_stat
1140
 
 
1141
 
    def test_update_file_to_dir(self):
1142
 
        """If a file changes to a directory we return None for the sha.
1143
 
        We also update the inventory record.
1144
 
        """
1145
 
        state, entry = self.get_state_with_a()
1146
 
        # The file sha1 won't be cached unless the file is old
1147
 
        state.adjust_time(+10)
1148
 
        self.create_and_test_file(state, entry)
1149
 
        os.remove('a')
1150
 
        self.create_and_test_dir(state, entry)
1151
 
 
1152
 
    def test_update_file_to_symlink(self):
1153
 
        """File becomes a symlink"""
1154
 
        self.requireFeature(features.SymlinkFeature)
1155
 
        state, entry = self.get_state_with_a()
1156
 
        # The file sha1 won't be cached unless the file is old
1157
 
        state.adjust_time(+10)
1158
 
        self.create_and_test_file(state, entry)
1159
 
        os.remove('a')
1160
 
        self.create_and_test_symlink(state, entry)
1161
 
 
1162
 
    def test_update_dir_to_file(self):
1163
 
        """Directory becoming a file updates the entry."""
1164
 
        state, entry = self.get_state_with_a()
1165
 
        # The file sha1 won't be cached unless the file is old
1166
 
        state.adjust_time(+10)
1167
 
        self.create_and_test_dir(state, entry)
1168
 
        os.rmdir('a')
1169
 
        self.create_and_test_file(state, entry)
1170
 
 
1171
 
    def test_update_dir_to_symlink(self):
1172
 
        """Directory becomes a symlink"""
1173
 
        self.requireFeature(features.SymlinkFeature)
1174
 
        state, entry = self.get_state_with_a()
1175
 
        # The symlink target won't be cached if it isn't old
1176
 
        state.adjust_time(+10)
1177
 
        self.create_and_test_dir(state, entry)
1178
 
        os.rmdir('a')
1179
 
        self.create_and_test_symlink(state, entry)
1180
 
 
1181
 
    def test_update_symlink_to_file(self):
1182
 
        """Symlink becomes a file"""
1183
 
        self.requireFeature(features.SymlinkFeature)
1184
 
        state, entry = self.get_state_with_a()
1185
 
        # The symlink and file info won't be cached unless old
1186
 
        state.adjust_time(+10)
1187
 
        self.create_and_test_symlink(state, entry)
1188
 
        os.remove('a')
1189
 
        self.create_and_test_file(state, entry)
1190
 
 
1191
 
    def test_update_symlink_to_dir(self):
1192
 
        """Symlink becomes a directory"""
1193
 
        self.requireFeature(features.SymlinkFeature)
1194
 
        state, entry = self.get_state_with_a()
1195
 
        # The symlink target won't be cached if it isn't old
1196
 
        state.adjust_time(+10)
1197
 
        self.create_and_test_symlink(state, entry)
1198
 
        os.remove('a')
1199
 
        self.create_and_test_dir(state, entry)
1200
 
 
1201
 
    def test__is_executable_win32(self):
1202
 
        state, entry = self.get_state_with_a()
1203
 
        self.build_tree(['a'])
1204
 
 
1205
 
        # Make sure we are using the win32 implementation of _is_executable
1206
 
        state._is_executable = state._is_executable_win32
1207
 
 
1208
 
        # The file on disk is not executable, but we are marking it as though
1209
 
        # it is. With _is_executable_win32 we ignore what is on disk.
1210
 
        entry[1][0] = ('f', '', 0, True, dirstate.DirState.NULLSTAT)
1211
 
 
1212
 
        stat_value = os.lstat('a')
1213
 
        packed_stat = dirstate.pack_stat(stat_value)
1214
 
 
1215
 
        state.adjust_time(-10) # Make sure everything is new
1216
 
        self.update_entry(state, entry, abspath='a', stat_value=stat_value)
1217
 
 
1218
 
        # The row is updated, but the executable bit stays set.
1219
 
        self.assertEqual([('f', '', 14, True, dirstate.DirState.NULLSTAT)],
1220
 
                         entry[1])
1221
 
 
1222
 
        # Make the disk object look old enough to cache (but it won't cache the
1223
 
        # sha as it is a new file).
1224
 
        state.adjust_time(+20)
1225
 
        digest = 'b50e5406bb5e153ebbeb20268fcf37c87e1ecfb6'
1226
 
        self.update_entry(state, entry, abspath='a', stat_value=stat_value)
1227
 
        self.assertEqual([('f', '', 14, True, dirstate.DirState.NULLSTAT)],
1228
 
            entry[1])
1229
 
 
1230
 
    def _prepare_tree(self):
1231
 
        # Create a tree
1232
 
        text = 'Hello World\n'
1233
 
        tree = self.make_branch_and_tree('tree')
1234
 
        self.build_tree_contents([('tree/a file', text)])
1235
 
        tree.add('a file', 'a-file-id')
1236
 
        # Note: dirstate does not sha prior to the first commit
1237
 
        # so commit now in order for the test to work
1238
 
        tree.commit('first')
1239
 
        return tree, text
1240
 
 
1241
 
    def test_sha1provider_sha1_used(self):
1242
 
        tree, text = self._prepare_tree()
1243
 
        state = dirstate.DirState.from_tree(tree, 'dirstate',
1244
 
            UppercaseSHA1Provider())
1245
 
        self.addCleanup(state.unlock)
1246
 
        expected_sha = osutils.sha_string(text.upper() + "foo")
1247
 
        entry = state._get_entry(0, path_utf8='a file')
1248
 
        state._sha_cutoff_time()
1249
 
        state._cutoff_time += 10
1250
 
        sha1 = self.update_entry(state, entry, 'tree/a file',
1251
 
                                 os.lstat('tree/a file'))
1252
 
        self.assertEqual(expected_sha, sha1)
1253
 
 
1254
 
    def test_sha1provider_stat_and_sha1_used(self):
1255
 
        tree, text = self._prepare_tree()
1256
 
        tree.lock_write()
1257
 
        self.addCleanup(tree.unlock)
1258
 
        state = tree._current_dirstate()
1259
 
        state._sha1_provider = UppercaseSHA1Provider()
1260
 
        # If we used the standard provider, it would look like nothing has
1261
 
        # changed
1262
 
        file_ids_changed = [change[0] for change
1263
 
                            in tree.iter_changes(tree.basis_tree())]
1264
 
        self.assertEqual(['a-file-id'], file_ids_changed)
1265
 
 
1266
 
 
1267
 
class UppercaseSHA1Provider(dirstate.SHA1Provider):
1268
 
    """A custom SHA1Provider."""
1269
 
 
1270
 
    def sha1(self, abspath):
1271
 
        return self.stat_and_sha1(abspath)[1]
1272
 
 
1273
 
    def stat_and_sha1(self, abspath):
1274
 
        file_obj = file(abspath, 'rb')
1275
 
        try:
1276
 
            statvalue = os.fstat(file_obj.fileno())
1277
 
            text = ''.join(file_obj.readlines())
1278
 
            sha1 = osutils.sha_string(text.upper() + "foo")
1279
 
        finally:
1280
 
            file_obj.close()
1281
 
        return statvalue, sha1
1282
 
 
1283
 
 
1284
 
class TestProcessEntry(test_dirstate.TestCaseWithDirState):
1285
 
 
1286
 
    scenarios = multiply_scenarios(dir_reader_scenarios(), pe_scenarios)
1287
 
 
1288
 
    # Set by load_tests
1289
 
    _process_entry = None
1290
 
 
1291
 
    def setUp(self):
1292
 
        super(TestProcessEntry, self).setUp()
1293
 
        self.overrideAttr(dirstate, '_process_entry', self._process_entry)
1294
 
 
1295
 
    def assertChangedFileIds(self, expected, tree):
1296
 
        tree.lock_read()
1297
 
        try:
1298
 
            file_ids = [info[0] for info
1299
 
                        in tree.iter_changes(tree.basis_tree())]
1300
 
        finally:
1301
 
            tree.unlock()
1302
 
        self.assertEqual(sorted(expected), sorted(file_ids))
1303
 
 
1304
 
    def test_exceptions_raised(self):
1305
 
        # This is a direct test of bug #495023, it relies on osutils.is_inside
1306
 
        # getting called in an inner function. Which makes it a bit brittle,
1307
 
        # but at least it does reproduce the bug.
1308
 
        tree = self.make_branch_and_tree('tree')
1309
 
        self.build_tree(['tree/file', 'tree/dir/', 'tree/dir/sub',
1310
 
                         'tree/dir2/', 'tree/dir2/sub2'])
1311
 
        tree.add(['file', 'dir', 'dir/sub', 'dir2', 'dir2/sub2'])
1312
 
        tree.commit('first commit')
1313
 
        tree.lock_read()
1314
 
        self.addCleanup(tree.unlock)
1315
 
        basis_tree = tree.basis_tree()
1316
 
        def is_inside_raises(*args, **kwargs):
1317
 
            raise RuntimeError('stop this')
1318
 
        self.overrideAttr(osutils, 'is_inside', is_inside_raises)
1319
 
        self.assertListRaises(RuntimeError, tree.iter_changes, basis_tree)
1320
 
 
1321
 
    def test_simple_changes(self):
1322
 
        tree = self.make_branch_and_tree('tree')
1323
 
        self.build_tree(['tree/file'])
1324
 
        tree.add(['file'], ['file-id'])
1325
 
        self.assertChangedFileIds([tree.get_root_id(), 'file-id'], tree)
1326
 
        tree.commit('one')
1327
 
        self.assertChangedFileIds([], tree)
1328
 
 
1329
 
    def test_sha1provider_stat_and_sha1_used(self):
1330
 
        tree = self.make_branch_and_tree('tree')
1331
 
        self.build_tree(['tree/file'])
1332
 
        tree.add(['file'], ['file-id'])
1333
 
        tree.commit('one')
1334
 
        tree.lock_write()
1335
 
        self.addCleanup(tree.unlock)
1336
 
        state = tree._current_dirstate()
1337
 
        state._sha1_provider = UppercaseSHA1Provider()
1338
 
        self.assertChangedFileIds(['file-id'], tree)
 
746
        if CompiledDirstateHelpersFeature.available():
 
747
            from bzrlib._dirstate_helpers_c import _read_dirblocks_c
 
748
            self.assertIs(_read_dirblocks_c, dirstate._read_dirblocks)
 
749
        else:
 
750
            from bzrlib._dirstate_helpers_py import _read_dirblocks_py
 
751
            self.assertIs(_read_dirblocks_py, dirstate._read_dirblocks)
1339
752