geordi 2.11.0 → 3.1.0

data/lib/geordi/commands/security_update.rb

@@ -2,53 +2,110 @@ desc 'security-update [STEP]', 'Support for performing security updates'
 long_desc <<-LONGDESC
 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
 LONGDESC
 
-def security_update(step='prepare')
+def security_update(step = 'prepare')
   case step
   when 'prepare'
-    announce 'Preparing for security update'
-    warn 'Please read https://makandracards.com/makandra/1587 before applying security updates!'
-    note 'About to checkout production and pull'
-    prompt('Continue?', 'y', /y|yes/) or fail 'Cancelled.'
+    Interaction.announce 'Preparing for security update'
+    Interaction.warn 'Please read https://makandracards.com/makandra/1587 before applying security updates!'
+    Interaction.note 'About to checkout production and pull.'
+    Interaction.prompt('Continue?', 'y', /y|yes/) || Interaction.fail('Cancelled.')
 
-    Util.system! 'git checkout production', :show_cmd => true
-    Util.system! 'git pull', :show_cmd => true
+    Util.system! 'git checkout production', show_cmd: true
+    Util.system! 'git pull', show_cmd: true
 
-    success 'Successfully prepared for security update'
+    Interaction.success 'Successfully prepared for security update'
     puts
-    note 'Please apply the security update now and commit your changes.'
-    note 'When you are done, run `geordi security-update finish`.'
+    Interaction.note 'Please apply the security update now and commit your changes.'
+    Interaction.note 'When you are done, run `geordi security-update finish`.'
 
 
   when 'f', 'finish'
     # ensure everything is committed
-    `git status --porcelain`.empty? or fail('Please commit your changes before finishing the update.')
+    if Util.testing?
+      puts 'Util.system! git status --porcelain'
+    else
+      `git status --porcelain`.empty? || Interaction.fail('Please commit your changes before finishing the update.')
+    end
 
-    announce 'Finishing security update'
-    note 'Working directory clean.'
-    prompt('Have you successfully run all tests?', 'n', /y|yes/) or fail 'Please run tests first.'
+    Interaction.announce 'Finishing security update'
+    Interaction.note 'Working directory clean.'
+    Interaction.prompt('Have you successfully run all tests?', 'n', /y|yes/) || Interaction.fail('Please run tests first.')
 
-    note 'About to: push production, checkout & pull master, merge production, push master'
-    prompt('Continue?', 'n', /y|yes/) or fail 'Cancelled.'
+    Interaction.note 'About to: push production, checkout & pull master, merge production, push master.'
+    Interaction.prompt('Continue?', 'n', /y|yes/) || Interaction.fail('Cancelled.')
 
-    Util.system! 'git push', :show_cmd => true
-    Util.system! 'git checkout master', :show_cmd => true
-    Util.system! 'git pull', :show_cmd => true
-    Util.system! 'git merge production', :show_cmd => true
-    Util.system! 'git push', :show_cmd => true
+    Util.system! 'git push', show_cmd: true
+    Util.system! 'git checkout master', show_cmd: true
+    Util.system! 'git pull', show_cmd: true
+    Util.system! 'git merge production', show_cmd: true
+    Util.system! 'git push', show_cmd: true
 
-    announce 'Deploying all targets'
+    Interaction.announce 'Deployment'
     deploy = (Util.gem_major_version('capistrano') == 3) ? 'deploy' : 'deploy:migrations'
-    invoke_cmd 'capistrano', deploy
 
