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

DOE-330: Add skip_when_destroying option to dependencies.json #2

Merged
merged 1 commit into from
Jan 13, 2025
Merged

DOE-330: Add skip_when_destroying option to dependencies.json #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions .github/actions/terraform-dependency-sort/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@
"type": "integer",
"default": 1
},
"skip_when_destroying": {
"type": "boolean",
"default": False
}
},
"required": ["dependencies"],
}
Expand All @@ -59,10 +63,11 @@


class Node:
def __init__(self, name: str, base_dir: str, runner_label=DEFAULT_RUNNER_LABEL, planned_changes=True):
def __init__(self, name: str, base_dir: str, runner_label=DEFAULT_RUNNER_LABEL, planned_changes=True, skip_when_destroying=False):
self.name = name
self.runner_label = runner_label
self.planned_changes = planned_changes
self.skip_when_destroying = skip_when_destroying
self.edges = []
self.valid_dir = self._verify_dir_exists(base_dir)
logger.debug(f"{name} was created as a Node object!")
Expand Down Expand Up @@ -120,7 +125,7 @@ def __init__(self, base_dir: str):
self.nodes = {}
self.base_dir = base_dir

def add_node(self, stack_dir: str, dependencies: list, runner_label=DEFAULT_RUNNER_LABEL, planned_changes=True):
def add_node(self, stack_dir: str, dependencies: list, runner_label=DEFAULT_RUNNER_LABEL, planned_changes=True, skip_when_destroying=False):
"""
Add a node to the graph.

Expand Down Expand Up @@ -156,6 +161,13 @@ def add_node(self, stack_dir: str, dependencies: list, runner_label=DEFAULT_RUNN
f"Existing: '{node.planned_changes}', New: '{planned_changes}'. Updating to new value."
)
node.planned_changes = planned_changes

if node.skip_when_destroying != skip_when_destroying:
logger.warning(
f"skip_when_destroying mismatch for '{stack_dir}'. "
f"Existing: '{node.skip_when_destroying}', New: '{skip_when_destroying}'. Updating to new value."
)
node.skip_when_destroying = skip_when_destroying

node = self.nodes[stack_dir]
for dep in dependencies:
Expand Down Expand Up @@ -267,6 +279,7 @@ def extract_dependencies_from_file(file_path):
raise ValidationError(f"{file_path} contains invalid JSON: {e.msg}") from e

planned_changes = data.get("planned-changes", True)
skip_when_destroying = data.get("skip_when_destroying", False)
runner_label = data.get("runner-label", DEFAULT_RUNNER_LABEL)

if runner_label not in [DEFAULT_RUNNER_LABEL, "self-hosted"]:
Expand All @@ -277,12 +290,14 @@ def extract_dependencies_from_file(file_path):

data["planned-changes"] = planned_changes
data["runner-label"] = runner_label
data["skip_when_destroying"] = skip_when_destroying
dependencies = data["dependencies"]["paths"]

return {
"paths": dependencies,
"runner-label": runner_label,
"planned-changes": planned_changes
"planned-changes": planned_changes,
"skip_when_destroying": skip_when_destroying
}


Expand All @@ -305,7 +320,8 @@ def process_stack_files(base_dir):
dependencies = dependencies_info["paths"]
runner_label = dependencies_info["runner-label"]
planned_changes = dependencies_info["planned-changes"]
graph.add_node(stack_dir, dependencies, runner_label=runner_label, planned_changes=planned_changes)
skip_when_destroying = dependencies_info["skip_when_destroying"]
graph.add_node(stack_dir, dependencies, runner_label=runner_label, planned_changes=planned_changes, skip_when_destroying=skip_when_destroying)

return graph

Expand All @@ -326,7 +342,8 @@ def process_stack_files(base_dir):
"directory": node.name,
"runner_label": node.runner_label,
"planned_changes": node.planned_changes,
"order": index + 1
"order": index + 1,
"skip_when_destroying": node.skip_when_destroying
}
for index, node in enumerate(sorted_nodes)
]
Expand Down
31 changes: 30 additions & 1 deletion .github/actions/terraform-dependency-sort/test/test_main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def create_dir(self, dir_name):
os.makedirs(path, exist_ok=True)
return path

def write_json(self, dir_name, paths_content, runner_label=None, planned_changes=None, valid_json=True):
def write_json(self, dir_name, paths_content, skip_when_destroying=None, runner_label=None, planned_changes=None, valid_json=True):
"""
Writes JSON to dependencies.json in dir_name.
If valid_json is False, writes arbitrary content to simulate malformed JSON.
Expand All @@ -35,6 +35,8 @@ def write_json(self, dir_name, paths_content, runner_label=None, planned_changes
json_content["runner-label"] = runner_label
if planned_changes is not None:
json_content["planned-changes"] = planned_changes
if skip_when_destroying is not None:
json_content["skip_when_destroying"] = skip_when_destroying
else:
json_content = paths_content # Malformed content
with open(path, "w") as f:
Expand Down Expand Up @@ -314,5 +316,32 @@ def test_planned_changes_in_output(self):

self.assertEqual(matrix, expected_matrix)

def test_skip_destroy_is_true(self):
"""Test that the final output includes the correct 'skip_when_destroying' values."""
self.write_json("stack1", ["./stack2"], planned_changes=True)
self.write_json("stack2", [], planned_changes=False, skip_when_destroying=True)

graph = process_stack_files(self.test_dir)
graph.resolve_dependencies()
sorted_nodes = graph.topological_sort()

# Simulate the final output
matrix = [
{
"directory": node.name,
"runner_label": node.runner_label,
"planned_changes": node.planned_changes,
"skip_when_destroying": node.skip_when_destroying
}
for node in sorted_nodes
]

expected_matrix = [
{"directory": "./stack2", "runner_label": "ubuntu-latest", "planned_changes": False, "skip_when_destroying": True},
{"directory": "./stack1", "runner_label": "ubuntu-latest", "planned_changes": True, "skip_when_destroying": False},
]

self.assertEqual(matrix, expected_matrix)

if __name__ == '__main__':
unittest.main()
Loading