Files
sushy-cli/sushycli/base.py
Ilya Etingof e6447a063c Improve docstrings and README
Change-Id: If24d9c66be9a5e9eab6f1a364c531c01d5e53665
Story: 2006608
Task: 36776
2020-02-13 08:26:15 +01:00

87 lines
2.5 KiB
Python

# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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 sushy
from cliff import command
from cliff import lister
class BaseParserMixIn(object):
"""Common bits and pieces of all `sushycli` commands.
Does not implement any CLI command by its own.
"""
def _add_options(self, parser):
parser.add_argument(
'--username',
help='Redfish BMC username')
parser.add_argument(
'--password',
help='Redfish BMC user password')
parser.add_argument(
'--service-endpoint',
required=True,
help='Redfish BMC service endpoint URL e.g. '
'http://localhost:8000')
return parser
def take_action(self, args):
"""Common base for all command actions
:param args: a namespace of command-line option-value pairs that
come from the user
:returns: CLI process exit code
"""
root = sushy.Sushy(
args.service_endpoint, username=args.username,
password=args.password)
return root
class BaseCommand(BaseParserMixIn, command.Command):
"""Common base for all sushycli status commands"""
def get_parser(self, prog_name):
"""Common base for all status command parsers.
:param prog_name: name of the cliff command being executed
:returns: an `argparse.ArgumentParser` instance
"""
parser = super(BaseCommand, self).get_parser(prog_name)
return self._add_options(parser)
class BaseLister(BaseParserMixIn, lister.Lister):
"""Common base for all sushycli listing commands"""
def get_parser(self, prog_name):
"""Common base for all listing command parsers.
:param prog_name: name of the cliff command being executed
:returns: an `argparse.ArgumentParser` instance
"""
parser = super(BaseLister, self).get_parser(prog_name)
return self._add_options(parser)