Stop using assertEqual use assert instead (#389)

asherf · web-flow · commit 1b5cf4292d48 · 2023-04-28T13:37:42.000-04:00
diff --git a/django_prometheus/tests/end2end/testapp/test_db.py b/django_prometheus/tests/end2end/testapp/test_db.py
@@ -6,6 +6,7 @@
 from django_prometheus.testutils import (
     PrometheusTestCaseMixin,
     assert_metric_compare,
+    assert_metric_diff,
     get_metric,
     save_registry,
 )
@@ -86,7 +87,7 @@ def test_execute_many(self):
             "INSERT INTO testapp_lawn(location) VALUES (?)",
             [("Paris",), ("New York",), ("Berlin",), ("San Francisco",)],
         )
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             4,
             "django_db_execute_many_total",
diff --git a/django_prometheus/tests/end2end/testapp/test_middleware.py b/django_prometheus/tests/end2end/testapp/test_middleware.py
@@ -1,7 +1,11 @@
 from django.test import SimpleTestCase, override_settings
 from testapp.views import ObjectionException
 
-from django_prometheus.testutils import PrometheusTestCaseMixin, save_registry
+from django_prometheus.testutils import (
+    PrometheusTestCaseMixin,
+    assert_metric_diff,
+    save_registry,
+)
 
 
 def M(metric_name):
@@ -36,28 +40,28 @@ def test_request_counters(self):
         self.client.get("/help")
         self.client.post("/", {"test": "data"})
 
-        self.assertMetricDiff(registry, 4, M("requests_before_middlewares_total"))
-        self.assertMetricDiff(registry, 4, M("responses_before_middlewares_total"))
-        self.assertMetricDiff(registry, 3, T("requests_total_by_method"), method="GET")
-        self.assertMetricDiff(registry, 1, T("requests_total_by_method"), method="POST")
-        self.assertMetricDiff(registry, 4, T("requests_total_by_transport"), transport="http")
-        self.assertMetricDiff(
+        assert_metric_diff(registry, 4, M("requests_before_middlewares_total"))
+        assert_metric_diff(registry, 4, M("responses_before_middlewares_total"))
+        assert_metric_diff(registry, 3, T("requests_total_by_method"), method="GET")
+        assert_metric_diff(registry, 1, T("requests_total_by_method"), method="POST")
+        assert_metric_diff(registry, 4, T("requests_total_by_transport"), transport="http")
+        assert_metric_diff(
             registry,
             2,
             T("requests_total_by_view_transport_method"),
             view="testapp.views.index",
             transport="http",
             method="GET",
         )
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             1,
             T("requests_total_by_view_transport_method"),
             view="testapp.views.help",
             transport="http",
             method="GET",
         )
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             1,
             T("requests_total_by_view_transport_method"),
@@ -68,16 +72,16 @@ def test_request_counters(self):
         # We have 3 requests with no post body, and one with a few
         # bytes, but buckets are cumulative so that is 4 requests with
         # <=128 bytes bodies.
-        self.assertMetricDiff(registry, 3, M("requests_body_total_bytes_bucket"), le="0.0")
-        self.assertMetricDiff(registry, 4, M("requests_body_total_bytes_bucket"), le="128.0")
+        assert_metric_diff(registry, 3, M("requests_body_total_bytes_bucket"), le="0.0")
+        assert_metric_diff(registry, 4, M("requests_body_total_bytes_bucket"), le="128.0")
         self.assertMetricEquals(None, M("responses_total_by_templatename"), templatename="help.html")
