Latest govcms scaffold

.ahoy.yml

@@ -5,110 +5,110 @@ commands:
   up:
     usage: Build project.
     cmd: |
-      docker-compose up -d "$@" &&
-      docker-compose exec -T test dockerize -wait tcp://mariadb:3306 -timeout 2m &&
+      docker compose up -d "$@" &&
+      docker compose exec -T test dockerize -wait tcp://mariadb:3306 -timeout 2m &&
       ahoy info;
 
   down:
     usage: Delete project (CAUTION).
     cmd: |
       if [ "$1" == "y" ]; then
-        docker-compose down --volumes
+        docker compose down --volumes
       else
         ahoy confirm "Running this command will destroy your current site, database and build? Are you sure you didn't mean ahoy stop?" &&
         # Run this if confirm returns true
-        docker-compose down --volumes ||
+        docker compose down --volumes ||
         # Run this if confirm returns false
         echo "OK, probably a wise choice..."
       fi
 
   build:
     usage: Build project.
     cmd: |
-      docker-compose up -d --build "$@" &&
-      docker-compose exec -T test dockerize -wait tcp://mariadb:3306 -timeout 2m &&
+      docker compose up -d --build "$@" &&
+      docker compose exec -T test dockerize -wait tcp://mariadb:3306 -timeout 2m &&
       ahoy govcms-deploy && ahoy info;
 
   cli:
     usage: Start a shell inside cli container.
-    cmd: docker-compose exec cli bash
+    cmd: docker compose exec cli bash
 
   run:
     usage: Run command inside cli container.
-    cmd: docker-compose exec -T cli bash -c "$*"
+    cmd: docker compose exec -T cli bash -c "$*"
 
   govcms-deploy:
     usage: Runs deployment commands (e.g. config import, updb, cr, set up file_stage_proxy).
     cmd: |
-      docker-compose exec -T cli mkdir -p /app/web/sites/default/files/private/tmp && \
-      docker-compose exec -T cli /app/vendor/bin/govcms-db-update && \
-      docker-compose exec -T cli /app/vendor/bin/govcms-config-import && \
-      docker-compose exec -T cli /app/vendor/bin/govcms-cache-rebuild && \
-      docker-compose exec -T cli /app/vendor/bin/govcms-enable_modules
+      docker compose exec -T cli mkdir -p /app/web/sites/default/files/private/tmp && \
+      docker compose exec -T cli /app/vendor/bin/govcms-db-update && \
+      docker compose exec -T cli /app/vendor/bin/govcms-config-import && \
+      docker compose exec -T cli /app/vendor/bin/govcms-cache-rebuild && \
+      docker compose exec -T cli /app/vendor/bin/govcms-enable_modules
 
   drush:
     usage: Run drush commands in cli container.
-    cmd: docker-compose exec -T cli drush "$@"
+    cmd: docker compose exec -T cli drush "$@"
 
   logs:
     usage: Show Docker logs.
-    cmd: docker-compose logs "$@"
+    cmd: docker compose logs "$@"
 
   ps:
     usage: List running Docker containers.
-    cmd: docker-compose ps
+    cmd: docker compose ps
 
   restart:
     usage: Restart Docker containers.
-    cmd: docker-compose restart
+    cmd: docker compose restart
 
   stop:
     usage: Stop Docker containers.
-    cmd: docker-compose stop "$@"
+    cmd: docker compose stop "$@"
 
   install:
     usage: Install the profile.
-    cmd: docker-compose exec -T cli drush si -y govcms "$@" && ahoy govcms-deploy
+    cmd: docker compose exec -T cli drush si -y govcms "$@" && ahoy govcms-deploy
 
   login:
     usage: Login to a website.
     cmd: |
-      docker-compose exec -T cli drush -y cset tfa.settings reset_pass_skip_enabled true && \
-      docker-compose exec -T cli drush uinf --uid 1 --field name | xargs docker-compose exec -T cli drush uublk && \
-      docker-compose exec -T cli drush uli
+      docker compose exec -T cli drush -y cset tfa.settings reset_pass_skip_enabled true && \
+      docker compose exec -T cli drush uinf --uid 1 --field name | xargs docker compose exec -T cli drush uublk && \
+      docker compose exec -T cli drush uli
 
   unloop:
     usage: Fix local redirect loop
     cmd: |
