geordi 5.3.0 → 6.0.1

data/lib/geordi/commands/branch.rb

@@ -0,0 +1,12 @@
+desc 'branch', 'Check out a feature branch based on a story from Pivotal Tracker'
+long_desc <<-LONGDESC
+Example: `geordi branch`
+
+On the first execution we ask for your Pivotal Tracker API token. It will be
+stored in `~/.config/geordi/global.yml`.
+LONGDESC
+
+def branch
+  require 'geordi/gitpt'
+  Gitpt.new.run_branch
+end

data/lib/geordi/commands/commit.rb

@@ -10,5 +10,5 @@ LONGDESC
 
 def commit(*git_args)
   require 'geordi/gitpt'
-  Gitpt.new.run(git_args)
+  Gitpt.new.run_commit(git_args)
 end

data/lib/geordi/commands/cucumber.rb

@@ -2,24 +2,15 @@ desc 'cucumber [FILES and OPTIONS]', 'Run Cucumber features'
 long_desc <<-LONGDESC
 Example: `geordi cucumber features/authentication_feature:3`
 
-Runs Cucumber with `bundle exec`, using parallel tests, with a VNC session
-holding Selenium test browsers, support for using a dedicated testing browser
-and beta support for re-running failed scenarios.
+Runs Cucumber with `bundle exec`, using parallel tests and with support for
+re-running failed scenarios.
 
-- *@solo:* Generally, features are run in parallel. However, scenarios tagged
-with @solo are excluded from the parallel run and executed sequentially instead.
+Any unknown option will be passed through to Cucumber, e.g. `--format=pretty`.
+Make sure to connect option and value with an equals sign, i.e. have each option
+a contiguous string.
 
-- *Debugging:* In some cases, the dot-printing Cucumber formatter swallows
-errors. In case a feature fails without an error message, try running it with
-`--debug` or `-d`.
-
-- *Options:* Any unknown option will be passed through to Cucumber,
-e.g. `--format=pretty`. Make sure to connect option and value with an equals
-sign, i.e. have each option a contiguous string.
-
-- *VNC:* By default, test browsers will run in a VNC session. When using a
-headless test browser anyway, you can disable VNC by setting `use_vnc: false`
-in `.geordi.yml` in the project root.
+In order to limit processes in a parallel run, you can set an environment
+variable like this: `PARALLEL_TEST_PROCESSORS=6 geordi cucumber`
 LONGDESC
 
 option :modified, aliases: '-m', type: :boolean,
@@ -64,28 +55,6 @@ def cucumber(*args)
     cmd_opts, files = args.partition { |f| f.start_with? '-' }
     cmd_opts << '--format' << 'pretty' << '--backtrace' if options.debug
 
-    # Serial run of @solo scenarios ############################################
-    if files.any? { |f| f.include? ':' }
-      Interaction.note '@solo run skipped when called with line numbers' if options.verbose
-    else
-      solo_files = if files.empty?
-        'features' # Proper grepping
-      else
-        files.join(' ')
-      end
-
-      solo_tag_usages = `grep -r '@solo' #{solo_files}`.split("\n")
-
-      if solo_tag_usages.any?
-        solo_cmd_opts = cmd_opts.dup
-        solo_cmd_opts << '--tags' << '@solo'
-
-        Interaction.announce 'Running @solo features'
-        solo_success = Geordi::Cucumber.new.run files, solo_cmd_opts, verbose: options.verbose, parallel: false
-        solo_success || Interaction.fail('Features failed.')
-      end
-    end
-
     # Parallel run of all given features + reruns ##############################
     Interaction.announce 'Running features'
     normal_run_successful = Geordi::Cucumber.new.run(files, cmd_opts, verbose: options.verbose)

data/lib/geordi/commands/delete_dumps.rb

@@ -30,7 +30,7 @@ def delete_dumps(*locations)
   deletable_dumps = dump_files.flatten.uniq.sort.select &File.method(:file?)
 
   if deletable_dumps.empty?
