feat: cover governance workflow and insight APIs

Author: ayush-shah

platform-api/src/openmetadata_demo_api/catalog.py

@@ -55,6 +55,23 @@
     "createDBSchema",
     "createTable",
 }
+GOVERNANCE_INSIGHT_PREFIXES = (
+    "governance/",
+    "analytics/",
+    "datainsight/",
+    "kpi/",
+    "reports/",
+)
+GOVERNANCE_PARENT_FILES = {
+    "datainsight/DataInsightChartResource.java",
+    "datainsight/system/DataInsightSystemChartResource.java",
+    "governance/WorkflowDefinitionResource.java",
+}
+GOVERNANCE_CHILD_FILES = {
+    "governance/WorkflowInstanceResource.java",
+    "kpi/KpiResource.java",
+}
+GOVERNANCE_LEAF_FILES = {"governance/WorkflowInstanceStateResource.java"}
 CORE_SERVICE_PREREQUISITES = {
     "createApiService",
     "createDashboardService",
@@ -243,10 +260,12 @@ def _phase(operation: Mapping[str, Any]) -> str:
         term in operation_text for term in DEPENDENT_RECORD_TERMS
     ):
         return "enrichment"
-    if source_file in CORE_PARENT_FILES | TAXONOMY_PARENT_FILES:
+    if source_file in CORE_PARENT_FILES | TAXONOMY_PARENT_FILES | GOVERNANCE_PARENT_FILES:
         return "parent-assets"
-    if source_file in CORE_CHILD_FILES | TAXONOMY_CHILD_FILES:
+    if source_file in CORE_CHILD_FILES | TAXONOMY_CHILD_FILES | GOVERNANCE_CHILD_FILES:
         return "child-assets"
+    if source_file in GOVERNANCE_LEAF_FILES:
+        return "leaf-assets"
     if source_file.startswith(CORE_PREFIXES):
         return "leaf-assets"
     if source_file.startswith(ENRICHMENT_PREFIXES):
@@ -359,6 +378,16 @@ def scenarios() -> dict[str, Scenario]:
                 or operation["operation_id"] in CONTRACT_ASSET_PREREQUISITES
             ),
         ),
+        "governance-insights": scenario_from_operations(
+            "governance-insights",
+            "Governance workflows, analytics, insights, KPIs, reports, and forms",
+            tuple(
+                operation
+                for operation in all_operations
+                if str(operation["source"]["file"]).startswith(GOVERNANCE_INSIGHT_PREFIXES)
+                or operation["operation_id"] == "createDashboardService"
+            ),
+        ),
     }
 
 

platform-api/src/openmetadata_demo_api/request_fixtures.py

@@ -159,6 +159,18 @@
             "userComments": "Dry-run review",
         },
         "ReactionType": "thumbsUp",
+        "Report": {
+            "id": DEMO_ID,
+            "name": "demo-report",
+            "fullyQualifiedName": "demo.demo-report",
+            "service": {
+                "id": DEMO_ID,
+                "type": "dashboardService",
+                "name": "demo",
+                "fullyQualifiedName": "demo",
+            },
+        },
+        "ReportData": {"timestamp": 1, "reportDataType": "entityReportData"},
         "ReportDataType": "entityReportData",
         "RestoreEntity": {"id": DEMO_ID},
         "SearchIndexSampleData": {"messages": ['{"id": 1}']},
@@ -192,6 +204,7 @@
         },
         "ValidateGlossaryTagsRequest": {"dryRun": True, "glossaryTags": []},
         "VoteRequest": {"updatedVoteType": "votedUp"},
+        "WebAnalyticEventData": {"timestamp": 1, "eventType": "PageView"},
         "WebAnalyticEventType": "PageView",
     }
 )
@@ -277,6 +290,8 @@
             "metadata.generated.schema.type.recognizerFeedback",
             "RecognizerFeedback",
         ),
+        "Report": ("metadata.generated.schema.entity.data.report", "Report"),
+        "ReportData": ("metadata.generated.schema.analytics.reportData", "ReportData"),
         "RestoreEntity": (
             "metadata.generated.schema.api.data.restoreEntity",
             "RestoreEntity",
@@ -309,6 +324,10 @@
             "ValidateGlossaryTagsRequest",
         ),
         "VoteRequest": ("metadata.generated.schema.api.voteRequest", "QueryVote"),
+        "WebAnalyticEventData": (
+            "metadata.generated.schema.analytics.webAnalyticEventData",
+            "WebAnalyticEventData",
+        ),
     }
 )
 

platform-api/tests/test_runtime.py

@@ -800,3 +800,56 @@ def test_contract_policy_knowledge_requests_are_validated_and_placeholder_free()
         "CreateLearningResourceRequest",
         "CreateDocumentRequest",
     } <= models
+
+
+def test_governance_insight_scenario_covers_source_routes_and_dependencies() -> None:
+    prefixes = ("governance/", "analytics/", "datainsight/", "kpi/", "reports/")
+    expected = {
+        operation["operation_id"]
+        for operation in load_operations()
+        if str(operation["source"]["file"]).startswith(prefixes)
+    }
+    scenario = scenarios()["governance-insights"]
+
+    assert {step.operation_id for step in scenario.operation_steps} == expected | {
+        "createDashboardService"
+    }
+    assert len(scenario.run()) == len(expected) + 1
+    assert {
+        "createWebAnalyticEventType",
+        "addReportData",
+        "createDataInsightChart",
+        "createIntakeForm",
+        "createWorkflowDefinition",
+        "createKpi",
+        "createOrUpdateReport",
+    } <= expected
+    ordered = [step.operation_id for step in scenario.ordered_steps()]
+    assert ordered.index("createWorkflowDefinition") < ordered.index("listWorkflowInstances")
+    assert ordered.index("listWorkflowInstances") < ordered.index("listWorkflowInstanceStates")
+    assert ordered.index("createDataInsightChart") < ordered.index("createKpi")
+    assert ordered.index("createDashboardService") < ordered.index("createOrUpdateReport")
+
+
+def test_governance_insight_requests_are_validated_and_placeholder_free() -> None:
+    scenario = scenarios()["governance-insights"]
+
+    assert not {
+        str(value["_model"])
+        for step in scenario.operation_steps
+        for value in _nested_mappings(step.request)
+        if "_model" in value
+    }
+    models = {
+        str(asset["model"]).rsplit(".", 1)[-1]
+        for asset in load_assets()
+        if "governance-insights" in asset["scenarios"]
+    }
+    assert {
+        "CreateWebAnalyticEvent",
+        "CreateDataInsightChart",
+        "CreateKpiRequest",
+        "CreateIntakeFormRequest",
+        "CreateWorkflowDefinitionRequest",
+        "CreateWorkflowInstanceStateRequest",
+    } <= models