fix: stringfy all values in Result.data (#391)

takishida · web-flow · commit faa00aa652b1 · 2026-05-29T17:28:28.000-07:00
diff --git a/aci-preupgrade-validation-script.py b/aci-preupgrade-validation-script.py
@@ -1333,13 +1333,26 @@ class Result:
     """Class to hold the result of a check."""
     __slots__ = ("result", "msg", "headers", "data", "unformatted_headers", "unformatted_data", "recommended_action", "doc_url")
 
+    @staticmethod
+    def _stringify_table_rows(rows):
+        """Convert every table cell value to string for stable sorting/printing."""
+        if rows is None:
+            return []
+        normalized = []
+        for row in rows:
+            if isinstance(row, (list, tuple)):
+                normalized.append([str(col) for col in row])
+            else:
+                normalized.append([str(row)])
+        return normalized
+
     def __init__(self, result=PASS, msg="", headers=None, data=None, unformatted_headers=None, unformatted_data=None, recommended_action="", doc_url=""):
         self.result = result
         self.msg = msg
         self.headers = headers if headers is not None else []
-        self.data = data if data is not None else []
+        self.data = self._stringify_table_rows(data)
         self.unformatted_headers = unformatted_headers if unformatted_headers is not None else []
-        self.unformatted_data = unformatted_data if unformatted_data is not None else []
+        self.unformatted_data = self._stringify_table_rows(unformatted_data)
         self.recommended_action = recommended_action
         self.doc_url = doc_url
 
diff --git a/tests/checks/n9k_c9408_model_lem_count_check/test_n9k_c9408_model_lem_count_check.py b/tests/checks/n9k_c9408_model_lem_count_check/test_n9k_c9408_model_lem_count_check.py
@@ -71,7 +71,7 @@
             "6.2(1g)",
             read_data(dir, "fabricNode_n9k_c9408.json"),
             script.FAIL_O,
-            [["101", "N9K-C9408", "N9K-X9400-16W", 6]],
+            [["101", "N9K-C9408", "N9K-X9400-16W", "6"]],
             "",
         ),
         # Applicable mid-train version 6.1(5e), less than 6 LEMs on C9408 -> PASS
@@ -89,7 +89,7 @@
             "6.1(5e)",
             read_data(dir, "fabricNode_n9k_c9408.json"),
             script.FAIL_O,
-            [["101", "N9K-C9408", "N9K-X9400-16W", 6]],
+            [["101", "N9K-C9408", "N9K-X9400-16W", "6"]],
             "",
         ),
         # Version not affected (fixed in 6.1(6)+)
@@ -107,7 +107,7 @@
             "6.1(2f)",
             read_data(dir, "fabricNode_n9k_c9408.json"),
             script.FAIL_O,
-            [["101", "N9K-C9408", "N9K-X9400-16W", 6]],
+            [["101", "N9K-C9408", "N9K-X9400-16W", "6"]],
             "",
         ),
         # Count only C9408 nodes and only matching LEM model
@@ -117,8 +117,8 @@
             read_data(dir, "fabricNode_mixed.json"),
             script.FAIL_O,
             [
-                ["101", "N9K-C9408", "N9K-X9400-16W", 6],
-                ["102", "N9K-C9408", "N9K-X9400-16W", 6],
+                ["101", "N9K-C9408", "N9K-X9400-16W", "6"],
+                ["102", "N9K-C9408", "N9K-X9400-16W", "6"],
             ],
             "",
         ),
diff --git a/tests/checks/r_leaf_compatibility_check/test_r_leaf_compatibility_check.py b/tests/checks/r_leaf_compatibility_check/test_r_leaf_compatibility_check.py
@@ -53,7 +53,7 @@
             "4.1(2a)",
             "4.2(2a)",
             script.FAIL_O,
