← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/matchers.py

Fix up inter_changes with dirstate both C and python.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/matchers.py
1
 
# Copyright (C) 2010 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""Matchers for bzrlib.
18
 
 
19
 
Primarily test support, Matchers are used by self.assertThat in the bzrlib
20
 
test suite. A matcher is a stateful test helper which can be used to determine
21
 
if a passed object 'matches', much like a regex. If the object does not match
22
 
the mismatch can be described in a human readable fashion. assertThat then
23
 
raises if a mismatch occurs, showing the description as the assertion error.
24
 
 
25
 
Matchers are designed to be more reusable and composable than layered
26
 
assertions in Test Case objects, so they are recommended for new testing work.
27
 
"""
28
 
 
29
 
__all__ = [
30
 
    'MatchesAncestry',
31
 
    'ReturnsUnlockable',
32
 
    ]
33
 
 
34
 
from bzrlib import (
35
 
    revision as _mod_revision,
36
 
    )
37
 
 
38
 
from testtools.matchers import Mismatch, Matcher
39
 
 
40
 
 
41
 
class ReturnsUnlockable(Matcher):
42
 
    """A matcher that checks for the pattern we want lock* methods to have:
43
 
 
44
 
    They should return an object with an unlock() method.
45
 
    Calling that method should unlock the original object.
46
 
 
47
 
    :ivar lockable_thing: The object which can be locked that will be
48
 
        inspected.
49
 
    """
50
 
 
51
 
    def __init__(self, lockable_thing):
52
 
        Matcher.__init__(self)
53
 
        self.lockable_thing = lockable_thing
54
 
 
55
 
    def __str__(self):
56
 
        return ('ReturnsUnlockable(lockable_thing=%s)' % 
57
 
            self.lockable_thing)
58
 
 
59
 
    def match(self, lock_method):
60
 
        lock_method().unlock()
61
 
        if self.lockable_thing.is_locked():
62
 
            return _IsLocked(self.lockable_thing)
63
 
        return None
64
 
 
65
 
 
66
 
class _IsLocked(Mismatch):
67
 
    """Something is locked."""
68
 
 
69
 
    def __init__(self, lockable_thing):
70
 
        self.lockable_thing = lockable_thing
71
 
 
72
 
    def describe(self):
73
 
        return "%s is locked" % self.lockable_thing
74
 
 
75
 
 
76
 
class _AncestryMismatch(Mismatch):
77
 
    """Ancestry matching mismatch."""
78
 
 
79
 
    def __init__(self, tip_revision, got, expected):
80
 
        self.tip_revision = tip_revision
81
 
        self.got = got
82
 
        self.expected = expected
83
 
 
84
 
    def describe(self):
85
 
        return "mismatched ancestry for revision %r was %r, expected %r" % (
86
 
            self.tip_revision, self.got, self.expected)
87
 
 
88
 
 
89
 
class MatchesAncestry(Matcher):
90
 
    """A matcher that checks the ancestry of a particular revision.
91
 
 
92
 
    :ivar graph: Graph in which to check the ancestry
93
 
    :ivar revision_id: Revision id of the revision
94
 
    """
95
 
 
96
 
    def __init__(self, repository, revision_id):
97
 
        Matcher.__init__(self)
98
 
        self.repository = repository
99
 
        self.revision_id = revision_id
100
 
 
101
 
    def __str__(self):
102
 
        return ('MatchesAncestry(repository=%r, revision_id=%r)' % (
103
 
            self.repository, self.revision_id))
104
 
 
105
 
    def match(self, expected):
106
 
        self.repository.lock_read()
107
 
        try:
108
 
            graph = self.repository.get_graph()
109
 
            got = [r for r, p in graph.iter_ancestry([self.revision_id])]
110
 
            if _mod_revision.NULL_REVISION in got:
111
 
                got.remove(_mod_revision.NULL_REVISION)
112
 
        finally:
113
 
            self.repository.unlock()
114
 
        if sorted(got) != sorted(expected):
115
 
            return _AncestryMismatch(self.revision_id, sorted(got), sorted(expected))