Merge "Refactor the Tuskar storage tests"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
58ab67bfad
@ -57,6 +57,10 @@ class StoredFile(object):
|
||||
self.updated_at = updated_at
|
||||
self.version = version
|
||||
|
||||
def __eq__(self, other):
|
||||
return (isinstance(other, self.__class__)
|
||||
and self.__dict__ == other.__dict__)
|
||||
|
||||
def __str__(self):
|
||||
|
||||
name = " and name {0}".format(self.name) if self.name else ''
|
||||
|
||||
275
tuskar/tests/storage/drivers/base.py
Normal file
275
tuskar/tests/storage/drivers/base.py
Normal file
@ -0,0 +1,275 @@
|
||||
# -*- encoding: utf-8 -*-
|
||||
#
|
||||
# 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.
|
||||
|
||||
from abc import ABCMeta
|
||||
from abc import abstractmethod
|
||||
from datetime import datetime
|
||||
from functools import partial
|
||||
|
||||
from six import add_metaclass
|
||||
|
||||
from tuskar.storage import exceptions
|
||||
from tuskar.storage import stores
|
||||
from tuskar.tests.base import TestCase
|
||||
|
||||
|
||||
@add_metaclass(ABCMeta)
|
||||
class BaseDriverTestCase(TestCase):
|
||||
|
||||
@abstractmethod
|
||||
def _get_driver(self):
|
||||
pass
|
||||
|
||||
def setUp(self):
|
||||
|
||||
super(BaseDriverTestCase, self).setUp()
|
||||
|
||||
self.driver = self._get_driver()
|
||||
self.store = self._get_store(self.driver)
|
||||
|
||||
|
||||
@add_metaclass(ABCMeta)
|
||||
class BaseTestsMixin(object):
|
||||
|
||||
@abstractmethod
|
||||
def _get_store(self, driver):
|
||||
pass
|
||||
|
||||
|
||||
class BaseStoreMixin(BaseTestsMixin):
|
||||
|
||||
def _get_store(self, driver):
|
||||
|
||||
class BaseStore(stores._BaseStore):
|
||||
object_type = "base_object"
|
||||
|
||||
return BaseStore(driver)
|
||||
|
||||
def _create_test_object(self, i=None):
|
||||
return self.store.create("YAML")
|
||||
|
||||
def test_create(self):
|
||||
|
||||
# Test
|
||||
result = self.store.create("YAML")
|
||||
|
||||
# Verify
|
||||
self.assertNotEqual(result.uuid, None)
|
||||
self.assertEqual(result.contents, "YAML")
|
||||
self.assertEqual(result.name, None)
|
||||
self.assertEqual(type(result.created_at), datetime)
|
||||
self.assertEqual(result.updated_at, None)
|
||||
|
||||
def test_version(self):
|
||||
# Test
|
||||
result = self._create_test_object()
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.version, None)
|
||||
|
||||
def test_retrieve(self):
|
||||
|
||||
# Setup
|
||||
created = self._create_test_object()
|
||||
|
||||
# Test
|
||||
result = self.store.retrieve(created.uuid)
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.uuid, created.uuid)
|
||||
self.assertEqual(result.contents, created.contents)
|
||||
self.assertEqual(result.name, created.name)
|
||||
self.assertEqual(result.created_at, created.created_at)
|
||||
self.assertEqual(result.updated_at, created.updated_at)
|
||||
self.assertEqual(result.version, created.version)
|
||||
self.assertEqual(result, created)
|
||||
|
||||
def test_update(self):
|
||||
|
||||
# Setup
|
||||
created = self._create_test_object()
|
||||
|
||||
# Test
|
||||
result = self.store.update(created.uuid, "YAML 2")
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.uuid, created.uuid)
|
||||
self.assertEqual(result.contents, "YAML 2")
|
||||
self.assertEqual(result.name, created.name)
|
||||
self.assertEqual(result.created_at, created.created_at)
|
||||
self.assertEqual(type(result.updated_at), datetime)
|
||||
self.assertEqual(result.version, created.version)
|
||||
|
||||
def test_delete(self):
|
||||
|
||||
# Setup
|
||||
created = self._create_test_object()
|
||||
|
||||
# Test
|
||||
result = self.store.delete(created.uuid)
|
||||
|
||||
# Verify
|
||||
self.assertEqual(None, result)
|
||||
retrieve_call = partial(self.store.retrieve, created.uuid)
|
||||
self.assertRaises(exceptions.UnknownUUID, retrieve_call)
|
||||
|
||||
def test_list(self):
|
||||
|
||||
# Setup
|
||||
created_files = [self._create_test_object(i) for i in range(5)]
|
||||
|
||||
# Test
|
||||
listed_files = self.store.list()
|
||||
|
||||
# Verify
|
||||
self.assertEqual(5, len(listed_files))
|
||||
self.assertEqual(created_files, listed_files)
|
||||
|
||||
|
||||
class NamedStoreMixin(BaseStoreMixin):
|
||||
|
||||
def _get_store(self, driver):
|
||||
|
||||
class NamedStore(stores._NamedStore):
|
||||
object_type = "named_object"
|
||||
|
||||
return NamedStore(driver)
|
||||
|
||||
def _create_test_object(self, i=None):
|
||||
suffix = '' if i is None else " {0}".format(i)
|
||||
return self.store.create("NAME{0}".format(suffix), "YAML")
|
||||
|
||||
def test_create(self):
|
||||
|
||||
# Test
|
||||
result = self.store.create("NAME", "YAML")
|
||||
|
||||
# Verify
|
||||
self.assertNotEqual(result.uuid, None)
|
||||
self.assertEqual(result.contents, "YAML")
|
||||
self.assertEqual(result.name, "NAME")
|
||||
self.assertEqual(type(result.created_at), datetime)
|
||||
self.assertEqual(result.updated_at, None)
|
||||
|
||||
def test_retrieve(self):
|
||||
|
||||
# Setup
|
||||
created = self._create_test_object()
|
||||
|
||||
# Test
|
||||
result = self.store.retrieve(created.uuid)
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.uuid, created.uuid)
|
||||
self.assertEqual(result.contents, created.contents)
|
||||
self.assertEqual(result.name, created.name)
|
||||
self.assertEqual(result.created_at, created.created_at)
|
||||
self.assertEqual(result.updated_at, created.updated_at)
|
||||
self.assertEqual(result.version, created.version)
|
||||
self.assertEqual(result, created)
|
||||
|
||||
def test_retrieve_by_name(self):
|
||||
|
||||
# Setup
|
||||
created = self._create_test_object()
|
||||
|
||||
# Test
|
||||
result = self.store.retrieve_by_name(created.name)
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.uuid, created.uuid)
|
||||
self.assertEqual(result.contents, created.contents)
|
||||
self.assertEqual(result.name, created.name)
|
||||
self.assertEqual(result.created_at, created.created_at)
|
||||
self.assertEqual(result.updated_at, created.updated_at)
|
||||
self.assertEqual(result.version, created.version)
|
||||
self.assertEqual(result, created)
|
||||
|
||||
|
||||
class VersionedStoreMixin(NamedStoreMixin):
|
||||
|
||||
def _get_store(self, driver):
|
||||
|
||||
class VersionedStore(stores._VersionedStore):
|
||||
object_type = "versioned_object"
|
||||
|
||||
return VersionedStore(driver)
|
||||
|
||||
def test_version(self):
|
||||
# Test
|
||||
result = self._create_test_object()
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.version, 1)
|
||||
|
||||
def test_update(self):
|
||||
|
||||
# Setup
|
||||
created = self._create_test_object()
|
||||
|
||||
# Test
|
||||
result = self.store.update(created.uuid, "YAML 2")
|
||||
|
||||
# Verify
|
||||
self.assertNotEqual(result.uuid, created.uuid)
|
||||
self.assertEqual(result.contents, "YAML 2")
|
||||
self.assertEqual(result.name, created.name)
|
||||
self.assertNotEqual(result.created_at, created.created_at)
|
||||
self.assertEqual(result.updated_at, None)
|
||||
self.assertEqual(created.version, 1)
|
||||
self.assertEqual(result.version, 2)
|
||||
|
||||
def test_retrieve_by_name_and_version(self):
|
||||
|
||||
# Setup
|
||||
created = self._create_test_object()
|
||||
|
||||
# Test
|
||||
result = self.store.retrieve_by_name(
|
||||
created.name, version=created.version)
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.uuid, created.uuid)
|
||||
self.assertEqual(result.contents, created.contents)
|
||||
self.assertEqual(result.name, created.name)
|
||||
self.assertEqual(result.created_at, created.created_at)
|
||||
self.assertEqual(result.updated_at, created.updated_at)
|
||||
self.assertEqual(result.version, created.version)
|
||||
self.assertEqual(result, created)
|
||||
|
||||
def test_retrieve_by_name_and_version_fail(self):
|
||||
|
||||
# Setup
|
||||
created = self._create_test_object()
|
||||
|
||||
# Verify
|
||||
retrieve_call = partial(self.store.retrieve_by_name,
|
||||
created.name, 2)
|
||||
self.assertRaises(exceptions.UnknownVersion, retrieve_call)
|
||||
|
||||
def test_list_only_latest(self):
|
||||
|
||||
# Setup
|
||||
created_files = [self._create_test_object(i) for i in range(5)]
|
||||
|
||||
updated = [self.store.update(created.uuid, "YAML 2")
|
||||
for created in created_files]
|
||||
|
||||
# Test
|
||||
listed_files = self.store.list(only_latest=True)
|
||||
|
||||
# Verify
|
||||
self.assertEqual(5, len(listed_files))
|
||||
self.assertEqual(5, len(updated))
|
||||
self.assertEqual(updated, listed_files)
|
||||
@ -12,300 +12,26 @@
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
from datetime import datetime
|
||||
from functools import partial
|
||||
from tuskar.storage.drivers import sqlalchemy
|
||||
from tuskar.tests.storage.drivers import base
|
||||
|
||||
from mock import Mock
|
||||
from mock import patch
|
||||
from sqlalchemy.orm.exc import NoResultFound
|
||||
|
||||
from tuskar.storage.drivers.sqlalchemy import SQLAlchemyDriver
|
||||
from tuskar.storage.exceptions import UnknownName
|
||||
from tuskar.storage.exceptions import UnknownUUID
|
||||
from tuskar.storage.exceptions import UnknownVersion
|
||||
from tuskar.storage.stores import DeploymentPlanStore
|
||||
from tuskar.storage.stores import TemplateStore
|
||||
from tuskar.tests import base
|
||||
class SQLAlchemyTestCase(base.BaseDriverTestCase):
|
||||
|
||||
def _get_driver(self):
|
||||
return sqlalchemy.SQLAlchemyDriver()
|
||||
|
||||
class SQLAlchemyDriverTestCase(base.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
super(SQLAlchemyDriverTestCase, self).setUp()
|
||||
class BaseStoreSQLAlchemyTestCase(SQLAlchemyTestCase,
|
||||
base.BaseStoreMixin):
|
||||
pass
|
||||
|
||||
self.driver = SQLAlchemyDriver()
|
||||
self.store = TemplateStore(self.driver)
|
||||
|
||||
@patch('tuskar.storage.drivers.sqlalchemy.SQLAlchemyDriver._generate_uuid')
|
||||
def test_create(self, mock_uuid):
|
||||
class NamedStoreSQLAlchemyTestCase(SQLAlchemyTestCase,
|
||||
base.NamedStoreMixin):
|
||||
pass
|
||||
|
||||
# Setup
|
||||
expected_uuid = 'b4b85dc2-0b0a-48ed-a56c-e4d582fd1473'
|
||||
mock_uuid.return_value = expected_uuid
|
||||
|
||||
# Test
|
||||
result = self.driver.create(self.store, "swift.yaml", "YAML")
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.uuid, expected_uuid)
|
||||
self.assertEqual(result.version, 1)
|
||||
self.assertEqual(type(result.created_at), datetime)
|
||||
self.assertEqual(result.updated_at, None)
|
||||
|
||||
@patch('tuskar.storage.drivers.sqlalchemy.SQLAlchemyDriver._generate_uuid')
|
||||
def test_create_no_versioning(self, mock_uuid):
|
||||
|
||||
# Setup
|
||||
store = DeploymentPlanStore(self.driver)
|
||||
expected_uuid = 'b4b85dc2-0b0a-48ed-a56c-e4d582fd1473'
|
||||
mock_uuid.return_value = expected_uuid
|
||||
|
||||
# Test
|
||||
result = self.driver.create(store, "swift.yaml", "YAML")
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.uuid, expected_uuid)
|
||||
self.assertEqual(result.version, None)
|
||||
|
||||
@patch('tuskar.storage.drivers.sqlalchemy.SQLAlchemyDriver._generate_uuid')
|
||||
def test_retrieve(self, mock_uuid):
|
||||
|
||||
# Setup
|
||||
expected_uuid = 'b4b85dc2-0b0a-48ed-a56c-e4d582fd1473'
|
||||
expected_name = "swift.yaml"
|
||||
expected_contents = "YAML"
|
||||
mock_uuid.return_value = expected_uuid
|
||||
self.driver.create(self.store, expected_name, expected_contents)
|
||||
|
||||
# Test
|
||||
result = self.driver.retrieve(self.store, expected_uuid)
|
||||
|
||||
# Verify
|
||||
self.assertEqual(result.uuid, expected_uuid)
|
||||
self.assertEqual(result.name, expected_name)
|
||||
self.assertEqual(result.contents, expected_contents)
|
||||
|
||||
def test_retrieve_invalid(self):
|
||||
|
||||
# Setup
|
||||
retrieve_call = partial(
|
||||
self.driver.retrieve,
|
||||
self.store, "uuid"
|
||||
)
|
||||
|
||||
# Test & Verify
|
||||
self.assertRaises(UnknownUUID, retrieve_call)
|
||||
|
||||
def test_update(self):
|
||||
|
||||
# Setup
|
||||
expected_name = "swift.yaml"
|
||||
original_contents = "YAML"
|
||||
created = self.driver.create(
|
||||
self.store, expected_name, original_contents)
|
||||
|
||||
# Test
|
||||
new_contents = "YAML2"
|
||||
updated = self.driver.update(self.store, created.uuid, new_contents)
|
||||
|
||||
# Verify
|
||||
retrieved = self.driver.retrieve(self.store, created.uuid)
|
||||
self.assertEqual(retrieved.uuid, created.uuid)
|
||||
self.assertEqual(retrieved.name, expected_name)
|
||||
self.assertEqual(type(created.created_at), datetime)
|
||||
self.assertEqual(created.updated_at, None)
|
||||
|
||||
# Original and retrieved have not been updated
|
||||
self.assertEqual(retrieved.contents, original_contents)
|
||||
self.assertEqual(created.version, 1)
|
||||
self.assertEqual(retrieved.version, 1)
|
||||
|
||||
# Updated has a new version, and new contents
|
||||
self.assertEqual(updated.contents, new_contents)
|
||||
self.assertEqual(updated.version, 2)
|
||||
self.assertEqual(type(updated.created_at), datetime)
|
||||
self.assertEqual(updated.updated_at, None)
|
||||
|
||||
def test_update_no_versioning(self):
|
||||
|
||||
# Setup
|
||||
store = DeploymentPlanStore(self.driver)
|
||||
expected_name = "swift.yaml"
|
||||
original_contents = "YAML"
|
||||
created = self.driver.create(store, expected_name, original_contents)
|
||||
|
||||
# Test
|
||||
new_contents = "YAML2"
|
||||
updated = self.driver.update(store, created.uuid, new_contents)
|
||||
|
||||
# Verify
|
||||
self.assertEqual(updated.uuid, created.uuid)
|
||||
self.assertEqual(updated.name, expected_name)
|
||||
self.assertEqual("YAML2", updated.contents)
|
||||
self.assertEqual(updated.version, None)
|
||||
|
||||
self.assertEqual(type(created.created_at), datetime)
|
||||
self.assertEqual(created.updated_at, None)
|
||||
self.assertEqual(type(updated.created_at), datetime)
|
||||
self.assertEqual(type(updated.updated_at), datetime)
|
||||
|
||||
def test_update_invalid_uuid(self):
|
||||
|
||||
# Setup
|
||||
update_call = partial(self.driver.update, self.store, "uuid", "YAML2")
|
||||
|
||||
# Test & Verify
|
||||
self.assertRaises(UnknownUUID, update_call)
|
||||
|
||||
@patch('tuskar.storage.drivers.sqlalchemy.SQLAlchemyDriver._generate_uuid')
|
||||
def test_delete(self, mock_uuid):
|
||||
|
||||
# Setup
|
||||
expected_uuid = 'b4b85dc2-0b0a-48ed-a56c-e4d582fd1473'
|
||||
expected_name = "swift.yaml"
|
||||
contents = "YAML"
|
||||
mock_uuid.return_value = expected_uuid
|
||||
self.driver.create(self.store, expected_name, contents)
|
||||
|
||||
# Test
|
||||
result = self.driver.delete(self.store, expected_uuid)
|
||||
|
||||
# Verify
|
||||
self.assertEqual(None, result)
|
||||
retrieve_call = partial(
|
||||
self.driver.retrieve,
|
||||
self.store, expected_uuid
|
||||
)
|
||||
self.assertRaises(UnknownUUID, retrieve_call)
|
||||
|
||||
def test_delete_invalid(self):
|
||||
self.assertRaises(
|
||||
UnknownUUID, self.driver.delete, self.store, "uuid")
|
||||
|
||||
def test_list(self):
|
||||
|
||||
name = "swift.yaml"
|
||||
template = self.driver.create(self.store, name, "YAML1")
|
||||
|
||||
self.assertEqual(1, len(self.driver.list(self.store)))
|
||||
|
||||
self.driver.update(self.store, template.uuid, "YAML2")
|
||||
|
||||
self.assertEqual(2, len(self.driver.list(self.store)))
|
||||
|
||||
def test_list_only_latest(self):
|
||||
|
||||
# setup
|
||||
name = "swift.yaml"
|
||||
template = self.driver.create(self.store, name, "YAML1")
|
||||
updated = self.driver.update(self.store, template.uuid, "YAML2")
|
||||
|
||||
# test
|
||||
listed = self.driver.list(self.store, only_latest=True)
|
||||
|
||||
# verify
|
||||
self.assertEqual(1, len(listed))
|
||||
self.assertEqual([updated.uuid, ], [t.uuid for t in listed])
|
||||
|
||||
def test_list_only_latest_multi(self):
|
||||
|
||||
# setup
|
||||
name = "swift.yaml"
|
||||
template1 = self.driver.create(self.store, name, "YAML1")
|
||||
template1 = self.driver.update(self.store, template1.uuid, "YAML2")
|
||||
template2 = self.driver.create(self.store, "other", "YAML1")
|
||||
|
||||
# test
|
||||
listed = self.driver.list(self.store, only_latest=True)
|
||||
|
||||
# verify
|
||||
self.assertEqual(2, len(listed))
|
||||
self.assertEqual(
|
||||
set([template1.uuid, template2.uuid]),
|
||||
set(t.uuid for t in listed)
|
||||
)
|
||||
|
||||
def test_retrieve_by_name(self):
|
||||
|
||||
# Setup
|
||||
create_result = self.driver.create(self.store, "name", "YAML")
|
||||
self.driver.update(self.store, create_result.uuid, "YAML2")
|
||||
|
||||
# Test
|
||||
retrieved = self.driver.retrieve_by_name(self.store, "name")
|
||||
|
||||
# Verify
|
||||
self.assertNotEqual(create_result.uuid, retrieved.uuid)
|
||||
self.assertEqual(retrieved.contents, "YAML2")
|
||||
self.assertEqual(retrieved.version, 2)
|
||||
|
||||
def test_retrieve_by_name_version(self):
|
||||
|
||||
name = "swift.yaml"
|
||||
|
||||
# Setup
|
||||
first = self.driver.create(self.store, name, "YAML1")
|
||||
second = self.driver.update(self.store, first.uuid, "YAML2")
|
||||
third = self.driver.update(self.store, first.uuid, "YAML3")
|
||||
|
||||
# Test
|
||||
retrieved_first = self.driver.retrieve_by_name(self.store, name, 1)
|
||||
retrieved_second = self.driver.retrieve_by_name(self.store, name, 2)
|
||||
retrieved_third = self.driver.retrieve_by_name(self.store, name, 3)
|
||||
|
||||
# Verify
|
||||
|
||||
self.assertEqual(3, len(self.driver.list(self.store)))
|
||||
|
||||
self.assertEqual(retrieved_first.uuid, first.uuid)
|
||||
self.assertEqual(1, retrieved_first.version)
|
||||
self.assertEqual("YAML1", retrieved_first.contents)
|
||||
|
||||
self.assertEqual(retrieved_second.uuid, second.uuid)
|
||||
self.assertEqual(2, retrieved_second.version)
|
||||
self.assertEqual("YAML2", retrieved_second.contents)
|
||||
|
||||
self.assertEqual(retrieved_third.uuid, third.uuid)
|
||||
self.assertEqual(3, retrieved_third.version)
|
||||
self.assertEqual("YAML3", retrieved_third.contents)
|
||||
|
||||
def test_retrieve_by_name_invalid_name(self):
|
||||
|
||||
retrieve_by_name_call = partial(
|
||||
self.driver.retrieve_by_name,
|
||||
self.store, "name"
|
||||
)
|
||||
self.assertRaises(UnknownName, retrieve_by_name_call)
|
||||
|
||||
def test_retrieve_by_name_invalid_version(self):
|
||||
|
||||
self.driver.create(self.store, "name", "YAML")
|
||||
|
||||
retrieve_by_name_call = partial(
|
||||
self.driver.retrieve_by_name,
|
||||
self.store, "name", 2
|
||||
)
|
||||
|
||||
self.assertRaises(UnknownVersion, retrieve_by_name_call)
|
||||
|
||||
def test_retrieve_by_name_other_error(self):
|
||||
"""Verify that a NoResultFound exception is re-raised (and not
|
||||
lost/squashed) if it isn't detected to be due to a missing name or
|
||||
version that wasn't found.
|
||||
"""
|
||||
|
||||
self.driver.create(self.store, "name", "YAML")
|
||||
|
||||
with patch('tuskar.storage.drivers.sqlalchemy.get_session') as mock:
|
||||
|
||||
query_mock = Mock()
|
||||
query_mock.query.side_effect = NoResultFound()
|
||||
|
||||
mock.return_value = query_mock
|
||||
|
||||
retrieve_by_name_call = partial(
|
||||
self.driver.retrieve_by_name,
|
||||
self.store, "name"
|
||||
)
|
||||
|
||||
self.assertRaises(NoResultFound, retrieve_by_name_call)
|
||||
class VersionStoreSQLAlchemyTestCase(SQLAlchemyTestCase,
|
||||
base.VersionedStoreMixin):
|
||||
pass
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user