Adding module_utils to allow for common utilites that can be shared among ansible modules. #2623
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
wangxin
reviewed
Dec 15, 2020
ansible/module_utils/debug_utils.py
Outdated
|
|
||
| def create_debug_file(debug_fname): | ||
| curtime = datetime.datetime.now().isoformat() | ||
| timed_debug_fname = debug_fname % curtime |
There was a problem hiding this comment.
This requires that the debug_fname must be a template string. Without looking into the code, user may pass in an ordinary string as debug file name. Can this be improved?
There was a problem hiding this comment.
Added add_timestamp option to create_debug_file which defaults to True. If specified it will add the timestamp in between the extension (if present) and the base file name. Otherwise it will append timestamp to the end of the passed filename.
If add_timestamp is False, we will create the file with the passed filename itself with no timestamp.
Sometimes, there are utilities that are required for across multiple ansible modules in ansible/library. This commit adds module_utils directory under ansible and added module_utils in ansible.cfg to use this directory for ansible modules. Added debug_utils as an example with the following methods/utilities: - create_debug_file - create a timestamped debug file - print_debug_msg - print a message to the debug file. Added debug commands above to conn_graph_facts as an example.
Added add_timestamp optional arg to create_debug_file.
If add_timestamp is true, then
if there is an extension (like .txt) in the passed filename, then
insert curtime before the extension
else
insert curtime at the end
create file with name that has timestamp added to the passed filename
else
create file with name as the passed filename
sanmalho-git
force-pushed
the
module_utils
branch
from
5ac9856
to
ab5d8a0
Compare
wangxin
approved these changes
Dec 16, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of PR
Summary:
Fixes # (issue)
Type of change
Approach
What is the motivation for this PR?
Sometimes, there are utilities that are required for across multiple ansible modules in ansible/library.
For example:
How did you do it?
Usage of ansible module_utils is defined at https://docs.ansible.com/ansible/latest/dev_guide/developing_module_utilities.html
To have custom module_utils, we need to:
So, we did the following:
Added debug_utils as an example with the following methods/utilities:
Added debug commands above to conn_graph_facts as an example.
How did you verify/test it?
Made sure that conn_graph_facts works and the debug file is created.
Any platform specific information?
Supported testbed topology if it's a new test case?
Documentation