[#699] Added support for downloading DB from S3. (#2256)

Author: AlexSkrypnyk

.env

@@ -202,6 +202,16 @@ VORTEX_DB_DOWNLOAD_FTP_PORT=21
 VORTEX_DB_DOWNLOAD_FTP_FILE=db.sql
 #;> DB_DOWNLOAD_SOURCE_FTP
 
+#;< DB_DOWNLOAD_SOURCE_S3
+# Database dump file sourced from S3.
+
+# AWS S3 bucket name for database download.
+VORTEX_DB_DOWNLOAD_S3_BUCKET=
+
+# AWS S3 region.
+VORTEX_DB_DOWNLOAD_S3_REGION=ap-southeast-2
+#;> DB_DOWNLOAD_SOURCE_S3
+
 # Environment to download the database from.
 #
 # Applies to hosting environments.

.env.local.example

@@ -60,12 +60,21 @@ VORTEX_ACQUIA_SECRET=
 # VORTEX_DB_DOWNLOAD_SSH_FILE=
 #;> DB_DOWNLOAD_SOURCE_LAGOON
 
+#;< DB_DOWNLOAD_SOURCE_S3
+# Database dump file sourced from S3.
+
+# AWS access key for S3 database download.
+VORTEX_DB_DOWNLOAD_S3_ACCESS_KEY=
+# AWS secret key for S3 database download.
+VORTEX_DB_DOWNLOAD_S3_SECRET_KEY=
+#;> DB_DOWNLOAD_SOURCE_S3
+
 #;< DB_DOWNLOAD_SOURCE_CONTAINER_REGISTRY
 # Database image sourced from a container registry.
 
 # The username to log into the container registry.
-VORTEX_CONTAINER_REGISTRY_USER=$DOCKER_USER
+VORTEX_CONTAINER_REGISTRY_USER=
 # The password (token) to log into the container registry.
-VORTEX_CONTAINER_REGISTRY_PASS=$DOCKER_PASS
+VORTEX_CONTAINER_REGISTRY_PASS=
 #;> DB_DOWNLOAD_SOURCE_CONTAINER_REGISTRY
 #;> !PROVISION_TYPE_PROFILE

.vortex/docs/content/development/variables.mdx

@@ -19,6 +19,8 @@ class DatabaseDownloadSource extends AbstractHandler {
 
   const CONTAINER_REGISTRY = 'container_registry';
 
+  const S3 = 's3';
+
   const NONE = 'none';
 
   /**
@@ -45,6 +47,7 @@ public function options(array $responses): ?array {
       self::ACQUIA => 'Acquia backup',
       self::LAGOON => 'Lagoon environment',
       self::CONTAINER_REGISTRY => 'Container registry',
+      self::S3 => 'S3 bucket',
       self::NONE => 'None',
     ];
 
@@ -105,6 +108,7 @@ public function process(): void {
       DatabaseDownloadSource::ACQUIA,
       DatabaseDownloadSource::LAGOON,
       DatabaseDownloadSource::CONTAINER_REGISTRY,
+      DatabaseDownloadSource::S3,
     ];
 
     foreach ($types as $type) {

.vortex/installer/src/Prompts/Handlers/DatabaseDownloadSource.php

@@ -6,6 +6,6 @@
 +# Database image sourced from a container registry.
 +
 +# The username to log into the container registry.
-+VORTEX_CONTAINER_REGISTRY_USER=$DOCKER_USER
++VORTEX_CONTAINER_REGISTRY_USER=
 +# The password (token) to log into the container registry.
-+VORTEX_CONTAINER_REGISTRY_PASS=$DOCKER_PASS
++VORTEX_CONTAINER_REGISTRY_PASS=

.vortex/installer/tests/Fixtures/handler_process/db_download_source_container_registry/.env.local

@@ -6,6 +6,6 @@
 +# Database image sourced from a container registry.
 +
 +# The username to log into the container registry.
-+VORTEX_CONTAINER_REGISTRY_USER=$DOCKER_USER
++VORTEX_CONTAINER_REGISTRY_USER=
 +# The password (token) to log into the container registry.
-+VORTEX_CONTAINER_REGISTRY_PASS=$DOCKER_PASS
++VORTEX_CONTAINER_REGISTRY_PASS=

.vortex/installer/tests/Fixtures/handler_process/db_download_source_container_registry/.env.local.example

@@ -0,0 +1,40 @@
+@@ -142,13 +142,16 @@
+ VORTEX_DB_FILE=db.sql
+ 
+ # Database download source.
+-VORTEX_DB_DOWNLOAD_SOURCE=url
++VORTEX_DB_DOWNLOAD_SOURCE=s3
+ 
+-# Database dump file sourced from a URL.
+-#
+-# HTTP Basic Authentication credentials should be embedded into the value.
+-VORTEX_DB_DOWNLOAD_URL=
++# Database dump file sourced from S3.
+ 
++# AWS S3 bucket name for database download.
++VORTEX_DB_DOWNLOAD_S3_BUCKET=
++
++# AWS S3 region.
++VORTEX_DB_DOWNLOAD_S3_REGION=ap-southeast-2
++
+ # Environment to download the database from.
+ #
+ # Applies to hosting environments.
+@@ -199,17 +202,3 @@
+ # with optional names in the format "email|name".
+ # Example: "to1@example.com|Jane Doe, to2@example.com|John Doe"
+ VORTEX_NOTIFY_EMAIL_RECIPIENTS="webmaster@star-wars.com|Webmaster"
+-
+-################################################################################
+-#                                  DEMO                                        #
+-################################################################################
+-#                                                                              #
+-# Override project-specific values for demonstration purposes.                 #
+-# Used to showcase Vortex without asking users to perform additional steps.    #
+-#                                                                              #
+-# Remove this section after completing database download integration.          #
+-#                                                                              #
+-################################################################################
+-
+-# URL of the database used for demonstration with URL database download type.
+-VORTEX_DB_DOWNLOAD_URL=https://github.com/drevops/vortex/releases/download/__VERSION__/db_d11.demo.sql

.vortex/installer/tests/Fixtures/handler_process/db_download_source_s3/.env

@@ -0,0 +1,11 @@
+@@ -32,3 +32,10 @@
+ 
+ # Always override existing downloaded DB dump.
+ VORTEX_DB_DOWNLOAD_FORCE=1
++
++# Database dump file sourced from S3.
++
++# AWS access key for S3 database download.
++VORTEX_DB_DOWNLOAD_S3_ACCESS_KEY=
++# AWS secret key for S3 database download.
++VORTEX_DB_DOWNLOAD_S3_SECRET_KEY=

.vortex/installer/tests/Fixtures/handler_process/db_download_source_s3/.env.local

@@ -0,0 +1,11 @@
+@@ -32,3 +32,10 @@
+ 
+ # Always override existing downloaded DB dump.
+ VORTEX_DB_DOWNLOAD_FORCE=1
++
++# Database dump file sourced from S3.
++
++# AWS access key for S3 database download.
++VORTEX_DB_DOWNLOAD_S3_ACCESS_KEY=
++# AWS secret key for S3 database download.
++VORTEX_DB_DOWNLOAD_S3_SECRET_KEY=

.vortex/installer/tests/Fixtures/handler_process/db_download_source_s3/.env.local.example

@@ -40,6 +40,10 @@ public static function dataProviderHandlerProcess(): array {
           Env::put(PromptManager::makeEnvName(AiCodeInstructions::id()), AiCodeInstructions::CLAUDE);
         }),
       ],
+
+      'db download source, s3' => [
+        static::cw(fn() => Env::put(PromptManager::makeEnvName(DatabaseDownloadSource::id()), DatabaseDownloadSource::S3)),
+      ],
     ];
   }