Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Standardize algorithm to verify if invalid argument was used. #652

Merged
merged 26 commits into from Oct 4, 2021
Merged

Standardize algorithm to verify if invalid argument was used. #652

merged 26 commits into from Oct 4, 2021

Conversation

rjeffman
Copy link
Member

@rjeffman rjeffman commented Oct 1, 2021

Almost all modules use a similar algorithm to validate if parameters
should not have had a value provided by user, and as the algorithm is
implemented in each method, errors may occur, and error messages
may differ.

This PR proposes the use of a common procedure for all modules, based on
an IPAAnsibleModule method. The module provides a list of attributes that
shuld be null for the state/action requested, and the execution fails if one of
those attributes value is not None.

@rjeffman rjeffman force-pushed the ipaansiblemodule_fail_if_invalid branch from 308b317 to 31bc6fe Compare October 1, 2021 00:28
@rjeffman
IPAAnsibleModule: Provide function to fail in param is invalid.
3dd9855 
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.
@rjeffman
automember: Use IPAAnsibleModule method to validate arguments.
23e38fa 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
delegation: Use IPAAnsibleModule method to validate arguments.
06ccc70 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
dnsconfig: : Use IPAAnsibleModule method to validate arguments.
f343379 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
dnsforwardzone: Use IPAAnsibleModule method to validate arguments.
67282b1 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
dnsrecord: Use IPAAnsibleModule method to validate arguments.
6f7b514 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
dnszone: Use IPAAnsibleModule method to validate arguments.
089400d 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
group: Use IPAAnsibleModule method to validate arguments.
602f3a0 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
hbacrule: Use IPAAnsibleModule method to validate arguments.
7564250 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
hbacsvc: Use IPAAnsibleModule method to validate arguments.
43d1a06 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
hbacsvcgroup: Use IPAAnsibleModule method to validate arguments.
952f62c 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
host: Use IPAAnsibleModule method to validate arguments.
c497c8c 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
hostgroup: Use IPAAnsibleModule method to validate arguments.
9bf2def 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
location: Use IPAAnsibleModule method to validate arguments.
fc3f64f 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
permission: Use IPAAnsibleModule method to validate arguments.
53defc9 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
privilege: Use IPAAnsibleModule method to validate arguments.
08f9259 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
pwpolicy: Use IPAAnsibleModule method to validate arguments.
efa6730 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
role: Use IPAAnsibleModule method to validate arguments.
1ae2c1e 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
selfservice: Use IPAAnsibleModule method to validate arguments.
970d6c1 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
server: Use IPAAnsibleModule method to validate arguments.
f9851f0 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
service: Use IPAAnsibleModule method to validate arguments.
81672bd 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
sudocmd: Use IPAAnsibleModule method to validate arguments.
7f80a3f 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
sudocmdgroup: Use IPAAnsibleModule method to validate arguments.
14c9f30 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
sudorule: Use IPAAnsibleModule method to validate arguments.
5a67aa7 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
user: Use IPAAnsibleModule method to validate arguments.
2ec65e9 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman
vault: Use IPAAnsibleModule method to validate arguments.
0fac277 
Use the IPAAnsibleModule.params_fail_if_used method to validate
arguments provided by user.
@rjeffman rjeffman force-pushed the ipaansiblemodule_fail_if_invalid branch from 31bc6fe to 0fac277 Compare October 1, 2021 12:50
@rjeffman rjeffman changed the title WIP: Standardize algorithm no verify if invalid argument was used. Standardize algorithm no verify if invalid argument was used. Oct 1, 2021
@rjeffman rjeffman marked this pull request as ready for review October 1, 2021 13:12
@rjeffman rjeffman changed the title Standardize algorithm no verify if invalid argument was used. Standardize algorithm to verify if invalid argument was used. Oct 1, 2021
t-woerner
t-woerner approved these changes Oct 4, 2021
View reviewed changes
Copy link
Member

@t-woerner t-woerner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@t-woerner t-woerner merged commit ee29425 into freeipa:master Oct 4, 2021
@rjeffman rjeffman deleted the ipaansiblemodule_fail_if_invalid branch February 23, 2022 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@t-woerner t-woerner t-woerner approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@rjeffman @t-woerner