deb-python-fuelclient/fuelclient/commands/health.py

# -*- coding: utf-8 -*-
#
#    Copyright 2016 Vitalii Kulanov
#
#    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 abc
import six

from fuelclient.commands import base
from fuelclient.common import data_utils


class HealthMixIn(object):

    entity_name = 'health'


class HealthTestSetsList(HealthMixIn, base.BaseListCommand):
    """List of all available test sets for a given environment."""

    columns = ("id",
               "name")

    filters = {'environment_id': 'env'}

    def get_parser(self, prog_name):
        parser = super(HealthTestSetsList, self).get_parser(prog_name)
        parser.add_argument('-e',
                            '--env',
                            type=int,
                            required=True,
                            help='Id of the environment.')
        return parser


class HealthCheckStart(HealthMixIn, base.BaseListCommand):
    """Run specified test sets for a given environment."""

    columns = ("id",
               "testset",
               "cluster_id")

    def get_parser(self, prog_name):
        parser = super(HealthCheckStart, self).get_parser(prog_name)
        parser.add_argument('-e',
                            '--env',
                            type=int,
                            required=True,
                            help='Id of the environment.')
        parser.add_argument('--force',
                            action='store_true',
                            help='Force run health test sets.')
        parser.add_argument('-t',
                            '--tests',
                            nargs='+',
                            help='Name of the test sets to run.')
        parser.add_argument('--ostf-username',
                            default=None,
                            help='OSTF username.')
        parser.add_argument('--ostf-password',
                            default=None,
                            help='OSTF password.')
        parser.add_argument('--ostf-tenant-name',
                            default=None,
                            help='OSTF tenant name.')
        return parser

    def take_action(self, parsed_args):
        ostf_credentials = {}
        if parsed_args.ostf_tenant_name is not None:
            ostf_credentials['tenant'] = parsed_args.ostf_tenant_name
        if parsed_args.ostf_username is not None:
            ostf_credentials['username'] = parsed_args.ostf_username
        if parsed_args.ostf_password is not None:
            ostf_credentials['password'] = parsed_args.ostf_password

        if not ostf_credentials:
            self.app.stdout.write("WARNING: ostf credentials are going to be "
                                  "mandatory in the next release.\n")

        data = self.client.start(parsed_args.env,
                                 ostf_credentials=ostf_credentials,
                                 test_sets=parsed_args.tests,
                                 force=parsed_args.force)

        msg = ("\nHealth check tests for environment with id {0} has been "
               "started:\n".format(parsed_args.env))
        self.app.stdout.write(msg)
        data = data_utils.get_display_data_multi(self.columns, data)
        return self.columns, data


@six.add_metaclass(abc.ABCMeta)
class HealthCheckBaseAction(HealthMixIn, base.BaseShowCommand):
    """Base class for implementing action over a given test set."""

    columns = ("id",
               "testset",
               "cluster_id",
               "status")

    @abc.abstractproperty
    def action_status(self):
        """String with the name of the action."""
        pass

    def take_action(self, parsed_args):
        data = self.client.action(parsed_args.id, self.action_status)

        data = data_utils.get_display_data_single(self.columns, data)
        return self.columns, data


class HealthCheckStop(HealthCheckBaseAction):
    """Stop test set with given id."""

    action_status = "stopped"


class HealthCheckRestart(HealthCheckBaseAction):
    """Restart test set with given id."""

    action_status = "restarted"


class HealthTestSetsStatusList(HealthMixIn, base.BaseListCommand):
    """Show list of statuses of all test sets ever been executed in Fuel."""

    columns = ("id",
               "testset",
               "cluster_id",
               "status",
               "started_at",
               "ended_at")

    def get_parser(self, prog_name):
        parser = super(HealthTestSetsStatusList, self).get_parser(prog_name)
        parser.add_argument('-e',
                            '--env',
                            type=int,
                            help='Id of the environment.')
        return parser

    def take_action(self, parsed_args):
        data = self.client.get_status_all(parsed_args.env)

        data = data_utils.get_display_data_multi(self.columns, data)
        return self.columns, data


class HealthTestSetsStatusShow(HealthMixIn, base.BaseShowCommand):
    """Show status about a test set with given id."""

    columns = ("id",
               "testset",
               "cluster_id",
               "status",
               "started_at",
               "ended_at",
               "tests")

    def take_action(self, parsed_args):
        data = self.client.get_status_single(parsed_args.id)

        data = data_utils.get_display_data_single(self.columns, data)
        return self.columns, data