-      docker-compose exec -T cli drush ev '$u=\Drupal\user\Entity\User::load(1); $u->set("field_password_expiration", "0"); $u->save()' && \
-      docker-compose exec -T cli drush ev '$u=\Drupal\user\Entity\User::load(1); $u->set("field_last_password_reset", date("Y-m-d\TH:i:s")); $u->save()'
+      docker compose exec -T cli drush ev '$u=\Drupal\user\Entity\User::load(1); $u->set("field_password_expiration", "0"); $u->save()' && \
+      docker compose exec -T cli drush ev '$u=\Drupal\user\Entity\User::load(1); $u->set("field_last_password_reset", date("Y-m-d\TH:i:s")); $u->save()'
 
   mysql-import:
     usage: Pipe in a sql file.  `ahoy mysql-import local.sql`
     cmd: |
       if [ -e "$@" ] ; then
-        docker-compose exec cli bash -c 'drush sql-drop' &&
-        docker-compose exec -T cli bash -c 'drush sql-cli' < "$@"
+        docker compose exec cli bash -c 'drush sql-drop' &&
+        docker compose exec -T cli bash -c 'drush sql-cli' < "$@"
       else echo "Provided sql file" "$@" "does not exist"
       fi
 
   mysql-dump:
     usage: Dump data out into a file. `ahoy mysql-dump local.sql`
-    cmd: docker-compose exec -T cli bash -c 'drush sql-dump --ordered-dump' > "$@"
+    cmd: docker compose exec -T cli bash -c 'drush sql-dump --ordered-dump' > "$@"
 
   lint:
     usage: Lint code
     cmd: |
-      docker-compose exec -T test ./vendor/bin/govcms-lint web/modules/custom
-      docker-compose exec -T test ./vendor/bin/govcms-lint web/themes/custom
+      docker compose exec -T test ./vendor/bin/govcms-lint web/modules/custom
+      docker compose exec -T test ./vendor/bin/govcms-lint web/themes/custom
 
   test-behat:
     usage: Run Behat tests.
-    cmd: docker-compose exec -T test ./vendor/bin/govcms-behat "$@"
+    cmd: docker compose exec -T test ./vendor/bin/govcms-behat "$@"
 
   test-phpunit:
     usage: Run phpunit tests
-    cmd: docker-compose exec -T test ./vendor/bin/govcms-phpunit --testsuite govcms
+    cmd: docker compose exec -T test ./vendor/bin/govcms-phpunit --testsuite govcms
 
   pull:
     usage: Pull latest docker images.
@@ -119,14 +119,14 @@ commands:
     cmd: |
       ahoy confirm "Running this command will replace your current database. Are you sure?" &&
       # Run this if confirm returns true
-      ( cat .env | grep ^MARIADB_DATA_IMAGE | cut -c20- | xargs -n1 docker pull; docker-compose rm -f -s -v mariadb && ahoy up ) ||
+      ( cat .env | grep ^MARIADB_DATA_IMAGE | cut -c20- | xargs -n1 docker pull; docker compose rm -f -s -v mariadb && ahoy up ) ||
       # Run this if confirm returns false
       echo "OK, probably a wise choice..."
 
   ship-shape:
     usage: Run site validation scripts locally
     cmd: |
-      docker-compose exec -T cli shipshape -f /app/vendor/govcms/scaffold-tooling/shipshape.yml --exclude-db --error-code "$@"
+      docker compose exec -T cli shipshape run -f /app/vendor/govcms/scaffold-tooling/shipshape.yml --exclude-db --error-code . "$@"
 
   debug:
     usage: Enable debug configuration.
@@ -139,7 +139,7 @@ commands:
     cmd: |
       echo "Project                  : " $(ahoy run "echo \$LAGOON_PROJECT")
       echo "Site local URL           : " $(ahoy run "echo \$LAGOON_ROUTE")
-      echo "DB port on host          : " $(docker port $(docker-compose ps -q mariadb) 3306 | cut -d : -f 2)
+      echo "DB port on host          : " $(docker port $(docker compose ps -q mariadb) 3306 | cut -d : -f 2)
       if [ "$1" ]; then
         echo "One-time login           : " $(ahoy login -- --no-browser)
       fi

.docker/Dockerfile.paas

@@ -5,17 +5,15 @@
 ARG CLI_IMAGE
 ARG GOVCMS_IMAGE_VERSION={{ GOVCMS_VERSION }}.x-latest
 
-# Keep the base so we can copy modules from it at the end.
-FROM govcms/govcms:${GOVCMS_IMAGE_VERSION} as base
-
 FROM govcms/govcms:${GOVCMS_IMAGE_VERSION}
 
 ARG GOVCMS_GITHUB_TOKEN
 
 ENV WEBROOT=web
 
 # Clean up base image so as not to conflict with any changes.
-RUN rm -rf /app
+RUN mv /app/web/sites/all/modules /scaffold_modules \
+  && rm -rf /app
 
 RUN composer config --global github-oauth.github.com $GOVCMS_GITHUB_TOKEN
 
@@ -25,6 +23,8 @@ COPY custom /app/custom
 
 # Run composer. Additional `rm`s can be added to reduce the image size, with diminishing returns.
 RUN composer install --no-dev --no-interaction --no-suggest \
+  && mkdir -p /app/web/sites/all \
+  && mv /scaffold_modules /app/web/sites/all/modules \
   && rm -rf ~/.composer/cache \
   && rm -rf /app/web/core/tests \
   && rm -rf /app/web/modules/contrib/webform/tests
@@ -39,8 +39,6 @@ COPY .docker/config/cli/govcms.site.yml /app/drush/sites/
 RUN rm -Rf /home/.composer/vendor/bin
 ENV PATH="/app/vendor/bin:${PATH}"
 
-COPY --from=base /app/web/sites/all/modules/ /app/web/sites/all/modules/
-
 # Sanitize the Drupal install to remove potentially
 # harmful files from the built image.
 COPY .docker/scripts/sanitize.sh /tmp/sanitize.sh

.docker/Dockerfile.saasplus

@@ -19,7 +19,9 @@ COPY config /app/config
 COPY favicon.ico /app/web
 
 # To enable SaaS+ uncomment these lines
-RUN composer config --global github-oauth.github.com $GOVCMS_GITHUB_TOKEN
+RUN [ ! -z "$GOVCMS_GITHUB_TOKEN" ] \
+  && composer config --global github-oauth.github.com $GOVCMS_GITHUB_TOKEN \
+  || echo "skipping github token"
 COPY custom /app/custom
 RUN jq -s '.[1].repositories = (.[0].repositories + .[1].repositories) | .[1]' /app/custom/composer/composer.json /app/composer.json > /tmp/composer.json
 RUN mv /tmp/composer.json /app/composer.json

.docker/Dockerfile.test

@@ -12,11 +12,3 @@ ENV WEBROOT=web
 
 COPY --from=cli /app /app
 COPY tests /app/tests/
