Refactor(eos_designs): Refactor eos_designs structured_config code for router_path_selection #5002

laxmikantchintakindi · 2025-02-10T11:52:05Z

Change Summary

Refactor eos_designs structured_config code for router_path_selection.py.

Related Issue(s)

Fixes #

Component(s) name

arista.avd.eos_designs

Proposed changes

Refactor eos_designs structured_config code for router_path_selection.py.

How to test

Checklist

User Checklist

N/A

Repository Checklist

My code has been rebased from devel before I start
I have read the CONTRIBUTING document.
My change requires a change to the documentation and documentation have been updated accordingly.
I have updated molecule CI testing accordingly. (check the box if not applicable)

github-actions · 2025-02-10T11:52:15Z

Review docs on Read the Docs

To test this pull request:

# Create virtual environment for this testing below the current directory
python -m venv test-avd-pr-5002
# Activate the virtual environment
source test-avd-pr-5002/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/laxmikantchintakindi/avd.git@refactor/router-path-selection#subdirectory=python-avd" --force
# Point Ansible collections path to the Python virtual environment
export ANSIBLE_COLLECTIONS_PATH=$VIRTUAL_ENV/ansible_collections
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/laxmikantchintakindi/avd.git#/ansible_collections/arista/avd/,refactor/router-path-selection --force
# Optional: Install AVD examples
cd test-avd-pr-5002
ansible-playbook arista.avd.install_examples

python-avd/pyavd/_eos_designs/structured_config/network_services/router_path_selection.py

…r router_path_selection.py

for more information, see https://pre-commit.ci

python-avd/pyavd/_eos_designs/structured_config/network_services/router_path_selection.py

python-avd/pyavd/_eos_designs/structured_config/overlay/router_path_selection.py

github-actions · 2025-02-27T14:54:52Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

github-actions · 2025-02-28T10:10:52Z

Conflicts have been resolved. A maintainer will review the pull request shortly.

MaheshGSLAB · 2025-03-03T06:38:50Z

python-avd/pyavd/_eos_designs/structured_config/network_services/router_path_selection.py

-                    "vrfs": vrfs,
-                },
-            )
+            for vrf in vrfs:


Above we are iterating on self._filtered_wan_vrfs and here again iterating on vrfs so i think we can from the vrfs data in above loop only with if condition

MaheshGSLAB · 2025-03-03T06:41:07Z

python-avd/pyavd/_eos_designs/structured_config/network_services/router_path_selection.py


-    def _autovpn_policies(self: AvdStructuredConfigNetworkServicesProtocol) -> list:
+    def _autovpn_policies(self: AvdStructuredConfigNetworkServicesProtocol) -> None:
        """Return a list of policies for AutoVPN."""


Suggested change

"""Return a list of policies for AutoVPN."""

"""Set the list of policies for AutoVPN."""

MaheshGSLAB · 2025-03-03T06:43:48Z

python-avd/pyavd/_eos_designs/structured_config/network_services/router_path_selection.py

+                policy_item.rules.append(
+                    EosCliConfigGen.RouterPathSelection.PoliciesItem.RulesItem(
+                        id=10 * index,
+                        application_profile=get(match, "application_profile"),
+                        load_balance=match["load_balance_policy"].name if "load_balance_policy" in match else None,
+                    )
                )


Suggested change

policy_item.rules.append(

EosCliConfigGen.RouterPathSelection.PoliciesItem.RulesItem(

id=10 * index,

application_profile=get(match, "application_profile"),

load_balance=match["load_balance_policy"].name if "load_balance_policy" in match else None,

)

)

policy_item.rules.append_new(

id=10 * index,

application_profile=get(match, "application_profile"),

load_balance=match["load_balance_policy"].name if "load_balance_policy" in match else None,

)

sonarqubecloud · 2025-03-03T12:39:51Z

Quality Gate passed

Issues
6 New issues
0 Accepted issues

Measures
0 Security Hotspots
95.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

gmuloc · 2025-03-03T13:06:08Z

python-avd/pyavd/_eos_designs/structured_config/network_services/utils_wan.py

