Adapt the client for the v2 API

This adds a v2 client class allowing to add support for upcoming
v2 API endpoints. The v2 client class implements all v1 endpoints.
The cloudkitty API version can be specified with the
"--os-rating-api-version" option or the "OS_RATING_API_VERSION"
environment variable.

Change-Id: If38730da3baed59c93543a08f8a4989f919611db

Author: lukapeschke

cloudkittyclient/common/__init__.py

@@ -0,0 +1,44 @@
+# -*- 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 keystoneauth1 import adapter
+from keystoneauth1 import session as ks_session
+
+
+class BaseClient(object):
+
+    def __init__(self,
+                 session=None,
+                 adapter_options={},
+                 cacert=None,
+                 insecure=False,
+                 **kwargs):
+        adapter_options.setdefault('service_type', 'rating')
+
+        if insecure:
+            verify_cert = False
+        else:
+            if cacert:
+                verify_cert = cacert
+            else:
+                verify_cert = True
+
+        self.session = session
+        if self.session is None:
+            self.session = ks_session.Session(
+                verify=verify_cert, **kwargs)
+
+        self.api_client = adapter.Adapter(
+            session=self.session, **adapter_options)

cloudkittyclient/v1/base.py cloudkittyclient/common/base.pycloudkittyclient/v1/base.py renamed to cloudkittyclient/common/base.py

@@ -14,11 +14,12 @@
 
 from osc_lib import utils
 
-DEFAULT_API_VERSION = '1'
+DEFAULT_API_VERSION = '2'
 API_VERSION_OPTION = 'os_rating_api_version'
 API_NAME = "rating"
 API_VERSIONS = {
     "1": "cloudkittyclient.v1.client.Client",
+    "2": "cloudkittyclient.v2.client.Client",
 }
 
 
@@ -40,4 +41,9 @@ def make_client(instance):
 
 def build_option_parser(parser):
     """Hook to add global options."""
+    parser.add_argument(
+        '--rating-api-version', type=int, default=utils.env(
+            'OS_RATING_API_VERSION',
+            default=DEFAULT_API_VERSION)
+    )
     return parser

cloudkittyclient/common/client.py

@@ -22,6 +22,7 @@
 from oslo_log import log
 
 from cloudkittyclient import client
+from cloudkittyclient.osc import DEFAULT_API_VERSION
 from cloudkittyclient import utils
 
 
@@ -105,9 +106,6 @@ def build_option_parser(self, description, version):
             description,
             version,
             argparse_kwargs={'allow_abbrev': False})
-        parser.add_argument(
-            '--ck-api-version', type=int, default=1, dest='ck_version',
-            help='Cloudkitty API version (defaults to 1)')
         if 'OS_AUTH_TYPE' not in os.environ.keys() \
            and 'OS_PASSWORD' in os.environ.keys():
             os.environ['OS_AUTH_TYPE'] = 'password'
@@ -133,9 +131,10 @@ def client(self):
                     self.options.os_rating_endpoint_override or
                     self.options.os_endpoint_override),
             )
-            self._client = client.Client(str(self.options.ck_version),
-                                         session=session,
-                                         adapter_options=adapter_options)
+            self._client = client.Client(
+                str(self.options.os_rating_api_version or DEFAULT_API_VERSION),
+                session=session,
+                adapter_options=adapter_options)
         return self._client
 
 

cloudkittyclient/osc.py

@@ -13,41 +13,30 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 #
-from keystoneauth1 import adapter
-from keystoneauth1 import session as ks_session
-
+from cloudkittyclient.common import client
 from cloudkittyclient.v1 import collector
 from cloudkittyclient.v1 import info
 from cloudkittyclient.v1 import rating
 from cloudkittyclient.v1 import report
 from cloudkittyclient.v1 import storage
 
 
-class Client(object):
+class Client(client.BaseClient):
 
     def __init__(self,
                  session=None,
                  adapter_options={},
                  cacert=None,
                  insecure=False,
                  **kwargs):
-        adapter_options.setdefault('service_type', 'rating')
-
-        if insecure:
-            verify_cert = False
-        else:
-            if cacert:
-                verify_cert = cacert
-            else:
-                verify_cert = True
-
-        self.session = session
-        if self.session is None:
-            self.session = ks_session.Session(
-                verify=verify_cert, **kwargs)
+        super(Client, self).__init__(
+            session=session,
+            adapter_options=adapter_options,
+            cacert=cacert,
+            insecure=insecure,
+            **kwargs
+        )
 
-        self.api_client = adapter.Adapter(
-            session=self.session, **adapter_options)
         self.info = info.InfoManager(self.api_client)
         self.collector = collector.CollectorManager(self.api_client)
         self.rating = rating.RatingManager(self.api_client)

cloudkittyclient/shell.py

@@ -15,8 +15,8 @@
 #
 from oslo_log import log
 
+from cloudkittyclient.common import base
 from cloudkittyclient import exc
-from cloudkittyclient.v1 import base
 
 
 LOG = log.getLogger(__name__)

cloudkittyclient/v1/client.py

@@ -13,7 +13,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 #
-from cloudkittyclient.v1 import base
+from cloudkittyclient.common import base
 
 
 class InfoManager(base.BaseManager):

cloudkittyclient/v1/collector.py

@@ -15,9 +15,9 @@
 #
 from cliff import lister
 
+from cloudkittyclient.common import base
 from cloudkittyclient import exc
 from cloudkittyclient import utils
-from cloudkittyclient.v1 import base
 from cloudkittyclient.v1.rating import hashmap
 from cloudkittyclient.v1.rating import pyscripts
 

cloudkittyclient/v1/info.py

@@ -13,8 +13,8 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 #
+from cloudkittyclient.common import base
 from cloudkittyclient import exc
-from cloudkittyclient.v1 import base
 
 
 class HashmapManager(base.BaseManager):