openstack: switch the default json output to dictionary

The python-openstackclient output may either be a list of Value/Field or
a dictionary. Use the dictionary instead of the Value/Field form
because it is easier to deal with. The former was chosen because of a
bug that made it impossible to control the output. The bug still exists
but is believed to be rare enough to ignore. Should it happen, a message
recommending a corrective action and a comment on:

https://bugs.launchpad.net/python-openstackclient/+bug/1510546

is displayed.

Signed-off-by: Loic Dachary <loic@dachary.org>

diff --git a/setup.py b/setup.py
index 22b8a75459c6158bf1c0d6736701e8e8c66879a3..47475987a3b68394b5e8b565728eb4f4f899bf88 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -55,10 +55,6 @@ setup(
                       'pyopenssl>=0.13',
                       'ndg-httpsclient',
                       'pyasn1',
-                      # the following may be removed when
-                      # https://bugs.launchpad.net/python-openstackclient/+bug/1510546
-                      # is resolved
-                      'cliff-tablib', # required to get a Field/Value output from openstack server show
                       'python-openstackclient',
                       'prettytable',
                       ],

diff --git a/teuthology/openstack/__init__.py b/teuthology/openstack/__init__.py
index 4fcb8d77b65a053aa0d8e9ed2a04a9fcd512f9f1..a36447a5eca78d1577237542d7dfbeac8acc7e2e 100644 (file)
--- a/teuthology/openstack/__init__.py
+++ b/teuthology/openstack/__init__.py
@@ -44,6 +44,15 @@ from teuthology import misc
 
 log = logging.getLogger(__name__)
 
+def enforce_json_dictionary(something):
+    if type(something) is not types.DictType:
+        raise Exception(
+            'Please pip uninstall --yes cliff-tablib and try again.'
+            ' Details about this error can be found at'
+            ' https://bugs.launchpad.net/python-openstackclient/+bug/1510546'
+            ' you are encouraged to add a comment if you want it to be'
+            ' fixed.')
+
 class OpenStackInstance(object):
 
     def __init__(self, name_or_id, info=None):
@@ -56,10 +65,9 @@ class OpenStackInstance(object):
 
     def set_info(self):
         try:
