pg_export 1.0.0.rc6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca033b9c62cc381584bd9696e9607b63d89f52310a5847b714908c7140e755dc
-  data.tar.gz: 755e0fa8760fa1ba6b2d3d8af65532da26b9a8978b5005853d9aaede8131d748
+  metadata.gz: 568f50f6bbac2163007c60e8a27909ef5090c8ff043b22d4951733f74a31435f
+  data.tar.gz: a7401975c6950a99177279e63f9c8a3a6e39af5f3832c3357d01ac9532f98906
 SHA512:
-  metadata.gz: 01a50e23dff7a059c606aaff6ea744f3ee3da607ffcf5062514c447a0f9413386a7df378ae7467ff9e35745b65d5a78fa96c6e9abf93b6cff2d8dc4fa9be5e55
-  data.tar.gz: a32e7517a57dcc5eee39c40334ea5552709930d2e5bd402eaf55e67c96625b528aa40f99ef2ee5cdbacae8ad052250d2122f87eb83705ab85fa41599a755fff0
+  metadata.gz: 06241c56c3d2cb35c64860e015db5e1d6a638a579372dad8a81c70b00cf4fdf0907c4375b7ff469f1de4c00ab361c15f8744a76791c808f89d85cfb0d8f346fa
+  data.tar.gz: bd265680aa904baedf80e1a006ae5afed705918e7cf393098bac42a6c39d9d3ae23ca62915af5b782c74310b410eb709af890be89405dbe67779fa1a46608a6e

data/.rubocop.yml

@@ -2,8 +2,6 @@ AllCops:
   TargetRubyVersion: 2.3
 
 Metrics/BlockLength:
-  Exclude:
-    - 'bin/pg_export'
   ExcludedMethods: ['describe', 'context']
 
 Layout/LineLength:
@@ -32,6 +30,29 @@ Style/TrailingCommaInHashLiteral:
 
 Metrics/AbcSize:
   Max: 30
+  Exclude:
+    - 'lib/pg_export/configuration_parser.rb'
+    - 'lib/pg_export/configuration.rb'
 
 Metrics/PerceivedComplexity:
   Max: 30
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 200
+
+Layout/ExtraSpacing:
+  Exclude:
+    - 'lib/pg_export/configuration_parser.rb'
+
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/pg_export/configuration.rb'
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Style/Semicolon:
+  Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### 1.0.0 - 2022.05.17
+### 1.0.0 - 2023.12.15
 - Make it compatible with Ruby 3.0
 - Change configuration envs:
   - BACKUP_FTP_HOST -> PG_EXPORT_GATEWAY_HOST
@@ -7,9 +7,12 @@
   - DUMP_ENCRYPTION_KEY -> PG_EXPORT_ENCRYPTION_KEY
 - Drop Ruby 2.3 support
 - Add SSH option
-- Add `encryption_algorithm` option to interface
+- Add `encryption_algorithm` option
+- All command line options has now their equivalents in ENVs (and vice-versa)
 - Remove dry libraries dependencies
-- in case of failure bin/pg_export now returns with 1 exit value
+- In case of failure bin/pg_export now returns exit value 1
+- Improve performance
+- Improve error handling
 
 ### 0.7.7 - 2020.09.07
 

data/README.md

@@ -54,34 +54,48 @@ Or install it yourself as:
       pg_export DATABASE [OPTION..]
       pg_export --interactive DATABASE [OPTION..]
 
+    EXIT VALUES
+      0 - Success
+      1 - Error
+
     ARGUMENTS
       DATABASE - database name to export (when default mode)
-           - phrase to filter database dumps by (when interactive mode)
+               - phrase to filter database dumps by (when interactive mode)
 
     OPTIONS
