467 lines
16 KiB
Python
467 lines
16 KiB
Python
# Copyright 2019 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 argparse
|
|
import json
|
|
import logging
|
|
import yaml
|
|
|
|
from osc_lib import exceptions
|
|
from osc_lib.i18n import _
|
|
from prettytable import PrettyTable
|
|
|
|
from tripleoclient import command
|
|
from tripleoclient import constants
|
|
from tripleoclient import utils as oooutils
|
|
from tripleoclient.workflows import plan_management
|
|
|
|
from validations_libs import constants as v_consts
|
|
from validations_libs import utils as v_utils
|
|
from validations_libs.validation_actions import ValidationActions
|
|
from validations_libs.validation_logs import ValidationLogs
|
|
|
|
LOG = logging.getLogger(__name__ + ".TripleoValidator")
|
|
|
|
RED = "\033[1;31m"
|
|
GREEN = "\033[0;32m"
|
|
CYAN = "\033[36m"
|
|
RESET = "\033[0;0m"
|
|
|
|
FAILED_VALIDATION = "{}FAILED{}".format(RED, RESET)
|
|
PASSED_VALIDATION = "{}PASSED{}".format(GREEN, RESET)
|
|
|
|
GROUP_FILE = constants.VALIDATION_GROUPS_INFO
|
|
|
|
|
|
class _CommaListGroupAction(argparse.Action):
|
|
def __call__(self, parser, namespace, values, option_string=None):
|
|
opts = v_utils.get_validation_group_name_list(GROUP_FILE)
|
|
for value in values.split(','):
|
|
if value not in opts:
|
|
message = ("Invalid choice: {value} (choose from {choice})"
|
|
.format(value=value,
|
|
choice=opts))
|
|
raise argparse.ArgumentError(self, message)
|
|
setattr(namespace, self.dest, values.split(','))
|
|
|
|
|
|
class _CommaListAction(argparse.Action):
|
|
def __call__(self, parser, namespace, values, option_string=None):
|
|
setattr(namespace, self.dest, values.split(','))
|
|
|
|
|
|
class TripleOValidatorGroupInfo(command.Lister):
|
|
"""Display Information about Validation Groups"""
|
|
|
|
auth_required = False
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(TripleOValidatorGroupInfo, self).get_parser(prog_name)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
actions = ValidationActions(constants.ANSIBLE_VALIDATION_DIR)
|
|
return actions.group_information(GROUP_FILE)
|
|
|
|
|
|
class TripleOValidatorShow(command.ShowOne):
|
|
"""Display detailed information about a Validation"""
|
|
|
|
auth_required = False
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(TripleOValidatorShow, self).get_parser(prog_name)
|
|
|
|
parser.add_argument('validation_id',
|
|
metavar="<validation>",
|
|
type=str,
|
|
help='Validation ID')
|
|
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
LOG.debug(_('Show validation result'))
|
|
actions = ValidationActions(constants.ANSIBLE_VALIDATION_DIR)
|
|
|
|
try:
|
|
data = actions.show_validations(parsed_args.validation_id)
|
|
except Exception as e:
|
|
raise exceptions.CommandError(e)
|
|
|
|
if data:
|
|
return data.keys(), data.values()
|
|
|
|
|
|
class TripleOValidatorShowParameter(command.Command):
|
|
"""Display Validations Parameters"""
|
|
|
|
auth_required = False
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = argparse.ArgumentParser(
|
|
description=self.get_description(),
|
|
prog=prog_name,
|
|
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
|
add_help=True
|
|
)
|
|
|
|
ex_group = parser.add_mutually_exclusive_group(required=False)
|
|
|
|
ex_group.add_argument(
|
|
'--validation',
|
|
metavar='<validation_id>[,<validation_id>,...]',
|
|
dest='validation_name',
|
|
action=_CommaListAction,
|
|
default=[],
|
|
help=_("List specific validations, "
|
|
"if more than one validation is required "
|
|
"separate the names with commas: "
|
|
"--validation check-ftype,512e | "
|
|
"--validation 512e")
|
|
)
|
|
|
|
ex_group.add_argument(
|
|
'--group',
|
|
metavar='<group_id>[,<group_id>,...]',
|
|
action=_CommaListGroupAction,
|
|
default=[],
|
|
help=_("List specific group validations, "
|
|
"if more than one group is required "
|
|
"separate the group names with commas: "
|
|
"pre-upgrade,prep | "
|
|
"openshift-on-openstack")
|
|
)
|
|
|
|
parser.add_argument(
|
|
'--download',
|
|
action='store',
|
|
default=None,
|
|
help=_("Create a json or a yaml file "
|
|
"containing all the variables "
|
|
"available for the validations: "
|
|
"/tmp/myvars")
|
|
)
|
|
|
|
parser.add_argument(
|
|
'-f', '--format',
|
|
action='store',
|
|
metavar='<format>',
|
|
default='json',
|
|
choices=['json', 'yaml'],
|
|
help=_("Print representation of the validation. "
|
|
"The choices of the output format is json,yaml. ")
|
|
)
|
|
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
actions = ValidationActions(constants.ANSIBLE_VALIDATION_DIR)
|
|
params = actions.show_validations_parameters(
|
|
parsed_args.validation_name,
|
|
parsed_args.group,
|
|
parsed_args.format,
|
|
parsed_args.download)
|
|
if parsed_args.download:
|
|
print("The file {} has been created successfully".format(
|
|
parsed_args.download))
|
|
else:
|
|
print(params)
|
|
|
|
|
|
class TripleOValidatorList(command.Lister):
|
|
"""List the available validations"""
|
|
|
|
auth_required = False
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(TripleOValidatorList, self).get_parser(prog_name)
|
|
|
|
parser.add_argument(
|
|
'--group',
|
|
metavar='<group>[,<group>,...]',
|
|
action=_CommaListGroupAction,
|
|
default=[],
|
|
help=_("List specific group validations, "
|
|
"if more than one group is required "
|
|
"separate the group names with commas: "
|
|
"--group pre-upgrade,prep | "
|
|
"--group openshift-on-openstack")
|
|
)
|
|
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
LOG.debug(_('Launch listing the validations'))
|
|
try:
|
|
v_consts.DEFAULT_VALIDATIONS_BASEDIR = constants.\
|
|
DEFAULT_VALIDATIONS_BASEDIR
|
|
actions = ValidationActions(constants.ANSIBLE_VALIDATION_DIR,
|
|
parsed_args.group)
|
|
return actions.list_validations()
|
|
except Exception as e:
|
|
raise RuntimeError(_("Validations listing finished with errors\n"
|
|
"Output: {}").format(e))
|
|
|
|
|
|
class TripleOValidatorRun(command.Command):
|
|
"""Run the available validations"""
|
|
|
|
auth_required = False
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = argparse.ArgumentParser(
|
|
description=self.get_description(),
|
|
prog=prog_name,
|
|
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
|
add_help=False
|
|
)
|
|
|
|
parser.add_argument(
|
|
'--plan', '--stack',
|
|
dest='plan',
|
|
default='overcloud',
|
|
help=_("Execute the validations using a custom plan name")
|
|
)
|
|
|
|
parser.add_argument(
|
|
'--limit', action='store', required=False, help=_(
|
|
"A string that identifies a single node or comma-separated"
|
|
"list of nodes to be upgraded in parallel in this upgrade"
|
|
" run invocation. For example: --limit \"compute-0,"
|
|
" compute-1, compute-5\".")
|
|
)
|
|
extra_vars_group = parser.add_mutually_exclusive_group(required=False)
|
|
|
|
extra_vars_group.add_argument(
|
|
'--extra-vars',
|
|
action='store',
|
|
default={},
|
|
type=json.loads,
|
|
help=_(
|
|
"Add a dictionary as extra variable to a validation: "
|
|
"--extra-vars '{\"min_undercloud_ram_gb\": 24}'")
|
|
)
|
|
|
|
extra_vars_group.add_argument(
|
|
'--extra-vars-file',
|
|
action='store',
|
|
default='',
|
|
help=_(
|
|
"Add a JSON/YAML file containing extra variable "
|
|
"to a validation: "
|
|
"--extra-vars-file /home/stack/vars.[json|yaml] "
|
|
"If using Mistral, only a valid JSON file will be "
|
|
"supported."
|
|
)
|
|
)
|
|
|
|
extra_vars_group.add_argument(
|
|
'--extra-env-vars',
|
|
action='store',
|
|
default={},
|
|
type=json.loads,
|
|
help=_(
|
|
"A dictionary as extra environment variables you may need "
|
|
"to provide to your Ansible execution example:"
|
|
"ANSIBLE_STDOUT_CALLBACK=default")
|
|
)
|
|
|
|
extra_vars_group.add_argument(
|
|
'--static-inventory',
|
|
action='store',
|
|
default='',
|
|
help=_(
|
|
"Provide your own static inventory file. You can generate "
|
|
"such an inventory calling tripleo-ansible-inventory command. "
|
|
"Especially useful when heat service isn't available."
|
|
)
|
|
)
|
|
|
|
ex_group = parser.add_mutually_exclusive_group(required=True)
|
|
|
|
ex_group.add_argument(
|
|
'--validation',
|
|
metavar='<validation_id>[,<validation_id>,...]',
|
|
dest="validation_name",
|
|
action=_CommaListAction,
|
|
default=[],
|
|
help=_("Run specific validations, "
|
|
"if more than one validation is required "
|
|
"separate the names with commas: "
|
|
"--validation check-ftype,512e | "
|
|
"--validation 512e")
|
|
)
|
|
|
|
ex_group.add_argument(
|
|
'--group',
|
|
metavar='<group>[,<group>,...]',
|
|
action=_CommaListGroupAction,
|
|
default=[],
|
|
help=_("Run specific group validations, "
|
|
"if more than one group is required "
|
|
"separate the group names with commas: "
|
|
"--group pre-upgrade,prep | "
|
|
"--group openshift-on-openstack")
|
|
)
|
|
|
|
return parser
|
|
|
|
def _run_validator_run(self, parsed_args):
|
|
LOG = logging.getLogger(__name__ + ".ValidationsRunAnsible")
|
|
|
|
clients = self.app.client_manager
|
|
plans = plan_management.list_deployment_plans(clients)
|
|
|
|
if parsed_args.plan and parsed_args.plan not in plans:
|
|
raise exceptions.CommandError(
|
|
_("The plan '{}' doesn't exist. "
|
|
"Please use one of those {}".format(parsed_args, plans)))
|
|
|
|
limit = parsed_args.limit
|
|
extra_vars = parsed_args.extra_vars
|
|
if parsed_args.extra_vars_file:
|
|
try:
|
|
with open(parsed_args.extra_vars_file, 'r') as env_file:
|
|
extra_vars.update(yaml.safe_load(env_file.read()))
|
|
except yaml.YAMLError as e:
|
|
error_msg = (
|
|
"The request body must be properly formatted YAML/JSON. "
|
|
"Details: %s." % e)
|
|
raise exceptions.CommandError(error_msg)
|
|
|
|
# We don't check if the file exists in order to support
|
|
# passing a string such as "localhost,", like we can do with
|
|
# the "-i" option of ansible-playbook.
|
|
if parsed_args.static_inventory:
|
|
static_inventory = parsed_args.static_inventory
|
|
else:
|
|
static_inventory = oooutils.get_tripleo_ansible_inventory(
|
|
ssh_user='heat-admin',
|
|
stack=parsed_args.plan,
|
|
undercloud_connection='local',
|
|
return_inventory_file_path=True)
|
|
|
|
v_consts.DEFAULT_VALIDATIONS_BASEDIR = constants.\
|
|
DEFAULT_VALIDATIONS_BASEDIR
|
|
actions = ValidationActions()
|
|
try:
|
|
results = actions.run_validations(
|
|
inventory=static_inventory,
|
|
limit_hosts=limit,
|
|
group=parsed_args.group,
|
|
extra_vars=extra_vars,
|
|
validations_dir=constants.ANSIBLE_VALIDATION_DIR,
|
|
validation_name=parsed_args.validation_name,
|
|
extra_env_vars=parsed_args.extra_env_vars,
|
|
quiet=True)
|
|
except RuntimeError as e:
|
|
raise exceptions.CommandError(e)
|
|
|
|
if results:
|
|
# Build output
|
|
t = PrettyTable(border=True, header=True, padding_width=1)
|
|
# Set Field name by getting the result dict keys
|
|
t.field_names = results[0].keys()
|
|
for r in results:
|
|
if r.get('Status_by_Host'):
|
|
h = []
|
|
for host in r['Status_by_Host'].split(', '):
|
|
_name, _status = host.split(',')
|
|
color = (GREEN if _status == 'PASSED' else RED)
|
|
_name = '{}{}{}'.format(color, _name, RESET)
|
|
h.append(_name)
|
|
r['Status_by_Host'] = ', '.join(h)
|
|
if r.get('status'):
|
|
status = r.get('status')
|
|
color = (CYAN if status in ['starting', 'running']
|
|
else GREEN if status == 'PASSED' else RED)
|
|
r['status'] = '{}{}{}'.format(color, status, RESET)
|
|
t.add_row(r.values())
|
|
print(t)
|
|
else:
|
|
msg = "No Validation has been run, please check your parameters."
|
|
raise exceptions.CommandError(msg)
|
|
|
|
if not parsed_args.static_inventory:
|
|
LOG.debug(_('Removing static tripleo ansible inventory file'))
|
|
oooutils.cleanup_tripleo_ansible_inventory_file(
|
|
static_inventory)
|
|
|
|
def take_action(self, parsed_args):
|
|
self._run_validator_run(parsed_args)
|
|
|
|
|
|
class TripleOValidatorShowRun(command.Command):
|
|
"""Display details about a Validation execution"""
|
|
|
|
auth_required = False
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = argparse.ArgumentParser(
|
|
description=self.get_description(),
|
|
prog=prog_name,
|
|
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
|
add_help=False
|
|
)
|
|
|
|
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')
|
|
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
vlogs = ValidationLogs()
|
|
data = vlogs.get_logfile_content_by_uuid(parsed_args.uuid)
|
|
if data:
|
|
if parsed_args.full:
|
|
for d in data:
|
|
print(json.dumps(d, indent=4, sort_keys=True))
|
|
else:
|
|
for d in data:
|
|
for p in d.get('validation_output', []):
|
|
print(json.dumps(p['tasks'],
|
|
indent=4,
|
|
sort_keys=True))
|
|
else:
|
|
raise exceptions.CommandError(
|
|
"Could not find the log file linked to this UUID: %s" %
|
|
parsed_args.uuid)
|
|
|
|
|
|
class TripleOValidatorShowHistory(command.Lister):
|
|
"""Display Validations execution history"""
|
|
|
|
auth_required = False
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(TripleOValidatorShowHistory, self).get_parser(prog_name)
|
|
|
|
parser.add_argument('--validation',
|
|
metavar="<validation>",
|
|
type=str,
|
|
help='Display execution history for a validation')
|
|
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
actions = ValidationActions(constants.ANSIBLE_VALIDATION_DIR)
|
|
return actions.show_history(parsed_args.validation)
|