-    success 'Successfully pushed and deployed security update'
+    all_deploy_targets = Util.deploy_targets
+    Interaction.fail 'There are no deploy targets!' if all_deploy_targets.empty?
+
+    if all_deploy_targets.include?('staging')
+      Interaction.note 'There is a staging environment.'
+      Interaction.prompt('Deploy staging now?', 'y', /y|yes/) || Interaction.fail('Cancelled.')
+
+      Interaction.announce 'Deploy staging'
+      Util.system! "bundle exec cap staging #{deploy}", show_cmd: true
+
+      Interaction.prompt('Is the deployment log okay and the application is still running on staging?', 'y', /y|yes/) || Interaction.fail('Please fix the deployment issues on staging before you continue.')
+    else
+      Interaction.note 'There is no staging environment.'
+    end
+
+    deploy_targets_without_staging = all_deploy_targets.select { |target| target != 'staging' }
+
+    if deploy_targets_without_staging.empty?
+      Interaction.note 'There are no other stages.'
+    else
+      puts
+      Interaction.note 'Found the following other stages:'
+      puts deploy_targets_without_staging
+      puts
+      Interaction.prompt('Deploy other stages now?', 'y', /y|yes/) || Interaction.fail('Cancelled.')
+
+      deploy_targets_without_staging.each do |target|
+        Interaction.announce "Deploy #{target}"
+        Util.system! "bundle exec cap #{target} #{deploy}", show_cmd: true
+      end
+
+      Interaction.prompt('Is the application still running on all other stages and the logs are okay?', 'y', /y|yes/) || Interaction.fail('Please fix the application immediately!')
+    end
+
+    Interaction.success 'Successfully pushed and deployed security update'
     puts
-    note 'Now send an email to customer and project lead, informing them about the update.'
-    note 'Do not forget to make a joblog on a security budget, if available.'
+    Interaction.note 'Now send an email to customer and project lead, informing them about the update.'
+    Interaction.note 'Do not forget to make a joblog on a security budget, if available.'
   end
 end

data/lib/geordi/commands/server.rb

@@ -1,18 +1,18 @@
 desc 'server [PORT]', 'Start a development server'
 
-option :port, :aliases => '-p', :default => '3000',
-  :desc => 'Choose a port'
-option :public, :aliases => '-P', :type => :boolean,
-  :desc => 'Make the server accessible in the local network'
+option :port, aliases: '-p', default: '3000',
+  desc: 'Choose a port'
+option :public, aliases: '-P', type: :boolean,
+  desc: 'Make the server accessible in the local network'
 
 def server(port = nil)
   invoke_cmd 'bundle_install'
   invoke_cmd 'yarn_install'
   require 'geordi/util'
 
-  announce 'Booting a development server'
+  Interaction.announce 'Booting a development server'
   port ||= options.port
-  note "URL: http://#{ File.basename(Dir.pwd) }.vcap.me:#{port}"
+  Interaction.note "URL: http://#{File.basename(Dir.pwd)}.vcap.me:#{port}"
   puts
 
   command = Util.server_command

data/lib/geordi/commands/setup.rb

@@ -19,14 +19,14 @@ After setting up, runs all tests when called with the `--test` option:
     geordi setup -t
 LONGDESC
 
-option :dump, :type => :string, :aliases => '-d', :banner => 'TARGET',
-  :desc => 'After setup, dump the TARGET db and source it into the development db'
-option :test, :type => :boolean, :aliases => '-t', :desc => 'After setup, run tests'
+option :dump, type: :string, aliases: '-d', banner: 'TARGET',
+  desc: 'After setup, dump the TARGET db and source it into the development db'
+option :test, type: :boolean, aliases: '-t', desc: 'After setup, run tests'
 
 def setup
-  if File.exists? 'bin/setup'
-    announce 'Running bin/setup'
-    note "Geordi's own setup routine is skipped"
+  if File.exist? 'bin/setup'
+    Interaction.announce 'Running bin/setup'
+    Interaction.note "Geordi's own setup routine is skipped"
 
     Util.system! 'bin/setup'
   else
@@ -34,8 +34,8 @@ def setup
     invoke_cmd 'migrate'
   end
 
-  success 'Successfully set up the project.'
+  Interaction.success 'Successfully set up the project.'
 
-  invoke_cmd 'dump', options.dump, :load => true if options.dump
+  invoke_cmd 'dump', options.dump, load: true if options.dump
   invoke_cmd 'tests' if options.test
 end

data/lib/geordi/commands/shell.rb

@@ -7,13 +7,13 @@ Lets you select the server to connect to when called with `--select-server`:
     geordi shell production -s
 LONGDESC
 
-option :select_server, :default => false, :type => :boolean, :aliases => '-s'
+option :select_server, default: false, type: :boolean, aliases: '-s'
 
 # This method has a triple 'l' because :shell is a Thor reserved word. However,
 # it can still be called with `geordi shell` :)
