Unit test expansion (#75)

Unit test expansion

Reviewed-by: https://github.com/apps/ansible-zuul

Author: Qalthos

changelogs/fragments/75-unit-tests.yaml

@@ -0,0 +1,7 @@
+---
+bugfixes:
+  - nthhost filter now returns str instead of IPAddress object
+  - slaac filter now returns str instead of IPAddress object
+removed_features:
+  - module_utils.network.common.utils.EntityCollection has been removed as identical to ComplexList
+  - module_utils.network.common.utils.ComplexDict has been removed

plugins/filter/ipaddr.py

@@ -62,7 +62,6 @@ def _first_last(v):
 
 def _6to4_query(v, vtype, value):
     if v.version == 4:
-
         if v.size == 1:
             ipconv = str(v.ip)
         elif v.size > 1:
@@ -77,7 +76,7 @@ def _6to4_query(v, vtype, value):
         try:
             return "2002:{:02x}{:02x}:{:02x}{:02x}::1/48".format(*numbers)
         except Exception:
-            return False
+            pass
 
     elif v.version == 6:
         if vtype == "address":
@@ -87,8 +86,8 @@ def _6to4_query(v, vtype, value):
             if v.ip != v.network:
                 if ipaddr(str(v.ip), "2002::/16"):
                     return value
-            else:
-                return False
+
+    return False
 
 
 def _ip_query(v):
@@ -100,12 +99,6 @@ def _ip_query(v):
             return str(v.ip)
 
 
-def _gateway_query(v):
-    if v.size > 1:
-        if v.ip != v.network:
-            return str(v.ip) + "/" + str(v.prefixlen)
-
-
 def _address_prefix_query(v):
     if v.size > 1:
         if v.ip != v.network:
@@ -180,16 +173,6 @@ def _ip_netmask_query(v):
             return str(v.ip) + " " + str(v.netmask)
 
 
-"""
-def _ip_wildcard_query(v):
-    if v.size == 2:
-        return str(v.ip) + ' ' + str(v.hostmask)
-    elif v.size > 1:
-        if v.ip != v.network:
-            return str(v.ip) + ' ' + str(v.hostmask)
-"""
-
-
 def _ipv4_query(v, value):
     if v.version == 6:
         try:
@@ -517,12 +500,12 @@ def ipaddr(value, query="", version=False, alias="ipaddr"):
         "cidr": _cidr_query,
         "cidr_lookup": _cidr_lookup_query,
         "first_usable": _first_usable_query,
-        "gateway": _gateway_query,  # deprecate
-        "gw": _gateway_query,  # deprecate
+        "gateway": _address_prefix_query,  # deprecate
+        "gw": _address_prefix_query,  # deprecate
         "host": _host_query,
         "host/prefix": _address_prefix_query,  # deprecate
         "hostmask": _hostmask_query,
-        "hostnet": _gateway_query,  # deprecate
+        "hostnet": _address_prefix_query,  # deprecate
         "int": _int_query,
         "ip": _ip_query,
         "ip/prefix": _ip_prefix_query,
@@ -550,7 +533,7 @@ def ipaddr(value, query="", version=False, alias="ipaddr"):
         "public": _public_query,
         "range_usable": _range_usable_query,
         "revdns": _revdns_query,
-        "router": _gateway_query,  # deprecate
+        "router": _address_prefix_query,  # deprecate
         "size": _size_query,
         "size_usable": _size_usable_query,
         "subnet": _subnet_query,
@@ -880,7 +863,7 @@ def nthhost(value, query=""):
     try:
         nth = int(query)
         if value.size > nth:
-            return value[nth]
+            return str(value[nth])
 
     except ValueError:
         return False
@@ -961,6 +944,8 @@ def _address_normalizer(value):
         vtype = ipaddr(value, "type")
         if vtype == "address" or vtype == "network":
             v = ipaddr(value, "subnet")
+        else:
+            return False
     except Exception:
         return False
 
@@ -1086,7 +1071,7 @@ def slaac(value, query=""):
     except Exception:
         return False
 
-    return eui.ipv6(value.network)
+    return str(eui.ipv6(value.network))
 
 
 # ---- HWaddr / MAC address filters ----
@@ -1113,6 +1098,7 @@ def hwaddr(value, query="", alias="hwaddr"):
     try:
         v = netaddr.EUI(value)
     except Exception:
+        v = None
         if query and query != "bool":
             raise errors.AnsibleFilterError(
                 alias + ": not a hardware address: %s" % value
@@ -1128,8 +1114,6 @@ def hwaddr(value, query="", alias="hwaddr"):
             alias + ": unknown filter type: %s" % query
         )
 
-    return False
-
 
 def macaddr(value, query=""):
     return hwaddr(value, query, alias="macaddr")

plugins/module_utils/network/common/network.py

@@ -36,13 +36,16 @@
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.basic import env_fallback
 from ansible.module_utils.connection import Connection, ConnectionError
+from ansible.module_utils.six import iteritems
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.netconf import (
     NetconfConnection,
 )
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.parsing import (
     Cli,
 )
-from ansible.module_utils.six import iteritems
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
+    to_list,
+)
 
 
 NET_TRANSPORT_ARGS = dict(
@@ -81,15 +84,6 @@ def _transitional_argument_spec():
     return argument_spec
 
 
-def to_list(val):
-    if isinstance(val, (list, tuple)):
-        return list(val)
-    elif val is not None:
-        return [val]
-    else:
-        return list()
-
-
 class ModuleStub(object):
     def __init__(self, argument_spec, fail_json):
         self.params = dict()

plugins/module_utils/network/common/parsing.py

@@ -38,15 +38,9 @@
 )
 from ansible.module_utils.six import string_types, text_type
 from ansible.module_utils.six.moves import zip
