← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/lock_helpers.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 02:30:32 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909023032-xz7mkx0u4ppe1yvr
proper Contents panel in bzr-es.chm & bzr-ru.chm

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/lock_helpers.py
 
1
# Copyright (C) 2005, 2006 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
"""Helper functions/classes for testing locking"""
 
18
 
 
19
from bzrlib import errors
 
20
 
 
21
 
 
22
class TestPreventLocking(errors.LockError):
 
23
    """A test exception for forcing locking failure: %(message)s"""
 
24
 
 
25
 
 
26
class LockWrapper(object):
 
27
    """A wrapper which lets us set locking ability.
 
28
 
 
29
    This also lets us record what objects were locked in what order,
 
30
    to ensure that locking happens correctly.
 
31
    """
 
32
 
 
33
    def __init__(self, sequence, other, other_id):
 
34
        """Wrap a locking policy around a given object.
 
35
 
 
36
        :param sequence: A list object where we should record actions
 
37
        :param other: The object to control policy on
 
38
        :param other_id: Something to identify the object by
 
39
        """
 
40
        self.__dict__['_sequence'] = sequence
 
41
        self.__dict__['_other'] = other
 
42
        self.__dict__['_other_id'] = other_id
 
43
        self.__dict__['_allow_write'] = True
 
44
        self.__dict__['_allow_read'] = True
 
45
        self.__dict__['_allow_unlock'] = True
 
46
 
 
47
    def __eq__(self, other):
 
48
        # Branch objects look for controlfiles == repo.controlfiles.
 
49
        if type(other) is LockWrapper:
 
50
            return self._other == other._other
 
51
        return False
 
52
 
 
53
    def __getattr__(self, attr):
 
54
        return getattr(self._other, attr)
 
55
 
 
56
    def __setattr__(self, attr, val):
 
57
        return setattr(self._other, attr, val)
 
58
 
 
59
    def lock_read(self):
 
60
        self._sequence.append((self._other_id, 'lr', self._allow_read))
 
61
        if self._allow_read:
 
62
            return self._other.lock_read()
 
63
        raise TestPreventLocking('lock_read disabled')
 
64
 
 
65
    def lock_write(self, token=None):
 
66
        self._sequence.append((self._other_id, 'lw', self._allow_write))
 
67
        if self._allow_write:
 
68
            return self._other.lock_write()
 
69
        raise TestPreventLocking('lock_write disabled')
 
70
 
 
71
    def unlock(self):
 
72
        self._sequence.append((self._other_id, 'ul', self._allow_unlock))
 
73
        if self._allow_unlock:
 
74
            return self._other.unlock()
 
75
        raise TestPreventLocking('unlock disabled')
 
76
 
 
77
    def disable_lock_read(self):
 
78
        """Make a lock_read call fail"""
 
79
        self.__dict__['_allow_read'] = False
 
80
 
 
81
    def disable_unlock(self):
 
82
        """Make an unlock call fail"""
 
83
        self.__dict__['_allow_unlock'] = False
 
84
 
 
85
    def disable_lock_write(self):
 
86
        """Make a lock_write call fail"""
 
87
        self.__dict__['_allow_write'] = False
 
88
 
 
89