-def shelll(target, *args)
+def shelll(target, *_args)
   require 'geordi/remote'
 
-  announce 'Opening a shell on ' + target
+  Interaction.announce 'Opening a shell on ' + target
   Geordi::Remote.new(target).shell(options)
 end

data/lib/geordi/commands/tests.rb

@@ -10,5 +10,5 @@ def tests
     invoke_cmd 'cucumber'
   end
 
-  success 'Successfully ran tests.'
+  Interaction.success 'Successfully ran tests.'
 end

data/lib/geordi/commands/unit.rb

@@ -1,12 +1,12 @@
 desc 'unit', 'Run Test::Unit'
 def unit
-  if File.exists?('test/test_helper.rb')
+  if File.exist?('test/test_helper.rb')
     invoke_cmd 'bundle_install'
     invoke_cmd 'yarn_install'
 
-    announce 'Running Test::Unit'
+    Interaction.announce 'Running Test::Unit'
     Util.system! 'bundle exec rake test'
   else
-    note 'Test::Unit not employed.'
+    Interaction.note 'Test::Unit not employed.'
   end
 end

data/lib/geordi/commands/update.rb

@@ -16,18 +16,18 @@ After updating, runs all tests when called with the `--test` option:
 See `geordi help update` for details.
 LONGDESC
 
-option :dump, :type => :string, :aliases => '-d', :banner => 'TARGET',
-  :desc => 'After updating, dump the TARGET db and source it into the development db'
-option :test, :type => :boolean, :aliases => '-t', :desc => 'After updating, run tests'
+option :dump, type: :string, aliases: '-d', banner: 'TARGET',
+  desc: 'After updating, dump the TARGET db and source it into the development db'
+option :test, type: :boolean, aliases: '-t', desc: 'After updating, run tests'
 
 def update
-  announce 'Updating repository'
-  Util.system! 'git pull', :show_cmd => true
+  Interaction.announce 'Updating repository'
+  Util.system! 'git pull', show_cmd: true
 
   invoke_cmd 'migrate'
 
-  success 'Successfully updated the project.'
+  Interaction.success 'Successfully updated the project.'
 
-  invoke_cmd 'dump', options.dump, :load => true if options.dump
+  invoke_cmd 'dump', options.dump, load: true if options.dump
   invoke_cmd 'tests' if options.test
 end

data/lib/geordi/commands/vnc.rb

@@ -8,7 +8,7 @@ tests.
 When called with `--setup`, will guide through the setup of VNC.
 LONGDESC
 
-option :setup, :type => :boolean
+option :setup, type: :boolean
 
 def vnc
   if options.setup

data/lib/geordi/commands/with_rake.rb

@@ -1,13 +1,13 @@
-desc 'with-rake', 'Run tests with `rake`', :hide => true
+desc 'with-rake', 'Run tests with `rake`', hide: true
 def with_rake
   if Util.file_containing?('Rakefile', /^task.+default.+(spec|test|feature)/)
     invoke_cmd 'bundle_install'
     invoke_cmd 'yarn_install'
 
-    announce 'Running tests with `rake`'
+    Interaction.announce 'Running tests with `rake`'
     Util.system! 'rake'
   else
-    note '`rake` does not run tests.'
+    Interaction.note '`rake` does not run tests.'
     :did_not_perform
   end
 end

data/lib/geordi/commands/yarn_install.rb

@@ -1,8 +1,8 @@
-desc 'yarn-install', 'Runs yarn install if required', :hide => true
+desc 'yarn-install', 'Runs yarn install if required', hide: true
 
 def yarn_install
-  if File.exists?('package.json') and !system('yarn check --integrity > /dev/null 2>&1')
-    announce 'Yarn install'
+  if File.exist?('package.json') && !system('yarn check --integrity > /dev/null 2>&1')
+    Interaction.announce 'Yarn install'
     Util.system! 'yarn install'
   end
 end

data/lib/geordi/cucumber.rb

