aodh/aodh/tests/db.py

254 lines
8.4 KiB
Python

#
# Copyright 2012 New Dream Network, LLC (DreamHost)
# Copyright 2013 eNovance
#
# 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.
"""Base classes for API tests."""
import os
import uuid
import warnings
import fixtures
import mock
from oslo_config import fixture as fixture_config
from oslotest import mockpatch
import six
from six.moves.urllib import parse as urlparse
import sqlalchemy
import testscenarios.testcase
from testtools import testcase
from aodh import storage
from aodh.tests import base as test_base
try:
from aodh.tests import mocks
except ImportError:
mocks = None # happybase module is not Python 3 compatible yet
class MongoDbManager(fixtures.Fixture):
def __init__(self, conf):
self.conf = conf
def setUp(self):
super(MongoDbManager, self).setUp()
with warnings.catch_warnings():
warnings.filterwarnings(
action='ignore',
message='.*you must provide a username and password.*')
self.conf.set_override("connection",
'%(url)s_%(db)s' % {
'url': self.conf.database.connection,
'db': uuid.uuid4().hex,
}, "database")
try:
self.alarm_connection = storage.get_connection_from_config(
self.conf)
except storage.StorageBadVersion as e:
raise testcase.TestSkipped(six.text_type(e))
class SQLManager(fixtures.Fixture):
def __init__(self, conf):
self.conf = conf
db_name = 'aodh_%s' % uuid.uuid4().hex
self._engine = sqlalchemy.create_engine(conf.database.connection)
self._conn = self._engine.connect()
self._create_db(self._conn, db_name)
self.url = conf.database.connection.replace(
self.url_dbname_placeholder, db_name)
self.conf.set_override("connection", self.url, "database")
self._conn.close()
self._engine.dispose()
def setUp(self):
super(SQLManager, self).setUp()
self.alarm_connection = storage.get_connection_from_config(self.conf)
class PgSQLManager(SQLManager):
url_dbname_placeholder = 'template1'
@staticmethod
def _create_db(conn, db_name):
conn.connection.set_isolation_level(0)
conn.execute('CREATE DATABASE %s WITH TEMPLATE template0;' % db_name)
conn.connection.set_isolation_level(1)
class MySQLManager(SQLManager):
url_dbname_placeholder = 'test'
@staticmethod
def _create_db(conn, db_name):
conn.execute('CREATE DATABASE %s;' % db_name)
class HBaseManager(fixtures.Fixture):
def __init__(self, conf):
self.conf = conf
def setUp(self):
super(HBaseManager, self).setUp()
self.alarm_connection = storage.get_connection_from_config(self.conf)
# Unique prefix for each test to keep data is distinguished because
# all test data is stored in one table
data_prefix = str(uuid.uuid4().hex)
def table(conn, name):
return mocks.MockHBaseTable(name, conn, data_prefix)
# Mock only real HBase connection, MConnection "table" method
# stays origin.
mock.patch('happybase.Connection.table', new=table).start()
# We shouldn't delete data and tables after each test,
# because it last for too long.
# All tests tables will be deleted in setup-test-env.sh
mock.patch("happybase.Connection.disable_table",
new=mock.MagicMock()).start()
mock.patch("happybase.Connection.delete_table",
new=mock.MagicMock()).start()
mock.patch("happybase.Connection.create_table",
new=mock.MagicMock()).start()
@property
def url(self):
return '%s?table_prefix=%s' % (
self._url,
os.getenv("AODH_TEST_HBASE_TABLE_PREFIX", "test")
)
class SQLiteManager(fixtures.Fixture):
def __init__(self, conf):
self.conf = conf
def setUp(self):
super(SQLiteManager, self).setUp()
self.alarm_connection = storage.get_connection_from_config(self.conf)
class TestBase(testscenarios.testcase.WithScenarios, test_base.BaseTestCase):
DRIVER_MANAGERS = {
'mongodb': MongoDbManager,
'mysql': MySQLManager,
'postgresql': PgSQLManager,
'db2': MongoDbManager,
'sqlite': SQLiteManager,
}
if mocks is not None:
DRIVER_MANAGERS['hbase'] = HBaseManager
db_url = 'sqlite://' # NOTE(Alexei_987) Set default db url
def setUp(self):
super(TestBase, self).setUp()
engine = urlparse.urlparse(self.db_url).scheme
# NOTE(Alexei_987) Shortcut to skip expensive db setUp
test_method = self._get_test_method()
if (hasattr(test_method, '_run_with')
and engine not in test_method._run_with):
raise testcase.TestSkipped(
'Test is not applicable for %s' % engine)
# FIXME(jd) we need this to be sure ALL options are registered
# This module could be otherwise imported later by something else and
# fail because all options are not registered
import aodh.service # noqa
self.CONF = self.useFixture(fixture_config.Config()).conf
self.CONF([], project='aodh', validate_default_values=True)
self.CONF.set_override('connection', self.db_url, group="database")
try:
self.db_manager = self._get_driver_manager(engine)(self.CONF)
except ValueError as exc:
self.skipTest("missing driver manager: %s" % exc)
self.useFixture(self.db_manager)
self.alarm_conn = self.db_manager.alarm_connection
self.alarm_conn.upgrade()
self.useFixture(mockpatch.Patch(
'aodh.storage.get_connection_from_config',
side_effect=self._get_connection))
def tearDown(self):
self.alarm_conn.clear()
self.alarm_conn = None
super(TestBase, self).tearDown()
def _get_connection(self, conf):
return self.alarm_conn
def _get_driver_manager(self, engine):
manager = self.DRIVER_MANAGERS.get(engine)
if not manager:
raise ValueError('No manager available for %s' % engine)
return manager
def run_with(*drivers):
"""Used to mark tests that are only applicable for certain db driver.
Skips test if driver is not available.
"""
def decorator(test):
if isinstance(test, type) and issubclass(test, TestBase):
# Decorate all test methods
for attr in dir(test):
value = getattr(test, attr)
if callable(value) and attr.startswith('test_'):
if six.PY3:
value._run_with = drivers
else:
value.__func__._run_with = drivers
else:
test._run_with = drivers
return test
return decorator
@six.add_metaclass(test_base.SkipNotImplementedMeta)
class MixinTestsWithBackendScenarios(object):
scenarios = [
('sqlite', {'db_url': 'sqlite://'}),
]
for db in ('MONGODB', 'MYSQL', 'PGSQL', 'HBASE', 'DB2', 'ES'):
if os.environ.get('AODH_TEST_%s_URL' % db):
scenarios.append(
(db.lower(), {'db_url': os.environ.get(
'AODH_TEST_%s_URL' % db)}))
scenarios_db = [db for db, _ in scenarios]
# Insert default value for hbase test
if 'hbase' not in scenarios_db:
scenarios.append(
('hbase', {'db_url': 'hbase://__test__'}))
# Insert default value for db2 test
if 'mongodb' in scenarios_db and 'db2' not in scenarios_db:
scenarios.append(
('db2', {'db_url': os.environ.get('AODH_TEST_MONGODB_URL',
'').replace('mongodb://',
'db2://')}))