Move test utils out of base class (#384)

* Move test utils out of base class

Author: asherf

django_prometheus/tests/end2end/testapp/test_caches.py

@@ -2,7 +2,7 @@
 from django.test import TestCase
 from redis import RedisError
 
-from django_prometheus.testutils import PrometheusTestCaseMixin
+from django_prometheus.testutils import PrometheusTestCaseMixin, get_metric
 
 
 class TestCachesMetrics(PrometheusTestCaseMixin, TestCase):
@@ -22,9 +22,9 @@ def test_counters(self):
             tested_cache = caches[supported_cache]
             backend = supported_cache.split(".")[0]
 
-            total_before = self.getMetric("django_cache_get_total", backend=backend) or 0
-            hit_before = self.getMetric("django_cache_get_hits_total", backend=backend) or 0
-            miss_before = self.getMetric("django_cache_get_misses_total", backend=backend) or 0
+            total_before = get_metric("django_cache_get_total", backend=backend) or 0
+            hit_before = get_metric("django_cache_get_hits_total", backend=backend) or 0
+            miss_before = get_metric("django_cache_get_misses_total", backend=backend) or 0
 
             tested_cache.set("foo1", "bar")
             tested_cache.get("foo1")
@@ -47,10 +47,10 @@ def test_redis_cache_fail(self):
         # Note: test use fake service config (like if server was stopped)
         supported_cache = "redis"
 
-        total_before = self.getMetric("django_cache_get_total", backend=supported_cache) or 0
-        fail_before = self.getMetric("django_cache_get_fail_total", backend=supported_cache) or 0
-        hit_before = self.getMetric("django_cache_get_hits_total", backend=supported_cache) or 0
-        miss_before = self.getMetric("django_cache_get_misses_total", backend=supported_cache) or 0
+        total_before = get_metric("django_cache_get_total", backend=supported_cache) or 0
+        fail_before = get_metric("django_cache_get_fail_total", backend=supported_cache) or 0
+        hit_before = get_metric("django_cache_get_hits_total", backend=supported_cache) or 0
+        miss_before = get_metric("django_cache_get_misses_total", backend=supported_cache) or 0
 
         tested_cache = caches["stopped_redis_ignore_exception"]
         tested_cache.get("foo1")

django_prometheus/tests/end2end/testapp/test_db.py

@@ -3,7 +3,11 @@
 from django.db import connections
 from django.test import TestCase
 
-from django_prometheus.testutils import PrometheusTestCaseMixin
+from django_prometheus.testutils import (
+    PrometheusTestCaseMixin,
+    get_metric,
+    save_registry,
+)
 
 
 class BaseDbMetricTest(PrometheusTestCaseMixin, TestCase):
@@ -48,8 +52,8 @@ def test_counters(self):
             vendor="sqlite",
             type="OperationalError",
         )
-        assert self.getMetric("django_db_execute_total", alias="test_db_1", vendor="sqlite") > 0
-        assert self.getMetric("django_db_execute_total", alias="test_db_2", vendor="sqlite") >= 200
+        assert get_metric("django_db_execute_total", alias="test_db_1", vendor="sqlite") > 0
+        assert get_metric("django_db_execute_total", alias="test_db_2", vendor="sqlite") >= 200
 
     def test_histograms(self):
         cursor_db1 = connections["test_db_1"].cursor()