@@ -3,17 +3,16 @@ require 'tempfile'
 
 # This require-style is to prevent Ruby from loading files of a different
 # version of Geordi.
-require File.expand_path('../interaction', __FILE__)
-require File.expand_path('../firefox_for_selenium', __FILE__)
+require File.expand_path('interaction', __dir__)
+require File.expand_path('firefox_for_selenium', __dir__)
 
 module Geordi
   class Cucumber
-    include Geordi::Interaction
 
-    VNC_DISPLAY = ':17'
-    VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} -localhost -nolisten tcp -SecurityTypes None -geometry 1280x1024"
-    VNC_VIEWER_COMMAND = "vncviewer #{VNC_DISPLAY}"
-    VNC_ENV_VARIABLES = %w[DISPLAY BROWSER LAUNCHY_BROWSER]
+    VNC_DISPLAY = ':17'.freeze
+    VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} -localhost -nolisten tcp -SecurityTypes None -geometry 1280x1024".freeze
+    VNC_VIEWER_COMMAND = "vncviewer #{VNC_DISPLAY}".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
@@ -23,27 +22,27 @@ module Geordi
       setup_vnc
 
       command = use_parallel_tests?(options) ? parallel_execution_command : serial_execution_command
-      note_cmd(command) if options[:verbose]
+      Interaction.note_cmd(command) if options[:verbose]
 
       puts # Make newline
       system command # Util.system! would reset the Firefox PATH
     end
 
     def launch_vnc_viewer
-      fork {
+      fork do
         error = capture_stderr do
           system(VNC_VIEWER_COMMAND)
         end
         unless $?.success?
           if $?.exitstatus == 127
-            fail 'VNC viewer not found. Install it with `geordi vnc --setup`.'
+            Interaction.fail 'VNC viewer not found. Install it with `geordi vnc --setup`.'
           else
-            note 'VNC viewer could not be opened:'
+            Interaction.note 'VNC viewer could not be opened:'
             puts error
             puts
           end
         end
-      }
+      end
     end
 
     def restore_env
@@ -57,10 +56,10 @@ module Geordi
         VNC_ENV_VARIABLES.each do |variable|
           ENV["OUTER_#{variable}"] = ENV[variable] if ENV[variable]
         end
-        ENV["BROWSER"] = ENV["LAUNCHY_BROWSER"] = File.expand_path('../../../bin/launchy_browser', __FILE__)
-        ENV["DISPLAY"] = VNC_DISPLAY
+        ENV['BROWSER'] = ENV['LAUNCHY_BROWSER'] = File.expand_path('../../bin/launchy_browser', __dir__)
+        ENV['DISPLAY'] = VNC_DISPLAY
 
-        note 'Run `geordi vnc` to view the Selenium test browsers'
+        Interaction.note 'Run `geordi vnc` to view the Selenium test browsers'
       end
     end
 
@@ -73,11 +72,11 @@ module Geordi
       unless argv.include?('--format') || argv.include?('-f')
         format_args = spinner_available? ? ['--format', 'CucumberSpinner::CuriousProgressBarFormatter'] : ['--format', 'progress']
       end
-      [use_firefox_for_selenium, "b", "cucumber", format_args, escape_shell_args(argv)].flatten.compact.join(" ")
+      [use_firefox_for_selenium, 'b', 'cucumber', format_args, escape_shell_args(argv)].flatten.compact.join(' ')
     end
 
     def parallel_execution_command
-      note 'Using parallel_tests'
+      Interaction.note 'Using parallel_tests'
       self.argv = argv - command_line_features
 
       type_arg = Util.gem_version('parallel_tests') > Gem::Version.new('0.7.0') ? 'cucumber' : 'features'
@@ -87,8 +86,8 @@ module Geordi
       [
         use_firefox_for_selenium,
         'b parallel_test -t ' + type_arg,
-        %(-o '#{ command_line_options.join(' ') } --tags "#{not_tag('@solo')}"'),
-        "-- #{ features.join(' ') }"
+        %(-o '#{command_line_options.join(' ')} --tags "#{not_tag('@solo')}"'),
+        "-- #{features.join(' ')}",
       ].compact.join(' ')
     end
 
