~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_graph.py

  • Committer: Jelmer Vernooij
  • Date: 2010-12-20 11:57:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5577.
  • Revision ID: jelmer@samba.org-20101220115714-2ru3hfappjweeg7q
Don't use no-plugins.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
from bzrlib import (
18
18
    errors,
19
19
    graph as _mod_graph,
 
20
    symbol_versioning,
 
21
    tests,
20
22
    )
21
23
from bzrlib.revision import NULL_REVISION
22
24
from bzrlib.tests import TestCaseWithMemoryTransport
 
25
from bzrlib.symbol_versioning import deprecated_in
23
26
 
24
27
 
25
28
# Ancestry 1:
115
118
#     /  \      \
116
119
#  rev2a rev2b rev2c
117
120
#    |  /   \   /
118
 
#  rev3a    reveb
 
121
#  rev3a    rev3b
119
122
history_shortcut = {'rev1': [NULL_REVISION], 'rev2a': ['rev1'],
120
123
                    'rev2b': ['rev1'], 'rev2c': ['rev1'],
121
124
                    'rev3a': ['rev2a', 'rev2b'], 'rev3b': ['rev2b', 'rev2c']}
122
125
 
 
126
# Extended history shortcut
 
127
#  NULL_REVISION
 
128
#       |
 
129
#       a
 
130
#       |\
 
131
#       b |
 
132
#       | |
 
133
#       c |
 
134
#       | |
 
135
#       d |
 
136
#       |\|
 
137
#       e f
 
138
extended_history_shortcut = {'a': [NULL_REVISION],
 
139
                             'b': ['a'],
 
140
                             'c': ['b'],
 
141
                             'd': ['c'],
 
142
                             'e': ['d'],
 
143
                             'f': ['a', 'd'],
 
144
                            }
 
145
 
 
146
# Double shortcut
 
147
# Both sides will see 'A' first, even though it is actually a decendent of a
 
148
# different common revision.
 
149
#
 
150
#  NULL_REVISION
 
151
#       |
 
152
#       a
 
153
#      /|\
 
154
#     / b \
 
155
#    /  |  \
 
156
#   |   c   |
 
157
#   |  / \  |
 
158
#   | d   e |
 
159
#   |/     \|
 
160
#   f       g
 
161
 
 
162
double_shortcut = {'a':[NULL_REVISION], 'b':['a'], 'c':['b'],
 
163
                   'd':['c'], 'e':['c'], 'f':['a', 'd'],
 
164
                   'g':['a', 'e']}
 
165
 
 
166
# Complex shortcut
 
167
# This has a failure mode in that a shortcut will find some nodes in common,
 
168
# but the common searcher won't have time to find that one branch is actually
 
169
# in common. The extra nodes at the beginning are because we want to avoid
 
170
# walking off the graph. Specifically, node G should be considered common, but
 
171
# is likely to be seen by M long before the common searcher finds it.
 
172
#
 
173
# NULL_REVISION
 
174
#     |
 
175
#     a
 
176
#     |
 
177
#     b
 
178
#     |
 
179
#     c
 
180
#     |
 
181
#     d
 
182
#     |\
 
183
#     e f
 
184
#     | |\
 
185
#     | g h
 
186
#     |/| |
 
187
#     i j |
 
188
#     | | |
 
189
#     | k |
 
190
#     | | |
 
191
#     | l |
 
192
#     |/|/
 
193
#     m n
 
194
complex_shortcut = {'a':[NULL_REVISION], 'b':['a'], 'c':['b'], 'd':['c'],
 
195
                    'e':['d'], 'f':['d'], 'g':['f'], 'h':['f'],
 
196
                    'i':['e', 'g'], 'j':['g'], 'k':['j'],
 
197
                    'l':['k'], 'm':['i', 'l'], 'n':['l', 'h']}
 
198
 
 
199
# NULL_REVISION
 
200
#     |
 
201
#     a
 
202
#     |
 
203
#     b
 
204
#     |
 
205
#     c
 
206
#     |
 
207
#     d
 
208
#     |\
 
209
#     e |
 
210
#     | |
 
211
#     f |
 
212
#     | |
 
213
#     g h
 
214
#     | |\
 
215
#     i | j
 
216
#     |\| |
 
217
#     | k |
 
218
#     | | |
 
219
#     | l |
 
220
#     | | |
 
221
#     | m |
 
222
#     | | |
 
223
#     | n |
 
224
#     | | |
 
225
#     | o |
 
226
#     | | |
 
227
#     | p |
 
228
#     | | |
 
229
#     | q |
 
230
#     | | |
 
231
#     | r |
 
232
#     | | |
 
233
#     | s |
 
234
#     | | |
 
235
#     |/|/
 
236
#     t u
 
237
complex_shortcut2 = {'a':[NULL_REVISION], 'b':['a'], 'c':['b'], 'd':['c'],
 
238
                    'e':['d'], 'f':['e'], 'g':['f'], 'h':['d'], 'i':['g'],
 
239
                    'j':['h'], 'k':['h', 'i'], 'l':['k'], 'm':['l'], 'n':['m'],
 
240
                    'o':['n'], 'p':['o'], 'q':['p'], 'r':['q'], 's':['r'],
 
241
                    't':['i', 's'], 'u':['s', 'j'],
 
242
                    }
 
243
 
 
244
# Graph where different walkers will race to find the common and uncommon
 
245
# nodes.
 
246
#
 
247
# NULL_REVISION
 
248
#     |
 
249
#     a
 
250
#     |
 
251
#     b
 
252
#     |
 
253
#     c
 
254
#     |
 
255
#     d
 
256
#     |\
 
257
#     e k
 
258
#     | |
 
259
#     f-+-p
 
260
#     | | |
 
261
#     | l |
 
262
#     | | |
 
263
#     | m |
 
264
#     | |\|
 
265
#     g n q
 
266
#     |\| |
 
267
#     h o |
 
268
#     |/| |
 
269
#     i r |
 
270
#     | | |
 
271
#     | s |
 
272
#     | | |
 
273
#     | t |
 
274
#     | | |
 
275
#     | u |
 
276
#     | | |
 
277
#     | v |
 
278
#     | | |
 
279
#     | w |
 
280
#     | | |
 
281
#     | x |
 
282
#     | |\|
 
283
#     | y z
 
284
#     |/
 
285
#     j
 
286
#
 
287
# x is found to be common right away, but is the start of a long series of
 
288
# common commits.
 
289
# o is actually common, but the i-j shortcut makes it look like it is actually
 
290
# unique to j at first, you have to traverse all of x->o to find it.
 
291
# q,m gives the walker from j a common point to stop searching, as does p,f.
 
292
# k-n exists so that the second pass still has nodes that are worth searching,
 
293
# rather than instantly cancelling the extra walker.
 
294
 
 
295
racing_shortcuts = {'a':[NULL_REVISION], 'b':['a'], 'c':['b'], 'd':['c'],
 
296
    'e':['d'], 'f':['e'], 'g':['f'], 'h':['g'], 'i':['h', 'o'], 'j':['i', 'y'],
 
297
    'k':['d'], 'l':['k'], 'm':['l'], 'n':['m'], 'o':['n', 'g'], 'p':['f'],
 
298
    'q':['p', 'm'], 'r':['o'], 's':['r'], 't':['s'], 'u':['t'], 'v':['u'],
 
299
    'w':['v'], 'x':['w'], 'y':['x'], 'z':['x', 'q']}
 
300
 
 
301
 
 
302
# A graph with multiple nodes unique to one side.
 
303
#
 
304
# NULL_REVISION
 
305
#     |
 
306
#     a
 
307
#     |
 
308
#     b
 
309
#     |
 
310
#     c
 
311
#     |
 
312
#     d
 
313
#     |\
 
314
#     e f
 
315
#     |\ \
 
316
#     g h i
 
317
#     |\ \ \
 
318
#     j k l m
 
319
#     | |/ x|
 
320
#     | n o p
 
321
#     | |/  |
 
322
#     | q   |
 
323
#     | |   |
 
324
#     | r   |
 
325
#     | |   |
 
326
#     | s   |
 
327
#     | |   |
 
328
#     | t   |
 
329
#     | |   |
 
330
#     | u   |
 
331
#     | |   |
 
332
#     | v   |
 
333
#     | |   |
 
334
#     | w   |
 
335
#     | |   |
 
336
#     | x   |
 
337
#     |/ \ /
 
338
#     y   z
 
339
#
 
340
 
 
341
multiple_interesting_unique = {'a':[NULL_REVISION], 'b':['a'], 'c':['b'],
 
342
    'd':['c'], 'e':['d'], 'f':['d'], 'g':['e'], 'h':['e'], 'i':['f'],
 
343
    'j':['g'], 'k':['g'], 'l':['h'], 'm':['i'], 'n':['k', 'l'],
 
344
    'o':['m'], 'p':['m', 'l'], 'q':['n', 'o'], 'r':['q'], 's':['r'],
 
345
    't':['s'], 'u':['t'], 'v':['u'], 'w':['v'], 'x':['w'],
 
346
    'y':['j', 'x'], 'z':['x', 'p']}
 
347
 
 
348
 
 
349
# Shortcut with extra root
 
350
# We have a long history shortcut, and an extra root, which is why we can't
 
