Stop silently ignoring invalid 'server create --hint' options

The '--hint' option for 'server create' expects a key-value pair like so:

  openstack server create --hint group=245e1dfe-2d0e-4139-80a9-fce124948896 ...

However, the command doesn't complain if this isn't the case, meaning
typos like the below aren't indicated to the user:

  openstack server create --hint 245e1dfe-2d0e-4139-80a9-fce124948896

Due to how we'd implemented this here, this ultimately results in us
POSTing the following as part of the body to 'os-servers':

  {
    ...
    "OS-SCH-HNT:scheduler_hints": {
      "245e1dfe-2d0e-4139-80a9-fce124948896": null
    }
    ...
  }

Which is unfortunately allowed and ignored by nova due to the use of
'additionalProperties' in the schema [1]

Do what we do for loads of other options and explicitly fail on invalid
values. This involves adding a new argparse action since none of those
defined in osc-lib work for us. This is included here to ease
backporting of the fix but will be moved to osc-lib in a future patch.

[1] https://github.com/openstack/nova/blob/19.0.0/nova/api/openstack/compute/schemas/servers.py#L142-L146

Change-Id: I9e96d2978912c8dfeadae4a782c481a17cd7e348
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Story: #2006628
Task: #36840
Related-Bug: #1845322

1 files changed, 24 insertions, 1 deletions

diff --git a/openstackclient/tests/unit/compute/v2/test_server.py b/openstackclient/tests/unit/compute/v2/test_server.py
index b3be5147..27eefd85 100644
--- a/openstackclient/tests/unit/compute/v2/test_server.py
+++ b/openstackclient/tests/unit/compute/v2/test_server.py
@@ -860,7 +860,7 @@ class TestServerCreate(TestServer):
             ('key_name', 'keyname'),
             ('property', {'Beta': 'b'}),
             ('security_group', ['securitygroup']),
-            ('hint', ['a=b', 'a=c']),
+            ('hint', {'a': ['b', 'c']}),
             ('config_drive', False),
             ('server_name', self.new_server.name),
         ]
@@ -2060,6 +2060,29 @@ class TestServerCreate(TestServer):
                           self.cmd.take_action,
                           parsed_args)
 
+    def test_server_create_invalid_hint(self):
+        # Not a key-value pair
+        arglist = [
+            '--image', 'image1',
+            '--flavor', 'flavor1',
+            '--hint', 'a0cf03a5-d921-4877-bb5c-86d26cf818e1',
+            self.new_server.name,
+        ]
+        self.assertRaises(argparse.ArgumentTypeError,
+                          self.check_parser,
+                          self.cmd, arglist, [])
+
+        # Empty key
+        arglist = [
+            '--image', 'image1',
+            '--flavor', 'flavor1',
+            '--hint', '=a0cf03a5-d921-4877-bb5c-86d26cf818e1',
+            self.new_server.name,
+        ]
+        self.assertRaises(argparse.ArgumentTypeError,
+                          self.check_parser,
+                          self.cmd, arglist, [])
+
     def test_server_create_with_description_api_newer(self):
 
         # Description is supported for nova api version 2.19 or above