geordi 5.1.0 → 5.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7807d5539f7a89704caedcb84cbbe86fdf249f0d118419a208bc6de5a56d163d
-  data.tar.gz: 3e3ab52311d9148bb515d373e1404bf84a112111ab49935fb30e3694b04d2365
+  metadata.gz: 559fa220792042ae1d84411772b63a5f4526df68f5ac4eefbb008ac63705d72d
+  data.tar.gz: e43a552812daed79454864bed854720537ee2e9d8d303212b5dde4d8ef0b1694
 SHA512:
-  metadata.gz: '09e3ced6e1773f894560ec79ac6625ebc61af0e6eb0592785a5e273c6fb3df514691803072719854534d311cc6e8c8b1d62e9f4d184b31ca6b9e7bd74f5ad102'
-  data.tar.gz: 8d74f8a681f19d9f8d5d08ee95a4d4e2a30074d97021692f0734a40a14821ed6a204b435ffa615de57b5925994a65f00294f8492eafbe59baddc81daa5bfb034
+  metadata.gz: '0193eed8c9af5cadd36498a4b0eb5b6364a58e20e93ef3619af3dc934b16f61652b9b703e00049109592e6b324c7854d3d56cfe5aa14ca8948e5d6ed1320a548'
+  data.tar.gz: d7afc3e6ac2b5c3255fedd1f6e2a3f8fa1469c822c64f1ed1471a46ab0208c1f1f6084ee17b0edee79f07d0bce1d64d7768dcfaddffed61dfdd6664863851a49

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+2.2

data/CHANGELOG.md

@@ -7,11 +7,46 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ## Unreleased
 
 ### Compatible changes
-* Switch to tightvncserver to be compatible with Ubuntu 20.04. vnc4server is still supported.
-
 ### Breaking changes
 
 
+## 5.2.4 2021-01-29
+
+### Compatible changes
+* Fix and improve delete-dumps command (now supporting multiple arguments)
+
+
+## 5.2.3 2021-01-27
+
+### Compatible changes
+* Remove auto-bundling from `geordi shell` and remote `geordi console`
+
+
+## 5.2.2 2020-12-17
+
+### Compatible changes
+* Ignore ACL settings when loading a PostgreSQL dump
+
+
+## 5.2.1 2020-12-15
+
+### Compatible changes
+* Fix a bug regarding `geordi vnc` which was introduced in 5.1.0
+
+
+## 5.2.0 2020-12-14
+
+### Compatible changes
+* Geordi update will exit with a warning when Ruby version changes during pull.
+* Add `geordi docker` command with support for opening a shell for dockerized dev environments.
+
+
+## 5.1.0 2020-12-04
+
+### Compatible changes
+* Switch to tightvncserver to be compatible with Ubuntu 20.04. vnc4server is still supported.
+
+
 ## 5.0.0 2020-11-25
 
 ### Breaking changes
@@ -128,6 +163,9 @@ Don't know how to build task 'db:migrate parallel:prepare'
 ### Breaking changes
 - Remove support for Ruby 1.8.7 and Ruby 1.9.3. Bug fixes might still be backported to 2.x, but we will not add any features to 2.x anymore. Please consider to upgrade the Ruby version of your project.
 
+## 2.12.3
+
+* Add `geordi docker` command with support for opening a shell for dockerized dev environments.
 
 ## 2.11.0 2020-05-04
 

data/Gemfile.lock

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

data/README.md

@@ -111,13 +111,13 @@ in `.geordi.yml` in the project root.
 ### `geordi delete-dumps [DIRECTORY]`
 Delete database dump files (*.dump).
 
-Example: `geordi delete_dumps` or `geordi delete_dumps ~/tmp/dumps`
+Example: `geordi delete-dumps` or `geordi delete-dumps ~/tmp/dumps`
 
-Recursively search for files ending in `*.dump` and offer to delete those. When
+Recursively searches for files ending in `.dump` and offers to delete them. When
 no argument is given, two default directories are searched for dump files: the
 current working directory and `~/dumps` (for dumps created with geordi).
 
-Geordi will ask for confirmation before actually deleting files.
+Will ask for confirmation before actually deleting files.
 
 
 ### `geordi deploy [STAGE]`
@@ -157,6 +157,27 @@ 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.
+
+
 ### `geordi drop-databases`
 Interactively delete local databases.
 
@@ -176,18 +197,10 @@ offer to edit the whitelist instead.
 - `[--postgres=PORT_OR_SOCKET]`: Use Postgres port or socket
 - `[--mysql=PORT_OR_SOCKET]`: Use MySQL/MariaDB port or socket
 
+
 ### `geordi dump [TARGET]`
 Handle (remote) database dumps.
 
-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.
-
-When called with the `--load` option, sources the specified dump into the
-development database.
-
 `geordi dump` (without arguments) dumps the development database with `dumple`.
 
 `geordi dump -l tmp/staging.dump` (with the `--load` option) sources the
@@ -199,8 +212,15 @@ 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.
+
 **Options**
 - `-l, [--load=[DUMP_FILE]]`: Load a dump
+- `-d, [--database=NAME]`: Database name, if there are multiple databases
 
 
 ### `geordi firefox COMMAND`
@@ -406,11 +426,9 @@ Once you have completed your modifications, please update CHANGELOG and README
 as needed. Use `rake readme` to regenerate the Geordi section of the README from
 the command documentations.
 
-Make sure tests are green in the default Ruby *plus* in the oldest Ruby > 1.8
-that you have installed on your system (1.8.7 support has been dropped).
-
-Before releasing your changes, wait for the Travis results to see that tests
-passed in all Ruby versions.
+Make sure tests are green in the oldest supported Ruby version. Before releasing
+a new gem version, wait for the CI results to see that tests are green in all
+Ruby versions.
 
 
 Adding a new command

data/exe/geordi

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
 require 'geordi/util'
 
 Geordi::Util.installing_missing_gems do

data/geordi.gemspec

@@ -25,8 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'thor', '~> 1'
 
-  spec.post_install_message = <<-ATTENTION
-* Binary `geordi` installed
-* Geordi 4 has removed its deprecated executables. If you want to invoke these commands like before, you may create aliases on your machine. For the alias mapping, please refer to https://github.com/makandra/geordi/commit/68fa92acb146ebde3acb92d7b9556bd4eaa2b4ff
-  ATTENTION
+  #spec.post_install_message = <<-ATTENTION
+  #ATTENTION
 end

data/lib/geordi/commands/console.rb

@@ -14,9 +14,9 @@ option :select_server, type: :string, aliases: '-s', banner: '[SERVER_NUMBER]',
 
 def console(target = 'development', *_args)
   require 'geordi/remote'
-  invoke_geordi 'bundle_install'
 
   if target == 'development'
+    invoke_geordi 'bundle_install'
     invoke_geordi 'yarn_install'
 
     Interaction.announce 'Opening a local Rails console'

data/lib/geordi/commands/delete_dumps.rb

@@ -1,43 +1,41 @@
 desc 'delete-dumps [DIRECTORY]', 'Delete database dump files (*.dump)'
 long_desc <<-LONGDESC
-Example: `geordi delete_dumps` or `geordi delete_dumps ~/tmp/dumps`
+Example: `geordi delete-dumps` or `geordi delete-dumps ~/tmp/dumps`
 
-Recursively search for files ending in `*.dump` and offer to delete those. When
+Recursively searches for files ending in `.dump` and offers to delete them. When
 no argument is given, two default directories are searched for dump files: the
 current working directory and `~/dumps` (for dumps created with geordi).
 
-Geordi will ask for confirmation before actually deleting files.
+Will ask for confirmation before actually deleting files.
 LONGDESC
 
-def delete_dumps(dump_directory = nil)
-  deletable_dumps = []
-  dump_directories = if dump_directory.nil?
-    [
-      File.join(Dir.home, 'dumps'),
-      Dir.pwd,
-    ]
-  else
-    [dump_directory]
+def delete_dumps(*locations)
+  Interaction.announce 'Retrieving dump files'
+
+  dump_files = []
+  if locations.empty?
+    locations = [ File.join(Dir.home, 'dumps'), Dir.pwd ]
   end
-  Interaction.announce 'Looking for *.dump in ' << dump_directories.join(',')
-  dump_directories.each do |d|
-    d_2 = File.expand_path(d)
-    unless File.directory? File.realdirpath(d_2)
-      Interaction.warn "Directory #{d_2} does not exist"
+  locations.map! &File.method(:expand_path)
+
+  Interaction.note "Looking in #{locations.join(', ')}"
+  locations.each do |dir|
+    directory = File.expand_path(dir)
+    unless File.directory? File.realdirpath(directory)
+      Interaction.warn "Directory #{directory} does not exist. Skipping."
       next
     end
-    deletable_dumps.concat(Dir.glob("#{d_2}/**/*.dump"))
+    dump_files.concat Dir.glob("#{directory}/**/*.dump")
   end
+  deletable_dumps = dump_files.flatten.uniq.sort.select &File.method(:file?)
+
   if deletable_dumps.empty?
-    Interaction.success 'No dumps to delete' if deletable_dumps.empty?
-    exit 0
-  end
-  deletable_dumps.uniq!.sort!
-  Interaction.note 'The following dumps can be deleted:'
-  puts
-  puts deletable_dumps
-  Interaction.prompt('Delete those dumps', 'n', /y|yes/) || raise('Cancelled.')
-  deletable_dumps.each do |dump|
-    File.delete dump unless File.directory? dump
+    Interaction.note 'No dump files found'
+  else
+    puts deletable_dumps
+    Interaction.prompt('Delete these files?', 'n', /y|yes/) || Interaction.fail('Cancelled.')
+
+    deletable_dumps.each &File.method(:delete)
+    Interaction.success 'Done.'
   end
 end

data/lib/geordi/commands/docker.rb

@@ -0,0 +1,46 @@
+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'
+  def vnc
+    docker.vnc
+  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.
+LONGDESC
+subcommand 'docker', DockerCLI

data/lib/geordi/commands/shell.rb

@@ -15,8 +15,6 @@ option :select_server, type: :string, aliases: '-s', banner: '[SERVER_NUMBER]',
 def shelll(target, *_args)
   require 'geordi/remote'
 
-  invoke_geordi 'bundle_install'
-
   Interaction.announce 'Opening a shell on ' + target
   Geordi::Remote.new(target).shell(options)
 end

data/lib/geordi/commands/update.rb

@@ -10,13 +10,24 @@ option :dump, type: :string, aliases: '-d', banner: 'TARGET',
 option :test, type: :boolean, aliases: '-t', desc: 'After updating, run tests'
 
 def update
+  old_ruby_version = File.read('.ruby-version').chomp
+
   Interaction.announce 'Updating repository'
   Util.run!('git pull', show_cmd: true)
 
-  invoke_geordi 'migrate'
+  ruby_version = File.read('.ruby-version').chomp
+  ruby_version_changed = !ruby_version.empty? && (ruby_version != old_ruby_version)
+
+  if ruby_version_changed
+    puts
+    Interaction.warn 'Ruby version changed during git pull. Please run again to use the new version.'
+    exit(1)
+  else
+    invoke_geordi 'migrate'
 
-  Interaction.success 'Successfully updated the project.'
+    Interaction.success 'Successfully updated the project.'
 
-  invoke_geordi 'dump', options.dump, load: true if options.dump
-  invoke_geordi 'tests' if options.test
+    invoke_geordi 'dump', options.dump, load: true if options.dump
+    invoke_geordi 'tests' if options.test
+  end
 end

data/lib/geordi/cucumber.rb

@@ -11,9 +11,10 @@ module Geordi
   class Cucumber
 
     VNC_DISPLAY = ':17'.freeze
-    VNC_PASSWORD_FILE = File.absolute_path('~/.vnc/passwd').freeze # default for "vncpasswd"
-    VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} -localhost -nolisten tcp -geometry 1280x1024 -rfbauth #{VNC_PASSWORD_FILE}".freeze
-    VNC_VIEWER_COMMAND = "vncviewer #{VNC_DISPLAY} -passwd #{VNC_PASSWORD_FILE}".freeze
+    VNC_PASSWORD_FILE = File.expand_path('~/.vnc/passwd').freeze # default for "vncpasswd"
+    VNC_SERVER_DEFAULT_OPTIONS = "-localhost -nolisten tcp -geometry 1280x1024 -rfbauth #{VNC_PASSWORD_FILE}".freeze
+    VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} #{ENV.fetch('GEORDI_VNC_OPTIONS', VNC_SERVER_DEFAULT_OPTIONS)}".freeze
+    VNC_VIEWER_COMMAND = "vncviewer -passwd #{VNC_PASSWORD_FILE}".freeze
     VNC_ENV_VARIABLES = %w[DISPLAY BROWSER LAUNCHY_BROWSER].freeze
 
     def run(files, cucumber_options, options = {})
