cap_db_dump 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b17670872f50b5f6e4ced82d27850b86d69f5f544c16ffd2255f9be0550d0f5
-  data.tar.gz: 95a520425a6edf34da30890fb9cc898fac58b20c9ba5c152b6ca0e7dd7fe89ec
+  metadata.gz: 634f242534913169dcad7483e973eabf67248bc7615a3efa44db678195e9a9ae
+  data.tar.gz: 87cd8de8ad173684cee9963b6c14717a6135affb8db7c45cba3959978cd1b7ae
 SHA512:
-  metadata.gz: 4e9a93f1adcbbf42ceeff9f4da05913f2df61ca31be12afa6c42fb44dd0334258f633cc0ce3f7cf91ad5938668b0031ea27df22962f8f9bafc4874983e7208ba
-  data.tar.gz: a990d7fc1d50cf589c1d0b0af8be81aa238f6c1e75a7f55855d28170213a3f9357aebcd63fbd248a2988fa5ba5afe8e038aa5d2edfcaa362adb2270fec6cddd9
+  metadata.gz: 39108992543cb7bd245f2fbd18ba463599bbd16d5f310675c860b0e5ef3ad37f349bd8f698fe35bb2c5c4180982cb9a354e1169aa110efef200e19a065722e44
+  data.tar.gz: 4375688a259683891cf56f77c43e3624b50c7ca024a061f09c813432199922758922f801d3019492565b0644badcbd3eaa1f168e69241ee223467ed3866ffdca

data/lib/cap_db_dump/recipes.rb

