~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_graph.py

  • Committer: Patch Queue Manager
  • Date: 2012-09-17 11:14:25 UTC
  • mfrom: (6554.1.1 stack-remove-unknown)
  • Revision ID: pqm@pqm.ubuntu.com-20120917111425-4i6r0ze0v9zm33bu
(vila) Fix obscure and misleading warning when trying to delete an unknown
 config option. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

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