geordi 5.4.0 → 6.0.0.pre.rc1

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

data/lib/geordi/gitpt.rb

@@ -64,26 +64,41 @@ No staged changes. Will create an empty commit.
 
     def load_projects
       project_ids = settings.pivotal_tracker_project_ids
-      project_ids.collect { |project_id| client.project(project_id) }
+      project_ids.collect do |project_id|
+        begin
+          client.project(project_id)
+        rescue TrackerApi::Errors::ClientError
+          puts # Start a new line
+          Geordi::Interaction.warn "Could not access project #{project_id}. Skipping."
+        end
+      end.compact
     end
 
     def applicable_stories
+      if Util.testing?
+        return ENV['GEORDI_TESTING_NO_PT_STORIES'] == 'true' ? [] : [OpenStruct.new(id: 12, name: 'Test Story')]
+      end
+
       projects = load_projects
       projects.collect do |project|
-        project.stories(filter: 'state:started,finished,rejected')
+        project.stories(filter: 'state:started,finished,rejected', fields: ':default,owners(id,name)')
       end.flatten
     end
 
     def choose_story
-      if Util.testing?
-        return OpenStruct.new(id: 12, name: 'Test Story')
-      end
-
       loading_message = 'Connecting to Pivotal Tracker ...'
       print(loading_message)
       stories = applicable_stories
       reset_loading_message = "\r#{' ' * (loading_message.length + stories.length)}\r"
 
+      Geordi::Interaction.fail('No stories to offer.') if stories.empty?
+
+      if Util.testing?
+        return stories[0]
+      end
+
+      my_id = client.me.id
+
       highline.choose do |menu|
         menu.header = 'Choose a story'
 
@@ -92,7 +107,7 @@ No staged changes. Will create an empty commit.
 
           state = story.current_state
           owners = story.owners
-          owner_is_me = owners.collect(&:id).include?(client.me.id)
+          owner_is_me = owners.collect(&:id).include?(my_id)
 
           if state == 'started'
             state = HighLine::GREEN + state + HighLine::RESET

data/lib/geordi/interaction.rb

@@ -11,8 +11,9 @@ module Geordi
       puts "\e[4;34m#{message}\e[0m" # blue underline
     end
 
-    # Any hints, comments, infos or explanations should be `note`d. Please do
-    # not print any output (data, file contents, lists) with `note`.
+    # Any meta information, i.e. hints, comments, infos or explanations should
+    # be printed with `note`.
+    # Please do not use it for command output (data, file contents, lists etc).
     def note(text)
       puts '> ' + text
     end
@@ -38,7 +39,8 @@ module Geordi
       exit(1)
     end
 
-    # When you're done, inform the user with a `success` and a short message
+    # When you're done, inform the user with a `success` and a short message. It
+    # should be a sentence (i.e. ending with [.!?]).
     def success(text)
       message = "\n> #{text}"
       puts "\e[32m#{message}\e[0m" # green

data/lib/geordi/settings.rb

@@ -9,7 +9,9 @@ module Geordi
     LOCAL_SETTINGS_FILE_NAME = Util.testing? ? './tmp/local_settings.yml'.freeze : './.geordi.yml'.freeze
 
     ALLOWED_GLOBAL_SETTINGS = %w[ pivotal_tracker_api_key auto_update_chromedriver pivotal_tracker_project_ids ].freeze
-    ALLOWED_LOCAL_SETTINGS = %w[ use_vnc pivotal_tracker_project_ids ].freeze
+    ALLOWED_LOCAL_SETTINGS = %w[ pivotal_tracker_project_ids ].freeze
+
+    SETTINGS_WARNED = 'GEORDI_INVALID_SETTINGS_WARNED'
 
     def initialize
       read_settings
@@ -34,13 +36,6 @@ module Geordi
       save_global_settings
     end
 
-    # Local settings
-    # They should not be changed by geordi to avoid unexpected diffs, therefore
-    # there are no setters for these settings
-    def use_vnc?
-      @local_settings.fetch('use_vnc', true)
-    end
-
     def pivotal_tracker_project_ids
       local_project_ids = @local_settings['pivotal_tracker_project_ids'] || pt_project_ids_old
       global_project_ids = @global_settings['pivotal_tracker_project_ids']
@@ -73,14 +68,20 @@ module Geordi
       global_path = GLOBAL_SETTINGS_FILE_NAME
       local_path = LOCAL_SETTINGS_FILE_NAME
 
-      if File.exists?(global_path)
-        global_settings = YAML.safe_load(File.read(global_path))
-        check_for_invalid_keys(global_settings, ALLOWED_GLOBAL_SETTINGS, global_path)
+      global_settings = if File.exists?(global_path)
+        YAML.safe_load(File.read(global_path))
+      end
+      local_settings = if File.exists?(local_path)
+        YAML.safe_load(File.read(local_path))
       end
 
