1
# Copyright (C) 2010 Canonical Ltd
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.
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.
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
17
"""Matchers for breezy.
19
Primarily test support, Matchers are used by self.assertThat in the breezy
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.
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.
35
'RevisionHistoryMatches',
40
revision as _mod_revision,
42
from .. import lazy_import
43
lazy_import.lazy_import(globals(),
45
from breezy.bzr.smart.request import request_handlers as smart_request_handlers
46
from breezy.bzr.smart import vfs
48
from ..tree import find_previous_path
50
from testtools.matchers import Equals, Mismatch, Matcher
53
class ReturnsUnlockable(Matcher):
54
"""A matcher that checks for the pattern we want lock* methods to have:
56
They should return an object with an unlock() method.
57
Calling that method should unlock the original object.
59
:ivar lockable_thing: The object which can be locked that will be
63
def __init__(self, lockable_thing):
64
Matcher.__init__(self)
65
self.lockable_thing = lockable_thing
68
return ('ReturnsUnlockable(lockable_thing=%s)' %
71
def match(self, lock_method):
72
lock_method().unlock()
73
if self.lockable_thing.is_locked():
74
return _IsLocked(self.lockable_thing)
78
class _IsLocked(Mismatch):
79
"""Something is locked."""
81
def __init__(self, lockable_thing):
82
self.lockable_thing = lockable_thing
85
return "%s is locked" % self.lockable_thing
88
class _AncestryMismatch(Mismatch):
89
"""Ancestry matching mismatch."""
91
def __init__(self, tip_revision, got, expected):
92
self.tip_revision = tip_revision
94
self.expected = expected
97
return "mismatched ancestry for revision %r was %r, expected %r" % (
98
self.tip_revision, self.got, self.expected)
101
class MatchesAncestry(Matcher):
102
"""A matcher that checks the ancestry of a particular revision.
104
:ivar graph: Graph in which to check the ancestry
105
:ivar revision_id: Revision id of the revision
108
def __init__(self, repository, revision_id):
109
Matcher.__init__(self)
110
self.repository = repository
111
self.revision_id = revision_id
114
return ('MatchesAncestry(repository=%r, revision_id=%r)' % (
115
self.repository, self.revision_id))
117
def match(self, expected):
118
with self.repository.lock_read():
119
graph = self.repository.get_graph()
120
got = [r for r, p in graph.iter_ancestry([self.revision_id])]
121
if _mod_revision.NULL_REVISION in got:
122
got.remove(_mod_revision.NULL_REVISION)
123
if sorted(got) != sorted(expected):
124
return _AncestryMismatch(self.revision_id, sorted(got),
128
class HasLayout(Matcher):
129
"""A matcher that checks if a tree has a specific layout.
131
:ivar entries: List of expected entries, as (path, file_id) pairs.
134
def __init__(self, entries):
135
Matcher.__init__(self)
136
self.entries = entries
138
def get_tree_layout(self, tree, include_file_ids):
139
"""Get the (path, file_id) pairs for the current tree."""
140
with tree.lock_read():
141
for path, ie in tree.iter_entries_by_dir():
143
path += ie.kind_character()
145
yield (path, ie.file_id)
150
def _strip_unreferenced_directories(entries):
151
"""Strip all directories that don't (in)directly contain any files.
153
:param entries: List of path strings or (path, ie) tuples to process
156
for entry in entries:
157
if isinstance(entry, str):
161
if not path or path[-1] == "/":
163
directories.append((path, entry))
165
# Yield the referenced parent directories
166
for dirpath, direntry in directories:
167
if osutils.is_inside(dirpath, path):
173
return 'HasLayout(%r)' % self.entries
175
def match(self, tree):
176
include_file_ids = self.entries and not isinstance(
177
self.entries[0], str)
178
actual = list(self.get_tree_layout(
179
tree, include_file_ids=include_file_ids))
180
if not tree.has_versioned_directories():
181
entries = list(self._strip_unreferenced_directories(self.entries))
183
entries = self.entries
184
return Equals(entries).match(actual)
187
class HasPathRelations(Matcher):
188
"""Matcher verifies that paths have a relation to those in another tree.
190
:ivar previous_tree: tree to compare to
191
:ivar previous_entries: List of expected entries, as (path, previous_path) pairs.
194
def __init__(self, previous_tree, previous_entries):
195
Matcher.__init__(self)
196
self.previous_tree = previous_tree
197
self.previous_entries = previous_entries
199
def get_path_map(self, tree):
200
"""Get the (path, previous_path) pairs for the current tree."""
201
with tree.lock_read(), self.previous_tree.lock_read():
202
for path, ie in tree.iter_entries_by_dir():
203
if tree.supports_rename_tracking():
204
previous_path = find_previous_path(
205
tree, self.previous_tree, path)
207
if self.previous_tree.is_versioned(path):
212
kind = self.previous_tree.kind(previous_path)
213
if kind == 'directory':
216
yield (u"", previous_path)
218
yield (path + ie.kind_character(), previous_path)
221
def _strip_unreferenced_directories(entries):
222
"""Strip all directories that don't (in)directly contain any files.
224
:param entries: List of path strings or (path, previous_path) tuples to process
226
directory_used = set()
228
for (path, previous_path) in entries:
229
if not path or path[-1] == "/":
231
directories.append((path, previous_path))
233
# Yield the referenced parent directories
234
for direntry in directories:
235
if osutils.is_inside(direntry[0], path):
236
directory_used.add(direntry[0])
237
for (path, previous_path) in entries:
238
if (not path.endswith("/")) or path in directory_used:
239
yield (path, previous_path)
242
return 'HasPathRelations(%r, %r)' % (self.previous_tree, self.previous_entries)
244
def match(self, tree):
245
actual = list(self.get_path_map(tree))
246
if not tree.has_versioned_directories():
247
entries = list(self._strip_unreferenced_directories(
248
self.previous_entries))
250
entries = self.previous_entries
251
if not tree.supports_rename_tracking():
253
(path, path if self.previous_tree.is_versioned(path) else None)
254
for (path, previous_path) in entries]
255
return Equals(entries).match(actual)
258
class RevisionHistoryMatches(Matcher):
259
"""A matcher that checks if a branch has a specific revision history.
261
:ivar history: Revision history, as list of revisions. Oldest first.
264
def __init__(self, history):
265
Matcher.__init__(self)
266
self.expected = history
269
return 'RevisionHistoryMatches(%r)' % self.expected
271
def match(self, branch):
272
with branch.lock_read():
273
graph = branch.repository.get_graph()
274
history = list(graph.iter_lefthand_ancestry(
275
branch.last_revision(), [_mod_revision.NULL_REVISION]))
277
return Equals(self.expected).match(history)
280
class _NoVfsCallsMismatch(Mismatch):
281
"""Mismatch describing a list of HPSS calls which includes VFS requests."""
283
def __init__(self, vfs_calls):
284
self.vfs_calls = vfs_calls
287
return "no VFS calls expected, got: %s" % ",".join([
288
"%s(%s)" % (c.method,
289
", ".join([repr(a) for a in c.args])) for c in self.vfs_calls])
292
class ContainsNoVfsCalls(Matcher):
293
"""Ensure that none of the specified calls are HPSS calls."""
296
return 'ContainsNoVfsCalls()'
299
def match(cls, hpss_calls):
301
for call in hpss_calls:
303
request_method = smart_request_handlers.get(call.call.method)
305
# A method we don't know about doesn't count as a VFS method.
307
if issubclass(request_method, vfs.VfsRequest):
308
vfs_calls.append(call.call)
309
if len(vfs_calls) == 0:
311
return _NoVfsCallsMismatch(vfs_calls)
added
removed
breezy/tests/matchers.py
