b24d4ce792
Unused workdir argument of the run_validations method removed. Host and playbook skipping simplified. Docstrings adjusted, including some of the more important inline code examples. Test sensitivity to API changes was increased. More strict assertions have been put on the calls made in CLI. Logging statements related to the run action in validation_actions.py were expanded. New debug level logging statements introduced. One of the testing constants in the fakes.py was altered as it was not accurate representation of the real data, and as such was breaking the new logging statements during unit test runs. Deprecation notice for 'log_path' and 'groups' arguments, in both docstring and logging. Redundant conditionals for argument types were removed. The checks of the arguments are implemented in the function called in the subsequent statement. As there is no scenario in which one set of these checks passes, while the other fails with the same values, we can consider one of them to be redundant. Helper function 'get_validations_details' without active references was removed from utils submodule. Signed-off-by: Jiri Podivin <jpodivin@redhat.com> Change-Id: I781f6a6f9fc4bd558af56b648f0e0ee9f165dfab
132 lines
5.0 KiB
Python
132 lines
5.0 KiB
Python
#!/usr/bin/env 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 json
|
|
|
|
from validations_libs import constants
|
|
from validations_libs.validation_actions import ValidationActions
|
|
from validations_libs.validation_logs import ValidationLogs
|
|
from validations_libs.cli.base import BaseCommand, BaseLister
|
|
|
|
|
|
class ListHistory(BaseLister):
|
|
"""Display Validations execution history"""
|
|
|
|
def get_parser(self, parser):
|
|
parser = super(ListHistory, self).get_parser(parser)
|
|
|
|
parser.add_argument('--validation',
|
|
metavar="<validation_id>",
|
|
type=str,
|
|
help='Display execution history for a validation')
|
|
parser.add_argument('--limit',
|
|
dest='history_limit',
|
|
type=int,
|
|
default=15,
|
|
help=(
|
|
'Display <n> most recent '
|
|
'runs of the selected <validation>. '
|
|
'<n> must be > 0\n'
|
|
'The default display limit is set to 15.\n'))
|
|
parser.add_argument('--validation-log-dir', dest='validation_log_dir',
|
|
default=constants.VALIDATIONS_LOG_BASEDIR,
|
|
help=("Path where the validation log files "
|
|
"is located."))
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
# Merge config and CLI args:
|
|
self.base.set_argument_parser(self, parsed_args)
|
|
|
|
validation_log_dir = parsed_args.validation_log_dir
|
|
history_limit = parsed_args.history_limit
|
|
|
|
if history_limit < 1:
|
|
msg = ("Number <n> of the most recent runs must be > 0. "
|
|
"You have provided {}").format(history_limit)
|
|
raise ValueError(msg)
|
|
self.app.LOG.info(
|
|
("Limiting output to the maximum of "
|
|
"{} last validations.").format(history_limit))
|
|
|
|
actions = ValidationActions(log_path=parsed_args.validation_log_dir)
|
|
|
|
return actions.show_history(
|
|
validation_ids=parsed_args.validation,
|
|
history_limit=history_limit)
|
|
|
|
|
|
class GetHistory(BaseCommand):
|
|
"""Display details about a specific Validation execution"""
|
|
|
|
def get_parser(self, parser):
|
|
parser = super(GetHistory, self).get_parser(parser)
|
|
parser.add_argument('uuid',
|
|
metavar="<uuid>",
|
|
type=str,
|
|
help='Validation UUID Run')
|
|
|
|
parser.add_argument('--full',
|
|
action='store_true',
|
|
help='Show Full Details for the run')
|
|
|
|
parser.add_argument('--validation-log-dir', dest='validation_log_dir',
|
|
default=constants.VALIDATIONS_LOG_BASEDIR,
|
|
help=("Path where the validation log files "
|
|
"is located."))
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
# Merge config and CLI args:
|
|
self.base.set_argument_parser(self, parsed_args)
|
|
|
|
self.app.LOG.debug(
|
|
(
|
|
"Obtaining information about the validation run {}\n"
|
|
"From directory {}"
|
|
).format(
|
|
parsed_args.uuid,
|
|
parsed_args.validation_log_dir))
|
|
|
|
vlogs = ValidationLogs(logs_path=parsed_args.validation_log_dir)
|
|
|
|
try:
|
|
log_files = vlogs.get_logfile_content_by_uuid(parsed_args.uuid)
|
|
except IOError as io_error:
|
|
raise RuntimeError(
|
|
(
|
|
"Encountered a following IO error while attempting read a log "
|
|
"file linked to UUID: {} .\n"
|
|
"{}"
|
|
).format(
|
|
parsed_args.uuid,
|
|
io_error))
|
|
|
|
if log_files:
|
|
if parsed_args.full:
|
|
for log_file in log_files:
|
|
print(json.dumps(log_file, indent=4, sort_keys=True))
|
|
else:
|
|
for log_file in log_files:
|
|
for validation_result in log_file.get('validation_output', []):
|
|
print(json.dumps(validation_result['task'],
|
|
indent=4,
|
|
sort_keys=True))
|
|
else:
|
|
raise RuntimeError(
|
|
"Could not find the log file linked to this UUID: {}".format(
|
|
parsed_args.uuid))
|