-    Interaction.note 'No dump files found'
+    Interaction.warn 'No dump files found.'
   else
     puts deletable_dumps
     Interaction.prompt('Delete these files?', 'n', /y|yes/) || Interaction.fail('Cancelled.')

data/lib/geordi/commands/docker.rb

@@ -12,8 +12,13 @@ class DockerCLI < Thor
   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
-    docker.vnc
+    if options.setup
+      docker.setup_vnc
+    else
+      docker.vnc
+    end
   end
 
   private
@@ -42,5 +47,6 @@ There are three subcommands:
 
 - `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/commands/drop_databases.rb

@@ -47,6 +47,4 @@ def drop_databases
   cleaner = DBCleaner.new(extra_flags)
   cleaner.clean_mysql unless options.postgres_only
   cleaner.clean_postgres unless options.mysql_only
-
-  Interaction.success 'Done.'
 end

data/lib/geordi/commands/dump.rb

@@ -57,6 +57,9 @@ def dump(target = nil, *_args)
       Interaction.announce "Sourcing dump into the #{loader.config['database']} db"
       loader.load
 
+      Util.run! "rm #{dump_path}"
+      Interaction.note "Dump file removed"
+
       Interaction.success "Your #{loader.config['database']} database has now the data of #{target}#{database_label}."
     end
   end

data/lib/geordi/commands/remove_executable_flags.rb

@@ -10,5 +10,6 @@ def remove_executable_flags
     Interaction.note pattern
     `find . -name "#{pattern}" -exec chmod -x {} ';'`
   end
-  puts 'Done.'
+
+  Interaction.success 'Done.'
 end

data/lib/geordi/commands/rspec.rb

@@ -2,7 +2,10 @@ desc 'rspec [FILES]', 'Run RSpec'
 long_desc <<-LONGDESC
 Example: `geordi rspec spec/models/user_spec.rb:13`
 
-Runs RSpec with RSpec 1/2 support, parallel_tests detection and `bundle exec`.
+Runs RSpec with version 1/2 support, parallel_tests detection and `bundle exec`.
+
+In order to limit processes in a parallel run, you can set an environment
+variable like this: `PARALLEL_TEST_PROCESSORS=6 geordi rspec`
 LONGDESC
 
 def rspec(*files)

data/lib/geordi/commands/tests.rb

@@ -1,14 +1,38 @@
-desc 'tests', 'Run all employed tests'
-def tests
-  rake_result = invoke_geordi 'with_rake'
-
-  # Since `rake` usually is configured to run all tests, only run them if `rake`
-  # did not perform
-  if rake_result == :did_not_perform
-    invoke_geordi 'unit'
-    invoke_geordi 'rspec'
-    invoke_geordi 'cucumber'
-  end
+desc 'tests [FILES]', 'Run all employed tests'
+long_desc <<-LONGDESC
+When running `geordi tests` without any arguments, all unit tests, rspec specs
+and cucumber features will be run.
+
+When passing arguments, Geordi will forward them to either `rspec` or `cucumber`,
+depending on what the first argument indicates.
+LONGDESC
+
+def tests(*args)
+  if args.any?
+    args, opts = Thor::Options.split(args)
+    error_message = "When passing arguments, the first argument must be either an RSpec or a Cucumber path."
+
+    if args.empty?
+      Interaction.fail error_message
+    elsif args.first.start_with? 'spec'
+      invoke 'rspec', args, opts
+    elsif args.first.start_with? 'features'
+      invoke 'cucumber', args, opts
+    else
+      Interaction.fail error_message
+    end
 
-  Interaction.success 'Successfully ran tests.'
+  else
+    rake_result = invoke_geordi 'with_rake'
+
+    # Since `rake` usually is configured to run all tests, only run them if `rake`
+    # did not perform
+    if rake_result == :did_not_perform
+      invoke_geordi 'unit'
+      invoke_geordi 'rspec'
+      invoke_geordi 'cucumber'
+    end
+
+    Interaction.success 'Successfully ran tests.'
+  end
 end

data/lib/geordi/cucumber.rb

@@ -4,67 +4,23 @@ require 'tempfile'
 # This require-style is to prevent Ruby from loading files of a different
 # version of Geordi.
 require File.expand_path('interaction', __dir__)
-require File.expand_path('firefox_for_selenium', __dir__)
 require File.expand_path('settings', __dir__)
 
 module Geordi
   class Cucumber
 
-    VNC_DISPLAY = ':17'.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 = {})
       self.argv = files + cucumber_options.map { |option| option.split('=') }.flatten
       self.settings = Geordi::Settings.new
 
       consolidate_rerun_txt_files
       show_features_to_run
-      setup_vnc if settings.use_vnc?
 
       command = use_parallel_tests?(options) ? parallel_execution_command : serial_execution_command
       Interaction.note_cmd(command) if options[:verbose]
 
       puts # Make newline
-      system command # Util.run! would reset the Firefox PATH
-    end
-
-    def launch_vnc_viewer(source = VNC_DISPLAY)
-      fork do
-        error = capture_stderr do
-          system("#{VNC_VIEWER_COMMAND} #{source}")
-        end
-        unless $?.success?
-          if $?.exitstatus == 127
-            Interaction.fail 'VNC viewer not found. Install it with `geordi vnc --setup`.'
-          else
-            Interaction.note 'VNC viewer could not be opened:'
-            puts error
-            puts
-          end
-        end
-      end
-    end
-
-    def restore_env
-      VNC_ENV_VARIABLES.each do |variable|
-        ENV[variable] = ENV["OUTER_#{variable}"]
-      end
-    end
-
-    def setup_vnc
-      if try_and_start_vnc
-        VNC_ENV_VARIABLES.each do |variable|
-          ENV["OUTER_#{variable}"] = ENV[variable] if ENV[variable]
-        end
-        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'
-      end
+      system command
     end
 
     private
@@ -76,7 +32,7 @@ module Geordi
       unless argv.include?('--format') || argv.include?('-f')
         format_args = spinner_available? ? ['--format', 'CucumberSpinner::CuriousProgressBarFormatter'] : ['--format', 'progress']
       end
-      [use_firefox_for_selenium, Util.binstub_or_fallback('cucumber'), format_args, escape_shell_args(argv)].flatten.compact.join(' ')
+      [ Util.binstub_or_fallback('cucumber'), format_args, escape_shell_args(argv)].flatten.compact.join(' ')
     end
 
     def parallel_execution_command
@@ -88,28 +44,12 @@ module Geordi
       features = find_all_features_recursively('features') if features.empty?
 
       [
-        use_firefox_for_selenium,
         'bundle exec parallel_test -t ' + type_arg,
-        %(-o '#{command_line_options.join(' ')} --tags "#{not_tag('@solo')}"'),
+        %(-o '#{command_line_options.join(' ')}'),
         "-- #{features.join(' ')}",
       ].compact.join(' ')
     end
 
-    def not_tag(name)
-      if Util.gem_major_version('cucumber') < 3
-        "~#{name}"
-      else
-        "not #{name}"
-      end
-    end
-
-    def use_firefox_for_selenium
-      path = Geordi::FirefoxForSelenium.path_from_config
-      if path
-        "PATH=#{path}:$PATH"
-      end
-    end
-
     def escape_shell_args(*args)
       args.flatten.collect do |arg|
         arg.gsub(/([\\ "])/) { |_match| "\\#{Regexp.last_match(1)}" }
@@ -117,9 +57,7 @@ module Geordi
     end
 
     def show_features_to_run
-      if command_line_options.include? '@solo'
-        Interaction.note 'All features tagged with @solo'
-      elsif command_line_options.include? 'rerun'
+      if command_line_options.include? 'rerun'
         Interaction.note 'Rerunning failed scenarios'
       elsif features_to_run.empty?
         Interaction.note 'All features in features/'
@@ -210,39 +148,5 @@ module Geordi
         features_to_run.none? { |f| f.include? ':' }
     end
 
-    def try_and_start_vnc
-      # check if vnc is already running
-      # return true if vnc_server_running?
-      error = capture_stderr do
-        system(VNC_SERVER_COMMAND)
-      end
-      case $?.exitstatus
-      when 0,
-        98 # was already running after all
-        true
-      when 127 # not installed
-        Interaction.warn 'Could not launch VNC server. Install it with `geordi vnc --setup`.'
-        false
-      else
-        Interaction.warn 'Starting VNC failed:'
-        puts error
-        puts
-        false
-      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

data/lib/geordi/db_cleaner.rb

@@ -180,7 +180,7 @@ HEREDOC
         if @mysql_command.include? '-p'
           puts "Please enter your MySQL/MariaDB account 'root' for: DROP DATABASE #{db}"
         else
-          Interaction.note "Dropping MySQL/MariaDB database #{db}"
+          puts "Dropping MySQL/MariaDB database #{db}"
         end
         `#{@mysql_command} -e 'DROP DATABASE \`#{db}\`;'`
       end