@@ -31,10 +32,10 @@ module Geordi
       system command # Util.run! would reset the Firefox PATH
     end
 
-    def launch_vnc_viewer
+    def launch_vnc_viewer(source = VNC_DISPLAY)
       fork do
         error = capture_stderr do
-          system(VNC_VIEWER_COMMAND)
+          system("#{VNC_VIEWER_COMMAND} #{source}")
         end
         unless $?.success?
           if $?.exitstatus == 127
@@ -59,7 +60,7 @@ module Geordi
         VNC_ENV_VARIABLES.each do |variable|
           ENV["OUTER_#{variable}"] = ENV[variable] if ENV[variable]
         end
-        ENV['BROWSER'] = ENV['LAUNCHY_BROWSER'] = File.expand_path('../../bin/launchy_browser', __dir__)
+        ENV['BROWSER'] = ENV['LAUNCHY_BROWSER'] = File.expand_path('../../exe/launchy_browser', __dir__)
         ENV['DISPLAY'] = VNC_DISPLAY
 
         Interaction.note 'Run `geordi vnc` to view the Selenium test browsers'

data/lib/geordi/docker.rb

@@ -0,0 +1,116 @@
+require 'geordi/interaction'
+require 'geordi/cucumber'
+require 'yaml'
+
+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
+      Cucumber.new.launch_vnc_viewer('::5967')
+    end
+
+    private
+
+    def attach_to_running_shell
+      running_containers = execute(:`, 'docker-compose ps').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 == :`
+          mock_parse(*args)
+        else
+          mock_run(*args)
+        end
+      else
+        send(kind, *args)
+      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
+  end
+end

data/lib/geordi/dump_loader.rb

@@ -34,7 +34,7 @@ module Geordi
 
     def postgresql_command
       ENV['PGPASSWORD'] = config['password']
-      command = 'pg_restore --no-owner --clean'
+      command = 'pg_restore --no-owner --clean --no-acl'
       command << ' --username=' << config['username'].to_s if config['username']
       command << ' --port=' << config['port'].to_s if config['port']
       command << ' --host=' << config['host'].to_s if config['host']

data/lib/geordi/util.rb

@@ -1,5 +1,6 @@
 require 'geordi/interaction'
 require 'socket'
+require 'bundler'
 
 module Geordi
   class Util
@@ -64,7 +65,7 @@ module Geordi
           # Remove Geordi's Bundler environment when running commands.
           success = if !defined?(Bundler)
             system(*command)
-          elsif Gem::Version.new(Bundler::VERSION) >= Gem::Version.new('2.1.2')
+          elsif Gem::Version.new(Bundler::VERSION) >= Gem::Version.new('1.17.3')
             Bundler.with_original_env do
               system(*command)
             end
@@ -167,15 +168,10 @@ module Geordi
       # Get the version for the given gem by parsing Gemfile.lock.
       # Returns nil if the gem is not used.
       def gem_version(gem)
-        # Lines look like `* will_paginate (2.3.15)` or `railslts-version (2.3.18.16 7f51cc7)`
-        bundle_list.split("\n").each do |line|
-          matches = line.match(/\* #{gem} \(([\d\.]+)/)
-          next if matches.nil? || matches[1].nil?
+        lock_file = Bundler::LockfileParser.new(Bundler.read_file(Bundler.default_lockfile))
+        spec = lock_file.specs.detect { |spec| spec.name == gem }
 
-          return Gem::Version.new(matches[1])
-        end
-
-        nil
+        spec && spec.version
       end
 
       def file_containing?(file, regex)
@@ -192,12 +188,6 @@ module Geordi
         string
       end
 
-      private
-
-      def bundle_list
-        @bundle_list ||= `bundle list`
-      end
-
     end
   end
 end

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '5.1.0'.freeze
+  VERSION = '5.2.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.4
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -68,6 +68,7 @@ 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/firefox.rb
@@ -89,6 +90,7 @@ 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/firefox_for_selenium.rb
 - lib/geordi/gitpt.rb
@@ -101,9 +103,7 @@ homepage: https://makandra.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: |
-  * Binary `geordi` installed
-  * Geordi 4 has removed its deprecated executables. If you want to invoke these commands like before, you may create aliases on your machine. For the alias mapping, please refer to https://github.com/makandra/geordi/commit/68fa92acb146ebde3acb92d7b9556bd4eaa2b4ff
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib