~bzr-pqm/bzr/bzr.dev : contents of bzrlib/tests/test_counted

~bzr-pqm/bzr/bzr.dev : (revision 6615)

# Copyright (C) 2007, 2008, 2009, 2016 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""Tests for bzrlib.counted_lock"""

from bzrlib.counted_lock import CountedLock
from bzrlib.errors import (
    LockError,
    LockNotHeld,
    ReadOnlyError,
    TokenMismatch,
    )
from bzrlib.tests import TestCase


class DummyLock(object):
    """Lock that just records what's been done to it."""

    def __init__(self):
        self._calls = []
        self._lock_mode = None

    def is_locked(self):
        return self._lock_mode is not None

    def lock_read(self):
        self._assert_not_locked()
        self._lock_mode = 'r'
        self._calls.append('lock_read')

    def lock_write(self, token=None):
        if token is not None:
            if token == 'token':
                # already held by this caller
                return 'token'
            else:
                raise TokenMismatch()
        self._assert_not_locked()
        self._lock_mode = 'w'
        self._calls.append('lock_write')
        return 'token'

    def unlock(self):
        self._assert_locked()
        self._lock_mode = None
        self._calls.append('unlock')

    def break_lock(self):
        self._lock_mode = None
        self._calls.append('break')

    def _assert_locked(self):
        if not self._lock_mode:
            raise LockError("%s is not locked" % (self,))

    def _assert_not_locked(self):
        if self._lock_mode:
            raise LockError("%s is already locked in mode %r" %
                (self, self._lock_mode))

    def validate_token(self, token):
        if token == 'token':
            # already held by this caller
            return 'token'
        elif token is None:
            return
        else:
            raise TokenMismatch(token, 'token')


class TestDummyLock(TestCase):

    def test_lock_initially_not_held(self):
        l = DummyLock()
        self.assertFalse(l.is_locked())

    def test_lock_not_reentrant(self):
        # can't take the underlying lock twice
        l = DummyLock()
        l.lock_read()
        self.assertRaises(LockError, l.lock_read)

    def test_detect_underlock(self):
        l = DummyLock()
        self.assertRaises(LockError, l.unlock)

    def test_basic_locking(self):
        # dummy lock works like a basic non reentrant lock
        real_lock = DummyLock()
        self.assertFalse(real_lock.is_locked())
        # lock read and unlock
        real_lock.lock_read()
        self.assertTrue(real_lock.is_locked())
        real_lock.unlock()
        self.assertFalse(real_lock.is_locked())
        # lock write and unlock
        result = real_lock.lock_write()
        self.assertEqual('token', result)
        self.assertTrue(real_lock.is_locked())
        real_lock.unlock()
        self.assertFalse(real_lock.is_locked())
        # check calls
        self.assertEqual(
            ['lock_read', 'unlock', 'lock_write', 'unlock'],
            real_lock._calls)

    def test_break_lock(self):
        l = DummyLock()
        l.lock_write()
        l.break_lock()
        self.assertFalse(l.is_locked())
        self.assertEqual(
            ['lock_write', 'break'],
            l._calls)


class TestCountedLock(TestCase):

    def test_read_lock(self):
        # Lock and unlock a counted lock
        real_lock = DummyLock()
        l = CountedLock(real_lock)
        self.assertFalse(l.is_locked())
        # can lock twice, although this isn't allowed on the underlying lock
        l.lock_read()
        l.lock_read()
        self.assertTrue(l.is_locked())
        # and release
        l.unlock()
        self.assertTrue(l.is_locked())
        l.unlock()
        self.assertFalse(l.is_locked())
        self.assertEqual(
            ['lock_read', 'unlock'],
            real_lock._calls)

    def test_unlock_not_locked(self):
        real_lock = DummyLock()
        l = CountedLock(real_lock)
        self.assertRaises(LockNotHeld, l.unlock)

    def test_read_lock_while_write_locked(self):
        real_lock = DummyLock()
        l = CountedLock(real_lock)
        l.lock_write()
        l.lock_read()
        self.assertEqual('token', l.lock_write())
        l.unlock()
        l.unlock()
        l.unlock()
        self.assertFalse(l.is_locked())
        self.assertEqual(
            ['lock_write', 'unlock'],
            real_lock._calls)

    def test_write_lock_while_read_locked(self):
        real_lock = DummyLock()
        l = CountedLock(real_lock)
        l.lock_read()
        self.assertRaises(ReadOnlyError, l.lock_write)
        self.assertRaises(ReadOnlyError, l.lock_write)
        l.unlock()
        self.assertFalse(l.is_locked())
        self.assertEqual(
            ['lock_read', 'unlock'],
            real_lock._calls)

    def test_write_lock_reentrant(self):
        real_lock = DummyLock()
        l = CountedLock(real_lock)
        self.assertEqual('token', l.lock_write())
        self.assertEqual('token', l.lock_write())
        l.unlock()
        l.unlock()

    def test_reenter_with_token(self):
        real_lock = DummyLock()
        l1 = CountedLock(real_lock)
        l2 = CountedLock(real_lock)
        token = l1.lock_write()
        self.assertEqual('token', token)
        # now imagine that we lost that connection, but we still have the
        # token...
        del l1
        # because we can supply the token, we can acquire the lock through
        # another instance
        self.assertTrue(real_lock.is_locked())
        self.assertFalse(l2.is_locked())
        self.assertEqual(token, l2.lock_write(token=token))
        self.assertTrue(l2.is_locked())
        self.assertTrue(real_lock.is_locked())
        l2.unlock()
        self.assertFalse(l2.is_locked())
        self.assertFalse(real_lock.is_locked())

    def test_break_lock(self):
        real_lock = DummyLock()
        l = CountedLock(real_lock)
        l.lock_write()
        l.lock_write()
        self.assertTrue(real_lock.is_locked())
        l.break_lock()
        self.assertFalse(l.is_locked())
        self.assertFalse(real_lock.is_locked())

    # TODO: test get_physical_lock_status

