Refactor rds snapshot modules #2138
Merged
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
|
recheck |
|
recheck |
alinabuzachis
approved these changes
Jul 5, 2024
abikouo
reviewed
Jul 8, 2024
abikouo
approved these changes
Jul 17, 2024
| required_options = get_boto3_client_method_parameters(client, method_name, required=True) | ||
| if any(parameters.get(k) is None for k in required_options): | ||
| method_description = get_rds_method_attribute(method_name, module).operation_description | ||
| module.fail_json(msg=f"To {method_description} requires the parameters: {required_options}") |
There was a problem hiding this comment.
WDYT if we raise an AnsibleRDSError exception here and remove the module from function arguments
There was a problem hiding this comment.
In this case we also need module for the get_rds_method_attribute function.
There was a problem hiding this comment.
which in turn is needed for module.params (as currently written) :(
hakbailey
force-pushed
the
refactor_rds_snapshot_modules
branch
from
8569f9c to
d3ea854
Compare
tremble
approved these changes
Jul 23, 2024
| required_options = get_boto3_client_method_parameters(client, method_name, required=True) | ||
| if any(parameters.get(k) is None for k in required_options): | ||
| method_description = get_rds_method_attribute(method_name, module).operation_description | ||
| module.fail_json(msg=f"To {method_description} requires the parameters: {required_options}") |
There was a problem hiding this comment.
which in turn is needed for module.params (as currently written) :(
- Add describe_db_cluster_snapshots() function - Add get_snapshot() function to retrieve a single db instance or cluster snapshot using internal describe_db_snapshots() and describe_db_cluster_snapshots() - Add format_rds_client_method_parameters() to validate and format parameters for boto3 rds client methods - Update internal collection imports to use full collection path - Add unit tests for new functions
Changes to rds_instance module: - Replace get_final_snapshot() function with calls to get_snapshot() from module_utils/rds.py - Replace parameter formatting logic in get_parameters() with call to format_rds_client_method_parameters() from module_utils/rds.py - Remove unit tests for deleted get_final_snapshot() function Changes to rds_instance_snapshot module: - Replace get_snapshot() function with calls to get_snapshot() from module_utils/rds.py - Replace get_parameters() function with call to format_rds_client_method_parameters() from module_utils/rds.py - Remove global variables - Add type hinting to all functions Changes to rds_cluster_snapshot module: - Replace get_parameters() function with call to format_rds_client_method_parameters() from module_utils/rds.py - Remove global variables - Add type hinting to all functions Changes to rds_snapshot_info module: - Refactor internal common_snapshot_info() function to use describe_db_snapshots() and describe_db_cluster_snapshots() functions from module_utils/rds.py - Rename some variables to ensure consistent variable naming - Add type hinting to all functions
hakbailey
force-pushed
the
refactor_rds_snapshot_modules
branch
from
d3ea854 to
133c590
Compare
|
recheck |
softwarefactory-project-zuul
bot
merged commit 6f4143f
into
ansible-collections:main
36 checks passed
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.
SUMMARY
Move shared functionality from rds snapshot modules into rds module_utils. Second PR for #2003 / https://issues.redhat.com/browse/ACA-1343.
COMPONENT NAME
rds_cluster_snapshot
rds_instance_snapshot
rds_instance
rds_snapshot_info
module_utils/rds.py
ADDITIONAL INFORMATION
Detailed summary of all the changes:
module_utils/rds.py:
rds_instance module:
rds_instance_snapshot module:
rds_cluster_snapshot module:
rds_snapshot_info module: