geordi 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcd8074a50a0c81d4e0b7e2beaef07e8508018a494ae9b3cc288bb29c0b9e796
-  data.tar.gz: a8091353e0d315e6e37f93227688a89d74b7b01abcf4d4a4339271aaaf65e50a
+  metadata.gz: e775f88b224275cf01077937ba959b27666c1ae7ac18b58548a62bfa31161a12
+  data.tar.gz: 4e0efdb89bbf65b69a9753e8e05978b094915b613b1ded6ef1c1ea4716be0ea7
 SHA512:
-  metadata.gz: b6147e0cbddbcba812f1ea87f03544c0cefd6f40f766b6971275ec5c8efb25f307d47623508bb2990b7cdbd88ed540c51de51920faa59236e5a2034b2cfa9d68
-  data.tar.gz: '078962b0bac78764315e54f2f104354966cc775f18bd9a6d514069c8972bcf3dd4c96cb8b58e0ddf42b233032c12c7d00eb3af24b67970548bb297915d7394b7'
+  metadata.gz: 56146e32a18966efbe63a58074d158b888410cf19520150d175f3220be709820b7b05ed6f95df5f80993ed163ba9b59232f1d1f67c3bd43d2055e9b2d66cd812
+  data.tar.gz: e8e41bb61713a5f32dd4039cadee5b11a9f08bac20cad738e61975ea741bfd76cdf5e2d64a166579e701eda472f95f4f8ce15da27181fa0a8b11b748f5d222d3

data/.gitignore

