Merge branch 'chore/modernize' into 'master'

mgax · mgax · commit c227fd844371 · 2024-10-08T12:38:23.000Z
Modernize the tooling, add tests

See merge request internal/django-birdbath!13
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,4 @@ venv/
 .envrc
 build
 dist
+*.egg-info/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,9 @@
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.6.9'
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Torchbox Ltd.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/Makefile b/Makefile
diff --git a/birdbath/__init__.py b/birdbath/__init__.py
@@ -1 +1,8 @@
+"""
+A simple tool for giving Django database data a good wash. Anonymise user data, delete stuff you
+don't need in your development environment, or whatever it is you need to do.
+"""
+
+__version__ = "2.0.0"
+
 default_app_config = "birdbath.apps.BirdBathConfig"
diff --git a/birdbath/management/commands/run_birdbath.py b/birdbath/management/commands/run_birdbath.py
@@ -42,7 +42,7 @@ def handle(self, *args, **options):
                 processor = import_string(processor_path)()
                 try:
                     processor.run()
-                except Exception as e:
+                except Exception as e:  # noqa: BLE001
                     errors.append(e)
 
             if errors:
diff --git a/birdbath/processors/base.py b/birdbath/processors/base.py
@@ -3,7 +3,6 @@
 from django.db import models
 from django.utils.crypto import get_random_string
 from django.utils.functional import cached_property
-
 from faker import Faker
 
 LOWERCASE_STRING = "".join(string.ascii_lowercase)
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,62 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "django-birdbath"
+authors = [{name = "Torchbox", email = "info@torchbox.com"}]
+dynamic = ["version", "description"]
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = [
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = ["django", "anonymization", "data cleaning"]
+dependencies = [
+    "Faker >=8",
+]
+requires-python = ">=3.9"
+
+[project.urls]
+Home = "https://git.torchbox.com/internal/django-birdbath"
+
+[project.optional-dependencies]
+dev = [
+    "django~=4.2",
+    "pre-commit>=3.8.0",
+    "pytest~=8.3",
+    "pytest-django~=4.9",
+    "ruff==0.6.9",
+    "wagtail~=5.2",
+]
+
+[tool.flit.module]
+name = "birdbath"
+
+[tool.flit.sdist]
+include = ["LICENSE", "CHANGELOG.md", "README.md"]
+
+[tool.ruff]
+target-version = "py39"
+
+exclude = [
+    ".github",
+]
+
+# E501: Line too long
+lint.ignore = ["E501"]
+
+lint.select = [
+    "E", # pycodestyle errors
+    "F", # pyflakes
+    "I", # isort
+    "T20", # flake8-print
+    "BLE", # flake8-blind-except
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/settings.py b/tests/settings.py
@@ -0,0 +1,21 @@
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": ":memory:",
+    },
+}
+
+INSTALLED_APPS = [
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "wagtail.contrib.forms",
+    "wagtail.contrib.search_promotions",
+    "wagtail.search",
+    "wagtail.users",
+    "wagtail",
+    "birdbath",
+]
+
+SECRET_KEY = "not-so-secret-for-tests"
+
+STATIC_URL = "/static/"
diff --git a/tests/test_management_commands.py b/tests/test_management_commands.py
@@ -0,0 +1,11 @@
+import pytest
+from django.core.management import call_command
+
+from birdbath.models import Execution
+
+
+@pytest.mark.django_db
+def test_run_birdbath_command():
+    assert Execution.objects.count() == 0
+    call_command("run_birdbath")
+    assert Execution.objects.count() == 1
diff --git a/tests/test_processors.py b/tests/test_processors.py
@@ -0,0 +1,32 @@
+import pytest
+
+from birdbath.processors.users import UserEmailAnonymiser, UserPasswordAnonymiser
+
+
+@pytest.fixture
+def user(django_user_model):
+    return django_user_model.objects.create_user(
+        username="someone", email="someone@example.org", password="something"
+    )
+
+
+@pytest.mark.django_db
+def test_user_email_anonymiser(user):
+    original_email = user.email
+    anonymiser = UserEmailAnonymiser()
+    anonymiser.run()
+    user.refresh_from_db()
+    assert user.email != original_email
+    assert "@" in user.email
+
+
+@pytest.mark.django_db
+def test_user_password_anonymiser(user, django_user_model):
+    original_password_hash = user.password
+    anonymiser = UserPasswordAnonymiser()
+    anonymiser.run()
+    user.refresh_from_db()
+    assert user.password != original_password_hash
+    assert not django_user_model.objects.get(username=user.username).check_password(
+        "original_password"
+    )
diff --git a/tests/test_system_checks.py b/tests/test_system_checks.py
@@ -0,0 +1,21 @@
+import pytest
+from django.core.checks import Error
+from django.core.management import call_command
+
+from birdbath.system_checks import check_has_been_cleaned
+
+
+@pytest.mark.django_db
+def test_check_has_been_cleaned():
+    # Test when Birdbath hasn't been run
+    errors = check_has_been_cleaned(None)
+    assert len(errors) == 1
+    assert isinstance(errors[0], Error)
+    assert errors[0].id == "birdbath.E001"
+
+    # Run Birdbath
+    call_command("run_birdbath")
+
+    # Test after Birdbath has been run
+    errors = check_has_been_cleaned(None)
+    assert len(errors) == 0
diff --git a/tests/test_wagtail_processors.py b/tests/test_wagtail_processors.py
@@ -0,0 +1,29 @@
+import pytest
+from wagtail.contrib.forms.models import FormSubmission
+from wagtail.contrib.search_promotions.models import Query
+
+from birdbath.processors.contrib.wagtail import (
+    FormSubmissionCleaner,
+    SearchQueryCleaner,
+)
+
+
+@pytest.mark.django_db
+def test_search_query_cleaner():
+    Query.objects.create(query_string="test query")
+    assert Query.objects.count() == 1
+    cleaner = SearchQueryCleaner()
+    cleaner.run()
+    assert Query.objects.count() == 0
+
+
+@pytest.mark.django_db
+def test_form_submission_cleaner():
+    FormSubmission.objects.create(
+        form_data='{"name": "Test User", "email": "test@example.com"}',
+        page_id=1,
+    )
+    assert FormSubmission.objects.count() == 1
+    cleaner = FormSubmissionCleaner()
+    cleaner.run()
+    assert FormSubmission.objects.count() == 0
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,30 @@
+[tox]
+envlist =
+  py39-django42-wagtail62
+  py{310,311,312}-django{50,51}-wagtail62
+  py312-django42-wagtail{52,60,61,62}
+isolated_build = True
+
+[testenv]
+deps =
+    django42: Django>=4.2,<5.0
+    django50: Django>=5.0,<5.1
+    django51: Django>=5.1,<5.2
+    wagtail52: wagtail>=5.2,<5.3
+    wagtail60: wagtail>=6.0,<6.1
+    wagtail61: wagtail>=6.1,<6.2
+    wagtail62: wagtail>=6.2,<6.3
+    pytest
+    pytest-django
+extras = dev
+commands =
+    pytest {posargs}
+
+[testenv:lint]
+deps =
+    black==23.1.0
+    flake8==6.0.0
+    isort==5.12.0
+commands =
+    ruff check .
+    ruff format . --check

-Original file line number
+Diff line change
 .envrc
 build
 dist
 +*.egg-info/