rename synth class to AciResult + breakdown --puv into --api-only and --no-cleanup

Author: monrog2

tests/test_AciResult.py

@@ -0,0 +1,207 @@
+import pytest
+import importlib
+import json
+
+script = importlib.import_module("aci-preupgrade-validation-script")
+
+
+@pytest.mark.parametrize(
+    "func_name, name, description, result, recommended_action, reason, doc_url, column, row, unformatted_column, unformatted_rows, expected_show, expected_criticality, expected_passed",
+    [
+        # Check 1: NA
+        (
+            "fake_func_name_NA_test",
+            "NA",
+            "",
+            script.NA,
+            "",
+            "",
+            "",
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            False,
+            "informational",
+            "passed"
+        ),
+        # Check 2: PASS
+        (
+            "fake_func_name_PASS_test",
+            "PASS",
+            "",
+            script.PASS,
+            "",
+            "",
+            "",
+            [],
+            [],
+            [],
+            [],
+            True,
+            "informational",
+            "passed"
+        ),
+        # Check 3: POST
+        (
+            "fake_func_name_POST_test",
+            "POST",
+            "",
+            script.POST,
+            "reboot",
+            "test reason",
+            "https://test_doc_url.html",
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            False,
+            "informational",
+            "failed"
+        ),
+        # Check 4: MANUAL
+        (
+            "fake_func_name_MANUAL_test",
+            "MANUAL",
+            "",
+            script.MANUAL,
+            "reboot",
+            "test reason",
+            "https://test_doc_url.html",
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            True,
+            "warning",
+            "failed"
+        ),
+        # Check 5: ERROR
+        (
+            "fake_func_name_ERROR_test",
+            "ERROR",
+            "",
+            script.ERROR,
+            "reboot",
+            "test reason",
+            "https://test_doc_url.html",
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            True,
+            "major",
+            "failed"
+        ),
+        # Check 6: FAIL_UF
+        (
+            "fake_func_name_FAIL_UF_test",
+            "FAIL_UF",
+            "",
+            script.FAIL_UF,
+            "reboot",
+            "test reason",
+            "https://test_doc_url.html",
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            ["col1", "col2"],
+            [["row1", "row2"], ["row3", "row4"]],
+            True,
+            "critical",
+            "failed"
+        ),
+        # Check 7: FAIL_O
+        (
+            "fake_func_name_FAIL_O_test",
+            "FAIL_O",
+            "",
+            script.FAIL_O,
+            "reboot",
+            "test reason",
+            "https://test_doc_url.html",
+            ["col1", "col2", "col3"],
+            [["row1", "row2", "row3"], ["row4", "row5", "row6"]],
+            ["col4", "col5"],
+            [["row1", "row2"], ["row3", "row4"]],
+            True,
+            "critical",
+            "failed"
+        ),
+        # Check 8: FAIL_O Formatted only
+        (
+            "fake_func_name_FAIL_O_formatted_only_test",
+            "FAIL_O Formatted only",
+            "",
+            script.FAIL_O,
+            "reboot",
+            "test reason",
+            "https://test_doc_url.html",
+            ["col1", "col2", "col3"],
+            [["row1", "row2", "row3"], ["row4", "row5", "row6"]],
+            [],
+            [],
+            True,
+            "critical",
+            "failed"
+        ),
+        # Check 9: FAIL_O
+        (
+            "fake_func_name_FAIL_O_unformatted_only_test",
+            "FAIL_O Unformatted only",
+            "",
+            script.FAIL_O,
+            "reboot",
+            "test reason",
+            "https://test_doc_url.html",
+            [],
+            [],
+            ["col1", "col2", "col3"],
+            [["row1", "row2", "row3"], ["row4", "row5", "row6"]],
+            True,
+            "critical",
+            "failed"
+        ),
+    ],
+)
+def test_AciResult(
+    func_name,
+    name,
+    description,
+    result,
+    recommended_action,
+    reason,
+    doc_url,
+    column,
+    row,
+    unformatted_column,
+    unformatted_rows,
+    expected_show,
+    expected_criticality,
+    expected_passed,
+):
+    synth = script.AciResult(func_name, name, description)
+    synth.updateWithResults(result, recommended_action, reason, doc_url, column, row, unformatted_column, unformatted_rows)
+    file = synth.writeResult()
+    with open(file, "r") as f:
+        data = json.load(f)
+    assert data["ruleId"] == func_name
+    assert data["showValidation"] == expected_show
+    assert data["severity"] == expected_criticality
+    assert data["ruleStatus"] == expected_passed
+
+
+@pytest.mark.parametrize(
+    "headers, data",
+    [
+        ("", []),  # invalid headers (columns)
+        ([], {}),  # invalid data (rows)
+        ("", {}),  # invalid headers and data
+    ]
+)
+def test_invalid_headers_or_data(headers, data):
+    with pytest.raises(TypeError):
+        synth = script.AciResult("func_name", "Check Title", "A Description")
+        synth.craftData(
+            column=headers,
+            rows=data,
+        )

tests/test_parse_args.py

@@ -14,23 +14,24 @@ def test_no_args():
     # To simulate the script being run without any command-line arguments,
     # we set `sys.argv[1:]` to an empty list when `args` is `None`.
     sys.argv[1:] = []
-    is_puv, tversion, cversion, debug_function = script.parse_args(args=None)
-    assert is_puv is False
+    api_only, tversion, cversion, debug_function, no_cleanup = script.parse_args(args=None)
+    assert api_only is False
     assert tversion is None
     assert cversion is None
     assert debug_function is None
