refactor: config.yaml to toggle dependency graph status field.

Signed-off-by: Yuki Ito <yuki462@ibm.com>

Author: yuki462-b

oper8/config/config.yaml

@@ -33,6 +33,10 @@ manage_status: true
 # Whether or not to apply the internal name annotation to output resources
 internal_name_annotation: true
 
+# Whether to include the session dependency graph in the CR status field.
+# When enabled, the dependency graph will be added to status.componentStatus.dependencyGraph
+include_dependency_graph_in_status: false
+
 # Specify a single controller to watch, else an empty string leads to watches
 # for all controllers
 controller_name: ""

oper8/config/config_validation.yaml

@@ -30,6 +30,9 @@ working_dir:
 standalone:
   type: bool
 
+include_dependency_graph_in_status:
+  type: bool
+
 strict_versioning:
   type: bool
 

oper8/reconcile.py

@@ -1087,9 +1087,12 @@ def _update_reconcile_completion_status(
         """
         status_update = {
             "component_state": completion_state,
-            "dependency_graph": str(session.graph),
         }
 
+        # Include dependency graph if configured
+        if config.library_config.include_dependency_graph_in_status:
+            status_update["dependency_graph"] = str(session.graph)
+
         # If everything completed and verified, set ready and updating to STABLE
         # and set the status's reconciled version to the desired version
         if completion_state.verify_completed():

tests/test_reconcile.py

@@ -1301,6 +1301,63 @@ def test_update_reconcile_completion_status(
     check_status(dm, cr, ready_reason, updating_reason, completion_state)
 
 
+@pytest.mark.parametrize(
+    ["include_graph", "should_include_graph"],
+    [
+        [True, True],
+        [False, False],
+    ],
+)
+def test_update_reconcile_completion_status_dependency_graph_by_config(
+    include_graph, should_include_graph
+):
+    """Test that dependency_graph is included in status based on config setting"""
+    # Local
+    from oper8.dag import Graph
+
+    # Setup CR
+    cr = setup_cr()
+
+    # Create a graph with nodes
+    graph = Graph()
+    node_a = Node("A")
+    node_b = Node("B")
+    graph.add_node(node_a)
+    graph.add_node(node_b)
+    graph.add_node_dependency(node_a, node_b)
+
+    completion_state = CompletionState(verified_nodes=[node_a, node_b])
+
+    dm = MockDeployManager(resources=[cr])
+    rm = ReconcileManager(deploy_manager=dm)
+    session = setup_session(full_cr=cr, deploy_manager=dm)
+    # Access the private __graph attribute
+    session._Session__graph = graph
+
+    # Set the config value
+    with library_config(include_dependency_graph_in_status=include_graph):
+        rm._update_reconcile_completion_status(session, completion_state)
+
+    # Check the status
+    obj = dm.get_obj(
+        kind=cr.kind,
+        name=cr.metadata.name,
+        namespace=cr.metadata.namespace,
+        api_version=cr.apiVersion,
+    )
+    assert obj is not None
+    assert obj.get("status")
+
+    component_status = obj["status"].get(status.COMPONENT_STATUS)
+    assert component_status is not None
+
+    if should_include_graph:
+        assert status.COMPONENT_STATUS_DEPENDENCY_GRAPH in component_status
+        assert component_status[status.COMPONENT_STATUS_DEPENDENCY_GRAPH] == str(graph)
+    else:
+        assert status.COMPONENT_STATUS_DEPENDENCY_GRAPH not in component_status
+
+
 ###############
 ## _update_error_status ##
 ###############