geordi 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c18885f25960a7c8977933c0910c427cb4ca43a462b80ae272610514e7597f0e
-  data.tar.gz: 07a5a7c2cfd084b0e148a3f02fc4a294119ea6e65d2664bde0c8f3da2f37429f
+  metadata.gz: 5ae46d6ac8d8dd9bf53654f65445df1d0c576833db47db589b76e94cbb5784c0
+  data.tar.gz: 0034075de2f4f848686463486854cfaaee3980918048ce3480c3d6dc50634f0b
 SHA512:
-  metadata.gz: 0225535d4bce93d49b6a49cd27d53da4de8814298a835961beacebcc17c972b10c155ae6a66b136b9614725cab551e8a93868cf2c7d26f67570eb86714dca0a3
-  data.tar.gz: 5e0d4bdf3f39f9e5253b25abd515deaac20831b0bc8694eafc2c34a1b961f7ca37a78d7149b7a5711611a7eb886b6996ed24ff4f66b67c1d5ce7e8ffd5c2695e
+  metadata.gz: c52e541c8204de7e79e2935211251001b9992898770632eca578678eae5b58d4d8edb5c64b2ec82fa4f797109adc76091f9293a4bd2e3a0567c1a65a050791ab
+  data.tar.gz: 63bdba922fb2eaccd2edd3fffe233abc67fce88587606fea218685b4ee682181ea5f8c6daf728227dfa736d838327eef6f1ae930f67dec056dcd6c23fb0d6a85

data/Gemfile

@@ -4,6 +4,7 @@ source 'http://rubygems.org'
 gemspec
 
 gem 'aruba'
+gem 'contracts', '=0.9'
 gem 'rspec-mocks'
 gem 'highline'
 gem 'parallel_tests'

data/Gemfile.lock

@@ -1,38 +1,69 @@
 PATH
   remote: .
   specs:
-    geordi (2.11.0)
+    geordi (2.12.0)
       thor (~> 0.18.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.3.8)
-    aruba (0.6.2)
-      childprocess (>= 0.3.6)
-      cucumber (>= 1.1.1)
-      rspec-expectations (>= 2.7.0)
-    builder (3.2.3)
-    childprocess (1.0.1)
-      rake (< 13.0)
+    aruba (0.8.1)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      rspec-expectations (>= 2.99)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.4)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    contracts (0.9)
     cucumber (1.3.20)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.12)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.1.2)
