geordi 7.0.1 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f337449e17755555cb74cf3e63e6bef4529f46463f9c10194b3e7d7f9ea9146
-  data.tar.gz: 68702b98b7a81999334dd49fe7a70585fef245004036eaee3f967817d590b368
+  metadata.gz: 337e7767788852ee10b537112f4151f4b12e267740fa20557b7786e12babd97d
+  data.tar.gz: 0dd146812562eb28fa115cbbdefa1bffcc8b172f1b509d44414bcca667ce3774
 SHA512:
-  metadata.gz: 1f346dcc7bee9e66585cc649290306366e2986febdee02a1a0c81092d1481a0bc9382b3940264edc0f10494a9f74841402f4a56eed0e68887854f7f9e894afa4
-  data.tar.gz: 2518973bceb664d2cb321c57f1d05e32c629ef240cd26d29ac997cdeca8a2f97eba9d2d9e76177a82f26422276176415b14c68b16cf5fd8fa8bea141a292a726
+  metadata.gz: '07256569d49cf31224e4a69d5fc0e240d9c8df820e527fd615b1e5956f320fa01077572b4e79401bf7a5ee8b8d9bf135b94c369ef807a2bc40c36aa76eb7180a'
+  data.tar.gz: 18bf3b9d1026575a5c0c3d33281de6b211ffa38c8c0d316656c6aee90bcdc2b81e5cec2feae0f006f2ef3fb8458834c1813dcd8d2aff5adcdf17bed732a06217

data/.github/workflows/test.yml

@@ -31,10 +31,6 @@ jobs:
       run: |
         gem install bundler:2.2.26
         bundle install --no-deployment
-    - name: Install VNC viewer
-      run: |
-        sudo apt-get update
-        sudo apt-get install -y xtightvncviewer
     - name: Run tests
       run: bundle exec rake
     

data/CHANGELOG.md

@@ -3,10 +3,38 @@
 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
+
+### Breaking changes
+
+
+## 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 set.
+
+
+## 8.0.0 2021-11-08
+
+### Breaking changes
+* `geordi branch` now checks out new branches from the current branch instead of master. To check out from master, use `geordi branch -m`.
+
+
+## 7.0.2 2021-10-06
+
+### Compatible changes
+* fix `YAML.safe_load` for `psych` >= 4
 
 
 ## 7.0.1 2021-08-13
@@ -14,6 +42,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ### Compatible changes
 * Fix missing `thor` dependency
 
+
 ## 7.0.0 2021-08-25
 
 ### Breaking changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (7.0.1)
+    geordi (9.1.0)
       thor (~> 1)
 
 GEM
@@ -165,4 +165,4 @@ DEPENDENCIES
   tracker_api
 
 BUNDLED WITH
-   2.2.26
+   2.2.27

data/README.md

@@ -33,6 +33,9 @@ Example: `geordi branch`
 On the first execution we ask for your Pivotal Tracker API token. It will be
 stored in `~/.config/geordi/global.yml`.
 
+**Options**
+- `-m, [--from-master], [--no-from-master]`: Branch from master instead of the current branch
+
 
 ### `geordi capistrano COMMAND`
 Run a capistrano command on all deploy targets.
@@ -157,28 +160,6 @@ instead of `cap deploy:migrations`. You can force using `deploy` by passing the
 - `-c, [--current-branch], [--no-current-branch]`: Set DEPLOY_BRANCH to the current branch during deploy
 
 
-### `geordi docker`
-Manage docker containers for the current project.
-
-Manage docker containers to run your project dockerized.
-
-It expects a `docker-compose.yml` file that specifies all services, and a service
-named "main" that opens a shell for the project.
-
-There are three subcommands:
-
-- `geordi docker setup`
-  Fetches all docker containers.
-
-- `geordi docker shell`
-  Runs the docker service named 'main'.
-  Append `--secondary` to open a second shell in an already running container.
-
-- `geordi docker vnc`
-  Opens a VNC viewer to connect to the VNC server in the container.
-  Append `--setup` to be guided through the setup of VNC viewer.
-
-
 ### `geordi drop-databases`
 Interactively delete local databases.
 
@@ -213,7 +194,9 @@ 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 dump a specific
+database, pass the database name like this:
 
     geordi dump -d primary
 

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/commands/branch.rb

@@ -6,7 +6,9 @@ On the first execution we ask for your Pivotal Tracker API token. It will be
 stored in `~/.config/geordi/global.yml`.
 LONGDESC
 
+option :from_master, aliases: '-m', type: :boolean, desc: 'Branch from master instead of the current branch'
+
 def branch
   require 'geordi/gitpt'
-  Gitpt.new.run_branch
+  Gitpt.new.run_branch(from_master: options.from_master)
 end

data/lib/geordi/commands/dump.rb

@@ -11,7 +11,9 @@ 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 dump a specific
+database, pass the database name like this:
 
     geordi dump -d primary
 
@@ -26,9 +28,8 @@ def dump(target = nil, *_args)
   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)
 
