geordi 9.0.0 → 9.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1060f10e77e6173a1b8d63fd8c2d89579e5be0597a683f5358b01173e4c266de
-  data.tar.gz: 8a44e3cd313e779b84ae9ecfa0f92283f4dd3f45f7525ec0bc298b11a719c389
+  metadata.gz: e93051812acfd619f8d5a2db9c2641bb1ff19cf28835096cec1a2f6fd1487620
+  data.tar.gz: 4bc007b0985800b275de9dd0676cf0cbdf51a57800a4a426c0878738b9b00f43
 SHA512:
-  metadata.gz: c7793fda9e1494d3b1a2cf50dfa7b8c10ff61e8c7462596828fe6e44721f50dedbfe18ba2a2c2fb4e0b354500de9528f6e948e8716c9c1a31ceb42a49c8ea845
-  data.tar.gz: fedd7f3106bc5283b25b5f4e20fe1eda099d76c7e4b01483362cebde5cca516d559241d976ad51486a3bc71e11df5a3c21d14288c10805ad9af8307f48d7dab3
+  metadata.gz: 07105d522e4ed9c4412e95f0e8bd5dfbfbd4c8ea7bb7a58f7f347473eafb5807f7ceeaf82dc18f80dd85c77699970342f91396eec35f4a113a5aad8e0b73dc6d
+  data.tar.gz: 7bb8747a1352e983c3c3cecc848ae2097a01341e8c1bd0d1b32537e0470085d43cec4a639dbdc36eaacdd8fad5f4bce981032c8d06efe11c8ab0951afe4bbaec

data/CHANGELOG.md

@@ -3,7 +3,6 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-
 ## Unreleased
 
 ### Compatible changes
@@ -11,10 +10,30 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ### Breaking changes
 
 
+## 9.3.0 2022-04-26
+
+### Compatible changes
+* Add dump loading in multi-database-setups.
+
+
+## 9.2.0 2022-02-18
+
+### Compatible changes
+* Change the update mechanism of `geordi chromedriver-update`: This command (and `geordi cucumber`/`geordi tests` if the `auto_update_chromedriver` option is active) will now always update to the latest version of chromedriver for the current chrome version.
+
+
+## 9.1.0 2022-02-14
+
+### Compatible changes
+* `geordi dump` and `dumple` now default to "primary" database or the first
+  entry in a multi-db setup
+* Also added feature tests for `dumple` and structured the script
+
+
 ## 9.0.0 2021-12-02
 
 ### Breaking changes
-* Remove the `geordi docker` command.
+* Remove the `geordi docker` command set.
 
 
 ## 8.0.0 2021-11-08

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (9.0.0)
+    geordi (9.3.0)
       thor (~> 1)
 
 GEM

data/README.md

@@ -53,10 +53,10 @@ installed Chrome.
 
 Setting `auto_update_chromedriver` to `true` in your global Geordi config file 
 (`~/.config/geordi/global.yml`), will automatically update chromedriver before 
-cucumber tests, in case Chrome and chromedriver versions don't match
+cucumber tests if a newer chromedriver version is available.
 
 **Options**
-- `[--quiet-if-matching], [--no-quiet-if-matching]`: Suppress notification if chromedriver and chrome versions match
+- `[--quiet-if-matching], [--no-quiet-if-matching]`: Suppress notification if chromedriver is already on the latest version
 
 
 ### `geordi clean`
@@ -194,15 +194,21 @@ specified target's database and downloads it to `tmp/`.
 `geordi dump staging -l` (with a Capistrano deploy target and the `--load`
 option) sources the dump into the development database after downloading it.
 
-If you are using multiple databases per environment, pass the database name like this:
+If you are using multiple databases per environment, Geordi defaults to the
+"primary" database, or the first entry in database.yml. To target a specific
+database, pass the database name like this:
+```
+geordi dump -d primary
+```
 
-    geordi dump -d primary
-
-Loading a dump into one of multiple local databases is not supported yet.
+When used with the blank `load` option ("dump and source"), the `database` option
+will be respected both for the remote *and* the local database. If these should
+not match, please issue separate commands for dumping (`dump -d`) and sourcing
+(`dump -l -d`).
 
 **Options**
 - `-l, [--load=[DUMP_FILE]]`: Load a dump