-
-        # An entry is composed of a list of path-groups in `names` and a `priority`
-        policy_entries = get(input_dict, "path_groups", [])
+            # TODO: Decide if the default value in schema for lowest_hop_count is correct.


discuss between @gmuloc and @ClausHolbechArista

gmuloc · 2025-03-03T13:09:09Z

python-avd/pyavd/_eos_designs/structured_config/overlay/router_path_selection.py

+            )
+            self._set_local_interfaces_for_path_group(path_group.name, path_group_item)
+            self._set_dynamic_peers(disable_ipsec=disable_dynamic_peer_ipsec, path_group_item=path_group_item)
+            self._set_static_peers_for_path_group(path_group.name, path_group_item)

            if is_local_pg:


I feel like we could avoid creating the PathGroupsItem if it is not a local_pg - what do you think?

so above line 54

if not is_local_pg: continue

gmuloc · 2025-03-03T13:11:38Z

python-avd/pyavd/_eos_designs/structured_config/overlay/router_path_selection.py

+            path_group_item = EosCliConfigGen.RouterPathSelection.PathGroupsItem()
+            self._generate_ha_path_group(path_group_item=path_group_item)
+            self.structured_config.router_path_selection.path_groups.append(path_group_item)


Replace these 3 lines and rename the function
_set_ha_path_group below

gmuloc · 2025-03-03T13:13:39Z

python-avd/pyavd/_eos_designs/structured_config/overlay/router_path_selection.py

