rally/tests/unit/test.py
Chris St. Pierre 48fb0bdf5f Better mocking for self.[admin_]clients in Scenario tests
self.clients and self.admin_clients are mocked out in all sorts of fun
and interesting ways in the Scenario test cases, but rarely is it done
the same way twice. Many of the tests fail to distinguish between a
call to self.clients and a call to self.admin_clients, and all (or
nearly all) don't distinguish between clients -- that is, if a test
expects a call to self.clients("nova").foo, that would be satisfied by
self.clients("keystone").foo. This patch fixes those issues, and gives
us a consistent way to mock them going forward.

Change-Id: I98a532cedbe186c49bd5b6db903a72e7d1b6bcc7
2015-06-10 11:46:11 -05:00

120 lines
4.1 KiB
Python

# Copyright 2013: Mirantis Inc.
# All Rights Reserved.
#
# 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 mock
from oslo_config import fixture
from oslotest import base
from rally import db
from tests.unit import fakes
class DatabaseFixture(fixture.Config):
"""Create clean DB before starting test."""
def setUp(self):
super(DatabaseFixture, self).setUp()
db_url = os.environ.get("RALLY_UNITTEST_DB_URL", "sqlite://")
db.db_cleanup()
self.conf.set_default("connection", db_url, group="database")
db.db_drop()
db.db_create()
class TestCase(base.BaseTestCase):
"""Test case base class for all unit tests."""
def setUp(self):
super(TestCase, self).setUp()
self.addCleanup(mock.patch.stopall)
def _test_atomic_action_timer(self, atomic_actions, name):
action_duration = atomic_actions.get(name)
self.assertIsNotNone(action_duration)
self.assertIsInstance(action_duration, float)
def assertSequenceEqual(self, iterable_1, iterable_2):
self.assertEqual(tuple(iterable_1), tuple(iterable_2))
class DBTestCase(TestCase):
"""Base class for tests which use DB."""
def setUp(self):
super(DBTestCase, self).setUp()
self.useFixture(DatabaseFixture())
class ClientsTestCase(TestCase):
"""Base class for Scenario tests using mocked self.clients."""
def client_factory(self, client_type, version=None, admin=False):
"""Create a new client object."""
return mock.MagicMock(client_type=client_type,
version=version,
admin=admin)
def clients(self, client_type, version=None, admin=False):
"""Get a mocked client."""
key = (client_type, version, admin)
if key not in self._clients:
self._clients[key] = self.client_factory(client_type,
version=version,
admin=admin)
return self._clients[key]
def admin_clients(self, client_type, version=None):
"""Get a mocked admin client."""
return self.clients(client_type, version=version, admin=True)
def client_created(self, client_type, version=None, admin=False):
"""Determine if a client has been created.
This can be used to see if a scenario calls
'self.clients("foo")', without checking to see what was done
with the client object returned by that call.
"""
key = (client_type, version, admin)
return key in self._clients
def setUp(self):
super(ClientsTestCase, self).setUp()
self._clients = {}
self._client_mocks = [
mock.patch("rally.benchmark.scenarios.base.Scenario.clients",
mock.Mock(side_effect=self.clients)),
mock.patch("rally.benchmark.scenarios.base.Scenario.admin_clients",
mock.Mock(side_effect=self.admin_clients))
]
for patcher in self._client_mocks:
patcher.start()
def tearDown(self):
for patcher in self._client_mocks:
patcher.stop()
super(ClientsTestCase, self).tearDown()
class FakeClientsTestCase(ClientsTestCase):
"""Base class for Scenario tests using fake (not mocked) self.clients."""
def client_factory(self, client_type, version=None, admin=False):
return getattr(self._fake_clients, client_type)()
def setUp(self):
super(FakeClientsTestCase, self).setUp()
self._fake_clients = fakes.FakeClients()