Merge branch 'develop' into child_fabric_module

Author: prabahal

.gitignore

@@ -77,3 +77,6 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# Ignore Integration Tests Files Directories
+tests/integration/targets/ndfc_interface/files

docs/cisco.dcnm.dcnm_interface_module.rst

@@ -610,6 +610,7 @@ Parameters
                 </td>
                 <td>
                         <div>Interface mode</div>
+                        <div>When ethernet interface is a PortChannel or vPC member, mode is ignored. The only properties that can be managed for PortChannel or vPC member interfaces are &#x27;admin_state&#x27;, &#x27;description&#x27; and &#x27;cmds&#x27;. All other properties are ignored.</div>
                 </td>
             </tr>
             <tr>

playbooks/roles/ndfc_interface/ansible.cfg

@@ -0,0 +1,3 @@
+[defaults]
+# This ansible.cfg file is only used for testing purposes in this directory.
+roles_path = <path to targets>/collections/ansible_collections/cisco/dcnm/tests/integration/targets

playbooks/roles/ndfc_interface/ndfc_hosts.yaml

@@ -0,0 +1,15 @@
+all:
+  vars:
+    ansible_user: "admin"
+    ansible_password: "password"
+    ansible_python_interpreter: python
+    ansible_httpapi_validate_certs: False
+    ansible_httpapi_use_ssl: True
+  children:
+    ndfc:
+      vars:
+        ansible_connection: ansible.netcommon.httpapi
+        ansible_network_os: cisco.dcnm.dcnm
+      hosts:
+        nac-ndfc1:
+          ansible_host: 10.0.55.128

playbooks/roles/ndfc_interface/ndfc_tests.yaml

@@ -0,0 +1,44 @@
+---
+# This playbook can be used to execute integration tests for
+# the role located in:
+#
+# tests/integration/targets/dcnm_interface
+#
+# Modify the vars section with details for your testing setup.
+#
+- hosts: ndfc
+  gather_facts: no
+  connection: ansible.netcommon.httpapi
+
+  vars:
+    # Uncomment testcase to run a specific test
+    testcase: ndfc_pc_members
+    ansible_it_fabric: test_fabric
+    ansible_switch1: 192.168.1.13
+    ansible_switch2: 192.168.1.14
+    ansible_eth_intf2: Ethernet1/2
+    ansible_eth_intf3: Ethernet1/3
+    ansible_eth_intf4: Ethernet1/4
+    ansible_eth_intf5: Ethernet1/5
+    ansible_eth_intf6: Ethernet1/6
+    ansible_eth_intf7: Ethernet1/7
+    ansible_eth_intf8: Ethernet1/8
+    ansible_eth_intf9: Ethernet1/9
+    ansible_eth_intf10: Ethernet1/10
+    ansible_eth_intf11: Ethernet1/11
+    ansible_eth_intf12: Ethernet1/12
+    ansible_eth_intf13: Ethernet1/13
+    ansible_eth_intf14: Ethernet1/14
+    ansible_eth_intf15: Ethernet1/15
+    ansible_eth_intf16: Ethernet1/16
+    ansible_eth_intf17: Ethernet1/17
+    ansible_eth_intf18: Ethernet1/18
+    ansible_eth_intf19: Ethernet1/19
+    ansible_eth_intf20: Ethernet1/20
+    ansible_eth_intf21: Ethernet1/21
+    port_channel_1: port-channel801
+    port_channel_2: port-channel802
+    port_channel_3: port-channel803
+
+  roles:
+    - ndfc_interface

plugins/__init__.py