-- `-d, [--database=NAME]`: Database name, if there are multiple databases
+- `-d, [--database=NAME]`: Target database, if there are multiple databases
 
 
 ### `geordi help [COMMAND]`

data/exe/dumple

@@ -1,28 +1,33 @@
 #!/usr/bin/env ruby
 
-require 'erb'
-
-fail_gently = ARGV.include?("--fail-gently")
-compress = ARGV.include?("--compress")
-
 if ARGV.include?("-i")
   puts "*******************************************************"
   puts
   system("du -sh ~/dumps")
   puts
   puts "*******************************************************"
+
   exit
 end
 
-###
-
+require 'erb'
 require "yaml"
-config_path = 'config/database.yml'
 
-begin
-  # go to project root
+DB_CONFIG_PATH = 'config/database.yml'
+DUMPS_DIR = "#{ENV['HOME']}/dumps"
+
+def run(*args)
+  if !!ENV['GEORDI_TESTING']
+    puts "system #{args.join(', ')}"
+    true # "Command succeeded"
+  else
+    system *args
+  end
+end
+
+def cd_to_project_root(fail_gently)
   current = Dir.pwd
-  until (File.exists? config_path)
+  until File.exists?(DB_CONFIG_PATH)
     Dir.chdir '..'
     if current == Dir.pwd
       if fail_gently
@@ -38,46 +43,24 @@ begin
         sleep 5
         exit
       else
-        raise "Call me from inside a Rails project."
+        raise "x Call me from inside a Rails project."
       end
     end
     current = Dir.pwd
   end
+end
 
