← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/matchers.py

  • Committer: Robert Collins
  • Date: 2010-05-06 07:48:22 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506074822-0bsgf2j4h8jx0xkk
Added ``bzrlib.tests.matchers`` as a place to put matchers, along with
our first in-tree matcher. See the module docstring for details.
(Robert Collins)

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
    'ReturnsCallableLeavingObjectUnlocked',
 
31
    ]
 
32
 
 
33
from testtools.matchers import Mismatch, Matcher
 
34
 
 
35
 
 
36
class ReturnsCallableLeavingObjectUnlocked(Matcher):
 
37
    """A matcher that checks for the pattern we want lock* methods to have:
 
38
 
 
39
    They should return a callable.
 
40
    Calling that callable should unlock the original object.
 
41
 
 
42
    :ivar lockable_thing: The object which can be locked that will be
 
43
        inspected.
 
44
    """
 
45
 
 
46
    def __init__(self, lockable_thing):
 
47
        Matcher.__init__(self)
 
48
        self.lockable_thing = lockable_thing
 
49
 
 
50
    def __str__(self):
 
51
        return ('ReturnsCallableLeavingObjectUnlocked(lockable_thing=%s)' % 
 
52
            self.lockable_thing)
 
53
 
 
54
    def match(self, lock_method):
 
55
        lock_method()()
 
56
        if self.lockable_thing.is_locked():
 
57
            return _IsLocked(self.lockable_thing)
 
58
        return None
 
59
 
 
60
 
 
61
class _IsLocked(Mismatch):
 
62
    """Something is locked."""
 
63
 
 
64
    def __init__(self, lockable_thing):
 
65
        self.lockable_thing = lockable_thing
 
66
 
 
67
    def describe(self):
 
68
        return "%s is locked" % self.lockable_thing