Add diagnostics to check result

resolves datacontract#64

datacontract/engines/soda/check_soda_execute.py

@@ -20,7 +20,8 @@
 from datacontract.model.run import Run, Check, Log
 
 
-def check_soda_execute(run: Run, data_contract: DataContractSpecification, server: Server, spark: SparkSession, tmp_dir):
+def check_soda_execute(run: Run, data_contract: DataContractSpecification, server: Server, spark: SparkSession,
+    tmp_dir):
     if data_contract is None:
         run.log_warn("Cannot run engine soda-core, as data contract is invalid")
         return
@@ -107,16 +108,13 @@ def check_soda_execute(run: Run, data_contract: DataContractSpecification, serve
     for c in scan_results.get("checks"):
         check = Check(
             type="schema",
-            result="passed"
-            if c.get("outcome") == "pass"
-            else "failed"
-            if c.get("outcome") == "fail"
-            else c.get("outcome"),
+            result=to_result(c),
             reason=", ".join(c.get("outcomeReasons")),
             name=c.get("name"),
             model=c.get("table"),
             field=c.get("column"),
             engine="soda-core",
+            diagnostics=c.get("diagnostics"),
         )
         update_reason(check, c)
         run.checks.append(check)
@@ -144,6 +142,16 @@ def check_soda_execute(run: Run, data_contract: DataContractSpecification, serve
         return
 
 
+def to_result(c) -> str:
+    soda_outcome = c.get("outcome")
+    if soda_outcome == "pass":
+        return "passed"
+    elif soda_outcome == "fail":
+        return "failed"
+    else:
+        return soda_outcome
+
+
 def update_reason(check, c):
     """Try to find a reason in diagnostics"""
     if check.result == "passed":

datacontract/model/run.py

@@ -15,6 +15,7 @@ class Check(BaseModel):
     model: Optional[str] = None
     field: Optional[str] = None
     details: Optional[str] = None
+    diagnostics: Optional[dict] = None
 
 
 class Log(BaseModel):
@@ -69,7 +70,7 @@ def log_error(self, message: str):
         self.logs.append(Log(level="ERROR", message=message, timestamp=datetime.now(timezone.utc)))
 
     def pretty(self):
-        return self.model_dump_json()
+        return self.model_dump_json(indent=2)
 
     @staticmethod
     def create_run():

tests/test_test_parquet.py

@@ -23,7 +23,7 @@ def test_valid():
         # publish=True,
     )
     run = data_contract.test()
-    print(run)
+    print(run.pretty())
     assert run.result == "passed"
     assert len(run.checks) == 4
     assert all(check.result == "passed" for check in run.checks)