prefix test index names

Author: aaxelb

elasticsearch_metrics/imps/elastic6.py

@@ -251,14 +251,21 @@ def get_timeseries_index_template(cls):
             template_name=cls._template_name, pattern=cls._template_pattern
         )
 
+    @classmethod
+    def get_timeseries_name_prefix(cls) -> str:
+        return ""
+
     @classmethod
     def get_index_name(cls, date: datetime.date | None = None) -> str:
         date = date or timezone.now().date()
         dateformat = getattr(
             settings, "ELASTICSEARCH_METRICS_DATE_FORMAT", DEFAULT_DATE_FORMAT
         )
         date_formatted = date.strftime(dateformat)
-        return "{}_{}".format(cls._template_name, date_formatted)
+        _name_parts = (cls._template_name, date_formatted)
+        if _prefix := cls.get_timeseries_name_prefix():
+            _name_parts = (_prefix, *_name_parts)
+        return "_".join(_name_parts)
 
 
 class Metric(Document, BaseMetric):

elasticsearch_metrics/imps/elastic8.py

@@ -158,28 +158,12 @@ def record(
 
     @classmethod
     def check_djelme_setup(cls, using: str | None = None) -> bool:
+        # this base class has only a single index -- does it exist?
         return bool(cls._index.get(using=using))
 
-    @classmethod
-    def refresh_timeseries_indexes(cls, using: str | None = None) -> None:
-        cls._get_connection(using).indices.refresh(
-            index=cls.format_timeseries_index_pattern()
-        )
-
-    @classmethod
-    def each_timeseries_index(
-        cls, using: str | None = None
-    ) -> collections.abc.Iterator[tuple[str, dict[str, typing.Any]]]:
-        _resp = cls._get_connection(using).indices.get(
-            index=cls.format_timeseries_index_pattern(),
-        )
-        for _index_name, _index_info in _resp.items():
-            assert isinstance(_index_name, str)
-            assert isinstance(_index_info, dict)
-            yield _index_name, _index_info
-
     @classmethod
     def _djelme_teardown(cls, es_client):
+        # this base class has only a single index -- delete it
         cls._index.delete(using=es_client)
 
     @classmethod
@@ -263,13 +247,12 @@ class Meta:
 
     @classmethod
     def init(cls, index=None, using=None) -> None:
-        """Create the index and populate the mappings in elasticsearch.
+        """Create an index template with mappings for timeseries indexes
 
         overrides elasticsearch.Document.init
+        (but doesn't call super().init(), which would create a "now" index)
         """
         assert not cls.is_abstract
-        # to init timeseries indexes, create only the template
-        # (don't call super().init(), which would create a "now" index)
         cls.sync_index_template(using=using)
 
     @classmethod
@@ -297,6 +280,24 @@ def search_timeseries_range(
         )
         return cls.search(index=_index_pattern).filter(_timestamp_q)
 
+    @classmethod
+    def refresh_timeseries_indexes(cls, using: str | None = None) -> None:
+        cls._get_connection(using).indices.refresh(
+            index=cls.format_timeseries_index_pattern()
+        )
+
+    @classmethod
+    def each_timeseries_index(
+        cls, using: str | None = None
+    ) -> collections.abc.Iterator[tuple[str, dict[str, typing.Any]]]:
+        _resp = cls._get_connection(using).indices.get(
+            index=cls.format_timeseries_index_pattern(),
+        )
+        for _index_name, _index_info in _resp.items():
+            assert isinstance(_index_name, str)
+            assert isinstance(_index_info, dict)
+            yield _index_name, _index_info
+
     @classmethod
     def _djelme_teardown(cls, es8_client: Elastic8Client) -> None:
         _indexname_wildcard = cls.format_timeseries_index_pattern()

elasticsearch_metrics/tests/_test_util.py

@@ -2,6 +2,7 @@
 from unittest import mock
 import types
 import typing
+import uuid
 
 from django.core.management import call_command
 from django.core.management.base import BaseCommand
@@ -52,18 +53,29 @@ def __init_subclass__(
 
     def setUp(self):
         super().setUp()
+        _name_prefix = uuid.uuid4().hex
+        self.enterContext(
+            mock.patch(
+                "elasticsearch_metrics.imps.elastic8.TimeseriesRecord.get_timeseries_name_prefix",
+                return_value=_name_prefix,
+            )
+        )
+        self.enterContext(
+            mock.patch(
+                "elasticsearch_metrics.imps.elastic6.BaseMetric.get_timeseries_name_prefix",
+                return_value=_name_prefix,
+            ),
+        )
         if self.__autosetup_backends:
             self.setup_backends()
 
     def tearDown(self):
-        super().tearDown()
         if self.__autoteardown_backends:
             self.teardown_backends()
+        super().tearDown()
 
     def setup_backends(self):
-        # TODO: prefix index names, avoid collisions across test runs
-        # get settings from elasticsearch_metrics.tests.settings.DJELME_BACKENDS
-        # self.teardown_backends()  # in case any already exist
+        # backends based on settings in django.conf.settings.DJELME_BACKENDS
         for _backend_name, _recordtypes in djelme_registry.each_recordtype_by_backend():
             djelme_registry.get_backend(_backend_name).djelme_setup(_recordtypes)
 

elasticsearch_metrics/tests/test_imps_elastic8.py

@@ -423,16 +423,19 @@ def setUp(self):
         Dummy8Event.refresh_timeseries_indexes()
 
     def test_indexes(self):
-        _index_names = {_name for _name, _ in Dummy8Event.each_timeseries_index()}
+        _index_names = {
+            _strip_test_prefix(_name)
+            for _name, _ in Dummy8Event.each_timeseries_index()
+        }
         self.assertEqual(
             _index_names,
             {
-                "dummy8app_dummy8event_1234_05_06_",
-                "dummy8app_dummy8event_1234_05_07_",
-                "dummy8app_dummy8event_1234_06_01_",
-                "dummy8app_dummy8event_1235_05_06_",
-                "dummy8app_dummy8event_2345_06_09_",
-                "dummy8app_dummy8event_2345_07_09_",
+                "dummy8event_1234_05_06_",
+                "dummy8event_1234_05_07_",
+                "dummy8event_1234_06_01_",
+                "dummy8event_1235_05_06_",
+                "dummy8event_2345_06_09_",
+                "dummy8event_2345_07_09_",
             },
         )
 
@@ -482,15 +485,18 @@ def setUp(self):
         Monthly8Event.refresh_timeseries_indexes()
 
     def test_indexes(self):
-        _index_names = {_name for _name, _ in Monthly8Event.each_timeseries_index()}
+        _index_names = {
+            _strip_test_prefix(_name)
+            for _name, _ in Monthly8Event.each_timeseries_index()
+        }
         self.assertEqual(
             _index_names,
             {
-                "dummy8evenz_eventlog_1234_05_",
-                "dummy8evenz_eventlog_1234_06_",
-                "dummy8evenz_eventlog_1235_05_",
-                "dummy8evenz_eventlog_2345_06_",
-                "dummy8evenz_eventlog_2345_07_",
+                "eventlog_1234_05_",
+                "eventlog_1234_06_",
+                "eventlog_1235_05_",
+                "eventlog_2345_06_",
+                "eventlog_2345_07_",
             },
         )
 
@@ -540,13 +546,16 @@ def setUp(self):
         ThingHappened.refresh_timeseries_indexes()
 
     def test_indexes(self):
-        _index_names = {_name for _name, _ in ThingHappened.each_timeseries_index()}
+        _index_names = {
+            _strip_test_prefix(_name)
+            for _name, _ in ThingHappened.each_timeseries_index()
+        }
         self.assertEqual(
             _index_names,
             {
-                "dummy8app_happen_1234_",
-                "dummy8app_happen_1235_",
-                "dummy8app_happen_2345_",
+                "happen_1234_",
+                "happen_1235_",
+                "happen_2345_",
             },
         )
 
@@ -581,3 +590,9 @@ def _assert_things(hits, expected_thing_ids):
             ThingHappened.search_timeseries_range((1234, 5, 6, 2), (1234, 5, 7)),
             {"b"},
         )
+
+
+def _strip_test_prefix(index_name: str) -> str:
+    # strip uuid test prefix
+    (_, _, _without_prefix) = index_name.partition("_")
+    return _without_prefix