Fix(eos_designs): Avoid returning objects in facts (#5016) (#5027)

aristanetworks · Feb 12, 2025 · de0a65e · de0a65e
1 parent 6d2c93c
commit de0a65e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/python-avd/pyavd/_eos_designs/eos_designs_facts/overlay.py b/python-avd/pyavd/_eos_designs/eos_designs_facts/overlay.py
@@ -38,8 +38,8 @@ def evpn_route_servers(self: EosDesignsFactsProtocol) -> list:
         """
         if self.shared_utils.underlay_router is True:
             if self.evpn_role == "client":
-                return self.shared_utils.node_config.evpn_route_servers or self.shared_utils.uplink_switches
-            return self.shared_utils.node_config.evpn_route_servers
+                return self.shared_utils.node_config.evpn_route_servers._as_list() or self.shared_utils.uplink_switches
+            return self.shared_utils.node_config.evpn_route_servers._as_list()
         return []
 
     @cached_property
@@ -48,7 +48,7 @@ def mpls_route_reflectors(self: EosDesignsFactsProtocol) -> list | None:
         if self.shared_utils.underlay_router is True and (
             self.mpls_overlay_role in ["client", "server"] or (self.evpn_role in ["client", "server"] and self.overlay["evpn_mpls"])
         ):
-            return self.shared_utils.node_config.mpls_route_reflectors
+            return self.shared_utils.node_config.mpls_route_reflectors._as_list()
         return None
 
     @cached_property

diff --git a/python-avd/tests/pyavd/molecule_scenarios/test_get_avd_facts.py b/python-avd/tests/pyavd/molecule_scenarios/test_get_avd_facts.py
@@ -1,6 +1,7 @@
 # Copyright (c) 2023-2025 Arista Networks, Inc.
 # Use of this source code is governed by the Apache License 2.0
 # that can be found in the LICENSE file.
+import json
 from copy import deepcopy
 
 import pytest
@@ -39,3 +40,5 @@ def test_get_avd_facts(molecule_scenario: MoleculeScenario) -> None:
     assert isinstance(avd_facts["avd_overlay_peers"], dict)
     assert "avd_topology_peers" in avd_facts
     assert isinstance(avd_facts["avd_topology_peers"], dict)
+    # Test that we can dump the returned data as json.
+    assert json.dumps(avd_facts)
diff --git a/python-avd/tests/pyavd/molecule_scenarios/test_get_device_structured_config.py b/python-avd/tests/pyavd/molecule_scenarios/test_get_device_structured_config.py
@@ -1,6 +1,7 @@
 # Copyright (c) 2023-2025 Arista Networks, Inc.
 # Use of this source code is governed by the Apache License 2.0
 # that can be found in the LICENSE file.
+import json
 from copy import deepcopy
 
 import pytest
@@ -40,3 +41,5 @@ def test_get_device_structured_config(molecule_host: MoleculeHost) -> None:
     assert isinstance(structured_config, dict)
     assert molecule_host.name == structured_config["hostname"]
     assert expected_structured_config == structured_config
+    # Test that we can dump the returned data as json.
+    assert json.dumps(structured_config)