Files
python-cloudkittyclient/cloudkittyclient/v1/storage_cli.py
Luka Peschke d070f6a68c Rewrite of the client
The client has been completely rewritten in order to use cliff. The code
should be easier to maintain: authentication is now entirely handled by
keystoneauth, CloudKitty's client and CK's OSC plugin use the exact same
classes (no code duplication).

New features for users:

  * Client-side CSV report generation: It is possible for users to generate
    CSV reports with the new client. There is a default format, but reports
    may also be configured through a yaml config file. (see documentation)

  * The documentation has been improved. (A few examples on how to use the
    python library + complete API bindings and CLI reference).

  * It is now possible to use the client without Keystone authentication (this
    requires that CK's API is configured to use the noauth auth strategy).

  * Various features are brought by cliff: completion, command output formatting
    (table, shell, yaml, json...).

New features for developpers:

  * Python 2.7/3.5 compatible 'python-cloudkittyclient' module.

  * Integration tests (for 'openstack rating' and 'cloudkitty') have been
    added. These allow to create gate jobs running against a CK devstack

  * Tests are now ran with stestr instead of testr, which allows a better
    control over execution.

  * The dependency list has been reduced and upper constraints have been set.

Change-Id: I7c6afa46138d499b37b8be3d049b23ab5302a928
Task: 6589
Story: 2001614
2018-06-15 12:08:21 +02:00

68 lines
2.7 KiB
Python

# -*- coding: utf-8 -*-
# Copyright 2018 Objectif Libre
#
# 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.
#
from cliff import lister
from cloudkittyclient import exc
from cloudkittyclient import utils
class CliGetDataframes(lister.Lister):
"""List stored dataframes or generate CSV reports.
Dataframes can be filtered on resource_type and project_id.
CSV reports can be generated with the 'df-to-csv' formatter.
A config file may be provided to configure the output of that formatter.
See documentation for more details.
"""
columns = [
('begin', 'Begin'),
('end', 'End'),
('tenant_id', 'Project ID'),
('resources', 'Resources'),
]
def take_action(self, parsed_args):
for arg in ['begin', 'end']:
value = getattr(parsed_args, arg)
if value is not None:
try:
setattr(parsed_args, arg, utils.iso2dt(value))
except ValueError:
raise exc.InvalidArgumentError(
'Invalid timestamp "{}"'.format(value))
resp = utils.get_client_from_osc(self).storage.get_dataframes(
**vars(parsed_args)).get('dataframes', [])
values = utils.list_to_cols(resp, self.columns)
for value in values:
for resource in value[3]:
rating = float(resource['rating'])
volume = float(resource['volume'])
if volume > 0:
resource['rate_value'] = '{:.4f}'.format(rating / volume)
else:
resource['rate_value'] = ''
return [col[1] for col in self.columns], values
def get_parser(self, prog_name):
parser = super(CliGetDataframes, self).get_parser(prog_name)
parser.add_argument('-b', '--begin', type=str, help='Begin timestamp')
parser.add_argument('-e', '--end', type=str, help='End timestamp')
parser.add_argument('-p', '--project-id', type=str, dest='tenant_id',
help='Id of the tenant to filter on')
parser.add_argument('-r', '--resource_type', type=str,
help='Resource type to filter on')
return parser