@@ -109,21 +108,21 @@ module Geordi
 
     def escape_shell_args(*args)
       args.flatten.collect do |arg|
-        arg.gsub(/([\\ "])/) { |match| "\\#{$1}" }
+        arg.gsub(/([\\ "])/) { |_match| "\\#{Regexp.last_match(1)}" }
       end
     end
 
     def show_features_to_run
       if command_line_options.include? '@solo'
-        note 'All features tagged with @solo'
+        Interaction.note 'All features tagged with @solo'
       elsif command_line_options.include? 'rerun'
-        note 'Rerunning failed scenarios'
+        Interaction.note 'Rerunning failed scenarios'
       elsif features_to_run.empty?
-        note 'All features in features/'
+        Interaction.note 'All features in features/'
       else
         notification = 'Only: ' + features_to_run.join(', ')
         notification << ' (from rerun.txt)' if (features_to_run == rerun_txt_features) && (features_to_run != command_line_features)
-        note notification
+        Interaction.note notification
       end
     end
 
@@ -137,8 +136,8 @@ module Geordi
 
     def rerun_txt_features
       @rerun_txt_features ||= begin
-        if File.exists?("rerun.txt")
-          IO.read("rerun.txt").to_s.strip.split(/\s+/)
+        if File.exist?('rerun.txt')
+          IO.read('rerun.txt').to_s.strip.split(/\s+/)
         else
           []
         end
@@ -150,7 +149,7 @@ module Geordi
     end
 
     def command_line_options
-      @command_line_options ||= Array.new.tap do |args|
+      @command_line_options ||= [].tap do |args|
         # Sorry for this mess. Option parsing doesn't get much prettier.
         argv.each_cons(2) do |a, b|
           break if a == '--' # This is the common no-options-beyond marker
@@ -171,9 +170,9 @@ module Geordi
     end
 
     def consolidate_rerun_txt_files
-      parallel_rerun_files = Dir.glob("parallel_rerun*.txt")
+      parallel_rerun_files = Dir.glob('parallel_rerun*.txt')
       unless parallel_rerun_files.empty?
-        note 'Consolidating parallel_rerun.txt files ...'
+        Interaction.note 'Consolidating parallel_rerun.txt files ...'
 
         rerun_content = []
         parallel_rerun_files.each do |filename|
@@ -181,8 +180,8 @@ module Geordi
           File.unlink(filename)
         end
 
-        File.open("rerun.txt", "w") do |f|
-          f.puts(rerun_content.join(" "))
+        File.open('rerun.txt', 'w') do |f|
+          f.puts(rerun_content.join(' '))
         end
       end
     end
@@ -190,14 +189,14 @@ module Geordi
     def find_all_features_recursively(files_or_dirs)
       Array(files_or_dirs).map do |file_or_dir|
         if File.directory?(file_or_dir)
-          file_or_dir = Dir.glob(File.join(file_or_dir, "**", "*.feature"))
+          file_or_dir = Dir.glob(File.join(file_or_dir, '**', '*.feature'))
         end
         file_or_dir
       end.flatten.uniq.compact
     end
 
     def spinner_available?
-      @spinner_available ||= File.exists?('Gemfile') && File.open('Gemfile').read.scan(/cucumber_spinner/).any?
+      @spinner_available ||= File.exist?('Gemfile') && File.open('Gemfile').read.scan(/cucumber_spinner/).any?
     end
 
     def use_parallel_tests?(options)
@@ -209,7 +208,7 @@ module Geordi
 
     def try_and_start_vnc
       # check if vnc is already running
-      #return true if vnc_server_running?
+      # return true if vnc_server_running?
       error = capture_stderr do
         system(VNC_SERVER_COMMAND)
       end
@@ -218,10 +217,10 @@ module Geordi
         98 # was already running after all
         true
       when 127 # not installed
-        warn 'Could not launch VNC server. Install it with `geordi vnc --setup`.'
+        Interaction.warn 'Could not launch VNC server. Install it with `geordi vnc --setup`.'
         false
       else
-        warn 'Starting VNC failed:'
+        Interaction.warn 'Starting VNC failed:'
         puts error
         puts
         false