openstack/validations-libs
Code Issues Proposed changes

Improved log path handling

Browse Source 
Validations logging now has several documented fallbacks.
constants.py now includes constant default path,
in order to improve readability and provide reference.

utils.py contains new test function to detect and log
when validations logs are stored in volatile /tmp.

Tests are included.

Complementary patch for validations_commons callbacks
is optional, as the behavior should stay largely the same.

Depends-On: https://review.opendev.org/c/openstack/validations-common/+/789782

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: I02df49532974cd0bcb2df8176b19ffc1cd5a65d1
This commit is contained in:
Jiri Podivin 2021-05-03 11:36:29 +02:00
parent 36c9b8cbcb
commit 0dca003674
5 changed files with 371 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
validations_libs/constants.py
View File

@ -24,9 +24,7 @@ VALIDATION_GROUPS = ['no-op',
'prep',
'post']
VALIDATIONS_LOG_BASEDIR = ('/var/log/validations'
if os.path.exists('/var/log/validations') else
os.getcwd())
VALIDATIONS_LOG_BASEDIR = os.path.join(os.environ.get('HOME'), 'validations')
VALIDATION_ANSIBLE_ARTIFACT_PATH = '{}/artifacts/'.format(
VALIDATIONS_LOG_BASEDIR)

124
validations_libs/tests/test_utils.py
View File