351
# stop searchers based on seeing NULL_REVISION
 
352
#  NULL_REVISION
 
353
#       |   |
 
354
#       a   |
 
355
#       |\  |
 
356
#       b | |
 
357
#       | | |
 
358
#       c | |
 
359
#       | | |
 
360
#       d | g
 
361
#       |\|/
 
362
#       e f
 
363
shortcut_extra_root = {'a': [NULL_REVISION],
 
364
                       'b': ['a'],
 
365
                       'c': ['b'],
 
366
                       'd': ['c'],
 
367
                       'e': ['d'],
 
368
                       'f': ['a', 'd', 'g'],
 
369
                       'g': [NULL_REVISION],
 
370
                      }
 
371
 
123
372
#  NULL_REVISION
124
373
#       |
125
374
#       f
134
383
            'f':[NULL_REVISION]}
135
384
 
136
385
 
 
386
# A graph that contains a ghost
 
387
#  NULL_REVISION
 
388
#       |
 
389
#       f
 
390
#       |
 
391
#       e   g
 
392
#      / \ /
 
393
#     b   d
 
394
#     | \ |
 
395
#     a   c
 
396
 
 
397
with_ghost = {'a': ['b'], 'c': ['b', 'd'], 'b':['e'], 'd':['e', 'g'],
 
398
              'e': ['f'], 'f':[NULL_REVISION], NULL_REVISION:()}
 
399
 
 
400
# A graph that shows we can shortcut finding revnos when reaching them from the
 
401
# side.
 
402
#  NULL_REVISION
 
403
#       |
 
404
#       a
 
405
#       |
 
406
#       b
 
407
#       |
 
408
#       c
 
409
#       |
 
410
#       d
 
411
#       |
 
412
#       e
 
413
#      / \
 
414
#     f   g
 
415
#     |
 
416
#     h
 
417
#     |
 
418
#     i
 
419
 
 
420
with_tail = {'a':[NULL_REVISION], 'b':['a'], 'c':['b'], 'd':['c'], 'e':['d'],
 
421
             'f':['e'], 'g':['e'], 'h':['f'], 'i':['h']}
 
422
 
 
423
 
137
424
class InstrumentedParentsProvider(object):
138
425
 
139
426
    def __init__(self, parents_provider):
140
427
        self.calls = []
141
428
        self._real_parents_provider = parents_provider
142
429
 
143
 
    def get_parents(self, nodes):
 
430
    def get_parent_map(self, nodes):
144
431
        self.calls.extend(nodes)
145
 
        return self._real_parents_provider.get_parents(nodes)
 
432
        return self._real_parents_provider.get_parent_map(nodes)
 
433
 
 
434
 
 
435
class TestGraphBase(tests.TestCase):
 
436
 
 
437
    def make_graph(self, ancestors):
 
438
        return _mod_graph.Graph(_mod_graph.DictParentsProvider(ancestors))
 
439
 
 
440
    def make_breaking_graph(self, ancestors, break_on):
 
441
        """Make a Graph that raises an exception if we hit a node."""
 
442
        g = self.make_graph(ancestors)
 
443
        orig_parent_map = g.get_parent_map
 
444
        def get_parent_map(keys):
 
445
            bad_keys = set(keys).intersection(break_on)
 
446
            if bad_keys:
 
447
                self.fail('key(s) %s was accessed' % (sorted(bad_keys),))
 
448
            return orig_parent_map(keys)
 
449
        g.get_parent_map = get_parent_map
 
450
        return g
146
451
 
147
452
 
148
453
class TestGraph(TestCaseWithMemoryTransport):
149
454
 
150
455
    def make_graph(self, ancestors):
151
 
        tree = self.prepare_memory_tree('.')
152
 
        self.build_ancestry(tree, ancestors)
153
 
        self.addCleanup(tree.unlock)
154
 
        return tree.branch.repository.get_graph()
 
456
        return _mod_graph.Graph(_mod_graph.DictParentsProvider(ancestors))
155
457
 
156
458
    def prepare_memory_tree(self, location):
157
459
        tree = self.make_branch_and_memory_tree(location)
224
526
        graph = self.make_graph(history_shortcut)
225
527
        self.assertEqual(set(['rev2b']), graph.find_lca('rev3a', 'rev3b'))
226
528
 
 
529
    def test_lefthand_distance_smoke(self):
 
530
        """A simple does it work test for graph.lefthand_distance(keys)."""
 
531
        graph = self.make_graph(history_shortcut)
 
532
        distance_graph = graph.find_lefthand_distances(['rev3b', 'rev2a'])
 
533
        self.assertEqual({'rev2a': 2, 'rev3b': 3}, distance_graph)
 
534
 
 
535
    def test_lefthand_distance_ghosts(self):
 
536
        """A simple does it work test for graph.lefthand_distance(keys)."""
 
537
        nodes = {'nonghost':[NULL_REVISION], 'toghost':['ghost']}
 
538
        graph = self.make_graph(nodes)
 
539
        distance_graph = graph.find_lefthand_distances(['nonghost', 'toghost'])
 
540
        self.assertEqual({'nonghost': 1, 'toghost': -1}, distance_graph)
 
541
 
227
542
    def test_recursive_unique_lca(self):
228
543
        """Test finding a unique least common ancestor.
229
544
 
236
551
                         graph.find_unique_lca(NULL_REVISION, 'rev1'))
237
552
        self.assertEqual('rev1', graph.find_unique_lca('rev1', 'rev1'))
238
553
        self.assertEqual('rev1', graph.find_unique_lca('rev2a', 'rev2b'))
 
554
        self.assertEqual(('rev1', 1,),
 
555
                         graph.find_unique_lca('rev2a', 'rev2b',
 
556
                         count_steps=True))
 
557
 
 
558
    def assertRemoveDescendants(self, expected, graph, revisions):
 
559
        parents = graph.get_parent_map(revisions)
 
560
        self.assertEqual(expected,
 
561
                         graph._remove_simple_descendants(revisions, parents))
 
562
 
 
563
    def test__remove_simple_descendants(self):
 
564
        graph = self.make_graph(ancestry_1)
 
565
        self.assertRemoveDescendants(set(['rev1']), graph,
 
566
            set(['rev1', 'rev2a', 'rev2b', 'rev3', 'rev4']))
 
567
 
 
568
    def test__remove_simple_descendants_disjoint(self):
 
569
        graph = self.make_graph(ancestry_1)
 
570
        self.assertRemoveDescendants(set(['rev1', 'rev3']), graph,
 
571
            set(['rev1', 'rev3']))
 
572
 
 
573
    def test__remove_simple_descendants_chain(self):
 
574
        graph = self.make_graph(ancestry_1)
 
575
        self.assertRemoveDescendants(set(['rev1']), graph,
 
576
            set(['rev1', 'rev2a', 'rev3']))
 
577
 
 
578
    def test__remove_simple_descendants_siblings(self):
 
579
        graph = self.make_graph(ancestry_1)
 
580
        self.assertRemoveDescendants(set(['rev2a', 'rev2b']), graph,
 
581
            set(['rev2a', 'rev2b', 'rev3']))
239
582
 
240
583
    def test_unique_lca_criss_cross(self):
241
584
        """Ensure we don't pick non-unique lcas in a criss-cross"""
242
585
        graph = self.make_graph(criss_cross)
243
586
        self.assertEqual('rev1', graph.find_unique_lca('rev3a', 'rev3b'))
 
587
        lca, steps = graph.find_unique_lca('rev3a', 'rev3b', count_steps=True)
 
588
        self.assertEqual('rev1', lca)
 
589
        self.assertEqual(2, steps)
244
590
 
245
591
    def test_unique_lca_null_revision(self):
246
592
        """Ensure we pick NULL_REVISION when necessary"""
255
601
        self.assertEqual(NULL_REVISION,
256
602
                         graph.find_unique_lca('rev4a', 'rev1b'))
257
603
 
 
604
    def test_lca_double_shortcut(self):
 
605
        graph = self.make_graph(double_shortcut)
 
606
        self.assertEqual('c', graph.find_unique_lca('f', 'g'))
 
607
 
258
608
    def test_common_ancestor_two_repos(self):
259
609
        """Ensure we do unique_lca using data from two repos"""
260
610
        mainline_tree = self.prepare_memory_tree('mainline')
283
633
        self.assertEqual((set(['rev4', 'rev3', 'rev2a']), set()),
284
634
                         graph.find_difference('rev4', 'rev2b'))
285
635
 
 
636
    def test_graph_difference_separate_ancestry(self):
 
637
        graph = self.make_graph(ancestry_2)
 
638
        self.assertEqual((set(['rev1a']), set(['rev1b'])),
 
639
                         graph.find_difference('rev1a', 'rev1b'))
 
640
        self.assertEqual((set(['rev1a', 'rev2a', 'rev3a', 'rev4a']),
 
641
                          set(['rev1b'])),
 
642
                         graph.find_difference('rev4a', 'rev1b'))
 
643
 
286
644
    def test_graph_difference_criss_cross(self):
287
645
        graph = self.make_graph(criss_cross)
