test/support a wider range of pythons and djangoes (#82)

* add github actions workflow

* test more pythons and djangoes

* drop python2 support

* [wip] django 3+

* [wip] elasticsearch-dsl-py 6.3+

* fix lint

* add testbox to docker-compose.yml

* more pythons and more djangoes

* update versions

* test a metric with custom analyzer

* better testbox

* update versions

* quotes

* use appconfig in test settings

* update version

* goodbye travis

Author: aaxelb

.github/workflows/test_djelme.yml

@@ -0,0 +1,54 @@
+name: test_djelme
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  checks: write
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        id: setup-py
+        with:
+          python-version: '3.7'
+      - run: pip install -U tox
+      - name: alias pythonX.Y for tox
+        run: alias python${{ steps.setup-py.outputs.python-version }}=${{ steps.setup-py.outputs.python-path }}
+      - run: TOXENV=lint tox
+
+
+  test:
+    strategy:
+      matrix:
+        python: ['3.6', '3.7', '3.8', '3.9', '3.10']
+        django: ['1.11', '2.0', '2.1', '2.2', '3.0', '3.1', '3.2', '4.0', '4.1']
+        # TODO: elasticsearch: ['6', '7', '8', '9']
+        exclude:
+          - {python: '3.6', django: '4.0'}
+          - {python: '3.6', django: '4.1'}
+          - {python: '3.7', django: '4.0'}
+          - {python: '3.7', django: '4.1'}
+          - {python: '3.10', django: '1.11'}
+          - {python: '3.10', django: '2.0'}
+    runs-on: ubuntu-latest
+    services:
+      elasticsearch:
+        image: elasticsearch:6.8.23
+        ports:
+          - 9201:9200
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        id: setup-py
+        with:
+          python-version: ${{ matrix.python }}
+      - run: pip install -U tox
+      - run: alias python${{ steps.setup-py.outputs.python-version }}=${{ steps.setup-py.outputs.python-path }}
+      - run: TOXENV=`echo 'py${{ matrix.python }}-django${{matrix.django}}' | sed 's/\.//g'` tox
+

.pre-commit-config.yaml

@@ -1,16 +1,16 @@
 repos:
-- repo: https://github.com/ambv/black
-  rev: 18.9b0
+- repo: https://github.com/psf/black
+  rev: 22.8.0
   hooks:
   - id: black
-    language_version: python3.6
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v2.1.0
+    language_version: python3.7
+- repo: https://github.com/PyCQA/flake8
+  rev: 5.0.4
   hooks:
   - id: flake8
-    additional_dependencies: ["flake8-bugbear==18.8.0"]
+    additional_dependencies: ["flake8-bugbear==22.8.23"]
 - repo: https://github.com/asottile/blacken-docs
-  rev: v0.3.0
+  rev: v1.12.1
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==18.9b0]
+    additional_dependencies: [black==22.8.0]

.travis.yml