-        self.assertMetricDiff(registry, 3, T("responses_total_by_templatename"), templatename="index.html")
-        self.assertMetricDiff(registry, 4, T("responses_total_by_status"), status="200")
-        self.assertMetricDiff(registry, 0, M("responses_body_total_bytes_bucket"), le="0.0")
-        self.assertMetricDiff(registry, 3, M("responses_body_total_bytes_bucket"), le="128.0")
-        self.assertMetricDiff(registry, 4, M("responses_body_total_bytes_bucket"), le="8192.0")
-        self.assertMetricDiff(registry, 4, T("responses_total_by_charset"), charset="utf-8")
-        self.assertMetricDiff(registry, 0, M("responses_streaming_total"))
+        assert_metric_diff(registry, 3, T("responses_total_by_templatename"), templatename="index.html")
+        assert_metric_diff(registry, 4, T("responses_total_by_status"), status="200")
+        assert_metric_diff(registry, 0, M("responses_body_total_bytes_bucket"), le="0.0")
+        assert_metric_diff(registry, 3, M("responses_body_total_bytes_bucket"), le="128.0")
+        assert_metric_diff(registry, 4, M("responses_body_total_bytes_bucket"), le="8192.0")
+        assert_metric_diff(registry, 4, T("responses_total_by_charset"), charset="utf-8")
+        assert_metric_diff(registry, 0, M("responses_streaming_total"))
 
     def test_latency_histograms(self):
         # Caution: this test is timing-based. This is not ideal. It
@@ -90,15 +94,15 @@ def test_latency_histograms(self):
         # This always takes more than .1 second, so checking the lower
         # buckets is fine.
         self.client.get("/slow")
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             0,
             M("requests_latency_seconds_by_view_method_bucket"),
             le="0.05",
             view="slow",
             method="GET",
         )
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             1,
             M("requests_latency_seconds_by_view_method_bucket"),
@@ -114,7 +118,7 @@ def test_exception_latency_histograms(self):
             self.client.get("/objection")
         except ObjectionException:
             pass
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             2,
             M("requests_latency_seconds_by_view_method_bucket"),
@@ -127,5 +131,5 @@ def test_streaming_responses(self):
         registry = save_registry()
         self.client.get("/")
         self.client.get("/file")
-        self.assertMetricDiff(registry, 1, M("responses_streaming_total"))
-        self.assertMetricDiff(registry, 1, M("responses_body_total_bytes_bucket"), le="+Inf")
+        assert_metric_diff(registry, 1, M("responses_streaming_total"))
+        assert_metric_diff(registry, 1, M("responses_body_total_bytes_bucket"), le="+Inf")
diff --git a/django_prometheus/tests/end2end/testapp/test_middleware_custom_labels.py b/django_prometheus/tests/end2end/testapp/test_middleware_custom_labels.py
@@ -9,7 +9,11 @@
     PrometheusAfterMiddleware,
     PrometheusBeforeMiddleware,
 )
-from django_prometheus.testutils import PrometheusTestCaseMixin, save_registry
+from django_prometheus.testutils import (
+    PrometheusTestCaseMixin,
+    assert_metric_diff,
+    save_registry,
+)
 
 EXTENDED_METRICS = [
     M("requests_latency_seconds_by_view_method"),
@@ -62,36 +66,36 @@ def test_request_counters(self):
         self.client.get("/help")
         self.client.post("/", {"test": "data"})
 
-        self.assertMetricDiff(registry, 4, M("requests_before_middlewares_total"))
-        self.assertMetricDiff(registry, 4, M("responses_before_middlewares_total"))
-        self.assertMetricDiff(registry, 3, T("requests_total_by_method"), method="GET")
-        self.assertMetricDiff(registry, 1, T("requests_total_by_method"), method="POST")
-        self.assertMetricDiff(registry, 4, T("requests_total_by_transport"), transport="http")
-        self.assertMetricDiff(
+        assert_metric_diff(registry, 4, M("requests_before_middlewares_total"))
+        assert_metric_diff(registry, 4, M("responses_before_middlewares_total"))
+        assert_metric_diff(registry, 3, T("requests_total_by_method"), method="GET")
+        assert_metric_diff(registry, 1, T("requests_total_by_method"), method="POST")
+        assert_metric_diff(registry, 4, T("requests_total_by_transport"), transport="http")
+        assert_metric_diff(
             registry,
             2,
             T("requests_total_by_view_transport_method"),
             view="testapp.views.index",
             transport="http",
             method="GET",
         )
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             1,
             T("requests_total_by_view_transport_method"),
             view="testapp.views.help",
             transport="http",
             method="GET",
         )
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             1,
             T("requests_total_by_view_transport_method"),
             view="testapp.views.index",
             transport="http",
             method="POST",
         )
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             2.0,
             T("responses_total_by_status_view_method"),
