Add support for /v2/summary to the client

This allows to get a summary through the v2 API endpoint via the client
library and cli tool.

Depends-On: https://review.opendev.org/#/c/660608/
Change-Id: Id63f2419fe3a1eb518a0ffa7ea5fa572b18df651
Story: 2005664
Task: 30960

Author: lukapeschke

cloudkittyclient/osc.py

@@ -14,7 +14,7 @@
 
 from osc_lib import utils
 
-DEFAULT_API_VERSION = '2'
+DEFAULT_API_VERSION = '1'
 API_VERSION_OPTION = 'os_rating_api_version'
 API_NAME = "rating"
 API_VERSIONS = {

cloudkittyclient/shell.py

@@ -78,13 +78,25 @@ class CloudKittyShell(cliff.app.App):
         'pyscripts-script-update',
     ]
 
+    def _get_api_version(self, args):
+        # FIXME(peschk_l): This is a hacky way to figure out the client version
+        # to load. If anybody has a better idea, please fix this.
+        self.deferred_help = True
+        parser = self.build_option_parser('CloudKitty CLI client',
+                                          utils.get_version())
+        del self.deferred_help
+        parsed_args = parser.parse_known_args(args)
+        return str(parsed_args[0].os_rating_api_version or DEFAULT_API_VERSION)
+
     def __init__(self, args):
         self._args = args
         self.cloud_config = os_client_config.OpenStackConfig()
         super(CloudKittyShell, self).__init__(
             description='CloudKitty CLI client',
             version=utils.get_version(),
-            command_manager=CommandManager('cloudkittyclient'),
+            command_manager=CommandManager('cloudkittyclient.v{}'.format(
+                self._get_api_version(args[:]),
+            )),
             deferred_help=True,
         )
         self._client = None

cloudkittyclient/tests/functional/v2/test_summary.py

@@ -0,0 +1,35 @@
+# Copyright 2019 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 cloudkittyclient.tests.functional import base
+
+
+class CkSummaryTest(base.BaseFunctionalTest):
+
+    def __init__(self, *args, **kwargs):
+        super(CkSummaryTest, self).__init__(*args, **kwargs)
+        self.runner = self.cloudkitty
+
+    def test_summary_get(self):
+        return True
+        # FIXME(peschk_l): Uncomment and update this once there is a way to set
+        # the state of a summary through the client
+        # resp = self.runner('summary get')
+
+
+class OSCSummaryTest(CkSummaryTest):
+
+    def __init__(self, *args, **kwargs):
+        super(OSCSummaryTest, self).__init__(*args, **kwargs)
+        self.runner = self.openstack

cloudkittyclient/tests/unit/v2/base.py

@@ -14,6 +14,7 @@
 
 from cloudkittyclient.tests import utils
 from cloudkittyclient.v2 import scope
+from cloudkittyclient.v2 import summary
 
 
 class BaseAPIEndpointTestCase(utils.BaseTestCase):
@@ -22,3 +23,4 @@ def setUp(self):
         super(BaseAPIEndpointTestCase, self).setUp()
         self.api_client = utils.FakeHTTPClient()
         self.scope = scope.ScopeManager(self.api_client)
+        self.summary = summary.SummaryManager(self.api_client)

cloudkittyclient/tests/unit/v2/test_summary.py

@@ -0,0 +1,39 @@
+# Copyright 2019 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 collections import OrderedDict
+
+from cloudkittyclient.tests.unit.v2 import base
+
+
+class TestSummary(base.BaseAPIEndpointTestCase):
+
+    def test_get_summary(self):
+        self.summary.get_summary()
+        self.api_client.get.assert_called_once_with('/v2/summary')
+
+    def test_get_summary_with_pagination_args(self):
+        self.summary.get_summary(offset=10, limit=10)
+        try:
+            self.api_client.get.assert_called_once_with(
+                '/v2/summary?limit=10&offset=10')
+        except AssertionError:
+            self.api_client.get.assert_called_once_with(
+                '/v2/summary?offset=10&limit=10')
+
+    def test_get_summary_filters(self):
+        self.summary.get_summary(
+            filters=OrderedDict([('one', 'two'), ('three', 'four')]))
+        self.api_client.get.assert_called_once_with(
+            '/v2/summary?filters=one%3Atwo%2Cthree%3Afour')

