Switch to docker compose command, fix tests (#855)

* Switch to docker compose cmd

* Update versions in pre-commit

* Update inner pre commit config

* Bump upload artifact

* Remove version from docker compose config

* fix test script, remove extra package

Author: gaganpreet

.github/workflows/cookiecutter-project-test.yml

@@ -39,11 +39,11 @@ jobs:
       if: ${{ always() }}
       run: |
         cd ./test-project
-        docker-compose logs -t
+        docker compose logs -t
 
     - name: Archive cypress screenshots
       if: always()
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: cypress-screenshots
         path: |

.pre-commit-config.yaml

@@ -1,21 +1,21 @@
 exclude: "(src/generated/|alembic/versions|test.yaml)"
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
 
   # Backend hooks
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 25.1.0
     hooks:
       - id: black
         files: backend/
         types: [file, python]
   - repo: https://github.com/myint/autoflake
-    rev: v1.4
+    rev: v2.3.1
     hooks:
       - id: autoflake
         args:
@@ -25,7 +25,7 @@ repos:
         types: [file, python]
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.11.5
+    rev: 6.0.1
     hooks:
       - id: isort
         name: isort (python)
@@ -42,7 +42,7 @@ repos:
         types: [pyi]
 
   - repo: https://github.com/pycqa/flake8
-    rev: 3.8.3
+    rev: 7.1.2
     hooks:
       - id: flake8
         files: backend/

scripts/test.sh

@@ -2,8 +2,8 @@
 
 set -eou pipefail
 
-# Stop containers from previous run, if any
-(cd ./test-project && docker-compose -f docker-compose.yml down --rmi local -v && cd ..) || true
+# Stop containers from prlibasound2evious run, if any
+(cd ./test-project && docker compose -f docker-compose.yml down --rmi local -v && cd ..) || true
 
 # Run this from the root of the project
 rm -rf ./test-project
@@ -13,24 +13,24 @@ cookiecutter --no-input -f ./ project_slug="test-project" project_name="Test pro
 cd ./test-project/
 
 # Start docker containers
-docker-compose -f docker-compose.yml up -d --build
+docker compose -f docker-compose.yml up -d --build
 
 
 # Run backend tests
-docker-compose exec -T postgres createdb -U postgres apptest
+docker compose exec -T postgres createdb -U postgres apptest
 
-docker-compose exec -T backend pytest -v --cov --cov-report term-missing
+docker compose exec -T backend pytest -v --cov --cov-report term-missing
 
 # Run cypress tests
-docker-compose exec -T backend alembic upgrade head
+docker compose exec -T backend alembic upgrade head
 
-docker-compose exec -T backend alembic check
+docker compose exec -T backend alembic check
 
 docker build --target build -t frontend-build:latest frontend
 
 mv $(pwd)/frontend/src/generated /tmp/src-generated
 
-PACKAGE_LIST="xvfb libnss3 libatk1.0 libatk-bridge2.0 libgtk-3.0 libgbm1 libasound2 default-jre"
+PACKAGE_LIST="xvfb libnss3 libatk1.0 libatk-bridge2.0 libgtk-3.0 libgbm1 default-jre"
 # If GITHUB_REPOSITORY is not set, then we can just run it in docker
 # We need to have two paths here because Github CI works weirdly with bind mounts that we can use to run the tests locally in Docker
 if [ -z "${GITHUB_REPOSITORY-}" ]

{{cookiecutter.project_slug}}/.pre-commit-config.yaml

@@ -1,21 +1,21 @@
 exclude: "(frontend/src/generated/|backend/alembic/versions/)"
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
 
   # Backend hooks
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 25.1.0
     hooks:
       - id: black
         files: backend/
         types: [file, python]
   - repo: https://github.com/myint/autoflake
-    rev: v1.4
+    rev: v2.3.1
     hooks:
       - id: autoflake
         args:
@@ -25,7 +25,7 @@ repos:
         types: [file, python]
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.11.5
+    rev: 6.0.1
     hooks:
       - id: isort
         name: isort (python)
@@ -42,7 +42,7 @@ repos:
         types: [pyi]
 
   - repo: https://github.com/pycqa/flake8
-    rev: 3.8.3
+    rev: 7.1.2
     hooks:
       - id: flake8
         files: backend/

{{cookiecutter.project_slug}}/README.md

@@ -16,16 +16,16 @@ The frontend of this project uses React Admin. Follow the quick tutorial to unde
 
 ## Step 1: Getting started
 
-Start a local development instance with docker-compose
+Start a local development instance with docker compose
 
 ```bash
-docker-compose up -d
+docker compose up -d
 
 # Run database migration
-docker-compose exec backend alembic upgrade head
+docker compose exec backend alembic upgrade head
 
 # Create database used for testing
-docker-compose exec postgres createdb apptest -U postgres
+docker compose exec postgres createdb apptest -U postgres
 ```
 
 Now you can navigate to the following URLs:
@@ -43,10 +43,10 @@ pre-commit install
 
 ### Local development
 
-The backend setup of docker-compose is set to automatically reload the app whenever code is updated. However, for frontend it's easier to develop locally.
+The backend setup of docker compose is set to automatically reload the app whenever code is updated. However, for frontend it's easier to develop locally.
 
 ```bash
-docker-compose stop frontend
+docker compose stop frontend
 cd frontend
 yarn
 yarn start
@@ -66,7 +66,7 @@ Don't forget to edit the `.env` file and update the `BACKEND_CORS_ORIGINS` value
 If you add a dependency, you'll need to rebuild your containers like this:
 
 ```bash
-docker-compose up -d --build
+docker compose up -d --build
 ```
 
 ### Regenerate front-end API package
@@ -83,24 +83,24 @@ These two are the most used commands when working with alembic. For more info, f
 
 ```bash
 # Auto generate a revision
-docker-compose exec backend alembic revision --autogenerate -m 'message'
+docker compose exec backend alembic revision --autogenerate -m 'message'
 
 # Apply latest changes
-docker-compose exec backend alembic upgrade head
+docker compose exec backend alembic upgrade head
 ```
 
 ### Backend tests
 
 The `Backend` service uses a hardcoded database named `apptest`. First, ensure that it's created
 
 ```bash
-docker-compose exec postgres createdb apptest -U postgres
+docker compose exec postgres createdb apptest -U postgres
 ```
 
 Then you can run tests with this command:
 
 ```bash
-docker-compose run backend pytest --cov --cov-report term-missing
+docker compose run backend pytest --cov --cov-report term-missing
 ```
 
 ### Single docker image

{{cookiecutter.project_slug}}/backend/app/api/items.py

@@ -37,9 +37,9 @@ async def get_items(
         .scalars()
         .all()
     )
-    response.headers[
-        "Content-Range"
-    ] = f"{request_params.skip}-{request_params.skip + len(items)}/{total}"
+    response.headers["Content-Range"] = (
+        f"{request_params.skip}-{request_params.skip + len(items)}/{total}"
+    )
     return items
 
 

{{cookiecutter.project_slug}}/docker-compose.ci.yml

@@ -1,5 +1,3 @@
-version: "3.9"
-
 services:
   backend:
     image: "{{ cookiecutter.project_slug }}-backend:latest"

{{cookiecutter.project_slug}}/docker-compose.override.yml

@@ -1,6 +1,5 @@
 # We specify volumes in override.yml, because volumes don't work well in a
 # docker-in-docker setup (the paths of parent host rarely match the nested containers)
-version: "3.9"
 
 services:
   postgres:

{{cookiecutter.project_slug}}/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.9"
-
 services:
   postgres:
     image: postgres:12