-      -g, --gateway GATEWAY            Allowed values: ftp, ssh. Default: ftp. Credentials need to be set via ENVs
-      -s, --ssh                        Same as "--gateway ssh"
-      -f, --ftp                        Same as "--gateway ftp"
-      -d, --database DATABASE          Alternative way of specifying name of the database to export or phrase to filter by
-      -e, --encryption_key KEY         Dumps will be SSL encrypted using this key. Should have exactly 16 characters. Overwrites PG_EXPORT_ENCRYPTION_KEY env
-      -a, --algorithm ALGORITHM        Encryption cipher algorithm (default: AES-128-CBC). Overwrites PG_EXPORT_ENCRYPTION_ALGORITHM env. For available option see `$ openssl list -cipher-algorithms`
-      -k, --keep KEEP                  Number of dump files to keep on FTP (default: 10). Overwrites KEEP_DUMPS env
-      -t, --timestamped                Enables log messages with timestamps
-      -m, --muted                      Mutes log messages (overrides -t option)
-      -i, --interactive                Interactive mode, for importing dumps
-      -v, --version                    Show version
-      -h, --help                       Show this message
+      -g, --gateway GATEWAY      Allowed values: ftp, ssh. Default: ftp. Credentials need to be set via ENVs
+      -U, --user USER            Gateway (ftp or ssh) user
+      -H, --host HOST            Gateway (ftp or ssh) host
+      -P, --password PASSWORD    Gateway (ftp or ssh) password
+      -d, --database DATABASE    In plain mode: database name to export;
+                                 In interactive mode: phrase to filter by
+      -e, --encryption_key KEY   Dumps will be SSL encrypted using this key. Should have exactly 16 characters
+      -a, --algorithm ALGORITHM  Encryption cipher algorithm (default: AES-128-CBC);
+                                 For available option see `$ openssl list -cipher-algorithms`
+      -k, --keep KEEP            Number of dump files to keep on FTP (default: 10)
+      -s, --ssh                  Same as "--gateway ssh". When set, the --gateway option is ignored
+      -f, --ftp                  Same as "--gateway ftp". When set, the --gateway option is ignored
+      -t, --timestamped          Prepends log messages with timestamps
+      -m, --muted                Mutes log messages. When set, the -t option is ignored. Prints message only on error
+      -i, --interactive          Interactive mode, for importing dumps. Whan set, the -t and -m options are ignored
+      -w, --welcome              Try connecting to the gateway (FTP or SSH) to verify the connection and exit
+      -c, --configuration        Print the configuration and exit
+      -v, --version              Print version
+      -h, --help                 Print this message and exit
 
     ENV
-      PG_EXPORT_GATEWAY_HOST           required
-      PG_EXPORT_GATEWAY_USER           required
-      PG_EXPORT_GATEWAY_PASSWORD       optional when eg. authorized key is added
-      PG_EXPORT_ENCRYPTION_KEY         required or set by --encryption_key)
-      PG_EXPORT_ENCRYPTION_ALGORITHM   required or set by --algorithm)
+      Each of the above options can be also set using enviromental variables.
+      Use full option names prepending with PG_EXPORT_ phrase.
+      Command line options takes precedence over the ENVs.
+
+      Eg. below two commands are equivalent:
+        pg_export -s -U user -H host database_name -k 10
 
-    TEST RUN
-      -c, --configuration              Print the configuration
-      -w, --welcome                    Try connecting to the gateway (FTP or SSH) to verify the connection
+      Is equivalent to:
+        export PG_EXPORT_GATEWAY_USER=user
+        export PG_EXPORT_GATEWAY_HOST=host
+        export PG_EXPORT_KEEP=20
+        pg_export -s database_name -k 10
 
 ## How to start
 
@@ -96,21 +110,16 @@ __Step 1.__ Prepare ENV variables.
     /* Dumps will be SSL(AES-128-CBC) encrypted using this key. */
     PG_EXPORT_ENCRYPTION_KEY=1234567890abcdef
 
