[#1642] Added support for migration DB.

Author: AlexSkrypnyk

.ahoy.yml

@@ -35,6 +35,9 @@ commands:
     cmd: |
       COMPOSE_PROJECT_NAME=${COMPOSE_PROJECT_NAME:-${PWD##*/}} \
       VORTEX_HOST_DB_PORT=$(docker compose port database 3306 2>/dev/null | cut -d : -f 2) \
+      #;< MIGRATION
+      VORTEX_HOST_DB2_PORT=$(docker compose port database2 3306 2>/dev/null | cut -d : -f 2) \
+      #;> MIGRATION
       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) \
@@ -48,6 +51,16 @@ commands:
       open "mysql://${DATABASE_USERNAME:-drupal}:${DATABASE_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."
 
+  #;< MIGRATION
+  db2:
+    usage: Open DB2 in Sequel Ace.
+    cmd: |
+      uname -a | grep -i -q darwin && test -d "${VORTEX_HOST_SEQUELACE_PATH:-/Applications/Sequel Ace.app}" && \
+      VORTEX_HOST_DB2_PORT=$(docker compose port database2 3306 2>/dev/null | cut -d : -f 2) && \
+      open "mysql://${DATABASE2_USERNAME:-drupal}:${DATABASE2_PASSWORD:-drupal}@127.0.0.1:${VORTEX_HOST_DB2_PORT}/drupal" -a "Sequel Ace" \
+      || echo "Not a supported OS or Sequel Ace is not installed."
+  #;> MIGRATION
+
   # ----------------------------------------------------------------------------
   # Container commands.
   # ----------------------------------------------------------------------------
@@ -125,6 +138,15 @@ commands:
     cmd: |
       case " $* " in *" --fresh "*) export VORTEX_DOWNLOAD_DB_FRESH=1;; esac
       ./scripts/vortex/download-db.sh
+
+  #;< MIGRATION
+  download-db2:
+    usage: Download second database (migration). Run with "--fresh" to force.
+    aliases: [fetch-db2]
+    cmd: |
+      case " $* " in *" --fresh "*) export VORTEX_DOWNLOAD_DB_FORCE=1;; esac
+      VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
+  #;> MIGRATION
   #;> !PROVISION_TYPE_PROFILE
 
   reload-db:

.circleci/config.yml

@@ -154,16 +154,23 @@ jobs:
             # Change 'v1' to 'v2', 'v3' etc., commit and push to force cache reset.
             # Lookup cache based on the default branch and a timestamp. Allows
             # to use cache from the very first build on the day (sanitized database dump, for example).
-            - v26.1.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback" }}-{{ checksum "/tmp/db_cache_timestamp" }}
+            - v26.2.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback" }}-{{ checksum "/tmp/db_cache_timestamp" }}
             # Fallback to caching by default branch name only. Allows to use
             # cache from the branch build on the previous day.
-            - v26.1.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback" }}-
+            - v26.2.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback" }}-
 
       - run:
           name: Download DB
           command: VORTEX_DOWNLOAD_DB_SEMAPHORE=/tmp/download-db-success ./scripts/vortex/download-db.sh
           no_output_timeout: 30m
 
+      #;< MIGRATION
+      - run:
+          name: Download migration DB
+          command: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
+          no_output_timeout: 30m
+      #;> MIGRATION
+
       # Execute commands after database download script finished: if the
       # DB dump was downloaded - build the site (to ensure that the DB dump
       # is valid) and export the DB using selected method (to support
@@ -187,7 +194,7 @@ jobs:
           # The cache will not be saved if it already exists.
           # Note that the cache fallback flag is enabled for this case in order
           # to save cache even if the fallback is not used when restoring it.
-          key: v26.1.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback_yes" }}-{{ checksum "/tmp/db_cache_timestamp" }}
+          key: v26.2.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback_yes" }}-{{ checksum "/tmp/db_cache_timestamp" }}
           paths:
             - /root/project/.data
 
@@ -236,8 +243,8 @@ jobs:
           keys:
             # Use cached artifacts from previous builds of this branch.
             # https://circleci.com/docs/2.0/caching/#restoring-cache
