Merge pull request #310 from CiscoDevNet/dcnm_fabric_v2

dcnm_fabric v2. Ready for review.

Author: mikewiebe

playbooks/roles/dcnm_fabric/dcnm_tests.yaml

@@ -1,8 +1,10 @@
 ---
 # This playbook can be used to execute integration tests for
-# the role located in:
+# the roles located in:
 #
-# Modify the vars section with details for testing setup.
+# ./tests/integration/targets/dcnm_fabric/tests/*.yaml
+#
+# Modify the vars section with details for your testing setup.
 #
 # NOTES:
 # 1. For the IPFM test cases (dcnm_*_ipfm), ensure that the controller
@@ -17,17 +19,23 @@
   connection: ansible.netcommon.httpapi
 
   vars:
-    # This testcase field can run any test in the tests directory for the role
+    # Uncomment ONE of the following testcases
     # testcase: dcnm_fabric_deleted_basic
     # testcase: dcnm_fabric_deleted_basic_ipfm
+    # testcase: dcnm_fabric_deleted_basic_lan_classic
+    # testcase: dcnm_fabric_deleted_basic_msd
+    # testcase: dcnm_fabric_deleted_basic_vxlan
     # testcase: dcnm_fabric_merged_basic
     # testcase: dcnm_fabric_merged_basic_ipfm
     # testcase: dcnm_fabric_merged_save_deploy
     # testcase: dcnm_fabric_merged_save_deploy_ipfm
     # testcase: dcnm_fabric_replaced_basic
+    # testcase: dcnm_fabric_replaced_basic_vxlan
+    # testcase: dcnm_fabric_replaced_basic_vxlan_site_id
     # testcase: dcnm_fabric_replaced_basic_ipfm
     # testcase: dcnm_fabric_replaced_save_deploy
     # testcase: dcnm_fabric_replaced_save_deploy_ipfm
+    # testcase: dcnm_fabric_query_basic.yaml
     fabric_name_1: VXLAN_EVPN_Fabric
     fabric_type_1: VXLAN_EVPN
     fabric_name_2: VXLAN_EVPN_MSD_Fabric

plugins/module_utils/common/maintenance_mode_info.py

@@ -130,7 +130,7 @@ def __init__(self, params):
 
         self.params = params
         self.conversion = ConversionUtils()
-        self.fabric_details = FabricDetailsByName(self.params)
+        self.fabric_details = FabricDetailsByName()
         self.switch_details = SwitchDetails()
 
         self._config = None

plugins/module_utils/common/results.py

@@ -232,7 +232,9 @@ def did_anything_change(self) -> bool:
         Return True if there were any changes
         Otherwise, return False
         """
-        msg = f"{self.class_name}.did_anything_change(): ENTERED: "
+        method_name = inspect.stack()[0][3]
+
+        msg = f"{self.class_name}.{method_name}: ENTERED: "
         msg += f"self.action: {self.action}, "
         msg += f"self.state: {self.state}, "
         msg += f"self.result_current: {self.result_current}, "
@@ -248,12 +250,17 @@ def did_anything_change(self) -> bool:
             return True
         if self.result_current.get("changed", None) is False:
             return False
+        if "changed" not in self.result_current:
+            return False
         for diff in self.diff:
             something_changed = False
             test_diff = copy.deepcopy(diff)
             test_diff.pop("sequence_number", None)
             if len(test_diff) != 0:
                 something_changed = True
+        msg = f"{self.class_name}.{method_name}: "
+        msg += f"something_changed: {something_changed}"
+        self.log.debug(msg)
         return something_changed
 
     def register_task_result(self):

plugins/module_utils/fabric/common.py

@@ -22,6 +22,8 @@
 
 from ansible_collections.cisco.dcnm.plugins.module_utils.common.conversion import \
     ConversionUtils
+from ansible_collections.cisco.dcnm.plugins.module_utils.common.properties import \
+    Properties
 from ansible_collections.cisco.dcnm.plugins.module_utils.fabric.config_deploy import \
     FabricConfigDeploy
 from ansible_collections.cisco.dcnm.plugins.module_utils.fabric.config_save import \
@@ -30,45 +32,34 @@
     FabricTypes
 
 
+@Properties.add_rest_send
+@Properties.add_results
 class FabricCommon:
     """
+    ### Summary
     Common methods used by the other classes supporting
     the dcnm_fabric module
 
-    Usage (where params is AnsibleModule.params)
+    ### Usage
 
     class MyClass(FabricCommon):