-
-
-def to_list(val):
-    if isinstance(val, (list, tuple)):
-        return list(val)
-    elif val is not None:
-        return [val]
-    else:
-        return list()
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
+    to_list,
+)
 
 
 class FailedConditionsError(Exception):

plugins/module_utils/network/common/utils.py

@@ -289,38 +289,26 @@ def __call__(self, value, strict=True):
         return value
 
 
-class EntityCollection(Entity):
+class ComplexList(Entity):
     """Extends ```Entity``` to handle a list of dicts """
 
+    def __init__(self, attrs, module, *args, **kwargs):
+        super(ComplexList, self).__init__(module, attrs, *args, **kwargs)
+
     def __call__(self, iterable, strict=True):
         if iterable is None:
             iterable = [
-                super(EntityCollection, self).__call__(
-                    self._module.params, strict
-                )
+                super(ComplexList, self).__call__(self._module.params, strict)
             ]
 
         if not isinstance(iterable, (list, tuple)):
             self._module.fail_json(msg="value must be an iterable")
 
         return [
-            (super(EntityCollection, self).__call__(i, strict))
-            for i in iterable
+            (super(ComplexList, self).__call__(i, strict)) for i in iterable
         ]
 
 
-# these two are for backwards compatibility and can be removed once all of the
-# modules that use them are updated
-class ComplexDict(Entity):
-    def __init__(self, attrs, module, *args, **kwargs):
-        super(ComplexDict, self).__init__(module, attrs, *args, **kwargs)
-
-
-class ComplexList(EntityCollection):
-    def __init__(self, attrs, module, *args, **kwargs):
-        super(ComplexList, self).__init__(module, attrs, *args, **kwargs)
-
-
 def dict_diff(base, comparable):
     """ Generate a dict object of differences
 

plugins/modules/cli_config.py

@@ -229,7 +229,7 @@ def validate_args(module, device_operations):
             supports_feature = device_operations.get("supports_%s" % feature)
             if supports_feature is None:
                 module.fail_json(
-                    "This platform does not specify whether %s is supported or not. "
+                    msg="This platform does not specify whether %s is supported or not. "
                     "Please report an issue against this platform's cliconf plugin."
                     % feature
                 )

tests/unit/module_utils/network/common/test_config.py

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+#
+# (c) 2017 Red Hat, Inc.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# Make coding more python3-ish
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+import re
+
+import pytest
+
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
+    config,
+)
+
+
+RUNNING = """interface Ethernet1
+   speed auto
+   no switchport
+   no lldp receive
+!
+interface Ethernet2
+   speed auto
+   no switchport
+   no lldp transmit
+!
+interface Management1
+   ip address dhcp
+!"""
+
+
+def test_config_items():
+    net_config = config.NetworkConfig(indent=3, contents=RUNNING)
+    assert len(net_config.items) == 10
+
+    net_config = config.NetworkConfig(
+        indent=3, contents=RUNNING, ignore_lines=[r"\s*no .*"]
+    )
+    assert len(net_config.items) == 6
+
+    net_config = config.NetworkConfig(
+        indent=3, contents=RUNNING, ignore_lines=[re.compile(r"\s*no .*")]
+    )
+    assert len(net_config.items) == 6
+
+
+def test_config_get_block():
+    net_config = config.NetworkConfig(indent=3, contents=RUNNING)
+
+    with pytest.raises(
+        AssertionError, match="path argument must be a list object"
+    ):
+        net_config.get_block("interface Ethernet2")
+
+    with pytest.raises(ValueError, match="path does not exist in config"):
+        net_config.get_block(["interface Ethernet3"])
+
+    block = net_config.get_block(["interface Ethernet2"])
+    assert len(block) == 4
+
+
+def test_line_hierarchy():
+    net_config = config.NetworkConfig(indent=3, contents=RUNNING)
+
+    lines = net_config.items
+    assert lines[0].has_children
+    assert not lines[0].has_parents
+    assert not lines[1].has_children
+    assert lines[1].has_parents