-            - v26.1.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback_yes" }}-{{ checksum "/tmp/db_cache_timestamp" }}
-            - v26.1.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback_yes" }}-
+            - v26.2.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback_yes" }}-{{ checksum "/tmp/db_cache_timestamp" }}
+            - v26.2.0-db11-{{ checksum "/tmp/db_cache_branch" }}-{{ checksum "/tmp/db_cache_fallback_yes" }}-
       #;> !PROVISION_TYPE_PROFILE
 
       - *step_setup_remote_docker
@@ -356,6 +363,11 @@ jobs:
             if [ -f .data/db.sql ]; then
               docker compose exec cli mkdir -p .data
               docker compose cp -L .data/db.sql cli:/app/.data/db.sql
+              #;< MIGRATION
+              if [ -f ".data/${VORTEX_DOWNLOAD_DB2_FILE:-db2.sql}" ]; then
+                docker compose cp -L ".data/${VORTEX_DOWNLOAD_DB2_FILE:-db2.sql}" cli:"/app/.data/${VORTEX_DOWNLOAD_DB2_FILE:-db2.sql}"
+              fi
+              #;> MIGRATION
             fi
             docker compose exec $(env | cut -f1 -d= | sed 's/^/-e /') -T cli ./scripts/vortex/provision.sh
           no_output_timeout: 30m

.env

@@ -226,6 +226,61 @@ VORTEX_DOWNLOAD_DB_ACQUIA_DB_NAME=your_site
 
 #;> !PROVISION_TYPE_PROFILE
 
+#;< MIGRATION
+################################################################################
+#                       SECOND DATABASE (MIGRATION)                            #
+################################################################################
+
+# Second database for migrations.
+# See settings.migration.php for database credentials.
+
+# Second database dump file name.
+VORTEX_DOWNLOAD_DB2_FILE=db2.sql
+
+# Second database download source.
+VORTEX_DOWNLOAD_DB2_SOURCE=url
+
+#;< MIGRATION_DB_DOWNLOAD_SOURCE_URL
+# Second database dump file sourced from a URL.
+#
+# HTTP Basic Authentication credentials should be embedded into the value.
+VORTEX_DOWNLOAD_DB2_URL=
+#;> MIGRATION_DB_DOWNLOAD_SOURCE_URL
+
+#;< MIGRATION_DB_DOWNLOAD_SOURCE_FTP
+# Second database dump file sourced from FTP.
+
+# Second database dump FTP host.
+VORTEX_DOWNLOAD_DB2_FTP_HOST=
+
+# Second database dump FTP port.
+VORTEX_DOWNLOAD_DB2_FTP_PORT=21
+
+# Second database dump FTP file name.
+VORTEX_DOWNLOAD_DB2_FTP_FILE=db2.sql
+#;> MIGRATION_DB_DOWNLOAD_SOURCE_FTP
+
+#;< MIGRATION_DB_DOWNLOAD_SOURCE_S3
+# Second database dump file sourced from S3.
+
+# AWS S3 bucket name for second database download.
+VORTEX_DOWNLOAD_DB2_S3_BUCKET=
+
+# AWS S3 region.
+VORTEX_DOWNLOAD_DB2_S3_REGION=ap-southeast-2
+#;> MIGRATION_DB_DOWNLOAD_SOURCE_S3
+
+# Environment to download the second database from.
+#
+# Applies to hosting environments.
+VORTEX_DOWNLOAD_DB2_ENVIRONMENT=prod
+
+#;< HOSTING_ACQUIA
+# Acquia database name to download the second database from.
+VORTEX_DOWNLOAD_DB2_ACQUIA_DB_NAME=your_site
+#;> HOSTING_ACQUIA
+#;> MIGRATION
+
 ################################################################################
 #                             RELEASE VERSIONING                               #
 ################################################################################
@@ -303,6 +358,13 @@ VORTEX_NOTIFY_WEBHOOK_URL=
 VORTEX_DOWNLOAD_DB_URL=https://github.com/drevops/vortex/releases/download/25.4.0/db_d11.demo.sql
 #;> DB_DOWNLOAD_SOURCE_URL
 
