From 7dbc92b5215c0ee3608d2341c7d60af43db9a3d6 Mon Sep 17 00:00:00 2001
From: qtang <qtang@vmware.com>
Date: Thu, 21 Jul 2016 18:06:35 +0800
Subject: [PATCH] Prevent null key setting for property

null key is the invalid input when setting property
in the openstack components.

Prevent null key setting for property in
openstackclient.

Change-Id: I8ec72664b5393ffef71fffa4bd1cd3c303e86a52
Related-Bug: #1558690
---
 osc_lib/cli/parseractions.py                  | 16 ++++++++--
 osc_lib/tests/cli/test_parseractions.py       | 30 ++++++++++---------
 .../notes/bug-1558690-1528b637f2c0a449.yaml   |  6 ++++
 3 files changed, 36 insertions(+), 16 deletions(-)
 create mode 100644 releasenotes/notes/bug-1558690-1528b637f2c0a449.yaml

diff --git a/osc_lib/cli/parseractions.py b/osc_lib/cli/parseractions.py
index 9140084..85d7310 100644
--- a/osc_lib/cli/parseractions.py
+++ b/osc_lib/cli/parseractions.py
@@ -33,7 +33,13 @@ class KeyValueAction(argparse.Action):
 
         # Add value if an assignment else remove it
         if '=' in values:
-            getattr(namespace, self.dest, {}).update([values.split('=', 1)])
+            values_list = values.split('=', 1)
+            # NOTE(qtang): Prevent null key setting in property
+            if '' == values_list[0]:
+                msg = _("Property key must be specified: %s")
+                raise argparse.ArgumentTypeError(msg % str(values))
+            else:
+                getattr(namespace, self.dest, {}).update([values_list])
         else:
             msg = _("Expected 'key=value' type, but got: %s")
             raise argparse.ArgumentTypeError(msg % str(values))
@@ -88,7 +94,13 @@ class MultiKeyValueAction(argparse.Action):
         for kv in values.split(','):
             # Add value if an assignment else raise ArgumentTypeError
             if '=' in kv:
-                params.update([kv.split('=', 1)])
+                kv_list = kv.split('=', 1)
+                # NOTE(qtang): Prevent null key setting in property
+                if '' == kv_list[0]:
+                    msg = _("Each property key must be specified: %s")
+                    raise argparse.ArgumentTypeError(msg % str(kv))
+                else:
+                    params.update([kv_list])
             else:
                 msg = _(
                     "Expected comma separated 'key=value' pairs, but got: %s"
diff --git a/osc_lib/tests/cli/test_parseractions.py b/osc_lib/tests/cli/test_parseractions.py
index 8f52e5a..451f44e 100644
--- a/osc_lib/tests/cli/test_parseractions.py
+++ b/osc_lib/tests/cli/test_parseractions.py
@@ -49,13 +49,14 @@ class TestKeyValueAction(utils.TestCase):
         self.assertEqual(expect, actual)
 
     def test_error_values(self):
-        self.assertRaises(
-            argparse.ArgumentTypeError,
-            self.parser.parse_args,
-            [
-                '--property', 'red',
-            ]
-        )
+        data_list = [
+            ['--property', 'red', ],
+            ['--property', '=', ],
+            ['--property', '=red', ]
+        ]
+        for data in data_list:
+            self.assertRaises(argparse.ArgumentTypeError,
+                              self.parser.parse_args, data)
 
 
 class TestMultiKeyValueAction(utils.TestCase):
@@ -115,13 +116,14 @@ class TestMultiKeyValueAction(utils.TestCase):
         self.assertItemsEqual(expect, actual)
 
     def test_error_values_with_comma(self):
-        self.assertRaises(
-            argparse.ArgumentTypeError,
-            self.parser.parse_args,
-            [
-                '--test', 'mmm,nnn=zzz',
-            ]
-        )
+        data_list = [
+            ['--test', 'mmm,nnn=zzz', ],
+            ['--test', 'nnn=zzz,=', ],
+            ['--test', 'nnn=zzz,=zzz', ]
+        ]
+        for data in data_list:
+            self.assertRaises(argparse.ArgumentTypeError,
+                              self.parser.parse_args, data)
 
     def test_error_values_without_comma(self):
         self.assertRaises(
diff --git a/releasenotes/notes/bug-1558690-1528b637f2c0a449.yaml b/releasenotes/notes/bug-1558690-1528b637f2c0a449.yaml
new file mode 100644
index 0000000..879b3b8
--- /dev/null
+++ b/releasenotes/notes/bug-1558690-1528b637f2c0a449.yaml
@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    Prevent null key setting for key-value pairs in the ``KeyValueAction``
+    and ``MultiKeyValueAction`` parser actions.
+    [Bug `1558690 <https://bugs.launchpad.net/bugs/1558690>`_]
\ No newline at end of file