fix: Refactor Docker commands in scripts (#1282)

Update the Docker commands in the scripts to use the "docker compose" syntax instead of "docker-compose".
Amsterdam-Music-Lab · Sep 24, 2024 · 3490098 · 3490098
1 parent 1ddfcc4
commit 3490098
Show file tree

Hide file tree

Showing 13 changed files with 38 additions and 43 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,16 +11,16 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Run Backend Tests
-        run: sudo docker-compose --env-file .env-github-actions run server bash -c "coverage run manage.py test"
+        run: sudo docker compose --env-file .env-github-actions run server bash -c "coverage run manage.py test"
       - name: Generate Backend Coverage Report (Inline)
-        run: sudo docker-compose --env-file .env-github-actions run server bash -c "coverage report --show-missing"
+        run: sudo docker compose --env-file .env-github-actions run server bash -c "coverage report --show-missing"
 
       # Generate coverage badge (only for main and develop branches)
       - name: Generate Backend Coverage Report (XML) and Badge
         if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop'
         run: |
-          sudo docker-compose --env-file .env-github-actions run server bash -c "coverage xml"
-          sudo docker-compose --env-file .env-github-actions run server bash -c "genbadge coverage -i coverage.xml -o coverage-backend-badge-new.svg -n \"Backend Code Coverage\""
+          sudo docker compose --env-file .env-github-actions run server bash -c "coverage xml"
+          sudo docker compose --env-file .env-github-actions run server bash -c "genbadge coverage -i coverage.xml -o coverage-backend-badge-new.svg -n \"Backend Code Coverage\""
       # Push coverage badge to separate branch (only for main and develop branches)
       - name: Push Backend Coverage Badge to separate branch
         continue-on-error: true
@@ -55,15 +55,15 @@ jobs:
       - uses: actions/checkout@v3
       - name: Lint Backend
         continue-on-error: false
-        run: sudo docker-compose --env-file .env-github-actions run server bash -c "flake8"
+        run: sudo docker compose --env-file .env-github-actions run server bash -c "flake8"
 
   frontend-test:
     name: Test Frontend
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - name: Run Frontend Tests
-        run: sudo docker-compose --env-file .env-github-actions run client yarn test:ci
+        run: sudo docker compose --env-file .env-github-actions run client yarn test:ci
 
   frontend-coverage-badge:
     name: Generate Frontend Coverage Badge
@@ -74,8 +74,8 @@ jobs:
       - uses: actions/checkout@v3
       - name: Generate Frontend Coverage Report (XML) and Badge
         run: |
-          sudo docker-compose --env-file .env-github-actions run client yarn test:ci
-          sudo docker-compose --env-file .env-github-actions run client yarn coverage-badges -s public/coverage/coverage-summary.json -o public/coverage/coverage-frontend-badge-new.svg --label 'Frontend Code Coverage'
+          sudo docker compose --env-file .env-github-actions run client yarn test:ci
+          sudo docker compose --env-file .env-github-actions run client yarn coverage-badges -s public/coverage/coverage-summary.json -o public/coverage/coverage-frontend-badge-new.svg --label 'Frontend Code Coverage'
       - name: Push Frontend Coverage Badge to separate branch
         continue-on-error: true
         run: |
@@ -106,4 +106,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - run: sudo docker-compose --env-file .env-github-actions run client yarn lint
+      - run: sudo docker compose --env-file .env-github-actions run client yarn lint
diff --git a/.github/workflows/podman.yml b/.github/workflows/podman.yml
@@ -79,11 +79,11 @@ jobs:
           echo "VITE_SENTRY_DSN=$FRONTEND_SENTRY_DSN" >> .env
           cp .env frontend/.env
       - name: Build Podman images
-        run: podman-compose -f docker-compose-deploy.yml build
+        run: podman-compose -f docker compose-deploy.yml build
       - name: Shut down running containers
-        run: podman compose -f docker-compose-deploy.yml down
+        run: podman compose -f docker compose-deploy.yml down
       - name: Deploy Podman images
-        run: podman-compose -f docker-compose-deploy.yml up -d
+        run: podman-compose -f docker compose-deploy.yml up -d
       - name: Notify Sentry of new release
         run: |
             curl -X POST "https://sentry.io/api/0/organizations/uva-aml/releases/" \
@@ -101,9 +101,9 @@ jobs:
       - name: Prune old images
         run: podman image prune -a -f
       - name: Check Podman images
-        run: podman-compose -f docker-compose-deploy.yml ps
+        run: podman-compose -f docker compose-deploy.yml ps
       - name: Check logs
-        run: podman-compose -f docker-compose-deploy.yml logs
+        run: podman-compose -f docker compose-deploy.yml logs
 
   deploy-acceptance:
     name: Deploy to acceptance environment
@@ -171,11 +171,11 @@ jobs:
           echo "VITE_SENTRY_DSN=$FRONTEND_SENTRY_DSN" >> .env
           cp .env frontend/.env
       - name: Build Podman images
-        run: podman-compose -f docker-compose-deploy.yml build
+        run: podman-compose -f docker compose-deploy.yml build
       - name: Shut down running containers
-        run: podman compose -f docker-compose-deploy.yml down
+        run: podman compose -f docker compose-deploy.yml down
       - name: Deploy Podman images
-        run: podman-compose -f docker-compose-deploy.yml up -d
+        run: podman-compose -f docker compose-deploy.yml up -d
       - name: Notify Sentry of new release
         run: |
           curl -X POST "https://sentry.io/api/0/organizations/uva-aml/releases/" \
@@ -193,9 +193,9 @@ jobs:
       - name: Prune old images
         run: podman image prune -a -f
       - name: Check Podman images
-        run: podman-compose -f docker-compose-deploy.yml ps
+        run: podman-compose -f docker compose-deploy.yml ps
       - name: Check logs
-        run: podman-compose -f docker-compose-deploy.yml logs
+        run: podman-compose -f docker compose-deploy.yml logs
 
   deploy-production:
     name: Deploy to production environment
@@ -260,11 +260,11 @@ jobs:
           echo "VITE_SENTRY_DSN=$FRONTEND_SENTRY_DSN" >> .env
           cp .env frontend/.env
       - name: Build Podman images
-        run: podman-compose -f docker-compose-deploy.yml build
+        run: podman-compose -f docker compose-deploy.yml build
       - name: Shut down running containers
-        run: podman compose -f docker-compose-deploy.yml down
+        run: podman compose -f docker compose-deploy.yml down
       - name: Deploy Podman images
-        run: podman-compose -f docker-compose-deploy.yml up -d
+        run: podman-compose -f docker compose-deploy.yml up -d
       - name: Notify Sentry of new release
         run: |
           curl -X POST "https://sentry.io/api/0/organizations/uva-aml/releases/" \
@@ -282,7 +282,7 @@ jobs:
       - name: Prune old images
         run: podman image prune -a -f
       - name: Check Podman images
-        run: podman-compose -f docker-compose-deploy.yml ps
+        run: podman-compose -f docker compose-deploy.yml ps
 
   e2e-acceptance:
     name: E2E tests on acceptance environment

diff --git a/README.md b/README.md
@@ -30,22 +30,22 @@ Install [Docker Desktop](https://docs.docker.com/desktop/).
 Make a copy of [the file](https://github.com/Amsterdam-Music-Lab/MUSCLE/blob/develop/.env.dist) `.env.dist` (in the same directory as this README) and rename it to `.env.` This file contains variables used by Docker to start up a container network serving MUSCLE.
 
 Start Docker (the app icon is a whale carrying containers). Then, open a terminal and run
-`docker-compose up` (add `sudo` on Linux).
-This command starts up the containers defined in `docker-compose.yaml`:
+`docker compose up` (add `sudo` on Linux).
+This command starts up the containers defined in `docker compose.yaml`:
 - a PostgreSQL container, for storing experiment/user/playlist data, saved on the host machine in the Docker user data, represented in the volume `db_data`. Data added to the database will persist if the container is shut down.
 - a ip2country container, which provides country codes for ip addresses, used for demographic information of users.
 - a container of the server, defined in DockerfileDevelop in `backend`. The Dockerfile defines the Python version and installs development dependencies. The startup command runs migrations and then starts up a Django development server.
 - a container of the client, defined in DockerfileDevelop in `frontend`. The Dockerfile defines the node version and installs node modules. The startup command kicks off a React development server.
 
 Once you see all containers have started up, open your browser and navigate to [localhost:3000](http://localhost:3000). You should now be able to see the first screen of the Goldsmiths Musical Sophistication Index questionnaire.
 
-Since the `docker-compose.yaml` defines bind mounts for `backend` and `frontend`, any changes to the files on the host are immediately reflected in the containers, which means code watching works and hot reload works in the same way as with a native node or Django server.
+Since the `docker compose.yaml` defines bind mounts for `backend` and `frontend`, any changes to the files on the host are immediately reflected in the containers, which means code watching works and hot reload works in the same way as with a native node or Django server.
 
 To stop the containers, press `ctrl-c` or (in another terminal) run
-`docker-compose down`.
+`docker compose down`.
 
 ## Production build
-A production build should define its own `docker-compose.yaml`, making use of the `Dockerfile` of the `backend` and `frontend` environments. It should also define a custom .env file, with safe passwords for the SQL database and the Python backend. Instead of mounting the entire backend and frontend directory and using the development servers, the backend should serve with gunicorn, and the frontend should use a build script to compile static html, css and JavaScript.
+A production build should define its own `docker compose.yaml`, making use of the `Dockerfile` of the `backend` and `frontend` environments. It should also define a custom .env file, with safe passwords for the SQL database and the Python backend. Instead of mounting the entire backend and frontend directory and using the development servers, the backend should serve with gunicorn, and the frontend should use a build script to compile static html, css and JavaScript.
 
 ## Troubleshooting
 

diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -1,4 +1,4 @@
-# Docker-compose definition for development
+# docker compose definition for development
 
 version: '2.4'
 

diff --git a/scripts/build-front b/scripts/build-front
@@ -1,3 +1,2 @@
 #!/bin/bash
-docker-compose run --rm client yarn build
-
+docker compose run --rm client yarn build
diff --git a/scripts/lint-back b/scripts/lint-back
@@ -1,2 +1,2 @@
 #!/bin/bash
-docker-compose run --rm server bash -c "flake8"
+docker compose run --rm server bash -c "flake8"
diff --git a/scripts/lint-front b/scripts/lint-front
@@ -1,2 +1,2 @@
 #!/bin/bash
-docker-compose run --rm client yarn lint $@
+docker compose run --rm client yarn lint $@
diff --git a/scripts/manage b/scripts/manage
@@ -1,4 +1,4 @@
 #!/bin/bash
 
 # This script executes Django management commands through Docker.
-docker-compose run --rm server python manage.py $@
+docker compose run --rm server python manage.py $@
diff --git a/scripts/test-back b/scripts/test-back
@@ -1,3 +1,2 @@
 #!/bin/bash
-docker-compose run --rm server bash -c "python manage.py test $@"
-
+docker compose run --rm server bash -c "python manage.py test $@"
diff --git a/scripts/test-back-coverage b/scripts/test-back-coverage
@@ -1,3 +1,2 @@
 #!/bin/bash
-docker-compose run --rm server bash -c "coverage run manage.py test && coverage report --show-missing"
-
+docker compose run --rm server bash -c "coverage run manage.py test && coverage report --show-missing"
diff --git a/scripts/test-front b/scripts/test-front
@@ -1,3 +1,2 @@
 #!/bin/bash
-docker-compose run --rm client yarn test --watch=false
-
+docker compose run --rm client yarn test --watch=false
diff --git a/scripts/test-front-ci b/scripts/test-front-ci
@@ -1,2 +1,2 @@
 #!/bin/bash
-docker-compose run --rm client yarn test:ci
+docker compose run --rm client yarn test:ci
diff --git a/scripts/test-front-watch b/scripts/test-front-watch
@@ -1,3 +1,2 @@
 #!/bin/bash
-docker-compose run --rm client yarn test --watch=true
-
+docker compose run --rm client yarn test --watch=true