.ahoy.yml

#
# Ahoy configuration file.
# http://www.ahoycli.com/
#
# Provides development experience shortcuts to work with the stack.
# Any command can be copy-pasted directly into terminal and ran without using
# Ahoy.
#
# Do not add values directly into this file. Use .env file instead.
# Run `ahoy up cli` to apply environment variables changes to containers.
---
ahoyapi: v2

commands:

  build:
    usage: Build or rebuild the project.
    cmd: |
      ahoy reset                          # Reset the project.
      ahoy up --build --force-recreate    # Start the stack.
      ahoy composer install               # Install Composer dependencies.
      ahoy fei                            # Install front-end dependencies.
      ahoy fe                             # Build front-end assets.
      ahoy provision                      # Provision the site.
      VORTEX_SHOW_LOGIN=1 ahoy info       # Show information and a login link.

  info:
    usage: Show information about this project.
    cmd: |
      COMPOSE_PROJECT_NAME=${COMPOSE_PROJECT_NAME:-${PWD##*/}} \
      VORTEX_HOST_DB_PORT=$(docker compose port mariadb 3306 2>/dev/null | cut -d : -f 2) \
      VORTEX_HOST_SOLR_PORT=$(docker compose port solr 8983 2>/dev/null | cut -d : -f 2) \
      VORTEX_HOST_SELENIUM_VNC_PORT=$(docker compose port chrome 7900 2>/dev/null | cut -d : -f 2) \
      VORTEX_HOST_HAS_SEQUELACE=$(uname -a | grep -i -q darwin && mdfind -name 'Sequel Ace' 2>/dev/null | grep -q "Ace" && echo 1 || true) \
      ahoy cli ./scripts/vortex/info.sh "$@"

  db:
    usage: Open DB in Sequel Ace.
    cmd: |
      uname -a | grep -i -q darwin && mdfind -name 'Sequel Ace' 2>/dev/null |grep -q "Ace" \
      && VORTEX_HOST_DB_PORT="$(docker port $(docker compose ps -q mariadb 2>/dev/null) 3306 2>/dev/null | cut -d : -f 2)" \
      && open "mysql://${MARIADB_USERNAME:-drupal}:${MARIADB_PASSWORD:-drupal}@127.0.0.1:${VORTEX_HOST_DB_PORT}/drupal" -a "Sequel Ace" \
      || echo "Not a supported OS or Sequel Ace is not installed."

  # ----------------------------------------------------------------------------
  # Container commands.
  # ----------------------------------------------------------------------------

  up:
    usage: Build and start containers.
    cmd: |
      docker compose up -d "$@"
      if docker compose logs | grep -q "\[Error\]"; then exit 1; fi

  down:
    usage: Stop and remove containers, images, volumes and networks.
    cmd: |
      ahoy confirm "Running this command will remove your current database. Are you sure?" &&
      if [ -f "docker-compose.yml" ]; then docker compose down --remove-orphans --volumes > /dev/null 2>&1; fi

  start:
    usage: Start existing containers.
    cmd: docker compose start "$@"

  stop:
    usage: Stop running containers.
    cmd: docker compose stop "$@"

  restart:
    usage: Restart stopped or running containers.
    cmd: docker compose restart "$@"

  logs:
    usage: Show container logs for services.
    cmd: docker compose logs "$@"

  pull:
    usage: Pull latest container images.
    cmd: if [ ! -z "$(docker image ls -q)" ]; then docker image ls --format \"{{.Repository}}:{{.Tag}}\" | grep uselagoon/ | grep -v none | xargs -n1 docker pull -q | cat; fi

  cli:
    usage: Start a shell or run a command inside the CLI service container.
    # Drop into a shell if no arguments are supplied, otherwise run the command.
    # Environment variables are passed from the host and filtered by prefix.
    # Use \" (slash followed by a double quote) to escape double quotes in
    # arguments that contain spaces.
    cmd: |
      if [ "${#}" -ne 0 ]; then
        docker compose exec $(env | cut -f1 -d= | grep "TERM\|COMPOSE_\|GITHUB_\|DOCKER_\|DRUPAL_\|VORTEX_" | sed 's/^/-e /') -T cli bash -c "$*"
      else
        docker compose exec $(env | cut -f1 -d= | grep "TERM\|COMPOSE_\|GITHUB_\|DOCKER_\|DRUPAL_\|VORTEX_" | sed 's/^/-e /') cli bash
      fi

  composer:
    usage: Run Composer commands in the CLI service container.
    cmd: |
      ahoy cli " \
        if [ -n \"${GITHUB_TOKEN:-}\" ]; then export COMPOSER_AUTH='{\"github-oauth\": {\"github.com\": \"${GITHUB_TOKEN-}\"}}'; fi && \
        COMPOSER_MEMORY_LIMIT=-1 composer --ansi $@"

  drush:
    usage: Run Drush commands in the CLI service container.
    cmd: ahoy cli "vendor/bin/drush -l \${VORTEX_LOCALDEV_URL} $*"

  flush-redis:
    usage: Flush Redis cache.
    cmd: docker compose exec redis redis-cli flushall

  # ----------------------------------------------------------------------------
  # Application commands.
  # ----------------------------------------------------------------------------

  login:
    usage: Login to a website.
    # Unblock user 1 and generate a one time login link.
    cmd: ahoy cli ./scripts/vortex/login.sh

  download-db:
    usage: Download database.
    cmd: ./scripts/vortex/download-db.sh

  reload-db:
    usage: Reload the database container using local database image.
    cmd: |
      ahoy confirm "Running this command will replace your current database. Are you sure?" &&
      docker compose rm --force --stop --volumes mariadb && \
        ahoy up -- --build mariadb && \
        ahoy up wait_dependencies && \
        sleep 15 && \
        ahoy provision && \
        VORTEX_SHOW_LOGIN=1 ahoy info

  provision:
    usage: Provision a site from the database dump or profile.
    cmd: ahoy cli ./scripts/vortex/provision.sh

  export-db:
    usage: Export database dump or database image (if VORTEX_DB_IMAGE variable is set).
    cmd: ./scripts/vortex/export-db.sh "$@"

  pull-db:
    usage: Download database image with the latest nightly dump. Run "ahoy reload-db" to reload DB in the running stack.
    cmd: \[ -n "${VORTEX_DB_IMAGE}" \] && docker pull ${VORTEX_DB_IMAGE} || true

  reset:
    usage: "Remove containers, all build files. Use with `hard` to reset repository to the last commit."
    cmd: |
      ahoy confirm "All containers and build files will be removed. Proceed?" &&
      AHOY_CONFIRM_RESPONSE=y ahoy down && ./scripts/vortex/reset.sh "$@"

  fei:
    usage: Install front-end assets.
    cmd: ahoy cli "npm --prefix ${VORTEX_WEBROOT}/themes/custom/${DRUPAL_THEME} install"

  fe:
    usage: Build front-end assets.
    cmd: ahoy cli "cd ${VORTEX_WEBROOT}/themes/custom/${DRUPAL_THEME} && npm run build"

  fed:
    usage: Build front-end assets for development.
    cmd: ahoy cli "cd ${VORTEX_WEBROOT}/themes/custom/${DRUPAL_THEME} && npm run build-dev"

  few:
    usage: Watch front-end assets during development.
    cmd: |
      ahoy cli "pkill -9 -f grunt" || true
      ahoy cli "cd ${VORTEX_WEBROOT}/themes/custom/${DRUPAL_THEME} && npm run watch"

  lint:
    usage: Lint back-end and front-end code.
    cmd: ahoy lint-be && ahoy lint-fe && ahoy lint-tests

  lint-be:
    usage: Lint back-end code.
    cmd: |
      ahoy cli vendor/bin/phpcs
      ahoy cli vendor/bin/phpstan
      ahoy cli vendor/bin/rector --clear-cache --dry-run
      ahoy cli vendor/bin/phpmd . text phpmd.xml

  lint-fe:
    usage: Lint front-end code.
    cmd: |
      ahoy cli vendor/bin/twig-cs-fixer lint
      ahoy cli "npm run --prefix \${VORTEX_WEBROOT}/themes/custom/\${DRUPAL_THEME} lint"

  lint-tests:
    usage: Lint tests code.
    cmd: |
      ahoy cli vendor/bin/gherkinlint lint tests/behat/features

  lint-fix:
    usage: Fix lint issues of back-end and front-end code.
    cmd: ahoy lint-be-fix && ahoy lint-fe-fix

  lint-be-fix:
    usage: Fix lint issues of back-end code.
    cmd: |
      ahoy cli vendor/bin/rector --clear-cache
      ahoy cli vendor/bin/phpcbf

  lint-fe-fix:
    usage: Fix lint issues of front-end code.
    cmd: |
      ahoy cli vendor/bin/twig-cs-fixer lint --fix
      ahoy cli "npm run --prefix \${VORTEX_WEBROOT}/themes/custom/\${DRUPAL_THEME} lint-fix"

  test:
    usage: Run all tests.
    cmd: ahoy test-unit && ahoy test-kernel && ahoy test-functional && ahoy test-bdd

  test-unit:
    usage: Run PhpUnit unit tests.
    cmd: ahoy cli vendor/bin/phpunit --testsuite=unit "$@"

  test-kernel:
    usage: Run PhpUnit kernel tests.
    cmd: ahoy cli vendor/bin/phpunit --testsuite=kernel "$@"

  test-functional:
    usage: Run PhpUnit functional tests.
    cmd: ahoy cli vendor/bin/phpunit --testsuite=functional "$@"

  test-bdd:
    usage: Run BDD tests.
    cmd: ahoy cli php -d memory_limit=-1 vendor/bin/behat --colors "$@"

  debug:
    usage: Enable PHP Xdebug.
    cmd: ahoy cli php -v | grep -q Xdebug || XDEBUG_ENABLE=true ahoy up cli php nginx && ahoy cli php -v | grep -q Xdebug && echo "Enabled debug configuration. Use 'ahoy up' to disable."

  deploy:
    usage: Run remote deployment procedures.
    cmd: |
      ahoy confirm "Deployment usually runs in CI. Are you sure you want to proceed with manual deployment? (Run as ahoy deploy [type1,[type2..]], where [type] is 'code', 'container_registry', 'webhook')" &&
      ./scripts/vortex/deploy.sh "$@"

  github-labels:
    usage: Update project's GitHub labels.
    cmd: ./scripts/vortex/github-labels.sh "$@"

  doctor:
    usage: Find problems with current project setup.
    cmd: ./scripts/vortex/doctor.sh "$@"

  update-vortex:
    usage: Update Vortex stack.
    cmd: |
      ahoy confirm "Some committed files may become overwritten. Proceed?" &&
      ./scripts/vortex/update-vortex.sh $@

  local:
    usage: Custom local commands. See `ahoy local help`.
    cmd: |
      if [ -f .ahoy.local.yml ]; then
        ahoy -f ".ahoy.local.yml" "$@"
      else
        echo ".ahoy.local.yml does not exist."
        echo "Copy .ahoy.local.example.yml to .ahoy.local.yml and rerun this command.";
      fi

  # ----------------------------------------------------------------------------
  # Utilities.
  # ----------------------------------------------------------------------------
  confirm:
    cmd: |
      if [ -z "${AHOY_CONFIRM_RESPONSE}" ]; then
        read -r -p ">> $1 [y/N] " AHOY_CONFIRM_RESPONSE
        [ "${AHOY_CONFIRM_RESPONSE}" = "y" ] || [ "${AHOY_CONFIRM_RESPONSE}" = true ] || ( echo "The operation was canceled." && exit 1 )
      else
        echo ">> $1 [y/N] ${AHOY_CONFIRM_RESPONSE}" \
        && if [ "${AHOY_CONFIRM_WAIT_SKIP}" != "1" ]; then echo "Waiting for 3 seconds... Press Ctrl+C to cancel."; sleep 3; fi
      fi
    hide: true

# Override entrypoint to alter default behaviour of Ahoy.
entrypoint:
  - bash
  - -c
  # Exit the script if any statement returns a non-true return value.
  - -e
  # Read variables from .env file, respecting existing values.
  # - Used to load and pass updated environment variables' values into already
  #   running containers.
  # - Use `ahoy up cli` in cases when changes require container restart.
  - |
    t=$(mktemp) && export -p > "$t" && set -a && . ./.env && if [ -f ./.env.local ];then . ./.env.local;fi && set +a && . "$t" && rm "$t" && unset t
    bash -e -c "$0" "$@"
  - '{{cmd}}'
  - '{{name}}'