@ -47,17 +47,131 @@ class TestUtils(TestCase):
utils.get_validations_data,
validation)
@mock.patch('validations_libs.utils.Path.touch')
@mock.patch('validations_libs.utils.LOG.error')
@mock.patch('validations_libs.utils.LOG.warning')
@mock.patch('validations_libs.utils.os.path.exists',
return_value=True)
@mock.patch('validations_libs.utils.current_time',
return_value='2020-04-02T06:58:20.352272Z')
@mock.patch('os.makedirs')
def test_create_artifacts_dir(self, mock_makedirs,
mock_datetime, mock_path_exists,
mock_warning, mock_error,
mock_touch):
artifacts_dir = utils.get_artifacts_dir(
log_dir='/tmp/foo')
self.assertEqual(artifacts_dir,
'/tmp/foo/artifacts')
mock_error.assert_not_called()
mock_warning.assert_not_called()
@mock.patch('validations_libs.utils.Path.touch')
@mock.patch('validations_libs.utils.LOG.error')
@mock.patch('validations_libs.utils.LOG.warning')
@mock.patch('validations_libs.utils.current_time',
return_value='2020-04-02T06:58:20.352272Z')
@mock.patch('validations_libs.utils.get_log_dir', return_value='/tmp/foo')
@mock.patch('validations_libs.utils.os.path.exists', return_value=False)
@mock.patch('os.makedirs', side_effect=[OSError, None])
def test_create_artifacts_dir_OSError(self, mock_makedirs,
mock_get_log_dir,
mock_exists, mock_datetime,
mock_warning, mock_error,
mock_touch):
artifacts_dir = utils.get_artifacts_dir(
log_dir='/tmp/foo')
self.assertNotEqual(
artifacts_dir,
'/tmp/foo/')
mock_error.assert_called()
mock_warning.assert_called()
@mock.patch('validations_libs.utils.Path.touch')
@mock.patch('validations_libs.utils.LOG.error')
@mock.patch('validations_libs.utils.LOG.warning')
@mock.patch('validations_libs.utils.current_time',
return_value='2020-04-02T06:58:20.352272Z')
@mock.patch('validations_libs.utils.os.path.exists', return_value=False)
@mock.patch('os.makedirs', side_effect=[PermissionError, None])
def test_create_artifacts_dir_PermissionError(self, mock_makedirs,
mock_exists, mock_datetime,
mock_warning, mock_error,
mock_touch):
artifacts_dir = utils.get_artifacts_dir(
log_dir='/tmp/foo')
self.assertNotEqual(
artifacts_dir,
'/tmp/foo/')
mock_error.assert_called()
mock_warning.assert_called()
@mock.patch('validations_libs.utils.LOG.error')
@mock.patch('validations_libs.utils.LOG.warning')
@mock.patch('validations_libs.utils.os.path.exists',
return_value=True)
@mock.patch('validations_libs.utils.current_time',
return_value='2020-04-02T06:58:20.352272Z')
@mock.patch('os.makedirs')
@mock.patch('uuid.uuid4', return_value='1234')
def test_create_artifacts_dir(self, mock_uuid, mock_makedirs,
mock_datetime):
uuid, dir_path = utils.create_artifacts_dir(dir_path='/tmp/foo',
def test_create_artifacts_subdir(self, mock_uuid, mock_makedirs,
mock_datetime, mock_path_exists,
mock_warning, mock_error):
uuid, artifacts_dir = utils.get_artifacts_subdir(
log_dir='/tmp/foo/artifacts',
prefix='ntp')
self.assertEqual(uuid, '1234')
self.assertEqual(dir_path,
'/tmp/foo/1234_ntp_2020-04-02T06:58:20.352272Z')
self.assertEqual(artifacts_dir,
'/tmp/foo/artifacts/1234_ntp_2020-04-02T06:58:20.352272Z')
mock_error.assert_not_called()
mock_warning.assert_not_called()
@mock.patch('validations_libs.utils.LOG.exception')
@mock.patch('validations_libs.utils.current_time',
return_value='2020-04-02T06:58:20.352272Z')
@mock.patch('validations_libs.utils.os.path.exists', return_value=False)
@mock.patch('os.makedirs', side_effect=[OSError, None])
@mock.patch('uuid.uuid4', return_value='1234')
def test_create_artifacts_subdir_OSError(self, mock_uuid, mock_makedirs,
mock_exists, mock_datetime,
mock_exception):
self.assertRaises(
RuntimeError,
utils.get_artifacts_subdir,
log_dir='/tmp/foo/artifacts',
prefix='ntp')
mock_exception.assert_called()
@mock.patch('validations_libs.utils.LOG.exception')
@mock.patch('validations_libs.utils.current_time',
return_value='2020-04-02T06:58:20.352272Z')
@mock.patch('validations_libs.utils.os.path.exists', return_value=False)
@mock.patch('os.makedirs', side_effect=[PermissionError, None])
@mock.patch('uuid.uuid4', return_value='1234')
def test_create_artifacts_subdir_PermissionError(self, mock_uuid,
mock_makedirs,
mock_exists, mock_datetime,
mock_exception):
self.assertRaises(
RuntimeError,
utils.get_artifacts_subdir,
log_dir='/tmp/foo/artifacts',
prefix='ntp')
mock_exception.assert_called()
@mock.patch('yaml.safe_load', return_value=fakes.FAKE_PLAYBOOK)
@mock.patch('six.moves.builtins.open')

114
validations_libs/tests/test_validation_actions.py
View File

@ -45,11 +45,17 @@ class TestValidationActions(TestCase):
'My Validation Two Name',
['prep', 'pre-introspection'])]))
@mock.patch('validations_libs.utils.create_artifacts_dir',
return_value=('1234', '/tmp/'))
@mock.patch('validations_libs.utils.get_artifacts_subdir',
return_value=('123', '/var/log/validations'))
@mock.patch('validations_libs.utils.get_artifacts_dir',
return_value='/var/log/validations/artifacts')
@mock.patch('validations_libs.utils.get_log_dir',
return_value=('/var/log/validations'))
@mock.patch('validations_libs.utils.get_validations_playbook',
return_value=['/tmp/foo/fake.yaml'])
def test_validation_skip_validation(self, mock_validation_play, mock_tmp):
def test_validation_skip_validation(self, mock_validation_play,
mock_logdir, mock_artdir,
mock_artsubdir):
playbook = ['fake.yaml']
inventory = 'tmp/inventory.yaml'
@ -66,16 +72,24 @@ class TestValidationActions(TestCase):
limit_hosts=None)
self.assertEqual(run_return, [])
@mock.patch('validations_libs.utils.get_artifacts_subdir',
return_value=(
'123',
'/var/log/validations/artifacts/123_foo_time'))
@mock.patch('validations_libs.utils.get_artifacts_dir',
return_value='/var/log/validations/artifacts')
@mock.patch('validations_libs.utils.get_log_dir',
return_value=('/var/log/validations'))
@mock.patch('validations_libs.utils.get_validations_playbook',
return_value=['/tmp/foo/fake.yaml'])
@mock.patch('validations_libs.ansible.Ansible.run')
@mock.patch('validations_libs.utils.create_artifacts_dir',
return_value=('1234', '/tmp/'))
def test_validation_skip_on_specific_host(self, mock_tmp, mock_ansible_run,
mock_validation_play):
def test_validation_skip_on_specific_host(self, mock_ansible_run,
mock_validation_play,
mock_get_log_dir, mock_artdir,
mock_artsubdir):
mock_ansible_run.return_value = ('fake.yaml', 0, 'successful')
run_called_args = {
'workdir': '/tmp/',
'workdir': '/var/log/validations/artifacts/123_foo_time',
'playbook': '/tmp/foo/fake.yaml',
'base_dir': '/usr/share/ansible/',
'playbook_dir': '/tmp/foo',
@ -86,11 +100,11 @@ class TestValidationActions(TestCase):
'quiet': True,
'extra_vars': None,
'limit_hosts': '!cloud1',
'ansible_artifact_path': '/tmp/',
'ansible_artifact_path': '/var/log/validations/artifacts/123_foo_time',
'extra_env_variables': None,
'ansible_cfg': None,
'gathering_policy': 'explicit',
'log_path': None,
'log_path': '/var/log/validations',
'run_async': False,
'python_interpreter': None,
'ssh_user': None
@ -112,16 +126,25 @@ class TestValidationActions(TestCase):
)
mock_ansible_run.assert_called_with(**run_called_args)
@mock.patch('validations_libs.utils.get_artifacts_subdir',
return_value=(
'123',
'/var/log/validations/artifacts/123_foo_time'))
@mock.patch('validations_libs.utils.get_artifacts_dir',
return_value='/var/log/validations/artifacts')
@mock.patch('validations_libs.utils.get_log_dir',
return_value='/var/log/validations')
@mock.patch('validations_libs.utils.get_validations_playbook',
return_value=['/tmp/foo/fake.yaml'])
@mock.patch('validations_libs.ansible.Ansible.run')
@mock.patch('validations_libs.utils.create_artifacts_dir',
return_value=('1234', '/tmp/'))
def test_validation_skip_with_limit_host(self, mock_tmp, mock_ansible_run,
mock_validation_play):
def test_validation_skip_with_limit_host(self, mock_ansible_run,
mock_validation_play,
mock_get_log_dir, mock_artdir,
mock_artsubdir):
mock_ansible_run.return_value = ('fake.yaml', 0, 'successful')
run_called_args = {
'workdir': '/tmp/',
'workdir': '/var/log/validations/artifacts/123_foo_time',
'playbook': '/tmp/foo/fake.yaml',
'base_dir': '/usr/share/ansible/',
'playbook_dir': '/tmp/foo',
@ -135,8 +158,8 @@ class TestValidationActions(TestCase):
'extra_env_variables': None,
'ansible_cfg': None,
'gathering_policy': 'explicit',
'ansible_artifact_path': '/tmp/',
'log_path': None,
'ansible_artifact_path': '/var/log/validations/artifacts/123_foo_time',
'log_path': '/var/log/validations',
'run_async': False,
'python_interpreter': None,
'ssh_user': None
@ -157,35 +180,34 @@ class TestValidationActions(TestCase):
limit_hosts='cloud,cloud1,!cloud2')
mock_ansible_run.assert_called_with(**run_called_args)
@mock.patch('validations_libs.validation_logs.ValidationLogs.get_results')
@mock.patch('validations_libs.utils.get_artifacts_subdir',
return_value=(
'123',
'/var/log/validations/artifacts/123_foo_time'))
@mock.patch('validations_libs.utils.get_artifacts_dir',
return_value='/var/log/validations/artifacts')
@mock.patch('validations_libs.utils.get_log_dir',
return_value='/var/log/validations')
@mock.patch('validations_libs.validation_actions.ValidationLogs.get_results',
side_effect=fakes.FAKE_SUCCESS_RUN)
@mock.patch('validations_libs.utils.parse_all_validations_on_disk')
@mock.patch('validations_libs.ansible.Ansible.run')
@mock.patch('validations_libs.utils.create_artifacts_dir',
return_value=('1234', '/tmp/'))
def test_validation_run_success(self, mock_tmp, mock_ansible_run,
mock_validation_dir, mock_results):
def test_validation_run_success(self, mock_ansible_run,
mock_validation_dir,
mock_results,
mock_get_log_dir, mock_artdir,
mock_artsubdir):
mock_validation_dir.return_value = [{
'description': 'My Validation One Description',
'groups': ['prep', 'pre-deployment'],
'id': 'foo',
'name': 'My Validition One Name',
'parameters': {}}]
mock_ansible_run.return_value = ('foo.yaml', 0, 'successful')
mock_results.return_value = [{'Duration': '0:00:01.761',
'Host_Group': 'overcloud',
'Status': 'PASSED',
'Status_by_Host': 'subnode-1,PASSED',
'UUID': 'foo',
'Unreachable_Hosts': '',
'Validations': 'ntp'}]
expected_run_return = [{'Duration': '0:00:01.761',
'Host_Group': 'overcloud',
'Status': 'PASSED',
'Status_by_Host': 'subnode-1,PASSED',
'UUID': 'foo',
'Unreachable_Hosts': '',
'Validations': 'ntp'}]
expected_run_return = fakes.FAKE_SUCCESS_RUN[0]
playbook = ['fake.yaml']
inventory = 'tmp/inventory.yaml'
@ -206,20 +228,31 @@ class TestValidationActions(TestCase):
validations_dir='/tmp/foo'
)
@mock.patch('validations_libs.utils.get_artifacts_subdir',
return_value=(
'123',
'/var/log/validations/artifacts/123_foo_time'))
@mock.patch('validations_libs.utils.get_artifacts_dir',
return_value='/var/log/validations/artifacts')
@mock.patch('validations_libs.utils.get_log_dir',
return_value='/var/log/validations')
@mock.patch('validations_libs.validation_logs.ValidationLogs.get_results')
@mock.patch('validations_libs.utils.parse_all_validations_on_disk')
@mock.patch('validations_libs.ansible.Ansible.run')
@mock.patch('validations_libs.utils.create_artifacts_dir',
return_value=('1234', '/tmp/'))
def test_validation_run_failed(self, mock_tmp, mock_ansible_run,
mock_validation_dir, mock_results):
def test_validation_run_failed(self, mock_ansible_run,
mock_validation_dir, mock_results,
mock_get_log_dir, mock_artdir,
mock_artsubdir):
mock_validation_dir.return_value = [{
'description': 'My Validation One Description',
'groups': ['prep', 'pre-deployment'],
'id': 'foo',
'name': 'My Validition One Name',
'parameters': {}}]
mock_ansible_run.return_value = ('foo.yaml', 0, 'failed')
mock_results.return_value = [{'Duration': '0:00:01.761',
'Host_Group': 'overcloud',
'Status': 'PASSED',
@ -227,6 +260,7 @@ class TestValidationActions(TestCase):
'UUID': 'foo',
'Unreachable_Hosts': '',
'Validations': 'ntp'}]
expected_run_return = [{'Duration': '0:00:01.761',
'Host_Group': 'overcloud',
'Status': 'PASSED',

176
validations_libs/utils.py
View File

@ -19,6 +19,7 @@ import os
import six
import uuid
from pathlib import Path
from os.path import join
from validations_libs import constants
from validations_libs.group import Group
@ -32,32 +33,179 @@ def current_time():
return '%sZ' % datetime.datetime.utcnow().isoformat()
def create_artifacts_dir(dir_path=None, prefix=None):
def _create_log_dir():
"""Create default validations log dir.
Log the failure if encountering OSError or PermissionError.
:raises: RuntimeError
"""
try:
log_path = "{}".format(constants.VALIDATIONS_LOG_BASEDIR)
os.makedirs(log_path)
except (OSError, PermissionError):
LOG.error(
(
"Error while creating the log directory. "
"Please check the access rights for: '{}'"
).format(log_path)
)
raise RuntimeError()
def get_log_dir(log_path):
"""Get validations log directory.
Default to `constants.VALIDATIONS_LOG_BASEDIR` if the selected
`log_path` does not exist.
Attempt to create default log directory if it's missing.
:param log_path: selected log dir absolute path
:log_path type: `string`
:return: verified validations log path
:rtype: `string`
"""
if not os.path.exists(log_path):
LOG.warning(
(
"Requested log folder unavailable, defaulting to: '{}'"
).format(constants.VALIDATIONS_LOG_BASEDIR)
)
log_path = constants.VALIDATIONS_LOG_BASEDIR
if not os.path.exists(constants.VALIDATIONS_LOG_BASEDIR):
LOG.warning(
(
"Default log folder unavailable, creating: '{}'"
).format(log_path)
)
_create_log_dir()
return log_path
def _setup_artifacts_dir(log_path):
"""
:param log_path: selected log dir absolute path
:log_path type: `string`
:return: verified validations log path
:rtype: `string`
"""
artifact_dir = os.path.join(log_path, 'artifacts')
if not os.path.exists(artifact_dir):
os.makedirs(artifact_dir)
marker = Path(
os.path.join(artifact_dir, '.validationsartifacts'))
marker.touch()
return artifact_dir
def _create_artifacts_subdir(artifacts_dir_path, prefix):
"""Create Ansible artifacts directory
:param dir_path: Directory asbolute path
:type dir_path: `string`
:param artifacts_dir_path: Directory absolute path
:type artifacts_dir_path: `string`
:param prefix: Playbook name
:type prefix: `string`
:return: The UUID of the validation and the absolute Path of the log file
:return: The UUID of the validation and the absolute path of the log file
:rtype: `string`, `string`
"""
dir_path = (dir_path if dir_path else
constants.VALIDATION_ANSIBLE_ARTIFACT_PATH)
validation_uuid = str(uuid.uuid4())
log_dir = "{}/{}_{}_{}".format(dir_path, validation_uuid,
(prefix if prefix else ''), current_time())
artifact_sub_dir = "{}_{}_{}".format(
validation_uuid,
prefix,
current_time())
artifact_sub_dir = os.path.join(artifacts_dir_path, artifact_sub_dir)
os.makedirs(artifact_sub_dir)
return validation_uuid, artifact_sub_dir
def get_artifacts_dir(log_dir):
"""Retrieve Ansible artifacts directory
This function contains additional checks for the log directory
access as well as possible fallbacks.
In order, following locations are considered for artifacts directory:
`log_dir` parameter
`validations_libs.constants.VALIDATION_ANSIBLE_ARTIFACT_PATH`
Error and warning is logged, to notify the user about remediation,
and possible complexities it may lead to.
:param log_dir: Directory absolute path
:type log_dir: `string`
:return: artifacts_dir path
:rtype: `string`
"""
try:
os.makedirs(log_dir)
return validation_uuid, log_dir
except OSError:
LOG.exception(
artifacts_dir = _setup_artifacts_dir(log_dir)
except (OSError, PermissionError):
LOG.error(
(
"Error while creating Ansible artifacts log file."
"Please check the access rights for {}"
"Error while creating Ansible artifacts directory. "
"Please check the access rights for: '{}'"
).format(log_dir)
)
artifacts_dir = _setup_artifacts_dir(
constants.VALIDATION_ANSIBLE_ARTIFACT_PATH)
LOG.warning(
(
"Selected artifact folder unavailable, defaulting to: '{}'"
).format(artifacts_dir)
)
return artifacts_dir
def get_results_dirs(log_path):
"""
:param log_path: Absolute log directory path
:type log_path: `string`
:return: log path and artifacts path
:rtype: `string`, `string`
"""
log_path = get_log_dir(log_path)
artifacts_path = get_artifacts_dir(log_path)
return log_path, artifacts_path
def get_artifacts_subdir(log_dir, prefix=''):
"""Retrieve Ansible artifacts directory
:param log_dir: Directory absolute path
:type log_dir: `string`
:param prefix: Playbook name
:type prefix: `string`
:return: The UUID of the validation and the absolute path of the log file
:rtype: `string`, `string`
"""
try:
validation_uuid, artifacts_dir = _create_artifacts_subdir(
log_dir,
prefix)
except (OSError, PermissionError):
LOG.exception(
(
"Error while creating Ansible artifacts directory. "
"Please check the access rights for: '{}'"
).format(log_dir)
)
raise RuntimeError()
return validation_uuid, artifacts_dir
def parse_all_validations_on_disk(path, groups=None):
"""Return a list of validations metadata which can be sorted by Groups

22
validations_libs/validation_actions.py
View File

@ -208,7 +208,8 @@ class ValidationActions(object):
extra_env_vars=None, ansible_cfg=None, quiet=True,
workdir=None, limit_hosts=None, run_async=False,
base_dir=constants.DEFAULT_VALIDATIONS_BASEDIR,
log_path=None, python_interpreter=None,
log_path=constants.VALIDATIONS_LOG_BASEDIR,
python_interpreter=None,
skip_list=None,
callback_whitelist=None,
output_callback='validation_stdout',
@ -248,6 +249,8 @@ class ValidationActions(object):
``constants.DEFAULT_VALIDATIONS_BASEDIR``)
:type base_dir: ``string``
:param log_path: The absolute path of the validations logs directory
(Defaults to
``constants.VALIDATIONS_LOG_BASEDIR``)
:type log_path: ``string``
:param python_interpreter: Path to the Python interpreter to be
used for module execution on remote targets,
@ -333,6 +336,8 @@ class ValidationActions(object):
else:
raise RuntimeError("No validations found")
log_path = v_utils.get_log_dir(log_path)
artifacts_path = v_utils.get_artifacts_dir(log_path)
self.log.debug('Running the validations with Ansible')
results = []
for playbook in playbooks:
@ -342,11 +347,12 @@ class ValidationActions(object):
play_name,
limit_hosts)
if _play:
validation_uuid, artifacts_dir = v_utils.create_artifacts_dir(
dir_path=log_path, prefix=os.path.basename(playbook))
run_ansible = v_ansible(validation_uuid)
val_uuid, art_dir = v_utils.get_artifacts_subdir(
log_dir=artifacts_path,
prefix=os.path.basename(playbook))
run_ansible = v_ansible(val_uuid)
_playbook, _rc, _status = run_ansible.run(
workdir=artifacts_dir,
workdir=art_dir,
playbook=playbook,
base_dir=base_dir,
playbook_dir=validations_dir,
@ -360,7 +366,7 @@ class ValidationActions(object):
extra_env_variables=extra_env_vars,
ansible_cfg=ansible_cfg,
gathering_policy='explicit',
ansible_artifact_path=artifacts_dir,
ansible_artifact_path=art_dir,
log_path=log_path,
run_async=run_async,
python_interpreter=python_interpreter,
@ -369,7 +375,7 @@ class ValidationActions(object):
'rc_code': _rc,
'status': _status,
'validations': _playbook.split('.')[0],
'UUID': validation_uuid,
'UUID': val_uuid,
})
else:
self.log.debug('Skipping Validations: {}'.format(playbook))
@ -378,7 +384,7 @@ class ValidationActions(object):
return results
# Return log results
uuid = [id['UUID'] for id in results]
vlog = ValidationLogs()
vlog = ValidationLogs(log_path)
return vlog.get_results(uuid)
def group_information(self, groups):