docker-compose.yml

networks:
    frontend:
        name: frontend
        external: false
    backend:
        name: backend
        external: false
    backend-test:
        name: backend-test
        external: false

# Base configuration for services that use the local smr image
x-smr-base: &smr-base
    build:
        context: .
        args:
            - NO_DEV
    image: local/smr
    pull_policy: never
    environment: &smr-base-env
        MYSQL_HOST:
        MYSQL_USER:
        MYSQL_DATABASE:
        MYSQL_PASSWORD_FILE: /run/secrets/mysql-password
    secrets:
        - source: mysql-password
          mode: 0444

# Web configuration for `smr` (production) and `smr-dev` (testing).
x-smr-web: &smr-web
    <<: *smr-base
    container_name: ${SMR_HOST}
    networks:
        - frontend
        - backend
    labels:
        - "traefik.enable=true"
        - "traefik.http.routers.${SMR_HOST}.rule=${SMR_RULE:-PathPrefix(`/`)}"
    depends_on:
        - mysql
        - smtp
    environment:
        <<: *smr-base-env
        XDEBUG_MODE:
        DISABLE_PHPDI_COMPILATION:
    # Allow the process to be interruptible with SIGINT.
    # For tests, this may corrupt the test database and require a reset.
    # CLI programs may not be cleaned up properly if interrupted.
    # (see https://github.com/docker-library/php/issues/505)
    init: true

# Base configuration for the SMR command line tools
x-smr-cli: &smr-cli
    <<: *smr-base
    networks:
        - backend
    depends_on:
        - mysql
        - smtp
    volumes:
        - ./config:/smr/config:ro
        # Mount the source code instead of copying it.
        - ./src:/smr/src:ro

# Base configuration for SMR testing tools
x-smr-test: &smr-test
    <<: *smr-base
    environment:
        <<: *smr-base-env
        XDEBUG_MODE: "off"
    volumes:
        - ./config/config.specific.sample.php:/smr/config/config.specific.php:ro
        - ./phpunit.xml:/smr/phpunit.xml:ro
        - ./phpstan.neon.dist:/smr/phpstan.neon.dist:ro
        - ./phpcs.xml:/smr/phpcs.xml:ro
        - ./rector.php:/smr/rector.php:ro
        # Mount the source code instead of copying it.
        - ./src:/smr/src:rw
        - ./test:/smr/test:rw

x-mysql-common: &mysql-common
    image: mysql:8.0
    container_name: ${MYSQL_HOST}
    environment:
        - MYSQL_USER
        - MYSQL_DATABASE
        - MYSQL_PASSWORD_FILE=/run/secrets/mysql-password
        - MYSQL_ROOT_PASSWORD_FILE=/run/secrets/mysql-root-password
    secrets:
        - mysql-password
        - mysql-root-password
    command: [ "mysqld",
               "--character-set-server=utf8",
               "--collation-server=utf8_general_ci" ]
    healthcheck:
        test: mysql -uroot -p$$(cat $$MYSQL_ROOT_PASSWORD_FILE) -e 'SHOW DATABASES'
        interval: 5s
        timeout: 20s