@@ -58,15 +62,15 @@ def test_histograms(self):
         for _ in range(200):
             cursor_db2.execute("SELECT 2")
         assert (
-            self.getMetric(
+            get_metric(
                 "django_db_query_duration_seconds_count",
                 alias="test_db_1",
                 vendor="sqlite",
             )
             > 0
         )
         assert (
-            self.getMetric(
+            get_metric(
                 "django_db_query_duration_seconds_count",
                 alias="test_db_2",
                 vendor="sqlite",
@@ -75,7 +79,7 @@ def test_histograms(self):
         )
 
     def test_execute_many(self):
-        registry = self.saveRegistry()
+        registry = save_registry()
         cursor_db1 = connections["test_db_1"].cursor()
         cursor_db1.executemany(
             "INSERT INTO testapp_lawn(location) VALUES (?)",
@@ -102,7 +106,7 @@ class TestPostgresDbMetrics(BaseDbMetricTest):
     """
 
     def test_counters(self):
-        registry = self.saveRegistry()
+        registry = save_registry()
         cursor = connections["postgresql"].cursor()
 
         for _ in range(20):
@@ -129,7 +133,7 @@ class TestMysDbMetrics(BaseDbMetricTest):
     """
 
     def test_counters(self):
-        registry = self.saveRegistry()
+        registry = save_registry()
         cursor = connections["mysql"].cursor()
 
         for _ in range(20):
@@ -156,7 +160,7 @@ class TestPostgisDbMetrics(BaseDbMetricTest):
     """
 
     def test_counters(self):
-        r = self.saveRegistry()
+        r = save_registry()
         cursor = connections["postgis"].cursor()
 
         for _ in range(20):

django_prometheus/tests/end2end/testapp/test_middleware.py

@@ -1,7 +1,7 @@
 from django.test import SimpleTestCase, override_settings
 from testapp.views import ObjectionException
 
-from django_prometheus.testutils import PrometheusTestCaseMixin
+from django_prometheus.testutils import PrometheusTestCaseMixin, save_registry
 
 
 def M(metric_name):
@@ -30,7 +30,7 @@ class TestMiddlewareMetrics(PrometheusTestCaseMixin, SimpleTestCase):
     """
 
     def test_request_counters(self):
-        registry = self.saveRegistry()
+        registry = save_registry()
         self.client.get("/")
         self.client.get("/")
         self.client.get("/help")
@@ -85,7 +85,7 @@ def test_latency_histograms(self):
         # to complete), to eliminate flakiness we adjust the buckets used
         # in the test suite.
 
-        registry = self.saveRegistry()
+        registry = save_registry()
 
         # This always takes more than .1 second, so checking the lower
         # buckets is fine.
@@ -108,7 +108,7 @@ def test_latency_histograms(self):
         )
 
     def test_exception_latency_histograms(self):
-        registry = self.saveRegistry()
+        registry = save_registry()
 
         try:
             self.client.get("/objection")
@@ -124,7 +124,7 @@ def test_exception_latency_histograms(self):
         )
 
     def test_streaming_responses(self):
-        registry = self.saveRegistry()
+        registry = save_registry()
         self.client.get("/")
         self.client.get("/file")
         self.assertMetricDiff(registry, 1, M("responses_streaming_total"))

django_prometheus/tests/end2end/testapp/test_middleware_custom_labels.py

@@ -9,7 +9,7 @@
     PrometheusAfterMiddleware,
     PrometheusBeforeMiddleware,
 )
-from django_prometheus.testutils import PrometheusTestCaseMixin
+from django_prometheus.testutils import PrometheusTestCaseMixin, save_registry
 
 EXTENDED_METRICS = [
     M("requests_latency_seconds_by_view_method"),
@@ -56,7 +56,7 @@ def setUpClass(cls):
         Metrics._instance = None
 
     def test_request_counters(self):
-        registry = self.saveRegistry()
+        registry = save_registry()
         self.client.get("/")
         self.client.get("/")
         self.client.get("/help")

django_prometheus/tests/end2end/testapp/test_models.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 from testapp.models import Dog, Lawn
 
-from django_prometheus.testutils import PrometheusTestCaseMixin
+from django_prometheus.testutils import PrometheusTestCaseMixin, save_registry
 
 
 def M(metric_name):
@@ -17,7 +17,7 @@ class TestModelMetrics(PrometheusTestCaseMixin, TestCase):
     """Test django_prometheus.models."""
 
     def test_counters(self):
-        registry = self.saveRegistry()
+        registry = save_registry()
         cool = Dog()
         cool.name = "Cool"
         cool.save()

django_prometheus/tests/test_testutils.py

@@ -4,7 +4,13 @@
 
 import prometheus_client
 
-from django_prometheus.testutils import PrometheusTestCaseMixin
+from django_prometheus.testutils import (
+    PrometheusTestCaseMixin,
+    get_metric,
+    get_metric_from_frozen_registry,
+    get_metrics_vector,
+    save_registry,
+)
 
 
 class SomeTestCase(PrometheusTestCaseMixin):
@@ -35,23 +41,23 @@ def setUp(self):
         self.some_labelled_gauge.labels("carmin", "royal").set(4)
         self.test_case = SomeTestCase()
 
-    def testGetMetrics(self):
-        """Tests getMetric."""
-        assert 42 == self.test_case.getMetric("some_gauge", registry=self.registry)
-        assert 1 == self.test_case.getMetric(
+    def test_get_metric(self):
+        """Tests get_metric."""
+        assert 42 == get_metric("some_gauge", registry=self.registry)
+        assert 1 == get_metric(
             "some_labelled_gauge",
             registry=self.registry,
             labelred="pink",
             labelblue="indigo",
         )
 
-    def testGetMetricVector(self):
-        """Tests getMetricVector."""
-        vector = self.test_case.getMetricVector("some_nonexistent_gauge", registry=self.registry)
+    def test_get_metrics_vector(self):
+        """Tests get_metrics_vector."""
+        vector = get_metrics_vector("some_nonexistent_gauge", registry=self.registry)
         assert [] == vector
-        vector = self.test_case.getMetricVector("some_gauge", registry=self.registry)
+        vector = get_metrics_vector("some_gauge", registry=self.registry)
         assert [({}, 42)] == vector
-        vector = self.test_case.getMetricVector("some_labelled_gauge", registry=self.registry)
+        vector = get_metrics_vector("some_labelled_gauge", registry=self.registry)
         assert sorted(
             [
                 ({"labelred": "pink", "labelblue": "indigo"}, 1),
@@ -90,24 +96,24 @@ def testAssertMetricEquals(self):
         )
 
     def test_registry_saving(self):
-        """Tests saveRegistry and frozen registries operations."""
-        frozen_registry = self.test_case.saveRegistry(registry=self.registry)
+        """Tests save_registry and frozen registries operations."""
+        frozen_registry = save_registry(registry=self.registry)
         # Test that we can manipulate a frozen scalar metric.
-        assert 42 == self.test_case.getMetricFromFrozenRegistry("some_gauge", frozen_registry)
+        assert 42 == get_metric_from_frozen_registry("some_gauge", frozen_registry)
         self.some_gauge.set(99)
-        assert 42 == self.test_case.getMetricFromFrozenRegistry("some_gauge", frozen_registry)
+        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
         self.test_case.assertMetricDiff(frozen_registry, 1, "some_gauge", registry=self.registry)
         assert self.test_case.passes is False
         self.test_case.passes = True
 
         # Now test the same thing with a labelled metric.
-        assert 1 == self.test_case.getMetricFromFrozenRegistry(
+        assert 1 == get_metric_from_frozen_registry(
             "some_labelled_gauge", frozen_registry, labelred="pink", labelblue="indigo"
         )
         self.some_labelled_gauge.labels("pink", "indigo").set(5)
-        assert 1 == self.test_case.getMetricFromFrozenRegistry(
+        assert 1 == get_metric_from_frozen_registry(
             "some_labelled_gauge", frozen_registry, labelred="pink", labelblue="indigo"
         )
         self.test_case.assertMetricDiff(