dependencies: add celery and celery beat to the project

Signed-off-by: andrepapoti <[email protected]>

Author: andrepapoti

docker-compose.yml

@@ -35,3 +35,56 @@ services:
       - DATABASE_NAME=patchwork
       - DATABASE_USER=patchwork
       - DATABASE_PASSWORD=password
+
+  redis:
+    image: redis:alpine
+    ports:
+      - 6379:6379
+
+  celery:
+    build:
+      context: .
+      dockerfile: ./tools/docker/Dockerfile
+      args:
+        - UID
+        - GID
+    user: patchwork
+    command: ["celery", "-A", "patchwork", "worker", "--loglevel=info"]
+    volumes:
+      - .:/home/patchwork/patchwork/
+    depends_on:
+      - db
+      - redis
+    environment:
+      - UID
+      - GID
+      # skip DATABASE_TYPE explicitly as mysql should be the default type.
+      - DATABASE_HOST=db
+      - DATABASE_PORT=3306
+      - DATABASE_NAME=patchwork
+      - DATABASE_USER=patchwork
+      - DATABASE_PASSWORD=password
+
+  celerybeat:
+    build:
+      context: .
+      dockerfile: ./tools/docker/Dockerfile
+      args:
+        - UID
+        - GID
+    user: patchwork
+    command: ["celery", "-A", "patchwork", "beat", "--loglevel=info", "--scheduler", "django_celery_beat.schedulers:DatabaseScheduler"]
+    volumes:
+      - .:/home/patchwork/patchwork/
+    depends_on:
+      - db
+      - redis
+    environment:
+      - UID
+      - GID
+      # skip DATABASE_TYPE explicitly as mysql should be the default type.
+      - DATABASE_HOST=db
+      - DATABASE_PORT=3306
+      - DATABASE_NAME=patchwork
+      - DATABASE_USER=patchwork
+      - DATABASE_PASSWORD=password

patchwork/__init__.py

@@ -3,9 +3,11 @@
 #
 # SPDX-License-Identifier: GPL-2.0-or-later
 
+from patchwork.celery import app as celery_app
 from patchwork.version import get_str_version
 from patchwork.version import get_latest_version
 
 VERSION = get_str_version()
 
 __version__ = get_latest_version()
+__all__ = ('celery_app',)

patchwork/celery.py

@@ -0,0 +1,10 @@
+import os
+from celery import Celery
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'patchwork.settings')
+
+app = Celery('patchwork')
+
+app.config_from_object('django.conf:settings', namespace='CELERY')
+
+app.autodiscover_tasks()

patchwork/settings/base.py

@@ -187,6 +187,20 @@
     'NON_FIELD_ERRORS_KEY': 'detail',
 }
 
+# Celery settings
+
+INSTALLED_APPS += ['django_celery_beat']
+
+CELERY_BROKER_URL = 'redis://redis:6379/0'
+CELERY_RESULT_BACKEND = 'redis://redis:6379/0'
+CELERY_ACCEPT_CONTENT = ['json']
+CELERY_TASK_SERIALIZER = 'json'
+CELERY_RESULT_SERIALIZER = 'json'
+CELERY_TIMEZONE = 'UTC'
+
+CELERY_BEAT_SCHEDULER = 'django_celery_beat.schedulers:DatabaseScheduler'
+DJANGO_CELERY_BEAT_TZ_AWARE = False
+
 #
 # Logging settings
 #

requirements-dev.txt

@@ -3,4 +3,7 @@ djangorestframework~=3.14.0
 django-filter~=23.5.0
 django-debug-toolbar~=4.2.0
 django-dbbackup~=4.1.0
+celery~=5.3.0
+redis~=5.0.0
+django-celery-beat~=2.6.0
 -r requirements-test.txt

requirements-prod.txt

@@ -3,3 +3,6 @@ djangorestframework~=3.14.0
 django-filter~=23.5.0
 psycopg2~=2.9.0
 sqlparse~=0.4.0
+celery~=5.3.0
+redis~=5.0.0
+django-celery-beat~=2.6.0