Add a CLIArgs Singleton class that will hold the parse cli arguments

test/units/module_utils/common/collections.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 import pytest
 
 from ansible.module_utils.common._collections_compat import Sequence
-from ansible.module_utils.common.collections import is_iterable, is_sequence
+from ansible.module_utils.common.collections import ImmutableDict, is_iterable, is_sequence
 
 
 class SeqStub:
@@ -100,3 +100,57 @@ def test_iterable_including_strings(string_input):
 @pytest.mark.parametrize('string_input', TEST_STRINGS)
 def test_iterable_excluding_strings(string_input):
     assert not is_iterable(string_input, include_strings=False)
+
+
+class TestImmutableDict:
+    def test_scalar(self):
+        imdict = ImmutableDict({1: 2})
+        assert imdict[1] == 2
+
+    def test_string(self):
+        imdict = ImmutableDict({u'café': u'くらとみ'})
+        assert imdict[u'café'] == u'くらとみ'
+
+    def test_container(self):
+        imdict = ImmutableDict({(1, 2): ['1', '2']})
+        assert imdict[(1, 2)] == ['1', '2']
+
+    def test_from_tuples(self):
+        imdict = ImmutableDict((('a', 1), ('b', 2)))
+        assert frozenset(imdict.items()) == frozenset((('a', 1), ('b', 2)))
+
+    def test_from_kwargs(self):
+        imdict = ImmutableDict(a=1, b=2)
+        assert frozenset(imdict.items()) == frozenset((('a', 1), ('b', 2)))
+
+    def test_immutable(self):
+        imdict = ImmutableDict({1: 2})
+
+        with pytest.raises(TypeError) as exc_info:
+            imdict[1] = 3
+        assert exc_info.value.args[0] == "'ImmutableDict' object does not support item assignment"
+
+        with pytest.raises(TypeError) as exc_info:
+            imdict[5] = 3
+        assert exc_info.value.args[0] == "'ImmutableDict' object does not support item assignment"
+
+    def test_hashable(self):
+        # ImmutableDict is hashable when all of its values are hashable
+        imdict = ImmutableDict({u'café': u'くらとみ'})
+        assert hash(imdict)
+
+    def test_nonhashable(self):
+        # ImmutableDict is unhashable when one of its values is unhashable
+        imdict = ImmutableDict({u'café': u'くらとみ', 1: [1, 2]})
+
+        with pytest.raises(TypeError) as exc_info:
+            hash(imdict)
+        assert exc_info.value.args[0] == "unhashable type: 'list'"
+
+    def test_len(self):
+        imdict = ImmutableDict({1: 2, 'a': 'b'})
+        assert len(imdict) == 2
+
+    def test_repr(self):
+        imdict = ImmutableDict({1: 2, 'a': 'b'})
+        assert repr(imdict) == "ImmutableDict({1: 2, 'a': 'b'})"

test/units/test_arguments.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2018, Toshio Kuratomi <tkuratomi@ansible.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division)
+__metaclass__ = type
+
+try:
+    import argparse
+except ImportError:
+    argparse = None
+
+import optparse
+
+import pytest
+
+from ansible import arguments
+
+
+MAKE_IMMUTABLE_DATA = ((u'くらとみ', u'くらとみ'),
+                       (42, 42),
+                       ({u'café': u'くらとみ'}, arguments.ImmutableDict({u'café': u'くらとみ'})),
+                       ([1, u'café', u'くらとみ'], (1, u'café', u'くらとみ')),
+                       (set((1, u'café', u'くらとみ')), frozenset((1, u'café', u'くらとみ'))),
+                       ({u'café': [1, set(u'ñ')]},
+                        arguments.ImmutableDict({u'café': (1, frozenset(u'ñ'))})),
+                       ([set((1, 2)), {u'くらとみ': 3}],
+                        (frozenset((1, 2)), arguments.ImmutableDict({u'くらとみ': 3}))),
+                      )
+
+
+@pytest.mark.parametrize('data, expected', MAKE_IMMUTABLE_DATA)
+def test_make_immutable(data, expected):
+    assert arguments._make_immutable(data) == expected
+
+
+def test_cliargs():
+    class FakeOptions:
+        pass
+    options = FakeOptions()
+    options.tags = [u'production', u'webservers']
+    options.check_mode = True
+    options.start_at_task = u'Start with くらとみ'
+
+    expected = frozenset((('tags', (u'production', u'webservers')),
+                          ('check_mode', True),
+                          ('start_at_task', u'Start with くらとみ')))
+
+    assert frozenset(arguments.CLIArgs(options).items()) == expected
+
+
+@pytest.mark.skipIf(argparse is None)
+def test_cliargs_argparse():
+    parser = argparse.ArgumentParser(description='Process some integers.')
+    parser.add_argument('integers', metavar='N', type=int, nargs='+',
+                        help='an integer for the accumulator')
+    parser.add_argument('--sum', dest='accumulate', action='store_const',
+                        const=sum, default=max,
+                        help='sum the integers (default: find the max)')
+    args = parser.parse_args([u'--sum', u'1', u'2'])
+
+    expected = frozenset((('accumulate', sum), ('integers', (1, 2))))
+
+    assert frozenset(arguments.CLIArgs.from_options(args).items()) == expected
+
+
+# Can get rid of this test when we port ansible.cli from optparse to argparse
+def test_cliargs_optparse():
+    parser = optparse.OptionParser(description='Process some integers.')
+    parser.add_option('--sum', dest='accumulate', action='store_const',
+                        const=sum, default=max,
+                        help='sum the integers (default: find the max)')
+    opts, args = parser.parse_args([u'--sum', u'1', u'2'])
+    opts.integers = args
+
+    expected = frozenset((('accumulate', sum), ('integers', (u'1', u'2'))))
+
+    assert frozenset(arguments.CLIArgs.from_options(opts).items()) == expected