-        def __init__(self, params):
-            super().__init__(params)
+        def __init__(self):
+            super().__init__()
         ...
     """
 
-    def __init__(self, params):
+    def __init__(self):
         self.class_name = self.__class__.__name__
-        self.params = params
+        self.action = None
 
         self.log = logging.getLogger(f"dcnm.{self.class_name}")
 
-        self.check_mode = self.params.get("check_mode", None)
-        if self.check_mode is None:
-            msg = f"{self.class_name}.__init__(): "
-            msg += "check_mode is required"
-            raise ValueError(msg)
-
-        self.state = self.params.get("state", None)
-        if self.state is None:
-            msg = f"{self.class_name}.__init__(): "
-            msg += "state is required"
-            raise ValueError(msg)
-
         self.conversion = ConversionUtils()
-        self.config_save = FabricConfigSave(params)
-        self.config_deploy = FabricConfigDeploy(params)
+        self.config_save = FabricConfigSave()
+        self.config_deploy = FabricConfigDeploy()
         self.fabric_types = FabricTypes()
 
-        msg = "ENTERED FabricCommon(): "
-        msg += f"check_mode: {self.check_mode}, "
-        msg += f"state: {self.state}"
+        msg = "ENTERED FabricCommon()"
         self.log.debug(msg)
 
         # key: fabric_name, value: boolean
@@ -105,19 +96,13 @@ def __init__(self, params):
         self.path = None
         self.verb = None
 
-        self._init_properties()
-        self._init_key_translations()
+        self._fabric_details = None
+        self._fabric_summary = None
+        self._fabric_type = "VXLAN_EVPN"
+        self._rest_send = None
+        self._results = None
 
-    def _init_properties(self) -> None:
-        """
-        Initialize the properties dictionary.
-        """
-        self._properties: dict = {}
-        self._properties["fabric_details"] = None
-        self._properties["fabric_summary"] = None
-        self._properties["fabric_type"] = "VXLAN_EVPN"
-        self._properties["rest_send"] = None
-        self._properties["results"] = None
+        self._init_key_translations()
 
     def _init_key_translations(self):
         """
@@ -166,6 +151,7 @@ def _config_save(self, payload):
             return
 
         self.config_save.payload = payload
+        # pylint: disable=no-member
         self.config_save.rest_send = self.rest_send
         self.config_save.results = self.results
         try:
@@ -196,6 +182,7 @@ def _config_deploy(self, payload):
             self.config_deploy.fabric_details = self.fabric_details
             self.config_deploy.payload = payload
             self.config_deploy.fabric_summary = self.fabric_summary
+            # pylint: disable=no-member
             self.config_deploy.rest_send = self.rest_send
             self.config_deploy.results = self.results
         except TypeError as error:
@@ -240,6 +227,7 @@ def translate_anycast_gw_mac(self, fabric_name, mac_address):
         try:
             mac_address = self.conversion.translate_mac_address(mac_address)
         except ValueError as error:
+            # pylint: disable=no-member
             self.results.failed = True
             self.results.changed = False
             self.results.register_task_result()
@@ -270,6 +258,7 @@ def _fixup_payloads_to_commit(self) -> None:
             self._fixup_anycast_gw_mac()
             self._fixup_bgp_as()
         except ValueError as error:
+            # pylint: disable=no-member
             self.results.failed = True
             self.results.changed = False
             self.results.register_task_result()
@@ -324,7 +313,7 @@ def _verify_payload(self, payload) -> None:
         - raise ``ValueError`` if the payload is missing mandatory keys
         """
         method_name = inspect.stack()[0][3]
-        if self.state not in {"merged", "replaced"}:
+        if self.action not in {"fabric_create", "fabric_replace", "fabric_update"}:
             return
         msg = f"{self.class_name}.{method_name}: "
         msg += f"payload: {payload}"
@@ -393,22 +382,22 @@ def fabric_details(self):
         """
         An instance of the FabricDetails class.
         """
-        return self._properties["fabric_details"]
+        return self._fabric_details
 
     @fabric_details.setter
     def fabric_details(self, value):
-        self._properties["fabric_details"] = value
+        self._fabric_details = value
 
     @property
     def fabric_summary(self):
         """
         An instance of the FabricSummary class.
         """
-        return self._properties["fabric_summary"]
+        return self._fabric_summary
 
     @fabric_summary.setter
     def fabric_summary(self, value):
-        self._properties["fabric_summary"] = value
+        self._fabric_summary = value
 
     @property
     def fabric_type(self):
@@ -419,7 +408,7 @@ def fabric_type(self):
 
         See ``FabricTypes().valid_fabric_types`` for valid values
         """
-        return self._properties["fabric_type"]
+        return self._fabric_type
 
     @fabric_type.setter
     def fabric_type(self, value):
@@ -430,26 +419,4 @@ def fabric_type(self, value):
             msg += f"{self.fabric_types.valid_fabric_types}. "
             msg += f"Got {value}"
             raise ValueError(msg)
-        self._properties["fabric_type"] = value
-
-    @property
-    def rest_send(self):
-        """
-        An instance of the RestSend class.
-        """
-        return self._properties["rest_send"]
-
-    @rest_send.setter
-    def rest_send(self, value):
-        self._properties["rest_send"] = value
-
-    @property
-    def results(self):
-        """
-        An instance of the Results class.
-        """
-        return self._properties["results"]
-
-    @results.setter
-    def results(self, value):
-        self._properties["results"] = value
+        self._fabric_type = value