@@ -101,7 +105,7 @@ def test_request_counters(self):
             view_type="foo",
             user_agent_type="browser",
         )
-        self.assertMetricDiff(
+        assert_metric_diff(
             registry,
             1.0,
             T("responses_total_by_status_view_method"),
diff --git a/django_prometheus/tests/end2end/testapp/test_models.py b/django_prometheus/tests/end2end/testapp/test_models.py
@@ -1,7 +1,11 @@
 from django.test import TestCase
 from testapp.models import Dog, Lawn
 
-from django_prometheus.testutils import PrometheusTestCaseMixin, save_registry
+from django_prometheus.testutils import (
+    PrometheusTestCaseMixin,
+    assert_metric_diff,
+    save_registry,
+)
 
 
 def M(metric_name):
@@ -21,31 +25,31 @@ def test_counters(self):
         cool = Dog()
         cool.name = "Cool"
         cool.save()
-        self.assertMetricDiff(registry, 1, M("inserts_total"), model="dog")
+        assert_metric_diff(registry, 1, M("inserts_total"), model="dog")
 
         elysees = Lawn()
         elysees.location = "Champs Elysees, Paris"
         elysees.save()
-        self.assertMetricDiff(registry, 1, M("inserts_total"), model="lawn")
-        self.assertMetricDiff(registry, 1, M("inserts_total"), model="dog")
+        assert_metric_diff(registry, 1, M("inserts_total"), model="lawn")
+        assert_metric_diff(registry, 1, M("inserts_total"), model="dog")
 
         galli = Dog()
         galli.name = "Galli"
         galli.save()
-        self.assertMetricDiff(registry, 2, M("inserts_total"), model="dog")
+        assert_metric_diff(registry, 2, M("inserts_total"), model="dog")
 
         cool.breed = "Wolfhound"
-        self.assertMetricDiff(registry, 2, M("inserts_total"), model="dog")
+        assert_metric_diff(registry, 2, M("inserts_total"), model="dog")
 
         cool.save()
-        self.assertMetricDiff(registry, 2, M("inserts_total"), model="dog")
-        self.assertMetricDiff(registry, 1, M("updates_total"), model="dog")
+        assert_metric_diff(registry, 2, M("inserts_total"), model="dog")
+        assert_metric_diff(registry, 1, M("updates_total"), model="dog")
 
         cool.age = 9
         cool.save()
-        self.assertMetricDiff(registry, 2, M("updates_total"), model="dog")
+        assert_metric_diff(registry, 2, M("updates_total"), model="dog")
 
         cool.delete()  # :(
-        self.assertMetricDiff(registry, 2, M("inserts_total"), model="dog")
-        self.assertMetricDiff(registry, 2, M("updates_total"), model="dog")
-        self.assertMetricDiff(registry, 1, M("deletes_total"), model="dog")
+        assert_metric_diff(registry, 2, M("inserts_total"), model="dog")
+        assert_metric_diff(registry, 2, M("updates_total"), model="dog")
+        assert_metric_diff(registry, 1, M("deletes_total"), model="dog")
diff --git a/django_prometheus/tests/test_testutils.py b/django_prometheus/tests/test_testutils.py
@@ -6,6 +6,7 @@
 
 from django_prometheus.testutils import (
     PrometheusTestCaseMixin,
+    assert_metric_diff,
     assert_metric_no_diff,
     assert_metric_not_equal,
     get_metric,
@@ -104,8 +105,8 @@ def test_registry_saving(self):
         assert 42 == get_metric_from_frozen_registry("some_gauge", frozen_registry)
         self.some_gauge.set(99)
         assert 42 == get_metric_from_frozen_registry("some_gauge", frozen_registry)
-        self.test_case.assertMetricDiff(frozen_registry, 99 - 42, "some_gauge", registry=self.registry)
-        assert self.test_case.passes is True
+        assert_metric_diff(frozen_registry, 99 - 42, "some_gauge", registry=self.registry)
+
         assert_metric_no_diff(frozen_registry, 1, "some_gauge", registry=self.registry)
 
         # Now test the same thing with a labelled metric.
@@ -116,15 +117,15 @@ def test_registry_saving(self):
         assert 1 == get_metric_from_frozen_registry(
             "some_labelled_gauge", frozen_registry, labelred="pink", labelblue="indigo"
         )
-        self.test_case.assertMetricDiff(
+        assert_metric_diff(
             frozen_registry,
             5 - 1,
             "some_labelled_gauge",
             registry=self.registry,
             labelred="pink",
             labelblue="indigo",
         )
-        assert self.test_case.passes is True
+
         assert_metric_no_diff(
             frozen_registry,
             1,
diff --git a/django_prometheus/testutils.py b/django_prometheus/testutils.py
@@ -42,32 +42,33 @@ def assertMetricEquals(self, expected_value, metric_name, registry=REGISTRY, **l
             metric_name,
             format_vector(get_metrics_vector(metric_name)),
         )
-        self.assertEqual(expected_value, value, assert_err)
-
-    def assertMetricDiff(self, frozen_registry, expected_diff, metric_name, registry=REGISTRY, **labels):
-        """Asserts that metric_name{**labels} changed by expected_diff between
-        the frozen registry and now. A frozen registry can be obtained
-        by calling save_registry, typically at the beginning of a test
-        case.
-        """
-        saved_value = get_metric_from_frozen_registry(metric_name, frozen_registry, **labels)
-        current_value = get_metric(metric_name, registry=registry, **labels)
-        assert current_value is not None, METRIC_DIFF_ERR_NONE_EXPLANATION % (
-            metric_name,
-            format_labels(labels),
-            saved_value,
-            current_value,
-        )
-        diff = current_value - (saved_value or 0.0)
-        assert_err = METRIC_DIFF_ERR_EXPLANATION % (
-            metric_name,
-            format_labels(labels),
-            diff,
-            expected_diff,
-            saved_value,
-            current_value,
-        )
-        self.assertEqual(expected_diff, diff, assert_err)
+        assert expected_value == value, assert_err
+
+
+def assert_metric_diff(frozen_registry, expected_diff, metric_name, registry=REGISTRY, **labels):
+    """Asserts that metric_name{**labels} changed by expected_diff between
+    the frozen registry and now. A frozen registry can be obtained
+    by calling save_registry, typically at the beginning of a test
+    case.
+    """
+    saved_value = get_metric_from_frozen_registry(metric_name, frozen_registry, **labels)
+    current_value = get_metric(metric_name, registry=registry, **labels)
+    assert current_value is not None, METRIC_DIFF_ERR_NONE_EXPLANATION % (
+        metric_name,
+        format_labels(labels),
+        saved_value,
+        current_value,
+    )
+    diff = current_value - (saved_value or 0.0)
+    assert_err = METRIC_DIFF_ERR_EXPLANATION % (
+        metric_name,
+        format_labels(labels),
+        diff,
+        expected_diff,
+        saved_value,
+        current_value,
+    )
+    assert expected_diff == diff, assert_err
 
 
 def assert_metric_no_diff(frozen_registry, expected_diff, metric_name, registry=REGISTRY, **labels):
@@ -138,7 +139,7 @@ def save_registry(registry=REGISTRY):
 
         registry = save_registry()
         doStuff()
-        self.assertMetricDiff(registry, 1, 'stuff_done_total')
+        assert_metric_diff(registry, 1, 'stuff_done_total')
     """
     return copy.deepcopy(list(registry.collect()))
 
