From 3dd9855916a520e7459e4fa25732c8879b155eb2 Mon Sep 17 00:00:00 2001
From: Rafael Guterres Jeffman <rjeffman@redhat.com>
Date: Thu, 30 Sep 2021 21:05:23 -0300
Subject: [PATCH] IPAAnsibleModule: Provide function to fail in param is
invalid.
Almost all modules require an algorithm ta validade if the user
provided arguments for the playbook are valid for the requested
state and/or action.
This patch provides a function that tests if any of a list of
arguments were set, and fail with a standardized message, making
all modules fail in the same way.
---
.../module_utils/ansible_freeipa_module.py | 24 +++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/plugins/module_utils/ansible_freeipa_module.py b/plugins/module_utils/ansible_freeipa_module.py
index fe526804..2dfc1d37 100644
--- a/plugins/module_utils/ansible_freeipa_module.py
+++ b/plugins/module_utils/ansible_freeipa_module.py
@@ -674,6 +674,30 @@ else:
"""
return module_params_get(self, name)
+ def params_fail_used_invalid(self, invalid_params, state, action=None):
+ """
+ Fail module execution if one of the invalid parameters is not None.
+
+ Parameters
+ ----------
+ invalid_params:
+ List of parameters that must value 'None'.
+ state:
+ State being tested.
+ action:
+ Action being tested (optional).
+
+ """
+ if action is None:
+ msg = "Argument '{0}' can not be used with state '{1}'"
+ else:
+ msg = "Argument '{0}' can not be used with action "\
+ "'{2}' and state '{1}'"
+
+ for param in invalid_params:
+ if self.params.get(param) is not None:
+ self.fail_json(msg=msg.format(param, state, action))
+
def ipa_command(self, command, name, args):
"""
Execute an IPA API command with a required `name` argument.
--
GitLab