@@ -39,19 +40,19 @@ def dump(target = nil, *_args)
 
       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
+    if options.load # … and dump loading
       loader = DumpLoader.new(dump_path)
 
       Interaction.announce "Sourcing dump into the #{loader.config['database']} db"

data/lib/geordi/dump_loader.rb

@@ -14,8 +14,15 @@ module Geordi
       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
-      @config ||= YAML.safe_load(evaluated_config_file, [Symbol, Time], [], true)
+      permitted_classes = [Symbol, Time]
+      @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']
     end
     alias_method :config, :development_database_config

data/lib/geordi/gitpt.rb

@@ -26,7 +26,7 @@ module Geordi
       end
     end
 
-    def run_branch
+    def run_branch(from_master: false)
       story = choose_story || Interaction.fail('No story selected.')
 
       normalized_story_name = normalize_string(story.name)
@@ -50,7 +50,7 @@ module Geordi
       if branch_name.present?
         checkout_branch branch_name, new_branch: false
       else
-        checkout_branch new_branch_name, new_branch: true
+        checkout_branch new_branch_name, new_branch: true, from_master: from_master
       end
     end
 
@@ -103,8 +103,6 @@ module Geordi
         menu.header = 'Choose a story'
 
         stories.each do |story|
-          print '.' # Progress
-
           state = story.current_state
           owners = story.owners
           owner_is_me = owners.collect(&:id).include?(my_id)
@@ -141,9 +139,9 @@ module Geordi
       HighLine::BOLD + string + HighLine::RESET
     end
 
-    def checkout_branch(name, new_branch: false)
+    def checkout_branch(name, new_branch: false, from_master: false)
       if new_branch
-        Util.run! ['git', 'checkout', 'master']
+        Util.run! ['git', 'checkout', 'master'] if from_master
         Util.run! ['git', 'checkout', '-b', name]
       else
         Util.run! ['git', 'checkout', name]

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '7.0.1'.freeze
+  VERSION = '9.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 9.1.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -67,7 +67,6 @@ files:
 - lib/geordi/commands/cucumber.rb
 - lib/geordi/commands/delete_dumps.rb
 - lib/geordi/commands/deploy.rb
-- lib/geordi/commands/docker.rb
 - lib/geordi/commands/drop_databases.rb
 - lib/geordi/commands/dump.rb
 - lib/geordi/commands/migrate.rb
@@ -87,7 +86,6 @@ files:
 - lib/geordi/commands/yarn_install.rb
 - lib/geordi/cucumber.rb
 - lib/geordi/db_cleaner.rb
-- lib/geordi/docker.rb
 - lib/geordi/dump_loader.rb
 - lib/geordi/gitpt.rb
 - lib/geordi/interaction.rb
@@ -98,7 +96,8 @@ 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.
 
@@ -117,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Collection of command line tools we use in our daily work with Ruby, Rails

data/lib/geordi/commands/docker.rb

@@ -1,52 +0,0 @@
-class DockerCLI < Thor
-  desc 'setup', 'Setup docker and fetch required docker-container for the current project'
-  def setup
-    docker.setup
-  end
-
-  desc 'shell', 'Open a shell in the main docker container for the current project'
-  option :secondary, default: false, type: :boolean
-  map 'shell' => '_shell'
-  def _shell
-    docker.shell(:secondary => options[:secondary])
-  end
-
-  desc 'vnc', 'Open a vnc viewer connecting to the docker container'
-  option :setup, default: false, type: :boolean, desc: 'Guide through the setup of VNC'
-  def vnc
-    if options.setup
-      docker.setup_vnc
-    else
-      docker.vnc
-    end
-  end
-
-  private
-
-  def docker
-    require 'geordi/docker'
-    Geordi::Docker.new
-  end
-end
-
-desc 'docker', 'Manage docker containers for the current project'
-long_desc <<-LONGDESC
-Manage docker containers to run your project dockerized.
-
-It expects a `docker-compose.yml` file that specifies all services, and a service
-named "main" that opens a shell for the project.
-
-There are three subcommands:
-
-- `geordi docker setup`
-  Fetches all docker containers.
-
-- `geordi docker shell`
-  Runs the docker service named 'main'.
-  Append `--secondary` to open a second shell in an already running container.
-
-- `geordi docker vnc`
-  Opens a VNC viewer to connect to the VNC server in the container.
-  Append `--setup` to be guided through the setup of VNC viewer.
-LONGDESC
-subcommand 'docker', DockerCLI

data/lib/geordi/docker.rb