288
646
        self.assertEqual((set(['rev3a']), set(['rev3b'])),
290
648
        self.assertEqual((set([]), set(['rev3b', 'rev2b'])),
291
649
                         graph.find_difference('rev2a', 'rev3b'))
292
650
 
 
651
    def test_graph_difference_extended_history(self):
 
652
        graph = self.make_graph(extended_history_shortcut)
 
653
        self.assertEqual((set(['e']), set(['f'])),
 
654
                         graph.find_difference('e', 'f'))
 
655
        self.assertEqual((set(['f']), set(['e'])),
 
656
                         graph.find_difference('f', 'e'))
 
657
 
 
658
    def test_graph_difference_double_shortcut(self):
 
659
        graph = self.make_graph(double_shortcut)
 
660
        self.assertEqual((set(['d', 'f']), set(['e', 'g'])),
 
661
                         graph.find_difference('f', 'g'))
 
662
 
 
663
    def test_graph_difference_complex_shortcut(self):
 
664
        graph = self.make_graph(complex_shortcut)
 
665
        self.assertEqual((set(['m', 'i', 'e']), set(['n', 'h'])),
 
666
                         graph.find_difference('m', 'n'))
 
667
 
 
668
    def test_graph_difference_complex_shortcut2(self):
 
669
        graph = self.make_graph(complex_shortcut2)
 
670
        self.assertEqual((set(['t']), set(['j', 'u'])),
 
671
                         graph.find_difference('t', 'u'))
 
672
 
 
673
    def test_graph_difference_shortcut_extra_root(self):
 
674
        graph = self.make_graph(shortcut_extra_root)
 
675
        self.assertEqual((set(['e']), set(['f', 'g'])),
 
676
                         graph.find_difference('e', 'f'))
 
677
 
 
678
 
293
679
    def test_stacked_parents_provider(self):
 
680
        parents1 = _mod_graph.DictParentsProvider({'rev2': ['rev3']})
 
681
        parents2 = _mod_graph.DictParentsProvider({'rev1': ['rev4']})
 
682
        stacked = _mod_graph.StackedParentsProvider([parents1, parents2])
 
683
        self.assertEqual({'rev1':['rev4'], 'rev2':['rev3']},
 
684
                         stacked.get_parent_map(['rev1', 'rev2']))
 
685
        self.assertEqual({'rev2':['rev3'], 'rev1':['rev4']},
 
686
                         stacked.get_parent_map(['rev2', 'rev1']))
 
687
        self.assertEqual({'rev2':['rev3']},
 
688
                         stacked.get_parent_map(['rev2', 'rev2']))
 
689
        self.assertEqual({'rev1':['rev4']},
 
690
                         stacked.get_parent_map(['rev1', 'rev1']))
 
691
    
 
692
    def test_stacked_parents_provider_overlapping(self):
 
693
        # rev2 is availible in both providers.
 
694
        # 1
 
695
        # |
 
696
        # 2
 
697
        parents1 = _mod_graph.DictParentsProvider({'rev2': ['rev1']})
 
698
        parents2 = _mod_graph.DictParentsProvider({'rev2': ['rev1']})
 
699
        stacked = _mod_graph.StackedParentsProvider([parents1, parents2])
 
700
        self.assertEqual({'rev2': ['rev1']},
 
701
                         stacked.get_parent_map(['rev2']))
294
702
 
 
703
    def test__stacked_parents_provider_deprecated(self):
295
704
        parents1 = _mod_graph.DictParentsProvider({'rev2': ['rev3']})
296
705
        parents2 = _mod_graph.DictParentsProvider({'rev1': ['rev4']})
297
 
        stacked = _mod_graph._StackedParentsProvider([parents1, parents2])
298
 
        self.assertEqual([['rev4',], ['rev3']],
299
 
                         stacked.get_parents(['rev1', 'rev2']))
300
 
        self.assertEqual([['rev3',], ['rev4']],
301
 
                         stacked.get_parents(['rev2', 'rev1']))
302
 
        self.assertEqual([['rev3',], ['rev3']],
303
 
                         stacked.get_parents(['rev2', 'rev2']))
304
 
        self.assertEqual([['rev4',], ['rev4']],
305
 
                         stacked.get_parents(['rev1', 'rev1']))
 
706
        stacked = self.applyDeprecated(deprecated_in((1, 16, 0)),
 
707
                    _mod_graph._StackedParentsProvider, [parents1, parents2])
 
708
        self.assertEqual({'rev1':['rev4'], 'rev2':['rev3']},
 
709
                         stacked.get_parent_map(['rev1', 'rev2']))
 
710
        self.assertEqual({'rev2':['rev3'], 'rev1':['rev4']},
 
711
                         stacked.get_parent_map(['rev2', 'rev1']))
 
712
        self.assertEqual({'rev2':['rev3']},
 
713
                         stacked.get_parent_map(['rev2', 'rev2']))
 
714
        self.assertEqual({'rev1':['rev4']},
 
715
                         stacked.get_parent_map(['rev1', 'rev1']))
306
716
 
307
717
    def test_iter_topo_order(self):
308
718
        graph = self.make_graph(ancestry_1)
328
738
        instrumented_graph.is_ancestor('rev2a', 'rev2b')
329
739
        self.assertTrue('null:' not in instrumented_provider.calls)
330
740
 
 
741
    def test_is_between(self):
 
742
        graph = self.make_graph(ancestry_1)
 
743
        self.assertEqual(True, graph.is_between('null:', 'null:', 'null:'))
 
744
        self.assertEqual(True, graph.is_between('rev1', 'null:', 'rev1'))
 
745
        self.assertEqual(True, graph.is_between('rev1', 'rev1', 'rev4'))
 
746
        self.assertEqual(True, graph.is_between('rev4', 'rev1', 'rev4'))
 
747
        self.assertEqual(True, graph.is_between('rev3', 'rev1', 'rev4'))
 
748
        self.assertEqual(False, graph.is_between('rev4', 'rev1', 'rev3'))
 
749
        self.assertEqual(False, graph.is_between('rev1', 'rev2a', 'rev4'))
 
750
        self.assertEqual(False, graph.is_between('null:', 'rev1', 'rev4'))
 
751
 
331
752
    def test_is_ancestor_boundary(self):
332
753
        """Ensure that we avoid searching the whole graph.
333
 
        
 
754
 
334
755
        This requires searching through b as a common ancestor, so we
335
756
        can identify that e is common.
336
757
        """
340
761
        self.assertFalse(graph.is_ancestor('a', 'c'))
341
762
        self.assertTrue('null:' not in instrumented_provider.calls)
342
763
 
 
764
    def test_iter_ancestry(self):
 
765
        nodes = boundary.copy()
 
766
        nodes[NULL_REVISION] = ()
 
767
        graph = self.make_graph(nodes)
 
768
        expected = nodes.copy()
 
769
        expected.pop('a') # 'a' is not in the ancestry of 'c', all the
 
770
                          # other nodes are
 
771
        self.assertEqual(expected, dict(graph.iter_ancestry(['c'])))
 
772
        self.assertEqual(nodes, dict(graph.iter_ancestry(['a', 'c'])))
 
773
 
 
774
    def test_iter_ancestry_with_ghost(self):
 
775
        graph = self.make_graph(with_ghost)
 
776
        expected = with_ghost.copy()
 
777
        # 'a' is not in the ancestry of 'c', and 'g' is a ghost
 
778
        expected['g'] = None
 
779
        self.assertEqual(expected, dict(graph.iter_ancestry(['a', 'c'])))
 
780
        expected.pop('a')
 
781
        self.assertEqual(expected, dict(graph.iter_ancestry(['c'])))
 
782
 
343
783
    def test_filter_candidate_lca(self):
344
784
        """Test filter_candidate_lca for a corner case
345
785
 
373
813
        self.assertEqual(set(['rev1']), graph.heads(('rev1', 'null:')))
374
814
 
375
815
    def test_heads_one(self):
376
 
        # A single node will alwaya be a head
 
816
        # A single node will always be a head
377
817
        graph = self.make_graph(ancestry_1)
378
818
        self.assertEqual(set(['null:']), graph.heads(['null:']))
379
819
        self.assertEqual(set(['rev1']), graph.heads(['rev1']))
445
885
 
446
886
    def _run_heads_break_deeper(self, graph_dict, search):
447
887
        """Run heads on a graph-as-a-dict.
448
 
        
 
888
 
449
889
        If the search asks for the parents of 'deeper' the test will fail.
450
890
        """
451
891
        class stub(object):
452
892
            pass
453
 
        def get_parents(keys):
454
 
            result = []
 
893
        def get_parent_map(keys):
 
894
            result = {}
455
895
            for key in keys:
456
896
                if key == 'deeper':
457
897
                    self.fail('key deeper was accessed')
458
 
                result.append(graph_dict[key])
 
898
                result[key] = graph_dict[key]
459
899
            return result
460
900
        an_obj = stub()
461
 
        an_obj.get_parents = get_parents
 
901
        an_obj.get_parent_map = get_parent_map
462
902
        graph = _mod_graph.Graph(an_obj)
463
903
        return graph.heads(search)
464
904
 
496
936
        }
497
937
        self.assertEqual(set(['h1', 'h2']),
498
938
            self._run_heads_break_deeper(graph_dict, ['h1', 'h2']))
 
939
 
 
940
    def test_breadth_first_search_start_ghosts(self):
 
941
        graph = self.make_graph({})
 
942
        # with_ghosts reports the ghosts
 
943
        search = graph._make_breadth_first_searcher(['a-ghost'])
 
944
        self.assertEqual((set(), set(['a-ghost'])), search.next_with_ghosts())
 
945
        self.assertRaises(StopIteration, search.next_with_ghosts)
 
946
        # next includes them
 
947
        search = graph._make_breadth_first_searcher(['a-ghost'])
 
948
        self.assertEqual(set(['a-ghost']), search.next())
 
949
        self.assertRaises(StopIteration, search.next)
 
950
 
 
951
    def test_breadth_first_search_deep_ghosts(self):
 
952
        graph = self.make_graph({
 
953
            'head':['present'],
 
954
            'present':['child', 'ghost'],
 
955
            'child':[],
 
956
            })
 
957
        # with_ghosts reports the ghosts
 
958
        search = graph._make_breadth_first_searcher(['head'])
 
959
        self.assertEqual((set(['head']), set()), search.next_with_ghosts())
 
960
        self.assertEqual((set(['present']), set()), search.next_with_ghosts())
 
961
        self.assertEqual((set(['child']), set(['ghost'])),
 
962
            search.next_with_ghosts())
 
963
        self.assertRaises(StopIteration, search.next_with_ghosts)
 
964
        # next includes them
 
965
        search = graph._make_breadth_first_searcher(['head'])
 
966
        self.assertEqual(set(['head']), search.next())
 
967
        self.assertEqual(set(['present']), search.next())
 
968
        self.assertEqual(set(['child', 'ghost']),
 
969
            search.next())
 
970
        self.assertRaises(StopIteration, search.next)
 
971
 
 
972
    def test_breadth_first_search_change_next_to_next_with_ghosts(self):
 
973
        # To make the API robust, we allow calling both next() and
 
974
        # next_with_ghosts() on the same searcher.
 
975
        graph = self.make_graph({
 
976
            'head':['present'],
 
977
            'present':['child', 'ghost'],
 
978
            'child':[],
 
979
            })
 
980
        # start with next_with_ghosts
 
981
        search = graph._make_breadth_first_searcher(['head'])
 
982
        self.assertEqual((set(['head']), set()), search.next_with_ghosts())
 
983
        self.assertEqual(set(['present']), search.next())
 
984
        self.assertEqual((set(['child']), set(['ghost'])),
 
985
            search.next_with_ghosts())
 
986
        self.assertRaises(StopIteration, search.next)
 
987
        # start with next
 
988
        search = graph._make_breadth_first_searcher(['head'])
 
989
        self.assertEqual(set(['head']), search.next())
 
990
        self.assertEqual((set(['present']), set()), search.next_with_ghosts())
 
991
        self.assertEqual(set(['child', 'ghost']),
 
992
            search.next())
 
993
        self.assertRaises(StopIteration, search.next_with_ghosts)
 
994
 
 
995
    def test_breadth_first_change_search(self):
 
996
        # Changing the search should work with both next and next_with_ghosts.
 
997
        graph = self.make_graph({
 
998
            'head':['present'],
 
999
            'present':['stopped'],
 
1000
            'other':['other_2'],
 
1001
            'other_2':[],
 
1002
            })
 
1003
        search = graph._make_breadth_first_searcher(['head'])
 
1004
        self.assertEqual((set(['head']), set()), search.next_with_ghosts())
 
1005
        self.assertEqual((set(['present']), set()), search.next_with_ghosts())
 
1006
        self.assertEqual(set(['present']),
 
1007
            search.stop_searching_any(['present']))
 
1008
        self.assertEqual((set(['other']), set(['other_ghost'])),
 
1009
            search.start_searching(['other', 'other_ghost']))
 
1010
        self.assertEqual((set(['other_2']), set()), search.next_with_ghosts())
 
1011
        self.assertRaises(StopIteration, search.next_with_ghosts)
 
1012
        # next includes them
 
1013
        search = graph._make_breadth_first_searcher(['head'])
 
1014
        self.assertEqual(set(['head']), search.next())
 
1015
        self.assertEqual(set(['present']), search.next())
 
1016
        self.assertEqual(set(['present']),
 
1017
            search.stop_searching_any(['present']))
 
1018
        search.start_searching(['other', 'other_ghost'])
 
1019
        self.assertEqual(set(['other_2']), search.next())
 
1020
        self.assertRaises(StopIteration, search.next)
 
1021
 
 
1022
    def assertSeenAndResult(self, instructions, search, next):
 
1023
        """Check the results of .seen and get_result() for a seach.
 
1024
 
 
1025
        :param instructions: A list of tuples:
 
1026
            (seen, recipe, included_keys, starts, stops).
 
1027
            seen, recipe and included_keys are results to check on the search
 
1028
            and the searches get_result(). starts and stops are parameters to
 
1029
            pass to start_searching and stop_searching_any during each
 
1030
            iteration, if they are not None.
 
1031
        :param search: The search to use.
 
1032
        :param next: A callable to advance the search.
 
1033
        """
 
1034
        for seen, recipe, included_keys, starts, stops in instructions:
 
1035
            # Adjust for recipe contract changes that don't vary for all the
 
1036
            # current tests.
 
1037
            recipe = ('search',) + recipe
 
1038
            next()
 
1039
            if starts is not None:
 
1040
                search.start_searching(starts)
 
1041
            if stops is not None:
 
1042
                search.stop_searching_any(stops)
 
1043
            result = search.get_result()
 
1044
            self.assertEqual(recipe, result.get_recipe())
 
1045
            self.assertEqual(set(included_keys), result.get_keys())
 
1046
            self.assertEqual(seen, search.seen)
 
1047
 
 
1048
    def test_breadth_first_get_result_excludes_current_pending(self):
 
1049
        graph = self.make_graph({
 
1050
            'head':['child'],
 
1051
            'child':[NULL_REVISION],
 
1052
            NULL_REVISION:[],
 
1053
            })
 
1054
        search = graph._make_breadth_first_searcher(['head'])
 
1055
        # At the start, nothing has been seen, to its all excluded:
 
1056
        result = search.get_result()
 
1057
        self.assertEqual(('search', set(['head']), set(['head']), 0),
 
1058
            result.get_recipe())
 
1059
        self.assertEqual(set(), result.get_keys())
 
1060
        self.assertEqual(set(), search.seen)
 
1061
        # using next:
 
1062
        expected = [
 
1063
            (set(['head']), (set(['head']), set(['child']), 1),
 
1064
             ['head'], None, None),
 
1065
            (set(['head', 'child']), (set(['head']), set([NULL_REVISION]), 2),
 
1066
             ['head', 'child'], None, None),
 
1067
            (set(['head', 'child', NULL_REVISION]), (set(['head']), set(), 3),
 
1068
             ['head', 'child', NULL_REVISION], None, None),
 
1069
            ]
 
1070
        self.assertSeenAndResult(expected, search, search.next)
 
1071
        # using next_with_ghosts:
 
1072
        search = graph._make_breadth_first_searcher(['head'])
 
1073
        self.assertSeenAndResult(expected, search, search.next_with_ghosts)
 
1074
 
 
1075
    def test_breadth_first_get_result_starts_stops(self):
 
1076
        graph = self.make_graph({
 
1077
            'head':['child'],
 
1078
            'child':[NULL_REVISION],
 
1079
            'otherhead':['otherchild'],
 
1080
            'otherchild':['excluded'],
 
1081
            'excluded':[NULL_REVISION],
 
1082
            NULL_REVISION:[]
 
1083
            })
 
1084
        search = graph._make_breadth_first_searcher([])
 
1085
        # Starting with nothing and adding a search works:
 
1086
        search.start_searching(['head'])
 
1087
        # head has been seen:
 
1088
        result = search.get_result()
 
1089
        self.assertEqual(('search', set(['head']), set(['child']), 1),
 
1090
            result.get_recipe())
 
1091
        self.assertEqual(set(['head']), result.get_keys())
 
1092
        self.assertEqual(set(['head']), search.seen)
 
1093
        # using next:
 
1094
        expected = [
 
1095
            # stop at child, and start a new search at otherhead:
 
1096
            # - otherhead counts as seen immediately when start_searching is
 
1097
            # called.
 
1098
            (set(['head', 'child', 'otherhead']),
 
1099
             (set(['head', 'otherhead']), set(['child', 'otherchild']), 2),
 
1100
             ['head', 'otherhead'], ['otherhead'], ['child']),
 
1101
            (set(['head', 'child', 'otherhead', 'otherchild']),
 
1102
             (set(['head', 'otherhead']), set(['child', 'excluded']), 3),
 
1103
             ['head', 'otherhead', 'otherchild'], None, None),
 
1104
            # stop searching excluded now
 
1105
            (set(['head', 'child', 'otherhead', 'otherchild', 'excluded']),
 
1106
             (set(['head', 'otherhead']), set(['child', 'excluded']), 3),
 
1107
             ['head', 'otherhead', 'otherchild'], None, ['excluded']),
 
1108
            ]
 
1109
        self.assertSeenAndResult(expected, search, search.next)
 
1110
        # using next_with_ghosts:
 
1111
        search = graph._make_breadth_first_searcher([])
 
1112
        search.start_searching(['head'])
 
1113
        self.assertSeenAndResult(expected, search, search.next_with_ghosts)
 
1114
 
 
1115
    def test_breadth_first_stop_searching_not_queried(self):
 
1116
        # A client should be able to say 'stop node X' even if X has not been
 
1117
        # returned to the client.
 
1118
        graph = self.make_graph({
 
1119
            'head':['child', 'ghost1'],
 
1120
            'child':[NULL_REVISION],
 
1121
            NULL_REVISION:[],
 
1122
            })
 
1123
        search = graph._make_breadth_first_searcher(['head'])
 
1124
        expected = [
 
1125
            # NULL_REVISION and ghost1 have not been returned
 
1126
            (set(['head']),
 
1127
             (set(['head']), set(['child', NULL_REVISION, 'ghost1']), 1),
 
1128
             ['head'], None, [NULL_REVISION, 'ghost1']),
 
1129
            # ghost1 has been returned, NULL_REVISION is to be returned in the
 
1130
            # next iteration.
 
1131
            (set(['head', 'child', 'ghost1']),
 
1132
             (set(['head']), set(['ghost1', NULL_REVISION]), 2),
 
1133
             ['head', 'child'], None, [NULL_REVISION, 'ghost1']),
 
1134
            ]
 
1135
        self.assertSeenAndResult(expected, search, search.next)
 
1136
        # using next_with_ghosts:
 
1137
        search = graph._make_breadth_first_searcher(['head'])
 
1138
        self.assertSeenAndResult(expected, search, search.next_with_ghosts)
 
1139
 
 
1140
    def test_breadth_first_stop_searching_late(self):
 
1141
        # A client should be able to say 'stop node X' and have it excluded
 
1142
        # from the result even if X was seen in an older iteration of the
 
1143
        # search.
 
1144
        graph = self.make_graph({
 
1145
            'head':['middle'],
 
1146
            'middle':['child'],
 
1147
            'child':[NULL_REVISION],
 
1148
            NULL_REVISION:[],
 
1149
            })
 
1150
        search = graph._make_breadth_first_searcher(['head'])
 
1151
        expected = [
 
1152
            (set(['head']), (set(['head']), set(['middle']), 1),
 
1153
             ['head'], None, None),
 
1154
            (set(['head', 'middle']), (set(['head']), set(['child']), 2),
 
1155
             ['head', 'middle'], None, None),
 
1156
            # 'middle' came from the previous iteration, but we don't stop
 
1157
            # searching it until *after* advancing the searcher.
 
1158
            (set(['head', 'middle', 'child']),
 
1159
             (set(['head']), set(['middle', 'child']), 1),
 
1160
             ['head'], None, ['middle', 'child']),
 
1161
            ]
 
1162
        self.assertSeenAndResult(expected, search, search.next)
 
1163
        # using next_with_ghosts:
 
1164
        search = graph._make_breadth_first_searcher(['head'])
 
1165
        self.assertSeenAndResult(expected, search, search.next_with_ghosts)
 
1166
 
 
1167
    def test_breadth_first_get_result_ghosts_are_excluded(self):
 
1168
        graph = self.make_graph({
 
1169
            'head':['child', 'ghost'],
 
1170
            'child':[NULL_REVISION],
 
1171
            NULL_REVISION:[],
 
1172
            })
 
1173
        search = graph._make_breadth_first_searcher(['head'])
 
1174
        # using next:
 
1175
        expected = [
 
1176
            (set(['head']),
 
1177
             (set(['head']), set(['ghost', 'child']), 1),
 
1178
             ['head'], None, None),
 
1179
            (set(['head', 'child', 'ghost']),
 
1180
             (set(['head']), set([NULL_REVISION, 'ghost']), 2),
 
1181
             ['head', 'child'], None, None),
 
1182
            ]
 
1183
        self.assertSeenAndResult(expected, search, search.next)
 
1184
        # using next_with_ghosts:
 
1185
        search = graph._make_breadth_first_searcher(['head'])
 
1186
        self.assertSeenAndResult(expected, search, search.next_with_ghosts)
 
1187
 
 
1188
    def test_breadth_first_get_result_starting_a_ghost_ghost_is_excluded(self):
 
1189
        graph = self.make_graph({
 
1190
            'head':['child'],
 
1191
            'child':[NULL_REVISION],
 
1192
            NULL_REVISION:[],
 
1193
            })
 
1194
        search = graph._make_breadth_first_searcher(['head'])
 
1195
        # using next:
 
1196
        expected = [
 
1197
            (set(['head', 'ghost']),
 
1198
             (set(['head', 'ghost']), set(['child', 'ghost']), 1),
 
1199
             ['head'], ['ghost'], None),
 
1200
            (set(['head', 'child', 'ghost']),
 
1201
             (set(['head', 'ghost']), set([NULL_REVISION, 'ghost']), 2),
 
1202
             ['head', 'child'], None, None),
 
1203
            ]
 
1204
        self.assertSeenAndResult(expected, search, search.next)
 
1205
        # using next_with_ghosts:
 
1206
        search = graph._make_breadth_first_searcher(['head'])
 
1207
        self.assertSeenAndResult(expected, search, search.next_with_ghosts)
 
1208
 
 
1209
    def test_breadth_first_revision_count_includes_NULL_REVISION(self):
 
1210
        graph = self.make_graph({
 
1211
            'head':[NULL_REVISION],
 
1212
            NULL_REVISION:[],
 
1213
            })
 
1214
        search = graph._make_breadth_first_searcher(['head'])
 
1215
        # using next:
 
1216
        expected = [
 
1217
            (set(['head']),
 
1218
             (set(['head']), set([NULL_REVISION]), 1),
 
1219
             ['head'], None, None),
 
1220
            (set(['head', NULL_REVISION]),
 
1221
             (set(['head']), set([]), 2),
 
1222
             ['head', NULL_REVISION], None, None),
 
1223
            ]
 
1224
        self.assertSeenAndResult(expected, search, search.next)
 
1225
        # using next_with_ghosts:
 
1226
        search = graph._make_breadth_first_searcher(['head'])
 
1227
        self.assertSeenAndResult(expected, search, search.next_with_ghosts)
 
1228
 
 
1229
    def test_breadth_first_search_get_result_after_StopIteration(self):
 
1230
        # StopIteration should not invalid anything..
 
1231
        graph = self.make_graph({
 
1232
            'head':[NULL_REVISION],
 
1233
            NULL_REVISION:[],
 
1234
            })
 
1235
        search = graph._make_breadth_first_searcher(['head'])
 
1236
        # using next:
 
1237
        expected = [
 
1238
            (set(['head']),
 
1239
             (set(['head']), set([NULL_REVISION]), 1),
 
1240
             ['head'], None, None),
 
1241
            (set(['head', 'ghost', NULL_REVISION]),
 
1242
             (set(['head', 'ghost']), set(['ghost']), 2),
 
1243
             ['head', NULL_REVISION], ['ghost'], None),
 
1244
            ]
 
1245
        self.assertSeenAndResult(expected, search, search.next)
 
1246
        self.assertRaises(StopIteration, search.next)
 
1247
        self.assertEqual(set(['head', 'ghost', NULL_REVISION]), search.seen)
 
1248
        result = search.get_result()
 
1249
        self.assertEqual(('search', set(['ghost', 'head']), set(['ghost']), 2),
 
1250
            result.get_recipe())
 
1251
        self.assertEqual(set(['head', NULL_REVISION]), result.get_keys())
 
1252
        # using next_with_ghosts:
 
1253
        search = graph._make_breadth_first_searcher(['head'])
 
1254
        self.assertSeenAndResult(expected, search, search.next_with_ghosts)
 
1255
        self.assertRaises(StopIteration, search.next)
 
1256
        self.assertEqual(set(['head', 'ghost', NULL_REVISION]), search.seen)
 
1257
        result = search.get_result()
 
1258
        self.assertEqual(('search', set(['ghost', 'head']), set(['ghost']), 2),
 
1259
            result.get_recipe())
 
1260
        self.assertEqual(set(['head', NULL_REVISION]), result.get_keys())
 
1261
 
 
1262
 
 
1263
class TestFindUniqueAncestors(TestGraphBase):
 
1264
 
 
1265
    def assertFindUniqueAncestors(self, graph, expected, node, common):
 
1266
        actual = graph.find_unique_ancestors(node, common)
 
1267
        self.assertEqual(expected, sorted(actual))
 
1268
 
 
1269
    def test_empty_set(self):
 
1270
        graph = self.make_graph(ancestry_1)
 
1271
        self.assertFindUniqueAncestors(graph, [], 'rev1', ['rev1'])
 
1272
        self.assertFindUniqueAncestors(graph, [], 'rev2b', ['rev2b'])
 
1273
        self.assertFindUniqueAncestors(graph, [], 'rev3', ['rev1', 'rev3'])
 
1274
 
 
1275
    def test_single_node(self):
 
1276
        graph = self.make_graph(ancestry_1)
 
1277
        self.assertFindUniqueAncestors(graph, ['rev2a'], 'rev2a', ['rev1'])
 
1278
        self.assertFindUniqueAncestors(graph, ['rev2b'], 'rev2b', ['rev1'])
 
1279
        self.assertFindUniqueAncestors(graph, ['rev3'], 'rev3', ['rev2a'])
 
1280
 
 
1281
    def test_minimal_ancestry(self):
 
1282
        graph = self.make_breaking_graph(extended_history_shortcut,
 
1283
                                         [NULL_REVISION, 'a', 'b'])
 
1284
        self.assertFindUniqueAncestors(graph, ['e'], 'e', ['d'])
 
1285
 
 
1286
        graph = self.make_breaking_graph(extended_history_shortcut,
 
1287
                                         ['b'])
 
1288
        self.assertFindUniqueAncestors(graph, ['f'], 'f', ['a', 'd'])
 
1289
 
 
1290
        graph = self.make_breaking_graph(complex_shortcut,
 
1291
                                         ['a', 'b'])
 
1292
        self.assertFindUniqueAncestors(graph, ['h'], 'h', ['i'])
 
1293
        self.assertFindUniqueAncestors(graph, ['e', 'g', 'i'], 'i', ['h'])
 
1294
        self.assertFindUniqueAncestors(graph, ['h'], 'h', ['g'])
 
1295
        self.assertFindUniqueAncestors(graph, ['h'], 'h', ['j'])
 
1296
 
 
1297
    def test_in_ancestry(self):
 
1298
        graph = self.make_graph(ancestry_1)
 
1299
        self.assertFindUniqueAncestors(graph, [], 'rev1', ['rev3'])
 
1300
        self.assertFindUniqueAncestors(graph, [], 'rev2b', ['rev4'])
 
1301
 
 
1302
    def test_multiple_revisions(self):
 
1303
        graph = self.make_graph(ancestry_1)
 
1304
        self.assertFindUniqueAncestors(graph,
 
1305
            ['rev4'], 'rev4', ['rev3', 'rev2b'])
 
1306
        self.assertFindUniqueAncestors(graph,
 
1307
            ['rev2a', 'rev3', 'rev4'], 'rev4', ['rev2b'])
 
1308
 
 
1309
    def test_complex_shortcut(self):
 
1310
        graph = self.make_graph(complex_shortcut)
 
1311
        self.assertFindUniqueAncestors(graph,
 
1312
            ['h', 'n'], 'n', ['m'])
 
1313
        self.assertFindUniqueAncestors(graph,
 
1314
            ['e', 'i', 'm'], 'm', ['n'])
 
1315
 
 
1316
    def test_complex_shortcut2(self):
 
1317
        graph = self.make_graph(complex_shortcut2)
 
1318
        self.assertFindUniqueAncestors(graph,
 
1319
            ['j', 'u'], 'u', ['t'])
 
1320
        self.assertFindUniqueAncestors(graph,
 
1321
            ['t'], 't', ['u'])
 
1322
 
 
1323
    def test_multiple_interesting_unique(self):
 
1324
        graph = self.make_graph(multiple_interesting_unique)
 
1325
        self.assertFindUniqueAncestors(graph,
 
1326
            ['j', 'y'], 'y', ['z'])
 
1327
        self.assertFindUniqueAncestors(graph,
 
1328
            ['p', 'z'], 'z', ['y'])
 
1329
 
 
1330
    def test_racing_shortcuts(self):
 
1331
        graph = self.make_graph(racing_shortcuts)
 
1332
        self.assertFindUniqueAncestors(graph,
 
1333
            ['p', 'q', 'z'], 'z', ['y'])
 
1334
        self.assertFindUniqueAncestors(graph,
 
1335
            ['h', 'i', 'j', 'y'], 'j', ['z'])
 
1336
 
 
1337
 
 
1338
class TestGraphFindDistanceToNull(TestGraphBase):
 
1339
    """Test an api that should be able to compute a revno"""
 
1340
 
 
1341
    def assertFindDistance(self, revno, graph, target_id, known_ids):
 
1342
        """Assert the output of Graph.find_distance_to_null()"""
 
1343
        actual = graph.find_distance_to_null(target_id, known_ids)
 
1344
        self.assertEqual(revno, actual)
 
1345
 
 
1346
    def test_nothing_known(self):
 
1347
        graph = self.make_graph(ancestry_1)
 
1348
        self.assertFindDistance(0, graph, NULL_REVISION, [])
 
1349
        self.assertFindDistance(1, graph, 'rev1', [])
 
1350
        self.assertFindDistance(2, graph, 'rev2a', [])
 
1351
        self.assertFindDistance(2, graph, 'rev2b', [])
 
1352
        self.assertFindDistance(3, graph, 'rev3', [])
 
1353
        self.assertFindDistance(4, graph, 'rev4', [])
 
1354
 
 
1355
    def test_rev_is_ghost(self):
 
1356
        graph = self.make_graph(ancestry_1)
 
1357
        e = self.assertRaises(errors.GhostRevisionsHaveNoRevno,
 
1358
                              graph.find_distance_to_null, 'rev_missing', [])
 
1359
        self.assertEqual('rev_missing', e.revision_id)
 
1360
        self.assertEqual('rev_missing', e.ghost_revision_id)
 
1361
 
 
1362
    def test_ancestor_is_ghost(self):
 
1363
        graph = self.make_graph({'rev':['parent']})
 
1364
        e = self.assertRaises(errors.GhostRevisionsHaveNoRevno,
 
1365
                              graph.find_distance_to_null, 'rev', [])
 
1366
        self.assertEqual('rev', e.revision_id)
 
1367
        self.assertEqual('parent', e.ghost_revision_id)
 
1368
 
 
1369
    def test_known_in_ancestry(self):
 
1370
        graph = self.make_graph(ancestry_1)
 
1371
        self.assertFindDistance(2, graph, 'rev2a', [('rev1', 1)])
 
1372
        self.assertFindDistance(3, graph, 'rev3', [('rev2a', 2)])
 
1373
 
 
1374
    def test_known_in_ancestry_limits(self):
 
1375
        graph = self.make_breaking_graph(ancestry_1, ['rev1'])
 
1376
        self.assertFindDistance(4, graph, 'rev4', [('rev3', 3)])
 
1377
 
 
1378
    def test_target_is_ancestor(self):
 
1379
        graph = self.make_graph(ancestry_1)
 
1380
        self.assertFindDistance(2, graph, 'rev2a', [('rev3', 3)])
 
1381
 
 
1382
    def test_target_is_ancestor_limits(self):
 
1383
        """We shouldn't search all history if we run into ourselves"""
 
1384
        graph = self.make_breaking_graph(ancestry_1, ['rev1'])
 
1385
        self.assertFindDistance(3, graph, 'rev3', [('rev4', 4)])
 
1386
 
 
1387
    def test_target_parallel_to_known_limits(self):
 
1388
        # Even though the known revision isn't part of the other ancestry, they
 
1389
        # eventually converge
 
1390
        graph = self.make_breaking_graph(with_tail, ['a'])
 
1391
        self.assertFindDistance(6, graph, 'f', [('g', 6)])
 
1392
        self.assertFindDistance(7, graph, 'h', [('g', 6)])
 
1393
        self.assertFindDistance(8, graph, 'i', [('g', 6)])
 
1394
        self.assertFindDistance(6, graph, 'g', [('i', 8)])
 
1395
 
 
1396
 
 
1397
class TestFindMergeOrder(TestGraphBase):
 
1398
 
 
1399
    def assertMergeOrder(self, expected, graph, tip, base_revisions):
 
1400
        self.assertEqual(expected, graph.find_merge_order(tip, base_revisions))
 
1401
 
 
1402
    def test_parents(self):
 
1403
        graph = self.make_graph(ancestry_1)
 
1404
        self.assertMergeOrder(['rev3', 'rev2b'], graph, 'rev4',
 
1405
                                                        ['rev3', 'rev2b'])
 
1406
        self.assertMergeOrder(['rev3', 'rev2b'], graph, 'rev4',
 
1407
                                                        ['rev2b', 'rev3'])
 
1408
 
 
1409
    def test_ancestors(self):
 
1410
        graph = self.make_graph(ancestry_1)
 
1411
        self.assertMergeOrder(['rev1', 'rev2b'], graph, 'rev4',
 
1412
                                                        ['rev1', 'rev2b'])
 
1413
        self.assertMergeOrder(['rev1', 'rev2b'], graph, 'rev4',
 
1414
                                                        ['rev2b', 'rev1'])
 
1415
 
 
1416
    def test_shortcut_one_ancestor(self):
 
1417
        # When we have enough info, we can stop searching
 
1418
        graph = self.make_breaking_graph(ancestry_1, ['rev3', 'rev2b', 'rev4'])
 
1419
        # Single ancestors shortcut right away
 
1420
        self.assertMergeOrder(['rev3'], graph, 'rev4', ['rev3'])
 
1421
 
 
1422
    def test_shortcut_after_one_ancestor(self):
 
1423
        graph = self.make_breaking_graph(ancestry_1, ['rev2a', 'rev2b'])
 
1424
        self.assertMergeOrder(['rev3', 'rev1'], graph, 'rev4', ['rev1', 'rev3'])
 
1425
 
 
1426
 
 
1427
class TestFindDescendants(TestGraphBase):
 
1428
 
 
1429
    def test_find_descendants_rev1_rev3(self):
 
1430
        graph = self.make_graph(ancestry_1)
 
1431
        descendants = graph.find_descendants('rev1', 'rev3')
 
1432
        self.assertEqual(set(['rev1', 'rev2a', 'rev3']), descendants)
 
1433
 
 
1434
    def test_find_descendants_rev1_rev4(self):
 
1435
        graph = self.make_graph(ancestry_1)
 
1436
        descendants = graph.find_descendants('rev1', 'rev4')
 
1437
        self.assertEqual(set(['rev1', 'rev2a', 'rev2b', 'rev3', 'rev4']),
 
1438
                         descendants)
 
1439
 
 
1440
    def test_find_descendants_rev2a_rev4(self):
 
1441
        graph = self.make_graph(ancestry_1)
 
1442
        descendants = graph.find_descendants('rev2a', 'rev4')
 
1443
        self.assertEqual(set(['rev2a', 'rev3', 'rev4']), descendants)
 
1444
 
 
1445
class TestFindLefthandMerger(TestGraphBase):
 
1446
 
 
1447
    def check_merger(self, result, ancestry, merged, tip):
 
1448
        graph = self.make_graph(ancestry)
 
1449
        self.assertEqual(result, graph.find_lefthand_merger(merged, tip))
 
1450
 
 
1451
    def test_find_lefthand_merger_rev2b(self):
 
1452
        self.check_merger('rev4', ancestry_1, 'rev2b', 'rev4')
 
1453
 
 
1454
    def test_find_lefthand_merger_rev2a(self):
 
1455
        self.check_merger('rev2a', ancestry_1, 'rev2a', 'rev4')
 
1456
 
 
1457
    def test_find_lefthand_merger_rev4(self):
 
1458
        self.check_merger(None, ancestry_1, 'rev4', 'rev2a')
 
1459
 
 
1460
    def test_find_lefthand_merger_f(self):
 
1461
        self.check_merger('i', complex_shortcut, 'f', 'm')
 
1462
 
 
1463
    def test_find_lefthand_merger_g(self):
 
1464
        self.check_merger('i', complex_shortcut, 'g', 'm')
 
1465
 
 
1466
    def test_find_lefthand_merger_h(self):
 
1467
        self.check_merger('n', complex_shortcut, 'h', 'n')
 
1468
 
 
1469
 
 
1470
class TestGetChildMap(TestGraphBase):
 
1471
 
 
1472
    def test_get_child_map(self):
 
1473
        graph = self.make_graph(ancestry_1)
 
1474
        child_map = graph.get_child_map(['rev4', 'rev3', 'rev2a', 'rev2b'])
 
1475
        self.assertEqual({'rev1': ['rev2a', 'rev2b'],
 
1476
                          'rev2a': ['rev3'],
 
1477
                          'rev2b': ['rev4'],
 
1478
                          'rev3': ['rev4']},
 
1479
                          child_map)
 
1480
 
 
1481
 
 
1482
class TestCachingParentsProvider(tests.TestCase):
 
1483
    """These tests run with:
 
1484
 
 
1485
    self.inst_pp, a recording parents provider with a graph of a->b, and b is a
 
1486
    ghost.
 
1487
    self.caching_pp, a CachingParentsProvider layered on inst_pp.
 
1488
    """
 
1489
 
 
1490
    def setUp(self):
 
1491
        super(TestCachingParentsProvider, self).setUp()
 
1492
        dict_pp = _mod_graph.DictParentsProvider({'a':('b',)})
 
1493
        self.inst_pp = InstrumentedParentsProvider(dict_pp)
 
1494
        self.caching_pp = _mod_graph.CachingParentsProvider(self.inst_pp)
 
1495
 
 
1496
    def test_get_parent_map(self):
 
1497
        """Requesting the same revision should be returned from cache"""
 
1498
        self.assertEqual({}, self.caching_pp._cache)
 
1499
        self.assertEqual({'a':('b',)}, self.caching_pp.get_parent_map(['a']))
 
1500
        self.assertEqual(['a'], self.inst_pp.calls)
 
1501
        self.assertEqual({'a':('b',)}, self.caching_pp.get_parent_map(['a']))
 
1502
        # No new call, as it should have been returned from the cache
 
1503
        self.assertEqual(['a'], self.inst_pp.calls)
 
1504
        self.assertEqual({'a':('b',)}, self.caching_pp._cache)
 
1505
 
 
1506
    def test_get_parent_map_not_present(self):
 
1507
        """The cache should also track when a revision doesn't exist"""
 
1508
        self.assertEqual({}, self.caching_pp.get_parent_map(['b']))
 
1509
        self.assertEqual(['b'], self.inst_pp.calls)
 
1510
        self.assertEqual({}, self.caching_pp.get_parent_map(['b']))
 
1511
        # No new calls
 
1512
        self.assertEqual(['b'], self.inst_pp.calls)
 
1513
 
 
1514
    def test_get_parent_map_mixed(self):
 
1515
        """Anything that can be returned from cache, should be"""
 
1516
        self.assertEqual({}, self.caching_pp.get_parent_map(['b']))
 
1517
        self.assertEqual(['b'], self.inst_pp.calls)
 
1518
        self.assertEqual({'a':('b',)},
 
1519
                         self.caching_pp.get_parent_map(['a', 'b']))
 
1520
        self.assertEqual(['b', 'a'], self.inst_pp.calls)
 
1521
 
 
1522
    def test_get_parent_map_repeated(self):
 
1523
        """Asking for the same parent 2x will only forward 1 request."""
 
1524
        self.assertEqual({'a':('b',)},
 
1525
                         self.caching_pp.get_parent_map(['b', 'a', 'b']))
 
1526
        # Use sorted because we don't care about the order, just that each is
 
1527
        # only present 1 time.
 
1528
        self.assertEqual(['a', 'b'], sorted(self.inst_pp.calls))
 
1529
 
 
1530
    def test_note_missing_key(self):
 
1531
        """After noting that a key is missing it is cached."""
 
1532
        self.caching_pp.note_missing_key('b')
 
1533
        self.assertEqual({}, self.caching_pp.get_parent_map(['b']))
 
1534
        self.assertEqual([], self.inst_pp.calls)
 
1535
        self.assertEqual(set(['b']), self.caching_pp.missing_keys)
 
1536
 
 
1537
 
 
1538
class TestCachingParentsProviderExtras(tests.TestCaseWithTransport):
 
1539
    """Test the behaviour when parents are provided that were not requested."""
 
1540
 
 
1541
    def setUp(self):
 
1542
        super(TestCachingParentsProviderExtras, self).setUp()
 
1543
        class ExtraParentsProvider(object):
 
1544
 
 
1545
            def get_parent_map(self, keys):
 
1546
                return {'rev1': [], 'rev2': ['rev1',]}
 
1547
 
 
1548
        self.inst_pp = InstrumentedParentsProvider(ExtraParentsProvider())
 
1549
        self.caching_pp = _mod_graph.CachingParentsProvider(
 
1550
            get_parent_map=self.inst_pp.get_parent_map)
 
1551
 
 
1552
    def test_uncached(self):
 
1553
        self.caching_pp.disable_cache()
 
1554
        self.assertEqual({'rev1': []},
 
1555
                         self.caching_pp.get_parent_map(['rev1']))
 
1556
        self.assertEqual(['rev1'], self.inst_pp.calls)
 
1557
        self.assertIs(None, self.caching_pp._cache)
 
1558
 
 
1559
    def test_cache_initially_empty(self):
 
1560
        self.assertEqual({}, self.caching_pp._cache)
 
1561
 
 
1562
    def test_cached(self):
 
1563
        self.assertEqual({'rev1': []},
 
1564
                         self.caching_pp.get_parent_map(['rev1']))
 
1565
        self.assertEqual(['rev1'], self.inst_pp.calls)
 
1566
        self.assertEqual({'rev1': [], 'rev2': ['rev1']},
 
1567
                         self.caching_pp._cache)
 
1568
        self.assertEqual({'rev1': []},
 
1569
                          self.caching_pp.get_parent_map(['rev1']))
 
1570
        self.assertEqual(['rev1'], self.inst_pp.calls)
 
1571
 
 
1572
    def test_disable_cache_clears_cache(self):
 
1573
        # Put something in the cache
 
1574
        self.caching_pp.get_parent_map(['rev1'])
 
1575
        self.assertEqual(2, len(self.caching_pp._cache))
 
1576
        self.caching_pp.disable_cache()
 
1577
        self.assertIs(None, self.caching_pp._cache)
 
1578
 
 
1579
    def test_enable_cache_raises(self):
 
1580
        e = self.assertRaises(AssertionError, self.caching_pp.enable_cache)
 
1581
        self.assertEqual('Cache enabled when already enabled.', str(e))
 
1582
 
 
1583
    def test_cache_misses(self):
 
1584
        self.caching_pp.get_parent_map(['rev3'])
 
1585
        self.caching_pp.get_parent_map(['rev3'])
 
1586
        self.assertEqual(['rev3'], self.inst_pp.calls)
 
1587
 
 
1588
    def test_no_cache_misses(self):
 
1589
        self.caching_pp.disable_cache()
 
1590
        self.caching_pp.enable_cache(cache_misses=False)
 
1591
        self.caching_pp.get_parent_map(['rev3'])
 
1592
        self.caching_pp.get_parent_map(['rev3'])
 
1593
        self.assertEqual(['rev3', 'rev3'], self.inst_pp.calls)
 
1594
 
 
1595
    def test_cache_extras(self):
 
1596
        self.assertEqual({}, self.caching_pp.get_parent_map(['rev3']))
 
1597
        self.assertEqual({'rev2': ['rev1']},
 
1598
                         self.caching_pp.get_parent_map(['rev2']))
 
1599
        self.assertEqual(['rev3'], self.inst_pp.calls)
 
1600
 
 
1601
 
 
1602
class TestCollapseLinearRegions(tests.TestCase):
 
1603
 
 
1604
    def assertCollapsed(self, collapsed, original):
 
1605
        self.assertEqual(collapsed,
 
1606
                         _mod_graph.collapse_linear_regions(original))
 
1607
 
 
1608
    def test_collapse_nothing(self):
 
1609
        d = {1:[2, 3], 2:[], 3:[]}
 
1610
        self.assertCollapsed(d, d)
 
1611
        d = {1:[2], 2:[3, 4], 3:[5], 4:[5], 5:[]}
 
1612
        self.assertCollapsed(d, d)
 
1613
 
 
1614
    def test_collapse_chain(self):
 
1615
        # Any time we have a linear chain, we should be able to collapse
 
1616
        d = {1:[2], 2:[3], 3:[4], 4:[5], 5:[]}
 
1617
        self.assertCollapsed({1:[5], 5:[]}, d)
 
1618
        d = {5:[4], 4:[3], 3:[2], 2:[1], 1:[]}
 
1619
        self.assertCollapsed({5:[1], 1:[]}, d)
 
1620
        d = {5:[3], 3:[4], 4:[1], 1:[2], 2:[]}
 
1621
        self.assertCollapsed({5:[2], 2:[]}, d)
 
1622
 
 
1623
    def test_collapse_with_multiple_children(self):
 
1624
        #    7
 
1625
        #    |
 
1626
        #    6
 
1627
        #   / \
 
1628
        #  4   5
 
1629
        #  |   |
 
1630
        #  2   3
 
1631
        #   \ /
 
1632
        #    1
 
1633
        #
 
1634
        # 4 and 5 cannot be removed because 6 has 2 children
 
1635
        # 2 and 3 cannot be removed because 1 has 2 parents
 
1636
        d = {1:[2, 3], 2:[4], 4:[6], 3:[5], 5:[6], 6:[7], 7:[]}
 
1637
        self.assertCollapsed(d, d)
 
1638
 
 
1639
 
 
1640
class TestGraphThunkIdsToKeys(tests.TestCase):
 
1641
 
 
1642
    def test_heads(self):
 
1643
        # A
 
1644
        # |\
 
1645
        # B C
 
1646
        # |/
 
1647
        # D
 
1648
        d = {('D',): [('B',), ('C',)], ('C',):[('A',)],
 
1649
             ('B',): [('A',)], ('A',): []}
 
1650
        g = _mod_graph.Graph(_mod_graph.DictParentsProvider(d))
 
1651
        graph_thunk = _mod_graph.GraphThunkIdsToKeys(g)
 
1652
        self.assertEqual(['D'], sorted(graph_thunk.heads(['D', 'A'])))
 
1653
        self.assertEqual(['D'], sorted(graph_thunk.heads(['D', 'B'])))
 
1654
        self.assertEqual(['D'], sorted(graph_thunk.heads(['D', 'C'])))
 
1655
        self.assertEqual(['B', 'C'], sorted(graph_thunk.heads(['B', 'C'])))
 
1656
 
 
1657
    def test_add_node(self):
 
1658
        d = {('C',):[('A',)], ('B',): [('A',)], ('A',): []}
 
1659
        g = _mod_graph.KnownGraph(d)
 
1660
        graph_thunk = _mod_graph.GraphThunkIdsToKeys(g)
 
1661
        graph_thunk.add_node("D", ["A", "C"])
 
1662
        self.assertEqual(['B', 'D'],
 
1663
            sorted(graph_thunk.heads(['D', 'B', 'A'])))
 
1664
 
 
1665
 
 
1666
class TestPendingAncestryResultGetKeys(TestCaseWithMemoryTransport):
 
1667
    """Tests for bzrlib.graph.PendingAncestryResult."""
 
1668
 
 
1669
    def test_get_keys(self):
 
1670
        builder = self.make_branch_builder('b')
 
1671
        builder.start_series()
 
1672
        builder.build_snapshot('rev-1', None, [
 
1673
            ('add', ('', 'root-id', 'directory', ''))])
 
1674
        builder.build_snapshot('rev-2', ['rev-1'], [])
 
1675
        builder.finish_series()
 
1676
        repo = builder.get_branch().repository
 
1677
        repo.lock_read()
 
1678
        self.addCleanup(repo.unlock)
 
1679
        result = _mod_graph.PendingAncestryResult(['rev-2'], repo)
 
1680
        self.assertEqual(set(['rev-1', 'rev-2']), set(result.get_keys()))
 
1681
 
 
1682
    def test_get_keys_excludes_ghosts(self):
 
1683
        builder = self.make_branch_builder('b')
 
1684
        builder.start_series()
 
1685
        builder.build_snapshot('rev-1', None, [
 
1686
            ('add', ('', 'root-id', 'directory', ''))])
 
1687
        builder.build_snapshot('rev-2', ['rev-1', 'ghost'], [])
 
1688
        builder.finish_series()
 
1689
        repo = builder.get_branch().repository
 
1690
        repo.lock_read()
 
1691
        self.addCleanup(repo.unlock)
 
1692
        result = _mod_graph.PendingAncestryResult(['rev-2'], repo)
 
1693
        self.assertEqual(sorted(['rev-1', 'rev-2']), sorted(result.get_keys()))
 
1694
 
 
1695
    def test_get_keys_excludes_null(self):
 
1696
        # Make a 'graph' with an iter_ancestry that returns NULL_REVISION
 
1697
        # somewhere other than the last element, which can happen in real
 
1698
        # ancestries.
 
1699
        class StubGraph(object):
 
1700
            def iter_ancestry(self, keys):
 
1701
                return [(NULL_REVISION, ()), ('foo', (NULL_REVISION,))]
 
1702
        result = _mod_graph.PendingAncestryResult(['rev-3'], None)
 
1703
        result_keys = result._get_keys(StubGraph())
 
1704
        # Only the non-null keys from the ancestry appear.
 
1705
        self.assertEqual(set(['foo']), set(result_keys))
 
1706
 
 
1707
 
 
1708
class TestPendingAncestryResultRefine(TestGraphBase):
 
1709
 
 
1710
    def test_refine(self):
 
1711
        # Used when pulling from a stacked repository, so test some revisions
 
1712
        # being satisfied from the stacking branch.
 
1713
        g = self.make_graph(
 
1714
            {"tip":["mid"], "mid":["base"], "tag":["base"],
 
1715
             "base":[NULL_REVISION], NULL_REVISION:[]})
 
1716
        result = _mod_graph.PendingAncestryResult(['tip', 'tag'], None)
 
1717
        result = result.refine(set(['tip']), set(['mid']))
 
1718
        self.assertEqual(set(['mid', 'tag']), result.heads)
 
1719
        result = result.refine(set(['mid', 'tag', 'base']),
 
1720
            set([NULL_REVISION]))
 
1721
        self.assertEqual(set([NULL_REVISION]), result.heads)
 
1722
        self.assertTrue(result.is_empty())
 
1723
 
 
1724
 
 
1725
class TestSearchResultRefine(TestGraphBase):
 
1726
 
 
1727
    def test_refine(self):
 
1728
        # Used when pulling from a stacked repository, so test some revisions
 
1729
        # being satisfied from the stacking branch.
 
1730
        g = self.make_graph(
 
1731
            {"tip":["mid"], "mid":["base"], "tag":["base"],
 
1732
             "base":[NULL_REVISION], NULL_REVISION:[]})
 
1733
        result = _mod_graph.SearchResult(set(['tip', 'tag']),
 
1734
            set([NULL_REVISION]), 4, set(['tip', 'mid', 'tag', 'base']))
 
1735
        result = result.refine(set(['tip']), set(['mid']))
 
1736
        recipe = result.get_recipe()
 
1737
        # We should be starting from tag (original head) and mid (seen ref)
 
1738
        self.assertEqual(set(['mid', 'tag']), recipe[1])
 
1739
        # We should be stopping at NULL (original stop) and tip (seen head)
 
1740
        self.assertEqual(set([NULL_REVISION, 'tip']), recipe[2])
 
1741
        self.assertEqual(3, recipe[3])
 
1742
        result = result.refine(set(['mid', 'tag', 'base']),
 
1743
            set([NULL_REVISION]))
 
1744
        recipe = result.get_recipe()
 
1745
        # We should be starting from nothing (NULL was known as a cut point)
 
1746
        self.assertEqual(set([]), recipe[1])
 
1747
        # We should be stopping at NULL (original stop) and tip (seen head) and
 
1748
        # tag (seen head) and mid(seen mid-point head). We could come back and
 
1749
        # define this as not including mid, for minimal results, but it is
 
1750
        # still 'correct' to include mid, and simpler/easier.
 
1751
        self.assertEqual(set([NULL_REVISION, 'tip', 'tag', 'mid']), recipe[2])
 
1752
        self.assertEqual(0, recipe[3])
 
1753
        self.assertTrue(result.is_empty())