fix: add unit tests

Author: Kl0ven

.github/workflows/tests.yml

@@ -0,0 +1,36 @@
+name: tests-unittest
+
+on:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        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/[email protected]
+        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
+      - 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,33 +1,60 @@
 # Sentry Dynamic Sampling Controller
 
-This project aims to provide dynamic sampling without relying on Sentry Dynamic Sampling.
+[![PyPI](https://img.shields.io/pypi/v/sentry-dynamic-sampling-lib?color=blue)](https://pypi.org/project/sentry-dynamic-sampling-lib/)
+![Tests Status](https://github.com/SpikeeLabs/sentry-dynamic-sampling-lib/actions/workflows/.github/workflows/test.yml/badge.svg)
+[![codecov](https://codecov.io/gh/SpikeeLabs/sentry-dynamic-sampling-lib/branch/main/graph/badge.svg?token=NK5V6YMWW0)](https://codecov.io/gh/SpikeeLabs/sentry-dynamic-sampling-lib)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sentry-dynamic-sampling-lib)
+![PyPI - License](https://img.shields.io/pypi/l/sentry-dynamic-sampling-lib)
 
+---
+This project aims to provide dynamic sampling without relying on Sentry own's Dynamic Sampling.
+This libs works by adding a `traces_sampler` callback to sentry.
+In the background a thread fetch the data from the [controller](https://github.com/SpikeeLabs/sentry-dynamic-sampling-controller)
+It's also able to ignore WSGI route an Celery task set in controller.
 
-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
-```bash
-# install deps
-poetry install
+## Usage
+```python
+import sentry_sdk
+from sentry_dynamic_sampling_lib import init_wrapper
 
-# pre-commit
-poetry run pre-commit install --install-hook
-poetry run pre-commit install --install-hooks --hook-type commit-msg
+# init sentry as usual
+# without traces_sampler and sample_rate param
+sentry_sdk.init(  # pylint: disable=E0110
+    dsn=SENTRY_DSN,
+    integrations=[],
+    environment=ENVIRONMENT,
+    release=SENTRY_RELEASE,
+)
+
+# hook sentry_dynamic_sampling_lib into sentry
+init_wrapper()
 ```
 
 
-## Run
+## Configuration
+The following environment variables can be used to configure the lib
+
 ```bash
-poetry shell
+SENTRY_CONTROLLER_HOST=none # (required, no default)
+SENTRY_CONTROLLER_PATH="/sentry/apps/{}/" # (optional, default to example)
+SENTRY_CONTROLLER_METRIC_PATH="/sentry/apps/{}/metrics/{}/" # (optional, default to example)
+SENTRY_CONTROLLER_POLL_INTERVAL=60 # (optional, default to example)
+SENTRY_CONTROLLER_METRIC_INTERVAL=600 # (optional, default to example)
+```
 
-# add user
-python manage.py createsuperuser
 
-# run server
-# admin @ http://localhost:8000/admin/
-python manage.py runserver
 
+
+## Development
+```bash
+# install deps
+poetry install
+
+# pre-commit
+poetry run pre-commit install --install-hook
+poetry run pre-commit install --install-hooks --hook-type commit-msg
 ```

dist/sentry_dynamic_sampling_lib-0.1.0-py3-none-any.whl

@@ -3,15 +3,28 @@ name = "sentry-dynamic-sampling-lib"
 version = "0.1.0"
 description = ""
 authors = ["jeanloup.monnier <[email protected]>"]
+maintainers = ["jeanloup.monnier <[email protected]>"]
 readme = "README.md"
-packages = [{include = "sentry_dynamic_sampling_lib"}]
+packages = [{ include = "sentry_dynamic_sampling_lib" }]
+license = "BSD 2"
+repository = "https://github.com/SpikeeLabs/django-admin-action-tools"
+
+classifiers = [
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3 :: Only",
+]
+
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.8"
 schedule = "^1.1.0"
 wrapt = "^1.14.1"
 psutil = "^5.9.4"
 requests-cache = "^0.9.7"
+pytest = "^7.2.0"
 
 
 [tool.poetry.group.dev.dependencies]
@@ -27,3 +40,67 @@ sentry-sdk = "^1.12.1"
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+
+[tool.black]
+exclude = '''
+(
+    /(
+        \.git
+        |\.tox
+        |migrations
+    )/
+)
+'''
+include = '\.pyi?$'
+line-length = 119
+
+[tool.pylama]
+format = "pycodestyle"
+linters = "pycodestyle,pyflakes,pylint"
+max_line_length = 119
+skip = ".pytest_cache,.venv/*,*/migrations/*,tests/*,*/tests/*,docs/*"
+
+[tool.pylama.linter.pycodestyle]
+max_line_length = 119
+
+[tool.pylama.linter.pylint]
+disable = "W0108,W0511,W0602,W0603,W0703,C0206,C0209,C0114,C0115,C0116,R0903,R0913,R0914,R0901,E1101,E1130,E1136,W0212"
+# Ignored rules:
+#   - W0108: Lambda may not be necessary
+#   - W0511: fixme, todo
+#   - W0602: global-variable-not-assigned
+#   - W0603: global-statement
+#   - W0703: Catching too general exception
+#   - C0114: missing-module-docstring
+#   - C0115: missing-class-docstring
+#   - C0116: missing-function-docstring
+#   - C0206: consider-using-dict-items
+#   - C0209: consider-using-f-string
+#   - R0903: too-few-public-methods
+#   - R0913: too-many-arguments
+#   - R0914: too-many-locals
+#   - R0901: max-parents: Maximum number of parents for a class
+#   - E1101: generated-members
+#            List of members which are set dynamically and missed by pylint inference system,
+#            and so shouldn't trigger E1101 when accessed.
+#   - E1130: invalid-unary-operand-type
+#            Emitted when a unary operand is used on an object which does not support this type of operation.
+#   - E1136: unsubscriptable-object
+#            Value '%s' is unsubscriptable Emitted when a subscripted value doesn't support subscription
+#   - W0212: protected-access: Access to a protected member of a client class
+
+
+[tool.coverage.run]
+command_line = "-m pytest"
+relative_files = true
+omit = ["tests/*"]
+source = ["sentry_dynamic_sampling_lib"]
+branch = true
+
+[tool.coverage.report]
+fail_under = 100
+
+[tool.pytest.ini_options]
+testpaths = "tests/"
+# addopts = "--doctest-modules -ra -l --tb=short --show-capture=all --color=yes"