[PR #2248/31112152 backport][stable-9] Refactor Some Command-Related Methods in aws_ssm.py
#2261
Conversation
![patchback[bot]](https://avatars.githubusercontent.com/in/21488?s=60&v=4){kind=small}
SUMMARY This work is part of the currently ongoing AWS SSM Connection Refactoring & Plugin Promotion effort and related to ansible-collections/amazon.aws#2394. Fixes ACA-2095 ISSUE TYPE Feature Pull Request TASK LIST The _exec_transport_commands method is refactored to accept a single structured object (a tuple containing lists of command dictionaries) that contains the necessary command data. Create a custom dataclass to hold command output. Create a custom dataclass TypedDict to hold command results. The _generate_commands function returns a list of typed dictionaries with clear metadata (command strings, method, headers). _exec_transport_commands accepts a list of typed dictionaries as an argument and returns the custom CommandResults object. Python type hints are added to the method signature and the structured object to improve readability, facilitate static analysis, and clearly define the expected structure and data types. Docstrings should be added to any refactored methods and the structured object (if custom), clarifying the purpose, structure, inputs, outputs, and any edge cases or special handling (if applicable). Unit tests have been created to ensure that the refactored _generate_commands method outputs the expected structured command object. Add a changelog file. Reviewed-by: Bikouo Aubin Reviewed-by: Rahmanim Benny <[email protected]> Reviewed-by: Alina Buzachis Reviewed-by: GomathiselviS <[email protected]> Reviewed-by: Mark Chappell Reviewed-by: Bianca Henderson <[email protected]> Reviewed-by: Mike Graves <[email protected]> (cherry picked from commit 3111215)
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 3m 37s (non-voting) |
beeankha
requested review from
a team,
gravesm,
jillr,
hakbailey,
beeankha,
brahmanim,
alinabuzachis and
GomathiselviS
|
Build succeeded (gate pipeline). ❌ ansible-galaxy-importer POST_FAILURE in 4m 19s (non-voting) |
softwarefactory-project-zuul
bot
merged commit b2b2ff0
into
stable-9
softwarefactory-project-zuul
bot
deleted the
patchback/backports/stable-9/311121522ef21f2126e7f0b42121df0092db090c/pr-2248
branch
This is a backport of PR #2248 as merged into main (3111215).
SUMMARY
This work is part of the currently ongoing AWS SSM Connection Refactoring & Plugin Promotion effort and related to ansible-collections/amazon.aws#2394.
Fixes ACA-2095
ISSUE TYPE
TASK LIST
_exec_transport_commandsmethod is refactored to accept a single structured object (a tuple containing lists of command dictionaries) that contains the necessary command data.Create a custom dataclass to hold command output.custom dataclassTypedDictto hold command results._generate_commandsfunction returns a list of typed dictionaries with clear metadata (command strings, method, headers)._exec_transport_commandsaccepts a list of typed dictionaries as an argument and returns the customCommandResultsobject._generate_commandsmethod outputs the expected structured command object.