-            [["4.2(2a)", "Present", True]],
+            [["4.2(2a)", "Present", "True"]],
         ),
         # PASS - bug version upgrade, no RL
         (
@@ -80,7 +80,7 @@
             "4.2(3a)",
             "5.2(3a)",
             script.FAIL_O,
-            [["5.2(3a)", "Present", False]],
+            [["5.2(3a)", "Present", "False"]],
         ),
         # PASS - Fix ver to 5.x, no RL
         (
diff --git a/tests/checks/rogue_ep_coop_exception_mac_check/test_rogue_ep_coop_exception_mac_check.py b/tests/checks/rogue_ep_coop_exception_mac_check/test_rogue_ep_coop_exception_mac_check.py
@@ -66,14 +66,14 @@
             "6.0(3e)",
             "5.2(3e)",
             script.FAIL_O,
-            [[5, "N/A"]],
+            [["5", "N/A"]],
         ),
         (
             {exception_mac_api: read_data(dir, "rogue_mac_response.json")},
             "6.1(3g)",
             "5.2(3e)",
             script.FAIL_O,
-            [[5, "N/A"]],
+            [["5", "N/A"]],
         ),
         # Affected (post-APIC upgrade, pre-switch upgrade) cases
         # tversion == cversion (affected target), no exception MACs
@@ -121,7 +121,7 @@
             "6.0(3e)",
             "6.0(3e)",
             script.FAIL_O,