+    assert no_cleanup is False
 
 
 @pytest.mark.parametrize(
     "args, expected_result",
     [
         ([], False),
-        (["--puv"], True),
+        (["--api-only"], True),
     ],
 )
-def test_puv(args, expected_result):
-    is_puv, tversion, cversion, debug_function = script.parse_args(args)
-    assert is_puv == expected_result
+def test_api_only(args, expected_result):
+    api_only, tversion, cversion, debug_function, no_cleanup = script.parse_args(args)
+    assert api_only == expected_result
 
 
 @pytest.mark.parametrize(
@@ -45,7 +46,7 @@ def test_puv(args, expected_result):
     ],
 )
 def test_tversion(args, expected_result):
-    is_puv, tversion, cversion, debug_function = script.parse_args(args)
+    api_only, tversion, cversion, debug_function, no_cleanup = script.parse_args(args)
     if tversion is not None:
         assert isinstance(tversion, str)
     assert str(tversion) == str(expected_result)
@@ -63,7 +64,7 @@ def test_tversion(args, expected_result):
     ],
 )
 def test_cversion(args, expected_result):
-    is_puv, tversion, cversion, debug_function = script.parse_args(args)
+    api_only, tversion, cversion, debug_function, no_cleanup = script.parse_args(args)
     if cversion is not None:
         assert isinstance(cversion, str)
     assert str(cversion) == str(expected_result)
@@ -78,7 +79,7 @@ def test_cversion(args, expected_result):
     ],
 )
 def test_debug_func(args, expected_result):
-    is_puv, tversion, cversion, debug_function = script.parse_args(args)
+    api_only, tversion, cversion, debug_function, no_cleanup = script.parse_args(args)
     if debug_function is not None:
         assert isinstance(debug_function, str)
     assert str(debug_function) == str(expected_result)

tests/test_prepare.py

@@ -62,7 +62,7 @@ def _mock_get_target_version(arg_tversion):
 
 
 @pytest.mark.parametrize(
-    "icurl_outputs, is_puv, arg_tversion, arg_cversion, debug_function, expected_result",
+    "icurl_outputs, api_only, arg_tversion, arg_cversion, debug_function, expected_result",
     [
         # Default, no argparse arguments
         (
@@ -77,7 +77,7 @@ def _mock_get_target_version(arg_tversion):
             None,
             {"username": "admin", "password": "mypassword", "cversion": AciVersion("6.1(1a)"), "tversion": AciVersion("6.2(1a)"), "sw_cversion": AciVersion("6.0(9d)"), "vpc_node_ids": ["101", "102"]},
         ),
-        # `is_puv` is True (i.e. --puv)
+        # `api_only` is True (i.e. --puv)
         # No `get_credentials()`, no username nor password
         (
             {
@@ -163,9 +163,9 @@ def _mock_get_target_version(arg_tversion):
         ),
     ],
 )
-def test_prepare(mock_icurl, is_puv, arg_tversion, arg_cversion, debug_function, expected_result):
-    checks = script.get_checks(is_puv, debug_function)
-    inputs = script.prepare(is_puv, arg_tversion, arg_cversion, len(checks))
+def test_prepare(mock_icurl, api_only, arg_tversion, arg_cversion, debug_function, expected_result):
+    checks = script.get_checks(api_only, debug_function)
+    inputs = script.prepare(api_only, arg_tversion, arg_cversion, len(checks))
     for key, value in expected_result.items():
         if "version" in key:
             assert isinstance(inputs[key], AciVersion)
@@ -182,7 +182,7 @@ def test_prepare(mock_icurl, is_puv, arg_tversion, arg_cversion, debug_function,
         assert meta["cversion"] == str(expected_result["cversion"])
         assert meta["tversion"] == str(expected_result["tversion"])
         assert meta["sw_cversion"] == str(expected_result["sw_cversion"])
-        assert meta["is_puv"] == is_puv
+        assert meta["api_only"] == api_only
         assert meta["total_checks"] == len(checks)
         if debug_function:
             assert meta["total_checks"] == 1
@@ -201,7 +201,7 @@ def test_cversion_invald():
 
 
 @pytest.mark.parametrize(
-    "icurl_outputs, is_puv, arg_tversion, arg_cversion, debug_function, expected_result",
+    "icurl_outputs, api_only, arg_tversion, arg_cversion, debug_function, expected_result",
     [
         # `get_cversion()` failure
         (
@@ -259,12 +259,12 @@ def test_cversion_invald():
         ),
     ],
 )
-def test_prepare_exception(capsys, caplog, mock_icurl, is_puv, arg_tversion, arg_cversion, debug_function, expected_result):
+def test_prepare_exception(capsys, caplog, mock_icurl, api_only, arg_tversion, arg_cversion, debug_function, expected_result):
     caplog.set_level(logging.CRITICAL)
     with pytest.raises(SystemExit):
         with pytest.raises(Exception):
-            checks = script.get_checks(is_puv, debug_function)
-            script.prepare(is_puv, arg_tversion, arg_cversion, len(checks))
+            checks = script.get_checks(api_only, debug_function)
+            script.prepare(api_only, arg_tversion, arg_cversion, len(checks))
     captured = capsys.readouterr()
     print(captured.out)
     assert captured.out.endswith(expected_result)

tests/test_run_checks.py

@@ -6,7 +6,7 @@
 script = importlib.import_module("aci-preupgrade-validation-script")
 AciVersion = script.AciVersion
 JSON_DIR = script.JSON_DIR
-ApicResult = script.syntheticMaintPValidate
+ApicResult = script.AciResult
 Result = script.Result
 check_wrapper = script.check_wrapper