Add support for Cache API

This change provides support for the Cache API changes and
deprecation path for glance-cache-manage command.

Change-Id: I6fca9bbe6bc0bd9b14d8dba685405838131160af

glanceclient/v2/cache.py

@@ -0,0 +1,62 @@
+# Copyright 2021 OpenStack Foundation
+# All Rights Reserved.
+#
+#    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 glanceclient.common import utils
+from glanceclient import exc
+
+TARGET_VALUES = ('both', 'cache', 'queue')
+
+
+class Controller(object):
+    def __init__(self, http_client):
+        self.http_client = http_client
+
+    def is_supported(self, version):
+        if utils.has_version(self.http_client, version):
+            return True
+        else:
+            raise exc.HTTPNotImplemented(
+                'Glance does not support image caching API (v2.14)')
+
+    @utils.add_req_id_to_object()
+    def list(self):
+        if self.is_supported('v2.14'):
+            url = '/v2/cache'
+            resp, body = self.http_client.get(url)
+            return body, resp
+
+    @utils.add_req_id_to_object()
+    def delete(self, image_id):
+        if self.is_supported('v2.14'):
+            resp, body = self.http_client.delete('/v2/cache/%s' %
+                                                 image_id)
+            return body, resp
+
+    @utils.add_req_id_to_object()
+    def clear(self, target):
+        if self.is_supported('v2.14'):
+            url = '/v2/cache'
+            headers = {}
+            if target != "both":
+                headers = {'x-image-cache-clear-target': target}
+            resp, body = self.http_client.delete(url, headers=headers)
+            return body, resp
+
+    @utils.add_req_id_to_object()
+    def queue(self, image_id):
+        if self.is_supported('v2.14'):
+            url = '/v2/cache/%s' % image_id
+            resp, body = self.http_client.put(url)
+            return body, resp

glanceclient/v2/client.py

@@ -16,6 +16,7 @@
 
 from glanceclient.common import http
 from glanceclient.common import utils
+from glanceclient.v2 import cache
 from glanceclient.v2 import image_members
 from glanceclient.v2 import image_tags
 from glanceclient.v2 import images
@@ -39,6 +40,7 @@ class Client(object):
     """
 
     def __init__(self, endpoint=None, **kwargs):
+        self.endpoint_provided = endpoint is not None
         endpoint, self.version = utils.endpoint_version_from_url(endpoint, 2.0)
         self.http_client = http.get_http_client(endpoint=endpoint, **kwargs)
         self.schemas = schemas.Controller(self.http_client)
@@ -69,3 +71,5 @@ class Client(object):
             metadefs.NamespaceController(self.http_client, self.schemas))
 
         self.versions = versions.VersionController(self.http_client)
+
+        self.cache = cache.Controller(self.http_client)

glanceclient/v2/shell.py

@@ -23,6 +23,7 @@ from glanceclient._i18n import _
 from glanceclient.common import progressbar
 from glanceclient.common import utils
 from glanceclient import exc
+from glanceclient.v2 import cache
 from glanceclient.v2 import image_members
 from glanceclient.v2 import image_schema
 from glanceclient.v2 import images
@@ -1479,6 +1480,76 @@ def do_md_tag_list(gc, args):
     utils.print_list(tags, columns, field_settings=column_settings)
 
 
+@utils.arg('--target', default='both',
+           choices=cache.TARGET_VALUES,
+           help=_('Specify which target you want to clear'))
+def do_cache_clear(gc, args):
+    """Clear all images from cache, queue or both"""
+    if not gc.endpoint_provided:
+        utils.exit("Direct server endpoint needs to be provided. Do not use "
+                   "loadbalanced or catalog endpoints.")
+    try:
+        gc.cache.clear(args.target)
+    except exc.HTTPForbidden:
+        msg = _("You are not permitted to delete image(s) "
+                "from cache.")
+        utils.print_err(msg)
+    except exc.HTTPException as e:
+        msg = _("'%s': Unable to delete image(s) from cache." % e)
+        utils.print_err(msg)
+
+
+@utils.arg('id', metavar='<IMAGE_ID>', nargs='+',
+           help=_('ID of image(s) to delete from cache/queue.'))
+def do_cache_delete(gc, args):
+    """Delete image from cache/caching queue."""
+    if not gc.endpoint_provided:
+        utils.exit("Direct server endpoint needs to be provided. Do not use "
+                   "loadbalanced or catalog endpoints.")
+
+    for args_id in args.id:
+        try:
+            gc.cache.delete(args_id)
+        except exc.HTTPForbidden:
+            msg = _("You are not permitted to delete the image '%s' "
+                    "from cache." % args_id)
+            utils.print_err(msg)
+        except exc.HTTPException as e:
+            msg = _("'%s': Unable to delete image '%s' from cache."
+                    % (e, args_id))
+            utils.print_err(msg)
+
+
+def do_cache_list(gc, args):
+    """Get cache state."""
+    if not gc.endpoint_provided:
+        utils.exit("Direct server endpoint needs to be provided. Do not use "
+                   "loadbalanced or catalog endpoints.")
+    cached_images = gc.cache.list()
+    utils.print_cached_images(cached_images)
+
+
+@utils.arg('id', metavar='<IMAGE_ID>', nargs='+',
+           help=_('ID of image(s) to queue for caching.'))
+def do_cache_queue(gc, args):
+    """Queue image(s) for caching."""
+    if not gc.endpoint_provided:
+        utils.exit("Direct server endpoint needs to be provided. Do not use "
+                   "loadbalanced or catalog endpoints.")
+
+    for args_id in args.id:
+        try:
+            gc.cache.queue(args_id)
+        except exc.HTTPForbidden:
+            msg = _("You are not permitted to queue the image '%s' "
+                    "for caching." % args_id)
+            utils.print_err(msg)
+        except exc.HTTPException as e:
+            msg = _("'%s': Unable to queue image '%s' for caching."
+                    % (e, args_id))
+            utils.print_err(msg)
+
+
 @utils.arg('--sort-key', default='status',
            choices=tasks.SORT_KEY_VALUES,
            help=_('Sort task list by specified field.'))