@@ -149,44 +135,48 @@ def _get_path_group_id(self: AvdStructuredConfigOverlayProtocol, path_group_name
            return config_id
        return 500

-    def _get_local_interfaces_for_path_group(self: AvdStructuredConfigOverlayProtocol, path_group_name: str) -> list:
+    def _set_local_interfaces_for_path_group(
+        self: AvdStructuredConfigOverlayProtocol, path_group_name: str, path_group_item: EosCliConfigGen.RouterPathSelection.PathGroupsItem


no need to pass path_group_name anymore I think if you pass path_group_item you can just access it using path_group_item.name

also rename the path_group_item to path_group, that's what it is really

gmuloc · 2025-03-03T13:14:01Z

python-avd/pyavd/_eos_designs/structured_config/overlay/router_path_selection.py

        """
        Generate the router_path_selection.local_interfaces list.

        For AUTOVPN clients, configure the stun server profiles as appropriate
        """
-        local_interfaces = []
        if path_group_name not in self.shared_utils.wan_local_path_groups:


Once your rename the path_group_item to path_group, use:

Suggested change

if path_group_name not in self.shared_utils.wan_local_path_groups:

if path_group.name not in self.shared_utils.wan_local_path_groups:

gmuloc · 2025-03-03T13:16:00Z

python-avd/pyavd/_eos_designs/structured_config/overlay/router_path_selection.py

-    def _get_static_peers_for_path_group(self: AvdStructuredConfigOverlayProtocol, path_group_name: str) -> list | None:
+    def _set_static_peers_for_path_group(
+        self: AvdStructuredConfigOverlayProtocol, path_group_name: str, path_group_item: EosCliConfigGen.RouterPathSelection.PathGroupsItem
+    ) -> None:
        """Retrieves the static peers to configure for a given path-group based on the connected nodes."""


Suggested change

"""Retrieves the static peers to configure for a given path-group based on the connected nodes."""

"""Set the static peers to configure for a given path-group based on the connected nodes."""

github-actions bot assigned laxmikantchintakindi Feb 10, 2025

MaheshGSLAB reviewed Feb 11, 2025

View reviewed changes

python-avd/pyavd/_eos_designs/structured_config/network_services/router_path_selection.py Show resolved Hide resolved

python-avd/pyavd/_eos_designs/structured_config/network_services/router_path_selection.py Outdated Show resolved Hide resolved

github-actions bot added state: CI Updated CI scenario have been updated in the PR and removed state: CI Updated CI scenario have been updated in the PR labels Feb 18, 2025

laxmikantchintakindi requested a review from Vibhu-gslab February 19, 2025 11:41

laxmikantchintakindi force-pushed the refactor/router-path-selection branch from 0c85f19 to 751ba2d Compare February 19, 2025 12:37

Vibhu-gslab force-pushed the refactor/router-path-selection branch from 66b7227 to 30eb016 Compare February 24, 2025 05:29

Laxmikant Chintakindi and others added 6 commits February 25, 2025 20:25

Refactor(eos_designs): Refactor eos_designs structured_config code fo…

be1e52c

…r router_path_selection.py

Adding overlay router-path-selection

fd0f9cb

[pre-commit.ci] auto fixes from pre-commit.com hooks

5ce216a

for more information, see https://pre-commit.ci

Restructure code

b65afd6

Remove commented code

50c5cc2

Apply suggestion on lbpolicy creation

f548021

laxmikantchintakindi force-pushed the refactor/router-path-selection branch from 30eb016 to f548021 Compare February 25, 2025 14:55

MaheshGSLAB reviewed Feb 26, 2025

View reviewed changes

github-actions bot added the state: conflict PR with conflict label Feb 27, 2025

Laxmikant Chintakindi and others added 3 commits February 28, 2025 10:56

Add set befor method name

e917302

Refactor(eos_designs): Change the way to generate load balance policies

179977b

Merge branch 'devel' into refactor/router-path-selection

b75bc57

github-actions bot removed the state: conflict PR with conflict label Feb 28, 2025

Fix: Wrong merge commit

58b56f4

MaheshGSLAB reviewed Mar 3, 2025

View reviewed changes

small modification in code

3757cf1

laxmikantchintakindi requested review from gmuloc and MaheshGSLAB March 3, 2025 09:42

laxmikantchintakindi changed the title ~~Refactor(eos_designs): Refactor eos_designs structured_config code for router_path_selection.py~~ Refactor(eos_designs): Refactor eos_designs structured_config code for router_path_selection Mar 3, 2025

Merge branch 'devel' into refactor/router-path-selection

eec7870

gmuloc marked this pull request as ready for review March 3, 2025 13:03

gmuloc requested review from a team as code owners March 3, 2025 13:03

gmuloc reviewed Mar 3, 2025

View reviewed changes

gmuloc requested changes Mar 3, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor(eos_designs): Refactor eos_designs structured_config code for router_path_selection #5002

Refactor(eos_designs): Refactor eos_designs structured_config code for router_path_selection #5002

laxmikantchintakindi commented Feb 10, 2025 •

edited

Loading

github-actions bot commented Feb 10, 2025

github-actions bot commented Feb 27, 2025

github-actions bot commented Feb 28, 2025

MaheshGSLAB Mar 3, 2025

laxmikantchintakindi Mar 3, 2025

MaheshGSLAB Mar 3, 2025

laxmikantchintakindi Mar 3, 2025

MaheshGSLAB Mar 3, 2025

laxmikantchintakindi Mar 3, 2025

sonarqubecloud bot commented Mar 3, 2025

gmuloc Mar 3, 2025

gmuloc Mar 3, 2025

gmuloc Mar 3, 2025

gmuloc Mar 3, 2025

gmuloc Mar 3, 2025

gmuloc Mar 3, 2025

	"""Return a list of policies for AutoVPN."""
	"""Set the list of policies for AutoVPN."""

	if path_group_name not in self.shared_utils.wan_local_path_groups:
	if path_group.name not in self.shared_utils.wan_local_path_groups:

	"""Retrieves the static peers to configure for a given path-group based on the connected nodes."""
	"""Set the static peers to configure for a given path-group based on the connected nodes."""

Refactor(eos_designs): Refactor eos_designs structured_config code for router_path_selection #5002

Are you sure you want to change the base?

Refactor(eos_designs): Refactor eos_designs structured_config code for router_path_selection #5002

Conversation

laxmikantchintakindi commented Feb 10, 2025 • edited Loading

Change Summary

Related Issue(s)

Component(s) name

Proposed changes

How to test

Checklist

User Checklist

Repository Checklist

github-actions bot commented Feb 10, 2025

github-actions bot commented Feb 27, 2025

github-actions bot commented Feb 28, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Mar 3, 2025

Quality Gate passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

laxmikantchintakindi commented Feb 10, 2025 •

edited

Loading