@@ -206,7 +206,7 @@ HEREDOC
       until %w[y n].include? proceed
         deletable_dbs = filter_whitelisted(dbtype, database_list)
         if deletable_dbs.empty?
-          Interaction.note "No #{dbtype} databases found that were not whitelisted"
+          Interaction.note "No #{dbtype} databases found that were not whitelisted."
           if Interaction.prompt('Edit the whitelist? [y]es or [n]o') == 'y'
             proceed = 'e'
           else
@@ -214,11 +214,11 @@ HEREDOC
           end
         end
         if proceed.empty?
-          Interaction.note "The following #{dbtype} databases are not whitelisted and could be deleted:"
+          Interaction.note "The following #{dbtype} databases are not whitelisted and can be deleted:"
           deletable_dbs.sort.each do |db|
             puts db
           end
-          Interaction.note "Those #{dbtype} databases are not whitelisted and could be deleted."
+          Interaction.note "These #{dbtype} databases are not whitelisted and can be deleted."
           proceed = Interaction.prompt('Proceed? [y]es, [n]o or [e]dit whitelist')
         end
         case proceed
@@ -226,7 +226,7 @@ HEREDOC
           proceed = '' # reset user selection
           edit_whitelist dbtype
         when 'n'
-          Interaction.success 'Not deleting anything'
+          Interaction.success 'Nothing deleted.'
           return []
         when 'y'
           return deletable_dbs

data/lib/geordi/docker.rb

@@ -1,6 +1,7 @@
 require 'geordi/interaction'
 require 'geordi/cucumber'
 require 'yaml'
+require 'open3'
 
 module Geordi
   class Docker
@@ -28,13 +29,61 @@ module Geordi
     end
 
     def vnc
-      Cucumber.new.launch_vnc_viewer('::5967')
+      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 Util.strip_heredoc <<-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
-      running_containers = execute(:`, 'docker-compose ps').split("\n")
+      # 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')
@@ -54,13 +103,17 @@ module Geordi
     def execute(kind, *args)
       if ENV['GEORDI_TESTING']
         puts "Stubbed run #{args.join(' ')}"
-        if kind == :`
+        if kind == :` || kind == :capture
           mock_parse(*args)
         else
           mock_run(*args)
         end
       else
-        send(kind, *args)
+        if kind == :capture
+          Open3.capture2(*args)
+        else
+          send(kind, *args)
+        end
       end
     end
 
@@ -112,5 +165,19 @@ module Geordi
         []
       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