geordi 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7807d5539f7a89704caedcb84cbbe86fdf249f0d118419a208bc6de5a56d163d
-  data.tar.gz: 3e3ab52311d9148bb515d373e1404bf84a112111ab49935fb30e3694b04d2365
+  metadata.gz: 4359df61d9901b0d3091ef950530212fb9ba92847425d136a42c4668d6745462
+  data.tar.gz: c6cf00413126337330997068a59f097f226cdc41f9feb97d8523996d77ceeba5
 SHA512:
-  metadata.gz: '09e3ced6e1773f894560ec79ac6625ebc61af0e6eb0592785a5e273c6fb3df514691803072719854534d311cc6e8c8b1d62e9f4d184b31ca6b9e7bd74f5ad102'
-  data.tar.gz: 8d74f8a681f19d9f8d5d08ee95a4d4e2a30074d97021692f0734a40a14821ed6a204b435ffa615de57b5925994a65f00294f8492eafbe59baddc81daa5bfb034
+  metadata.gz: 6a2b44bbe812e2a20bd2002ee64f3925108203f188d88e7da0f590cf2b7d2f4e01c744525c778cce47f6e1990ec44b2df65a95adaaa15cb4a6e2d3a8167ceddb
+  data.tar.gz: 0f6441323fc798aba02f8d6947a803504e9bb11d3714001e1840959a90cf3763e590f45e112d94b6494996f78101bd73e5a7fb62440359c9c9b402dd1b9bc2a9

data/CHANGELOG.md

@@ -7,11 +7,24 @@ 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.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 +141,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.0)
       thor (~> 1)
 
 GEM

data/README.md

@@ -157,6 +157,24 @@ 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'.
+- `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 +194,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 +209,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/docker.rb

@@ -0,0 +1,44 @@
+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'.
+- `geordi docker vnc`
+  Opens a VNC viewer to connect to the VNC server in the container.
+
+LONGDESC
+subcommand 'docker', DockerCLI

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

@@ -12,8 +12,9 @@ module Geordi
 
     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_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

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

@@ -64,7 +64,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

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '5.1.0'.freeze
+  VERSION = '5.2.0'.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.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2020-12-14 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