/brz/remove-bazaar : contents of bzrlib/tests/per_lock/test

: (revision 2364)

To get this branch, use:

bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

# Copyright (C) 2007 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

"""Tests for OS level locks."""

from bzrlib import (
    errors,
    osutils,
    )

from bzrlib.tests.per_lock import TestCaseWithLock


class TestLock(TestCaseWithLock):

    def setUp(self):
        super(TestLock, self).setUp()
        self.build_tree(['a-file'])

    def test_read_lock(self):
        """Smoke test for read locks."""
        a_lock = self.read_lock('a-file')
        self.addCleanup(a_lock.unlock)
        # The lock file should be opened for reading
        txt = a_lock.f.read()
        self.assertEqual('contents of a-file\n', txt)

    def test_create_if_needed_read(self):
        """We will create the file if it doesn't exist yet."""
        a_lock = self.read_lock('other-file')
        self.addCleanup(a_lock.unlock)
        txt = a_lock.f.read()
        self.assertEqual('', txt)

    def test_create_if_needed_write(self):
        """We will create the file if it doesn't exist yet."""
        a_lock = self.write_lock('other-file')
        self.addCleanup(a_lock.unlock)
        txt = a_lock.f.read()
        self.assertEqual('', txt)
        a_lock.f.seek(0)
        a_lock.f.write('foo\n')
        a_lock.f.seek(0)
        txt = a_lock.f.read()
        self.assertEqual('foo\n', txt)

    def test_readonly_file(self):
        """If the file is readonly, we can take a read lock.

        But we shouldn't be able to take a write lock.
        """
        osutils.make_readonly('a-file')
        # Make sure the file is read-only (on all platforms)
        self.assertRaises(IOError, open, 'a-file', 'rb+')
        a_lock = self.read_lock('a-file')
        a_lock.unlock()

        self.assertRaises(errors.ReadOnlyLockError, self.write_lock, 'a-file')

    def test_write_lock(self):
        """Smoke test for write locks."""
        a_lock = self.write_lock('a-file')
        self.addCleanup(a_lock.unlock)
        # You should be able to read and write to the lock file.
        txt = a_lock.f.read()
        self.assertEqual('contents of a-file\n', txt)
        # Win32 requires that you call seek() when switching between a read
        # operation and a write operation.
        a_lock.f.seek(0, 2)
        a_lock.f.write('more content\n')
        a_lock.f.seek(0)
        txt = a_lock.f.read()
        self.assertEqual('contents of a-file\nmore content\n', txt)

    def test_multiple_read_locks(self):
        """You can take out more than one read lock on the same file."""
        a_lock = self.read_lock('a-file')
        self.addCleanup(a_lock.unlock)
        b_lock = self.read_lock('a-file')
        self.addCleanup(b_lock.unlock)

    def test_multiple_write_locks_exclude(self):
        """Taking out more than one write lock should fail."""
        a_lock = self.write_lock('a-file')
        self.addCleanup(a_lock.unlock)
        # Taking out a lock on a locked file should raise LockContention
        self.assertRaises(errors.LockContention, self.write_lock, 'a-file')

    def _disabled_test_read_then_write_excludes(self):
        """If a file is read-locked, taking out a write lock should fail."""
        a_lock = self.read_lock('a-file')
        self.addCleanup(a_lock.unlock)
        # Taking out a lock on a locked file should raise LockContention
        self.assertRaises(errors.LockContention, self.write_lock, 'a-file')

    def _disabled_test_write_then_read_excludes(self):
        """If a file is write-locked, taking out a read lock should fail.

        The file is exclusively owned by the write lock, so we shouldn't be
        able to take out a shared read lock.
        """
        a_lock = self.write_lock('a-file')
        self.addCleanup(a_lock.unlock)
        # Taking out a lock on a locked file should raise LockContention
        self.assertRaises(errors.LockContention, self.read_lock, 'a-file')

2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	1	# Copyright (C) 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	16
	17	"""Tests for OS level locks."""
	18
	19	from bzrlib import (
2353.3.2 by John Arbash Meinel Add a tests that multiple write locks raise the right kind of error.	20	errors,
2353.3.3 by John Arbash Meinel Define an explicit error when trying to grab a write lock on a readonly file.	21	osutils,
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	22	)
	23
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	24	from bzrlib.tests.per_lock import TestCaseWithLock
	25
	26
	27	class TestLock(TestCaseWithLock):
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	28
	29	def setUp(self):
	30	super(TestLock, self).setUp()
	31	self.build_tree(['a-file'])
	32
	33	def test_read_lock(self):
	34	"""Smoke test for read locks."""
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	35	a_lock = self.read_lock('a-file')
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	36	self.addCleanup(a_lock.unlock)
	37	# The lock file should be opened for reading
	38	txt = a_lock.f.read()
	39	self.assertEqual('contents of a-file\n', txt)
	40
	41	def test_create_if_needed_read(self):
	42	"""We will create the file if it doesn't exist yet."""
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	43	a_lock = self.read_lock('other-file')
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	44	self.addCleanup(a_lock.unlock)
	45	txt = a_lock.f.read()
	46	self.assertEqual('', txt)
	47
	48	def test_create_if_needed_write(self):
	49	"""We will create the file if it doesn't exist yet."""
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	50	a_lock = self.write_lock('other-file')
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	51	self.addCleanup(a_lock.unlock)
	52	txt = a_lock.f.read()
	53	self.assertEqual('', txt)
