oslo.concurrency/oslo_concurrency/tests/unit/test_lockutils_eventlet.py
Balazs Gibizer ee3f73a133 Fix fair internal lock used from eventlet.spawn_n
The fasteners lib in version 0.15.0 removed the
threading.current_thread workaround for eventlet[1] because eventlet
seemed to fixed the current_thread issues tracked in [2]. However the
fix for [2] only fixed half of the problem. The threading.current_thread
call works if it is called from thread created by eventlet.spawn.
However if the thread is created with eventlet.spawn_n then
threading.current_thread is still broken and returns the ID of the
python native thread.

The fasteners' ReaderWriterLock depends heavily on
threading.current_thread to decide which thread holds a lock and to
allow re-entry of that thread. This leads to the situation that
multiple threads created from spawn_n could take the same
ReaderWriterLock at the same time.

The fair internal lock in oslo.concurrency uses ReaderWriterLock and
as a result such lock is broken for threads created with spawn_n.

Note that this issue was raised with eventlet in [3] when the nova team
detected it via a direct usage of ReaderWriterLock in the nova test
code. As [3] did not lead to a solution in eventlet nova implemented a
nova local fix for the test code in [4].

However now we detected that oslo.concurrency is affected by this issue
as well.

This patch restores the workaround that was removed by [1].

Note that a fasteners issue [5] also opened to restore the
workaround[1].

[1] 467ed75ee1
[2] https://github.com/eventlet/eventlet/issues/172
[3] https://github.com/eventlet/eventlet/issues/731
[4] https://review.opendev.org/c/openstack/nova/+/813114
[5] https://github.com/harlowja/fasteners/issues/96

Closes-Bug: #1988311
Change-Id: Ia873bcc6b07121c9bd0b94c593567d537b4c1112
2022-09-05 13:29:04 +02:00

105 lines
3.3 KiB
Python

# Copyright 2011 Justin Santa Barbara
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import os
import tempfile
import eventlet
from eventlet import greenpool
from oslotest import base as test_base
from oslo_concurrency import lockutils
class TestFileLocks(test_base.BaseTestCase):
def test_concurrent_green_lock_succeeds(self):
"""Verify spawn_n greenthreads with two locks run concurrently."""
tmpdir = tempfile.mkdtemp()
self.completed = False
def locka(wait):
a = lockutils.InterProcessLock(os.path.join(tmpdir, 'a'))
with a:
wait.wait()
self.completed = True
def lockb(wait):
b = lockutils.InterProcessLock(os.path.join(tmpdir, 'b'))
with b:
wait.wait()
wait1 = eventlet.event.Event()
wait2 = eventlet.event.Event()
pool = greenpool.GreenPool()
pool.spawn_n(locka, wait1)
pool.spawn_n(lockb, wait2)
wait2.send()
eventlet.sleep(0)
wait1.send()
pool.waitall()
self.assertTrue(self.completed)
class TestInternalLock(test_base.BaseTestCase):
def _test_internal_lock_with_two_threads(self, fair, spawn):
self.other_started = eventlet.event.Event()
self.other_finished = eventlet.event.Event()
def other():
self.other_started.send('started')
with lockutils.lock("my-lock", fair=fair):
pass
self.other_finished.send('finished')
with lockutils.lock("my-lock", fair=fair):
# holding the lock and starting another thread that also wants to
# take it before finishes
spawn(other)
# let the other thread start
self.other_started.wait()
eventlet.sleep(0)
# the other thread should not have finished as it would need the
# lock we are holding
self.assertIsNone(
self.other_finished.wait(0.5),
"Two threads was able to take the same lock",
)
# we released the lock, let the other thread take it and run to
# completion
result = self.other_finished.wait()
self.assertEqual('finished', result)
def test_lock_with_spawn(self):
self._test_internal_lock_with_two_threads(
fair=False, spawn=eventlet.spawn
)
def test_lock_with_spawn_n(self):
self._test_internal_lock_with_two_threads(
fair=False, spawn=eventlet.spawn_n
)
def test_fair_lock_with_spawn(self):
self._test_internal_lock_with_two_threads(
fair=True, spawn=eventlet.spawn
)
def test_fair_lock_with_spawn_n(self):
self._test_internal_lock_with_two_threads(
fair=True, spawn=eventlet.spawn_n
)