openstacksdk/openstack/tests/unit/cloud/test_task_manager.py

228 lines
6.9 KiB
Python

# Copyright (c) 2015 Hewlett-Packard Development Company, L.P.
#
# 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 concurrent.futures
import fixtures
import mock
import threading
import time
from six.moves import queue
from openstack import task_manager
from openstack.tests.unit import base
class TestException(Exception):
pass
class TaskTest(task_manager.Task):
def main(self):
raise TestException("This is a test exception")
class TaskTestGenerator(task_manager.Task):
def main(self):
yield 1
class TaskTestInt(task_manager.Task):
def main(self):
return int(1)
class TaskTestFloat(task_manager.Task):
def main(self):
return float(2.0)
class TaskTestStr(task_manager.Task):
def main(self):
return "test"
class TaskTestBool(task_manager.Task):
def main(self):
return True
class TaskTestSet(task_manager.Task):
def main(self):
return set([1, 2])
class TestRateTransforms(base.TestCase):
def test_rate_parameter_scalar(self):
manager = task_manager.TaskManager(name='test', rate=0.1234)
self.assertEqual(1 / 0.1234, manager._get_wait('compute'))
self.assertEqual(1 / 0.1234, manager._get_wait(None))
def test_rate_parameter_dict(self):
manager = task_manager.TaskManager(
name='test',
rate={
'compute': 20,
'network': 10,
})
self.assertEqual(1.0 / 20, manager._get_wait('compute'))
self.assertEqual(1.0 / 10, manager._get_wait('network'))
self.assertIsNone(manager._get_wait('object-store'))
class TestTaskManager(base.TestCase):
def setUp(self):
super(TestTaskManager, self).setUp()
self.manager = task_manager.TaskManager(name='test')
self.manager.start()
def test_wait_re_raise(self):
"""Test that Exceptions thrown in a Task is reraised correctly
This test is aimed to six.reraise(), called in Task::wait().
Specifically, we test if we get the same behaviour with all the
configured interpreters (e.g. py27, p35, ...)
"""
self.assertRaises(TestException, self.manager.submit_task, TaskTest())
def test_dont_munchify_int(self):
ret = self.manager.submit_task(TaskTestInt())
self.assertIsInstance(ret, int)
def test_dont_munchify_float(self):
ret = self.manager.submit_task(TaskTestFloat())
self.assertIsInstance(ret, float)
def test_dont_munchify_str(self):
ret = self.manager.submit_task(TaskTestStr())
self.assertIsInstance(ret, str)
def test_dont_munchify_bool(self):
ret = self.manager.submit_task(TaskTestBool())
self.assertIsInstance(ret, bool)
def test_dont_munchify_set(self):
ret = self.manager.submit_task(TaskTestSet())
self.assertIsInstance(ret, set)
@mock.patch.object(concurrent.futures.ThreadPoolExecutor, 'submit')
def test_async(self, mock_submit):
self.manager.submit_function(set, run_async=True)
self.assertTrue(mock_submit.called)
@mock.patch.object(task_manager.TaskManager, 'post_run_task')
@mock.patch.object(task_manager.TaskManager, 'pre_run_task')
def test_pre_post_calls(self, mock_pre, mock_post):
self.manager.submit_function(lambda: None)
mock_pre.assert_called_once()
mock_post.assert_called_once()
@mock.patch.object(task_manager.TaskManager, 'post_run_task')
@mock.patch.object(task_manager.TaskManager, 'pre_run_task')
def test_validate_timing(self, mock_pre, mock_post):
# Note the unit test setup has mocked out time.sleep() and
# done a * 0.0001, and the test should be under the 5
# second timeout. Thus with below, we should see at
# *least* a 1 second pause running the task.
self.manager.submit_function(lambda: time.sleep(10000))
mock_pre.assert_called_once()
mock_post.assert_called_once()
args, kwargs = mock_post.call_args_list[0]
self.assertTrue(args[0] > 1.0)
class ThreadingTaskManager(task_manager.TaskManager):
"""A subclass of TaskManager which exercises the thread-shifting
exception handling behavior."""
def __init__(self, *args, **kw):
super(ThreadingTaskManager, self).__init__(
*args, **kw)
self.queue = queue.Queue()
self._running = True
self._thread = threading.Thread(name=self.name, target=self.run)
self._thread.daemon = True
self.failed = False
def start(self):
self._thread.start()
def stop(self):
self._running = False
self.queue.put(None)
def join(self):
self._thread.join()
def run(self):
# No exception should ever cause this method to hit its
# exception handler.
try:
while True:
task = self.queue.get()
if not task:
if not self._running:
break
continue
self.run_task(task)
self.queue.task_done()
except Exception:
self.failed = True
raise
def submit_task(self, task, raw=False):
# An important part of the exception-shifting feature is that
# this method should raise the exception.
self.queue.put(task)
return task.wait()
class ThreadingTaskManagerFixture(fixtures.Fixture):
def _setUp(self):
self.manager = ThreadingTaskManager(name='threading test')
self.manager.start()
self.addCleanup(self._cleanup)
def _cleanup(self):
self.manager.stop()
self.manager.join()
class TestThreadingTaskManager(base.TestCase):
def setUp(self):
super(TestThreadingTaskManager, self).setUp()
f = self.useFixture(ThreadingTaskManagerFixture())
self.manager = f.manager
def test_wait_re_raise(self):
"""Test that Exceptions thrown in a Task is reraised correctly
This test is aimed to six.reraise(), called in Task::wait().
Specifically, we test if we get the same behaviour with all the
configured interpreters (e.g. py27, p35, ...)
"""
self.assertRaises(TestException, self.manager.submit_task, TaskTest())
# Stop the manager and join the run thread to ensure the
# exception handler has run.
self.manager.stop()
self.manager.join()
self.assertFalse(self.manager.failed)