geordi 5.0.0 → 5.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 785901e0e49997506cc80f2df64338acc50a9605b42816cce92f56c5dba834b7
-  data.tar.gz: 9ec7abce9fd67cdff30584c236ba4454c3cbfe276091b277ffbec95221da9e04
+  metadata.gz: 601c58f6344b5fb02e2514749e216e60a6f6f1cc656d2a37eabb891cc013edfa
+  data.tar.gz: 07b06fa74266f0ba5506b8218e10c78b4156c854cef9bb8bca3fd77ba5b6d30a
 SHA512:
-  metadata.gz: d8fd6738e768cd5e0ae9b9ccfc0c3bdb781e00abf000c596d408fd62b408f6b46069447d4f8acb98d02b4e2b8ed04faec72af700f18f0d7b8364e42a5dce6ac9
-  data.tar.gz: 78ec1bae91f5b3b8ca9fa7dc696021ae78d820250ee62596647283388070e5731b780c4f166f6ecaf4471051c11f340b7d33a8d36ae3c902855fa92c1a8a5f48
+  metadata.gz: 533ceae3f15d374526bafa76278914212de5b930250c8375c8f4cde1661e56d4c22093a4266c48b3646b023c4925599e2c46e0f93f38b52430a9748ce1778e7c
+  data.tar.gz: edf3b697d11b5ec5c932ccd6a60311325ea0d8ed50e3d0650aae3f63b8cd514374dfd465212aae82e6585daee7f7466113cf6b1dacbf430a2b7c95269c9b0dc2

data/.github/workflows/test.yml

@@ -35,7 +35,8 @@ jobs:
         ruby-version: "${{ matrix.ruby }}"
     - name: Install vncserver
       run: |
-        sudo apt-get install -y vnc4server
+        sudo apt-get update
+        sudo apt-get install -y tightvncserver
         # Fake required password for vncserver
         mkdir ~/.vnc && touch ~/.vnc/passwd && chmod 700 ~/.vnc/passwd
     - name: Bundle

data/.ruby-version

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

data/CHANGELOG.md

@@ -10,6 +10,37 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ### Breaking changes
 
 
+## 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
@@ -126,6 +157,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.3)
       thor (~> 1)
 
 GEM

data/README.md

@@ -1,4 +1,4 @@
-Geordi [![Build Status](https://travis-ci.org/makandra/geordi.svg?branch=master)](https://travis-ci.org/makandra/geordi)
+Geordi [![Tests](https://github.com/makandra/geordi/workflows/Tests/badge.svg)](https://github.com/makandra/geordi/actions)
 ======
 
 Geordi is a collection of command line tools we use in our daily work with
@@ -157,6 +157,25 @@ 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 a 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 +195,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 +210,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`

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/_setup_vnc.rb

@@ -23,26 +23,24 @@ def _setup_vnc
     Interaction.success 'It appears you already have a VNC server installed. Good job!'
   else
     puts 'Please run:'
-    Interaction.note_cmd 'sudo apt-get install vnc4server'
+    Interaction.note_cmd 'sudo apt-get install tightvncserver'
+    puts 'In case this package is not available, you may try vnc4server instead.'
     Interaction.prompt 'Continue ...'
 
     puts
+
     Interaction.note 'We will now set a password for your VNC server.'
     puts Util.strip_heredoc <<-TEXT
-      When running our cucumber script, you will not actually need this
-      password, and there is no security risk. However, if you start a vncserver
-      without our cucumber script, a user with your password can connect to
-      your machine.
+      When running our cucumber script, this password will be used while also
+      restricting access to the local machine. However, if you start a vncserver
+      without our cucumber script, keep in mind that a user with this password
+      can connect to your machine.
 
     TEXT
     puts 'Please run:'
-    Interaction.note_cmd 'vncserver :20'
+    Interaction.note_cmd 'vncpasswd'
     Interaction.warn 'Enter a secure password!'
     Interaction.prompt 'Continue ...'
-
-    puts 'Now stop the server again. Please run:'
-    Interaction.note_cmd 'vncserver -kill :20'
-    Interaction.prompt 'Continue ...'
   end
 
   Interaction.announce 'Setup VNC viewer'

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/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,8 +11,10 @@ module Geordi
   class Cucumber
 
     VNC_DISPLAY = ':17'.freeze
-    VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} -localhost -nolisten tcp -SecurityTypes None -geometry 1280x1024".freeze
-    VNC_VIEWER_COMMAND = "vncviewer #{VNC_DISPLAY}".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 = {})
@@ -30,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
@@ -58,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.0.0'.freeze
+  VERSION = '5.2.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.3
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-01-27 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
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+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