4d1df7b0e7
As we now have a mechanism for falling back to a default directory for logs and artifacts, we can allow the customers to specify their own. This patch add the argument to the CLI along with minimum necessary information about the usage. Signed-off-by: Jiri Podivin <jpodivin@redhat.com> Change-Id: Id31a7ce2dfc4d9a132fea7d600e8beb8adc0739b (cherry picked from commit 7876cab41586157a1b5e8fd426deb16d79567a52)
357 lines
15 KiB
Python
357 lines
15 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.
|
|
#
|
|
import sys
|
|
|
|
try:
|
|
from unittest import mock
|
|
except ImportError:
|
|
import mock
|
|
from unittest import TestCase
|
|
|
|
from validations_libs.cli import run
|
|
from validations_libs.tests import fakes
|
|
from validations_libs.tests.cli.fakes import BaseCommand
|
|
|
|
|
|
class TestRun(BaseCommand):
|
|
|
|
def setUp(self):
|
|
super(TestRun, self).setUp()
|
|
self.cmd = run.Run(self.app, None)
|
|
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=None)
|
|
def test_run_command_return_none(self, mock_run):
|
|
arglist = ['--validation', 'foo']
|
|
verifylist = [('validation_name', ['foo'])]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.assertRaises(RuntimeError, self.cmd.take_action, parsed_args)
|
|
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=fakes.FAKE_SUCCESS_RUN)
|
|
def test_run_command_success(self, mock_run):
|
|
arglist = ['--validation', 'foo']
|
|
verifylist = [('validation_name', ['foo'])]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.cmd.take_action(parsed_args)
|
|
|
|
def test_run_command_exclusive_group(self):
|
|
arglist = ['--validation', 'foo', '--group', 'bar']
|
|
verifylist = [('validation_name', ['foo'], 'group', 'bar')]
|
|
|
|
self.assertRaises(Exception, self.check_parser, self.cmd,
|
|
arglist, verifylist)
|
|
|
|
@mock.patch('validations_libs.constants.VALIDATIONS_LOG_BASEDIR')
|
|
@mock.patch('validations_libs.cli.common.print_dict')
|
|
@mock.patch('getpass.getuser',
|
|
return_value='doe')
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=fakes.FAKE_SUCCESS_RUN)
|
|
def test_run_command_extra_vars(self, mock_run, mock_user, mock_print,
|
|
mock_log_dir):
|
|
run_called_args = {
|
|
'inventory': 'localhost',
|
|
'limit_hosts': None,
|
|
'group': [],
|
|
'extra_vars': {'key': 'value'},
|
|
'validations_dir': '/usr/share/ansible/validation-playbooks',
|
|
'base_dir': '/usr/share/ansible',
|
|
'validation_name': ['foo'],
|
|
'extra_env_vars': None,
|
|
'python_interpreter': sys.executable,
|
|
'quiet': True,
|
|
'ssh_user': 'doe',
|
|
'log_path': mock_log_dir}
|
|
|
|
arglist = ['--validation', 'foo',
|
|
'--extra-vars', 'key=value']
|
|
verifylist = [('validation_name', ['foo']),
|
|
('extra_vars', {'key': 'value'})]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.cmd.take_action(parsed_args)
|
|
mock_run.assert_called_with(**run_called_args)
|
|
|
|
@mock.patch('validations_libs.constants.VALIDATIONS_LOG_BASEDIR')
|
|
@mock.patch('validations_libs.cli.common.print_dict')
|
|
@mock.patch('getpass.getuser',
|
|
return_value='doe')
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=fakes.FAKE_SUCCESS_RUN)
|
|
def test_run_command_extra_vars_twice(self, mock_run, mock_user,
|
|
mock_print, mock_log_dir):
|
|
run_called_args = {
|
|
'inventory': 'localhost',
|
|
'limit_hosts': None,
|
|
'group': [],
|
|
'extra_vars': {'key': 'value2'},
|
|
'validations_dir': '/usr/share/ansible/validation-playbooks',
|
|
'base_dir': '/usr/share/ansible',
|
|
'validation_name': ['foo'],
|
|
'extra_env_vars': None,
|
|
'python_interpreter': sys.executable,
|
|
'quiet': True,
|
|
'ssh_user': 'doe',
|
|
'log_path': mock_log_dir}
|
|
|
|
arglist = ['--validation', 'foo',
|
|
'--extra-vars', 'key=value1',
|
|
'--extra-vars', 'key=value2']
|
|
verifylist = [('validation_name', ['foo']),
|
|
('extra_vars', {'key': 'value2'})]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.cmd.take_action(parsed_args)
|
|
mock_run.assert_called_with(**run_called_args)
|
|
|
|
def test_run_command_exclusive_vars(self):
|
|
arglist = ['--validation', 'foo',
|
|
'--extra-vars', 'key=value1',
|
|
'--extra-vars-file', '/foo/vars.yaml']
|
|
verifylist = [('validation_name', ['foo']),
|
|
('extra_vars', {'key': 'value2'})]
|
|
|
|
self.assertRaises(Exception, self.check_parser, self.cmd,
|
|
arglist, verifylist)
|
|
|
|
@mock.patch('validations_libs.constants.VALIDATIONS_LOG_BASEDIR')
|
|
@mock.patch('yaml.safe_load', return_value={'key': 'value'})
|
|
@mock.patch('six.moves.builtins.open')
|
|
@mock.patch('getpass.getuser',
|
|
return_value='doe')
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=fakes.FAKE_SUCCESS_RUN)
|
|
def test_run_command_extra_vars_file(self, mock_run, mock_user, mock_open,
|
|
mock_yaml, mock_log_dir):
|
|
|
|
run_called_args = {
|
|
'inventory': 'localhost',
|
|
'limit_hosts': None,
|
|
'group': [],
|
|
'extra_vars': {'key': 'value'},
|
|
'validations_dir': '/usr/share/ansible/validation-playbooks',
|
|
'base_dir': '/usr/share/ansible',
|
|
'validation_name': ['foo'],
|
|
'extra_env_vars': None,
|
|
'python_interpreter': sys.executable,
|
|
'quiet': True,
|
|
'ssh_user': 'doe',
|
|
'log_path': mock_log_dir}
|
|
|
|
arglist = ['--validation', 'foo',
|
|
'--extra-vars-file', '/foo/vars.yaml']
|
|
verifylist = [('validation_name', ['foo']),
|
|
('extra_vars_file', '/foo/vars.yaml')]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.cmd.take_action(parsed_args)
|
|
mock_run.assert_called_with(**run_called_args)
|
|
|
|
@mock.patch('validations_libs.constants.VALIDATIONS_LOG_BASEDIR')
|
|
@mock.patch('getpass.getuser',
|
|
return_value='doe')
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=fakes.FAKE_SUCCESS_RUN)
|
|
def test_run_command_extra_env_vars(self, mock_run, mock_user, mock_log_dir):
|
|
run_called_args = {
|
|
'inventory': 'localhost',
|
|
'limit_hosts': None,
|
|
'group': [],
|
|
'extra_vars': None,
|
|
'validations_dir': '/usr/share/ansible/validation-playbooks',
|
|
'base_dir': '/usr/share/ansible',
|
|
'validation_name': ['foo'],
|
|
'extra_env_vars': {'key': 'value'},
|
|
'python_interpreter': sys.executable,
|
|
'quiet': True,
|
|
'ssh_user': 'doe',
|
|
'log_path': mock_log_dir}
|
|
|
|
arglist = ['--validation', 'foo',
|
|
'--extra-env-vars', 'key=value']
|
|
verifylist = [('validation_name', ['foo']),
|
|
('extra_env_vars', {'key': 'value'})]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.cmd.take_action(parsed_args)
|
|
mock_run.assert_called_with(**run_called_args)
|
|
|
|
@mock.patch('validations_libs.constants.VALIDATIONS_LOG_BASEDIR')
|
|
@mock.patch('getpass.getuser',
|
|
return_value='doe')
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=fakes.FAKE_SUCCESS_RUN)
|
|
def test_run_command_extra_env_vars_with_custom_callback(self,
|
|
mock_run,
|
|
mock_user,
|
|
mock_log_dir):
|
|
run_called_args = {
|
|
'inventory': 'localhost',
|
|
'limit_hosts': None,
|
|
'log_path': mock_log_dir,
|
|
'quiet': False,
|
|
'group': [],
|
|
'extra_vars': None,
|
|
'validations_dir': '/usr/share/ansible/validation-playbooks',
|
|
'base_dir': '/usr/share/ansible',
|
|
'validation_name': ['foo'],
|
|
'extra_env_vars': {'ANSIBLE_STDOUT_CALLBACK': 'default'},
|
|
'python_interpreter': sys.executable,
|
|
'quiet': False,
|
|
'ssh_user': 'doe'}
|
|
|
|
arglist = ['--validation', 'foo',
|
|
'--extra-env-vars', 'ANSIBLE_STDOUT_CALLBACK=default']
|
|
verifylist = [('validation_name', ['foo']),
|
|
('extra_env_vars', {'ANSIBLE_STDOUT_CALLBACK': 'default'})]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.cmd.take_action(parsed_args)
|
|
mock_run.assert_called_with(**run_called_args)
|
|
|
|
@mock.patch('validations_libs.constants.VALIDATIONS_LOG_BASEDIR')
|
|
@mock.patch('getpass.getuser',
|
|
return_value='doe')
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=fakes.FAKE_SUCCESS_RUN)
|
|
def test_run_command_extra_env_vars_twice(self, mock_run, mock_user, mock_log_dir):
|
|
run_called_args = {
|
|
'inventory': 'localhost',
|
|
'limit_hosts': None,
|
|
'group': [],
|
|
'extra_vars': None,
|
|
'validations_dir': '/usr/share/ansible/validation-playbooks',
|
|
'base_dir': '/usr/share/ansible',
|
|
'validation_name': ['foo'],
|
|
'extra_env_vars': {'key': 'value2'},
|
|
'python_interpreter': sys.executable,
|
|
'quiet': True,
|
|
'ssh_user': 'doe',
|
|
'log_path': mock_log_dir}
|
|
|
|
arglist = ['--validation', 'foo',
|
|
'--extra-env-vars', 'key=value1',
|
|
'--extra-env-vars', 'key=value2']
|
|
verifylist = [('validation_name', ['foo']),
|
|
('extra_env_vars', {'key': 'value2'})]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.cmd.take_action(parsed_args)
|
|
mock_run.assert_called_with(**run_called_args)
|
|
|
|
@mock.patch('validations_libs.constants.VALIDATIONS_LOG_BASEDIR')
|
|
@mock.patch('getpass.getuser',
|
|
return_value='doe')
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=fakes.FAKE_SUCCESS_RUN)
|
|
def test_run_command_extra_env_vars_and_extra_vars(self,
|
|
mock_run,
|
|
mock_user,
|
|
mock_log_dir):
|
|
run_called_args = {
|
|
'inventory': 'localhost',
|
|
'limit_hosts': None,
|
|
'group': [],
|
|
'extra_vars': {'key': 'value'},
|
|
'validations_dir': '/usr/share/ansible/validation-playbooks',
|
|
'base_dir': '/usr/share/ansible',
|
|
'validation_name': ['foo'],
|
|
'extra_env_vars': {'key2': 'value2'},
|
|
'python_interpreter': sys.executable,
|
|
'quiet': True,
|
|
'ssh_user': 'doe',
|
|
'log_path': mock_log_dir}
|
|
|
|
arglist = ['--validation', 'foo',
|
|
'--extra-vars', 'key=value',
|
|
'--extra-env-vars', 'key2=value2']
|
|
verifylist = [('validation_name', ['foo']),
|
|
('extra_vars', {'key': 'value'}),
|
|
('extra_env_vars', {'key2': 'value2'})]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.cmd.take_action(parsed_args)
|
|
mock_run.assert_called_with(**run_called_args)
|
|
|
|
def test_run_command_exclusive_wrong_extra_vars(self):
|
|
arglist = ['--validation', 'foo',
|
|
'--extra-vars', 'key=value1,key=value2']
|
|
verifylist = [('validation_name', ['foo']),
|
|
('extra_vars', {'key': 'value2'})]
|
|
|
|
self.assertRaises(Exception, self.check_parser, self.cmd,
|
|
arglist, verifylist)
|
|
|
|
@mock.patch('getpass.getuser',
|
|
return_value='doe')
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=fakes.FAKE_FAILED_RUN)
|
|
def test_run_command_failed_validation(self, mock_run, mock_user):
|
|
run_called_args = {
|
|
'inventory': 'localhost',
|
|
'limit_hosts': None,
|
|
'group': [],
|
|
'extra_vars': {'key': 'value'},
|
|
'validations_dir': '/usr/share/ansible/validation-playbooks',
|
|
'base_dir': '/usr/share/ansible',
|
|
'validation_name': ['foo'],
|
|
'extra_env_vars': {'key2': 'value2'},
|
|
'python_interpreter': sys.executable,
|
|
'quiet': True,
|
|
'ssh_user': 'doe'}
|
|
|
|
arglist = ['--validation', 'foo']
|
|
verifylist = [('validation_name', ['foo'])]
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.assertRaises(RuntimeError, self.cmd.take_action, parsed_args)
|
|
|
|
@mock.patch('getpass.getuser',
|
|
return_value='doe')
|
|
@mock.patch('validations_libs.validation_actions.ValidationActions.'
|
|
'run_validations',
|
|
return_value=[])
|
|
def test_run_command_no_validation(self, mock_run, mock_user):
|
|
run_called_args = {
|
|
'inventory': 'localhost',
|
|
'limit_hosts': None,
|
|
'group': [],
|
|
'extra_vars': {'key': 'value'},
|
|
'validations_dir': '/usr/share/ansible/validation-playbooks',
|
|
'base_dir': '/usr/share/ansible',
|
|
'validation_name': ['foo'],
|
|
'extra_env_vars': {'key2': 'value2'},
|
|
'python_interpreter': sys.executable,
|
|
'quiet': True,
|
|
'ssh_user': 'doe'}
|
|
|
|
arglist = ['--validation', 'foo']
|
|
verifylist = [('validation_name', ['foo'])]
|
|
|
|
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
|
|
self.assertRaises(RuntimeError, self.cmd.take_action, parsed_args)
|