feat: add linter

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: Linter
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Create environment file
+        run: |
+          echo "POSTGRES_HOST=${{ secrets.POSTGRES_HOST }}" > .env
+          echo "POSTGRES_PORT=${{ secrets.POSTGRES_PORT }}" >> .env
+          echo "POSTGRES_DB=${{ secrets.POSTGRES_DB }}" >> .env
+          echo "POSTGRES_USER=${{ secrets.POSTGRES_USER }}" >> .env
+          echo "POSTGRES_PASSWORD=${{ secrets.POSTGRES_PASSWORD }}" >> .env
+
+      - name: Run linter
+        run: |
+          setsid ./ci/lint.sh

.gitlab-ci.yml

@@ -1,5 +1,6 @@
 stages:
   - test
+  - lint
 
 unit_test:
   stage: test
@@ -21,4 +22,15 @@ integration_test:
       - /^(main|develop.*)$/
       - merge_requests
   tags:
-    - imagesbuilder
+    - imagesbuilder
+
+lint:
+  stage: lint
+  script:
+    - setsid ./ci/lint.sh
+  only:
+    refs:
+      - /^(main|develop.*)$/
+      - merge_requests
+  tags:
+    - imagesbuilder

Dockerfile

@@ -32,4 +32,10 @@ FROM api AS unit_tests
 
 WORKDIR /app/src
 
-CMD ["python", "-m", "unittest", "discover", "-s", "./unit_tests", "-p", "test_*.py", "-v"]
+CMD ["python", "-m", "unittest", "discover", "-s", "./unit_tests", "-p", "test_*.py", "-v"]
+
+FROM api AS linter
+
+WORKDIR /app/src
+
+CMD ["ruff", "check", "--fix", "."]

README.md

@@ -169,6 +169,18 @@ Here's how to run the integration test locally:
 ```shell
 docker-compose up --build --abort-on-container-exit mercury_unit_tests
 ```
+
+## Linter
+
+Having a fast linter can help avoiding coding style problems, and potentially avoid future bugs that takes long hours to fix.  
+For the linter we're working with [ruff](https://astral.sh/ruff), a very fast linter written in Rust.
+
+Here's how to run the linter test locally:
+
+```shell
+docker-compose up --build --abort-on-container-exit mercury_linter
+```
+
 -------
 
 ## Contributions

ci/lint.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+docker-compose up --build --abort-on-container-exit mercury_linter

docker-compose.yml

@@ -61,6 +61,14 @@ services:
       target: unit_tests
     env_file:
       - .env
+  mercury_linter:
+    image: cwcloud-linter:latest
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+      target: linter
+    env_file:
+      - .env
 
 volumes:
   mercurydb:

requirements.txt

@@ -9,4 +9,5 @@ bcrypt
 python-jose[cryptography]
 passlib[bcrypt]
 python-multipart
-pytest
+pytest
+ruff