Refactor(pyavd)!: Make sort_key mandatory in natural_sort when sorting list of dictionaries (aristanetworks#6273)

Co-authored-by: Shivani-gslab <[email protected]>
Co-authored-by: Claus Holbech <[email protected]>

Author: 3 people

ansible_collections/arista/avd/examples/cv-pathfinder/documentation/fabric/WAN-documentation.md

@@ -68,10 +68,10 @@
 | l3leaf | site2-leaf2 | Ethernet3 | wan_router | site2-wan2 | Ethernet1 |
 | l3leaf | site2-leaf2 | Ethernet3.100 | wan_router | site2-wan2 | Ethernet1.100 |
 | l3leaf | site2-leaf2 | Ethernet3.101 | wan_router | site2-wan2 | Ethernet1.101 |
-| l2leaf | site3-leaf1 | Ethernet1 VLAN 42 | wan_router | site3-wan1 | Ethernet1.42 |
-| l2leaf | site3-leaf1 | Ethernet1 VLAN 666 | wan_router | site3-wan1 | Ethernet1.666 |
 | l2leaf | site3-leaf1 | Ethernet1 | wan_router | site3-wan1 | Ethernet1 |
 | l2leaf | site3-leaf1 | Ethernet1 | wan_router | site3-wan1 | Ethernet1 |
+| l2leaf | site3-leaf1 | Ethernet1 VLAN 42 | wan_router | site3-wan1 | Ethernet1.42 |
+| l2leaf | site3-leaf1 | Ethernet1 VLAN 666 | wan_router | site3-wan1 | Ethernet1.666 |
 | l3leaf | site4-border1 | Ethernet3 | wan_router | site4-wan1 | Ethernet1 |
 | l3leaf | site4-border1 | Ethernet5 | mlag_peer | site4-border2 | Ethernet5 |
 | l3leaf | site4-border1 | Ethernet6 | mlag_peer | site4-border2 | Ethernet6 |

ansible_collections/arista/avd/extensions/molecule/eos_cli_config_gen/documentation/devices/host1.md

@@ -885,9 +885,9 @@ management tech-support
 | FTP | default | Loopback0 |
 | FTP | MGMT | Management0 |
 | FTP | abc | Ethernet10 |
+| HTTP | default | Ethernet10 |
 | HTTP | default | Loopback0 |
 | HTTP | MGMT | Management0 |
-| HTTP | default | Ethernet10 |
 | SSH | default | Ethernet10 |
 | SSH | default | Loopback0 |
 | SSH | MGMT | Management0 |
@@ -905,9 +905,9 @@ management tech-support
 ip ftp client source-interface Loopback0
 ip ftp client source-interface Management0 vrf MGMT
 ip ftp client source-interface Ethernet10 vrf abc
+ip http client local-interface Ethernet10
 ip http client local-interface Loopback0 vrf default
 ip http client local-interface Management0 vrf MGMT
-ip http client local-interface Ethernet10
 ip ssh client source-interface Ethernet10
 ip ssh client source-interface Loopback0 vrf default
 ip ssh client source-interface Management0 vrf MGMT
@@ -1370,19 +1370,19 @@ tacacs-server host 10.10.10.160
 
 | VRF | Source Interface Name |
 | --- | --------------- |
-| default | loopback1 |
-| TEST1 | lo3 |
-| default | loopback10 |
+| default | Loopback1 |
+| TEST1 | Loopback3 |
+| default | Loopback10 |
 
 #### IP TACACS Source Interfaces Device Configuration
 
 ```eos
 !
-ip tacacs vrf default source-interface loopback1
+ip tacacs vrf default source-interface Loopback1
 !
-ip tacacs vrf TEST1 source-interface lo3
+ip tacacs vrf TEST1 source-interface Loopback3
 !
-ip tacacs source-interface loopback10
+ip tacacs source-interface Loopback10
 ```
 
 ### Radius Proxy
@@ -1582,19 +1582,19 @@ radius-server host 10.10.11.155 vrf mgt tls ssl-profile HOST_SSL_PROFILE port 20
 
 | VRF | Source Interface Name |
 | --- | --------------- |
-| default | loopback1 |
-| MGMT | Ma1 |
-| default | loopback10 |
+| default | Loopback1 |
+| default | Loopback10 |
+| MGMT | Management1 |
 
 #### IP SOURCE Source Interfaces Device Configuration
 
 ```eos
 !
-ip radius vrf default source-interface loopback1
+ip radius vrf default source-interface Loopback1
 !
-ip radius vrf MGMT source-interface Ma1
+ip radius source-interface Loopback10
 !
-ip radius source-interface loopback10
+ip radius vrf MGMT source-interface Management1
 ```
 
 ### AAA Server Groups

ansible_collections/arista/avd/extensions/molecule/eos_cli_config_gen/intended/configs/host1.cfg

@@ -5265,9 +5265,9 @@ ip nat synchronization
 ip ftp client source-interface Loopback0
 ip ftp client source-interface Management0 vrf MGMT
 ip ftp client source-interface Ethernet10 vrf abc
+ip http client local-interface Ethernet10
 ip http client local-interface Loopback0 vrf default
 ip http client local-interface Management0 vrf MGMT
-ip http client local-interface Ethernet10
 ip ssh client source-interface Ethernet10
 ip ssh client source-interface Loopback0 vrf default
 ip ssh client source-interface Management0 vrf MGMT
@@ -5472,11 +5472,11 @@ priority-flow-control pause watchdog default recovery-time 1.22
 priority-flow-control pause watchdog default polling-interval 10.001
 priority-flow-control pause watchdog action no-drop
 !
-ip radius vrf default source-interface loopback1
+ip radius vrf default source-interface Loopback1
 !
-ip radius vrf MGMT source-interface Ma1
+ip radius source-interface Loopback10
 !
-ip radius source-interface loopback10
+ip radius vrf MGMT source-interface Management1
 !
 role network-limited
    10 permit mode exec command ssh
@@ -7136,11 +7136,11 @@ stun
       binding timeout 600 seconds
       ssl connection lifetime 1300 minutes
 !
-ip tacacs vrf default source-interface loopback1
+ip tacacs vrf default source-interface Loopback1
 !
-ip tacacs vrf TEST1 source-interface lo3
+ip tacacs vrf TEST1 source-interface Loopback3
 !
-ip tacacs source-interface loopback10
+ip tacacs source-interface Loopback10
 !
 traffic-policies
    field-set l4-port SERVICE-DEMO

ansible_collections/arista/avd/extensions/molecule/eos_cli_config_gen/inventory/host_vars/host1/ip-radius-source-interface.yml

@@ -3,8 +3,8 @@
 
 ip_radius_source_interfaces:
   - vrf: default
-    name: loopback1
+    name: Loopback1
   - vrf: MGMT
-    name: Ma1
+    name: Management1
   - vrf:
-    name: loopback10
+    name: Loopback10

ansible_collections/arista/avd/extensions/molecule/eos_cli_config_gen/inventory/host_vars/host1/ip-tacacs-source-interface.yml

@@ -3,8 +3,8 @@
 
 ip_tacacs_source_interfaces:
   - vrf: default
-    name: loopback1
+    name: Loopback1
   - vrf: TEST1
-    name: lo3
+    name: Loopback3
   - vrf:
-    name: loopback10
+    name: Loopback10

ansible_collections/arista/avd/plugins/filter/natural_sort.py

@@ -38,7 +38,7 @@
   - |-
       Provides the capability to sort a list or a dictionary of integers and strings that contain alphanumeric characters naturally.
       When leveraged on a dictionary, only the key value will be returned.
-      An optional `sort_key` can be specified, to sort on content of certain key if the items are dictionaries.
+      If the items are dictionaries, a `sort_key` must be specified, to sort on the content of the key.
   - The filter will return an empty list if the value parsed to `arista.avd.natural_sort` is `None` or `undefined`.
 positional: _input
 options: