feat: add unit test

Author: Kl0ven

.github/workflows/pylama.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
 
 jobs:
-  build:
+  pylama:
     runs-on: ubuntu-latest
     strategy:
       matrix:

.github/workflows/semver_build_publish.yml

@@ -63,3 +63,10 @@ jobs:
         run: |
           CHANNEL=${{ needs.semver.outputs.new_release_channel }}
           docker push ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:${CHANNEL:-'latest'}
+
+      - name: Docker Hub Description
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}

.github/workflows/tests.yml

@@ -0,0 +1,55 @@
+name: tests-unittest
+
+on:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+        poetry-version: ["1.2"]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run image
+        uses: abatilo/actions-poetry@v2.0.0
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Install dependencies
+        run: poetry install
+      - name: Run tests with coverage
+        run: |
+          poetry run coverage run
+          poetry run coverage xml
+        env:
+          POSTGRES_HOST: localhost
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          TESTING: "true"
+          SECRET_KEY: "very_secret_key"
+          OIDC_OP_JWKS_ENDPOINT: "http://nowhere.com"
+      - name: Upload Coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          verbose: true
+          files: coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: true

README.md

@@ -1,14 +1,19 @@
 # Sentry Dynamic Sampling Controller
 
+![Tests Status](https://github.com/SpikeeLabs/sentry-dynamic-sampling-controller/actions/workflows/.github/workflows/test.yml/badge.svg)
+[![codecov](https://codecov.io/gh/SpikeeLabs/sentry-dynamic-sampling-controller/branch/main/graph/badge.svg?token=NK5V6YMWW0)](https://codecov.io/gh/SpikeeLabs/sentry-dynamic-sampling-controller)
+
+---
+
 This project aims to provide dynamic sampling without relying on Sentry Dynamic Sampling.
 
 
-It work by installing the library [sentry-dynamic-sampling-lib](https://github.com/SpikeeLabs/sentry-dynamic-sampling-lib) on each project that use sentry. This lib hooks into the sentry callback to change the sampling rate. to get the rate the lib calls this service.
+It work by installing the library [sentry-dynamic-sampling-lib](https://github.com/SpikeeLabs/sentry-dynamic-sampling-lib) on each project that use sentry. This lib hooks into the sentry callback to change the sampling rate. To get the rate the lib calls this service.
 
 
 
 
-## Install
+## Development
 ```bash
 # install deps
 poetry install
@@ -23,6 +28,8 @@ poetry run pre-commit install --install-hooks --hook-type commit-msg
 ```bash
 poetry shell
 
+python manage.py migrate
+
 # add user
 python manage.py createsuperuser
 

config.py

@@ -3,9 +3,7 @@
 
 worker_class = "gevent"
 workers = int(os.getenv("WORKERS", "4"))
-bind = [
-    f'{os.environ.get("HTTP_ADDR", "0.0.0.0")}:{os.environ.get("HTTP_PORT", "8000")}'
-]
+bind = [f'{os.environ.get("HTTP_ADDR", "0.0.0.0")}:{os.environ.get("HTTP_PORT", "8000")}']
 daemon = os.environ.get("DEAMON_RUNNING", False)
 timeout = os.environ.get("TIMEOUT", 60)
 loglevel = os.environ.get("LOG_LEVEL", "info")

controller/sentry/admin.py

@@ -18,8 +18,6 @@
 from controller.sentry.models import App
 from controller.sentry.utils import invalidate_cache
 
-admin.site
-
 
 @admin.register(App)
 class AppAdmin(
@@ -102,7 +100,7 @@ def get_change_actions(self, request, object_id, form_url):
     @add_form_to_action(BumpForm)
     @confirm_action()
     @admin.action(description="Bump Sample Rate")
-    def bump_sample_rate(self, request, queryset, form: BumpForm = None):
+    def bump_sample_rate(self, request, queryset, form: BumpForm = None):  # pylint: disable=unused-argument
         new_date = timezone.now() + form.cleaned_data["duration"]
         queryset.update(
             active_sample_rate=form.cleaned_data["new_sample_rate"],
@@ -122,7 +120,7 @@ def has_bump_sample_rate_permission(self, request):
     @takes_instance_or_queryset
     @confirm_action(display_queryset=False)
     @admin.action(description="Panic")
-    def panic(self, request, queryset):
+    def panic(self, request, queryset):  # pylint: disable=unused-argument
         cache.set(settings.PANIC_KEY, True, timeout=None)
 
     panic.allowed_permissions = ("panic",)
@@ -138,7 +136,7 @@ def has_panic_permission(self, request):
     @takes_instance_or_queryset
     @confirm_action(display_queryset=False)
     @admin.action(description="UnPanic")
-    def unpanic(self, request, queryset):
+    def unpanic(self, request, queryset):  # pylint: disable=unused-argument
         cache.delete(settings.PANIC_KEY)
 
     unpanic.allowed_permissions = ("unpanic",)

controller/sentry/auth.py

@@ -1,8 +1,13 @@
+from functools import lru_cache
+
 from django.conf import settings
 from django.contrib.auth.models import Group
 from mozilla_django_oidc.auth import OIDCAuthenticationBackend
 
-DEVELOPER_GROUP = Group.objects.get(name=settings.DEVELOPER_GROUP)
+
+@lru_cache
+def get_group(group):
+    return Group.objects.get(name=group)
 
 
 class ControllerOIDCAuthenticationBackend(OIDCAuthenticationBackend):
@@ -30,4 +35,4 @@ def _set_username(self, user, claims):
 
     def _set_perms(self, user):
         user.is_staff = True
-        user.groups.add(DEVELOPER_GROUP)
+        user.groups.add(get_group(settings.DEVELOPER_GROUP))

controller/sentry/fixtures/groups.json

@@ -19,9 +19,6 @@ def clean_new_sample_rate(self):
 
     def clean_duration(self):
         data = self.cleaned_data["duration"]
-        if (
-            data.total_seconds() < 0
-            or data.total_seconds() > settings.MAX_BUMP_TIME_SEC
-        ):
-            raise ValidationError("duration must be between 0 and 600")
+        if data.total_seconds() < 0 or data.total_seconds() > settings.MAX_BUMP_TIME_SEC:
+            raise ValidationError(f"duration must be between 0 and {settings.MAX_BUMP_TIME_SEC}")
         return data

controller/sentry/forms.py

@@ -1,4 +1,4 @@
 from controller.sentry.metrics.celery import celery_merger
 from controller.sentry.metrics.wsgi import wsgi_merger
 
-__all__ = [wsgi_merger, celery_merger]
+__all__ = ["wsgi_merger", "celery_merger"]