[#1668] Allow to import from a custom file using ahoy import.

Author: AlexSkrypnyk

.ahoy.yml

@@ -148,7 +148,7 @@ commands:
 
   import-db:
     usage: Import database from dump.
-    cmd: VORTEX_PROVISION_POST_OPERATIONS_SKIP=1 ahoy cli ./scripts/vortex/provision.sh
+    cmd: VORTEX_PROVISION_POST_OPERATIONS_SKIP=1 VORTEX_PROVISION_DB="$@" ahoy cli ./scripts/vortex/provision.sh
 
   pull-db:
     usage: Download database image with the latest nightly dump. Run "ahoy reload-db" to reload DB in the running stack.

.vortex/docs/content/workflows/variables.mdx

@@ -1481,6 +1481,14 @@ Default value: `UNDEFINED`
 
 Defined in: `ACQUIA ENVIRONMENT`
 
+### `VORTEX_PROVISION_DB`
+
+Provision database dump file.<br/>If not set, it will be auto-discovered from the VORTEX_DB_DIR directory using<br/>the VORTEX_DB_FILE name.
+
+Default value: `UNDEFINED`
+
+Defined in: `scripts/vortex/provision.sh`
+
 ### `VORTEX_PROVISION_OVERRIDE_DB`
 
 Overwrite a database if it exists.
@@ -1545,6 +1553,14 @@ Default value: `UNDEFINED`
 
 Defined in: `.env`, `scripts/vortex/provision.sh`
 
+### `VORTEX_PROVISION_SCRIPTS_DIR`
+
+Directory with custom provision scripts.
+
+Default value: `./scripts/custom`
+
+Defined in: `scripts/vortex/provision.sh`
+
 ### `VORTEX_PROVISION_SKIP`
 
 Flag to skip site provisioning.

.vortex/installer/tests/Fixtures/install/_baseline/.ahoy.yml

@@ -141,7 +141,7 @@ commands:
 
   import-db:
     usage: Import database from dump.
-    cmd: VORTEX_PROVISION_POST_OPERATIONS_SKIP=1 ahoy cli ./scripts/vortex/provision.sh
+    cmd: VORTEX_PROVISION_POST_OPERATIONS_SKIP=1 VORTEX_PROVISION_DB="$@" ahoy cli ./scripts/vortex/provision.sh
 
   pull-db:
     usage: Download database image with the latest nightly dump. Run "ahoy reload-db" to reload DB in the running stack.

.vortex/tests/bats/_helper.workflow.bash

@@ -325,8 +325,10 @@ assert_ahoy_login() {
 
 assert_ahoy_export_db() {
   step "Export DB"
-  file="${1:-mydb.sql}"
+
+  file="${1:-}"
   run ahoy export-db "${file}"
+
   assert_success
   assert_output_not_contains "Containers are not running."
   sync_to_host
@@ -335,7 +337,9 @@ assert_ahoy_export_db() {
 
 assert_ahoy_import_db() {
   step "Import DB"
-  run ahoy import-db
+
+  run ahoy import-db "${1-}"
+
   assert_success
   assert_output_contains "Provisioning site from the database dump file."
   assert_output_not_contains "Running deployment operations via 'drush deploy:hook'."

.vortex/tests/bats/workflow.install.db.bats

@@ -34,10 +34,18 @@ load _helper.workflow.bash
 
   assert_ahoy_login
 
+  # Export to default file.
   assert_ahoy_export_db
 
+  # Export to custom file.
+  assert_ahoy_export_db "mydb.sql"
+
+  # Import from default file.
   assert_ahoy_import_db
 
+  # Import from custom file.
+  assert_ahoy_import_db "mydb.sql"
+
   assert_ahoy_lint
 
   assert_ahoy_test

scripts/vortex/provision.sh

@@ -35,6 +35,14 @@ VORTEX_PROVISION_USE_MAINTENANCE_MODE="${VORTEX_PROVISION_USE_MAINTENANCE_MODE:-
 # state before any updates ran (for example, DB caching in CI).
 VORTEX_PROVISION_POST_OPERATIONS_SKIP="${VORTEX_PROVISION_POST_OPERATIONS_SKIP:-0}"
 
+# Provision database dump file.
+# If not set, it will be auto-discovered from the VORTEX_DB_DIR directory using
+# the VORTEX_DB_FILE name.
+VORTEX_PROVISION_DB="${VORTEX_PROVISION_DB:-}"
+
+# Directory with custom provision scripts.
+VORTEX_PROVISION_SCRIPTS_DIR="${VORTEX_PROVISION_SCRIPTS_DIR:-./scripts/custom}"
+
 # Name of the webroot directory with Drupal codebase.
 WEBROOT="${WEBROOT:-web}"
 
@@ -74,15 +82,19 @@ yesno() { [ "${1}" = "1" ] && echo "Yes" || echo "No"; }
 
 info "Started site provisioning."
 
-[ "${VORTEX_PROVISION_SKIP}" = "1" ] && pass "Skipped site provisioning as VORTEX_PROVISION_SKIP is set to 1." && exit 0
-
-# Normalize the provision type.
-VORTEX_PROVISION_TYPE=${VORTEX_PROVISION_TYPE:-'database'}
-case ${VORTEX_PROVISION_TYPE} in database | profile) ;; *) VORTEX_PROVISION_TYPE='database' ;; esac
+if [ "${VORTEX_PROVISION_SKIP}" = "1" ]; then
+  pass "Skipped site provisioning as VORTEX_PROVISION_SKIP is set to 1."
+  info "Finished site provisioning."
+  exit 0
+fi
 
-## Convert DB dir starting with './' to a full path.
+# Convert DB dir starting with './' to a full path.
 [ "${VORTEX_DB_DIR#./}" != "${VORTEX_DB_DIR}" ] && VORTEX_DB_DIR="$(pwd)${VORTEX_DB_DIR#.}"
 
+if [ -z "${VORTEX_PROVISION_DB}" ]; then
+  VORTEX_PROVISION_DB="${VORTEX_PROVISION_DB:-"${VORTEX_DB_DIR}/${VORTEX_DB_FILE}"}"
+fi
+
 drush_version="$(drush --version | cut -d' ' -f4)"
 drupal_version="$(drush status --field=drupal-version 2>/dev/null || echo "Unknown")"
 site_is_installed="$(drush status --fields=bootstrap 2>/dev/null | grep -q "Successful" && echo "1" || echo "0")"
@@ -92,9 +104,11 @@ if [ -z "${DRUPAL_CONFIG_PATH}" ]; then
   DRUPAL_CONFIG_PATH="$(drush php:eval 'print realpath(\Drupal\Core\Site\Settings::get("config_sync_directory"));')"
   [ ! -d "${DRUPAL_CONFIG_PATH}" ] && fail "Config directory \"${DRUPAL_CONFIG_PATH:-<empty>}\" does not exist." && exit 1
 fi
-
 site_has_config="$(test "$(ls -1 ${DRUPAL_CONFIG_PATH}/*.yml 2>/dev/null | wc -l | tr -d ' ')" -gt 0 && echo "1" || echo "0")"
 
+# Normalize the provision type.
+[ "${VORTEX_PROVISION_TYPE}" = "profile" ] || VORTEX_PROVISION_TYPE=database
+
 ################################################################################
 # Print provisioning information.
 ################################################################################
@@ -107,7 +121,7 @@ note "Public files path              : ${DRUPAL_PUBLIC_FILES-<empty>}"
 note "Private files path             : ${DRUPAL_PRIVATE_FILES-<empty>}"
 note "Temporary files path           : ${DRUPAL_TEMPORARY_FILES-<empty>}"
 note "Config files path              : ${DRUPAL_CONFIG_PATH}"
-note "DB dump file path              : ${VORTEX_DB_DIR}/${VORTEX_DB_FILE} ($([ -f "${VORTEX_DB_DIR}/${VORTEX_DB_FILE}" ] && echo "present" || echo "absent"))"
+note "DB dump file path              : ${VORTEX_PROVISION_DB} ($([ -f "${VORTEX_PROVISION_DB}" ] && echo "present" || echo "absent"))"
 if [ -n "${VORTEX_DB_IMAGE:-}" ]; then
   note "DB dump container image        : ${VORTEX_DB_IMAGE}"
 fi
@@ -128,17 +142,17 @@ echo
 # Provision site by importing the database from the dump file.
 #
 provision_from_db() {
-  if [ ! -f "${VORTEX_DB_DIR}/${VORTEX_DB_FILE}" ]; then
+  if [ ! -f "${VORTEX_PROVISION_DB}" ]; then
     echo
     fail "Unable to import database from file."
-    note "Dump file ${VORTEX_DB_DIR}/${VORTEX_DB_FILE} does not exist."
+    note "Dump file ${VORTEX_PROVISION_DB} does not exist."
     note "Site content was not changed."
     exit 1
   fi
 
   drush sql:drop
 
-  drush sql:cli <"${VORTEX_DB_DIR}/${VORTEX_DB_FILE}"
+  drush sql:cli <"${VORTEX_PROVISION_DB}"
 
   pass "Imported database from the dump file."
 }
@@ -177,7 +191,7 @@ provision_from_profile() {
 # sufficient output for debugging.
 if [ "${VORTEX_PROVISION_TYPE}" = "database" ]; then
   info "Provisioning site from the database dump file."
-  note "Dump file path: ${VORTEX_DB_DIR}/${VORTEX_DB_FILE}"
+  note "Dump file path: ${VORTEX_PROVISION_DB}"
 
   if [ "${site_is_installed}" = "1" ]; then
     note "Existing site was found when provisioning from the database dump file."
@@ -292,10 +306,10 @@ else
 fi
 
 # Run custom provision scripts.
-# The files should be located in "./scripts/custom/" directory
-# and must have "provision-" prefix and ".sh" extension.
-if [ -d "./scripts/custom" ]; then
-  for file in ./scripts/custom/provision-*.sh; do
+# The files should be located in VORTEX_PROVISION_SCRIPTS_DIR directory,
+# must have "provision-" prefix and ".sh" extension.
+if [ -d "${VORTEX_PROVISION_SCRIPTS_DIR}" ]; then
+  for file in "${VORTEX_PROVISION_SCRIPTS_DIR}"/provision-*.sh; do
     if [ -f "${file}" ]; then
       task "Running custom post-install script '${file}'."
       echo