-    /* Dumps to be kept on FTP */
-    /* Optional, defaults to 10 */
-    KEEP_DUMPS=5
-
-Note, that variables cannot include `#` sign, [more info](http://serverfault.com/questions/539730/environment-variable-in-etc-environment-with-pound-hash-sign-in-the-value).
-
 __Step 2.__ Print the configuration to verify if env variables has been loaded properly.
 
     $ pg_export --configuration
     => encryption_key k4***
        gateway_host yourftp.example.com
        gateway_user your_gateway_user
-       gateway_password pass***
+       gateway_password
        logger_format plain
-       keep_dumps 2
+       keep_dumps 10
+       ....
 
 __Step 3.__ Try connecting to FTP to verify the connection.
 
@@ -119,18 +128,18 @@ __Step 3.__ Try connecting to FTP to verify the connection.
 
 __Step 4.__ Perform database export.
 
-    $ pg_export -d your_database [-k 5]
-    => Dump database your_database to your_database_20181016_121314 (1.36MB)
-       Encrypt your_database_20181016_121314 (1.34MB)
+    $ pg_export -d your_database -k 5
+    => Dump database your_database to database_name (1.36MB)
+       Encrypt database_name_20181016_121314 (1.34MB)
        Connect to yourftp.example.com
-       Upload your_database_20181016_121314 (1.34MB) to yourftp.example.com
+       Upload database_name_20181016_121314 (1.34MB) to yourftp.example.com
        Close FTP
 
 ## How to restore a dump?
 
 Run interactive mode and follow the instructions:
 
-    pg_export [-d your_database] -i
+    pg_export [-d database_name] -i
 
 ## Development
 

data/bin/pg_export

@@ -4,143 +4,25 @@
 lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'optparse'
 require 'pg_export'
 
-database = nil
-x = nil
-
-option_parser = OptionParser.new do |opts|
-  opts.banner = <<~TXT
-    NAME
-        pg_export - CLI for exporting/importing PostgreSQL dumps via FTP/SSH
-
-    SYNOPSIS
-        pg_export DATABASE [OPTION..]
-        pg_export --interactive DATABASE [OPTION..]
-
-    EXIT VALUES
-        0 - Success
-        1 - Error
-
-    ARGUMENTS
-        DATABASE - database name to export (when default mode)
-                 - phrase to filter database dumps by (when interactive mode)
-
-    OPTIONS
-  TXT
-
-  opts.program_name = 'pg_export'
-  opts.version = PgExport::VERSION
-
-  opts.on('-g', '--gateway GATEWAY', %w[ftp ssh], 'Allowed values: ftp, ssh. Default: ftp. Credentials need to be set via ENVs') do |g|
-    ENV['GATEWAY'] = g
-  end
-
-  opts.on('-s', '--ssh', 'Same as "--gateway ssh"') do
-    ENV['GATEWAY'] = 'ssh'
-  end
-
-  opts.on('-f', '--ftp', 'Same as "--gateway ftp"') do
-    ENV['GATEWAY'] = 'ftp'
-  end
-
-  opts.on('-d', '--database DATABASE', String, 'Alternative way of specifying name of the database to export or phrase to filter by') do |d|
-    database = d
-  end
-
-  opts.on('-e', '--encryption_key KEY', String, 'Dumps will be SSL encrypted using this key. Should have exactly 16 characters. Overwrites PG_EXPORT_ENCRYPTION_KEY env') do |key|
-    ENV['PG_EXPORT_ENCRYPTION_KEY'] = key
-  end
-
-  opts.on('-a', '--algorithm ALGORITHM', String, 'Encryption cipher algorithm (default: AES-128-CBC). Overwrites PG_EXPORT_ENCRYPTION_ALGORITHM env. For available option see `$ openssl list -cipher-algorithms`') do |key|
-    ENV['PG_EXPORT_ENCRYPTION_KEY'] = key
-  end
-
-  opts.on('-k', '--keep KEEP', String, 'Number of dump files to keep on FTP (default: 10). Overwrites KEEP_DUMPS env') do |keep|
-    ENV['KEEP_DUMPS'] = keep
-  end
-
-  opts.on('-t', '--timestamped', 'Enables log messages with timestamps') do
-    ENV['LOGGER_FORMAT'] = 'timestamped'
-  end
-
-  opts.on('-m', '--muted', 'Mutes log messages (overrides -t option)') do
-    ENV['LOGGER_FORMAT'] = 'muted'
-  end
-
-  opts.on('-i', '--interactive', 'Interactive mode, for importing dumps') do
-    ENV['PG_EXPORT_MODE'] = 'interactive'
-  end
-
-  opts.on('-v', '--version', 'Show version') do
-    puts PgExport::VERSION
-    exit
-  end
-
-  opts.on('-h', '--help', 'Show this message') do
-    puts opts
-    exit
-  end
-
-  opts.separator <<~TXT
-
-    ENV
-        PG_EXPORT_GATEWAY_HOST           required
-        PG_EXPORT_GATEWAY_USER           required
-        PG_EXPORT_GATEWAY_PASSWORD       optional when eg. authorized key is added
-        PG_EXPORT_ENCRYPTION_KEY         required or set by --encryption_key)
-        PG_EXPORT_ENCRYPTION_ALGORITHM   required or set by --algorithm)
-  TXT
-
-  opts.separator "\nTEST RUN"
-
-  opts.on('-c', '--configuration', 'Print the configuration') do
-    x = -> { puts PgExport.new.config }
-  end
-
-  opts.on('-w', '--welcome', 'Try connecting to the gateway (FTP or SSH) to verify the connection') do
-    x = -> { puts PgExport.new.gateway_welcome }
-  end
-
-  if ARGV.empty?
-    puts opts
-    exit
-  end
-end
-
 begin
