getting rid of Ignores for sanity tests (#62)

getting rid of Ignores for sanity tests Reviewed-by: Rohit Thakur <rohitthakur2590@outlook.com> https://github.com/rohitthakur2590
ansible-collections · Jul 24, 2020 · 05b4f31 · 05b4f31
1 parent bcfb4f0
commit 05b4f31
Show file tree

Hide file tree

Showing 35 changed files with 501 additions and 228 deletions.
diff --git a/changelogs/fragments/remove_ignores_for_sanity.yaml b/changelogs/fragments/remove_ignores_for_sanity.yaml
@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - Makes sure that docstring and argspec are in sync and removes sanity ignores (https://github.com/ansible-collections/cisco.iosxr/pull/62).
diff --git a/plugins/doc_fragments/iosxr.py b/plugins/doc_fragments/iosxr.py
@@ -26,12 +26,10 @@ class ModuleDocFragment(object):
           over the specified transport.  The value of host is used as the destination
           address for the transport.
         type: str
-        required: true
       port:
         description:
         - Specifies the port to use when building the connection to the remote device.
         type: int
-        default: 22
       username:
         description:
         - Configures the username to use to authenticate the connection to the remote
@@ -52,14 +50,21 @@ class ModuleDocFragment(object):
           for either connecting or sending commands.  If the timeout is exceeded before
           the operation is completed, the module will error.
         type: int
-        default: 10
       ssh_keyfile:
         description:
         - Specifies the SSH key to use to authenticate the connection to the remote
           device.   This value is the path to the key used to authenticate the SSH
           session. If the value is not specified in the task, the value of environment
           variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
         type: path
+      transport:
+        description:
+        - Specifies the type of connection based transport.
+        type: str
+        default: cli
+        choices:
+        - cli
+        - netconf
 notes:
 - For more information on using Ansible to manage network devices see the :ref:`Ansible
   Network Guide <network_guide>`

diff --git a/plugins/module_utils/network/iosxr/argspec/facts/facts.py b/plugins/module_utils/network/iosxr/argspec/facts/facts.py
@@ -20,6 +20,8 @@ def __init__(self, **kwargs):
         pass
 
     argument_spec = {
-        "gather_subset": dict(default=["!config"], type="list"),
-        "gather_network_resources": dict(type="list"),
+        "gather_subset": dict(
+            default=["!config"], type="list", elements="str"
+        ),
+        "gather_network_resources": dict(type="list", elements="str"),
     }
diff --git a/plugins/module_utils/network/iosxr/argspec/l2_interfaces/l2_interfaces.py b/plugins/module_utils/network/iosxr/argspec/l2_interfaces/l2_interfaces.py
@@ -42,7 +42,7 @@ def __init__(self, **kwargs):
                 "native_vlan": {"type": "int"},
                 "l2transport": {"type": "bool"},
                 "l2protocol": {
-                    "element": "dict",
+                    "elements": "dict",
                     "type": "list",
                     "options": {
                         "cdp": {
@@ -63,7 +63,7 @@ def __init__(self, **kwargs):
                         },
                     },
                 },
-                "q_vlan": {"type": "list"},
+                "q_vlan": {"type": "list", "elements": "int"},
                 "propagate": {"type": "bool"},
             },
             "type": "list",

diff --git a/plugins/module_utils/network/iosxr/argspec/l3_interfaces/l3_interfaces.py b/plugins/module_utils/network/iosxr/argspec/l3_interfaces/l3_interfaces.py
@@ -40,15 +40,15 @@ def __init__(self, **kwargs):
             "options": {
                 "name": {"type": "str", "required": True},
                 "ipv4": {
-                    "element": "dict",
+                    "elements": "dict",
                     "type": "list",
                     "options": {
                         "address": {"type": "str"},
                         "secondary": {"type": "bool"},
                     },
                 },
                 "ipv6": {
-                    "element": "dict",
+                    "elements": "dict",
                     "type": "list",
                     "options": {"address": {"type": "str"}},
                 },

diff --git a/plugins/module_utils/network/iosxr/argspec/ospfv2/ospfv2.py b/plugins/module_utils/network/iosxr/argspec/ospfv2/ospfv2.py
@@ -99,7 +99,22 @@ def __init__(self, **kwargs):
                                     },
                                     "type": "dict",
                                 },
