Merge pull request #246 from yuki462-b/session-graph-status

feat: add session dependency status.

Author: gabe-l-hart

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

@@ -1085,7 +1085,13 @@ def _update_reconcile_completion_status(
             completion_state: CompletionState
                 The result of the rollout
         """
-        status_update = {"component_state": completion_state}
+        status_update = {
+            "component_state": completion_state,
+        }
+
+        # 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

oper8/status.py

@@ -57,6 +57,7 @@
 COMPONENT_STATUS_FAILED_NODES = "failedComponents"
 COMPONENT_STATUS_DEPLOYED_COUNT = "deployed"
 COMPONENT_STATUS_VERIFIED_COUNT = "verified"
+COMPONENT_STATUS_DEPENDENCY_GRAPH = "dependencyGraph"
 
 # The fields in status that hold the version information
 # NOTE: These intentionally match IBM CloudPak naming conventions
@@ -134,6 +135,7 @@ def make_application_status(  # pylint: disable=too-many-arguments,too-many-loca
     supported_versions: Optional[List[str]] = None,
     operator_version: Optional[str] = None,
     kind: Optional[str] = None,
+    dependency_graph: Optional[str] = None,
 ) -> dict:
     """Create a full status object for an application
 
@@ -163,6 +165,8 @@ def make_application_status(  # pylint: disable=too-many-arguments,too-many-loca
             The kind of reconciling CR. If specified, this function adds
             service status field which is compliant with IBM Cloud Pak
             requirements.
+        dependency_graph: Optional[str]
+            String representation of the session dependency graph
 
     Returns:
         current_status:  dict
@@ -184,7 +188,9 @@ def make_application_status(  # pylint: disable=too-many-arguments,too-many-loca
     # track which components have deployed and verified
     if component_state is not None:
         log.debug2("Adding component state to status")
-        status[COMPONENT_STATUS] = _make_component_state(component_state)
+        status[COMPONENT_STATUS] = _make_component_state(
+            component_state, dependency_graph
+        )
         log.debug3(status[COMPONENT_STATUS])
 
     # Create the versions section
@@ -491,7 +497,9 @@ def _make_updating_condition(
     )
 
 
-def _make_component_state(component_state: CompletionState) -> dict:
+def _make_component_state(
+    component_state: CompletionState, dependency_graph: Optional[str] = None
+) -> dict:
     """Make the component state object"""
     all_nodes = sorted([comp.get_name() for comp in component_state.all_nodes])
     deployed_nodes = sorted(
@@ -509,7 +517,7 @@ def _make_component_state(component_state: CompletionState) -> dict:
         [comp.get_name() for comp in component_state.unverified_nodes]
     )
     failed_nodes = sorted([comp.get_name() for comp in component_state.failed_nodes])
-    return {
+    result = {
         COMPONENT_STATUS_ALL_NODES: all_nodes,
         COMPONENT_STATUS_DEPLOYED_NODES: deployed_nodes,
         COMPONENT_STATUS_UNVERIFIED_NODES: unverified_nodes,
@@ -518,6 +526,12 @@ def _make_component_state(component_state: CompletionState) -> dict:
         COMPONENT_STATUS_VERIFIED_COUNT: f"{len(verified_nodes)}/{len(all_nodes)}",
     }
 
+    # Add dependency graph if provided
+    if dependency_graph is not None:
+        result[COMPONENT_STATUS_DEPENDENCY_GRAPH] = dependency_graph
+
+    return result
+
 
 def _make_available_version(version: str) -> dict:
     """Make an object for the available version list following the IBM CloudPak

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 ##
 ###############

tests/test_status.py

@@ -141,6 +141,39 @@ def test_make_application_status_component_state():
     }
 
 
+def test_make_application_status_component_state_with_dependency_graph():
+    """Make sure that dependency_graph is included in component status when provided"""
+    # Local
+    from oper8.dag import Graph
+
+    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)
+    graph_str = str(graph)
+
+    res = status.make_application_status(
+        component_state=CompletionState(
+            verified_nodes=[node_a, node_b],
+        ),
+        dependency_graph=graph_str,
+    )
+    assert res == {
+        "conditions": [],
+        status.COMPONENT_STATUS: {
+            status.COMPONENT_STATUS_ALL_NODES: ["A", "B"],
+            status.COMPONENT_STATUS_DEPLOYED_NODES: ["A", "B"],
+            status.COMPONENT_STATUS_UNVERIFIED_NODES: [],
+            status.COMPONENT_STATUS_FAILED_NODES: [],
+            status.COMPONENT_STATUS_DEPLOYED_COUNT: "2/2",
+            status.COMPONENT_STATUS_VERIFIED_COUNT: "2/2",
+            status.COMPONENT_STATUS_DEPENDENCY_GRAPH: graph_str,
+        },
+    }
+
+
 def test_make_application_status_supported_versions():
     """Make sure that setting supported versions in status creates the correct
     status.versions entries