Django contrib app

procrastinate/contrib/django/__init__.py

@@ -0,0 +1 @@
+default_app_config = "procrastinate.contrib.django.apps.ProcrastinateConfig"

procrastinate/contrib/django/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ProcrastinateConfig(AppConfig):
+    name = "procrastinate.contrib.django"
+    label = "procrastinate_django"

procrastinate/contrib/django/migrations/0001_initial.py

@@ -0,0 +1,12 @@
+from django.db import migrations
+
+from ..utils import get_sql
+
+
+class Migration(migrations.Migration):
+    initial = True
+    dependencies = []
+
+    operations = [
+        migrations.RunSQL(get_sql("baseline-0.5.0.sql")),
+    ]

procrastinate/contrib/django/migrations/0002_drop_started_at_column.py

@@ -0,0 +1,12 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0001_initial")]
+
+    operations = [
+        migrations.RunSQL(get_sql("delta_0.5.0_001_drop_started_at_column.sql")),
+    ]

procrastinate/contrib/django/migrations/0003_drop_started_at_column.py

@@ -0,0 +1,12 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0002_drop_started_at_column")]
+
+    operations = [
+        migrations.RunSQL(get_sql("delta_0.5.0_002_drop_started_at_column.sql")),
+    ]

procrastinate/contrib/django/migrations/0004_drop_procrastinate_version_table.py

@@ -0,0 +1,14 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0003_drop_started_at_column")]
+
+    operations = [
+        migrations.RunSQL(
+            get_sql("delta_0.5.0_003_drop_procrastinate_version_table.sql")
+        ),
+    ]

procrastinate/contrib/django/migrations/0005_fix_procrastinate_fetch_job.py

@@ -0,0 +1,12 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0004_drop_procrastinate_version_table")]
+
+    operations = [
+        migrations.RunSQL(get_sql("delta_0.6.0_001_fix_procrastinate_fetch_job.sql")),
+    ]

procrastinate/contrib/django/migrations/0006_fix_trigger_status_events_insert.py

@@ -0,0 +1,14 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0005_fix_procrastinate_fetch_job")]
+
+    operations = [
+        migrations.RunSQL(
+            get_sql("delta_0.7.1_001_fix_trigger_status_events_insert.sql")
+        ),
+    ]

procrastinate/contrib/django/migrations/0007_add_queueing_lock_column.py

@@ -0,0 +1,12 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0006_fix_trigger_status_events_insert")]
+
+    operations = [
+        migrations.RunSQL(get_sql("delta_0.8.1_001_add_queueing_lock_column.sql")),
+    ]

procrastinate/contrib/django/migrations/0008_close_fetch_job_race_condition.py

@@ -0,0 +1,14 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0007_add_queueing_lock_column")]
+
+    operations = [
+        migrations.RunSQL(
+            get_sql("delta_0.10.0_001_close_fetch_job_race_condition.sql")
+        ),
+    ]

procrastinate/contrib/django/migrations/0009_add_defer_job_function.py

@@ -0,0 +1,12 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0008_close_fetch_job_race_condition")]
+
+    operations = [
+        migrations.RunSQL(get_sql("delta_0.10.0_002_add_defer_job_function.sql")),
+    ]

procrastinate/contrib/django/migrations/0010_add_procrastinate_periodic_defers.py

@@ -0,0 +1,14 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0009_add_defer_job_function")]
+
+    operations = [
+        migrations.RunSQL(
+            get_sql("delta_0.11.0_003_add_procrastinate_periodic_defers.sql")
+        ),
+    ]

procrastinate/contrib/django/migrations/0011_add_foreign_key_index.py

@@ -0,0 +1,12 @@
+from django.db import migrations
+
+from procrastinate.contrib.django.utils import get_sql
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("procrastinate_django", "0010_add_procrastinate_periodic_defers")]
+
+    operations = [
+        migrations.RunSQL(get_sql("delta_0.12.0_001_add_foreign_key_index.sql")),
+    ]

procrastinate/schema.py

@@ -23,3 +23,7 @@ def get_migrations_path() -> str:
     def apply_schema(self) -> None:
         queries = self.get_schema()
         self.connector.execute_query(query=queries)
+
+    @staticmethod
+    def get_sql(migration) -> str:
+        return read_text("procrastinate.sql.migrations", migration)

setup.cfg

@@ -40,10 +40,12 @@ dev =
     isort>=5.0.0
 
 test =
+    django>=3,<=4
     pytest
     pytest-mock
     pytest-cov
     pytest-click
+    pytest-django
     pytest-asyncio!=0.11.0
     pum
 
@@ -96,13 +98,16 @@ testpaths =
     tests/integration
     tests/acceptance
     tests/migration
-
+DJANGO_SETTINGS_MODULE = tests.acceptance.django_settings
 [mypy]
 no_implicit_optional = True
 
 [mypy-setuptools.*,psycopg2.*,importlib_metadata.*,importlib_resources.*,aiopg.*,croniter.*]
 ignore_missing_imports = True
 
+[mypy-procrastinate.contrib.django.migrations.*,procrastinate.contrib.django.apps]
+ignore_errors = True
+
 [coverage:report]
 exclude_lines =
     raise NotImplementedError

tests/acceptance/django_settings.py

@@ -0,0 +1,16 @@
+import os
+
+SECRET_KEY = "test"
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.postgresql_psycopg2",
+        "NAME": os.environ.get("PGDATABASE_DJANGO", "procrastinate"),
+        "USER": os.environ.get("PGUSER", "postgres"),
+        "PASSWORD": os.environ.get("PGPASSWORD", "password"),
+        "HOST": os.environ.get("PGHOST", "localhost"),
+    },
+}
+
+INSTALLED_APPS = [
+    "procrastinate.contrib.django",
+]

tests/acceptance/test_django.py

@@ -0,0 +1,26 @@
+import pathlib
+
+from django.db import connection
+
+
+def test_django_migrations_run_properly(db):
+    # At this point, with the db fixture, we have all migrations applied
+    with connection.cursor() as cursor:
+        cursor.execute("SELECT * FROM procrastinate_jobs")
+
+
+def test_no_missing_migration():
+    procrastinate_dir = pathlib.Path(__file__).parent.parent.parent / "procrastinate"
+    django_migrations_path = procrastinate_dir / "contrib" / "django" / "migrations"
+    django_migrations = [
+        e for e in list(django_migrations_path.iterdir()) if e.name.startswith("0")
+    ]
+    sql_migrations_path = procrastinate_dir / "sql" / "migrations"
+    sql_migrations = list(sql_migrations_path.iterdir())
+
+    assert len(sql_migrations) > 0
+    assert len(django_migrations) > 0
+
+    assert len(sql_migrations) == len(
+        django_migrations
+    ), "Some django migrations are missing"

tests/unit/test_schema.py

@@ -1,3 +1,5 @@
+import pathlib
+
 from collections import defaultdict
 
 
@@ -15,3 +17,13 @@ def test_apply_schema(app, connector):
     app.schema_manager.apply_schema()
 
     assert connector.queries == [("apply_schema", {})]
+
+
+def test_get_sql(app):
+    migration_name = "baseline-0.5.0.sql"
+    migration = app.schema_manager.get_sql(migration_name)
+
+    assert migration.startswith(
+        "CREATE EXTENSION IF NOT EXISTS plpgsql WITH SCHEMA pg_catalog;"
+    )
+    assert len(migration.splitlines()) == 187