From ed6555526d6af694646596d38c25eada3b24a33a Mon Sep 17 00:00:00 2001 From: Vinay M <63404819+roverflow@users.noreply.github.com> Date: Wed, 5 Apr 2023 18:54:10 +0530 Subject: [PATCH] Fixed the netaddr error msg for clarity (#244) * Fixed the netaddr error msg for clarity * added changelog * Used missing_required_lib --------- Co-authored-by: Kate Case --- changelogs/fragments/netaddr_error.yml | 3 +++ plugins/plugin_utils/base/ipaddr_utils.py | 6 ++---- plugins/plugin_utils/base/ipaddress_utils.py | 5 +---- 3 files changed, 6 insertions(+), 8 deletions(-) create mode 100644 changelogs/fragments/netaddr_error.yml diff --git a/changelogs/fragments/netaddr_error.yml b/changelogs/fragments/netaddr_error.yml new file mode 100644 index 0000000..823c7f8 --- /dev/null +++ b/changelogs/fragments/netaddr_error.yml @@ -0,0 +1,3 @@ +--- +trivial: + - fixed netaddr error message to give better clarity that the package is missing diff --git a/plugins/plugin_utils/base/ipaddr_utils.py b/plugins/plugin_utils/base/ipaddr_utils.py index ddbe3bb..0d75199 100644 --- a/plugins/plugin_utils/base/ipaddr_utils.py +++ b/plugins/plugin_utils/base/ipaddr_utils.py @@ -16,6 +16,7 @@ __metaclass__ = type import types from ansible.errors import AnsibleFilterError +from ansible.module_utils.basic import missing_required_lib from ansible.utils.display import Display @@ -598,10 +599,7 @@ def _need_netaddr(f_name, *args, **kwargs): """ verify python's netaddr for these filters to work """ - raise AnsibleFilterError( - "The %s filter requires python's netaddr be " - "installed on the ansible controller" % f_name, - ) + raise AnsibleFilterError(missing_required_lib("netaddr")) def _address_normalizer(value): diff --git a/plugins/plugin_utils/base/ipaddress_utils.py b/plugins/plugin_utils/base/ipaddress_utils.py index 152218b..3693adc 100644 --- a/plugins/plugin_utils/base/ipaddress_utils.py +++ b/plugins/plugin_utils/base/ipaddress_utils.py @@ -87,7 +87,4 @@ def _validate_args(plugin, doc, params): def _need_netaddr(f_name, *args, **kwargs): - raise errors.AnsibleFilterError( - "The %s filter requires python's netaddr be " - "installed on the ansible controller" % f_name, - ) + raise errors.AnsibleFilterError(missing_required_lib("netaddr"))