+#;< MIGRATION
+#;< MIGRATION_DB_DOWNLOAD_SOURCE_URL
+# URL of the migration source database used for demonstration.
+VORTEX_DOWNLOAD_DB2_URL=https://github.com/drevops/vortex/releases/download/25.4.0/db_d11.demo_source.sql
+#;> MIGRATION_DB_DOWNLOAD_SOURCE_URL
+#;> MIGRATION
+
 #;< DB_DOWNLOAD_SOURCE_CONTAINER_REGISTRY
 # Demo database container image used for demonstration of database-in-image
 # data storage.

.github/workflows/build-test-deploy.yml

@@ -122,11 +122,11 @@ jobs:
         uses: actions/cache/restore@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5
         with:
           path: .data
-          key: v26.1.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback') }}-${{ hashFiles('db_cache_timestamp') }}
+          key: v26.2.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback') }}-${{ hashFiles('db_cache_timestamp') }}
           # Fallback to caching by default branch name only. Allows to use
           # cache from the branch build on the previous day.
           restore-keys: |
-            v26.1.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback') }}-
+            v26.2.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback') }}-
 
       - name: Download DB
         run: |
@@ -139,6 +139,11 @@ jobs:
           VORTEX_ACQUIA_SECRET: ${{ secrets.VORTEX_ACQUIA_SECRET }}
         #;> DB_DOWNLOAD_SOURCE_ACQUIA
 
+      #;< MIGRATION
+      - name: Download migration DB
+        run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
+      #;> MIGRATION
+
       - name: Export DB
         run: |
           if [ ! -f /tmp/download-db-success ]; then echo "==> Database download semaphore file is missing. DB export will not proceed."; exit 0; fi
@@ -158,7 +163,7 @@ jobs:
         if: env.db_hash != hashFiles('.data')
         with:
           path: .data
-          key: v26.1.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback_yes') }}-${{ hashFiles('db_cache_timestamp') }}
+          key: v26.2.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback_yes') }}-${{ hashFiles('db_cache_timestamp') }}
   #;> !PROVISION_TYPE_PROFILE
 
   build:
@@ -223,7 +228,7 @@ jobs:
           date "${VORTEX_CI_DB_CACHE_TIMESTAMP}" | tee db_cache_timestamp
 
       - name: Show cache key for database caching
-        run: echo 'v26.1.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback_yes') }}-${{ hashFiles('db_cache_timestamp') }}'
+        run: echo 'v26.2.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback_yes') }}-${{ hashFiles('db_cache_timestamp') }}'
 
       # Restore DB cache based on the cache strategy set by the cache keys below.
       # Change 'v1' to 'v2', 'v3' etc., commit and push to force cache reset.
@@ -235,9 +240,9 @@ jobs:
           path: .data
           fail-on-cache-miss: true
           # Use cached database from previous builds of this branch.
-          key: v26.1.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback_yes') }}-${{ hashFiles('db_cache_timestamp') }}
+          key: v26.2.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback_yes') }}-${{ hashFiles('db_cache_timestamp') }}
           restore-keys: |
-            v26.1.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback_yes') }}-
+            v26.2.0-db11-${{ hashFiles('db_cache_branch') }}-${{ hashFiles('db_cache_fallback_yes') }}-
       #;> !PROVISION_TYPE_PROFILE
 
       - name: Login to container registry
@@ -340,6 +345,11 @@ jobs:
           if [ -f .data/db.sql ]; then
             docker compose exec cli mkdir -p .data
             docker compose cp -L .data/db.sql cli:/app/.data/db.sql
+            #;< MIGRATION
+            if [ -f ".data/${VORTEX_DOWNLOAD_DB2_FILE:-db2.sql}" ]; then
+              docker compose cp -L ".data/${VORTEX_DOWNLOAD_DB2_FILE:-db2.sql}" cli:"/app/.data/${VORTEX_DOWNLOAD_DB2_FILE:-db2.sql}"
+            fi
+            #;> MIGRATION
           fi
           docker compose exec $(env | cut -f1 -d= | sed 's/^/-e /') -T cli ./scripts/vortex/provision.sh
         timeout-minutes: 30

