d070f6a68c
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
65 lines
2.2 KiB
Python
65 lines
2.2 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 string import Formatter as StringFormatter
|
|
|
|
from six.moves.urllib.parse import urlencode
|
|
|
|
|
|
class BaseManager(object):
|
|
"""Base class for Endpoint Manager objects."""
|
|
|
|
url = ''
|
|
|
|
def __init__(self, api_client):
|
|
self.api_client = api_client
|
|
self._formatter = StringFormatter()
|
|
|
|
def _get_format_kwargs(self, **kwargs):
|
|
it = self._formatter.parse(self.url)
|
|
output = {i[1]: '' for i in it}
|
|
for key in output.keys():
|
|
if kwargs.get(key):
|
|
output[key] = kwargs[key]
|
|
if 'endpoint' in output.keys():
|
|
output.pop('endpoint')
|
|
return output
|
|
|
|
def get_url(self,
|
|
endpoint,
|
|
kwargs,
|
|
authorized_args=[]):
|
|
"""Returns the required url for a request against CloudKitty's API.
|
|
|
|
:param endpoint: The endpoint on which the request should be done
|
|
:type endpoint: str
|
|
:param kwargs: kwargs that will be used to build the query (part after
|
|
'?' in the url) and to format the url.
|
|
:type kwargs: dict
|
|
:param authorized_args: The arguments that are authorized in url
|
|
parameters
|
|
:type authorized_args: list
|
|
"""
|
|
query_kwargs = {
|
|
key: kwargs[key] for key in authorized_args
|
|
if kwargs.get(key, None)
|
|
}
|
|
kwargs = self._get_format_kwargs(**kwargs)
|
|
url = self.url.format(endpoint=endpoint, **kwargs)
|
|
query = urlencode(query_kwargs)
|
|
if query:
|
|
url += '?' + query
|
|
return url
|