6614.1.3 by Vincent Ladeuil Fix assertEquals being deprecated by using assertEqual.	1	# Copyright (C) 2007, 2008, 2009, 2016 Canonical Ltd
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	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
4183.7.1 by Sabin Iacob update FSF mailing address	15	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	16
	17	"""Tests for bzrlib.counted_lock"""
	18
	19	from bzrlib.counted_lock import CountedLock
	20	from bzrlib.errors import (
	21	LockError,
3474.1.2 by Martin Pool CountedLock.unlock should raise LockNotHeld if appropriate	22	LockNotHeld,
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	23	ReadOnlyError,
3474.1.2 by Martin Pool CountedLock.unlock should raise LockNotHeld if appropriate	24	TokenMismatch,
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	25	)
	26	from bzrlib.tests import TestCase
	27
	28
	29	class DummyLock(object):
	30	"""Lock that just records what's been done to it."""
	31
	32	def __init__(self):
	33	self._calls = []
	34	self._lock_mode = None
	35
	36	def is_locked(self):
	37	return self._lock_mode is not None
	38
	39	def lock_read(self):
	40	self._assert_not_locked()
	41	self._lock_mode = 'r'
	42	self._calls.append('lock_read')
	43
3407.2.20 by Martin Pool Add lock token support to CountedLock	44	def lock_write(self, token=None):
	45	if token is not None:
	46	if token == 'token':
	47	# already held by this caller
	48	return 'token'
	49	else:
3468.3.2 by Martin Pool merge trunk	50	raise TokenMismatch()
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	51	self._assert_not_locked()
	52	self._lock_mode = 'w'
	53	self._calls.append('lock_write')
3407.2.19 by Martin Pool CountedLock should manage lock tokens	54	return 'token'
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	55
	56	def unlock(self):
	57	self._assert_locked()
	58	self._lock_mode = None
	59	self._calls.append('unlock')
	60
	61	def break_lock(self):
	62	self._lock_mode = None
	63	self._calls.append('break')
	64
	65	def _assert_locked(self):
	66	if not self._lock_mode:
	67	raise LockError("%s is not locked" % (self,))
	68
	69	def _assert_not_locked(self):
	70	if self._lock_mode:
	71	raise LockError("%s is already locked in mode %r" %
	72	(self, self._lock_mode))
	73
3474.1.2 by Martin Pool CountedLock.unlock should raise LockNotHeld if appropriate	74	def validate_token(self, token):
	75	if token == 'token':
	76	# already held by this caller
	77	return 'token'
3474.1.3 by Martin Pool CountedLock now handles and tests lock tokens	78	elif token is None:
	79	return
3474.1.2 by Martin Pool CountedLock.unlock should raise LockNotHeld if appropriate	80	else:
	81	raise TokenMismatch(token, 'token')
	82
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	83
	84	class TestDummyLock(TestCase):
	85
	86	def test_lock_initially_not_held(self):
	87	l = DummyLock()
	88	self.assertFalse(l.is_locked())
	89
	90	def test_lock_not_reentrant(self):
	91	# can't take the underlying lock twice
	92	l = DummyLock()
	93	l.lock_read()
	94	self.assertRaises(LockError, l.lock_read)
	95
	96	def test_detect_underlock(self):
	97	l = DummyLock()
	98	self.assertRaises(LockError, l.unlock)
	99
	100	def test_basic_locking(self):
	101	# dummy lock works like a basic non reentrant lock
	102	real_lock = DummyLock()
	103	self.assertFalse(real_lock.is_locked())
	104	# lock read and unlock
	105	real_lock.lock_read()
	106	self.assertTrue(real_lock.is_locked())
	107	real_lock.unlock()
	108	self.assertFalse(real_lock.is_locked())
	109	# lock write and unlock