@@ -1,183 +0,0 @@
-require 'geordi/interaction'
-require 'geordi/cucumber'
-require 'yaml'
-require 'open3'
-
-module Geordi
-  class Docker
-    DOCKER_COMPOSE_FILE = 'docker-compose.yml'.freeze
-
-    include Interaction
-
-    def setup
-      check_installation_and_config
-      announce('Fetching containers...')
-      if execute(:system, 'docker-compose', 'pull')
-        success('Fetch successful.')
-      else
-        fail('Fetch failed.')
-      end
-    end
-
-    def shell(options = {})
-      check_installation_and_config
-      if options[:secondary]
-        attach_to_running_shell
-      else
-        run_shell
-      end
-    end
-
-    def vnc
-      check_installation_and_config
-      launch_vnc_viewer('::5967')
-    end
-
-    def setup_vnc
-      `clear`
-      Interaction.note 'This script will help you install a VNC viewer.'
-      Interaction.note 'Please open a second shell to execute instructions.'
-      Interaction.prompt 'Continue ...'
-
-      Interaction.announce 'Setup VNC viewer'
-      vnc_viewer_installed = system('which vncviewer > /dev/null 2>&1')
-      if vnc_viewer_installed
-        Interaction.success 'It appears you already have a VNC viewer installed. Good job!'
-      else
-        puts 'Please run:'
-        Interaction.note_cmd 'sudo apt-get install xtightvncviewer'
-        Interaction.prompt 'Continue ...'
-      end
-
-      puts
-      puts <<~TEXT
-        Done. You can view the VNC window with `geordi docker vnc`.
-      TEXT
-
-      Interaction.success 'Happy cuking!'
-    end
-
-    private
-
-    def launch_vnc_viewer(source)
-      fail('VNC viewer not found. Install it with `geordi docker vnc --setup`.') unless command_exists?('vncviewer')
-
-      fork do
-        error = capture_stderr do
-          system("vncviewer #{source}")
-        end
-        unless $?.success?
-          if $?.exitstatus == 127
-            fail('VNC viewer not found. Install it with `geordi docker vnc --setup`.')
-          else
-            fail("VNC viewer could not be opened: #{error}")
-          end
-        end
-      end
-      exit 0
-    end
-
-    def attach_to_running_shell
-      # The command line output of docker-compose ps changes depending on the container name length, this is
-      # caused by the varying terminal length and results in the longer outputs, e.g the container name and id
-      # to be cut after x characters and the rest being placed in the line below.
-
-      stdout_str, _error_str = execute(:capture, {'COLUMNS' => '400'}, 'docker-compose ps')
-      running_containers = stdout_str.split("\n")
-      if (main_container_line = running_containers.grep(/_main_run/).first)
-        container_name = main_container_line.split(' ').first
-        execute(:exec, 'docker', 'exec', '-it', container_name, 'bash')
-      else
-        fail('Could not find a running shell. Start without --secondary first.')
-      end
-    end
-
-    def run_shell
-      command = [:system, 'docker-compose', 'run', '--service-ports']
-      command += ssh_agent_forward
-      command += ['main']
-      execute(*command)
-      execute(:system, 'docker-compose', 'stop')
-    end
-
-    def execute(kind, *args)
-      if ENV['GEORDI_TESTING']
-        puts "Stubbed run #{args.join(' ')}"
-        if kind == :` || kind == :capture
-          mock_parse(*args)
-        else
-          mock_run(*args)
-        end
-      else
-        if kind == :capture
-          Open3.capture2(*args)
-        else
-          send(kind, *args)
-        end
-      end
-    end
-
-    def mock_run(*args)
-      # exists just to be stubbed in tests
-      true
-    end
-
-    def mock_parse(*args)
-      # exists just to be stubbed in tests
-      'command output'
-    end
-
-    def check_installation_and_config
-      unless command_exists?('docker')
-        fail('You need to install docker first with `sudo apt install docker`. After installation please log out and back in to your system once.')
-      end
-
-      unless command_exists?('docker-compose')
-        fail('You need to install docker-compose first with `sudo apt install docker-compose`.')
-      end
-
-      unless docker_compose_config && (services = docker_compose_config['services']) && services.key?('main')
-        fail('Your project does not seem to be properly set up. Expected to find a docker-compose.yml which defines a service named "main".')
-      end
-    end
-
-    def command_exists?(command)
-      execute(:system, "which #{command} > /dev/null")
-    end
-
-    def docker_compose_config
-      @docker_compose_config ||= if File.exists?(DOCKER_COMPOSE_FILE)
-        if YAML.respond_to?(:safe_load)
-          YAML.safe_load(File.read(DOCKER_COMPOSE_FILE))
-        else
-          YAML.load(File.read(DOCKER_COMPOSE_FILE))
-        end
-      end
-    rescue
-      false
-    end
-
-    def ssh_agent_forward
-      if (auth_sock = ENV['SSH_AUTH_SOCK'])
-        dirname = File.dirname(auth_sock)
-        ['-v', "#{dirname}:#{dirname}", '-e', "SSH_AUTH_SOCK=#{auth_sock}"]
-      else
-        []
-      end
-    end
-
-    def capture_stderr
-      old_stderr = $stderr.dup
-      io = Tempfile.new('cuc')
-      $stderr.reopen(io)
-      yield
-      io.rewind
-      io.read
-    ensure
-      io.close
-      io.unlink
-      $stderr.reopen(old_stderr)
-    end
-
-  end
-end