Refactor(eos_designs): Move eos_designs_shared_utils to PyAVD (#4126)

Co-authored-by: Guillaume Mulocher <[email protected]>

ansible_collections/arista/avd/docs/contribution/eos_designs_internal_notes.md

@@ -179,7 +179,7 @@ classDiagram
 
 ### SharedUtils
 
-See the source code [here](../../plugins/plugin_utils/eos_designs_shared_utils/__init__.py)
+See the source code [here](https://github.com/aristanetworks/avd/tree/devel/python-avd/pyavd/_eos_designs/shared_utils)
 
 ```mermaid
 classDiagram

ansible_collections/arista/avd/plugins/action/eos_designs_facts.py

@@ -11,7 +11,6 @@
 from ansible.errors import AnsibleActionFail
 from ansible.plugins.action import ActionBase, display
 
-from ansible_collections.arista.avd.plugins.plugin_utils.eos_designs_shared_utils import SharedUtils
 from ansible_collections.arista.avd.plugins.plugin_utils.errors import AristaAvdMissingVariableError
 from ansible_collections.arista.avd.plugins.plugin_utils.pyavd_wrappers import RaiseOnUse
 from ansible_collections.arista.avd.plugins.plugin_utils.schema.avdschematools import AvdSchemaTools
@@ -21,9 +20,10 @@
 
 try:
     from pyavd._eos_designs.eos_designs_facts import EosDesignsFacts
+    from pyavd._eos_designs.shared_utils import SharedUtils
     from pyavd.vendor.errors.errors import AristaAvdMissingVariableError as PyavdMissingVariableError
 except ImportError as e:
-    EosDesignsFacts = RaiseOnUse(
+    EosDesignsFacts = SharedUtils = RaiseOnUse(
         AnsibleActionFail(
             f"The '{PLUGIN_NAME}' plugin requires the 'pyavd' Python library. Got import error",
             orig_exc=e,

ansible_collections/arista/avd/plugins/action/yaml_templates_to_facts.py

@@ -17,16 +17,28 @@
 from ansible.utils.vars import isidentifier
 
 from ansible_collections.arista.avd.plugins.plugin_utils.avdfacts import AvdFacts
-from ansible_collections.arista.avd.plugins.plugin_utils.eos_designs_shared_utils import SharedUtils
 from ansible_collections.arista.avd.plugins.plugin_utils.errors import AristaAvdMissingVariableError
 from ansible_collections.arista.avd.plugins.plugin_utils.merge import merge
+from ansible_collections.arista.avd.plugins.plugin_utils.pyavd_wrappers import RaiseOnUse
 from ansible_collections.arista.avd.plugins.plugin_utils.schema.avdschematools import AvdSchemaTools
 from ansible_collections.arista.avd.plugins.plugin_utils.strip_empties import strip_null_from_data
 from ansible_collections.arista.avd.plugins.plugin_utils.utils import get, get_templar, load_python_class
 from ansible_collections.arista.avd.plugins.plugin_utils.utils import template as templater
 
 DEFAULT_PYTHON_CLASS_NAME = "AvdStructuredConfig"
 
+PLUGIN_NAME = "arista.avd.yaml_templates_to_facts"
+
+try:
+    from pyavd._eos_designs.shared_utils import SharedUtils
+except ImportError as e:
+    SharedUtils = RaiseOnUse(
+        AnsibleActionFail(
+            f"The '{PLUGIN_NAME}' plugin requires the 'pyavd' Python library. Got import error",
+            orig_exc=e,
+        )
+    )
+
 
 class ActionModule(ActionBase):
     def run(self, tmp=None, task_vars=None):

ansible_collections/arista/avd/plugins/plugin_utils/avdfacts.py

@@ -7,7 +7,7 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from ansible_collections.arista.avd.plugins.plugin_utils.eos_designs_shared_utils import SharedUtils
+    from pyavd._eos_designs.shared_utils import SharedUtils
 
 
 class AvdFacts:

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/MOVED_TO_PYAVD.txt

@@ -0,0 +1 @@
+The eos_designs_shared_utils Python module has been moved to PyAVD in the folder /python-avd/pyavd/_eos_designs/shared_utils/

python-avd/Makefile

@@ -52,7 +52,6 @@ copy-libs: ## Copy files from Ansible AVD collection
 	mkdir -p $(J2_DIR)
 	mkdir -p $(SCHEMAS_DIR)
 	mkdir -p $(EOS_CLI_CONFIG_GEN_TEMPLATE_DIR)
-	mkdir -p $(EOS_DESIGNS_MODULES_DIR)
 
 	cp $(ANSIBLE_AVD_DIR)/LICENSE $(PACKAGE_DIR)/LICENSE
 	cp -r $(ANSIBLE_AVD_DIR)/ansible_collections/arista/avd/plugins/plugin_utils/* $(VENDOR_DIR)
@@ -62,7 +61,7 @@ copy-libs: ## Copy files from Ansible AVD collection
 	cp -r $(ANSIBLE_AVD_DIR)/ansible_collections/arista/avd/roles/eos_cli_config_gen/templates/* $(EOS_CLI_CONFIG_GEN_TEMPLATE_DIR)
 	rm -f $(EOS_CLI_CONFIG_GEN_TEMPLATE_DIR)/avd_schema_documentation.j2
 
-	mv $(VENDOR_DIR)/eos_designs_* $(EOS_DESIGNS_MODULES_DIR)/
+	rm -rf $(VENDOR_DIR)/eos_designs_*
 
 	$(SCRIPTS_DIR)/build-schemas.py
 	cp $(ANSIBLE_AVD_DIR)/ansible_collections/arista/avd/roles/eos_cli_config_gen/schemas/eos_cli_config_gen.schema.pickle $(SCHEMAS_DIR)/
@@ -86,7 +85,6 @@ fix-libs: ## Fix/remove various Ansible specifics things from python files
 	find $(PACKAGE_DIR) -name '*.py' -exec sed -i -e 's/AnsibleError/AristaAvdError/g' {} +
 	find $(PACKAGE_DIR) -name '*.py' -exec sed -i -e 's/AnsibleActionFail/AristaAvdError/g' {} +
 	find $(PACKAGE_DIR) -name '*.py' -exec sed -i -e 's/ansible_collections\.arista\.avd\.plugins\.plugin_utils\.schema\.avdschematools/pyavd.avd_schema_tools/g' {} +
-	find $(PACKAGE_DIR) -name '*.py' -exec sed -i -e 's/ansible_collections\.arista\.avd\.plugins\.plugin_utils\.eos_designs_shared_utils/$(VENDOR_IMPORT)\.eos_designs\.eos_designs_shared_utils/g' {} +
 	find $(PACKAGE_DIR) -name '*.py' -exec sed -i -e 's/ansible_collections\.arista\.avd\.plugins\.plugin_utils/$(VENDOR_IMPORT)/g' {} +
 	find $(PACKAGE_DIR) -name '*.py' -exec sed -i -e 's/ansible_collections\.arista\.avd\.plugins\.module_utils/$(VENDOR_IMPORT)/g' {} +
 
@@ -102,9 +100,6 @@ fix-libs: ## Fix/remove various Ansible specifics things from python files
 
 	find $(PACKAGE_DIR) -name '*.py' -exec sed -i -e 's/ansible_collections\.arista\.avd\.plugins\.filter/$(VENDOR_IMPORT)\.j2\.filter/g' {} +
 
-# Only remaining python_modules are ip_addressing and interface_descriptions referred in eos_designs_shared_utils.
-	find $(PACKAGE_DIR) -name '*.py' -exec sed -i -e 's/ansible_collections\.arista\.avd\.roles\.eos_designs\.python_modules/$(EOS_DESIGNS_IMPORT)/g' {} +
-
 	find $(PACKAGE_DIR) -name '*.py' -exec sed -i -e 's/from ansible\.utils\.display/from $(VENDOR_IMPORT)\.utils\.display/g' {} +
 
 	cp -r $(CURRENT_DIR)/vendor_overrides/* $(VENDOR_DIR)/

python-avd/pyavd/_eos_designs/interface_descriptions/models.py

@@ -7,7 +7,7 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from ...vendor.eos_designs.eos_designs_shared_utils import SharedUtils
+    from ..shared_utils import SharedUtils
 
 
 class InterfaceDescriptionData:

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/bgp_peer_groups.py → python-avd/pyavd/_eos_designs/shared_utils/bgp_peer_groups.py

@@ -6,10 +6,10 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import get
+from ...vendor.utils import get
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 
 class BgpPeerGroupsMixin:

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/connected_endpoints_keys.py → python-avd/pyavd/_eos_designs/shared_utils/connected_endpoints_keys.py

@@ -6,11 +6,11 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.filter.convert_dicts import convert_dicts
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import get
+from ...j2filters.convert_dicts import convert_dicts
+from ...vendor.utils import get
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 # NOTE: there is a static list of default endpoint keys in the fabric connected endpoints documentation templates.
 DEFAULT_CONNECTED_ENDPOINTS_KEYS = [

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/cv_topology.py → python-avd/pyavd/_eos_designs/shared_utils/cv_topology.py

@@ -6,11 +6,11 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.filter.range_expand import range_expand
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import get, get_item
+from ...vendor.j2.filter.range_expand import range_expand
+from ...vendor.utils import get, get_item
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 
 class CvTopology:

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/filtered_tenants.py → python-avd/pyavd/_eos_designs/shared_utils/filtered_tenants.py

@@ -6,15 +6,15 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.filter.convert_dicts import convert_dicts
-from ansible_collections.arista.avd.plugins.filter.natural_sort import natural_sort
-from ansible_collections.arista.avd.plugins.filter.range_expand import range_expand
-from ansible_collections.arista.avd.plugins.plugin_utils.errors import AristaAvdError, AristaAvdMissingVariableError
-from ansible_collections.arista.avd.plugins.plugin_utils.merge import merge
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import default, get, get_item, unique
+from ...j2filters.convert_dicts import convert_dicts
+from ...j2filters.natural_sort import natural_sort
+from ...vendor.errors import AristaAvdError, AristaAvdMissingVariableError
+from ...vendor.j2.filter.range_expand import range_expand
+from ...vendor.merge import merge
+from ...vendor.utils import default, get, get_item, unique
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 
 class FilteredTenantsMixin:
@@ -456,5 +456,3 @@ def get_additional_svi_config(svi_config: dict, svi: dict, vrf: dict) -> None:
                     ospf_keys.append({"id": ospf_key["id"], "hash_algorithm": ospf_key.get("hash_algorithm", "sha512"), "key": ospf_key["key"]})
                 if ospf_keys:
                     svi_config.update({"ospf_authentication": ospf_authentication, "ospf_message_digest_keys": ospf_keys})
-
-        return None

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/flow_tracking.py → python-avd/pyavd/_eos_designs/shared_utils/flow_tracking.py

@@ -7,10 +7,10 @@
 from functools import cached_property
 from typing import TYPE_CHECKING, Literal
 
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import get
+from ...vendor.utils import get
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 
 class FlowTrackingMixin:

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/inband_management.py → python-avd/pyavd/_eos_designs/shared_utils/inband_management.py

@@ -7,11 +7,11 @@
 from ipaddress import ip_network
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.plugin_utils.errors import AristaAvdError, AristaAvdMissingVariableError
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import default, get
+from ...vendor.errors import AristaAvdError, AristaAvdMissingVariableError
+from ...vendor.utils import default, get
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 
 class InbandManagementMixin:

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/interface_descriptions.py → python-avd/pyavd/_eos_designs/shared_utils/interface_descriptions.py

@@ -6,12 +6,12 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.plugin_utils.merge import merge
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import get, load_python_class
-from ansible_collections.arista.avd.roles.eos_designs.python_modules.interface_descriptions import AvdInterfaceDescriptions
+from ...vendor.merge import merge
+from ...vendor.utils import get, load_python_class
+from ..interface_descriptions import AvdInterfaceDescriptions
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 DEFAULT_AVD_INTERFACE_DESCRIPTIONS_PYTHON_CLASS_NAME = "AvdInterfaceDescriptions"
 
@@ -54,5 +54,5 @@ def interface_descriptions_templates(self: SharedUtils) -> dict:
         node_type_templates = get(self.node_type_key_data, "interface_descriptions", default={})
         if hostvar_templates or node_type_templates:
             return merge(hostvar_templates, node_type_templates, list_merge="replace", destructive_merge=False)
-        else:
-            return {}
+
+        return {}

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/ip_addressing.py → python-avd/pyavd/_eos_designs/shared_utils/ip_addressing.py

@@ -6,12 +6,12 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.plugin_utils.merge import merge
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import get, load_python_class
-from ansible_collections.arista.avd.roles.eos_designs.python_modules.ip_addressing import AvdIpAddressing
+from ...vendor.merge import merge
+from ...vendor.utils import get, load_python_class
+from ..ip_addressing import AvdIpAddressing
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 DEFAULT_AVD_IP_ADDRESSING_PYTHON_CLASS_NAME = "AvdIpAddressing"
 
@@ -58,8 +58,8 @@ def vtep_ip(self: SharedUtils) -> str:
         """
         if self.mlag is True:
             return self.ip_addressing.vtep_ip_mlag()
-        else:
-            return self.ip_addressing.vtep_ip()
+
+        return self.ip_addressing.vtep_ip()
 
     @cached_property
     def vtep_vvtep_ip(self: SharedUtils) -> str | None:
@@ -96,5 +96,5 @@ def ip_addressing_templates(self: SharedUtils) -> dict:
         node_type_templates = get(self.node_type_key_data, "ip_addressing", default={})
         if hostvar_templates or node_type_templates:
             return merge(hostvar_templates, node_type_templates, list_merge="replace", destructive_merge=False)
-        else:
-            return {}
+
+        return {}

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/l3_interfaces.py → python-avd/pyavd/_eos_designs/shared_utils/l3_interfaces.py

@@ -6,11 +6,11 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.plugin_utils.merge import merge
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import get, get_item
+from ...vendor.merge import merge
+from ...vendor.utils import get, get_item
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 
 class L3InterfacesMixin:

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/link_tracking_groups.py → python-avd/pyavd/_eos_designs/shared_utils/link_tracking_groups.py

@@ -6,10 +6,10 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import get
+from ...vendor.utils import get
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 
 class LinkTrackingGroupsMixin:

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/mgmt.py → python-avd/pyavd/_eos_designs/shared_utils/mgmt.py

@@ -6,11 +6,11 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.plugin_utils.errors import AristaAvdMissingVariableError
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import default, get
+from ...vendor.errors import AristaAvdMissingVariableError
+from ...vendor.utils import default, get
 
 if TYPE_CHECKING:
-    from .shared_utils import SharedUtils
+    from . import SharedUtils
 
 
 class MgmtMixin:
@@ -70,7 +70,7 @@ def default_mgmt_method(self: SharedUtils) -> str | None:
 
             return default_mgmt_method
 
-        elif default_mgmt_method == "inband":
+        if default_mgmt_method == "inband":
             # Check for missing interface
             if self.inband_mgmt_interface is None:
                 raise AristaAvdMissingVariableError("'default_mgmt_method: inband' requires 'inband_mgmt_interface' to be set.")
@@ -83,7 +83,7 @@ def default_mgmt_method(self: SharedUtils) -> str | None:
     def default_mgmt_protocol_vrf(self: SharedUtils) -> str | None:
         if self.default_mgmt_method == "oob":
             return self.mgmt_interface_vrf
-        elif self.default_mgmt_method == "inband":
+        if self.default_mgmt_method == "inband":
             # inband_mgmt_vrf returns None for vrf default.
             return self.inband_mgmt_vrf or "default"
 
@@ -93,7 +93,7 @@ def default_mgmt_protocol_vrf(self: SharedUtils) -> str | None:
     def default_mgmt_protocol_interface(self: SharedUtils) -> str | None:
         if self.default_mgmt_method == "oob":
             return self.mgmt_interface
-        elif self.default_mgmt_method == "inband":
+        if self.default_mgmt_method == "inband":
             return self.inband_mgmt_interface
 
         return None

ansible_collections/arista/avd/plugins/plugin_utils/eos_designs_shared_utils/misc.py → python-avd/pyavd/_eos_designs/shared_utils/misc.py

@@ -7,16 +7,15 @@
 from functools import cached_property
 from typing import TYPE_CHECKING
 
-from ansible_collections.arista.avd.plugins.filter.convert_dicts import convert_dicts
-from ansible_collections.arista.avd.plugins.filter.natural_sort import natural_sort
-from ansible_collections.arista.avd.plugins.filter.range_expand import range_expand
-from ansible_collections.arista.avd.plugins.plugin_utils.errors.errors import AristaAvdError, AristaAvdMissingVariableError
-from ansible_collections.arista.avd.plugins.plugin_utils.utils import default, get, get_item
+from ...j2filters.convert_dicts import convert_dicts
+from ...j2filters.natural_sort import natural_sort
+from ...vendor.errors.errors import AristaAvdError, AristaAvdMissingVariableError
+from ...vendor.j2.filter.range_expand import range_expand
+from ...vendor.utils import default, get, get_item
 
 if TYPE_CHECKING:
-    from pyavd._eos_designs.eos_designs_facts import EosDesignsFacts
-
-    from .shared_utils import SharedUtils
+    from ...eos_designs_facts import EosDesignsFacts
+    from . import SharedUtils
 
 
 class MiscMixin:
@@ -364,10 +363,7 @@ def new_network_services_bgp_vrf_config(self: SharedUtils) -> bool:
 
         TODO: Change default to True in all cases in AVD 5.0.0 and remove in AVD 6.0.0
         """
-        if self.uplink_type == "p2p-vrfs":
-            default_value = True
-        else:
-            default_value = False
+        default_value = bool(self.uplink_type == "p2p-vrfs")
         return get(self.hostvars, "new_network_services_bgp_vrf_config", default=default_value)
 
     @cached_property