Merge pull request #216 from crazy-max/compose-stack-test

ci: use compose stack for testing

.github/workflows/build.yml

@@ -1,7 +1,7 @@
 name: build
 
 concurrency:
-  group: build-${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 on:
@@ -13,8 +13,6 @@ on:
     paths-ignore:
       - '**.md'
   pull_request:
-    branches:
-      - 'master'
     paths-ignore:
       - '**.md'
 

.github/workflows/labels.yml

@@ -1,5 +1,9 @@
 name: labels
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:

.github/workflows/test.yml

@@ -1,14 +1,16 @@
 name: test
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:
       - 'master'
     paths-ignore:
       - '**.md'
   pull_request:
-    branches:
-      - 'master'
     paths-ignore:
       - '**.md'
 
@@ -36,43 +38,22 @@ jobs:
           targets: image-local
         env:
           DEFAULT_TAG: ${{ env.BUILD_TAG }}
-      -
-        name: Create network
-        run: |
-          docker network create -d bridge ${{ env.CONTAINER_NAME }}
-      -
-        name: Start MariaDB container
-        run: |
-          docker run -d --name mariadb --hostname mariadb \
-            --network ${{ env.CONTAINER_NAME }} \
-            -e "MYSQL_ALLOW_EMPTY_PASSWORD=yes" \
-            -e "MYSQL_DATABASE=anonaddy" \
-            -e "MYSQL_USER=anonaddy" \
-            -e "MYSQL_PASSWORD=anonaddy" \
-            mariadb:10.5
       -
         name: Generate DKIM private key
         run: |
-          docker run --rm -t --entrypoint "" \
-            -e "ANONADDY_DOMAIN=example.com" \
-            -v "/tmp/data:/data" \
-            ${{ env.BUILD_TAG }} gen-dkim
+          docker compose run --rm gen-dkim
+        working-directory: test
+        env:
+          ANONADDY_IMAGE: ${{ env.BUILD_TAG }}
+          ANONADDY_CONTAINER: ${{ env.CONTAINER_NAME }}
       -
-        name: Start container
+        name: Start
         run: |
-          docker run -d --name ${{ env.CONTAINER_NAME }} \
-            --link mariadb \
-            --network ${{ env.CONTAINER_NAME }} \
-            -e "DB_HOST=mariadb" \
-            -e "DB_DATABASE=anonaddy" \
-            -e "DB_USERNAME=anonaddy" \
-            -e "DB_PASSWORD=anonaddy" \
-            -e "APP_KEY=base64:Gh8/RWtNfXTmB09pj6iEflt/L6oqDf9ZxXIh4I9MS7A=" \
-            -e "ANONADDY_DOMAIN=example.com" \
-            -e "ANONADDY_SECRET=0123456789abcdefghijklmnopqrstuvwxyz" \
-            -e "RSPAMD_ENABLE=true" \
-            -v "/tmp/data:/data" \
-            ${{ env.BUILD_TAG }}
+          docker compose up -d
+        working-directory: test
+        env:
+          ANONADDY_IMAGE: ${{ env.BUILD_TAG }}
+          ANONADDY_CONTAINER: ${{ env.CONTAINER_NAME }}
       -
         name: Check container logs
         uses: crazy-max/.github/.github/actions/container-logs-check@main
@@ -81,8 +62,11 @@ jobs:
           log_check: "ready to handle connections"
           timeout: 120
       -
-        name: Container logs
+        name: Logs
         if: always()
         run: |
-          docker logs ${{ env.CONTAINER_NAME }}
-          docker rm -f ${{ env.CONTAINER_NAME }} > /dev/null 2>&1 || true
+          docker compose logs
+        working-directory: test
+        env:
+          ANONADDY_IMAGE: ${{ env.BUILD_TAG }}
+          ANONADDY_CONTAINER: ${{ env.CONTAINER_NAME }}

README.md

@@ -227,11 +227,11 @@ Image: anonaddy/anonaddy:latest
 ### Docker Compose
 
 Docker compose is the recommended way to run this image. You can use the following
-[docker compose template](examples/compose/docker-compose.yml), then run the container:
+[docker compose template](examples/compose/compose.yml), then run the container:
 
 ```console
-docker-compose up -d
-docker-compose logs -f
+docker compose up -d
+docker compose logs -f
 ```
 
 ## Upgrade
@@ -240,8 +240,8 @@ You can upgrade AnonAddy automatically through the UI, it works well. But I
 recommend to recreate the container whenever I push an update:
 
 ```console
-docker-compose pull
-docker-compose up -d
+docker compose pull
+docker compose up -d
 ```
 
 ## Notes
@@ -252,25 +252,25 @@ If you want to use the artisan command to perform common server operations like
 manage users, passwords and more, type:
 
 ```console
-docker-compose exec anonaddy anonaddy <command>
+docker compose exec anonaddy anonaddy <command>
 ```
 
 For example to list all available commands:
 
 ```console
-docker-compose exec anonaddy anonaddy list
+docker compose exec anonaddy anonaddy list
 ```
 
 ### Create user
 
 ```console
-docker-compose exec anonaddy anonaddy anonaddy:create-user "username" "webmaster@example.com"
+docker compose exec anonaddy anonaddy anonaddy:create-user "username" "webmaster@example.com"
 ```
 
 ### Generate DKIM private/public keypair
 
 ```console
-docker-compose run --entrypoint '' anonaddy gen-dkim
+docker compose run --entrypoint '' anonaddy gen-dkim
 ```
 
 ```text
@@ -291,7 +291,7 @@ If you don't have an existing GPG key, you can generate a new GPG key with the
 following command:
 
 ```console
-docker-compose exec --user anonaddy anonaddy gpg --full-gen-key
+docker compose exec --user anonaddy anonaddy gpg --full-gen-key
 ```
 
 Keys will be stored in `/data/.gnupg` folder.

examples/compose/docker-compose.yml → examples/compose/compose.yml

@@ -1,4 +1,4 @@
-version: "3.5"
+name: annoaddy
 
 services:
   db:

examples/nginx/README.md

@@ -15,8 +15,8 @@ sudo openssl dhparam -out dhparam.pem 4096
 
 ## Configure mounts for nginx
 
-The `docker-compose.yml` may need some adjusting to properly mount your
-specific let's encrypt and dhparam certs.
+The `compose.yml` may need some adjusting to properly mount your specific
+let's encrypt and dhparam certs.
 
 ## Rspamd web ui
 

examples/nginx/docker-compose.yml → examples/nginx/compose.yml

@@ -1,4 +1,4 @@
-version: "3.5"
+name: annoaddy
 
 services:
   db:

examples/rspamd/docker-compose.yml → examples/rspamd/compose.yml

@@ -1,4 +1,4 @@
-version: "3.5"
+name: annoaddy
 
 services:
   db:

examples/traefik/README.md

@@ -3,6 +3,6 @@
 ```bash
 touch acme.json
 chmod 600 acme.json
-docker-compose up -d
-docker-compose logs -f
+docker compose up -d
+docker compose logs -f
 ```

examples/traefik/docker-compose.yml → examples/traefik/compose.yml

@@ -1,4 +1,4 @@
-version: "3.5"
+name: annoaddy
 
 services:
   traefik:

test/.env

@@ -0,0 +1,3 @@
+MYSQL_DATABASE=anonaddy
+MYSQL_USER=anonaddy
+MYSQL_PASSWORD=anonaddy

test/anonaddy.env

@@ -0,0 +1,36 @@
+TZ=Europe/Paris
+PUID=1000
+PGID=1000
+
+MEMORY_LIMIT=256M
+UPLOAD_MAX_SIZE=16M
+OPCACHE_MEM_SIZE=128
+REAL_IP_FROM=0.0.0.0/32
+REAL_IP_HEADER=X-Forwarded-For
+LOG_IP_VAR=remote_addr
+
+APP_KEY=base64:Gh8/RWtNfXTmB09pj6iEflt/L6oqDf9ZxXIh4I9MS7A=
+APP_DEBUG=false
+APP_URL=http://127.0.0.1:8000
+
+ANONADDY_RETURN_PATH=bounces@example.com
+ANONADDY_ADMIN_USERNAME=anonaddy
+ANONADDY_ENABLE_REGISTRATION=true
+ANONADDY_DOMAIN=example.com
+ANONADDY_ALL_DOMAINS=example.com
+ANONADDY_HOSTNAME=mail.example.com
+ANONADDY_DNS_RESOLVER=127.0.0.1
+ANONADDY_SECRET=0123456789abcdefghijklmnopqrstuvwxyz
+ANONADDY_LIMIT=200
+ANONADDY_BANDWIDTH_LIMIT=104857600
+ANONADDY_NEW_ALIAS_LIMIT=10
+ANONADDY_ADDITIONAL_USERNAME_LIMIT=3
+
+MAIL_FROM_NAME=AnonAddy
+MAIL_FROM_ADDRESS=anonaddy@example.com
+
+POSTFIX_DEBUG=false
+POSTFIX_SMTPD_TLS=false
+POSTFIX_SMTP_TLS=false
+
+RSPAMD_ENABLE=true

test/compose.yml

@@ -0,0 +1,73 @@
+name: annoaddy
+
+services:
+  db:
+    image: mariadb:10.5
+    container_name: anonaddy_db
+    networks:
+      - anonaddy
+    command:
+      - "mysqld"
+      - "--character-set-server=utf8mb4"
+      - "--collation-server=utf8mb4_unicode_ci"
+    volumes:
+      - "db:/var/lib/mysql"
+    environment:
+      - "MYSQL_ALLOW_EMPTY_PASSWORD=yes"
+      - "MYSQL_DATABASE"
+      - "MYSQL_USER"
+      - "MYSQL_PASSWORD"
+    restart: always
+
+  redis:
+    image: redis:4.0-alpine
+    container_name: anonaddy_redis
+    networks:
+      - anonaddy
+    restart: always
+
+  anonaddy:
+    image: ${ANONADDY_IMAGE:-anonaddy/anonaddy}
+    container_name: ${ANONADDY_CONTAINER:-anonaddy}
+    depends_on:
+      - db
+      - redis
+    networks:
+      - anonaddy
+    ports:
+      - target: 25
+        published: 25
+        protocol: tcp
+      - target: 8000
+        published: 8000
+        protocol: tcp
+    volumes:
+      - "anonaddy:/data"
+    env_file:
+      - "./anonaddy.env"
+    environment:
+      - "DB_HOST=db"
+      - "DB_DATABASE=${MYSQL_DATABASE}"
+      - "DB_USERNAME=${MYSQL_USER}"
+      - "DB_PASSWORD=${MYSQL_PASSWORD}"
+      - "REDIS_HOST=redis"
+    restart: always
+
+  gen-dkim:
+    image: ${ANONADDY_IMAGE:-anonaddy/anonaddy}
+    profiles: ["bootstrap"]
+    entrypoint: ''
+    command: gen-dkim
+    volumes:
+      - "anonaddy:/data"
+    env_file:
+      - "./anonaddy.env"
+    restart: no
+
+volumes:
+  db:
+  anonaddy:
+
+networks:
+  anonaddy:
+    name: anonaddy