Change config diff utility function (#318)

* Change config util * Fix sanity error * Add fragment file * Fix sanity error * Address review comment * Address more review comments
ansible-collections · Dec 22, 2023 · 9572088 · 9572088
1 parent a745f08
commit 9572088
Show file tree

Hide file tree

Showing 24 changed files with 208 additions and 87 deletions.
diff --git a/changelogs/fragments/318-playbook-diff-mode-enhancement.yaml b/changelogs/fragments/318-playbook-diff-mode-enhancement.yaml
@@ -0,0 +1,19 @@
+minor_changes:
+  - sonic_aaa - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_acl_interfaces - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_interfaces - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_ip_neighbor - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_l2_acls - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_l2_interfaces - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_l3_acls - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_lag_interfaces - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_logging - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_ntp - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_port_group - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_radius_server - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_static_routes - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_system - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_tacacs_server - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_users - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_vlans - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
+  - sonic_vrfs - Enhance config diff generation function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/318).
diff --git a/plugins/module_utils/network/sonic/config/aaa/aaa.py b/plugins/module_utils/network/sonic/config/aaa/aaa.py
@@ -100,8 +100,9 @@ def execute_module(self):
             new_config = get_new_config(commands, existing_aaa_facts)
             result['after(generated)'] = new_config
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(old_config,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(old_config,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/acl_interfaces/acl_interfaces.py b/plugins/module_utils/network/sonic/config/acl_interfaces/acl_interfaces.py
@@ -132,8 +132,9 @@ def execute_module(self):
         if self._module._diff:
             self.sort_config(new_config)
             self.sort_config(old_config)
-            result['config_diff'] = get_formatted_config_diff(old_config,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(old_config,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/interfaces/interfaces.py b/plugins/module_utils/network/sonic/config/interfaces/interfaces.py
@@ -169,8 +169,9 @@ def execute_module(self):
             old_config.sort(key=lambda x: x['name'])
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(old_config,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(old_config,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/ip_neighbor/ip_neighbor.py b/plugins/module_utils/network/sonic/config/ip_neighbor/ip_neighbor.py
@@ -87,7 +87,7 @@ def __derive_ip_neighbor_config_delete_op(key_set, command, exist_conf):
 
 
 TEST_KEYS_formatted_diff = [
-    {'__delete_op_default': {'__delete_op': __derive_ip_neighbor_config_delete_op}},
+    {'__default_ops': {'__delete_op': __derive_ip_neighbor_config_delete_op}},
 ]
 
 
@@ -170,8 +170,9 @@ def execute_module(self):
             result['after(generated)'] = new_config
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(existing_ip_neighbor_facts,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(existing_ip_neighbor_facts,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/l2_acls/l2_acls.py b/plugins/module_utils/network/sonic/config/l2_acls/l2_acls.py
@@ -162,8 +162,9 @@ def execute_module(self):
         if self._module._diff:
             self.sort_config(new_config)
             self.sort_config(old_config)
-            result['config_diff'] = get_formatted_config_diff(old_config,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(old_config,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/l2_interfaces/l2_interfaces.py b/plugins/module_utils/network/sonic/config/l2_interfaces/l2_interfaces.py
@@ -134,8 +134,9 @@ def execute_module(self):
         if self._module._diff:
             self.sort_config(new_config)
             self.sort_config(old_config)
-            result['config_diff'] = get_formatted_config_diff(old_config,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(old_config,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/l3_acls/l3_acls.py b/plugins/module_utils/network/sonic/config/l3_acls/l3_acls.py
@@ -191,8 +191,9 @@ def execute_module(self):
         if self._module._diff:
             self.sort_config(new_config)
             self.sort_config(old_config)
-            result['config_diff'] = get_formatted_config_diff(old_config,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(old_config,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/lag_interfaces/lag_interfaces.py b/plugins/module_utils/network/sonic/config/lag_interfaces/lag_interfaces.py
@@ -141,8 +141,9 @@ def execute_module(self):
         if self._module._diff:
             self.sort_config(new_config)
             self.sort_config(old_config)
-            result['config_diff'] = get_formatted_config_diff(old_config,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(old_config,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/logging/logging.py b/plugins/module_utils/network/sonic/config/logging/logging.py
@@ -121,8 +121,9 @@ def execute_module(self):
             result['after(generated)'] = new_config
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(existing_logging_facts,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(existing_logging_facts,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/ntp/ntp.py b/plugins/module_utils/network/sonic/config/ntp/ntp.py
@@ -48,7 +48,7 @@
     {"ntp_keys": {"key_id": ""}}
 ]
 TEST_KEYS_formatted_diff = [
-    {'__delete_op_default': {'__delete_op': __DELETE_LEAFS_OR_CONFIG_IF_NO_NON_KEY_LEAF}},
+    {'__default_ops': {'__delete_op': __DELETE_LEAFS_OR_CONFIG_IF_NO_NON_KEY_LEAF}},
     {"servers": {"address": "", '__delete_op': __DELETE_CONFIG_IF_NO_SUBCONFIG}},
     {"ntp_keys": {"key_id": "", '__delete_op': __DELETE_CONFIG_IF_NO_SUBCONFIG}}
 ]
@@ -122,9 +122,9 @@ def execute_module(self):
             result['after(generated)'] = new_config
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(existing_ntp_facts,
-                                                              new_config)
-
+            result['diff'] = get_formatted_config_diff(existing_ntp_facts,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/port_group/port_group.py b/plugins/module_utils/network/sonic/config/port_group/port_group.py
@@ -133,8 +133,9 @@ def execute_module(self):
             result['after(generated)'] = new_config
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(existing_port_group_facts,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(existing_port_group_facts,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/radius_server/radius_server.py b/plugins/module_utils/network/sonic/config/radius_server/radius_server.py
@@ -43,7 +43,7 @@
     {'host': {'name': ''}},
 ]
 TEST_KEYS_formatted_diff = [
-    {'__delete_op_default': {'__delete_op': __DELETE_LEAFS_OR_CONFIG_IF_NO_NON_KEY_LEAF}},
+    {'__default_ops': {'__delete_op': __DELETE_LEAFS_OR_CONFIG_IF_NO_NON_KEY_LEAF}},
     {'host': {'name': '', '__delete_op': __DELETE_CONFIG_IF_NO_SUBCONFIG}},
 ]
 
@@ -110,8 +110,9 @@ def execute_module(self):
             result['after(generated)'] = new_config
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(existing_radius_server_facts,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(existing_radius_server_facts,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/static_routes/static_routes.py b/plugins/module_utils/network/sonic/config/static_routes/static_routes.py
@@ -170,8 +170,9 @@ def execute_module(self):
         if self._module._diff:
             self.sort_lists_in_config(new_config)
             self.sort_lists_in_config(old_config)
-            result['config_diff'] = get_formatted_config_diff(old_config,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(old_config,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/system/system.py b/plugins/module_utils/network/sonic/config/system/system.py
@@ -61,7 +61,7 @@ def __derive_system_config_delete_op(key_set, command, exist_conf):
 
 
 TEST_KEYS_formatted_diff = [
-    {'__delete_op_default': {'__delete_op': __derive_system_config_delete_op}},
+    {'__default_ops': {'__delete_op': __derive_system_config_delete_op}},
 ]
 
 
@@ -126,8 +126,9 @@ def execute_module(self):
             result['after(generated)'] = new_config
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(existing_system_facts,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(existing_system_facts,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/tacacs_server/tacacs_server.py b/plugins/module_utils/network/sonic/config/tacacs_server/tacacs_server.py
@@ -43,7 +43,7 @@
     {'host': {'name': ''}},
 ]
 TEST_KEYS_formatted_diff = [
-    {'__delete_op_default': {'__delete_op': __DELETE_LEAFS_OR_CONFIG_IF_NO_NON_KEY_LEAF}},
+    {'__default_ops': {'__delete_op': __DELETE_LEAFS_OR_CONFIG_IF_NO_NON_KEY_LEAF}},
     {'host': {'name': '', '__delete_op': __DELETE_CONFIG_IF_NO_SUBCONFIG}},
 ]
 
@@ -110,8 +110,9 @@ def execute_module(self):
             result['after(generated)'] = new_config
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(existing_tacacs_server_facts,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(existing_tacacs_server_facts,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/users/users.py b/plugins/module_utils/network/sonic/config/users/users.py
@@ -118,8 +118,9 @@ def execute_module(self):
         if self._module._diff:
             self.sort_lists_in_config(new_config)
             self.sort_lists_in_config(old_config)
-            result['config_diff'] = get_formatted_config_diff(old_config,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(old_config,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/vlans/vlans.py b/plugins/module_utils/network/sonic/config/vlans/vlans.py
@@ -115,8 +115,9 @@ def execute_module(self):
             result['after(generated)'] = new_config
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(existing_vlans_facts,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(existing_vlans_facts,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result
 

diff --git a/plugins/module_utils/network/sonic/config/vrfs/vrfs.py b/plugins/module_utils/network/sonic/config/vrfs/vrfs.py
@@ -116,8 +116,9 @@ def execute_module(self):
             result['after(generated)'] = new_config
 
         if self._module._diff:
-            result['config_diff'] = get_formatted_config_diff(existing_vrf_interfaces_facts,
-                                                              new_config)
+            result['diff'] = get_formatted_config_diff(existing_vrf_interfaces_facts,
+                                                       new_config,
+                                                       self._module._verbosity)
         result['warnings'] = warnings
         return result