+    declarative (0.0.20)
+    declarative-option (0.1.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
+    equalizer (0.0.11)
+    excon (0.78.0)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    ffi (1.9.18)
     gherkin (2.12.2)
       multi_json (~> 1.3)
     highline (1.6.21)
+    ice_nine (0.11.2)
     launchy (2.4.3)
       addressable (~> 2.3)
-    multi_json (1.13.1)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    multi_json (1.15.0)
     multi_test (0.1.2)
+    multipart-post (2.1.1)
     parallel (0.5.16)
     parallel_tests (0.6.18)
       parallel
-    rake (10.5.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
@@ -40,18 +71,39 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
+    ruby2_keywords (0.0.2)
     thor (0.18.1)
+    thread_safe (0.3.6)
+    tracker_api (1.11.0)
+      addressable
+      equalizer
+      excon
+      faraday
+      faraday_middleware
+      mimemagic
+      multi_json
+      representable
+      virtus
+    uber (0.1.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   aruba
+  contracts (= 0.9)
   geordi!
   highline
   launchy
   parallel_tests
+  pry
   rspec-mocks
+  tracker_api
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -54,6 +54,11 @@ Commit using a story title from Pivotal Tracker.
 
 Example: `geordi commit`
 
+Any extra arguments are forwarded to `git commit -m <message>`.
+
+If there are no staged changes, prints a warning but will continue to create
+an empty commit.
+
 On the first execution we ask for your Pivotal Tracker API token. It will be
 stored in `~/.gitpt`.
 
@@ -135,6 +140,23 @@ instead of `cap deploy:migrations`. You can force using `deploy` by passing the
 -M option: `geordi deploy -M staging`.
 
 
+### `geordi docker`
+
+Manage docker containers for the current project.
+
+Manage docker containers to run your project dockerized.
+
+It expects a docker-compose file that specifies all services, and a service
+named "main" that opens a shell for the project.
+
+There are two subcommands:
+
+- geordi docker setup
+  Builds all docker containers.
+- geordi docker shell
+  Runs the docker service named 'main'.
+
+
 ### `geordi drop-databases`
 
 Interactively delete local databases.

data/bin/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/features/docker.feature

@@ -0,0 +1,59 @@
+@same-process
+Feature: The docker command
+
+  Scenario: Setup checks for existence of docker
+    Given the docker command cannot find the "docker" binary
+    When I run `geordi docker setup`
+    Then the output should contain "which docker"
+      And the output should contain "x You need to install docker first"
+
+
+  Scenario: Setup checks for existence of docker-compose
+    Given the docker command cannot find the "docker-compose" binary
+    When I run `geordi docker setup`
+    Then the output should contain "which docker-compose"
+      And the output should contain "x You need to install docker-compose first"
+
+
+  Scenario: Setup checks for existence of docker-compose.yml
+    When I run `geordi docker setup`
+    Then the output should contain "x Your project does not seem to be properly set up."
+
+
+  Scenario: Setup checks for service named "main"
+    Given a file named "docker-compose.yml" with:
+    """
+    foo: bar
+    """
+
+    When I run `geordi docker setup`
+    Then the output should contain "x Your project does not seem to be properly set up."
+
+
+  Scenario: Setup runs docker-compose build
+    Given a file named "docker-compose.yml" with:
+    """
+    services:
+      main: foo
+    """
+
+    When I run `geordi docker setup`
+    Then the output should contain "docker-compose build"
+
+
+  Scenario: Shell checks for existence of docker
+    Given the docker command cannot find the "docker" binary
+    When I run `geordi docker shell`
+    Then the output should contain "which docker"
+      And the output should contain "x You need to install docker first"
+
+
+  Scenario: Shell runs docker-compose run maiun
+    Given a file named "docker-compose.yml" with:
+    """
+    services:
+      main: foo
+    """
+
+    When I run `geordi docker shell`
+    Then the output should contain "docker-compose run --service-ports main"

data/features/step_definitions/docker_command_steps.rb

@@ -0,0 +1,10 @@
+Given(/the docker command cannot find the "(.*?)" binary/) do |command|
+  require 'geordi/docker'
+  expect_any_instance_of(Geordi::Docker).to receive(:mock_run).at_least(:once).and_wrap_original do |original, *args|
+    if args[0] =~ /which #{Regexp.escape(command)}/
+      false
+    else
+      original.call(*args)
+    end
+  end
+end

data/features/support/aruba.rb

@@ -0,0 +1,60 @@
+require 'aruba/cucumber'
+require 'aruba/in_process'
+require 'geordi/cli'
+
+# https://github.com/erikhuda/thor/wiki/Integrating-with-Aruba-In-Process-Runs
+class InProcessCliRunner
+
+  # Allow everything fun to be injected from the outside while defaulting to normal implementations.
+  def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+    @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+  end
+
+  def execute!
+    exit_code = begin
+      # Thor accesses these streams directly rather than letting them be injected, so we replace them...
+      $stderr = @stderr
+      $stdin = @stdin
+      $stdout = @stdout
+
+      # Run our normal Thor app the way we know and love.
+      previous_program_name = $PROGRAM_NAME
+      $PROGRAM_NAME = 'geordi'
+      Geordi::CLI.start(@argv)
+
+      # Thor::Base#start does not have a return value, assume success if no exception is raised.
+      0
+    rescue StandardError => e
+      # The ruby interpreter would pipe this to STDERR and exit 1 in the case of an unhandled exception
+      b = e.backtrace
+      @stderr.puts("#{b.shift}: #{e.message} (#{e.class})")
+      @stderr.puts(b.map{|s| "\tfrom #{s}"}.join("\n"))
+      1
+    rescue SystemExit => e
+      e.status
+    ensure
+      # add additional cleanup code here
+
+      $stderr = STDERR
+      $stdin = STDIN
+      $stdout = STDOUT
+      $PROGRAM_NAME = previous_program_name
+    end
+
+    # Proxy our exit code back to the injected kernel.
+    @kernel.exit(exit_code)
+  end
+end
+
+Aruba.configure do |config|
+  config.main_class = InProcessCliRunner
+  config.command_launcher = :spawn
+end
+
+Before('@same-process') do
+  aruba.config.command_launcher = :in_process
+end
+
+Before do
+  @aruba_timeout_seconds = 5
+end

data/features/support/env.rb

@@ -1,4 +1,5 @@
-require 'aruba/cucumber'
+require 'cucumber/rspec/doubles'
+
 
 if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('1.8.7')
   require 'pry'

data/lib/geordi/commands/docker.rb

@@ -0,0 +1,36 @@
+class DockerCLI < Thor
+  desc 'setup', 'Setup docker and build 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.'
+  map 'shell' => '_shell'
+  def _shell
+    docker.shell
+  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 file that specifies all services, and a service
+named "main" that opens a shell for the project.
+
+There are two subcommands:
+
+- geordi docker setup
+  Builds all docker containers.
+- geordi docker shell
+  Runs the docker service named 'main'.
+
+LONGDESC
+subcommand 'docker', DockerCLI

data/lib/geordi/cucumber.rb

@@ -11,7 +11,8 @@ module Geordi
     include Geordi::Interaction
 
     VNC_DISPLAY = ':17'
-    VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} -localhost -nolisten tcp -SecurityTypes None -geometry 1280x1024"
+    VNC_SERVER_DEFAULT_OPTIONS = '-localhost -nolisten tcp -SecurityTypes None -geometry 1280x1024'
+    VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} #{ENV.fetch('GEORDI_VNC_OPTIONS', VNC_SERVER_DEFAULT_OPTIONS)}"
     VNC_VIEWER_COMMAND = "vncviewer #{VNC_DISPLAY}"
     VNC_ENV_VARIABLES = %w[DISPLAY BROWSER LAUNCHY_BROWSER]
 

data/lib/geordi/docker.rb

@@ -0,0 +1,71 @@
+require 'geordi/interaction'
+require 'yaml'
+
+module Geordi
+  class Docker
+    DOCKER_COMPOSE_FILE = 'docker-compose.yml'.freeze
+
+    include Interaction
+
+    def setup
+      check_installation_and_config
+      announce('Building containers...')
+      if execute(:system, 'docker-compose', 'build')
+        success('Build successful.')
+      else
+        fail('Build failed.')
+      end
+    end
+
+    def shell
+      check_installation_and_config
+      execute(:exec, 'docker-compose', 'run', '--service-ports', 'main')
+    end
+
+    private
+
+    def execute(kind, *args)
+      if ENV['GEORDI_TESTING']
+        puts "Stubbed run #{args.join(' ')}"
+        mock_run(*args)
+      else
+        send(kind, *args)
+      end
+    end
+
+    def mock_run(*args)
+      # exists just to be stubbed in tests
+      true
+    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
+      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
+  end
+end

data/lib/geordi/util.rb

@@ -51,7 +51,7 @@ module Geordi
           # Remove Geordi's Bundler environment when running commands.
           success = if !defined?(Bundler)
             system(*commands)
-          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(*commands)
             end

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '2.11.0'
+  VERSION = '2.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.12.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -81,14 +81,17 @@ files:
 - features/console.feature
 - features/cucumber.feature
 - features/deploy.feature
+- features/docker.feature
 - features/dump.feature
 - features/firefox.feature
 - features/server.feature
 - features/setup.feature
 - features/shell.feature
+- features/step_definitions/docker_command_steps.rb
+- features/step_definitions/miscellaneous_steps.rb
+- features/support/aruba.rb
 - features/support/env.rb
 - features/support/step_definitions/aruba_backport_steps.rb
-- features/support/step_definitions/miscellaneous_steps.rb
 - geordi.gemspec
 - lib/geordi.rb
 - lib/geordi/COMMAND_TEMPLATE
@@ -108,6 +111,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/eurest.rb
@@ -130,6 +134,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
@@ -156,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+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