-  config = YAML::load(ERB.new(File.read(config_path)).result)
-  environment, database = ARGV.reject{ |arg| arg[0].chr == '-' }
-  environment ||= 'production'
-  config = config[environment] or raise "No #{environment} database found.\nUsage: dumple ENVIRONMENT [DATABASE]"
-
-  if database
-    config = config[database] or raise %(Unknown #{environment} database "#{database}")
-  end
-
-  dump_dir = "#{ENV['HOME']}/dumps"
-  unless File.directory?(dump_dir)
-    Dir.mkdir(dump_dir)
-    system("chmod 700 #{dump_dir}")
-  end
-
-  if ARGV.find{ |arg| arg == '--for_download'}
-    dump_path = "#{dump_dir}/dump_for_download.dump"
-  else
-    dump_path = "#{dump_dir}/#{config['database']}_#{Time.now.strftime("%Y%m%d_%H%M%S")}.dump"
-  end
-
-  given_database = database ? %(#{database} ) : ""
-  puts "> Dumping #{given_database}database for \"#{environment}\" environment ..."
-
+def dump_command(dump_file, config)
   host = config['host']
   port = config['port']
 
-  dump_command = case config['adapter']
+  case config['adapter']
   when /mysql/
     command = "mysqldump"
     command << " -u\"#{config['username']}\""
     command << " -p\"#{config['password']}\""
     command << " #{config['database']}"
-    command << " -r #{dump_path}"
+    command << " -r #{dump_file}"
     # Using a transaction to allow concurrent request while creating a dump.
     # This works only reliable for InnoDB tables.
     # More details: https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html#option_mysqldump_single-transaction
@@ -96,25 +79,75 @@ begin
     command << " pg_dump #{config['database']}"
     command << " --clean"
     command << " --format=custom"
-    command << " --file=#{dump_path}"
+    command << " --file=#{dump_file}"
     command << " --username=\"#{config['username']}\""
     command << " --host=#{host}" if host
     command << " --port=#{port}" if port
     command
   else
-    raise "Adapter \"#{config['adapter']}\" is not supported"
+    raise %(x Adapter "#{config['adapter']}" is not supported.)
+  end
+end
+
+def find_database_config(config_path, environment, database)
+  environment ||= 'production'
+  database_yml = ERB.new(File.read(config_path)).result
+  config = YAML::load(database_yml)
+  config = config[environment] or raise "x No #{environment} database found.\nUsage: dumple ENVIRONMENT [DATABASE]"
+
+  if config.values[0].is_a? Hash # Multi-db setup
+    if database # Explicitly requested
+      config = config[database] or raise %(x Unknown #{environment} database "#{database}".)
+    elsif config.key? 'primary'
+      puts '> Multiple databases detected. Defaulting to primary database.'
+      config = config['primary']
+    else
+      puts "> Multiple databases detected. Defaulting to first entry (#{config.keys[0]})."
+      config = config.values[0]
+    end
+  else # Single-db setup
+    if database
+      raise %(x Could not select "#{database}" database in a single-db environment.)
+    end
   end
-  success = system(dump_command)
-  success or raise "Creating the dump failed"
 
-  system "chmod 600 #{dump_path}"
+  config
+end
+
+def prepare_dump_path(config)
+  unless File.directory?(DUMPS_DIR)
+    Dir.mkdir(DUMPS_DIR)
+    run "chmod 700 #{DUMPS_DIR}"
+  end
+
+  if ARGV.include? '--for_download'
+    "#{DUMPS_DIR}/dump_for_download.dump"
+  else
+    "#{DUMPS_DIR}/#{config['database']}_#{Time.now.strftime("%Y%m%d_%H%M%S")}.dump"
+  end
+end
+
+begin
+  fail_gently = ARGV.include?("--fail-gently")
+  compress = ARGV.include?("--compress")
+  environment, database = ARGV.reject { |arg| arg[0].chr == '-' }
+
+  cd_to_project_root(fail_gently)
+  config = find_database_config(DB_CONFIG_PATH, environment, database)
+  dump_path = prepare_dump_path(config)
+
+  # Dump!
+  given_database = database ? %(#{database} ) : ""
+  command = dump_command(dump_path, config)
+  puts "> Dumping #{given_database}database for \"#{environment}\" environment ..."
+  run command or raise "x Creating the dump failed."
+  run "chmod 600 #{dump_path}"
 
   if compress
     puts "> Compressing the dump ..."
-
     # gzip compresses in place
-    compress_success = system("gzip #{dump_path}")
-    compress_success or raise "Compressing the dump failed"
+    compress_success = run "gzip #{dump_path}"
+    compress_success or raise "x Compressing the dump failed."
     dump_path << ".gz"
   end
 

data/geordi.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.description = spec.summary
   spec.homepage = 'https://makandra.com'
   spec.license = 'MIT'
+  spec.metadata = { 'rubygems_mfa_required' => 'true' }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/geordi/chromedriver_updater.rb

@@ -7,18 +7,13 @@ module Geordi
 
     def run(options)
       chrome_version = determine_chrome_version
-      chromedriver_version = determine_chromedriver_version
+      current_chromedriver_version = determine_chromedriver_version
 
-      if skip_update?(chrome_version, chromedriver_version)
-        Interaction.success "No update required: both Chrome and chromedriver are on v#{chrome_version}!" unless options[:quiet_if_matching]
+      latest_chromedriver_version = latest_version(chrome_version)
+      if current_chromedriver_version == latest_chromedriver_version
+        Interaction.success "No update required: Chromedriver is already on the latest version v#{latest_chromedriver_version}!" unless options[:quiet_if_matching]
       else
-        chromedriver_zip = download_chromedriver(chrome_version)
-        unzip(chromedriver_zip, File.expand_path('~/bin'))
-
-        chromedriver_zip.unlink
-
-        # We need to determine the version again, as it could be nil in case no chromedriver was installed before
-        Interaction.success "Chromedriver updated to v#{determine_chromedriver_version}."
+        update_chromedriver(latest_chromedriver_version)
       end
     end
 
@@ -27,13 +22,13 @@ module Geordi
     def determine_chrome_version
       stdout_str, _error_str, status = Open3.capture3('google-chrome', '--version')
       chrome_version = unless stdout_str.nil?
-        stdout_str[/\AGoogle Chrome (\d+)/, 1]
+        stdout_str[/\AGoogle Chrome ([\d.]+)/, 1]
       end
 
       if !status.success? || chrome_version.nil?
         Interaction.fail('Could not determine the version of Google Chrome.')
       else
-        chrome_version.to_i
+        chrome_version
       end
     end
 
@@ -42,23 +37,32 @@ module Geordi
 
       stdout_str, _error_str, status = Open3.capture3('chromedriver', '-v')
       chromedriver_version = unless stdout_str.nil?
-        stdout_str[/\AChromeDriver (\d+)/, 1]
+        stdout_str[/\AChromeDriver ([\d.]+)/, 1]
       end
 
       if !status.success? || chromedriver_version.nil?
         Interaction.fail('Could not determine the version of chromedriver.')
       else
-        chromedriver_version.to_i
+        chromedriver_version
       end
     end
 
-    def skip_update?(chrome_version, chromedriver_version)
-      chrome_version == chromedriver_version
+    # Check https://groups.google.com/a/chromium.org/g/chromium-discuss/c/4BB4jmsRyv8/m/TY3FXS4HBgAJ
+    # for information how chrome version numbers work
+    def major_version(full_version)
+      full_version.match(/^(\d+\.\d+\.\d+)\.\d+$/)[1]
     end
 
-    def download_chromedriver(chrome_version)
-      latest_version = latest_version(chrome_version)
+    def update_chromedriver(latest_chromedriver_version)
+      chromedriver_zip = download_chromedriver(latest_chromedriver_version)
+
+      unzip(chromedriver_zip, File.expand_path('~/bin'))
 
+      # We need to determine the version again, as it could be nil in case no chromedriver was installed before
+      Interaction.success "Chromedriver updated to v#{determine_chromedriver_version}."
+    end
+
+    def download_chromedriver(latest_version)
       uri = URI("https://chromedriver.storage.googleapis.com/#{latest_version}/chromedriver_linux64.zip")
       response = Net::HTTP.get_response(uri)
 
@@ -73,11 +77,13 @@ module Geordi
     end
 
     def latest_version(chrome_version)
-      uri = URI("https://chromedriver.storage.googleapis.com/LATEST_RELEASE_#{chrome_version}")
+      return @latest_version if @latest_version
+
+      uri = URI("https://chromedriver.storage.googleapis.com/LATEST_RELEASE_#{major_version(chrome_version)}")
       response = Net::HTTP.get_response(uri)
 
       if response.is_a?(Net::HTTPSuccess)
-        response.body.to_s
+        @latest_version = response.body.to_s
       else
         Interaction.fail("Could not download the chromedriver v#{chrome_version}.")
       end

data/lib/geordi/commands/chromedriver_update.rb

@@ -7,11 +7,11 @@ installed Chrome.
 
 Setting `auto_update_chromedriver` to `true` in your global Geordi config file 
 (`~/.config/geordi/global.yml`), will automatically update chromedriver before 
-cucumber tests, in case Chrome and chromedriver versions don't match
+cucumber tests if a newer chromedriver version is available.
 LONGDESC
 
 option :quiet_if_matching, type: :boolean, default: false,
-  desc: 'Suppress notification if chromedriver and chrome versions match'
+  desc: 'Suppress notification if chromedriver is already on the latest version'
 
 def chromedriver_update
   require 'geordi/chromedriver_updater'

data/lib/geordi/commands/dump.rb

@@ -11,48 +11,53 @@ specified target's database and downloads it to `tmp/`.
 `geordi dump staging -l` (with a Capistrano deploy target and the `--load`
 option) sources the dump into the development database after downloading it.
 
-If you are using multiple databases per environment, pass the database name like this:
-
-    geordi dump -d primary
-
-Loading a dump into one of multiple local databases is not supported yet.
+If you are using multiple databases per environment, Geordi defaults to the
+"primary" database, or the first entry in database.yml. To target a specific
+database, pass the database name like this:
+```
+geordi dump -d primary
+```
+
+When used with the blank `load` option ("dump and source"), the `database` option
+will be respected both for the remote *and* the local database. If these should
+not match, please issue separate commands for dumping (`dump -d`) and sourcing
+(`dump -l -d`).
 DESC
 
 option :load, aliases: '-l', type: :string, desc: 'Load a dump', banner: '[DUMP_FILE]'
-option :database, aliases: '-d', type: :string, desc: 'Database name, if there are multiple databases', banner: 'NAME'
+option :database, aliases: '-d', type: :string, desc: 'Target database, if there are multiple databases', banner: 'NAME'
 
 def dump(target = nil, *_args)
   require 'geordi/dump_loader'
   require 'geordi/remote'
   database = options[:database] ? "#{options[:database]} " : ''
 
-  if target.nil?
-    if options.load
-      # validate load option
+  if target.nil? # Local …
+    if options.load # … dump loading
       Interaction.fail 'Missing a dump file.' if options.load == 'load'
       File.exist?(options.load) || raise('Could not find the given dump file: ' + options.load)
 
-      loader = DumpLoader.new(options.load)
+      loader = DumpLoader.new(options.load, options.database)
 
       Interaction.announce "Sourcing dump into the #{loader.config['database']} db"
       loader.load
 
       Interaction.success "Your #{loader.config['database']} database has now the data of #{options.load}."
 
-    else
+    else # … dump creation
       Interaction.announce 'Dumping the development database'
       Util.run!("dumple development #{database}")
       Interaction.success "Successfully dumped the #{database}development database."
     end
 
-  else
+  else # Remote dumping …
     database_label = options[:database] ? " (#{database}database)" : ""
 
     Interaction.announce "Dumping the database of #{target}#{database_label}"
     dump_path = Geordi::Remote.new(target).dump(options)
 
-    if options.load
-      loader = DumpLoader.new(dump_path)
+    if options.load # … and dump loading
+      loader = DumpLoader.new(dump_path, options.database)
 
       Interaction.announce "Sourcing dump into the #{loader.config['database']} db"
       loader.load

data/lib/geordi/dump_loader.rb

@@ -6,24 +6,45 @@ require 'geordi/util'
 module Geordi
   class DumpLoader
 
-    def initialize(file)
+    def initialize(file, database)
       @dump_file = file
+      @database = database
     end
 
     def development_database_config
+      return @config if @config
+
       require 'yaml'
 
       evaluated_config_file = ERB.new(File.read('config/database.yml')).result
 
       # Allow aliases and a special set of classes like symbols and time objects
       permitted_classes = [Symbol, Time]
-      @config ||= if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
+      database_config = if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
         YAML.safe_load(evaluated_config_file, permitted_classes: permitted_classes, aliases: true)
       else
         YAML.safe_load(evaluated_config_file, permitted_classes, [], true)
       end
 
-      @config['development']
+      development_config = database_config['development']
+
+      if development_config.values[0].is_a? Hash # Multi-db setup
+        @config = if @database
+          development_config[@database] || Interaction.fail(%(Unknown development database "#{@database}".))
+        elsif development_config.has_key? 'primary'
+          development_config['primary']
+        else
+          development_config.values[0]
+        end
+      else # Single-db setup
+        if @database
+          Interaction.fail %(Could not select "#{@database}" database in a single-db setup.)
+        else
+          @config = development_config
+        end
+      end
+
+      @config
     end
     alias_method :config, :development_database_config
 
@@ -61,9 +82,12 @@ module Geordi
     end
 
     def load
+      adapter_command = "#{config['adapter']}_command"
+      Interaction.fail "Unknown database adapter #{config['adapter'].inspect} in config/database.yml." unless respond_to? adapter_command
+
       Interaction.note 'Source file: ' + dump_file
 
-      source_command = send("#{config['adapter']}_command")
+      source_command = send(adapter_command)
       Util.run! source_command, fail_message: "An error occurred loading #{File.basename(dump_file)}"
     end
 

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '9.0.0'.freeze
+  VERSION = '9.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.3.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -96,11 +96,12 @@ files:
 homepage: https://makandra.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 'Support for sequential running of integration tests tagged
   with @solo has been dropped.
 
-'
+  '
 rdoc_options: []
 require_paths:
 - lib
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.30
 signing_key: 
 specification_version: 4
 summary: Collection of command line tools we use in our daily work with Ruby, Rails