fix: Add default reason(msg) for AciResult for failed checks (#290)

* fix: Always populate msg/reason when a rule did not pass
* fix: add header to failureDetails

Author: takishida

aci-preupgrade-validation-script.py

@@ -918,11 +918,11 @@ def is_firstver_gt_secondver(first_ver, second_ver):
 
 class AciResult:
     """
-    APIC uses an object called `AciResult` to store the results of
-    each rule/check in the pre-upgrade validation which is run during the upgrade
+    APIC uses an object called `syntheticMaintPValidate` to store the results of
+    each rule/check in the pre-upgrade validation which runs during the upgrade
     workflow in the APIC GUI. When this script is invoked during the workflow, it
     is expected to write the results of each rule/check to a JSON file (one per rule)
-    in a specific format.
+    in a specific format compliant with `syntheticMaintPValidate`.
     """
     # Expected keys in the JSON file
     __slots__ = (
@@ -992,7 +992,10 @@ def updateWithResults(self, result, recommended_action, msg, doc_url, headers, d
         self.ruleStatus = AciResult.PASS
         if result not in [NA, PASS]:
             self.ruleStatus = AciResult.FAIL
+            if not self.reason:
+                self.reason = "See Failure Details"
             self.failureDetails["failType"] = result
+            self.failureDetails["header"] = headers
             self.failureDetails["data"] = self.craftData(headers, data)
             if unformatted_headers and unformatted_data:
                 self.failureDetails["unformatted_data"] = self.craftData(unformatted_headers, unformatted_data)

tests/test_run_checks.py

@@ -158,12 +158,15 @@ def test_run_checks(capsys, caplog):
                 # reason
                 if result == script.ERROR:
                     assert data["reason"].endswith(err_msg)
-                elif others.get("unformatted_data"):
-                    assert data["reason"] == others.get("msg", "") + (
-                        "\n"
-                        "Parse failure occurred, the provided data may not be complete. "
-                        "Please contact Cisco TAC to identify the missing data."
-                    )
+                elif result not in [script.PASS, script.NA]:
+                    msg = others.get("msg", "See Failure Details")
+                    if others.get("unformatted_data"):
+                        msg += (
+                            "\n"
+                            "Parse failure occurred, the provided data may not be complete. "
+                            "Please contact Cisco TAC to identify the missing data."
+                        )
+                    assert data["reason"] == msg
                 else:
                     assert data["reason"] == others.get("msg", "")
                 # failureDetails.failType