Create foreman_user module #296
Conversation
modules/foreman_user.py
Outdated
| } | ||
|
|
||
| # List of allowed timezones | ||
| timezone_list = [ |
There was a problem hiding this comment.
Can we pull these from apypie? It's should be exposed via https://github.com/Apipie/apypie/blob/master/apypie/param.py#L19
There was a problem hiding this comment.
That would be awesome. I just need to figure out how to do that.
There was a problem hiding this comment.
First of all, I don't understand Apypie well enough to know how to fetch that data from the server.
Secondly, as far as I can tell when checking /apidoc/v2.json is that the validator field just contains a human description and I'm not sure if that is stable enough for us to parse it and use it for validation of the module params.
Perhaps we could replace the hardcoded list in a later PR?
There was a problem hiding this comment.
I was just about to comment something similar. We're going to need changes to apypie. 👍
There was a problem hiding this comment.
Can you please open an issue against apypie? The validators can use some love indeed ;)
module_utils/foreman_helper.py
Outdated
| @@ -200,7 +200,7 @@ def update_resource(self, resource, old_entity, entity_dict, check_missing, chec | |||
| if check_missing is not None: | |||
| for key in check_missing: | |||
| if key in entity_dict and key not in volatile_entity.keys(): | |||
| volatile_entity[key] = new_value | |||
| volatile_entity[key] = entity_dict[key] | |||
|
This probably also needs a rebase and the XDG_CACHE_HOME thing |
Done! |
plugins/modules/foreman_user.py
Outdated
| RETURN = ''' # ''' | ||
|
|
||
| from ansible.module_utils.foreman_helper import ( | ||
| sanitize_entity_dict, |
|
Argh, seems my client didn't post the actual question. Does the |
|
(it is from the description, wonder if we can make that more explicit in the code) |
Yeah I was thinking that myself. But it's kinda hard to do since we need to first check if the user exists before we know whether some params are required or not. So I think the best and most boring solution would be to just document the requirement and let the error from Foreman bleed through the module. Maybe in the future we could improve it further. |
| } | ||
|
|
||
| # List of allowed timezones | ||
| timezone_list = [ |
There was a problem hiding this comment.
Are these lists (until they are generated) better suited to live somewhere in module_utils?
There was a problem hiding this comment.
If we would use them in multiple modules they would be. But I'm not sure we will do that anytime soon. Do we want to stuff a lot of into the utils that is only used in a single module?
I vote for keeping stuff in modules, and then move into module_utils when it needs to be shared between two or more modules. What do you guys think?
test/test_playbooks/user.yml
Outdated
| gather_facts: false | ||
| tasks: | ||
| - name: Load server config | ||
| include_vars: |
There was a problem hiding this comment.
I guess, you need to adjust that now.
(Directory changed...)
Create a new module for managing users. In order to change password we need to force the `password` field to be sent during POST but that field is not included when doing GET, so we put it in `check_missing`. I noticed, though, that the value for `check_missing` was a variable from a separate loop which seems wrong. Instead I change it to get the value from the incoming desired dict. This makes the module behave as we want. To ensure that the new user works we do a minor API request as the newly created user.
|
@ephracis Thank you |
Create a new module for managing users. In order to change password we
need to force the
passwordfield to be sent during POST but thatfield is not included when doing GET, so we put it in
check_missing.I noticed, though, that the value for
check_missingwas a variablefrom a separate loop which seems wrong. Instead I change it to get the
value from the incoming desired dict. This makes the module behave as
we want.
To ensure that the new user works we do an API request as the
newly created user. We do this again after changing password to ensure it worked.
Closes #200