services:
    smr:
        <<: *smr-web
        volumes:
            - ./vol_upload:/smr/src/htdocs/upload:rw
            - ./config:/smr/config:ro

    smr-dev:
        <<: *smr-web
        volumes:
            - ./vol_upload:/smr/src/htdocs/upload:rw
            - ./config:/smr/config:ro
            # Mount the source code instead of copying it.
            - ./src:/smr/src:ro
            # Directory for Xdebug profiler output
            - ./vol_xdebug:/tmp/xdebug:rw

    smtp:
        image: mwader/postfix-relay
        networks:
            - backend
        environment:
            - POSTFIX_myhostname=hostname.local
            - OPENDKIM_DOMAINS=smrealms.de=key1
        volumes:
            - ./opendkim:/etc/opendkim/keys/smrealms.de:rw

    flyway: &flyway-common
        image: flyway/flyway:10.6.0-alpine
        # Allow retries in case the mysql service is still spinning up
        command: migrate
        environment:
            FLYWAY_CONNECT_RETRIES: 20
            FLYWAY_PASSWORD: ${MYSQL_PASSWORD}
            FLYWAY_URL: "jdbc:mysql://${MYSQL_HOST}/${MYSQL_DATABASE}?allowPublicKeyRetrieval=true&useSSL=false"
            FLYWAY_USER: ${MYSQL_USER}
        networks:
            - backend
        depends_on:
            - mysql
        volumes:
            - ./db/patches:/flyway/sql:ro

    flyway-test:
        <<: *flyway-common
        networks:
            - backend-test
        depends_on:
            - mysql-test

    mysql:
        <<: *mysql-common
        networks:
            - backend
        volumes:
            - ./vol_db:/var/lib/mysql:rw

    # MySQL container with no volumes mounted for testing
    mysql-test:
        <<: *mysql-common
        networks:
            - backend-test

    phpunit:
        <<: *smr-test
        entrypoint: vendor/bin/phpunit
        networks:
            - backend-test
        environment:
            <<: *smr-base-env
            XDEBUG_MODE: coverage
        depends_on:
            mysql-test:
                condition: service_healthy

    phpstan:
        <<: *smr-test
        entrypoint: vendor/bin/phpstan --memory-limit=4G --ansi analyse -v

    phpcs:
        <<: *smr-test
        entrypoint: vendor/bin/phpcs --report-code --report-source

    phpcbf:
        <<: *smr-test
        entrypoint: vendor/bin/phpcbf

    rector:
        <<: *smr-test
        entrypoint: vendor/bin/rector process

    pma:
        image: phpmyadmin/phpmyadmin
        networks:
            - frontend
            - backend
        environment:
            PMA_HOST: ${MYSQL_HOST}
            PMA_ABSOLUTE_URI: /pma/
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.pma-${MYSQL_HOST}.rule=${SMR_RULE:-PathPrefix(`/`)} && PathPrefix(`/pma`)"
            - "traefik.http.routers.pma-${MYSQL_HOST}.middlewares=slash-then-strip@file"
        depends_on:
            - mysql

    discord:
        command: php src/tools/discord/bot.php
        <<: *smr-cli

    irc:
        command: php src/tools/irc/irc.php
        <<: *smr-cli

    npc:
        command: php src/tools/npc/npc.php
        <<: *smr-cli

    traefik:
        image: traefik:2.10
        networks:
            - frontend
        volumes:
            - /var/run/docker.sock:/var/run/docker.sock:ro
            - ./traefik:/etc/traefik:ro
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.traefik.rule=PathPrefix(`/api`) || PathPrefix(`/dashboard`)"
            - "traefik.http.routers.traefik.service=api@internal"
            - "traefik.http.routers.traefik.middlewares=add-slash@file"
        ports:
            - "80:80"
            - "443:443"

    # Generate rich API documentation of the SMR source code.
    api-docs:
        build:
            context: .
            dockerfile: ./api-docs/Dockerfile
        networks:
            - frontend
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.api-docs.rule=PathPrefix(`/docs`)"
            - "traefik.http.routers.api-docs.middlewares=slash-then-strip@file"

    # Web interface for managing Docker services
    portainer:
        image: portainer/portainer-ce
        networks:
            - frontend
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.portainer.rule=PathPrefix(`/docker`)"
            - "traefik.http.routers.portainer.middlewares=slash-then-strip@file"
            - "traefik.http.services.portainer.loadbalancer.server.port=9000"
        command: -H unix:///var/run/docker.sock
        volumes:
            - /var/run/docker.sock:/var/run/docker.sock:ro
            - ./vol_portainer:/data:rw

    # Web interface to display Xdebug profiler results
    webgrind:
        image: jokkedk/webgrind
        networks:
            - frontend
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.webgrind.rule=PathPrefix(`/webgrind`)"
            - "traefik.http.routers.webgrind.middlewares=slash-then-strip@file"
        volumes:
            # Webgrind looks for Xdebug profiler files in /tmp by default
            - ./vol_xdebug:/tmp:rw
            # Files mapped under /host will be available for code lookup
            - ./src:/host/smr/src:ro

secrets:
    mysql-password:
        environment: "MYSQL_PASSWORD"
    mysql-root-password:
        environment: "MYSQL_ROOT_PASSWORD"