cloudkittyclient/v2/client.py

@@ -15,6 +15,7 @@
 #
 from cloudkittyclient.v1 import client
 from cloudkittyclient.v2 import scope
+from cloudkittyclient.v2 import summary
 
 
 # NOTE(peschk_l) v2 client needs to implement v1 until the v1 API has been
@@ -36,3 +37,4 @@ def __init__(self,
         )
 
         self.scope = scope.ScopeManager(self.api_client)
+        self.summary = summary.SummaryManager(self.api_client)

cloudkittyclient/v2/summary.py

@@ -0,0 +1,52 @@
+# Copyright 2019 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 cloudkittyclient.common import base
+
+
+class SummaryManager(base.BaseManager):
+
+    url = '/v2/summary'
+
+    def get_summary(self, **kwargs):
+        """Returns a paginated list of summaries.
+
+        This support filters along with custom grouping.
+
+        :param offset: Index of the first scope that should be returned.
+        :type offset: int
+        :param limit: Maximal number of scopes to return.
+        :type limit: int
+        :param filters: Optional dict of filters to select data on.
+        :type filters: dict
+        :param groupby: Optional list of attributes to group data on.
+        :type groupby: str or list of str.
+        :param begin: Start of the period to gather data from
+        :type begin: datetime.datetime
+        :param end: End of the period to gather data from
+        :type end: datetime.datetime
+        """
+        if 'groupby' in kwargs.keys() and isinstance(kwargs['groupby'], list):
+            kwargs['groupby'] = ','.join(kwargs['groupby'])
+
+        kwargs['filters'] = ','.join(
+            '{}:{}'.format(k, v) for k, v in
+            (kwargs.get('filters', None) or {}).items()
+        )
+
+        authorized_args = [
+            'offset', 'limit', 'filters', 'groupby', 'begin', 'end']
+
+        url = self.get_url(None, kwargs, authorized_args=authorized_args)
+        return self.api_client.get(url).json()

cloudkittyclient/v2/summary_cli.py

@@ -0,0 +1,62 @@
+# Copyright 2019 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 oslo_utils import timeutils
+
+from cloudkittyclient import utils
+
+
+class CliSummaryGet(lister.Lister):
+    """Get a summary for a given period."""
+
+    def get_parser(self, prog_name):
+        parser = super(CliSummaryGet, self).get_parser(prog_name)
+
+        def filter_(elem):
+            if len(elem.split(':')) != 2:
+                raise TypeError
+            return str(elem)
+
+        parser.add_argument('--offset', type=int, default=0,
+                            help='Index of the first element')
+        parser.add_argument('--limit', type=int, default=100,
+                            help='Maximal number of elements')
+        parser.add_argument('-g', '--groupby', type=str, action='append',
+                            help='Attribute to group the summary by. Can be '
+                            'specified several times')
+        parser.add_argument('--filter', type=filter_, action='append',
+                            help="Optional filter, in 'key:value' format. Can "
+                            "be specified several times.")
+        parser.add_argument('-b', '--begin', type=timeutils.parse_isotime,
+                            help="Start of the period to query, in iso8601 "
+                            "format. Example: 2019-05-01T00:00:00Z.")
+        parser.add_argument('-e', '--end', type=timeutils.parse_isotime,
+                            help="End of the period to query, in iso8601 "
+                            "format. Example: 2019-06-01T00:00:00Z.")
+
+        return parser
+
+    def take_action(self, parsed_args):
+        filters = dict(elem.split(':') for elem in (parsed_args.filter or []))
+        resp = utils.get_client_from_osc(self).summary.get_summary(
+            offset=parsed_args.offset,
+            limit=parsed_args.limit,
+            begin=parsed_args.begin,
+            end=parsed_args.end,
+            filters=filters,
+            groupby=parsed_args.groupby,
+        )
+        columns = [c.replace('_', ' ').capitalize() for c in resp['columns']]
+        return columns, resp['results']

doc/source/api_reference/index.rst

@@ -1,15 +1,10 @@
 =============
-Api Reference
+API Reference
 =============
 
-A ``client.Client`` instance has the following submodules (each one
-corresponding to an API endpoint):
-
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+   :glob:
 
-   report
-   info
-   rating
-   collector
-   storage
+   v1/index
+   v2/index