-  option_parser.parse!
-  if x
-    x.call
-    exit
-  end
-  database = ARGV.first unless ARGV.empty?
-rescue OptionParser::ParseError => e
+  config = PgExport::ConfigurationParser.parse
+  pg_export = PgExport.new(config)
+  result = pg_export.call
+  result
+    .on_success { |outcome| puts outcome if outcome }
+    .on_failure { |outcome| warn outcome[:message]; exit 1 }
+rescue PgExport::ConfigurationParser::Error => e
   warn e.message.capitalize
-  warn 'Details:'
-  warn option_parser.to_s.split("\n").grep(/ #{e.args.first}/).join("\n")
-  warn 'Type "pg_export" for available options'
-  exit 1
-end
-
-begin
-  pg_export = PgExport.new
-rescue PgExport::InitializationError => e
-  warn 'Unable to initialize PgExport due to invalid configuration. Check you ENVs.'
-  warn "Detailed message: #{e.message}"
-  exit 1
-end
 
-begin
-  pg_export
-    .call(database)
-    .on_success { exit 0 }
-    .on_failure do |outcome|
-      warn outcome[:message]
-      exit 1
-    end
+  if e.reason == 'missing argument'
+    warn "\nHint for the #{e.args.first} option:"
+    warn PgExport::ConfigurationParser.help.to_s.split("\n").grep(/ #{e.args.first}/).join("\n")
+  end
 
+  warn 'Type "pg_export -h" to print options.'
+  exit 1
 rescue Interrupt
   puts
 end

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/pg_export/commands_factory.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'pg_export/value_objects/result'
+
+class PgExport
+  class CommandsFactory
+    attr_reader :config
+
+    def initialize(config:)
+      @config = config
+    end
+
+    def print_configuration
+      ->(_) { ValueObjects::Success.new(config) }
+    end
+
+    def gateway_welcome
+      ->(_) { ValueObjects::Success.new(gateway_factory.gateway.welcome) }
+    end
+
+    def print_version
+      ->(_) { ValueObjects::Success.new(PgExport::VERSION) }
+    end
+
+    def print_help
+      ->(_) { ValueObjects::Success.new(PgExport::ConfigurationParser.help) }
+    end
+
+    def export_dump
+      require 'pg_export/transactions/export_dump'
+      require 'pg_export/factories/dump_factory'
+      require 'pg_export/adapters/shell_adapter'
+      require 'pg_export/operations/encrypt_dump'
+      require 'pg_export/operations/open_connection'
+      require 'pg_export/operations/remove_old_dumps'
+      require 'pg_export/repositories/gateway_dump_repository'
+
+      PgExport::Transactions::ExportDump.new(
+        dump_factory: Factories::DumpFactory.new,
+        shell_adapter: Adapters::ShellAdapter.new,
+        encrypt_dump: Operations::EncryptDump.new(cipher_factory: cipher_factory),
+        open_connection: Operations::OpenConnection.new(gateway_factory: gateway_factory),
+        remove_old_dumps: Operations::RemoveOldDumps.new(
+          gateway_dump_repository: Repositories::GatewayDumpRepository.new,
+          keep: config.keep_dumps
+        ),
+        listeners: plain_listeners
+      )
+    end
+
+    def import_dump_interactively
+      require 'pg_export/transactions/import_dump_interactively'
+      require 'pg_export/ui/interactive/input'
+      require 'pg_export/adapters/shell_adapter'
+      require 'pg_export/factories/gateway_dump_file_factory'
+      require 'pg_export/repositories/gateway_dump_repository'
+      require 'pg_export/operations/open_connection'
+      require 'pg_export/operations/decrypt_dump'
+
+      PgExport::Transactions::ImportDumpInteractively.new(
+        input: Ui::Interactive::Input.new,
+        shell_adapter: Adapters::ShellAdapter.new,
+        gateway_dump_file_factory: Factories::GatewayDumpFileFactory.new,
+        gateway_dump_repository: Repositories::GatewayDumpRepository.new,
+        open_connection: Operations::OpenConnection.new(gateway_factory: gateway_factory),
+        decrypt_dump: Operations::DecryptDump.new(cipher_factory: cipher_factory),
+        listeners: interactive_listeners
+      )
+    end
+
+    private
+
+    def gateway_factory
+      if config.gateway == :ftp
+        require 'pg_export/factories/ftp_gateway_factory'
+
+        Factories::FtpGatewayFactory.new(config: config)
+      elsif config.gateway == :ssh
+        require 'pg_export/factories/ssh_gateway_factory'
+
+        Factories::SshGatewayFactory.new(config: config)
+      else
+        raise ArgumentError, "Unknown gateway #{config.gateway}"
+      end
+    end
+
+    def cipher_factory
+      require 'pg_export/factories/cipher_factory'
+
+      Factories::CipherFactory.new(
+        encryption_algorithm: config.encryption_algorithm,
+        encryption_key: config.encryption_key
+      )
+    end
+
+    def plain_listeners
+      require 'pg_export/listeners/plain/prepare_params'
+      require 'pg_export/listeners/plain/build_dump'
+      require 'pg_export/listeners/plain/close_connection'
+      require 'pg_export/listeners/plain/decrypt_dump'
+      require 'pg_export/listeners/plain/download_dump'
+      require 'pg_export/listeners/plain/encrypt_dump'
+      require 'pg_export/listeners/plain/fetch_dumps'
+      require 'pg_export/listeners/plain/open_connection'
+      require 'pg_export/listeners/plain/remove_old_dumps'
+      require 'pg_export/listeners/plain/restore'
+      require 'pg_export/listeners/plain/upload_dump'
+
+      logger = build_logger(config.logger_format)
+
+      {
+        prepare_params: Listeners::Plain::PrepareParams.new(logger: logger),
+        build_dump: Listeners::Plain::BuildDump.new(logger: logger),
+        encrypt_dump: Listeners::Plain::EncryptDump.new(logger: logger),
+        open_connection: Listeners::Plain::OpenConnection.new(logger: logger),
+        upload_dump: Listeners::Plain::UploadDump.new(logger: logger),
+        remove_old_dumps: Listeners::Plain::RemoveOldDumps.new(logger: logger),
+        close_connection: Listeners::Plain::CloseConnection.new(logger: logger)
+      }
+    end
+
+    def interactive_listeners
+      require 'pg_export/listeners/interactive/open_connection'
+      require 'pg_export/listeners/interactive/fetch_dumps'
+      require 'pg_export/listeners/interactive/select_dump'
+      require 'pg_export/listeners/interactive/download_dump'
+      require 'pg_export/listeners/interactive/close_connection'
+      require 'pg_export/listeners/interactive/decrypt_dump'
+      require 'pg_export/listeners/interactive/select_database'
+      require 'pg_export/listeners/interactive/restore'
+
+      {
+        open_connection: Listeners::Interactive::OpenConnection.new,
+        fetch_dumps: Listeners::Interactive::FetchDumps.new,
+        select_dump: Listeners::Interactive::SelectDump.new,
+        download_dump: Listeners::Interactive::DownloadDump.new,
+        close_connection: Listeners::Interactive::CloseConnection.new,
+        decrypt_dump: Listeners::Interactive::DecryptDump.new,
+        select_database: Listeners::Interactive::SelectDatabase.new,
+        restore: Listeners::Interactive::Restore.new,
+      }
+    end
+
+    def build_logger(logger_format)
+      require 'logger'
+
+      formatters = {
+        plain: ->(_, _, _, message) { "#{message}\n" },
+        muted: ->(*) {},
+        timestamped: lambda do |severity, datetime, progname, message|
+          "#{datetime} #{Process.pid} TID-#{Thread.current.object_id.to_s(36)}#{progname} #{severity}: #{message}\n"
+        end
+      }
+
+      Logger.new($stdout, formatter: formatters.fetch(logger_format))
+    end
+  end
+end

data/lib/pg_export/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'optparse'
+
 class PgExport
   class Configuration
     ATTRS = %i[
@@ -11,24 +13,12 @@ class PgExport
       logger_format
       keep_dumps
       gateway mode
+      database
+      command
     ].freeze
 
     attr_reader *ATTRS
 
-    def self.build(env)
-      new(
-        encryption_key: env['PG_EXPORT_ENCRYPTION_KEY'],
-        encryption_algorithm: env['PG_EXPORT_ENCRYPTION_ALGORITHM'],
-        gateway_host: env['PG_EXPORT_GATEWAY_HOST'],
-        gateway_user: env['PG_EXPORT_GATEWAY_USER'],
-        gateway_password: env['PG_EXPORT_GATEWAY_PASSWORD'],
-        logger_format: env['LOGGER_FORMAT'],
-        keep_dumps: env['KEEP_DUMPS'],
-        gateway: env['GATEWAY'],
-        mode: env['PG_EXPORT_MODE']
-      )
-    end
-
     def initialize(
       encryption_key: nil,
       encryption_algorithm: nil,
@@ -38,7 +28,9 @@ class PgExport
       logger_format: nil,
       keep_dumps: nil,
       gateway: nil,
-      mode: nil
+      mode: nil,
+      database: nil,
+      command: nil
     )
 
       @encryption_key = String(encryption_key)
@@ -57,7 +49,9 @@ class PgExport
 
       @logger_format = logger_format.to_s.to_sym
       @logger_format = :plain if @logger_format.empty?
-      raise ArgumentError, 'Logger format must be one of: plain, timestamped, muted' unless %i[plain timestamped muted].include?(@logger_format)
+      unless %i[plain timestamped muted].include?(@logger_format)
+        raise ArgumentError, 'Logger format must be one of: plain, timestamped, muted'
+      end
 
       @keep_dumps = Integer(keep_dumps || 10)
       raise ArgumentError, 'Keep dumps must greater or equal to 1' unless @keep_dumps >= 1
@@ -69,6 +63,11 @@ class PgExport
       @mode = mode.to_s.to_sym
       @mode = :plain if @mode.empty?
       raise ArgumentError, 'Mode must be one of: plain, interactive' unless %i[plain interactive].include?(@mode)
+
+      @database = String(database) unless database.nil?
+
+      @command = command.to_s.to_sym
+      @command = :export_dump if @command.empty?
     end
 
     def to_s