@@ -1,7 +1,6 @@
 # django-elasticsearch-metrics
 
 [![pypi](https://badge.fury.io/py/django-elasticsearch-metrics.svg)](https://badge.fury.io/py/django-elasticsearch-metrics)
-[![Build Status](https://travis-ci.org/CenterForOpenScience/django-elasticsearch-metrics.svg?branch=master)](https://travis-ci.org/CenterForOpenScience/django-elasticsearch-metrics)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
 Django app for storing time-series metrics in Elasticsearch.

README.md

@@ -2,6 +2,14 @@ version: '3'
 services:
   elasticsearch:
     image: docker.elastic.co/elasticsearch/elasticsearch:6.3.1
-    ports:
-      # Prevent clashing with another running cluster
-      - 9201:9200
+  testbox:
+    build:
+      context: .
+      dockerfile: testbox.Dockerfile
+    depends_on:
+      - elasticsearch
+    environment:
+      TOXENV: py39-django40
+      ELASTICSEARCH_HOST: elasticsearch:9200
+    volumes:
+      - ./:/code:cached

docker-compose.yml

@@ -1,16 +1 @@
-from django.apps import AppConfig
-from django.conf import settings
-from elasticsearch_dsl.connections import connections
-from django.utils.module_loading import autodiscover_modules
-
-__version__ = "5.0.0"
-
-default_app_config = "elasticsearch_metrics.ElasticsearchMetricsConfig"
-
-
-class ElasticsearchMetricsConfig(AppConfig):
-    name = "elasticsearch_metrics"
-
-    def ready(self):
-        connections.configure(**settings.ELASTICSEARCH_DSL)
-        autodiscover_modules("metrics")
+__version__ = "2022.0.5"

elasticsearch_metrics/__init__.py

@@ -0,0 +1,12 @@
+from django.apps import AppConfig
+from django.conf import settings
+from elasticsearch_dsl.connections import connections
+from django.utils.module_loading import autodiscover_modules
+
+
+class ElasticsearchMetricsConfig(AppConfig):
+    name = "elasticsearch_metrics"
+
+    def ready(self):
+        connections.configure(**settings.ELASTICSEARCH_DSL)
+        autodiscover_modules("metrics")

elasticsearch_metrics/apps.py

@@ -1,11 +1,13 @@
+from collections import ChainMap
+import logging
+
 from django.apps import apps
 from django.conf import settings
 from django.utils import timezone
-from django.utils.six import add_metaclass
 from elasticsearch.exceptions import NotFoundError
-from elasticsearch_dsl import Document, connections, Index
+from elasticsearch_dsl import Document, connections
 from elasticsearch_dsl.document import IndexMeta, MetaField
-from elasticsearch_dsl.index import DEFAULT_INDEX
+from elasticsearch_dsl.index import Index
 
 from elasticsearch_metrics import signals
 from elasticsearch_metrics import exceptions
@@ -17,6 +19,22 @@
 
 DEFAULT_DATE_FORMAT = "%Y.%m.%d"
 
+logger = logging.getLogger(__name__)
+
+
+class ReadonlyAttrMap:
+    def __init__(self, inner_obj):
+        self.__inner_obj = inner_obj
+
+    def __getitem__(self, key):
+        try:
+            return getattr(self.__inner_obj, key)
+        except AttributeError as e:
+            raise KeyError(key) from e
+
+    def __contains__(self, key):
+        return hasattr(self.__inner_obj, key)
+
 
 class MetricMeta(IndexMeta):
     """Metaclass for the base `Metric` class."""
@@ -71,41 +89,31 @@ def __new__(mcls, name, bases, attrs):  # noqa: B902
 
     # Override IndexMeta.construct_index so that
     # a new Index is created for every metric class
+    # and Index attrs are inherited
     @classmethod
     def construct_index(cls, opts, bases):
-        i = None
-        if opts is None:
-            # Inherit Index from base classes
-            for b in bases:
-                if getattr(b, "_index", DEFAULT_INDEX) is not DEFAULT_INDEX:
-                    parent_index = b._index
-                    i = Index(
-                        parent_index._name,
-                        doc_type=parent_index._mapping.doc_type,
-                        using=parent_index._using,
-                    )
-                    i._settings = parent_index._settings.copy()
-                    i._aliases = parent_index._aliases.copy()
-                    i._analysis = parent_index._analysis.copy()
-                    i._doc_types = parent_index._doc_types[:]
-                    break
-        if i is None:
-            i = Index(
-                getattr(opts, "name", "*"),
-                doc_type=getattr(opts, "doc_type", "doc"),
-                using=getattr(opts, "using", "default"),
-            )
-        i.settings(**getattr(opts, "settings", {}))
-        i.aliases(**getattr(opts, "aliases", {}))
-        for a in getattr(opts, "analyzers", ()):
+        parent_configs = [
+            base._index.to_dict() for base in bases if hasattr(base, "_index")
+        ]
+        if opts:
+            index_config = ChainMap(ReadonlyAttrMap(opts), *parent_configs)
+        else:
+            index_config = ChainMap(*parent_configs)
+
+        i = Index(
+            index_config.get("name", "*"),
+            using=index_config.get("using", "default"),
+        )
+        i.settings(**index_config.get("settings", {}))
+        i.aliases(**index_config.get("aliases", {}))
+        for a in index_config.get("analyzers", ()):
             i.analyzer(a)
         return i
 
 
 # We need this intermediate BaseMetric class so that
 # we can run MetricMeta ahead of IndexMeta
-@add_metaclass(MetricMeta)
-class BaseMetric(object):
+class BaseMetric(metaclass=MetricMeta):
     """Base metric class with which to define custom metric classes.
 
     Example usage:
@@ -114,6 +122,7 @@ class BaseMetric(object):
 
         from elasticsearch_metrics import metrics
 
+
         class PageView(metrics.Metric):
             user_id = metrics.Integer(index=True, doc_values=True)
 
@@ -162,7 +171,7 @@ def check_index_template(cls, using=None):
             raise exceptions.IndexTemplateNotFoundError(
                 "{template_name} does not exist for {metric_name}".format(**locals()),
                 client_error=client_error,
-            )
+            ) from client_error
         else:
             current_data = list(template.values())[0]
             template_data = cls.get_index_template().to_dict()

elasticsearch_metrics/metrics.py

@@ -48,10 +48,10 @@ def get_metric(self, app_label, metric_name=None):
         app_metrics = self._get_metrics_for_app(app_label=app_label)
         try:
             return app_metrics[metric_name.lower()]
-        except KeyError:
+        except KeyError as e:
             raise LookupError(
                 "App '{}' doesn't have a '{}' metric.".format(app_label, metric_name)
-            )
+            ) from e
 
     def get_metrics(self, app_label=None):
         """Return list of registered metric classes, optionally filtered on an app_label."""

elasticsearch_metrics/registry.py

@@ -1,10 +1,10 @@
 from django.dispatch import Signal
 
 # Sent before index template is created in elasticsearch
-pre_index_template_create = Signal(providing_args=["index_template", "using"])
+pre_index_template_create = Signal()
 # Sent after index template is created in elasticsearch
-post_index_template_create = Signal(providing_args=["index_template", "using"])
+post_index_template_create = Signal()
 # Sent at the beginning of Metric's save()
-pre_save = Signal(providing_args=["instance", "using", "index"])
+pre_save = Signal()
 # Like pre_save, but sent at the end of the save() method
-post_save = Signal(providing_args=["instance", "using", "index"])
+post_save = Signal()