3407.2.19 by Martin Pool CountedLock should manage lock tokens	110	result = real_lock.lock_write()
	111	self.assertEqual('token', result)
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	112	self.assertTrue(real_lock.is_locked())
	113	real_lock.unlock()
	114	self.assertFalse(real_lock.is_locked())
	115	# check calls
	116	self.assertEqual(
	117	['lock_read', 'unlock', 'lock_write', 'unlock'],
	118	real_lock._calls)
	119
	120	def test_break_lock(self):
	121	l = DummyLock()
	122	l.lock_write()
	123	l.break_lock()
	124	self.assertFalse(l.is_locked())
	125	self.assertEqual(
	126	['lock_write', 'break'],
	127	l._calls)
	128
	129
	130	class TestCountedLock(TestCase):
	131
3407.2.19 by Martin Pool CountedLock should manage lock tokens	132	def test_read_lock(self):
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	133	# Lock and unlock a counted lock
	134	real_lock = DummyLock()
	135	l = CountedLock(real_lock)
	136	self.assertFalse(l.is_locked())
	137	# can lock twice, although this isn't allowed on the underlying lock
	138	l.lock_read()
	139	l.lock_read()
	140	self.assertTrue(l.is_locked())
	141	# and release
	142	l.unlock()
	143	self.assertTrue(l.is_locked())
	144	l.unlock()
	145	self.assertFalse(l.is_locked())
6614.1.3 by Vincent Ladeuil Fix assertEquals being deprecated by using assertEqual.	146	self.assertEqual(
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	147	['lock_read', 'unlock'],
	148	real_lock._calls)
	149
	150	def test_unlock_not_locked(self):
	151	real_lock = DummyLock()
	152	l = CountedLock(real_lock)
3474.1.2 by Martin Pool CountedLock.unlock should raise LockNotHeld if appropriate	153	self.assertRaises(LockNotHeld, l.unlock)
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	154
	155	def test_read_lock_while_write_locked(self):
	156	real_lock = DummyLock()
	157	l = CountedLock(real_lock)
	158	l.lock_write()
	159	l.lock_read()
6614.1.3 by Vincent Ladeuil Fix assertEquals being deprecated by using assertEqual.	160	self.assertEqual('token', l.lock_write())
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	161	l.unlock()
	162	l.unlock()
	163	l.unlock()
	164	self.assertFalse(l.is_locked())
6614.1.3 by Vincent Ladeuil Fix assertEquals being deprecated by using assertEqual.	165	self.assertEqual(
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	166	['lock_write', 'unlock'],
	167	real_lock._calls)
	168
	169	def test_write_lock_while_read_locked(self):
	170	real_lock = DummyLock()
	171	l = CountedLock(real_lock)
	172	l.lock_read()
	173	self.assertRaises(ReadOnlyError, l.lock_write)
	174	self.assertRaises(ReadOnlyError, l.lock_write)
	175	l.unlock()
	176	self.assertFalse(l.is_locked())
6614.1.3 by Vincent Ladeuil Fix assertEquals being deprecated by using assertEqual.	177	self.assertEqual(
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	178	['lock_read', 'unlock'],
	179	real_lock._calls)
	180
3407.2.19 by Martin Pool CountedLock should manage lock tokens	181	def test_write_lock_reentrant(self):
	182	real_lock = DummyLock()
	183	l = CountedLock(real_lock)
	184	self.assertEqual('token', l.lock_write())
	185	self.assertEqual('token', l.lock_write())
	186	l.unlock()
	187	l.unlock()
	188
3407.2.20 by Martin Pool Add lock token support to CountedLock	189	def test_reenter_with_token(self):
	190	real_lock = DummyLock()
	191	l1 = CountedLock(real_lock)
	192	l2 = CountedLock(real_lock)
	193	token = l1.lock_write()
	194	self.assertEqual('token', token)
	195	# now imagine that we lost that connection, but we still have the
	196	# token...
	197	del l1
	198	# because we can supply the token, we can acquire the lock through
	199	# another instance
	200	self.assertTrue(real_lock.is_locked())
	201	self.assertFalse(l2.is_locked())
	202	self.assertEqual(token, l2.lock_write(token=token))
	203	self.assertTrue(l2.is_locked())
	204	self.assertTrue(real_lock.is_locked())
	205	l2.unlock()
	206	self.assertFalse(l2.is_locked())
	207	self.assertFalse(real_lock.is_locked())
	208
2475.4.1 by Martin Pool Start adding CountedLock class to partially replace LockableFiles	209	def test_break_lock(self):
	210	real_lock = DummyLock()
	211	l = CountedLock(real_lock)
	212	l.lock_write()
	213	l.lock_write()
	214	self.assertTrue(real_lock.is_locked())
	215	l.break_lock()
	216	self.assertFalse(l.is_locked())
	217	self.assertFalse(real_lock.is_locked())
4570.3.5 by Martin Pool Add CountedLock.get_physical_lock_status	218
	219	# TODO: test get_physical_lock_status