203 lines
9.3 KiB
Python
203 lines
9.3 KiB
Python
# Copyright 2017 AT&T Intellectual Property. All other 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 mock
|
|
|
|
from deckhand.engine import layering
|
|
from deckhand import errors
|
|
from deckhand import factories
|
|
from deckhand.tests import test_utils
|
|
from deckhand.tests.unit.engine import test_document_layering
|
|
|
|
|
|
class TestDocumentLayeringNegative(
|
|
test_document_layering.TestDocumentLayering):
|
|
|
|
def test_layering_method_merge_key_not_in_child(self):
|
|
mapping = {
|
|
"_GLOBAL_DATA_1_": {"data": {"a": {"x": 1, "y": 2}, "c": 9}},
|
|
"_SITE_DATA_1_": {"data": {"a": {"x": 7, "z": 3}, "b": 4}},
|
|
"_SITE_ACTIONS_1_": {
|
|
"actions": [{"method": "merge", "path": ".c"}]}
|
|
}
|
|
doc_factory = factories.DocumentFactory(2, [1, 1])
|
|
documents = doc_factory.gen_test(mapping, site_abstract=False)
|
|
|
|
self.assertRaises(errors.MissingDocumentKey, self._test_layering,
|
|
documents)
|
|
|
|
def test_layering_method_delete_key_not_in_child(self):
|
|
# The key will not be in the site after the global data is copied into
|
|
# the site data implicitly.
|
|
mapping = {
|
|
"_GLOBAL_DATA_1_": {"data": {"a": {"x": 1, "y": 2}, "c": 9}},
|
|
"_SITE_DATA_1_": {"data": {"a": {"x": 7, "z": 3}, "b": 4}},
|
|
"_SITE_ACTIONS_1_": {
|
|
"actions": [{"method": "delete", "path": ".b"}]}
|
|
}
|
|
doc_factory = factories.DocumentFactory(2, [1, 1])
|
|
documents = doc_factory.gen_test(mapping, site_abstract=False)
|
|
|
|
self.assertRaises(errors.MissingDocumentKey, self._test_layering,
|
|
documents)
|
|
|
|
def test_layering_method_replace_key_not_in_child(self):
|
|
mapping = {
|
|
"_GLOBAL_DATA_1_": {"data": {"a": {"x": 1, "y": 2}, "c": 9}},
|
|
"_SITE_DATA_1_": {"data": {"a": {"x": 7, "z": 3}, "b": 4}},
|
|
"_SITE_ACTIONS_1_": {
|
|
"actions": [{"method": "replace", "path": ".c"}]}
|
|
}
|
|
doc_factory = factories.DocumentFactory(2, [1, 1])
|
|
documents = doc_factory.gen_test(mapping, site_abstract=False)
|
|
|
|
self.assertRaises(errors.MissingDocumentKey, self._test_layering,
|
|
documents)
|
|
|
|
@mock.patch.object(layering, 'LOG', autospec=True)
|
|
def test_layering_with_empty_layer(self, mock_log):
|
|
doc_factory = factories.DocumentFactory(1, [1])
|
|
documents = doc_factory.gen_test({}, global_abstract=False)
|
|
|
|
# Only pass in the LayeringPolicy.
|
|
self._test_layering([documents[0]], global_expected=None)
|
|
mock_log.info.assert_has_calls([
|
|
mock.call(
|
|
'%s is an empty layer with no documents. It will be discarded '
|
|
'from the layerOrder during the layering process.', 'global'),
|
|
mock.call('Either the layerOrder in the LayeringPolicy was empty '
|
|
'to begin with or no document layers were found in the '
|
|
'layerOrder, causing it to become empty. No layering '
|
|
'will be performed.')
|
|
])
|
|
|
|
def test_layering_document_with_invalid_layer_raises_exc(self):
|
|
doc_factory = factories.DocumentFactory(1, [1])
|
|
documents = doc_factory.gen_test({}, site_abstract=False)
|
|
documents[1]['metadata']['layeringDefinition']['layer'] = 'invalid'
|
|
|
|
self.assertRaises(errors.InvalidDocumentLayer, self._test_layering,
|
|
documents)
|
|
|
|
@mock.patch.object(layering, 'LOG', autospec=True)
|
|
def test_layering_child_with_invalid_parent_selector(self, mock_log):
|
|
doc_factory = factories.DocumentFactory(2, [1, 1])
|
|
documents = doc_factory.gen_test({}, site_abstract=False)
|
|
|
|
for parent_selector in ({'key2': 'value2'}, {'key1': 'value2'}):
|
|
documents[-1]['metadata']['layeringDefinition'][
|
|
'parentSelector'] = parent_selector
|
|
|
|
layering.DocumentLayering(documents)
|
|
self.assertRegexpMatches(mock_log.info.mock_calls[0][1][0],
|
|
'Could not find parent for document .*')
|
|
mock_log.info.reset_mock()
|
|
|
|
@mock.patch.object(layering, 'LOG', autospec=True)
|
|
def test_layering_unreferenced_parent_label(self, mock_log):
|
|
doc_factory = factories.DocumentFactory(2, [1, 1])
|
|
documents = doc_factory.gen_test({}, site_abstract=False)
|
|
|
|
for parent_label in ({'key2': 'value2'}, {'key1': 'value2'}):
|
|
# Second doc is the global doc, or parent.
|
|
documents[1]['metadata']['labels'] = parent_label
|
|
|
|
layering.DocumentLayering(documents)
|
|
self.assertRegexpMatches(mock_log.info.mock_calls[0][1][0],
|
|
'Could not find parent for document .*')
|
|
mock_log.info.reset_mock()
|
|
|
|
def test_layering_duplicate_parent_selector_2_layer(self):
|
|
# Validate that documents belonging to the same layer cannot have the
|
|
# same unique parent identifier referenced by `parentSelector`.
|
|
doc_factory = factories.DocumentFactory(2, [2, 1])
|
|
documents = doc_factory.gen_test({}, site_abstract=False)
|
|
# Make both global documents have the same exact labels.
|
|
documents[2]['metadata']['labels'] = documents[1]['metadata']['labels']
|
|
|
|
self.assertRaises(errors.IndeterminateDocumentParent,
|
|
layering.DocumentLayering, documents)
|
|
|
|
def test_layering_duplicate_parent_selector_3_layer(self):
|
|
# Validate that documents belonging to the same layer cannot have the
|
|
# same unique parent identifier referenced by `parentSelector`.
|
|
doc_factory = factories.DocumentFactory(3, [1, 2, 1])
|
|
documents = doc_factory.gen_test({}, site_abstract=False)
|
|
# Make both region documents have the same exact labels.
|
|
documents[3]['metadata']['labels'] = documents[2]['metadata']['labels']
|
|
|
|
self.assertRaises(errors.IndeterminateDocumentParent,
|
|
layering.DocumentLayering, documents)
|
|
|
|
@mock.patch.object(layering, 'LOG', autospec=True)
|
|
def test_layering_document_references_itself(self, mock_log):
|
|
# Test that a parentSelector cannot reference the document itself
|
|
# without an error being raised.
|
|
doc_factory = factories.DocumentFactory(3, [1, 1, 1])
|
|
documents = doc_factory.gen_test({}, site_abstract=False)
|
|
self_ref = {"self": "self"}
|
|
documents[2]['metadata']['labels'] = self_ref
|
|
documents[2]['metadata']['layeringDefinition'][
|
|
'parentSelector'] = self_ref
|
|
|
|
layering.DocumentLayering(documents)
|
|
self.assertRegexpMatches(mock_log.info.mock_calls[0][1][0],
|
|
'Could not find parent for document .*')
|
|
|
|
def test_layering_without_layering_policy_raises_exc(self):
|
|
doc_factory = factories.DocumentFactory(1, [1])
|
|
documents = doc_factory.gen_test({}, site_abstract=False)[1:]
|
|
self.assertRaises(errors.LayeringPolicyNotFound,
|
|
layering.DocumentLayering, documents)
|
|
|
|
@mock.patch.object(layering, 'LOG', autospec=True)
|
|
def test_multiple_layering_policy_logs_warning(self, mock_log):
|
|
doc_factory = factories.DocumentFactory(1, [1])
|
|
documents = doc_factory.gen_test({}, global_abstract=False)
|
|
# Copy the same layering policy so that 2 are passed in, causing a
|
|
# warning to be raised.
|
|
documents.append(documents[0])
|
|
self._test_layering(documents, global_expected={})
|
|
mock_log.warning.assert_called_once_with(
|
|
'More than one layering policy document was passed in. Using the '
|
|
'first one found: [%s] %s.', documents[0]['schema'],
|
|
documents[0]['metadata']['name'])
|
|
|
|
def test_layering_documents_with_different_schemas_raises_exc(self):
|
|
"""Validate that attempting to layer documents with different `schema`s
|
|
results in errors.
|
|
"""
|
|
doc_factory = factories.DocumentFactory(3, [1, 1, 1])
|
|
documents = doc_factory.gen_test({})
|
|
|
|
# Region and site documents should result in no parent being found
|
|
# since their `schema`s will not match that of their parent's.
|
|
for idx in range(1, 3): # Only region/site have parent.
|
|
documents[idx]['schema'] = test_utils.rand_name('schema')
|
|
self.assertRaises(
|
|
errors.InvalidDocumentParent, self._test_layering, documents)
|
|
|
|
def test_layering_parent_and_child_with_same_layer_raises_exc(self):
|
|
"""Validate that attempting to layer documents with the same layer
|
|
results in an exception.
|
|
"""
|
|
doc_factory = factories.DocumentFactory(2, [1, 1])
|
|
documents = doc_factory.gen_test({})
|
|
|
|
for x in range(1, 3):
|
|
documents[x]['metadata']['layeringDefinition']['layer'] = 'global'
|
|
|
|
self.assertRaises(
|
|
errors.InvalidDocumentParent, self._test_layering, documents)
|