uniform parametrize, move fail message to utils

Author: Patryk Szulczewski

tests/test_diff_generator.py

@@ -2,12 +2,16 @@
 import pytest
 from netcompare.evaluator import diff_generator
 from netcompare.runner import extract_values_from_output
-from .utility import load_mocks
+from .utility import load_mocks, ASSERT_FAIL_MESSAGE
 
 
 exact_match_of_global_peers_via_napalm_getter = ("napalm_getter", "global.$peers$.*.[is_enabled,is_up]", [])
 
-exact_match_of_bgpPeerCaps_via_api = ("api", "result[0].vrfs.default.peerList[*].[$peerAddress$,state,bgpPeerCaps]", [])
+exact_match_of_bgp_peer_caps_via_api = (
+    "api",
+    "result[0].vrfs.default.peerList[*].[$peerAddress$,state,bgpPeerCaps]",
+    [],
+)
 
 exact_match_of_bgp_neigh_via_textfsm = ("textfsm", "result[*].[$bgp_neigh$,state]", [])
 
@@ -39,7 +43,7 @@
 
 eval_tests = [
     exact_match_of_global_peers_via_napalm_getter,
-    exact_match_of_bgpPeerCaps_via_api,
+    exact_match_of_bgp_peer_caps_via_api,
     exact_match_of_bgp_neigh_via_textfsm,
     raw_diff_of_interface_ma1_via_api_value_exclude,
     raw_diff_of_interface_ma1_via_api_novalue_exclude,
@@ -50,11 +54,6 @@
     exact_match_multi_nested_list,
 ]
 
-ASSERT_FAILED_MESSAGE = """Test output is different from expected output.
-output: {output}
-expected output: {expected_output}
-"""
-
 
 @pytest.mark.parametrize("folder_name, path, exclude", eval_tests)
 def test_eval(folder_name, path, exclude):
@@ -64,4 +63,4 @@ def test_eval(folder_name, path, exclude):
     post_value = extract_values_from_output(post_data, path, exclude)
     output = diff_generator(pre_value, post_value)
 
-    assert expected_output == output, ASSERT_FAILED_MESSAGE.format(output=output, expected_output=expected_output)
+    assert expected_output == output, ASSERT_FAIL_MESSAGE.format(output=output, expected_output=expected_output)

tests/test_filter_parsers.py

@@ -1,13 +1,9 @@
 "Filter parser unit tests."
 import pytest
 from netcompare.utils.filter_parsers import exclude_filter
