fix: Trailing slash in default routes, add tests for default routes (#43)

Author: khvn26

settings/dev.py

@@ -15,6 +15,7 @@
 PROMETHEUS_ENABLED = True
 
 # Settings required for tests
+SECRET_KEY = "test"
 DATABASES = {
     "default": dj_database_url.parse(
         env(
@@ -30,6 +31,7 @@
     "task_processor",
 ]
 MIDDLEWARE = [
+    "django.middleware.common.CommonMiddleware",
     "common.gunicorn.middleware.RouteLoggerMiddleware",
 ]
 LOG_FORMAT = "json"

src/common/core/urls.py

@@ -4,14 +4,14 @@
 from common.core import views
 
 urlpatterns = [
-    path("version", views.version_info),
-    path("health/liveness", views.liveness),
-    path("health/readiness", include("health_check.urls", namespace="health")),
+    path("version/", views.version_info),
+    path("health/liveness/", views.liveness),
+    path("health/readiness/", include("health_check.urls", namespace="health")),
     re_path(r"^health", include("health_check.urls", namespace="health-deprecated")),
     # Aptible health checks must be on /healthcheck and cannot redirect
     # see https://www.aptible.com/docs/core-concepts/apps/connecting-to-apps/app-endpoints/https-endpoints/health-checks
     re_path(r"^healthcheck", include("health_check.urls", namespace="health-aptible")),
 ]
 
 if settings.PROMETHEUS_ENABLED:
-    urlpatterns += [path("metrics", views.metrics)]
+    urlpatterns += [path("metrics/", views.metrics)]

tests/conftest.py

@@ -1 +1,26 @@
+import os
+from importlib import reload
+
+import prometheus_client
+import prometheus_client.values
+import pytest
+
 pytest_plugins = "flagsmith-test-tools"
+
+
+@pytest.fixture(scope="session")
+def prometheus_multiproc_dir(tmp_path_factory: pytest.TempPathFactory) -> str:
+    os.environ["PROMETHEUS_MULTIPROC_DIR"] = prometheus_multiproc_dir_path = str(
+        tmp_path_factory.mktemp("prometheus_multiproc")
+    )
+    reload(prometheus_client.values)
+    return prometheus_multiproc_dir_path
+
+
+@pytest.fixture(scope="session")
+def test_metric(prometheus_multiproc_dir: str) -> prometheus_client.Counter:
+    return prometheus_client.Counter(
+        "pytest_tests_run_total",
+        "Total number of tests run by pytest",
+        ["test_name"],
+    )

tests/integration/__init__.py

@@ -0,0 +1,34 @@
+import prometheus_client
+from rest_framework.test import APIClient
+
+
+def test_liveness_probe__return_expected(
+    client: APIClient,
+) -> None:
+    response = client.get("/health/liveness/")
+    assert response.status_code == 200
+    assert response.json() == {"status": "ok"}
+
+
+def test_metrics__return_expected(
+    test_metric: prometheus_client.Counter,
+    client: APIClient,
+) -> None:
+    # Arrange
+    test_metric.labels(test_name="test_metrics__return_expected").inc()
+
+    # Act
+    response = client.get("/metrics", follow=True)
+
+    # Assert
+    assert response.status_code == 200
+    assert response.content == (
+        "\n".join(
+            [
+                "# HELP pytest_tests_run_total Total number of tests run by pytest",
+                "# TYPE pytest_tests_run_total counter",
+                'pytest_tests_run_total{test_name="test_metrics__return_expected"} 1.0',
+                "",
+            ]
+        ).encode()
+    )

tests/integration/core/__init__.py

@@ -4,15 +4,10 @@
 from common.test_tools import AssertMetricFixture
 from common.test_tools.plugin import assert_metric_impl
 
-test_metric = prometheus_client.Counter(
-    "pytest_tests_run_total",
-    "Total number of tests run by pytest",
-    ["test_name"],
-)
-
 
 def test_assert_metrics__asserts_expected(
     assert_metric: AssertMetricFixture,
+    test_metric: prometheus_client.Counter,
 ) -> None:
     # Given
     test_metric.labels(test_name="test_assert_metrics__asserts_expected").inc()
@@ -25,7 +20,9 @@ def test_assert_metrics__asserts_expected(
     )
 
 
-def test_assert_metrics__registry_reset_expected() -> None:
+def test_assert_metrics__registry_reset_expected(
+    test_metric: prometheus_client.Counter,
+) -> None:
     # Given
     test_metric.labels(test_name="test_assert_metrics__registry_reset_expected").inc()