Add Docker, Docker Compose and use dockerized PostgreSQL for local testing (#476)

diegocastrum · auvipy · web-flow · commit 5e0b2c6075d8 · 2025-05-19T11:08:04.000Z
* fix: correct heading formatting in injecting_metadata.rst * feat(settings): update database configuration to use environment variables. Relates #475 * feat(tox): add passenv for DB_POSTGRES_* environment variables Relates #475 * feat(docker): Integrate Docker and Docker Compose for testing. - Introduced a `Dockerfile` to enable containerized testing environment for Django Celery Results. - Added a `compose.yml` file to orchestrate services, including a PostgreSQL container for database testing. - Enhanced `.gitignore` to exclude .env and temporary files. - Included a small update of the `README.rst` with instructions for running tests using Docker and Docker Compose. - Added `.dockerignore` to optimize Docker builds. Closes #475 * Update compose.yml * Update compose.yml * Update docker/Dockerfile * chore(Dockerfile): fix label formatting and update documentation link in Dockerfile * Update compose.yml --------- Co-authored-by: Asif Saif Uddin <auvipy@gmail.com>
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,73 @@
+# Version control
+.git
+.gitignore
+.gitattributes
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+*.egg
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+coverage.xml
+*.cover
+.pytest_cache/
+.hypothesis/
+
+# Django
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Docker
+docker-compose*.yml
+Dockerfile
+.docker
+docker/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Environment
+.env
+.venv
+env/
+venv/
+ENV/
+
+# Documentation
+docs/
+*.rst
+*.md
+LICENSE
+AUTHORS
+
+# OS specific
+.DS_Store
+Thumbs.db
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,5 @@ cover/
 .cache/
 htmlcov/
 coverage.xml
+.env
+*.ignore
diff --git a/AUTHORS b/AUTHORS
@@ -25,6 +25,7 @@ Darjus Loktevic <darjus@amazon.com>
 David Fischer <david.fischer.ch@gmail.com>
 David Ziegler <david.ziegler@gmail.com>
 Diego Andres Sanabria Martin <diegueus9@gmail.com>
+Diego Castro <diego.castro@kubicum.com>
 Dmitriy Krasilnikov <krasilnikov.d.o@gmail.com>
 Donald Stufft <donald.stufft@gmail.com>
 Eldon Stegall
diff --git a/README.rst b/README.rst
@@ -73,6 +73,17 @@ pip command::
     $ pip install https://github.com/celery/django-celery-results/zipball/master#egg=django-celery-results
 
 
+Running with Docker Compose
+===========================
+
+To run the project using Docker Compose, ensure you have Docker and Docker Compose installed. Then, execute the following command in the project root directory::
+
+    $ docker-compose up --build
+
+This will start a containerized PostgreSQL database and run the tests using `tox`.
+
+
+
 Issues with mysql
 -----------------
 
diff --git a/compose.yml b/compose.yml
@@ -0,0 +1,45 @@
+name: django-celeryresult
+
+volumes:
+    postgres_data:
+
+networks:
+    celery:
+
+services:
+    postgres:
+        image: postgres:${POSTGRES_VERSION:-15}
+        container_name: djangoceleryresults-postgres
+        cpus: 0.25
+        mem_limit: 256m
+        mem_reservation: 128m
+        environment:
+            POSTGRES_USER: ${DB_POSTGRES_USER:-postgres}
+            POSTGRES_PASSWORD: ${DB_POSTGRES_PASSWORD:-postgres}
+            POSTGRES_DB: ${DB_POSTGRES_DATABASE:-postgres}
+        volumes:
+            - postgres_data:/var/lib/postgresql/data
+        networks:
+            jazzband:
+                aliases:
+                    - dcr-postgres
+
+    app:
+        build:
+            context: .
+            dockerfile: ./docker/Dockerfile
+        container_name: djangoceleryresults-app
+        cpus: 0.25
+        mem_limit: 512m
+        mem_reservation: 256m
+        environment:
+            DB_POSTGRES_USER: ${DB_POSTGRES_USER:-postgres}
+            DB_POSTGRES_PASSWORD: ${DB_POSTGRES_PASSWORD:-postgres}
+            DB_POSTGRES_DATABASE: ${DB_POSTGRES_DATABASE:-postgres}
+            DB_POSTGRES_HOST: dcr-postgres
+        depends_on:
+            - postgres
+        networks:
+            celery:
+        volumes:
+            - ./:/usr/src/celery/django-celery-results
diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -0,0 +1,74 @@
+FROM python:3.13.3-slim AS base
+
+LABEL authors='Diego Castro <diego.castro@kubicum.com>' \
+    org.opencontainers.image.description='A Docker image to run tests for Django Celery Results using Tox' \
+    org.opencontainers.image.documentation='https://django-celery-results.readthedocs.io/' \
+    org.opencontainers.image.license='BSD-3-Clause' \
+    org.opencontainers.image.source='https://github.com/celery/django-celery-results' \
+    org.opencontainers.image.title='Dockerized Tox suite for Django Celery Results' \
+    org.opencontainers.image.vendor='Celery'
+
+RUN <<EOF
+    apt-get update && apt-get install -y --no-install-recommends \
+        build-essential \
+        curl \
+        wget \
+        gnupg \
+        zlib1g-dev \
+        libbz2-dev \
+        libreadline-dev \
+        libsqlite3-dev \
+        libssl-dev \
+        libffi-dev \
+        libpq-dev \
+        postgresql-client \
+        xz-utils \
+        tk-dev \
+        libncurses5-dev \
+        git \
+        bash && \
+        apt-get clean && rm -rf /var/lib/apt/lists/*
+EOF
+
+ENV PYTHON_VERSIONS="3.12.3 3.11.9 3.10.14 3.9.19 3.8.20" \
+    PYPY_VERSION="pypy3.10-v7.3.19-linux64"
+
+RUN <<EOF
+    for version in $PYTHON_VERSIONS; do
+        VERSION_MAJOR_MINOR=$(echo $version | cut -d. -f1-2) &&
+
+        wget https://www.python.org/ftp/python/${version}/Python-${version}.tgz &&
+        tar -xzf Python-${version}.tgz && cd Python-${version} &&
+
+        ./configure \
+            --prefix=/usr \
+            --enable-optimizations \
+            --with-ensurepip=install \
+            --enable-shared &&
+
+        make -j$(nproc) && make altinstall &&
+        cd .. && rm -rf Python-${version} Python-${version}.tgz &&
+
+        ln -sf /usr/bin/python${VERSION_MAJOR_MINOR} /usr/bin/python${VERSION_MAJOR_MINOR%.*}
+    done
+EOF
+
+RUN <<EOF
+    wget https://downloads.python.org/pypy/${PYPY_VERSION}.tar.bz2 &&
+    mkdir -p /opt/pypy310 &&
+    tar -xjC /opt/pypy310 --strip-components=1 -f ${PYPY_VERSION}.tar.bz2 &&
+    find /opt/pypy310/lib* -depth -type d -a \( -name test -o -name tests \) -exec rm -rf '{}' +;
+
+    rm ${PYPY_VERSION}.tar.bz2 &&
+
+    ln -sf /opt/pypy310/bin/pypy3 /usr/bin/
+    ln -sf /opt/pypy310/bin/pypy3 /usr/bin/pypy3.10
+EOF
+
+RUN pip install --upgrade pip && pip install --no-cache-dir tox
+
+WORKDIR /usr/src/celery/django-celery-results
+
+COPY . .
+
+ENTRYPOINT ["tox"]
diff --git a/docs/injecting_metadata.rst b/docs/injecting_metadata.rst
@@ -1,5 +1,5 @@
 Injecting metadata
-===============
+==================
 
 
 To save arbitrary data on the field TaskResult.meta, the Celery Task Request must be manipulated as such:
diff --git a/t/proj/settings.py b/t/proj/settings.py
@@ -28,20 +28,22 @@
     DATABASES = {
         'default': {
             'ENGINE': 'django.db.backends.postgresql',
-            'HOST': 'localhost',
-            'NAME': 'postgres',
-            'USER': 'postgres',
-            'PASSWORD': 'postgres',
+            'HOST': os.getenv('DB_POSTGRES_HOST', 'localhost'),
+            'PORT': os.getenv('DB_POSTGRES_PORT', '5432'),
+            'NAME': os.getenv('DB_POSTGRES_DATABASE', 'postgres'),
+            'USER': os.getenv('DB_POSTGRES_USER', 'postgres'),
+            'PASSWORD': os.getenv('DB_POSTGRES_PASSWORD', 'postgres'),
             'OPTIONS': {
                 'connect_timeout': 1000,
-            }
+            },
         },
         'secondary': {
             'ENGINE': 'django.db.backends.postgresql',
-            'HOST': 'localhost',
-            'NAME': 'postgres',
-            'USER': 'postgres',
-            'PASSWORD': 'postgres',
+            'HOST': os.getenv('DB_POSTGRES_HOST', 'localhost'),
+            'PORT': os.getenv('DB_POSTGRES_PORT', '5432'),
+            'NAME': os.getenv('DB_POSTGRES_DATABASE', 'postgres'),
+            'USER': os.getenv('DB_POSTGRES_USER', 'postgres'),
+            'PASSWORD': os.getenv('DB_POSTGRES_PASSWORD', 'postgres'),
             'OPTIONS': {
                 'connect_timeout': 1000,
             },
@@ -51,18 +53,19 @@
         },
         'read-only': {
             'ENGINE': 'django.db.backends.postgresql',
-            'HOST': 'localhost',
+            'HOST': os.getenv('DB_POSTGRES_HOST', 'localhost'),
+            'PORT': os.getenv('DB_POSTGRES_PORT', '5432'),
             'NAME': 'read-only-database',
-            'USER': 'postgres',
-            'PASSWORD': 'postgres',
+            'USER': os.getenv('DB_POSTGRES_USER', 'postgres'),
+            'PASSWORD': os.getenv('DB_POSTGRES_PASSWORD', 'postgres'),
             'OPTIONS': {
                 'connect_timeout': 1000,
                 'options': '-c default_transaction_read_only=on',
             },
             'TEST': {
                 'MIRROR': 'default',
             },
-        }
+        },
     }
 except ImportError:
     DATABASES = {
diff --git a/tox.ini b/tox.ini
@@ -23,6 +23,8 @@ DJANGO =
     5.2: django52
 
 [testenv]
+passenv =
+    DB_POSTGRES_*
 deps=
     -r{toxinidir}/requirements/default.txt
     -r{toxinidir}/requirements/test.txt

-Original file line number
+Diff line change
 David Fischer <[email protected]>
 David Ziegler <[email protected]>
 Diego Andres Sanabria Martin <[email protected]>
 +Diego Castro <[email protected]>
 Dmitriy Krasilnikov <[email protected]>
 Donald Stufft <[email protected]>
 Eldon Stegall