+from .utility import ASSERT_FAIL_MESSAGE
 
 
-ASSERT_FAIL_MESSAGE = """Test output is different from expected output.
-output: {output}
-expected output: {expected_output}
-"""
-
 exclude_filter_case_1 = (
     ["interfaceStatistics"],
     {

tests/test_flatten.py

@@ -1,13 +1,9 @@
 "Flatten list unit test"
 import pytest
 from netcompare.utils.flatten import flatten_list
+from .utility import ASSERT_FAIL_MESSAGE
 
 
-ASSERT_FAIL_MESSAGE = """Test output is different from expected output.
-output: {output}
-expected output: {expected_output}
-"""
-
 flatten_list_case_1 = (
     [[[[-1, 0], [-1, 0]]]],
     [[-1, 0], [-1, 0]],

tests/test_jmspath_parsers.py

@@ -1,13 +1,9 @@
 """JMSPath parser unit tests."""
 import pytest
 from netcompare.utils.jmspath_parsers import jmspath_value_parser, jmspath_refkey_parser
+from .utility import ASSERT_FAIL_MESSAGE
 
 
-ASSERT_FAIL_MESSSAGE = """Test output is different from expected output.
-output: {output}
-expected output: {expected_output}
-"""
-
 value_parser_case_1 = (
     "result[0].vrfs.default.peerList[*].[$peerAddress$,prefixesReceived]",
     "result[0].vrfs.default.peerList[*].[peerAddress,prefixesReceived]",
@@ -61,10 +57,10 @@
 @pytest.mark.parametrize("path, expected_output", value_parser_tests)
 def test_value_parser(path, expected_output):
     output = jmspath_value_parser(path)
-    assert expected_output == output, ASSERT_FAIL_MESSSAGE.format(output=output, expected_output=expected_output)
+    assert expected_output == output, ASSERT_FAIL_MESSAGE.format(output=output, expected_output=expected_output)
 
 
 @pytest.mark.parametrize("path, expected_output", keyref_parser_tests)
 def test_keyref_parser(path, expected_output):
     output = jmspath_refkey_parser(path)
-    assert expected_output == output, ASSERT_FAIL_MESSSAGE.format(output=output, expected_output=expected_output)
+    assert expected_output == output, ASSERT_FAIL_MESSAGE.format(output=output, expected_output=expected_output)

tests/test_refkey.py

@@ -1,12 +1,7 @@
 """Reference key unit tests."""
 import pytest
 from netcompare.utils.refkey import keys_cleaner, keys_values_zipper, associate_key_of_my_value
-
-
-ASSERT_FAILED_MESSAGE = """Test output is different from expected output.
-output: {output}
-expected output: {expected_output}
-"""
+from .utility import ASSERT_FAIL_MESSAGE
 
 keys_cleaner_case_1 = (
     {"10.1.0.0": {"address_family": "ipv4"}},
@@ -41,16 +36,16 @@
 @pytest.mark.parametrize("wanted_key, expected_output", keys_cleaner_tests)
 def test_keys_cleaner(wanted_key, expected_output):
     output = keys_cleaner(wanted_key)
-    assert expected_output == output, ASSERT_FAILED_MESSAGE.format(output=output, expected_output=expected_output)
+    assert expected_output == output, ASSERT_FAIL_MESSAGE.format(output=output, expected_output=expected_output)
 
 
 @pytest.mark.parametrize("ref_keys, wanted_values, expected_output", keys_zipper_tests)
 def test_keys_zipper(ref_keys, wanted_values, expected_output):
     output = keys_values_zipper(ref_keys, wanted_values)
-    assert expected_output == output, ASSERT_FAILED_MESSAGE.format(output=output, expected_output=expected_output)
+    assert expected_output == output, ASSERT_FAIL_MESSAGE.format(output=output, expected_output=expected_output)
 
 
 @pytest.mark.parametrize("path, wanted_values, expected_output", keys_association_test)
 def test_keys_association(path, wanted_values, expected_output):
     output = associate_key_of_my_value(path, wanted_values)
-    assert expected_output == output, ASSERT_FAILED_MESSAGE.format(output=output, expected_output=expected_output)
+    assert expected_output == output, ASSERT_FAIL_MESSAGE.format(output=output, expected_output=expected_output)

tests/test_type_check.py

@@ -1,7 +1,7 @@
 "Check Type unit tests."
 import pytest
 from netcompare.check_type import CheckType, ExactMatchType, ToleranceType
-from .utility import load_mocks
+from .utility import load_mocks, ASSERT_FAIL_MESSAGE
 
 
 @pytest.mark.parametrize(
@@ -83,7 +83,9 @@ def test_check_type_results(check_type_args, folder_name, path, expected_results
     pre_value = check.extract_value_from_json_path(pre_data, path)
     post_value = check.extract_value_from_json_path(post_data, path)
     actual_results = check.evaluate(pre_value, post_value)
-    assert actual_results == expected_results
+    assert actual_results == expected_results, ASSERT_FAIL_MESSAGE.format(
+        output=actual_results, expected_output=expected_results
+    )
 
 
 napalm_bgp_neighbor_status = (
@@ -127,4 +129,6 @@ def test_checks(folder_name, check_args, path, result_index):
     post_value = check.extract_value_from_json_path(post_data, path)
     actual_results = check.evaluate(pre_value, post_value)
 
-    assert list(actual_results) == results[result_index]
+    assert list(actual_results) == results[result_index], ASSERT_FAIL_MESSAGE.format(
+        output=actual_results, expected_output=results[result_index]
+    )

tests/utility.py

@@ -7,6 +7,12 @@
 dirname = os.path.dirname(os.path.abspath(__file__))
 
 
+ASSERT_FAIL_MESSAGE = """Test output is different from expected output.
+output: {output}
+expected output: {expected_output}
+"""
+
+
 def load_json_file(folder, filename):
     """Load mock data from json file."""
     filepath = os.path.join(dirname, "mock", folder, filename)