2353.3.13 by John Arbash Meinel Cleanup according to Alexander's review comments.	54	a_lock.f.seek(0)
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	55	a_lock.f.write('foo\n')
	56	a_lock.f.seek(0)
	57	txt = a_lock.f.read()
	58	self.assertEqual('foo\n', txt)
	59
2353.3.3 by John Arbash Meinel Define an explicit error when trying to grab a write lock on a readonly file.	60	def test_readonly_file(self):
	61	"""If the file is readonly, we can take a read lock.
	62
	63	But we shouldn't be able to take a write lock.
	64	"""
	65	osutils.make_readonly('a-file')
	66	# Make sure the file is read-only (on all platforms)
	67	self.assertRaises(IOError, open, 'a-file', 'rb+')
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	68	a_lock = self.read_lock('a-file')
2353.3.3 by John Arbash Meinel Define an explicit error when trying to grab a write lock on a readonly file.	69	a_lock.unlock()
	70
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	71	self.assertRaises(errors.ReadOnlyLockError, self.write_lock, 'a-file')
2353.3.3 by John Arbash Meinel Define an explicit error when trying to grab a write lock on a readonly file.	72
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	73	def test_write_lock(self):
	74	"""Smoke test for write locks."""
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	75	a_lock = self.write_lock('a-file')
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	76	self.addCleanup(a_lock.unlock)
	77	# You should be able to read and write to the lock file.
	78	txt = a_lock.f.read()
	79	self.assertEqual('contents of a-file\n', txt)
2353.3.6 by John Arbash Meinel On Win32 if you have a file opened in read+write mode, you must call seek() when switching	80	# Win32 requires that you call seek() when switching between a read
	81	# operation and a write operation.
	82	a_lock.f.seek(0, 2)
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	83	a_lock.f.write('more content\n')
	84	a_lock.f.seek(0)
	85	txt = a_lock.f.read()
	86	self.assertEqual('contents of a-file\nmore content\n', txt)
	87
	88	def test_multiple_read_locks(self):
	89	"""You can take out more than one read lock on the same file."""
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	90	a_lock = self.read_lock('a-file')
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	91	self.addCleanup(a_lock.unlock)
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	92	b_lock = self.read_lock('a-file')
2353.3.1 by John Arbash Meinel Add some basic locking tests which should currently pass on all platforms.	93	self.addCleanup(b_lock.unlock)
	94
2353.3.2 by John Arbash Meinel Add a tests that multiple write locks raise the right kind of error.	95	def test_multiple_write_locks_exclude(self):
	96	"""Taking out more than one write lock should fail."""
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	97	a_lock = self.write_lock('a-file')
2353.3.2 by John Arbash Meinel Add a tests that multiple write locks raise the right kind of error.	98	self.addCleanup(a_lock.unlock)
	99	# Taking out a lock on a locked file should raise LockContention
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	100	self.assertRaises(errors.LockContention, self.write_lock, 'a-file')
2353.3.3 by John Arbash Meinel Define an explicit error when trying to grab a write lock on a readonly file.	101
	102	def _disabled_test_read_then_write_excludes(self):
	103	"""If a file is read-locked, taking out a write lock should fail."""
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	104	a_lock = self.read_lock('a-file')
2353.3.3 by John Arbash Meinel Define an explicit error when trying to grab a write lock on a readonly file.	105	self.addCleanup(a_lock.unlock)
	106	# Taking out a lock on a locked file should raise LockContention
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	107	self.assertRaises(errors.LockContention, self.write_lock, 'a-file')
2353.3.3 by John Arbash Meinel Define an explicit error when trying to grab a write lock on a readonly file.	108
	109	def _disabled_test_write_then_read_excludes(self):
	110	"""If a file is write-locked, taking out a read lock should fail.
	111
	112	The file is exclusively owned by the write lock, so we shouldn't be
	113	able to take out a shared read lock.
	114	"""
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	115	a_lock = self.write_lock('a-file')
2353.3.3 by John Arbash Meinel Define an explicit error when trying to grab a write lock on a readonly file.	116	self.addCleanup(a_lock.unlock)
	117	# Taking out a lock on a locked file should raise LockContention
2353.3.9 by John Arbash Meinel Update the lock code and test code so that if more than one	118	self.assertRaises(errors.LockContention, self.read_lock, 'a-file')