Fixed DB download variables inconsistencies. (#2360)

AlexSkrypnyk · web-flow · commit 47f74f060f59 · 2026-03-12T18:31:13.000+11:00
diff --git a/.ahoy.yml b/.ahoy.yml
@@ -145,7 +145,7 @@ commands:
     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
+      VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
   #;> MIGRATION
   #;> !PROVISION_TYPE_PROFILE
 
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -258,7 +258,7 @@ jobs:
       #;< MIGRATION
       - run:
           name: Download migration DB
-          command: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
+          command: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
           no_output_timeout: 30m
       #;> MIGRATION
 
diff --git a/.circleci/vortex-test-common.yml b/.circleci/vortex-test-common.yml
@@ -143,7 +143,7 @@ jobs:
       #;< MIGRATION
       - run:
           name: Download migration DB
-          command: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
+          command: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
           no_output_timeout: 30m
       #;> MIGRATION
 
diff --git a/.github/workflows/build-test-deploy.yml b/.github/workflows/build-test-deploy.yml
@@ -265,7 +265,7 @@ jobs:
 
       #;< MIGRATION
       - name: Download migration DB
-        run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
+        run: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
       #;> MIGRATION
 
       - name: Export DB
diff --git a/.lagoon.yml b/.lagoon.yml
@@ -67,7 +67,7 @@ tasks:
         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
+          VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
         service: cli
     #;> MIGRATION
 
diff --git a/.vortex/docs/.utils/update-docs.sh b/.vortex/docs/.utils/update-docs.sh
@@ -22,7 +22,7 @@ echo "" >>"${OUTPUT_FILE}"
 echo "The list below is automatically generated with [Shellvar](https://github.com/alexSkrypnyk/shellvar) from all Shell scripts. " >>"${OUTPUT_FILE}"
 echo >>"${OUTPUT_FILE}"
 
-docker run -v "${ROOT_DIR}:/app" drevops/shellvar:1.5.1 extract \
+docker run -v "${ROOT_DIR}:/app" drevops/shellvar:1.7.0 extract \
   --skip-text="@docs:skip" \
   --skip-description-prefix=";<" \
   --skip-description-prefix=";>" \
diff --git a/.vortex/docs/content/development/variables.mdx b/.vortex/docs/content/development/variables.mdx
diff --git a/.vortex/docs/content/drupal/migrations.mdx b/.vortex/docs/content/drupal/migrations.mdx
@@ -92,9 +92,10 @@ which resolves to this connection.
 | `ahoy db2` | Open the migration database in Sequel Ace |
 
 The `download-db2` command reuses the existing `download-db.sh` script with
-`VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2`, which remaps all `VORTEX_DOWNLOAD_DB2_*`
-variables to `VORTEX_DOWNLOAD_DB_*` so all existing download sources (URL, FTP,
-Acquia, Lagoon, S3) work for the migration database as well.
+`VORTEX_DB_INDEX=2`, which makes all scripts resolve indexed variable names
+(e.g., `VORTEX_DOWNLOAD_DB2_SOURCE` instead of `VORTEX_DOWNLOAD_DB_SOURCE`,
+`VORTEX_DB2_IMAGE` instead of `VORTEX_DB_IMAGE`) so all existing download
+sources (URL, FTP, Acquia, Lagoon, S3) work for the migration database as well.
 
 ## Provision script
 
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_acquia/.ahoy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_acquia/.ahoy.yml
@@ -31,7 +31,7 @@
 +    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
++      VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
  
    reload-db:
      usage: Reload the database container using local database image.
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_acquia/.github/workflows/build-test-deploy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_acquia/.github/workflows/build-test-deploy.yml
@@ -3,7 +3,7 @@
          timeout-minutes: 30
  
 +      - name: Download migration DB
-+        run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
++        run: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
 +
        - name: Export DB
          run: |
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_ftp/.ahoy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_ftp/.ahoy.yml
@@ -31,7 +31,7 @@
 +    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
++      VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
  
    reload-db:
      usage: Reload the database container using local database image.
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_ftp/.github/workflows/build-test-deploy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_ftp/.github/workflows/build-test-deploy.yml
@@ -3,7 +3,7 @@
          timeout-minutes: 30
  
 +      - name: Download migration DB
-+        run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
++        run: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
 +
        - name: Export DB
          run: |
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_lagoon/.ahoy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_lagoon/.ahoy.yml
@@ -31,7 +31,7 @@
 +    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
++      VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
  
    reload-db:
      usage: Reload the database container using local database image.
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_lagoon/.github/workflows/build-test-deploy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_lagoon/.github/workflows/build-test-deploy.yml
@@ -3,7 +3,7 @@
          timeout-minutes: 30
  
 +      - name: Download migration DB
-+        run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
++        run: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
 +
        - name: Export DB
          run: |
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_s3/.ahoy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_s3/.ahoy.yml
@@ -31,7 +31,7 @@
 +    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
++      VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
  
    reload-db:
      usage: Reload the database container using local database image.
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_s3/.github/workflows/build-test-deploy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_s3/.github/workflows/build-test-deploy.yml
@@ -3,7 +3,7 @@
          timeout-minutes: 30
  
 +      - name: Download migration DB
-+        run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
++        run: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
 +
        - name: Export DB
          run: |
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_url/.ahoy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_url/.ahoy.yml
@@ -31,7 +31,7 @@
 +    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
++      VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
  
    reload-db:
      usage: Reload the database container using local database image.
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_url/.github/workflows/build-test-deploy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_download_source_url/.github/workflows/build-test-deploy.yml
@@ -3,7 +3,7 @@
          timeout-minutes: 30
  
 +      - name: Download migration DB
-+        run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
++        run: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
 +
        - name: Export DB
          run: |
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_enabled/.ahoy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_enabled/.ahoy.yml
@@ -31,7 +31,7 @@
 +    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
++      VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
  
    reload-db:
      usage: Reload the database container using local database image.
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_enabled/.github/workflows/build-test-deploy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_enabled/.github/workflows/build-test-deploy.yml
@@ -3,7 +3,7 @@
          timeout-minutes: 30
  
 +      - name: Download migration DB
-+        run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
++        run: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
 +
        - name: Export DB
          run: |
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_circleci/.ahoy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_circleci/.ahoy.yml
@@ -31,7 +31,7 @@
 +    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
++      VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
  
    reload-db:
      usage: Reload the database container using local database image.
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_circleci/.circleci/config.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_circleci/.circleci/config.yml
@@ -229,7 +229,7 @@ jobs:
 
       - run:
           name: Download migration DB
-          command: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
+          command: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
           no_output_timeout: 30m
 
       # Execute commands after database download script finished: if the
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_lagoon/.ahoy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_lagoon/.ahoy.yml
@@ -31,7 +31,7 @@
 +    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
++      VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
  
    reload-db:
      usage: Reload the database container using local database image.
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_lagoon/.github/workflows/build-test-deploy.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_lagoon/.github/workflows/build-test-deploy.yml
@@ -3,7 +3,7 @@
          timeout-minutes: 30
  
 +      - name: Download migration DB
-+        run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh
++        run: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
 +
        - name: Export DB
          run: |
diff --git a/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_lagoon/.lagoon.yml b/.vortex/installer/tests/Fixtures/handler_process/migration_enabled_lagoon/.lagoon.yml
@@ -62,7 +62,7 @@ tasks:
         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
+          VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh
         service: cli
 
     - run:
diff --git a/.vortex/tests/bats/unit/download-db-container-registry.bats b/.vortex/tests/bats/unit/download-db-container-registry.bats
@@ -142,6 +142,37 @@ load ../_helper.bash
   popd >/dev/null
 }
 