-            [[5, "only 31 found out of 32"]],
+            [["5", "only 31 found out of 32"]],
         ),
         (
             {
@@ -131,7 +131,7 @@
             "6.1(3g)",
             "6.1(3g)",
             script.FAIL_O,
-            [[5, "only 31 found out of 32"]],
+            [["5", "only 31 found out of 32"]],
         ),
         (
             {
@@ -141,7 +141,7 @@
             "6.0(3e)",
             "6.0(3e)",
             script.FAIL_O,
-            [[5, "only 27 found out of 32"]],
+            [["5", "only 27 found out of 32"]],
         ),
         (
             {
@@ -151,7 +151,7 @@
             "6.1(3g)",
             "6.1(3g)",
             script.FAIL_O,
-            [[5, "only 27 found out of 32"]],
+            [["5", "only 27 found out of 32"]],
         ),
         (
             {
@@ -161,7 +161,7 @@
             "6.0(3e)",
             "6.0(3e)",
             script.FAIL_O,
-            [[5, "only 1 found out of 32"]],
+            [["5", "only 1 found out of 32"]],
         ),
         (
             {
@@ -171,7 +171,7 @@
             "6.1(3g)",
             "6.1(3g)",
             script.FAIL_O,
-            [[5, "only 1 found out of 32"]],
+            [["5", "only 1 found out of 32"]],
         ),
         (
             {
@@ -181,7 +181,7 @@
             "6.0(3e)",
             "6.0(3e)",
             script.FAIL_O,
-            [[5, "only 0 found out of 32"]],
+            [["5", "only 0 found out of 32"]],
         ),
         (
             {
@@ -191,7 +191,7 @@
             "6.1(3g)",
             "6.1(3g)",
             script.FAIL_O,
-            [[5, "only 0 found out of 32"]],
+            [["5", "only 0 found out of 32"]],
         ),
     ],
 )
diff --git a/tests/test_Result.py b/tests/test_Result.py
@@ -0,0 +1,28 @@
+import importlib
+
+script = importlib.import_module("aci-preupgrade-validation-script")
+
+
+def test_print_result_handles_mixed_type_rows_without_error():
+    # Verify that Result stringifies all cell values, so data.sort() in print_result never fails.
+    r = script.Result(
+        result=script.FAIL_O,
+        headers=["col1"],
+        data=[[1], ["2"]],
+        unformatted_headers=["col1"],
+        unformatted_data=[[3], ["4"]],
+    )
+    # All values must already be strings after construction.
+    assert r.data == [["1"], ["2"]]
+    assert r.unformatted_data == [["3"], ["4"]]
+    # print_result must not raise.
+    script.print_result(
+        index=1,
+        total=1,
+        title="Mixed type table",
+        result=script.FAIL_O,
+        headers=r.headers,
+        data=r.data,
+        unformatted_headers=r.unformatted_headers,
+        unformatted_data=r.unformatted_data,
+    )

Original file line number	Diff line number	Diff line change
`@@ -66,14 +66,14 @@`
`66`	`66`	`"6.0(3e)",`
`67`	`67`	`"5.2(3e)",`
`68`	`68`	`script.FAIL_O,`
`69`		`- [[5, "N/A"]],`
	`69`	`+ [["5", "N/A"]],`
`70`	`70`	`),`
`71`	`71`	`(`
`72`	`72`	`{exception_mac_api: read_data(dir, "rogue_mac_response.json")},`
`73`	`73`	`"6.1(3g)",`
`74`	`74`	`"5.2(3e)",`
`75`	`75`	`script.FAIL_O,`
`76`		`- [[5, "N/A"]],`
	`76`	`+ [["5", "N/A"]],`
`77`	`77`	`),`
`78`	`78`	`# Affected (post-APIC upgrade, pre-switch upgrade) cases`
`79`	`79`	`# tversion == cversion (affected target), no exception MACs`
`@@ -121,7 +121,7 @@`
`121`	`121`	`"6.0(3e)",`
`122`	`122`	`"6.0(3e)",`
`123`	`123`	`script.FAIL_O,`
`124`		`- [[5, "only 31 found out of 32"]],`
	`124`	`+ [["5", "only 31 found out of 32"]],`
`125`	`125`	`),`
`126`	`126`	`(`
`127`	`127`	`{`
`@@ -131,7 +131,7 @@`
`131`	`131`	`"6.1(3g)",`
`132`	`132`	`"6.1(3g)",`
`133`	`133`	`script.FAIL_O,`
`134`		`- [[5, "only 31 found out of 32"]],`
	`134`	`+ [["5", "only 31 found out of 32"]],`
`135`	`135`	`),`
`136`	`136`	`(`
`137`	`137`	`{`
`@@ -141,7 +141,7 @@`
`141`	`141`	`"6.0(3e)",`
`142`	`142`	`"6.0(3e)",`
`143`	`143`	`script.FAIL_O,`
`144`		`- [[5, "only 27 found out of 32"]],`
	`144`	`+ [["5", "only 27 found out of 32"]],`
`145`	`145`	`),`
`146`	`146`	`(`
`147`	`147`	`{`
`@@ -151,7 +151,7 @@`
`151`	`151`	`"6.1(3g)",`
`152`	`152`	`"6.1(3g)",`
`153`	`153`	`script.FAIL_O,`
`154`		`- [[5, "only 27 found out of 32"]],`
	`154`	`+ [["5", "only 27 found out of 32"]],`
`155`	`155`	`),`
`156`	`156`	`(`
`157`	`157`	`{`
`@@ -161,7 +161,7 @@`
`161`	`161`	`"6.0(3e)",`
`162`	`162`	`"6.0(3e)",`
`163`	`163`	`script.FAIL_O,`
`164`		`- [[5, "only 1 found out of 32"]],`
	`164`	`+ [["5", "only 1 found out of 32"]],`
`165`	`165`	`),`
`166`	`166`	`(`
`167`	`167`	`{`
`@@ -171,7 +171,7 @@`
`171`	`171`	`"6.1(3g)",`
`172`	`172`	`"6.1(3g)",`
`173`	`173`	`script.FAIL_O,`
`174`		`- [[5, "only 1 found out of 32"]],`
	`174`	`+ [["5", "only 1 found out of 32"]],`
`175`	`175`	`),`
`176`	`176`	`(`
`177`	`177`	`{`
`@@ -181,7 +181,7 @@`
`181`	`181`	`"6.0(3e)",`
`182`	`182`	`"6.0(3e)",`
`183`	`183`	`script.FAIL_O,`
`184`		`- [[5, "only 0 found out of 32"]],`
	`184`	`+ [["5", "only 0 found out of 32"]],`
`185`	`185`	`),`
`186`	`186`	`(`
`187`	`187`	`{`
`@@ -191,7 +191,7 @@`
`191`	`191`	`"6.1(3g)",`
`192`	`192`	`"6.1(3g)",`
`193`	`193`	`script.FAIL_O,`
`194`		`- [[5, "only 0 found out of 32"]],`
	`194`	`+ [["5", "only 0 found out of 32"]],`
`195`	`195`	`),`
`196`	`196`	`],`
`197`	`197`	`)`