-            info = json.loads(
+            self.info = json.loads(
                 misc.sh("openstack server show -f json " + self.name_or_id))
-            self.info = dict(map(
-                lambda p: (p['Field'].lower(), p['Value']), info))
+            enforce_json_dictionary(self.info)
         except CalledProcessError:
             self.info = None
 
@@ -214,13 +222,13 @@ class OpenStack(object):
         Get the value of a field from a result returned by the openstack
         command in json format.
 
-        :param result:  A list of dicts in a format similar to the output of
+        :param result:  A dictionary similar to the output of
                         'openstack server show'
         :param field:   The name of the field whose value to retrieve. Case is
                         ignored.
         """
-        filter_func = lambda v: v['Field'].lower() == field.lower()
-        return filter(filter_func, result)[0]['Value']
+        enforce_json_dictionary(result)
+        return result[field.lower()]
 
     def image_exists(self, image):
         """

diff --git a/teuthology/openstack/test/test_openstack.py b/teuthology/openstack/test/test_openstack.py
index c46287be3f9339962efd7907347fd4833015d4ea..679d1d00277df690eb694a17bc5a894937bc157a 100644 (file)
--- a/teuthology/openstack/test/test_openstack.py
+++ b/teuthology/openstack/test/test_openstack.py
@@ -38,9 +38,75 @@ import scripts.openstack
 
 class TestOpenStackInstance(object):
 
-    teuthology_instance = '[{"Field": "OS-DCF:diskConfig", "Value": "MANUAL"}, {"Field": "OS-EXT-AZ:availability_zone", "Value": "nova"}, {"Field": "OS-EXT-STS:power_state", "Value": 1}, {"Field": "OS-EXT-STS:task_state", "Value": null}, {"Field": "OS-EXT-STS:vm_state", "Value": "active"}, {"Field": "OS-SRV-USG:launched_at", "Value": "2015-11-12T14:18:42.000000"}, {"Field": "OS-SRV-USG:terminated_at", "Value": null}, {"Field": "accessIPv4", "Value": ""}, {"Field": "accessIPv6", "Value": ""}, {"Field": "addresses", "Value": "Ext-Net=167.114.233.32"}, {"Field": "config_drive", "Value": ""}, {"Field": "created", "Value": "2015-11-12T14:18:22Z"}, {"Field": "flavor", "Value": "eg-30 (3c1d6170-0097-4b5c-a3b3-adff1b7a86e0)"}, {"Field": "hostId", "Value": "b482bcc97b6b2a5b3569dc349e2b262219676ddf47a4eaf72e415131"}, {"Field": "id", "Value": "f3ca32d7-212b-458b-a0d4-57d1085af953"}, {"Field": "image", "Value": "teuthology-ubuntu-14.04 (4300a7ca-4fbd-4b34-a8d5-5a4ebf204df5)"}, {"Field": "key_name", "Value": "myself"}, {"Field": "name", "Value": "teuthology"}, {"Field": "os-extended-volumes:volumes_attached", "Value": [{"id": "627e2631-fbb3-48cd-b801-d29cd2a76f74"}, {"id": "09837649-0881-4ee2-a560-adabefc28764"}, {"id": "44e5175b-6044-40be-885a-c9ddfb6f75bb"}]}, {"Field": "progress", "Value": 0}, {"Field": "project_id", "Value": "131b886b156a4f84b5f41baf2fbe646c"}, {"Field": "properties", "Value": ""}, {"Field": "security_groups", "Value": [{"name": "teuthology"}]}, {"Field": "status", "Value": "ACTIVE"}, {"Field": "updated", "Value": "2015-11-12T14:18:42Z"}, {"Field": "user_id", "Value": "291dde1633154837be2693c6ffa6315c"}]'
+    teuthology_instance = """
+{
+  "OS-EXT-STS:task_state": null,
+  "addresses": "Ext-Net=167.114.233.32",
+  "image": "Ubuntu 14.04 (0d315a8d-75e3-418a-80e4-48e62d599627)",
+  "OS-EXT-STS:vm_state": "active",
+  "OS-SRV-USG:launched_at": "2015-08-17T12:22:13.000000",
+  "flavor": "vps-ssd-1 (164fcc7e-7771-414f-a607-b388cb7b7aa0)",
+  "id": "f3ca32d7-212b-458b-a0d4-57d1085af953",
+  "security_groups": [
+    {
+      "name": "default"
+    }
+  ],
+  "user_id": "3a075820e5d24fda96cd340b87fd94e9",
+  "OS-DCF:diskConfig": "AUTO",
+  "accessIPv4": "",
+  "accessIPv6": "",
+  "progress": 0,
+  "OS-EXT-STS:power_state": 1,
+  "project_id": "62cf1be03cec403c8ed8e64df55732ea",
+  "config_drive": "",
+  "status": "ACTIVE",
+  "updated": "2015-11-03T13:48:53Z",
+  "hostId": "bcdf964b6f724e573c07156ff85b4db1707f6f0969f571cf33e0468d",
+  "OS-SRV-USG:terminated_at": null,
+  "key_name": "loic",
+  "properties": "",
+  "OS-EXT-AZ:availability_zone": "nova",
+  "name": "mrdarkdragon",
+  "created": "2015-08-17T12:21:31Z",
+  "os-extended-volumes:volumes_attached": [{"id": "627e2631-fbb3-48cd-b801-d29cd2a76f74"}, {"id": "09837649-0881-4ee2-a560-adabefc28764"}, {"id": "44e5175b-6044-40be-885a-c9ddfb6f75bb"}]
+}
+    """
 
-    teuthology_instance_no_addresses = '[{"Field": "addresses", "Value": ""}, {"Field": "id", "Value": "f3ca32d7-212b-458b-a0d4-57d1085af953"}]'
+    teuthology_instance_no_addresses = """
+{
+  "OS-EXT-STS:task_state": null,
+  "addresses": "",
+  "image": "Ubuntu 14.04 (0d315a8d-75e3-418a-80e4-48e62d599627)",
+  "OS-EXT-STS:vm_state": "active",
+  "OS-SRV-USG:launched_at": "2015-08-17T12:22:13.000000",
+  "flavor": "vps-ssd-1 (164fcc7e-7771-414f-a607-b388cb7b7aa0)",
+  "id": "f3ca32d7-212b-458b-a0d4-57d1085af953",
+  "security_groups": [
+    {
+      "name": "default"
+    }
+  ],
+  "user_id": "3a075820e5d24fda96cd340b87fd94e9",
+  "OS-DCF:diskConfig": "AUTO",
+  "accessIPv4": "",
+  "accessIPv6": "",
+  "progress": 0,
+  "OS-EXT-STS:power_state": 1,
+  "project_id": "62cf1be03cec403c8ed8e64df55732ea",
+  "config_drive": "",
+  "status": "ACTIVE",
+  "updated": "2015-11-03T13:48:53Z",
+  "hostId": "bcdf964b6f724e573c07156ff85b4db1707f6f0969f571cf33e0468d",
+  "OS-SRV-USG:terminated_at": null,
+  "key_name": "loic",
+  "properties": "",
+  "OS-EXT-AZ:availability_zone": "nova",
+  "name": "mrdarkdragon",
+  "created": "2015-08-17T12:21:31Z",
+  "os-extended-volumes:volumes_attached": []
+}
+    """
 
     def test_init(self):
         with patch.multiple(