-
-# Copy deploy and test scripts.
-RUN cp /app/vendor/govcms/scaffold-tooling/scripts/govcms* /usr/local/bin/
-RUN chmod +x /usr/local/bin/*
-
-# @see also drush setup in Dockerfile.cli
-COPY --from=cli /usr/local/bin/drush /usr/local/bin/
-RUN chmod +x /usr/local/bin/drush && rm -Rf /home/.composer/vendor/bin

.docker/config/test/sample.profile.yml

@@ -1,4 +1,4 @@
-title: 'Drupal 8 Sample Audit - run with docker-compose exec -T test drutiny profile:run sample @self'
+title: 'Drupal 8 Sample Audit - run with docker compose exec -T test drutiny profile:run sample @self'
 format:
   html:
     template: govcms-page

.env.default

@@ -1,7 +1,7 @@
 ##
 # This file contains per-project environment variables.
 # It is used by Ahoy, Docker-compose, Lagoon, and other scripts to read default values.
-# Copy this file to '.env' to make docker-compose use overridden values.
+# Copy this file to '.env' to make docker compose use overridden values.
 #
 
 # https://govcms.gov.au/wiki-vars#COMPOSE_PROJECT_NAME

.github/workflows/test-scaffold.yml

@@ -0,0 +1,153 @@
+name: Test scaffold
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - ready_for_review
+      - synchronize
+  schedule:
+    # Sunday 2 AM Melbourne time.
+    - cron: '0 16 * * SUN'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  DREVOPS_CI_TEST_RESULTS: /tmp/tests
+  DREVOPS_CI_ARTIFACTS: /tmp/artifacts
+  GOVCMS_VERSION: 10
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 2
+      matrix:
+        govcms_image:
+          - "10.x-latest"
+          - "10.x-edge"
+        project_type:
+          - saas
+          - paas
+      fail-fast: false
+
+    container:
+      image: drevops/ci-runner:24.8.0
+      env:
+        CI: 1
+        # Prevent GitHub overriding the Docker config.
+        DOCKER_CONFIG: /root/.docker
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        TZ: "Australia/Melbourne"
+        # Set runner terminal capabilities.
+        TERM: xterm-256color
+        # Directory to store test results.
+        DREVOPS_CI_TEST_RESULTS: ${{ env.DREVOPS_CI_TEST_RESULTS }}
+        # Directory to store test artifacts.
+        DREVOPS_CI_ARTIFACTS: ${{ env.DREVOPS_CI_ARTIFACTS }}
+        # Check only minimal stack requirements.
+        DREVOPS_DOCTOR_CHECK_MINIMAL: 1
+        # Directory to store code exported between jobs.
+        DREVOPS_EXPORT_CODE_DIR: /tmp/workspace/code
+
+    steps:
+      -
+        name: Checkout the repo
+        uses: actions/checkout@main
+
+      -
+        name: Check Docker and Compose version
+        run: |
+          echo "[INFO] Docker version."
+          docker version
+          echo "[INFO] Docker Compose version."
+          docker compose version
+
+      -
+        name: Setup Docker network
+        run: docker network prune -f >/dev/null 2>&1 && docker network inspect amazeeio-network >/dev/null 2>&1 || docker network create amazeeio-network >/dev/null 2>&1 || true
+
+      -
+        name: Process codebase to run in CI
+        run: |
+          find . -name "docker-compose.yml" -print0 | xargs -0 -I {} sh -c "sed -i -e ''/###/d'' {} && sed -i -e ''s/##//'' {} && sed -i -e 's#- .:/app:delegated#[]#' {}"
+          mkdir -p "${DREVOPS_EXPORT_CODE_DIR}"
+
+      -
+        name: Init scaffold
+        run: ahoy init scaffold-test ${{ matrix.project_type }} ${{ env.GOVCMS_VERSION }}
+
+      -
+        name: Build project
+        run: ahoy up
+        env:
+          GOVCMS_IMAGE_VERSION: ${{ matrix.govcms_image }}
+          GOVCMS_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      -
+        name: Install GovCMS profile
+        run: ahoy install
+
+  notify:
+    runs-on: ubuntu-latest
+    needs: [ test ]
+    if: ${{ !cancelled() }}
+    steps:
+      -
+        name: Notify failures to Slack
+        id: failure_slack
+        if: ${{ contains(needs.*.result, 'failure') }}
+        uses: slackapi/slack-github-action@v1.27.0
+        with:
+          # See https://github.com/slackapi/slack-github-action?tab=readme-ov-file
+          channel-id: ${{ secrets.SLACK_CHANNEL }}
+          payload: |
+            {
+              "attachments": [
+                {
+                  "color": "#ff0000",
+                  "blocks": [
+                    {
+                      "type": "header",
+                      "text": {
+                        "type": "plain_text",
+                        "text": "GovCMS Scaffold test failure"
+                      }
+                    },
+                    {
+                      "type": "context",
+                      "elements": [
+                        {
+                          "type": "mrkdwn",
+                          "text": "Some jobs were not successful, please view the pipeline and rerun."
+                        }
+                      ]
+                    },
+                    {
+                      "type": "actions",
+                      "block_id": "view_pipeline",
+                      "elements": [
+                        {
+                          "type": "button",
+                          "text": {
+                            "type": "plain_text",
+                            "text": "View pipeline"
+                          },
+                          "url": "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}