2.5.1 bug fixes (#450)

* Enable system auditd and ip loadshare hash downward compatibility (#441)

* Enable system auditd and ip loadshare hash downward compatibility.

* Add a fragment file.

* Add mock handling for edit_config_catch

* Fix sanity errors.

* Fix mistakes in the fragment file.

* Modify the fix to operation on individual requests in the enterprise_sonic httpapi plugin.

* Enable conditional suppression of GET exceptions.

* Fix handling for an empty GET response.

* Fix an indentation in the PoE facts file and fix global PoE empty configuration handling.

* Update regex expression in edit_config method (#443)

* Update regex expression in edit_config method

* Change fragment to bugfix

* Update 443-update-regex-edit-config.yaml

* Add import of the Ansible ConnectionError exception class for all files where it is used. (#445)

* Add import of the Ansible ConnectionError exception class for all files where it is used.

* Add a fragment file.

* Fix broken module documentation links in the README.md file (#446)

* In the enterprise_sonic README.md file, use the new Galaxy module documentation site for all links.

* Add a changelog fragment for this PR.

* Fix incorrect global regex results.

* Change the fragment designation to "trivial" to match changing the PR type to "documentation".

* Delete changed, redundant fragment file.

---------

Co-authored-by: stalabi1 <54641848+stalabi1@users.noreply.github.com>

changelogs/fragments/441-system-downward-compatibility-fix.yaml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - sonic_system - Catch the ConnectionError exception caused by unconditional fetching of auditd and ip loadshare hash algorithm configuration, and return empty configuration instead of allowing the uncaught exception to abort all "system" operations on SONiC images older than version 4.4.0 (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/441).

changelogs/fragments/443-update-regex-edit-config.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+  - Update regex search expression for 'not found' error message in httpapi/sonic.py 'edit_config' method (https://github.com/ansible-collection/dellemc.enterprise_sonic/pull/443).

changelogs/fragments/445-ConnectionError-add-imports.yaml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - ConnectionError - Add the needed import of the Ansible ConnectionError exception class for all files where it was previously missing. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/445).

changelogs/fragments/446-README-documentation-links-fix.yaml

@@ -0,0 +1,3 @@
+---
+trivial:
+  - README - Update all links to module documentation to use the new Ansible documentation web site on the galaxy.ansible.com domain(https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/446).

plugins/httpapi/sonic.py

@@ -39,6 +39,7 @@
 
 import json
 import time
+import re
 
 from ansible.module_utils._text import to_text
 from ansible.module_utils.connection import ConnectionError
@@ -67,7 +68,7 @@ def send_request(self, data, **message_kwargs):
     def get(self, command):
         return self.send_request(path=command, data=None, method='get')
 
-    def edit_config(self, requests):
+    def edit_config(self, requests, suppr_ntf_excp=True):
         """Send a list of http requests to remote device and return results
         """
         if requests is None:
@@ -78,7 +79,11 @@ def edit_config(self, requests):
             try:
                 response = self.send_request(**req)
             except ConnectionError as exc:
-                raise ConnectionError(to_text(exc, errors='surrogate_then_replace'))
+                if suppr_ntf_excp and req.get('method') == 'get' and re.search("[nN]ot [fF]ound.*code': 404", str(exc)):
+                    # 'code': 404, 'error-message': 'Resource not found'
+                    response = [{}, {}]
+                else:
+                    raise ConnectionError(to_text(exc, errors='surrogate_then_replace'))
             responses.append(response)
         return responses
 

plugins/module_utils/network/sonic/config/bfd/bfd.py

@@ -14,6 +14,7 @@
 __metaclass__ = type
 
 from copy import deepcopy
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase
 )

plugins/module_utils/network/sonic/config/copp/copp.py

@@ -15,6 +15,7 @@
 __metaclass__ = type
 
 from copy import deepcopy
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/dhcp_snooping/dhcp_snooping.py

@@ -16,6 +16,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/mac/mac.py

@@ -14,6 +14,7 @@
 __metaclass__ = type
 
 from copy import deepcopy
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/ospf_area/ospf_area.py

@@ -14,6 +14,7 @@
 __metaclass__ = type
 
 from copy import deepcopy
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/pki/pki.py

@@ -15,6 +15,7 @@
 
 __metaclass__ = type
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/poe/poe.py

@@ -16,6 +16,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/prefix_lists/prefix_lists.py

@@ -14,6 +14,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/qos_buffer/qos_buffer.py

@@ -13,6 +13,7 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/qos_interfaces/qos_interfaces.py

@@ -14,6 +14,7 @@
 __metaclass__ = type
 
 from copy import deepcopy
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/qos_maps/qos_maps.py

@@ -14,6 +14,7 @@
 __metaclass__ = type
 
 from copy import deepcopy
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/qos_pfc/qos_pfc.py

@@ -14,6 +14,7 @@
 __metaclass__ = type
 
 from copy import deepcopy
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/qos_scheduler/qos_scheduler.py

@@ -14,6 +14,7 @@
 __metaclass__ = type
 
 from copy import deepcopy
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/qos_wred/qos_wred.py

@@ -20,6 +20,7 @@
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
     to_list,
 )
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.utils.utils import (
     get_diff,
     remove_empties_from_list,

plugins/module_utils/network/sonic/config/roce/roce.py

@@ -13,6 +13,7 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/route_maps/route_maps.py

@@ -18,6 +18,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/sflow/sflow.py

@@ -15,6 +15,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/config/static_routes/static_routes.py

@@ -15,6 +15,7 @@
 __metaclass__ = type
 
 from copy import deepcopy
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
     ConfigBase,
 )

plugins/module_utils/network/sonic/facts/bfd/bfd.py

@@ -14,6 +14,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )

plugins/module_utils/network/sonic/facts/copp/copp.py

@@ -18,6 +18,7 @@
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.utils.utils import (
     remove_empties
 )

plugins/module_utils/network/sonic/facts/mac/mac.py

@@ -14,6 +14,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )

plugins/module_utils/network/sonic/facts/mgmt_servers/mgmt_servers.py

@@ -14,6 +14,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )

plugins/module_utils/network/sonic/facts/ospf_area/ospf_area.py

@@ -14,6 +14,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
     remove_empties,
     validate_config,

plugins/module_utils/network/sonic/facts/pki/pki.py

@@ -16,6 +16,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )

plugins/module_utils/network/sonic/facts/poe/poe.py

@@ -17,6 +17,7 @@
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.argspec.poe.poe import PoeArgs
 
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.sonic \
@@ -157,12 +158,7 @@ def get_poe_info(self):
             self._module.fail_json(msg=str(exc))
 
         poe_config = {}
-        try:
-            poe_config = response[0][1]
-            if len(poe_config) > 0:
-                poe_config = poe_config["openconfig-poe:poe"]
-        except Exception:
-            raise Exception("response from getting poe facts not formed as expected")
+        poe_config = response[0][1].get("openconfig-poe:poe", {})
 
         # get poe interface settings
         try:
@@ -172,14 +168,11 @@ def get_poe_info(self):
             self._module.fail_json(msg=str(exc))
 
         interface_poe_settings = []
-        try:
-            interface_poe_settings = []
-            for interface in response[0][1]["openconfig-interfaces:interfaces"]["interface"]:
-                interface_settings = interface.get("openconfig-if-ethernet:ethernet", {}).get("openconfig-if-poe:poe", {})
-                if len(interface_settings) > 0:
-                    interface_settings.update({"name": interface["name"]})
-                    interface_poe_settings.append(interface_settings)
-        except Exception:
-            raise Exception("response from getting poe facts not formed as expected")
+        poe_interfaces = response[0][1].get("openconfig-interfaces:interfaces", {}).get("interface", [])
+        for interface in poe_interfaces:
+            interface_settings = interface.get("openconfig-if-ethernet:ethernet", {}).get("openconfig-if-poe:poe", {})
+            if len(interface_settings) > 0:
+                interface_settings.update({"name": interface["name"]})
+                interface_poe_settings.append(interface_settings)
         formatted_specs = self.format_to_argspec(poe_config, interface_poe_settings)
         return formatted_specs

plugins/module_utils/network/sonic/facts/prefix_lists/prefix_lists.py

@@ -19,6 +19,7 @@
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )
+from ansible.module_utils.connection import ConnectionError
 
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.utils.utils \
     import (

plugins/module_utils/network/sonic/facts/qos_interfaces/qos_interfaces.py

@@ -17,6 +17,7 @@
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.utils.utils import (
     remove_empties_from_list
 )

plugins/module_utils/network/sonic/facts/qos_maps/qos_maps.py

@@ -17,6 +17,7 @@
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.utils.utils import (
     remove_empties
 )

plugins/module_utils/network/sonic/facts/qos_pfc/qos_pfc.py

@@ -14,6 +14,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )

plugins/module_utils/network/sonic/facts/qos_scheduler/qos_scheduler.py

@@ -14,6 +14,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )

plugins/module_utils/network/sonic/facts/qos_wred/qos_wred.py

@@ -17,6 +17,7 @@
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.utils.utils import (
     remove_empties_from_list
 )

plugins/module_utils/network/sonic/facts/roce/roce.py

@@ -14,6 +14,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )

plugins/module_utils/network/sonic/facts/route_maps/route_maps.py

@@ -18,6 +18,7 @@
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.argspec.route_maps.route_maps import Route_mapsArgs
 
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.utils.utils import remove_empties_from_list

plugins/module_utils/network/sonic/facts/sflow/sflow.py

@@ -17,6 +17,7 @@
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.argspec.sflow.sflow import SflowArgs
 
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.sonic \
@@ -53,17 +54,21 @@ def populate_facts(self, connection, ansible_facts, data=None):
         if not data:
             data = self.get_sflow_info()
 
-        data = self.format_to_argspec(data)
+        # convert to argspec for ansible_facts
+        facts = {}
+        if data:
+            data = self.format_to_argspec(data)
 
-        # validate can add null values for things missing from device config,
-        #   so doing that before remove empties
-        cleaned_data = utils.remove_empties(
-            utils.validate_config(self.argument_spec, data)
-        )
+            # validate can add null values for things missing from device config,
+            #   so doing that before remove empties
+            cleaned_data = utils.remove_empties(
+                utils.validate_config(self.argument_spec, data)
+            )
+            if cleaned_data:
+                facts["sflow"] = cleaned_data["config"]
 
         ansible_facts['ansible_network_resources'].pop('sflow', None)
-        if cleaned_data:
-            ansible_facts['ansible_network_resources'].update({"sflow": cleaned_data["config"]})
+        ansible_facts['ansible_network_resources'].update(facts)
 
         return ansible_facts
 
@@ -121,7 +126,7 @@ def get_sflow_info(self):
 
         response_body = {}
         try:
-            response_body = response[0][1][response_key]
+            response_body = response[0][1].get(response_key)
         except Exception:
             raise Exception("response from getting sflow facts not formed as expected")
 

plugins/module_utils/network/sonic/facts/static_routes/static_routes.py

@@ -15,6 +15,7 @@
 
 from copy import deepcopy
 
+from ansible.module_utils.connection import ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
     utils,
 )