-      if File.exists?(local_path)
-        local_settings = YAML.safe_load(File.read(local_path))
+      # Prevent duplicate warnings caused by another instance of Settings
+      unless ENV[SETTINGS_WARNED]
+        check_for_invalid_keys(global_settings, ALLOWED_GLOBAL_SETTINGS, global_path)
         check_for_invalid_keys(local_settings, ALLOWED_LOCAL_SETTINGS, local_path)
+        Interaction.warn "Unsupported config file \".firefox-version\". Please remove it." if File.exists?('.firefox-version')
+
+        ENV[SETTINGS_WARNED] = 'true'
       end
 
       @global_settings = global_settings || {}
@@ -88,21 +89,12 @@ module Geordi
     end
 
     def check_for_invalid_keys(settings, allowed_keys, file)
+      return if settings.nil?
+
       invalid_keys = settings.keys - allowed_keys
       unless invalid_keys.empty?
-        Geordi::Interaction.warn "Geordi detected unknown keys in #{file}.\n"
-
-        invalid_keys.sort.each do |key|
-          puts "* #{key}"
-        end
-
-        puts "\nAllowed keys are:"
-        allowed_keys.sort.each do |key|
-          puts "* #{key}"
-        end
-        puts
-
-        exit 1
+        Interaction.warn "Unknown settings in #{file}: #{invalid_keys.join(", ")}"
+        Interaction.note "Supported settings in #{file} are: #{allowed_keys.join(", ")}"
       end
     end
 

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '5.4.0'.freeze
+  VERSION = '6.0.0-rc1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 6.0.0.pre.rc1
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -32,12 +32,12 @@ executables:
 - b
 - dumple
 - geordi
-- launchy_browser
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rspec"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
@@ -48,14 +48,12 @@ files:
 - exe/b
 - exe/dumple
 - exe/geordi
-- exe/launchy_browser
 - geordi.gemspec
 - lib/geordi.rb
 - lib/geordi/COMMAND_TEMPLATE
 - lib/geordi/capistrano_config.rb
 - lib/geordi/chromedriver_updater.rb
 - lib/geordi/cli.rb
-- lib/geordi/commands/_setup_vnc.rb
 - lib/geordi/commands/apache_site.rb
 - lib/geordi/commands/branch.rb
 - lib/geordi/commands/bundle_install.rb
@@ -72,7 +70,6 @@ files:
 - lib/geordi/commands/docker.rb
 - lib/geordi/commands/drop_databases.rb
 - lib/geordi/commands/dump.rb
-- lib/geordi/commands/firefox.rb
 - lib/geordi/commands/migrate.rb
 - lib/geordi/commands/png_optimize.rb
 - lib/geordi/commands/rake.rb
@@ -86,14 +83,12 @@ files:
 - lib/geordi/commands/unit.rb
 - lib/geordi/commands/update.rb
 - lib/geordi/commands/version.rb
-- lib/geordi/commands/vnc.rb
 - lib/geordi/commands/with_rake.rb
 - 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
 - lib/geordi/interaction.rb
 - lib/geordi/remote.rb
@@ -104,7 +99,8 @@ homepage: https://makandra.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "  Support for sequential running of integration tests tagged
+  with @solo has been dropped.\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -115,11 +111,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+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

data/exe/launchy_browser

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-
-# This script is a part of Geordi. It is used by the cucumber command to have
-# launchy open error pages from tests in the users browser, as apposed to
-# opening it within VNC.
-
-# For unknown reasons, #require cannot find 'geordi/cucumber', so we need to
-# require it this way. Hours have been spent trying to require 'geordi/cucumber'.
-require File.expand_path('../../lib/geordi/cucumber', __FILE__)
-Geordi::Cucumber.new.restore_env
-
-require 'rubygems'
-require 'launchy'
-
-Launchy.open(ARGV.first)

data/lib/geordi/commands/_setup_vnc.rb

@@ -1,64 +0,0 @@
-desc '-setup-vnc', 'Setup VNC for running Selenium tests there', hide: true
-def _setup_vnc
-  `clear`
-
-  Interaction.note 'This script will help you install a VNC server and a VNC viewer.'
-  puts
-  puts Util.strip_heredoc <<-TEXT
-    With those you will be able to use our cucumber script without being
-    disturbed by focus-stealing Selenium windows. Instead, they will open
-    inside a VNC session.
-
-    You can still inspect everything with:
-  TEXT
-  Interaction.note_cmd 'geordi vnc'
-  puts
-  Interaction.note 'Please open a second shell to execute instructions.'
-  Interaction.prompt 'Continue ...'
-
-  Interaction.announce 'Setup VNC server'
-
-  vnc_server_installed = system('which vncserver > /dev/null 2>&1')
-  if vnc_server_installed
-    Interaction.success 'It appears you already have a VNC server installed. Good job!'
-  else
-    puts 'Please run:'
-    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, 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 'vncpasswd'
-    Interaction.warn 'Enter a secure password!'
-    Interaction.prompt 'Continue ...'
-  end
-
-  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
-    All done. Our cucumber script will now automatically run Selenium features
-    in VNC.
-  TEXT
-
-  Interaction.success 'Happy cuking!'
-end