@@ -3,6 +3,5 @@
 .idea
 pkg/*
 .DS_Store
-.pt_project_id
 tmp
 .byebug_history

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
@@ -7,13 +8,46 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ## Unreleased
 
 ### Compatible changes
-
 ### Breaking changes
 
 
-## 3.0.0 2020-05-04
+## 3.2.0 2020-07-15
+
+### Compatible changes
+- Improvement #43: `--select-server` option on `geordi shell` and `geordi console` can take the number of the server to connect to it directly and to skip the menu.
+- Add a `.geordi.yml` file to change multiple settings in the project and  `~/.config/geordi/global.yml` for global settings.
+- Deprecated the `.pt_project_id` file in favor of `.geordi.yml`.
+- Deprecated the `~/.gitpt` file in favor of `~/.config/geordi/global.yml`.
+- Add #91: Now there is an option to start cucumber without a VNC session. This is configured by the .geordi.yml file.
+- Fixed `git#staged_changes?` detection on Ruby < 2.5.
+
+
+## 3.1.0 2020-06-03
+
+### Compatible changes
+- Update security-update for improved workflow (#89): Deploy staging first and ask user, if application is still running. Then deploy other stages.
+
+
+## 3.0.3 2020-05-27
 
 ### Compatible changes
+- Fix #98: Changing the `config/database.yml` reader from `YAML.load` to `YAML.safe_load` dropped the support for aliases. We now allow aliases and the classes `Time` and `Symbol`. If we encounter further issues with this approach a revert to `YAML.load` would be an option, too.
+
+
+## 3.0.2 2020-05-18
+
+### Compatible changes
+- Fix #95: Method change from `! *.include?` to `*.exclude?` was not valid as we do not have active support in Geordi. Affected commands were `geordi cucumber` and `geordi deploy`.
+
+
+## 3.0.1 2020-05-13
+
+### Compatible changes
+- Fix #93: Using `$CHILDSTATUS` instead of `$?` did not work properly. This affected commands like `geordi drop-databases` to fail.
+- Fix #92: Geordi fail messages were converted to exceptions by accident. Now they are printed as red error message without the backtrace again.
+
+
+## 3.0.0 2020-05-04
 
 ### 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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (3.0.0)
+    geordi (3.2.0)
       thor (~> 1)
 
 GEM

data/README.md

@@ -54,8 +54,13 @@ 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`.
+stored in `~/.config/geordi/global.yml`.
 
 
 ### `geordi console [TARGET]`
@@ -66,6 +71,14 @@ Open a local Rails console: `geordi console`
 
 Open a Rails console on `staging`: `geordi console staging`
 
+Lets you select the server to connect to from a menu when called with `--select-server` or the alias `-s`:
+
+    geordi console staging -s
+
+If you already know the number of the server you want to connect to, just pass it along:
+
+    geordi console staging -s2
+
 
 ### `geordi cucumber [FILES and OPTIONS]`
 
@@ -87,6 +100,12 @@ or `-d`.
 - *Options:* Any unknown option will be passed through to Cucumber,
 e.g. `--format pretty`.
 
+- *VNC:* By default, test browsers will run in a VNC session. When using a
+headless test browser anyway, you can disable VNC by putting the following
+config into `.geordi.yml` in the project root:
+
+    use_vnc: false
+
 
 ### `geordi delete-dumps [DIRECTORY]`
 
@@ -255,10 +274,30 @@ Support for performing security updates.
 
 Preparation for security update: `geordi security-update`
 
+Checks out production and pulls.
+
 After performing the update: `geordi security-update finish`
 
 Switches branches, pulls, pushes and deploys as required by our workflow. Tells
-what it will do before it does it.
+what it will do before it does it. In detail:
+
+1. Asks user, if tests are green
+
+2. Pushes production
+
+3. Checks out master and pulls
+
+4. Merges production and pushes in master
+
+5. Deploys staging first, if there is a staging environment
+
+6. Asks user, if deployment log is okay and application is still running on staging
+
+7. Deploys other stages
+
+8. Asks user, if deployment log is okay and application is still running on all other stages
+
+9. Informs user about the next steps
 
 
 ### `geordi server [PORT]`
@@ -295,10 +334,14 @@ Open a shell on a Capistrano deploy target.
 
 Example: `geordi shell production`
 
-Lets you select the server to connect to when called with `--select-server`:
+Lets you select the server to connect to from a menu when called with `--select-server` or the alias `-s`:
 
     geordi shell production -s
 
+If you already know the number of the server you want to connect to, just pass it along:
+
+    geordi shell production -s2
+
 
 ### `geordi tests`
 

data/lib/geordi/COMMAND_TEMPLATE

@@ -21,10 +21,9 @@ def example
   # Invoke other commands like this:
   invoke_cmd 'other_command', 'argument', an: 'option'
 
-  fail 'Option missing' unless options.opt?
+  Interaction.fail 'Option missing' unless options.opt?
 
-  # For formatted output, see geordi/interaction.rb
-  success 'Done.'
+  Interaction.success 'Done.'
 end
 
 # Command mappings, usually not needed

data/lib/geordi/chromedriver_updater.rb

@@ -4,14 +4,13 @@ require 'tempfile'
 
 module Geordi
   class ChromedriverUpdater
-    include Geordi::Interaction
 
     def run
       chrome_version = determine_chrome_version
       chromedriver_version = determine_chromedriver_version
 
       if skip_update?(chrome_version, chromedriver_version)
-        warn("No update required, you are using for both executables the same version #{chrome_version}!")
+        Interaction.warn("No update required, you are using for both executables the same version #{chrome_version}!")
       else
         chromedriver_zip = download_chromedriver(chrome_version)
         unzip(chromedriver_zip, File.expand_path('~/bin'))
@@ -19,7 +18,7 @@ module Geordi
         chromedriver_zip.unlink
 
         # We need to determine the version again, as it could be nil in case no chromedriver was installed before
-        note "Chromedriver updated to version #{determine_chromedriver_version}"
+        Interaction.note "Chromedriver updated to version #{determine_chromedriver_version}"
       end
     end
 
@@ -32,7 +31,7 @@ module Geordi
       end
 
       if !status.success? || chrome_version.nil?
-        raise('Could not determine the current Google Chrome version')
+        Interaction.fail('Could not determine the current Google Chrome version')
       else
         chrome_version.to_i
       end
@@ -47,7 +46,7 @@ module Geordi
       end
 
       if !status.success? || chromedriver_version.nil?
-        raise('Could not determine the current chromedriver version')
+        Interaction.fail('Could not determine the current chromedriver version')
       else
         chromedriver_version.to_i
       end
@@ -69,7 +68,7 @@ module Geordi
 
         file
       else
-        raise("Could not download chromedriver version #{latest_version}")
+        Interaction.fail("Could not download chromedriver version #{latest_version}")
       end
     end
 
@@ -80,7 +79,7 @@ module Geordi
       if response.is_a?(Net::HTTPSuccess)
         response.body.to_s
       else
-        raise("Could not find the latest version for Google Chrome version #{chrome_version}")
+        Interaction.fail("Could not find the latest version for Google Chrome version #{chrome_version}")
       end
     end
 
@@ -88,7 +87,7 @@ module Geordi
       _stdout_str, _error_str, status = Open3.capture3('unzip', '-d', output_dir, '-o', zip.path)
 
       unless status.success?
-        raise("Could not unzip #{zip.path}")
+        Interaction.fail("Could not unzip #{zip.path}")
       end
     end
   end

data/lib/geordi/cli.rb

@@ -5,7 +5,6 @@ require 'geordi/util'
 
 module Geordi
   class CLI < Thor
-    include Geordi::Interaction
 
     def self.exit_on_failure?
       true

data/lib/geordi/commands/_setup_vnc.rb

@@ -2,33 +2,33 @@ desc '-setup-vnc', 'Setup VNC for running Selenium tests there', hide: true
 def _setup_vnc
   `clear`
 
-  note 'This script will help you install a VNC server and a VNC viewer.'
+  Interaction.note 'This script will help you install a VNC server and a VNC viewer.'
   puts
-  puts strip_heredoc <<-TEXT
+  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
-  note_cmd 'geordi vnc'
+  Interaction.note_cmd 'geordi vnc'
   puts
-  note 'Please open a second shell to execute instructions.'
-  prompt 'Continue ...'
+  Interaction.note 'Please open a second shell to execute instructions.'
+  Interaction.prompt 'Continue ...'
 
-  announce 'Setup VNC server'
+  Interaction.announce 'Setup VNC server'
 
   vnc_server_installed = system('which vncserver > /dev/null 2>&1')
   if vnc_server_installed
-    success 'It appears you already have a VNC server installed. Good job!'
+    Interaction.success 'It appears you already have a VNC server installed. Good job!'
   else
     puts 'Please run:'
-    note_cmd 'sudo apt-get install vnc4server'
-    prompt 'Continue ...'
+    Interaction.note_cmd 'sudo apt-get install vnc4server'
+    Interaction.prompt 'Continue ...'
 
     puts
-    note 'We will now set a password for your VNC server.'
-    puts strip_heredoc <<-TEXT
+    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
@@ -36,31 +36,31 @@ def _setup_vnc
 
     TEXT
     puts 'Please run:'
-    note_cmd 'vncserver :20'
-    warn 'Enter a secure password!'
-    prompt 'Continue ...'
+    Interaction.note_cmd 'vncserver :20'
+    Interaction.warn 'Enter a secure password!'
+    Interaction.prompt 'Continue ...'
 
     puts 'Now stop the server again. Please run:'
-    note_cmd 'vncserver -kill :20'
-    prompt 'Continue ...'
+    Interaction.note_cmd 'vncserver -kill :20'
+    Interaction.prompt 'Continue ...'
   end
 
-  announce 'Setup VNC viewer'
+  Interaction.announce 'Setup VNC viewer'
 
   vnc_viewer_installed = system('which vncviewer > /dev/null 2>&1')
   if vnc_viewer_installed
-    success 'It appears you already have a VNC viewer installed. Good job!'
+    Interaction.success 'It appears you already have a VNC viewer installed. Good job!'
   else
     puts 'Please run:'
-    note_cmd 'sudo apt-get install xtightvncviewer'
-    prompt 'Continue ...'
+    Interaction.note_cmd 'sudo apt-get install xtightvncviewer'
+    Interaction.prompt 'Continue ...'
   end
 
   puts
-  puts strip_heredoc <<-TEXT
+  puts Util.strip_heredoc <<-TEXT
     All done. Our cucumber script will now automatically run Selenium features
     in VNC.
   TEXT
 
-  success 'Happy cuking!'
+  Interaction.success 'Happy cuking!'
 end

data/lib/geordi/commands/bundle_install.rb

@@ -1,7 +1,7 @@
 desc 'bundle-install', 'Run bundle install if required', hide: true
 def bundle_install
   if File.exist?('Gemfile') && !system('bundle check > /dev/null 2>&1')
-    announce 'Bundling'
+    Interaction.announce 'Bundling'
     Util.system! 'bundle install'
   end
 end

data/lib/geordi/commands/capistrano.rb

@@ -6,16 +6,16 @@ LONGDESC
 def capistrano(*args)
   targets = Dir['config/deploy/*.rb'].map { |file| File.basename(file, '.rb') }.sort
 
-  note 'Found the following deploy targets:'
+  Interaction.note 'Found the following deploy targets:'
   puts targets
-  prompt('Continue?', 'n', /y|yes/) || raise('Cancelled.')
+  Interaction.prompt('Continue?', 'n', /y|yes/) || Interaction.fail('Cancelled.')
 
   targets << nil if targets.empty? # default target
   targets.each do |stage|
-    announce 'Target: ' + (stage || '(default)')
+    Interaction.announce 'Target: ' + (stage || '(default)')
 
     command = "bundle exec cap #{stage} " + args.join(' ')
-    note_cmd command
+    Interaction.note_cmd command
 
     Util.system!(command, fail_message: 'Capistrano failed. Have a look!')
   end

data/lib/geordi/commands/clean.rb

@@ -1,14 +1,15 @@
 desc 'clean', 'Remove unneeded files from the current directory'
 def clean
-  announce 'Removing tempfiles'
-  %w[webrat-* capybara-* tmp/webrat-* tmp/capybara-* tmp/rtex/* log/*.log].each do |pattern|
-    note pattern
+
+  Interaction.announce 'Removing tempfiles'
+  for pattern in %w[ webrat-* capybara-* tmp/webrat-* tmp/capybara-* tmp/rtex/* log/*.log ]
+    Interaction.note pattern
     puts `rm -vfR #{pattern}`
   end
 
-  announce 'Finding recursively and removing backup files'
+  Interaction.announce 'Finding recursively and removing backup files'
   %w[*~].each do |pattern|
-    note pattern
+    Interaction.note pattern
     `find . -name #{pattern} -exec rm {} ';'`
   end
 end

data/lib/geordi/commands/commit.rb

@@ -9,7 +9,7 @@ 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`.
+stored in `~/.config/geordi/global.yml`.
 LONGDESC
 
 def commit(*git_args)

data/lib/geordi/commands/console.rb

@@ -3,10 +3,18 @@ long_desc <<-LONGDESC
 Open a local Rails console: `geordi console`
 
 Open a Rails console on `staging`: `geordi console staging`
+
+Lets you select the server to connect to from a menu when called with `--select-server` or the alias `-s`:
+
+    geordi console staging -s
+
+If you already know the number of the server you want to connect to, just pass it along:
+
+    geordi console staging -s2
 LONGDESC
 
 
-option :select_server, default: false, type: :boolean, aliases: '-s'
+option :select_server, type: :string, aliases: '-s'
 
 def console(target = 'development', *_args)
   require 'geordi/remote'
@@ -14,11 +22,11 @@ def console(target = 'development', *_args)
   if target == 'development'
     invoke_cmd 'yarn_install'
 
-    announce 'Opening a local Rails console'
+    Interaction.announce 'Opening a local Rails console'
 
     Util.system! Util.console_command(target)
   else
-    announce 'Opening a Rails console on ' + target
+    Interaction.announce 'Opening a Rails console on ' + target
 
     Geordi::Remote.new(target).console(options)
   end