.github/workflows/vortex-test-common.yml

@@ -237,5 +237,5 @@ jobs:
         continue-on-error: ${{ vars.VORTEX_CI_YAMLLINT_IGNORE_FAILURE == '1' }}
 
       - name: Check coding standards with actionlint
-        run: docker run --rm -v "${GITHUB_WORKSPACE:-.}":/app --workdir /app rhysd/actionlint:1.7.2 -ignore 'SC2002:' -ignore 'SC2155:' -ignore 'SC2015:' -ignore 'SC2046:' -ignore 'SC1090:'
+        run: docker run --rm -v "${GITHUB_WORKSPACE:-.}":/app --workdir /app rhysd/actionlint:1.7.10 -ignore 'SC2002:' -ignore 'SC2155:' -ignore 'SC2015:' -ignore 'SC2046:' -ignore 'SC1090:'
         continue-on-error: ${{ vars.VORTEX_CI_ACTIONLINT_IGNORE_FAILURE == '1' }}

.gitignore

@@ -23,6 +23,9 @@ web/profiles/*
 web/sites/default/*
 !web/sites/default/settings.php
 !web/sites/default/services.yml
+#;< MIGRATION
+!web/sites/default/settings.migration.php
+#;> MIGRATION
 !web/sites/default/example.settings.local.php
 !web/sites/default/example.services.local.yml
 !web/sites/default/default.settings.local.php

.lagoon.yml

@@ -61,6 +61,16 @@ tasks:
         service: cli
     #;> !PROVISION_TYPE_PROFILE
 
+    #;< MIGRATION
+    - run:
+        name: Download migration database
+        command: |
+          export VORTEX_DOWNLOAD_DB_SSH_FILE=false
+          export VORTEX_DB_DIR=/tmp/data
+          VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
+        service: cli
+    #;> MIGRATION
+
     - run:
         name: Provision site
         command: |

.vortex/docs/.utils/create-migrate-source-db.sh

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+##
+# Create migration source database with sample data.
+#
+# This script populates the migration source database with a `categories` table
+# containing sample data for demonstration purposes.
+#
+# Usage:
+#   DB_URL=mysql://user:pass@host:port/dbname ./create-migrate-source-db.sh
+#
+# Or using drush:
+#   $(drush sql:connect) < <(./create-migrate-source-db.sh --sql)
+
+set -eu
+[ "${VORTEX_DEBUG-}" = "1" ] && set -x
+
+sql=$(
+  cat <<'SQL'
+DROP TABLE IF EXISTS `categories`;
+
+CREATE TABLE `categories` (
+  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+  `name` varchar(255) NOT NULL,
+  `description` text DEFAULT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
+
+INSERT INTO `categories` (`id`, `name`, `description`) VALUES
+(1, 'Jedi Order', 'Ancient order of Force-sensitive protectors of peace and justice in the galaxy.'),
+(2, 'Sith Lords', 'Dark side practitioners who seek power and dominion over the galaxy.'),
+(3, 'Galactic Empire', 'Authoritarian government that ruled the galaxy through fear and military might.'),
+(4, 'Rebel Alliance', 'Coalition of resistance fighters opposing the tyranny of the Galactic Empire.'),
+(5, 'Bounty Hunters', 'Mercenaries and trackers who pursue targets for credits across the galaxy.'),
+(6, 'Smugglers', 'Independent pilots and traders who operate outside the law for profit.'),
+(7, 'Droids', 'Mechanical beings serving various roles from protocol to astromech duties.'),
+(8, 'Mandalorians', 'Warrior culture known for their beskar armor and combat traditions.'),
+(9, 'Wookiees', 'Tall, fur-covered species from Kashyyyk known for their strength and loyalty.'),
+(10, 'Hutts', 'Powerful crime lords who control vast criminal enterprises across the Outer Rim.');
+SQL
+)
+
+if [ "${1:-}" = "--sql" ]; then
+  printf '%s\n' "${sql}"
+  exit 0
+fi
+
+echo "${sql}"