@@ -1,3 +1,6 @@
+require "json"
+require "yaml"
+
 Capistrano::Configuration.instance(:must_exist).load do
   namespace :database do
     DATABASE_ENGINES = [
@@ -12,6 +15,9 @@ Capistrano::Configuration.instance(:must_exist).load do
     set :database_engine, :mysql # specify :mysql | :psql
     # https://www.postgresql.org/docs/12/app-pgdump.html
     set :pg_dump_format, :c # specify c: 'compressed' (aka -Fc), :d 'directory', or set to nil for plain text
+    # :yaml reads config/database.yml as plain YAML, :rails asks `rails runner` on the server for the
+    # resolved config, and :auto uses :yaml unless database.yml contains ERB.
+    set :database_config_source, :auto
 
     module CapDbDumpHelpers
       def dump_path
@@ -50,6 +56,32 @@ Capistrano::Configuration.instance(:must_exist).load do
         @database_yml ||= read_db_yml
       end
 
+      def database_yml_path
+        "#{current_path}/config/database.yml"
+      end
+
+      def database_config_from_yaml(yaml)
+        YAML.safe_load(yaml, aliases: true)
+      end
+
+      # rvm-capistrano wraps commands in `rvm-shell '...' -c '...'`, so this must not contain single quotes.
+      def rails_runner_database_config_command
+        ruby = "puts :CAP_DB_DUMP_CONFIG_BEGIN, ActiveRecord::Base.connection_db_config.configuration_hash.to_json, :CAP_DB_DUMP_CONFIG_END"
+        "cd #{current_path} && RAILS_ENV=#{rails_env} bundle exec rails runner \"#{ruby}\""
+      end
+
+      # No pty, so stderr stays out of the captured output and the output (which has the password) isn't echoed.
+      def database_config_from_rails
+        output = capture(rails_runner_database_config_command, :pty => false)
+        json = output[/CAP_DB_DUMP_CONFIG_BEGIN\s*(\{.*?\})\s*CAP_DB_DUMP_CONFIG_END/m, 1]
+
+        unless json
+          raise "Could not find the database config in the output of rails runner"
+        end
+
+        { rails_env.to_s => JSON.parse(json) }
+      end
+
       def tasks_matching_for_db_dump
         { :only => { :db_dump => true } }
       end
@@ -63,27 +95,61 @@ Capistrano::Configuration.instance(:must_exist).load do
           raise "Cannot be run in dry_run mode!"
         end
 
-        yaml = capture("cat #{current_path}/config/database.yml")
-        YAML.safe_load(yaml, aliases: true)
+        case database_config_source.to_sym
+        when :yaml
+          database_config_from_yaml(capture("cat #{database_yml_path}"))
+        when :rails
+          database_config_from_rails
+        when :auto
+          yaml = capture("cat #{database_yml_path}")
+          yaml.include?("<%") ? database_config_from_rails : database_config_from_yaml(yaml)
+        else
+          raise "Unknown database_config_source. use one of: [:yaml, :rails, :auto]"
+        end
       end
     end
 
+    def database_password?
+      database_password && !database_password.to_s.empty?
+    end
+
+    # --defaults-extra-file must be the first option given to mysqldump
     def mysql_password_field
-      database_password && database_password.length > 0 ? "-p#{database_password}" : ""
+      database_password? ? "--defaults-extra-file=/dev/stdin" : ""
+    end
+
+    def mysql_password_stdin
+      escaped_password = database_password.to_s.gsub("\\") { "\\\\" }
+      "[client]\npassword=\"#{escaped_password}\"\n"
+    end
+
+    def database_port?
+      database_port && !database_port.to_s.strip.empty?
     end
 
     def postgres_port
-      database_port ? "-p #{database_port}" : ""
+      database_port? ? "-p #{database_port}" : ""
     end
 
     def pg_password
-      database_password && !database_password.empty? ?
-        "PGPASSWORD=#{database_password}" :
-        ""
+      database_password? ? "IFS= read -r PGPASSWORD && export PGPASSWORD &&" : ""
+    end
+
+    def pg_password_stdin
+      "#{database_password}\n"
+    end
+
+    # A pty would echo the password on stdin back into the (logged) output.
+    def run_with_password(command, stdin_data)
+      if database_password?
+        run command, :data => stdin_data, :eof => true, :pty => false
+      else
+        run command
+      end
     end
 
     def pg_port
-      database_port && !database_port.empty? ? "-p #{database_port}" : ""
+      database_port? ? "-p #{database_port}" : ""
     end
 
     task :create_dump, tasks_matching_for_db_dump do
@@ -94,9 +160,10 @@ Capistrano::Configuration.instance(:must_exist).load do
 
         ignored_tables = ignored_tables.join(" ")
 
-        command = "mysqldump -u #{database_username} -h #{database_host} #{mysql_password_field} -Q "
+        command = "mysqldump #{mysql_password_field} -u #{database_username} -h #{database_host} -Q "
         command << "--add-drop-table -O add-locks=FALSE --lock-tables=FALSE --single-transaction "
         command << "#{ignored_tables} #{database_name} > #{dump_path}"
+        password_stdin = mysql_password_stdin
       elsif database_engine == POSTGRES
         ignored_tables = schema_only_tables.map { |table_name|
           "--exclude-table=#{database_name}.#{table_name}"
@@ -109,13 +176,14 @@ Capistrano::Configuration.instance(:must_exist).load do
           command << "-F#{pg_dump_format} "
         end
         command << "#{ignored_tables} #{database_name} > #{dump_path}"
+        password_stdin = pg_password_stdin
       else
         raise "Unknown database engine. use one of: #{DATABASE_ENGINES.inspect}"
       end
 
       give_description "About to dump production DB"
 
-      run command
+      run_with_password command, password_stdin
       dump_schema_tables if schema_only_tables.any?
     end
 
@@ -124,7 +192,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         table_names = schema_only_tables.join(" ")
 
         if database_engine == MYSQL
-          command = "mysqldump -u #{database_username} -h #{database_host} #{mysql_password_field} "
+          command = "mysqldump #{mysql_password_field} -u #{database_username} -h #{database_host} "
           command << "-Q --add-drop-table --single-transaction --no-data #{database_name} #{table_names} >> #{dump_path}"
         elsif database_engine == POSTGRES
           raise "not yet supported. PR's welcome! (https://github.com/smtlaissezfaire/cap_db_dump)"
@@ -133,7 +201,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         end
 
         give_description "Dumping schema for tables: #{schema_only_tables.join(", ")}"
-        run command
+        run_with_password command, mysql_password_stdin
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cap_db_dump
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Scott Taylor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2026-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano