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

SSM Automation document graph visualization to help with branching in complex workflows #24

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

SSM Automation document graph visualization to help with branching in complex workflows #24

wants to merge 7 commits into from

Conversation

alemartini
Copy link
Contributor

Issue #, if available:

Description of changes: SSMTester static method convert_document_to_dot_graph converts an SSM Automation document from a JSON format to a directional graph in DOT language [1].
For each document, I can now have an additional script under Setup, and update the Makefile to generate a visual representation of the workflow to analyze branching on onFailure and onSuccess.

As an example, I added the script to AWS-DetachEBSVolume. To test:

  • Navigate to the DetachEBSVolumes folder
  • run:
make graph
  • Copy the content of Output/aws-DetachEBSVolume.dot
// Detach EBS Volume
digraph {
    Start [label=Start]
    End [label=End]
    Start -> createDocumentStack
    createDocumentStack -> End [label=onFailure]
    createDocumentStack -> detachVolume [label=onSuccess]
    detachVolume -> End [label=onFailure]
    detachVolume -> deleteCloudFormationTemplate [label=onSuccess]
    deleteCloudFormationTemplate -> End [label=onSuccess]
    deleteCloudFormationTemplate -> End [label=onFailure]
}

[1] https://www.graphviz.org/doc/info/lang.html

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@alemartini alemartini changed the title Master amartini PR for issue: https://github.com/awslabs/aws-systems-manager/issues/23 Aug 22, 2018
@alemartini alemartini mentioned this pull request Aug 22, 2018
Open
@Drudenhaus Drudenhaus self-requested a review October 3, 2018 00:09
@Drudenhaus Drudenhaus assigned Drudenhaus and alemartini and unassigned Drudenhaus Oct 3, 2018
@Drudenhaus Drudenhaus changed the title PR for issue: https://github.com/awslabs/aws-systems-manager/issues/23 SSM Automation document graph visualization to help with branching in complex workflows Oct 3, 2018
Drudenhaus
Drudenhaus suggested changes Oct 4, 2018
View reviewed changes
Copy link
Contributor

@Drudenhaus Drudenhaus left a comment

Choose a reason for hiding this comment

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

I added a number of comments in-line. Also as a general thought: the placement of convert_document_to_dot_graph() in Documents/Automation/Testing/ssm_testing.py does not seem appropriate. The method isn't related to testing nor does it need to operate on an class instance (hence static). It may be worthwhile to make a separate location for tools.

Documents/Automation/Testing/ssm_testing.py
json_doc = json.load(jsonfile, object_pairs_hook=OrderedDict)

# Initializating the graph variable with the document description and the default Start and End nodes
graph = []
Copy link
Contributor

Choose a reason for hiding this comment

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

Lines 160-164 could be replaced with a single list literal.

Documents/Automation/Testing/ssm_testing.py
# or save the current step information to be able to create the edge when inspecting the next available step
elif step["onFailure"] == "Continue":
if "nextStep" in step:
label="onFailure color=\"red\""
Copy link
Contributor

Choose a reason for hiding this comment

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

PEP8: missing spaces around the = operator.

Documents/Automation/Testing/ssm_testing.py
label="onFailure color=\"red\""
if "isCritical" in step:
if step["isCritical"] == "false":
label="onFailure"
Copy link
Contributor

Choose a reason for hiding this comment

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

PEP8: missing spaces around the = operator.

Documents/Automation/Testing/ssm_testing.py
step["name"], step["nextStep"], label))
else:
add_edge_from_previous_step = True
label="onFailure color=\"red\""
Copy link
Contributor

Choose a reason for hiding this comment

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

PEP8: missing spaces around the = operator.

Documents/Automation/Testing/ssm_testing.py
previous_step_name = step["name"]
# Lastly, retrieve the next step from onFailure directly
else:
label="onFailure color=\"red\""
Copy link
Contributor

Choose a reason for hiding this comment

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

PEP8: missing spaces around the = operator.

Documents/Automation/Testing/ssm_testing.py
label="onFailure color=\"red\""
if "isCritical" in step:
if step["isCritical"] == "false":
label="onFailure"
Copy link
Contributor

Choose a reason for hiding this comment

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

PEP8: missing spaces around the = operator.

Documents/Automation/Testing/ssm_testing.py
del choice["NextStep"]
# Removing first and last character from the choice (that removes the curly brackets),
# escaping and adding a new line for each comma)
label = "\"{}\"".format(json.dumps(choice)[1:-1].replace('", "','"\\l"').replace('"','\\"'))
Copy link
Contributor

Choose a reason for hiding this comment

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

PEP8: missing spaces after the commas.

Documents/Automation/Testing/ssm_testing.py
json_doc = json.load(jsonfile, object_pairs_hook=OrderedDict)

# Initializating the graph variable with the document description and the default Start and End nodes
graph = []
Copy link
Contributor

Choose a reason for hiding this comment

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

I recommend choosing a different variable name. "graph" has its own meaning in the context of programming/computer science and the type of this variable is actually a list. Consider "dot_lines", "document_lines", or something else.

Documents/Automation/Testing/ssm_testing.py
elif step["onFailure"] == "Continue":
if "nextStep" in step:
label="onFailure color=\"red\""
if "isCritical" in step:
Copy link
Contributor

Choose a reason for hiding this comment

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

The two if lines could be condensed into one:

if "isCritical" in step and step["isCritical"] == "false":

This also applies to lines 238-239.

Documents/Automation/Testing/ssm_testing.py
break

# If action is aws:branch, checking all choices to visualize each branch
if step["action"] == "aws:branch":
Copy link
Contributor

Choose a reason for hiding this comment

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

SSM's branching feature supports the and, or, and not logical operators. I think it would be valuable to support them here as well.

@alemartini alemartini mentioned this pull request Mar 21, 2019
Merged
@mavogel
Copy link

mavogel commented Jan 20, 2023

Hi @alemartini any plan on tackling the requested changes any time soon? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Drudenhaus Drudenhaus Drudenhaus requested changes

At least 2 approving reviews are required to merge this pull request.

Assignees

@alemartini alemartini

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alemartini @mavogel @Drudenhaus