-                                "bfd": {"type": "dict"},
+                                "bfd": {
+                                    "options": {
+                                        "fast_detect": {
+                                            "options": {
+                                                "set": {"type": "bool"},
+                                                "strict_mode": {
+                                                    "type": "bool"
+                                                },
+                                            },
+                                            "type": "dict",
+                                        },
+                                        "minimum_interval": {"type": "int"},
+                                        "multiplier": {"type": "int"},
+                                    },
+                                    "type": "dict",
+                                },
                                 "cost": {"type": "int"},
                                 "dead_interval": {"type": "int"},
                                 "default_cost": {"type": "int"},
@@ -447,15 +462,6 @@ def __init__(self, **kwargs):
                             "type": "str",
                         },
                         "max_lsa": {
-                            "mutually_exclusive": [
-                                [
-                                    "warning_only",
-                                    "ignore_count",
-                                    "reset_time",
-                                    "ignore_time",
-                                    "ignore_count",
-                                ]
-                            ],
                             "options": {
                                 "ignore_count": {"type": "int"},
                                 "ignore_time": {"type": "int"},

diff --git a/plugins/module_utils/network/iosxr/config/interfaces/interfaces.py b/plugins/module_utils/network/iosxr/config/interfaces/interfaces.py
@@ -167,9 +167,10 @@ def _state_replaced(self, want, have):
 
         for interface in want:
             for each in have:
-                if each["name"] == interface["name"]:
-                    break
-                elif interface["name"] in each["name"]:
+                if (
+                    each["name"] == interface["name"]
+                    or interface["name"] in each["name"]
+                ):
                     break
             else:
                 continue
@@ -192,9 +193,10 @@ def _state_overridden(self, want, have):
 
         for each in have:
             for interface in want:
-                if each["name"] == interface["name"]:
-                    break
-                elif interface["name"] in each["name"]:
+                if (
+                    each["name"] == interface["name"]
+                    or interface["name"] in each["name"]
+                ):
                     break
             else:
                 # We didn't find a matching desired state, which means we can
@@ -224,9 +226,10 @@ def _state_merged(self, want, have):
                 commands.extend(self._set_config(interface, dict()))
             else:
                 for each in have:
-                    if each["name"] == interface["name"]:
-                        break
-                    elif interface["name"] in each["name"]:
+                    if (
+                        each["name"] == interface["name"]
+                        or interface["name"] in each["name"]
+                    ):
                         break
                 else:
                     continue
@@ -245,9 +248,10 @@ def _state_deleted(self, want, have):
         if want:
             for interface in want:
                 for each in have:
-                    if each["name"] == interface["name"]:
-                        break
-                    elif interface["name"] in each["name"]:
+                    if (
+                        each["name"] == interface["name"]
+                        or interface["name"] in each["name"]
+                    ):
                         break
                 else:
                     continue

diff --git a/plugins/module_utils/network/iosxr/config/l2_interfaces/l2_interfaces.py b/plugins/module_utils/network/iosxr/config/l2_interfaces/l2_interfaces.py
@@ -195,7 +195,7 @@ def _state_overridden(self, want, have, module):
                 if each["name"] == interface["name"]:
                     in_have.add(interface["name"])
                     break
-                elif interface["name"] != each["name"]:
+                if interface["name"] != each["name"]:
                     not_in_have.add(interface["name"])
             else:
                 # We didn't find a matching desired state, which means we can
@@ -229,9 +229,10 @@ def _state_merged(self, want, have, module):
         for interface in want:
             interface["name"] = normalize_interface(interface["name"])
             for each in have:
-                if each["name"] == interface["name"]:
-                    break
-                elif interface["name"] in each["name"]:
+                if (
+                    each["name"] == interface["name"]
+                    or interface["name"] in each["name"]
+                ):
                     break
             else:
                 commands.extend(self._set_config(interface, {}, module))
@@ -252,9 +253,10 @@ def _state_deleted(self, want, have):
             for interface in want:
                 interface["name"] = normalize_interface(interface["name"])
                 for each in have:
-                    if each["name"] == interface["name"]:
-                        break
-                    elif interface["name"] in each["name"]:
+                    if (
+                        each["name"] == interface["name"]
+                        or interface["name"] in each["name"]
+                    ):
                         break
                 else:
                     continue

diff --git a/plugins/module_utils/network/iosxr/config/l3_interfaces/l3_interfaces.py b/plugins/module_utils/network/iosxr/config/l3_interfaces/l3_interfaces.py
@@ -200,7 +200,7 @@ def _state_overridden(self, want, have, module):
                 if each["name"] == interface["name"]:
                     in_have.add(interface["name"])
                     break
-                elif interface["name"] != each["name"]:
+                if interface["name"] != each["name"]:
                     not_in_have.add(interface["name"])
             else:
                 # We didn't find a matching desired state, which means we can
@@ -260,9 +260,10 @@ def _state_deleted(self, want, have):
             for interface in want:
                 interface["name"] = normalize_interface(interface["name"])
                 for each in have:
-                    if each["name"] == interface["name"]:
-                        break
-                    elif interface["name"] in each["name"]:
+                    if (
+                        each["name"] == interface["name"]
+                        or interface["name"] in each["name"]
+                    ):
                         break
                 else:
                     continue
@@ -297,7 +298,7 @@ def verify_diff_again(self, want, have):
                 ):
                     diff = True
                     break
-                elif each_want.get("address") != every_have.get(
+                if each_want.get("address") != every_have.get(
                     "address"
                 ) and len(each_want.keys()) == len(every_have.keys()):
                     diff = True

diff --git a/plugins/module_utils/network/iosxr/facts/legacy/base.py b/plugins/module_utils/network/iosxr/facts/legacy/base.py
@@ -184,7 +184,7 @@ def parse_interfaces(self, data):
         for line in data.split("\n"):
             if len(line) == 0:
                 continue
-            elif line[0] == " ":
+            if line[0] == " ":
                 parsed[key] += "\n%s" % line
             else:
                 match = re.match(r"^(\S+)", line)

diff --git a/plugins/module_utils/network/iosxr/iosxr.py b/plugins/module_utils/network/iosxr/iosxr.py
@@ -115,7 +115,10 @@
 
 iosxr_argument_spec = {
     "provider": dict(
-        type="dict", options=iosxr_provider_spec, removed_in_version=2.14
+        type="dict",
+        options=iosxr_provider_spec,
+        removed_at_date="2022-06-01",
+        removed_from_collection="cisco.iosxr",
     )
 }
 

diff --git a/plugins/module_utils/network/iosxr/utils/utils.py b/plugins/module_utils/network/iosxr/utils/utils.py
@@ -81,13 +81,13 @@ def filter_dict_having_none_value(want, have):
     for k, v in iteritems(want):
         if isinstance(v, dict):
             for key, value in iteritems(v):
-                if value is None:
+                if value is None and k in have and key in have.get(k):
                     dict_val = have.get(k).get(key)
                     test_key_dict.update({key: dict_val})
                 test_dict.update({k: test_key_dict})
         if isinstance(v, list) and isinstance(v[0], dict):
             for key, value in iteritems(v[0]):
-                if value is None:
+                if value is None and k in have and key in have.get(k):
                     dict_val = have.get(k).get(key)
                     test_key_dict.update({key: dict_val})
                 test_dict.update({k: test_key_dict})

diff --git a/plugins/modules/iosxr_banner.py b/plugins/modules/iosxr_banner.py
@@ -33,17 +33,20 @@
     description:
     - Specifies the type of banner to configure on remote device.
     required: true
+    type: str
     choices:
     - login
     - motd
   text:
     description:
-    - Banner text to be configured. Accepts multiline string, without empty lines.
+    - Banner text to be configured. Accepts multi line string, without empty lines.
       Requires I(state=present).
+    type: str
   state:
     description:
     - Existential state of the configuration on the device.
     default: present
+    type: str
     choices:
     - present
     - absent
@@ -84,7 +87,6 @@
   description: NetConf rpc xml sent to device with transport C(netconf)
   returned: always (empty list when no xml rpc to send)
   type: list
-  version_added: 2.5
   sample:
     - '<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
             <banners xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-infra-infra-cfg">