@@ -0,0 +1,120 @@
+from __future__ import absolute_import, division, print_function
+
+
+__metaclass__ = type
+
+from ansible.utils.display import Display
+from ansible.plugins.action import ActionBase
+
+display = Display()
+
+
+class ActionModule(ActionBase):
+
+    def run(self, tmp=None, task_vars=None):
+        results = super(ActionModule, self).run(tmp, task_vars)
+        results['failed'] = False
+
+        ndfc_data = self._task.args['ndfc_data']
+        test_data = self._task.args['test_data']
+
+        # import epdb ; epdb.st()
+
+        expected_state = {}
+        expected_state['pc_trunk_description'] = test_data['pc_trunk_desc']
+        expected_state['pc_trunk_member_description'] = test_data['eth_trunk_desc']
+        expected_state['pc_access_description'] = test_data['pc_access_desc']
+        expected_state['pc_access_member_description'] = test_data['eth_access_desc']
+        expected_state['pc_l3_description'] = test_data['pc_l3_desc']
+        expected_state['pc_l3_member_description'] = test_data['eth_l3_desc']
+        # --
+        expected_state['pc_trunk_host_policy'] = 'int_port_channel_trunk_host'
+        expected_state['pc_trunk_member_policy'] = 'int_port_channel_trunk_member_11_1'
+        # --
+        expected_state['pc_access_host_policy'] = 'int_port_channel_access_host'
+        expected_state['pc_access_member_policy'] = 'int_port_channel_access_member_11_1'
+        # --
+        expected_state['pc_l3_policy'] = 'int_l3_port_channel'
+        expected_state['pc_l3_member_policy'] = 'int_l3_port_channel_member'
+
+        interface_list = [test_data['pc1'], test_data['eth_intf8'], test_data['eth_intf9'],
+                          test_data['pc2'], test_data['eth_intf10'], test_data['eth_intf11'],
+                          test_data['pc3'], test_data['eth_intf12'], test_data['eth_intf13']]
+
+        if len(ndfc_data['response']) == 0:
+            results['failed'] = True
+            results['msg'] = 'No response data found'
+            return results
+
+        # ReWrite List Data to Dict keyed by interface name
+        ndfc_data_dict = {}
+        for interface in ndfc_data['response']:
+            int = interface['interfaces'][0]['ifName']
+            ndfc_data_dict[int] = interface['interfaces'][0]
+            ndfc_data_dict[int]['policy'] = interface['policy']
+
+        for interface in interface_list:
+            if interface not in ndfc_data_dict.keys():
+                results['failed'] = True
+                results['msg'] = f'Interface {interface} not found in response data'
+                return results
+
+            # Use a regex to match string 'Eth' in interface variable
+            if interface == test_data['pc1']:
+                if ndfc_data_dict[interface]['policy'] != expected_state['pc_trunk_host_policy']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} policy is not {expected_state["pc_trunk_host_policy"]}'
+                    return results
+                if ndfc_data_dict[interface]['nvPairs']['DESC'] != expected_state['pc_trunk_description']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} description is not {expected_state["pc_trunk_description"]}'
+                    return results
+            if interface == test_data['eth_intf8'] or interface == test_data['eth_intf9']:
+                if ndfc_data_dict[interface]['policy'] != expected_state['pc_trunk_member_policy']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} policy is not {expected_state["pc_trunk_member_policy"]}'
+                    return results
+                if ndfc_data_dict[interface]['nvPairs']['DESC'] != expected_state['pc_trunk_member_description']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} description is not {expected_state["pc_trunk_member_description"]}'
+                    return results
+
+            if interface == test_data['pc2']:
+                if ndfc_data_dict[interface]['policy'] != expected_state['pc_access_host_policy']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} policy is {expected_state["pc_access_host_policy"]}'
+                    return results
+                if ndfc_data_dict[interface]['nvPairs']['DESC'] != expected_state['pc_access_description']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} description is not {expected_state["pc_access_description"]}'
+                    return results
+            if interface == test_data['eth_intf10'] or interface == test_data['eth_intf11']:
+                if ndfc_data_dict[interface]['policy'] != expected_state['pc_access_member_policy']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} policy is not {expected_state["pc_access_member_policy"]}'
+                    return results
+                if ndfc_data_dict[interface]['nvPairs']['DESC'] != expected_state['pc_access_member_description']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} description is not {expected_state["pc_access_member_description"]}'
+                    return results
+
+            if interface == test_data['pc3']:
+                if ndfc_data_dict[interface]['policy'] != expected_state['pc_l3_policy']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} policy is not {expected_state["pc_l3_policy"]}'
+                    return results
+                if ndfc_data_dict[interface]['nvPairs']['DESC'] != expected_state['pc_l3_description']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} description is not {expected_state["pc_l3_description"]}'
+                    return results
+            if interface == test_data['eth_intf12'] or interface == test_data['eth_intf13']:
+                if ndfc_data_dict[interface]['policy'] != expected_state['pc_l3_member_policy']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} policy is not {expected_state["pc_l3_member_policy"]}'
+                    return results
+                if ndfc_data_dict[interface]['nvPairs']['DESC'] != expected_state['pc_l3_member_description']:
+                    results['failed'] = True
+                    results['msg'] = f'Interface {interface} description is not {expected_state["pc_l3_member_description"]}'
+                    return results
+
+        return results

plugins/action/tests/unit/ndfc_pc_members_validate.py

@@ -361,6 +361,32 @@ def is_read_only(self):
             self.log.debug(msg)
             return None
 
+    @property
+    def per_vrf_loopback_auto_provision(self):
+        """
+        ### Summary
+        The ``nvPairs.PER_VRF_LOOPBACK_AUTO_PROVISION`` value of the fabric
+        specified with filter.
+
+        ### Raises
+        None
+
+        ### Type
+        boolean
+
+        ### Returns
+        - True
+        - False
+        - None
+        """
+        try:
+            return self._get_nv_pair("PER_VRF_LOOPBACK_AUTO_PROVISION")
+        except ValueError as error:
+            msg = "Failed to retrieve per_vrf_loopback_auto_provision: "
+            msg += f"Error detail: {error}"
+            self.log.debug(msg)
+            return None
+
     @property
     def replication_mode(self):
         """

plugins/module_utils/fabric/fabric_details_v2.py

@@ -820,3 +820,42 @@ def dcnm_post_request(path, hdrs, verify_flag, upload_files):
         json_resp["REQUEST_PATH"] = path
         json_resp.pop("message")
     return json_resp
+
+
+def find_dict_in_list_by_key_value(search: list, key: str, value: str):
+    """
+    # Summary
+
+    Find a dictionary in a list of dictionaries.
+
+
+    ## Raises
+
+    None
+
+    ## Parameters
+
+    -   search: A list of dict
+    -   key: The key to lookup in each dict
+    -   value: The desired matching value for key
+
+    ## Returns
+
+    Either the first matching dict or None
+
+    ## Usage
+
+    ```python
+    content = [{"foo": "bar"}, {"foo": "baz"}]
+
+    match = find_dict_in_list_by_key_value(search=content, key="foo", value="baz")
+    print(f"{match}")
+    # -> {"foo": "baz"}
+
+    match = find_dict_in_list_by_key_value(search=content, key="foo", value="bingo")
+    print(f"{match}")
+    # -> None
+    ```
+    """
+    match = (d for d in search if d[key] == value)
+    return next(match, None)