airship/deckhand
Code Issues Proposed changes

Remove dead validation policy code.

Browse Source 
This PS removes dead validation policy code from Deckhand. Most
of this code is just for testing and serves no purpose because
Deckhand currently doesn't offer support for validation policies.
Besides, these tests assume a wrong implementation of validation
policies and should be removed for that reason alone.

The actual documentation and rudimentary foundational logic
for implementing validation policies has been left undeleted.
(Some of this logic includes having a constant for validation
policies in deckhand.types and a schema for validating validation
policies).

Change-Id: Ie0d27dae84c82096e0a88bebcba9bb7ca9bee7c1
This commit is contained in:
Felipe Monteiro 2018-01-06 18:08:03 +00:00
parent a73b118549
commit 89cc04165c
5 changed files with 0 additions and 249 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
deckhand/factories.py
View File

@ -19,7 +19,6 @@ import six
from oslo_log import log as logging
from deckhand.tests import test_utils
from deckhand import types
LOG = logging.getLogger(__name__)
@ -364,82 +363,3 @@ class DocumentSecretFactory(DeckhandFactory):
document_secret_template['metadata']['name'] = name
return document_secret_template
class ValidationPolicyFactory(DeckhandFactory):
"""Class for auto-generating validation policy templates for testing."""
VALIDATION_POLICY_TEMPLATE = {
"data": {
"validations": []
},
"metadata": {
"schema": "metadata/Control/%s" % DeckhandFactory.API_VERSION,
"name": ""
},
"schema": types.VALIDATION_POLICY_SCHEMA
}
def __init__(self):
"""Constructor for ``ValidationPolicyFactory``.
Returns a template whose YAML representation is of the form::
---
schema: deckhand/ValidationPolicy/v1.0
metadata:
schema: metadata/Control/v1.0
name: site-deploy-ready
data:
validations:
- name: deckhand-schema-validation
- name: drydock-site-validation
expiresAfter: P1W
- name: promenade-site-validation
expiresAfter: P1W
- name: armada-deployability-validation
...
"""
def gen(self, validation_type, status):
if validation_type not in types.DECKHAND_VALIDATION_TYPES:
raise ValueError("The validation type must be in %s."
% types.DECKHAND_VALIDATION_TYPES)
validation_policy_template = copy.deepcopy(
self.VALIDATION_POLICY_TEMPLATE)
validation_policy_template['metadata'][
'name'] = test_utils.rand_name('validation-policy')
validation_policy_template['data']['validations'] = [
{'name': validation_type, 'status': status}
]
return validation_policy_template
def gen_test(self, name=None, num_validations=None):
"""Generate the test document template.
Generate the document template based on the arguments passed to
the constructor and to this function.
"""
if not(num_validations and isinstance(num_validations, int)
and num_validations > 0):
raise ValueError('The "num_validations" attribute must be integer '
'value > 1.')
if not name:
name = test_utils.rand_name('validation-policy')
if not num_validations:
num_validations = 3
validations = [
test_utils.rand_name('validation-name')
for _ in range(num_validations)]
validation_policy_template = copy.deepcopy(
self.VALIDATION_POLICY_TEMPLATE)
validation_policy_template['metadata']['name'] = name
validation_policy_template['data']['validations'] = validations
return validation_policy_template

20
deckhand/tests/unit/db/test_revisions.py
View File

@ -13,10 +13,8 @@
# limitations under the License.
from deckhand import errors
from deckhand import factories
from deckhand.tests import test_utils
from deckhand.tests.unit.db import base
from deckhand import types
class TestRevisions(base.TestDbBase):
@ -111,24 +109,6 @@ class TestRevisions(base.TestDbBase):
self.assertEqual(created_rev_id,
retrieved_revision['documents'][0]['revision_id'])
def test_list_with_validation_policies(self):
documents = [base.DocumentFixture.get_minimal_fixture()
for _ in range(4)]
vp_factory = factories.ValidationPolicyFactory()
validation_policy = vp_factory.gen(types.DECKHAND_SCHEMA_VALIDATION,
'success')
documents.extend([validation_policy])
bucket_name = test_utils.rand_name('bucket')
self.create_documents(bucket_name, documents)
revisions = self.list_revisions()
self.assertIsInstance(revisions, list)
self.assertEqual(1, len(revisions))
self.assertEqual(5, len(revisions[0]['documents']))
self.assertEqual(types.VALIDATION_POLICY_SCHEMA,
revisions[0]['documents'][-1]['schema'])
def test_delete_all(self):
all_created_documents = []
all_revision_ids = []

86
deckhand/tests/unit/db/test_validations.py
View File

