1bbf282356
Presently, the operator(s) can only execute the official and supported validations coming from tripleo-validations and validations-common. Community validations enable a sysadmin to create and execute validations unique to their environment. This patch introduces the new Command Line Interface sub command to create a new community validation skeleton. First, this latter will check if there is an existing role or a playbook either in the community validations catalog or the official validations catalog. And it will create an Ansible role (with ansible-galaxy[1]) and a playbook in the ~/community-validations directory. By default, the community validations feature is enabled but may be disabled by setting [DEFAULT].enable_community_validations to ``False`` in the validation configuration file. Example: [stack@localhost]$ validation init my-new-validation Validation config file found: /etc/validation.cfg New role created successfully in /home/stack/community-validations/roles/my_new_validation New playbook created successfully in /home/stack/community-validations/playbooks/my-new-validation.yaml For a full demo of this new CLI sub command, please take a look at this asciinema[2]. [1] - https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html [2] - https://asciinema.org/a/445105 Change-Id: I8fb16e3456696187d4a9d3820740a7639a96e315 Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
173 lines
6.7 KiB
Python
173 lines
6.7 KiB
Python
# Copyright 2021 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.
|
|
#
|
|
|
|
try:
|
|
from unittest import mock
|
|
except ImportError:
|
|
import mock
|
|
|
|
from pathlib import PosixPath
|
|
from unittest import TestCase
|
|
|
|
from validations_libs import constants
|
|
from validations_libs.community.init_validation import \
|
|
CommunityValidation as cv
|
|
from validations_libs.tests import fakes
|
|
|
|
|
|
class TestCommunityValidation(TestCase):
|
|
|
|
def setUp(self):
|
|
super(TestCommunityValidation, self).setUp()
|
|
|
|
def test_role_name_underscored(self):
|
|
validation_name = "my_new_validation"
|
|
co_val = cv(validation_name)
|
|
role_name = co_val.role_name
|
|
self.assertEqual(role_name, validation_name)
|
|
|
|
def test_role_name_with_underscores_and_dashes(self):
|
|
validation_name = "my_new-validation"
|
|
co_val = cv(validation_name)
|
|
self.assertEqual(co_val.role_name, "my_new_validation")
|
|
|
|
def test_role_name_with_dashes_only(self):
|
|
validation_name = "my-new-validation"
|
|
co_val = cv(validation_name)
|
|
self.assertEqual(co_val.role_name,
|
|
"my_new_validation")
|
|
|
|
def test_role_name_compliant(self):
|
|
validation_name = "my_new_validation"
|
|
co_val = cv(validation_name)
|
|
self.assertTrue(co_val.is_role_name_compliant)
|
|
|
|
def test_role_name_not_compliant(self):
|
|
validation_name = "123_my_new-validation"
|
|
co_val = cv(validation_name)
|
|
self.assertFalse(co_val.is_role_name_compliant)
|
|
|
|
def test_role_basedir(self):
|
|
validation_name = "my_new-validation"
|
|
co_val = cv(validation_name)
|
|
self.assertEqual(co_val.role_basedir,
|
|
constants.COMMUNITY_ROLES_DIR)
|
|
|
|
def test_playbook_name_with_underscores(self):
|
|
validation_name = "my_new_validation"
|
|
co_val = cv(validation_name)
|
|
self.assertEqual(co_val.playbook_name,
|
|
"my-new-validation.yaml")
|
|
|
|
def test_playbook_name_with_underscores_and_dashes(self):
|
|
validation_name = "my_new-validation"
|
|
co_val = cv(validation_name)
|
|
self.assertEqual(co_val.playbook_name,
|
|
"my-new-validation.yaml")
|
|
|
|
def test_playbook_basedir(self):
|
|
validation_name = "my_new-validation"
|
|
co_val = cv(validation_name)
|
|
self.assertEqual(co_val.playbook_basedir,
|
|
constants.COMMUNITY_PLAYBOOKS_DIR)
|
|
|
|
@mock.patch('pathlib.Path.iterdir',
|
|
return_value=fakes.FAKE_ROLES_ITERDIR1)
|
|
@mock.patch('pathlib.Path.is_dir')
|
|
@mock.patch('pathlib.Path.exists', return_value=False)
|
|
def test_role_already_exists(self,
|
|
mock_path_exists,
|
|
mock_path_is_dir,
|
|
mock_path_iterdir):
|
|
validation_name = "my-val"
|
|
co_val = cv(validation_name)
|
|
self.assertTrue(co_val.is_role_exists())
|
|
|
|
@mock.patch('pathlib.Path.iterdir',
|
|
return_value=fakes.FAKE_ROLES_ITERDIR2)
|
|
@mock.patch('pathlib.Path.is_dir')
|
|
@mock.patch('pathlib.Path.exists', return_value=False)
|
|
def test_role_not_exists(self,
|
|
mock_path_exists,
|
|
mock_path_is_dir,
|
|
mock_path_iterdir):
|
|
validation_name = "my-val"
|
|
co_val = cv(validation_name)
|
|
self.assertFalse(co_val.is_role_exists())
|
|
|
|
@mock.patch('pathlib.Path.iterdir',
|
|
return_value=fakes.FAKE_PLAYBOOKS_ITERDIR1)
|
|
@mock.patch('pathlib.Path.is_file')
|
|
@mock.patch('pathlib.Path.exists', return_value=True)
|
|
def test_playbook_already_exists(self,
|
|
mock_path_exists,
|
|
mock_path_is_file,
|
|
mock_path_iterdir):
|
|
validation_name = "my_val"
|
|
co_val = cv(validation_name)
|
|
self.assertTrue(co_val.is_playbook_exists())
|
|
|
|
@mock.patch('pathlib.Path.iterdir',
|
|
return_value=fakes.FAKE_PLAYBOOKS_ITERDIR2)
|
|
@mock.patch('pathlib.Path.is_file')
|
|
@mock.patch('pathlib.Path.exists', return_value=False)
|
|
def test_playbook_not_exists(self,
|
|
mock_path_exists,
|
|
mock_path_is_file,
|
|
mock_path_iterdir):
|
|
validation_name = "my_val"
|
|
co_val = cv(validation_name)
|
|
self.assertFalse(co_val.is_playbook_exists())
|
|
|
|
def test_execute_with_role_name_not_compliant(self):
|
|
validation_name = "3_my-val"
|
|
co_val = cv(validation_name)
|
|
self.assertRaises(RuntimeError, co_val.execute)
|
|
|
|
@mock.patch('validations_libs.utils.run_command_and_log',
|
|
return_value=0)
|
|
@mock.patch('validations_libs.community.init_validation.CommunityValidation.role_basedir',
|
|
return_value=PosixPath("/foo/bar/roles"))
|
|
@mock.patch('validations_libs.community.init_validation.LOG',
|
|
autospec=True)
|
|
def test_exec_new_role_with_galaxy(self,
|
|
mock_log,
|
|
mock_role_basedir,
|
|
mock_run):
|
|
validation_name = "my_val"
|
|
cmd = ['ansible-galaxy', 'init', '-v',
|
|
'--offline', validation_name,
|
|
'--init-path', mock_role_basedir]
|
|
co_val = cv(validation_name)
|
|
co_val.execute()
|
|
mock_run.assert_called_once_with(mock_log, cmd)
|
|
|
|
@mock.patch('validations_libs.utils.run_command_and_log',
|
|
return_value=1)
|
|
@mock.patch('validations_libs.community.init_validation.CommunityValidation.role_basedir',
|
|
return_value=PosixPath("/foo/bar/roles"))
|
|
@mock.patch('validations_libs.community.init_validation.LOG',
|
|
autospec=True)
|
|
def test_exec_new_role_with_galaxy_and_error(self,
|
|
mock_log,
|
|
mock_role_basedir,
|
|
mock_run):
|
|
validation_name = "my_val"
|
|
cmd = ['ansible-galaxy', 'init', '-v',
|
|
'--offline', validation_name,
|
|
'--init-path', mock_role_basedir]
|
|
co_val = cv(validation_name)
|
|
self.assertRaises(RuntimeError, co_val.execute)
|