Add support for location parameters in v2 commands

Currently glanceclient's v2 commands don't support modification
operations on an image's location attribute - the argparse specification
for the location attribute of the image-update command causes the image
id argument to be included in list of locations and so the command
parsing fails (because it causes the image id to appear to be missing).

Furthermore even if the 'locations' argument were to be accepted by
argparse (e.g. by changing the argument specs and using --id to specify
the image id) the command would still fail because the arguments are
passed directly to the schema which expects the value of the 'locations'
argument to be a valid dictionary (there is nobody to convert the
argument string to a python dictionary that the schema expects).

This commit adds the following location related commands to
glanceclient:
    --location-add: Add a new location to the list of image locations.
    --location-delete: Remove an existing location from the list of
        image locations.
    --location-update: Update the metadata of existing location.

The glanceclient.v2.images.Controller class has been agumented with
three new methods to support the commands listed above:
    - add_location
    - delete_locations
    - update_location

The server has not been modified, i.e. all location related API requests
are passed to the server via HTTP PATCH requests and handled by the
server's image update function.

The v2 'image' and 'shell' related tests have also been supplemented.

Note that in order to use these options the server must be first
configured to expose location related info to the clients (i.e.
'show_multiple_locations' must be set to 'True").

I also added a mailmap entry for myself.

DocImpact
Closes-bug: #1271452
Co-Author: David Koo (koofoss) <david.koo@huawei.com>

Change-Id: Id1f320af05d9344645836359758e4aa227aafc69

glanceclient/v2/shell.py

@@ -19,7 +19,6 @@ from glanceclient import exc
 import json
 import os
 from os.path import expanduser
-import six
 
 IMAGE_SCHEMA = None
 
@@ -54,14 +53,11 @@ def do_image_create(gc, args):
         fields[key] = value
 
     image = gc.images.create(**fields)
-    ignore = ['self', 'access', 'file', 'schema']
-    image = dict([item for item in six.iteritems(image)
-                  if item[0] not in ignore])
-    utils.print_dict(image)
+    utils.print_image(image)
 
 
 @utils.arg('id', metavar='<IMAGE_ID>', help='ID of image to update.')
-@utils.schema_args(get_image_schema, omit=['id'])
+@utils.schema_args(get_image_schema, omit=['id', 'locations'])
 @utils.arg('--property', metavar="<key=value>", action='append',
            default=[], help=('Arbitrary property to associate with image.'
                              ' May be used multiple times.'))
@@ -85,10 +81,7 @@ def do_image_update(gc, args):
 
     image_id = fields.pop('id')
     image = gc.images.update(image_id, remove_properties, **fields)
-    ignore = ['self', 'access', 'file', 'schema']
-    image = dict([item for item in six.iteritems(image)
-                  if item[0] not in ignore])
-    utils.print_dict(image)
+    utils.print_image(image)
 
 
 @utils.arg('--page-size', metavar='<SIZE>', default=None, type=int,
@@ -125,9 +118,7 @@ def do_image_show(gc, args):
     """Describe a specific image."""
     image = gc.images.get(args.id)
     ignore = ['self', 'access', 'file', 'schema']
-    image = dict([item for item in six.iteritems(image) if item[0] not in
-                  ignore])
-    utils.print_dict(image, max_column_width=int(args.max_column_width))
+    utils.print_image(image, int(args.max_column_width))
 
 
 @utils.arg('--image-id', metavar='<IMAGE_ID>', required=True,
@@ -263,3 +254,48 @@ def do_image_tag_delete(gc, args):
         utils.exit('Unable to delete tag. Specify image_id and tag_value')
     else:
         gc.image_tags.delete(args.image_id, args.tag_value)
+
+
+@utils.arg('--url', metavar='<URL>', required=True,
+           help='URL of location to add.')
+@utils.arg('--metadata', metavar='<STRING>', default='{}',
+           help=('Metadata associated with the location. '
+                 'Must be a valid JSON object (default: %(default)s)'))
+@utils.arg('id', metavar='<ID>',
+           help='ID of image to which the location is to be added.')
+def do_location_add(gc, args):
+    """Add a location (and related metadata) to an image."""
+    try:
+        metadata = json.loads(args.metadata)
+    except ValueError:
+        utils.exit('Metadata is not a valid JSON object.')
+    else:
+        image = gc.images.add_location(args.id, args.url, metadata)
+        utils.print_dict(image)
+
+
+@utils.arg('--url', metavar='<URL>', action='append', required=True,
+           help='URL of location to remove. May be used multiple times.')
+@utils.arg('id', metavar='<ID>',
+           help='ID of image whose locations are to be removed.')
+def do_location_delete(gc, args):
+    """Remove locations (and related metadata) from an image."""
+    image = gc.images.delete_locations(args.id, set(args.url))
+
+
+@utils.arg('--url', metavar='<URL>', required=True,
+           help='URL of location to update.')
+@utils.arg('--metadata', metavar='<STRING>', default='{}',
+           help=('Metadata associated with the location. '
+                 'Must be a valid JSON object (default: %(default)s)'))
+@utils.arg('id', metavar='<ID>',
+           help='ID of image whose location is to be updated.')
+def do_location_update(gc, args):
+    """Update metadata of an image's location."""
+    try:
+        metadata = json.loads(args.metadata)
+    except ValueError:
+        utils.exit('Metadata is not a valid JSON object.')
+    else:
+        image = gc.images.update_location(args.id, args.url, metadata)
+        utils.print_dict(image)