Add MultiKeyValueAction to custom parser action

Class MultiKeyValueAction will be used to parse arguments like this:

--route destination=xxx,gateway=xxx --route destination=yyy,gateway=yyy

The result is a list like this:

[{destination:xxx, gateway:xxx}, {destination:yyy, gateway:yyy}]

This action also contain validation of the parameters.

Change-Id: Ie3aa8635c6a13fc2e429fe6922acd681dc7244cf

1 files changed, 129 insertions, 0 deletions

diff --git a/openstackclient/tests/common/test_parseractions.py b/openstackclient/tests/common/test_parseractions.py
index 0109a3f3..a4ee07bf 100644
--- a/openstackclient/tests/common/test_parseractions.py
+++ b/openstackclient/tests/common/test_parseractions.py
@@ -61,6 +61,135 @@ class TestKeyValueAction(utils.TestCase):
         self.assertDictEqual(expect, actual)
 
 
+class TestMultiKeyValueAction(utils.TestCase):
+
+    def setUp(self):
+        super(TestMultiKeyValueAction, self).setUp()
+
+        self.parser = argparse.ArgumentParser()
+
+        # Set up our typical usage
+        self.parser.add_argument(
+            '--test',
+            metavar='req1=xxx,req2=yyy',
+            action=parseractions.MultiKeyValueAction,
+            dest='test',
+            default=None,
+            required_keys=['req1', 'req2'],
+            optional_keys=['opt1', 'opt2'],
+            help='Test'
+        )
+
+    def test_good_values(self):
+        results = self.parser.parse_args([
+            '--test', 'req1=aaa,req2=bbb',
+            '--test', 'req1=,req2=',
+        ])
+
+        actual = getattr(results, 'test', [])
+        expect = [
+            {'req1': 'aaa', 'req2': 'bbb'},
+            {'req1': '', 'req2': ''},
+        ]
+        # Need to sort the lists before comparing them
+        key = lambda x: x['req1']
+        expect.sort(key=key)
+        actual.sort(key=key)
+        self.assertListEqual(expect, actual)
+
+    def test_empty_required_optional(self):
+        self.parser.add_argument(
+            '--test-empty',
+            metavar='req1=xxx,req2=yyy',
+            action=parseractions.MultiKeyValueAction,
+            dest='test_empty',
+            default=None,
+            required_keys=[],
+            optional_keys=[],
+            help='Test'
+        )
+
+        results = self.parser.parse_args([
+            '--test-empty', 'req1=aaa,req2=bbb',
+            '--test-empty', 'req1=,req2=',
+        ])
+
+        actual = getattr(results, 'test_empty', [])
+        expect = [
+            {'req1': 'aaa', 'req2': 'bbb'},
+            {'req1': '', 'req2': ''},
+        ]
+        # Need to sort the lists before comparing them
+        key = lambda x: x['req1']
+        expect.sort(key=key)
+        actual.sort(key=key)
+        self.assertListEqual(expect, actual)
+
+    def test_error_values_with_comma(self):
+        self.assertRaises(
+            argparse.ArgumentTypeError,
+            self.parser.parse_args,
+            [
+                '--test', 'mmm,nnn=zzz',
+            ]
+        )
+
+    def test_error_values_without_comma(self):
+        self.assertRaises(
+            argparse.ArgumentTypeError,
+            self.parser.parse_args,
+            [
+                '--test', 'mmmnnn',
+            ]
+        )
+
+    def test_missing_key(self):
+        self.assertRaises(
+            argparse.ArgumentTypeError,
+            self.parser.parse_args,
+            [
+                '--test', 'req2=ddd',
+            ]
+        )
+
+    def test_invalid_key(self):
+        self.assertRaises(
+            argparse.ArgumentTypeError,
+            self.parser.parse_args,
+            [
+                '--test', 'req1=aaa,req2=bbb,aaa=req1',
+            ]
+        )
+
+    def test_required_keys_not_list(self):
+        self.assertRaises(
+            TypeError,
+            self.parser.add_argument,
+            '--test-required-dict',
+            metavar='req1=xxx,req2=yyy',
+            action=parseractions.MultiKeyValueAction,
+            dest='test_required_dict',
+            default=None,
+            required_keys={'aaa': 'bbb'},
+            optional_keys=['opt1', 'opt2'],
+            help='Test'
+        )
+
+    def test_optional_keys_not_list(self):
+        self.assertRaises(
+            TypeError,
+            self.parser.add_argument,
+            '--test-optional-dict',
+            metavar='req1=xxx,req2=yyy',
+            action=parseractions.MultiKeyValueAction,
+            dest='test_optional_dict',
+            default=None,
+            required_keys=['req1', 'req2'],
+            optional_keys={'aaa': 'bbb'},
+            help='Test'
+        )
+
+
 class TestNonNegativeAction(utils.TestCase):
 
     def setUp(self):