Refactor Dockerfile to use Poetry for dependency management and add health check to production image

Author: coolbeevip

.github/workflows/pr.yml

@@ -17,33 +17,33 @@ on:
       - ".github/workflows/**"
 
 jobs:
-  lint:
+  ruff:
     runs-on: ubuntu-latest
     steps:
       - name: Check Out Repo
         uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: '3.9'
           cache: 'pip'
       - name: Install Dependencies
-        run: make init
-      - name: Run Linter
-        run: make lint
+        run: pip install -e .
+      - name: Run ruff
+        run: poetry run ruff check
 
   test:
-    needs: lint
+    needs: ruff
     runs-on: ubuntu-latest
     steps:
       - name: Check Out Repo
         uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: '3.9'
           cache: 'pip'
       - name: Install Dependencies
-        run: make init
+        run: pip install -e .
       - name: Run Tests
-        run: make test
+        run: poetry run pytest tests

Dockerfile

@@ -12,17 +12,26 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FROM python:3.9-buster as builder
+FROM python:3.9-buster AS builder
 
 WORKDIR /usr/app
+
+# Create and activate virtual environment
 RUN python -m venv /usr/app/venv
 ENV PATH="/usr/app/venv/bin:$PATH"
 
-COPY requirements.txt .
-RUN pip install -r requirements.txt
+# Install dependencies
+COPY poetry.lock pyproject.toml ./
+# Install dependencies only (no dev dependencies)
+RUN poetry export -f requirements.txt | pip install -r /dev/stdin
+
+# Install project
+COPY . .
+RUN pip install -e .
 
-FROM python:3.9-slim as production
+FROM python:3.9-slim AS production
 
+# Set environment variables in separate layers for better caching
 ENV BOT_LANGUAGE="en" \
     BOT_HOST="0.0.0.0" \
     BOT_PORT=9998 \
@@ -32,9 +41,16 @@ ENV BOT_LANGUAGE="en" \
     BOT_GITLAB_MERGE_REQUEST_MILESTONE_REQUIRED=false
 
 WORKDIR /usr/app
+
+# Copy only necessary files from builder
 COPY --from=builder /usr/app/venv ./venv
 COPY src src
 COPY gitlab_bot.py gitlab_bot.py
 
 ENV PATH="/usr/app/venv/bin:$PATH"
+
+# Health check
+HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
+  CMD curl -f http://localhost:${BOT_PORT}/ || exit 1
+
 CMD [ "python", "gitlab_bot.py" ]

Makefile

@@ -1,22 +1,20 @@
 init:
-	pip install . '.[lint]' '.[test]' '.[package]'
+	@pip install -e .
 
 lint:
-	@pflake8 ./src ./tests ./gitlab_bot.py || (echo "Run 'make fmt' to fix the issues" && exit 1)
-	@black --check ./src ./tests ./gitlab_bot.py || (echo "Run 'make fmt' to fix the issues" && exit 1)
+	@poetry run ruff check
 
 fmt:
-	@black ./src ./tests ./gitlab_bot.py
-	@isort --profile black ./src ./tests ./gitlab_bot.py
+	@poetry run ruff format
 
 test: lint
-	@pytest --cov=src tests
+	@poetry run pytest tests
 
 i18n:
 	xgettext -d base -o src/locales/gitlab-bot.pot *.py
 	msgfmt -o src/locales/en/LC_MESSAGES/gitlab-bot.mo src/locales/en/LC_MESSAGES/gitlab-bot.po
 	msgfmt -o src/locales/zh/LC_MESSAGES/gitlab-bot.mo src/locales/zh/LC_MESSAGES/gitlab-bot.po
 
-docker-build:
+docker:
 	export DOCKER_BUILDKIT=1
 	docker build -t coolbeevip/gitlab-bot --cache-from coolbeevip/gitlab-bot --build-arg BUILDKIT_INLINE_CACHE=1 .

gitlab_bot.py

@@ -31,7 +31,9 @@
 from src.merge_request_hook import MergeRequestHooks
 from src.note_hook import NoteHooks
 
-bot = GitLabBot(bot_gitlab_username, url=bot_gitlab_url, access_token=bot_gitlab_token)
+bot = GitLabBot(
+    bot_gitlab_username, url=bot_gitlab_url, access_token=bot_gitlab_token
+)
 
 issue_hooks = IssueHooks()
 merge_request_hooks = MergeRequestHooks()
@@ -65,25 +67,33 @@ async def note_issue_event(event, gl, *args, **kwargs):
 @bot.router.register("Merge Request Hook", action="open")
 async def merge_request_opened_event(event, gl, *args, **kwargs):
     if not ignore_event(event):
-        await merge_request_hooks.merge_request_opened_event(event, gl, args, kwargs)
+        await merge_request_hooks.merge_request_opened_event(
+            event, gl, args, kwargs
+        )
 
 
 @bot.router.register("Merge Request Hook", action="update")
 async def merge_request_updated_event(event, gl, *args, **kwargs):
     if not ignore_event(event):
-        await merge_request_hooks.merge_request_updated_event(event, gl, args, kwargs)
+        await merge_request_hooks.merge_request_updated_event(
+            event, gl, args, kwargs
+        )
 
 
 @bot.router.register("Merge Request Hook", action="reopen")
 async def merge_request_reopen_event(event, gl, *args, **kwargs):
     if not ignore_event(event):
-        await merge_request_hooks.merge_request_reopen_event(event, gl, args, kwargs)
+        await merge_request_hooks.merge_request_reopen_event(
+            event, gl, args, kwargs
+        )
 
 
 @bot.router.register("Note Hook", noteable_type="MergeRequest")
 async def note_merge_request_event(event, gl, *args, **kwargs):
     if not ignore_event(event):
-        await merge_request_hooks.note_merge_request_event(event, gl, args, kwargs)
+        await merge_request_hooks.note_merge_request_event(
+            event, gl, args, kwargs
+        )
 
 
 @bot.router.register("Note Hook", noteable_type="Commit")
@@ -104,7 +114,9 @@ def ignore_event(event) -> bool:
     if username != bot_gitlab_username:
         return False
     else:
-        logging.info("Ignore event: %s triggered by admin", event.data["event_type"])
+        logging.info(
+            "Ignore event: %s triggered by admin", event.data["event_type"]
+        )
         return True