+@test "download-db-container-registry: Resolve indexed variables with VORTEX_DB_INDEX" {
+  pushd "${LOCAL_REPO_DIR}" >/dev/null || exit 1
+
+  mock_docker=$(mock_command "docker")
+  mock_set_side_effect "${mock_docker}" "exit 1" 1
+  mock_set_side_effect "${mock_docker}" "echo 'pulled image'" 2
+
+  # Mock the login script.
+  mock_set_side_effect "$(mock_command "./scripts/vortex/login-container-registry.sh")" "echo 'logged in'" 1
+
+  # Set database index as used in CI: VORTEX_DB_INDEX=2.
+  export VORTEX_DB_INDEX="2"
+
+  # Set the shorthand image variable with index.
+  export VORTEX_DB2_IMAGE="myorg/migration-db"
+
+  # Set remaining required variables with index in the DB part.
+  export VORTEX_DOWNLOAD_DB2_CONTAINER_REGISTRY="registry.example.com"
+  export VORTEX_DOWNLOAD_DB2_CONTAINER_REGISTRY_USER="testuser"
+  export VORTEX_DOWNLOAD_DB2_CONTAINER_REGISTRY_PASS="testpass"
+  export VORTEX_DOWNLOAD_DB2_CONTAINER_REGISTRY_DB_DIR=".data"
+
+  run scripts/vortex/download-db-container-registry.sh
+  assert_success
+  assert_output_contains "[INFO] Started database data container image download."
+  assert_output_contains "Downloading myorg/migration-db image from the registry."
+  assert_output_contains "[ OK ] Finished database data container image download."
+
+  popd >/dev/null
+}
+
 @test "download-db-container-registry: Fail when VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_USER is missing" {
   pushd "${LOCAL_REPO_DIR}" >/dev/null || exit 1
 
diff --git a/.vortex/tests/bats/unit/download-db.bats b/.vortex/tests/bats/unit/download-db.bats
@@ -82,6 +82,108 @@ EOF
   popd >/dev/null
 }
 
+@test "download-db: Container registry source skips file existence check" {
+  pushd "${LOCAL_REPO_DIR}" >/dev/null || exit 1
+
+  # Create existing database files that would normally trigger the cache check.
+  mkdir -p .data
+  touch .data/db.sql
+  touch .data/db.tar
+
+  # Mock the container registry sub-script.
+  mkdir -p scripts/vortex
+  cat >scripts/vortex/download-db-container-registry.sh <<'EOF'
+#!/usr/bin/env bash
+echo "Started database data container image download."
+echo "Finished database data container image download."
+EOF
+  chmod +x scripts/vortex/download-db-container-registry.sh
+
+  mock_ls=$(mock_command "ls")
+  mock_set_output "${mock_ls}" "total 0" 1
+
+  export VORTEX_DOWNLOAD_DB_SOURCE="container_registry"
+  export VORTEX_DOWNLOAD_DB_PROCEED="1"
+  export VORTEX_DOWNLOAD_DB_DIR=".data"
+  export VORTEX_DOWNLOAD_DB_FILE="db.sql"
+  export VORTEX_DOWNLOAD_DB_FORCE=""
+
+  run scripts/vortex/download-db.sh
+  assert_success
+  assert_output_contains "Started database download."
+  assert_output_contains "Started database data container image download."
+  assert_output_contains "Finished database data container image download."
+  assert_output_contains "Finished database download."
+  assert_output_not_contains "Found existing database dump file(s)."
+  assert_output_not_contains "Using existing database dump file(s)."
+  assert_output_not_contains "Download will not proceed."
+
+  popd >/dev/null
+}
+
+@test "download-db: Resolve indexed long-form variables with VORTEX_DB_INDEX" {
+  pushd "${LOCAL_REPO_DIR}" >/dev/null || exit 1
+
+  # Mock the URL sub-script.
+  mkdir -p scripts/vortex
+  cat >scripts/vortex/download-db-url.sh <<'EOF'
+#!/usr/bin/env bash
+echo "Started database dump download from URL."
+echo "Finished database dump download from URL."
+EOF
+  chmod +x scripts/vortex/download-db-url.sh
+
+  mock_ls=$(mock_command "ls")
+  mock_set_output "${mock_ls}" "total 0" 1
+
+  # Set database index to pick up long-form indexed variables.
+  export VORTEX_DB_INDEX="2"
+  export VORTEX_DOWNLOAD_DB2_SOURCE="url"
+  export VORTEX_DOWNLOAD_DB2_PROCEED="1"
+  export VORTEX_DOWNLOAD_DB2_DIR=".data"
+  export VORTEX_DOWNLOAD_DB2_FILE="db2.sql"
+
+  run scripts/vortex/download-db.sh
+  assert_success
+  assert_output_contains "Started database 2 download."
+  assert_output_contains "Started database dump download from URL."
+  assert_output_contains "Finished database 2 download."
+
+  popd >/dev/null
+}
+
+@test "download-db: Resolve indexed shorthand variables with VORTEX_DB_INDEX" {
+  pushd "${LOCAL_REPO_DIR}" >/dev/null || exit 1
+
+  # Mock the URL sub-script.
+  mkdir -p scripts/vortex
+  cat >scripts/vortex/download-db-url.sh <<'EOF'
+#!/usr/bin/env bash
+echo "Started database dump download from URL."
+echo "Finished database dump download from URL."
+EOF
+  chmod +x scripts/vortex/download-db-url.sh
+
+  mock_ls=$(mock_command "ls")
+  mock_set_output "${mock_ls}" "total 0" 1
+
+  # Set database index to pick up shorthand indexed variables.
+  export VORTEX_DB_INDEX="2"
+  export VORTEX_DOWNLOAD_DB2_SOURCE="url"
+  export VORTEX_DOWNLOAD_DB2_PROCEED="1"
+  # Use shorthand forms for DIR and FILE.
+  export VORTEX_DB2_DIR=".data"
+  export VORTEX_DB2_FILE="db2.sql"
+
+  run scripts/vortex/download-db.sh
+  assert_success
+  assert_output_contains "Started database 2 download."
+  assert_output_contains "Started database dump download from URL."
+  assert_output_contains "Finished database 2 download."
+
+  popd >/dev/null
+}
+
 @test "download-db: Existing database file handling" {
   pushd "${LOCAL_REPO_DIR}" >/dev/null || exit 1
 
diff --git a/.vortex/tests/composer.json b/.vortex/tests/composer.json
@@ -23,7 +23,7 @@
     "require-dev": {
         "alexskrypnyk/file": "^0.19.0",
         "alexskrypnyk/phpunit-helpers": "^0.15",
-        "alexskrypnyk/shellvar": "^1.5.1",
+        "alexskrypnyk/shellvar": "^1.7.0",
         "czproject/git-php": "^4.6",
         "dealerdirect/phpcodesniffer-composer-installer": "^1.2.0",
         "drevops/phpcs-standard": "^0.6.2",
diff --git a/.vortex/tests/composer.lock b/.vortex/tests/composer.lock
diff --git a/scripts/vortex/download-db-acquia.sh b/scripts/vortex/download-db-acquia.sh
diff --git a/scripts/vortex/download-db-container-registry.sh b/scripts/vortex/download-db-container-registry.sh
diff --git a/scripts/vortex/download-db-ftp.sh b/scripts/vortex/download-db-ftp.sh
diff --git a/scripts/vortex/download-db-lagoon.sh b/scripts/vortex/download-db-lagoon.sh
diff --git a/scripts/vortex/download-db-s3.sh b/scripts/vortex/download-db-s3.sh
diff --git a/scripts/vortex/download-db-url.sh b/scripts/vortex/download-db-url.sh
diff --git a/scripts/vortex/download-db.sh b/scripts/vortex/download-db.sh

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`timeout-minutes: 30`
`4`	`4`
`5`	`5`	`+ - name: Download migration DB`
`6`		`-+ run: VORTEX_VAR_PREFIX=VORTEX_DOWNLOAD_DB2 ./scripts/vortex/download-db.sh`
	`6`	`++ run: VORTEX_DB_INDEX=2 ./scripts/vortex/download-db.sh`
`7`	`7`	`+`
`8`	`8`	`- name: Export DB`
`9`	`9`	`run: \|`