@ -1,86 +0,0 @@
# 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 yaml
from deckhand import factories
from deckhand.tests import test_utils
from deckhand.tests.unit.db import base
from deckhand import types
ARMADA_VALIDATION_POLICY = """
---
status: success
validator:
name: armada
version: 1.1.3
"""
PROMENADE_VALIDATION_POLICY = """
---
status: failure
errors:
- documents:
- schema: promenade/Node/v1
name: node-document-name
- schema: promenade/Masters/v1
name: kubernetes-masters
message: Node has master role, but not included in cluster masters list.
validator:
name: promenade
version: 1.1.2
"""
class TestValidations(base.TestDbBase):
def _create_revision_with_validation_policy(self):
vp_factory = factories.ValidationPolicyFactory()
validation_policy = vp_factory.gen(types.DECKHAND_SCHEMA_VALIDATION,
'success')
bucket_name = test_utils.rand_name('bucket')
documents = self.create_documents(bucket_name, [validation_policy])
revision_id = documents[0]['revision_id']
return revision_id
def test_create_validation(self):
revision_id = self._create_revision_with_validation_policy()
validation_name = test_utils.rand_name('validation')
payload = yaml.safe_load(PROMENADE_VALIDATION_POLICY)
created_validation = self.create_validation(
revision_id, validation_name, payload)
self.assertIsInstance(created_validation, dict)
self.assertEqual(validation_name, created_validation['name'])
self.assertEqual(payload['status'], created_validation['status'])
self.assertEqual(payload['validator'], created_validation['validator'])
def test_create_multiple_validations(self):
revision_id = self._create_revision_with_validation_policy()
for val_policy in (ARMADA_VALIDATION_POLICY,
PROMENADE_VALIDATION_POLICY):
validation_name = test_utils.rand_name('validation')
payload = yaml.safe_load(val_policy)
created_validation = self.create_validation(
revision_id, validation_name, payload)
payload.update({'name': validation_name})
self.assertIsInstance(created_validation, dict)
self.assertEqual(validation_name, created_validation['name'])
self.assertEqual(payload['status'], created_validation['status'])
self.assertEqual(payload['validator'],
created_validation['validator'])

2
deckhand/tests/unit/views/test_document_views.py
View File

@ -13,7 +13,6 @@
# limitations under the License.
from deckhand.control.views import document
from deckhand import factories
from deckhand.tests import test_utils
from deckhand.tests.unit.db import base
@ -23,7 +22,6 @@ class TestDocumentViews(base.TestDbBase):
def setUp(self):
super(TestDocumentViews, self).setUp()
self.view_builder = document.ViewBuilder()
self.factory = factories.ValidationPolicyFactory()
def _test_document_creation_view(self, count):
# Test document creation view with the number of documents being

61
deckhand/tests/unit/views/test_revision_views.py
View File

@ -13,10 +13,8 @@
# limitations under the License.
from deckhand.control.views import revision
from deckhand import factories
from deckhand.tests import test_utils
from deckhand.tests.unit.db import base
from deckhand import types
class TestRevisionViews(base.TestDbBase):
@ -24,7 +22,6 @@ class TestRevisionViews(base.TestDbBase):
def setUp(self):
super(TestRevisionViews, self).setUp()
self.view_builder = revision.ViewBuilder()
self.factory = factories.ValidationPolicyFactory()
def test_list_revisions_with_multiple_documents(self):
payload = [base.DocumentFixture.get_minimal_fixture()
@ -81,61 +78,3 @@ class TestRevisionViews(base.TestDbBase):
self.assertIsInstance(revision_view['validationPolicies'], list)
self.assertEqual(revision_view['validationPolicies'], [])
def test_show_revision_successful_validation_policy(self):
# Simulate 4 document payload with an internally generated validation
# policy which executes 'deckhand-schema-validation'.
payload = [base.DocumentFixture.get_minimal_fixture()
for _ in range(4)]
validation_policy = self.factory.gen(types.DECKHAND_SCHEMA_VALIDATION,
status='success')
payload.append(validation_policy)
bucket_name = test_utils.rand_name('bucket')
documents = self.create_documents(bucket_name, payload)
revision = self.show_revision(documents[0]['revision_id'])
revision_view = self.view_builder.show(revision)
expected_attrs = ('id', 'url', 'createdAt', 'validationPolicies',
'status')
for attr in expected_attrs:
self.assertIn(attr, revision_view)
self.assertEqual('success', revision_view['status'])
self.assertIsInstance(revision_view['validationPolicies'], list)
self.assertEqual(1, len(revision_view['validationPolicies']))
self.assertRegexpMatches(
revision_view['validationPolicies'][0]['name'],
'deckhand-validation-policy-.*')
self.assertEqual(revision_view['validationPolicies'][0]['status'],
'success')
def test_show_revision_failed_validation_policy(self):
# Simulate 4 document payload with an internally generated validation
# policy which executes 'deckhand-schema-validation'.
payload = [base.DocumentFixture.get_minimal_fixture()
for _ in range(4)]
validation_policy = self.factory.gen(types.DECKHAND_SCHEMA_VALIDATION,
status='failed')
payload.append(validation_policy)
bucket_name = test_utils.rand_name('bucket')
documents = self.create_documents(bucket_name, payload)
revision = self.show_revision(documents[0]['revision_id'])
revision_view = self.view_builder.show(revision)
expected_attrs = ('id', 'url', 'createdAt', 'validationPolicies',
'status')
for attr in expected_attrs:
self.assertIn(attr, revision_view)
self.assertEqual('failed', revision_view['status'])
self.assertIsInstance(revision_view['validationPolicies'], list)
self.assertEqual(1, len(revision_view['validationPolicies']))
self.assertRegexpMatches(
revision_view['validationPolicies'][0]['name'],
'deckhand-validation-policy-.*')
self.assertEqual(revision_view['validationPolicies'][0]['status'],
'failed')