openstack/tripleo-common
Code Issues Proposed changes
Files
8f88e7877835f7baa981e978f0d8f665fb6264c5
tripleo-common/tripleo_common/tests/utils/test_validations.py
Ana Krivokapic 8f88e78778 Add support for custom validations 
This patch introduces support for running custom validations by changing
the behavior of the validations actions ListValidationsAction,
ListGroupsAction and RunValidationAction.

Until now, these actions sourced validations from a directory on disk.
Now, these action are sourcing validations from the plan container
subdirectory (custom validations), or, if this is not available, from
the Swift container holding the default validations.

Change-Id: I9e9131b355312c53f12d154976d5d9cd706cc338
Implements: blueprint custom-validations
Depends-On: I338e139fa770ebb7bdcc1c0afb79eec062fada8b
2018-08-10 11:21:29 +02:00

283 lines
9.5 KiB
Python
Raw Blame History

# Copyright 2016 Red Hat, Inc.
#
# 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 collections import namedtuple
import mock
import yaml
from tripleo_common.constants import PLAN_NAME_PATTERN
from tripleo_common.tests import base
from tripleo_common.utils import validations
VALIDATION_DEFAULT = """---
- hosts: overcloud
vars:
metadata:
name: First validation
description: Default validation
tasks:
- name: Ping the nodes
ping:
"""
VALIDATION_CUSTOM = """---
- hosts: overcloud
vars:
metadata:
name: First validation
description: Custom validation
tasks:
- name: Ping the nodes
ping:
"""
VALIDATION_GROUP_1 = """---
- hosts: overcloud
vars:
metadata:
name: First validation
description: A validation belonging to group1
groups:
- group1
tasks:
- name: Ping the nodes
ping:
"""
VALIDATION_WITH_METADATA = """---
- hosts: undercloud
vars:
metadata:
name: Validation with metadata
description: A validation with extra metadata
foo: a foo metadata
bar: 42
tasks:
- name: Do something useful
watch_tv:
"""
VALIDATION_GROUPS_1_2 = """---
- hosts: undercloud
vars:
metadata:
name: Validation from many groups
description: A validation belonging to groups 1 and 2
groups:
- group1
- group2
tasks:
- name: Do something useful
watch_tv:
"""
VALIDATION_GROUP_1_PARSED = {
'description': 'A validation belonging to group1',
'groups': ['group1'],
'id': 'VALIDATION_GROUP_1',
'metadata': {},
'name': 'First validation',
}
VALIDATION_WITH_METADATA_PARSED = {
'description': 'A validation with extra metadata',
'groups': [],
'id': 'VALIDATION_WITH_METADATA',
'metadata': {'foo': 'a foo metadata', 'bar': 42},
'name': 'Validation with metadata',
}
VALIDATION_GROUPS_1_2_PARSED = {
'description': 'A validation belonging to groups 1 and 2',
'groups': ['group1', 'group2'],
'id': 'VALIDATION_GROUPS_1_2',
'metadata': {},
'name': 'Validation from many groups',
}
class ValidationsKeyTest(base.TestCase):
@mock.patch("oslo_concurrency.processutils.execute")
@mock.patch('tempfile.mkstemp')
def test_write_identity_file(self, mock_mkstemp, mock_execute):
mock_open_context = mock.mock_open()
mock_mkstemp.return_value = 'fd', 'tmp_path'
with mock.patch('os.fdopen',
mock_open_context):
validations.write_identity_file('private_key')
mock_open_context.assert_called_once_with('fd', 'w')
mock_open_context().write.assert_called_once_with('private_key')
mock_execute.assert_called_once_with(
'/usr/bin/sudo', '/usr/bin/chown', '-h', 'validations:',
'tmp_path')
@mock.patch("oslo_concurrency.processutils.execute")
def test_cleanup_identity_file(self, mock_execute):
validations.cleanup_identity_file('/path/to/key')
mock_execute.assert_called_once_with(
'/usr/bin/sudo', '/usr/bin/rm', '-f', '/path/to/key')
class LoadValidationsTest(base.TestCase):
def test_get_validation_metadata(self):
validation = yaml.safe_load(VALIDATION_GROUP_1)
value = validations.get_validation_metadata(validation, 'name')
self.assertEqual('First validation', value)
@mock.patch('tripleo_common.utils.validations.DEFAULT_METADATA')
def test_get_validation_metadata_default_value(self, mock_metadata):
mock_metadata.get.return_value = 'default_value'
value = validations.get_validation_metadata({}, 'missing')
self.assertEqual('default_value', value)
def test_get_remaining_metadata(self):
validation = yaml.safe_load(VALIDATION_WITH_METADATA)
value = validations.get_remaining_metadata(validation)
expected = {
'foo': 'a foo metadata',
'bar': 42
}
self.assertEqual(expected, value)
def test_get_remaining_metadata_no_extra(self):
validation = yaml.safe_load(VALIDATION_GROUP_1)
value = validations.get_remaining_metadata(validation)
self.assertEqual({}, value)
@mock.patch('tripleo_common.actions.base.TripleOAction.get_object_client')
def test_load_validations_no_group(self, mock_get_object_client):
swiftclient = mock.MagicMock(url='http://swift:8080/v1/AUTH_test')
swiftclient.get_container.side_effect = (
({}, []), # no custom validations
({},
[{'name': 'VALIDATION_GROUP_1.yaml', 'groups': ['group1']},
{'name': 'VALIDATION_WITH_METADATA.yaml'}]))
swiftclient.get_object.side_effect = (
({}, VALIDATION_GROUP_1),
({}, VALIDATION_WITH_METADATA),
)
mock_get_object_client.return_value = swiftclient
my_validations = validations.load_validations(
mock_get_object_client(), plan='overcloud')
expected = [VALIDATION_GROUP_1_PARSED, VALIDATION_WITH_METADATA_PARSED]
self.assertEqual(expected, my_validations)
@mock.patch('tripleo_common.actions.base.TripleOAction.get_object_client')
def test_load_validations_group(self, mock_get_object_client):
swiftclient = mock.MagicMock(url='http://swift:8080/v1/AUTH_test')
swiftclient.get_container.side_effect = (
({}, []), # no custom validations
({},
[
{'name': 'VALIDATION_GROUPS_1_2.yaml',
'groups': ['group1', 'group2']},
{'name': 'VALIDATION_GROUP_1.yaml', 'groups': ['group1']},
{'name': 'VALIDATION_WITH_METADATA.yaml'}
]
)
)
swiftclient.get_object.side_effect = (
({}, VALIDATION_GROUPS_1_2),
({}, VALIDATION_GROUP_1),
({}, VALIDATION_WITH_METADATA),
)
mock_get_object_client.return_value = swiftclient
my_validations = validations.load_validations(
mock_get_object_client(), plan='overcloud', groups=['group1'])
expected = [VALIDATION_GROUPS_1_2_PARSED, VALIDATION_GROUP_1_PARSED]
self.assertEqual(expected, my_validations)
@mock.patch('tripleo_common.actions.base.TripleOAction.get_object_client')
def test_load_validations_custom_gets_picked_over_default(
self, mock_get_object_client):
swiftclient = mock.MagicMock(url='http://swift:8080/v1/AUTH_test')
swiftclient.get_container.side_effect = (
({}, [{'name': 'FIRST_VALIDATION.yaml'}]),
({}, [{'name': 'FIRST_VALIDATION.yaml'}])
)
swiftclient.get_object.side_effect = (
({}, VALIDATION_CUSTOM),
({}, VALIDATION_DEFAULT)
)
mock_get_object_client.return_value = swiftclient
my_validations = validations.load_validations(
mock_get_object_client(), plan='overcloud')
self.assertEqual(len(my_validations), 1)
self.assertEqual('Custom validation', my_validations[0]['description'])
class RunValidationTest(base.TestCase):
@mock.patch('tripleo_common.actions.base.TripleOAction.get_object_client')
@mock.patch('tripleo_common.utils.validations.download_validation')
@mock.patch('oslo_concurrency.processutils.execute')
def test_run_validation(self, mock_execute,
mock_download_validation, mock_get_object_client):
swiftclient = mock.MagicMock(url='http://swift:8080/v1/AUTH_test')
mock_get_object_client.return_value = swiftclient
Ctx = namedtuple('Ctx', 'auth_uri user_name auth_token project_name')
mock_ctx = Ctx(
auth_uri='auth_uri',
user_name='user_name',
auth_token='auth_token',
project_name='project_name'
)
mock_execute.return_value = 'output'
mock_download_validation.return_value = 'validation_path'
result = validations.run_validation(mock_get_object_client(),
'validation', 'identity_file',
'plan', mock_ctx)
self.assertEqual('output', result)
mock_execute.assert_called_once_with(
'/usr/bin/sudo', '-u', 'validations',
'OS_AUTH_URL=auth_uri',
'OS_USERNAME=user_name',
'OS_AUTH_TOKEN=auth_token',
'OS_TENANT_NAME=project_name',
'/usr/bin/run-validation',
'validation_path',
'identity_file',
'plan'
)
mock_download_validation.assert_called_once_with(
mock_get_object_client(), 'plan', 'validation')
class RunPatternValidatorTest(base.TestCase):
def test_valid_patterns(self):
self.assertTrue(validations.pattern_validator("^$", ""))
self.assertTrue(
validations.pattern_validator(PLAN_NAME_PATTERN, "foo"))
self.assertTrue(
validations.pattern_validator(PLAN_NAME_PATTERN, "Foo-1"))
def test_invalid_patterns(self):
self.assertFalse(
validations.pattern_validator("^$", "foo"))
self.assertFalse(
validations.pattern_validator(PLAN_NAME_PATTERN, "foo_1"))
View Git Blame Copy Permalink