geordi 3.0.0 → 3.2.0

data/lib/geordi/commands/create_database_yml.rb

@@ -4,7 +4,7 @@ def create_database_yml
   sample_yml = 'config/database.sample.yml'
 
   if File.exist?(sample_yml) && !File.exist?(real_yml)
-    announce 'Creating ' + real_yml
+    Interaction.announce 'Creating ' + real_yml
 
     sample = File.read(sample_yml)
     adapter = sample.match(/adapter: (\w+)\n/).captures.first
@@ -15,6 +15,6 @@ def create_database_yml
     real = sample.gsub(/password:.*$/, "password: #{db_password}")
     File.open(real_yml, 'w') { |f| f.write(real) }
 
-    note "Created #{real_yml}."
+    Interaction.note "Created #{real_yml}."
   end
 end

data/lib/geordi/commands/create_databases.rb

@@ -3,7 +3,7 @@ def create_databases
   invoke_cmd 'create_database_yml'
   invoke_cmd 'bundle_install'
 
-  announce 'Creating databases'
+  Interaction.announce 'Creating databases'
 
   if File.exist?('config/database.yml')
     command = 'bundle exec rake db:create:all'

data/lib/geordi/commands/cucumber.rb

@@ -15,6 +15,13 @@ 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
+
 LONGDESC
 
 option :modified, aliases: '-m', type: :boolean,
@@ -34,7 +41,7 @@ def cucumber(*args)
     if options.modified?
       modified_features = `git status --short`.split($INPUT_RECORD_SEPARATOR).map do |line|
         indicators = line.slice!(0..2) # Remove leading indicators
-        line if line.include?('.feature') && indicators.exclude?('D')
+        line if line.include?('.feature') && !indicators.include?('D')
       end.compact
       args = modified_features
     end
@@ -56,7 +63,7 @@ def cucumber(*args)
 
     # Serial run of @solo scenarios ############################################
     if files.any? { |f| f.include? ':' }
-      note '@solo run skipped when called with line numbers' if options.verbose
+      Interaction.note '@solo run skipped when called with line numbers' if options.verbose
     else
       solo_files = if files.empty?
         'features' # Proper grepping
@@ -70,14 +77,14 @@ def cucumber(*args)
         solo_cmd_opts = cmd_opts.dup
         solo_cmd_opts << '--tags' << '@solo'
 
-        announce 'Running @solo features'
+        Interaction.announce 'Running @solo features'
         solo_success = Geordi::Cucumber.new.run files, solo_cmd_opts, verbose: options.verbose, parallel: false
-        solo_success || raise('Features failed.')
+        solo_success || Interaction.fail('Features failed.')
       end
     end
 
     # Parallel run of all given features + reruns ##############################
-    announce 'Running features'
+    Interaction.announce 'Running features'
     normal_run_successful = Geordi::Cucumber.new.run(files, cmd_opts, verbose: options.verbose)
 
     unless normal_run_successful
@@ -85,16 +92,16 @@ def cucumber(*args)
 
       # Reruns
       (options.rerun + 1).times do |i|
-        raise 'Features failed.' if i == options.rerun # All reruns done?
+        Interaction.fail 'Features failed.' if i == options.rerun # All reruns done?
 
-        announce "Rerun ##{i + 1} of #{options.rerun}"
+        Interaction.announce "Rerun ##{i + 1} of #{options.rerun}"
         break if Geordi::Cucumber.new.run([], cmd_opts, verbose: options.verbose, parallel: false)
       end
     end
 
-    success 'Features green.'
+    Interaction.success 'Features green.'
 
   else
-    note 'Cucumber not employed.'
+    Interaction.note 'Cucumber not employed.'
   end
 end

data/lib/geordi/commands/delete_dumps.rb

@@ -20,24 +20,24 @@ def delete_dumps(dump_directory = nil)
   else
     [dump_directory]
   end
-  announce 'Looking for *.dump in ' << dump_directories.join(',')
+  Interaction.announce 'Looking for *.dump in ' << dump_directories.join(',')
   dump_directories.each do |d|
     d_2 = File.expand_path(d)
     unless File.directory? File.realdirpath(d_2)
-      warn "Directory #{d_2} does not exist"
+      Interaction.warn "Directory #{d_2} does not exist"
       next
     end
     deletable_dumps.concat(Dir.glob("#{d_2}/**/*.dump"))
   end
   if deletable_dumps.empty?
-    success 'No dumps to delete' if deletable_dumps.empty?
+    Interaction.success 'No dumps to delete' if deletable_dumps.empty?
     exit 0
   end
   deletable_dumps.uniq!.sort!
-  note 'The following dumps can be deleted:'
+  Interaction.note 'The following dumps can be deleted:'
   puts
   puts deletable_dumps
-  prompt('Delete those dumps', 'n', /y|yes/) || raise('Cancelled.')
+  Interaction.prompt('Delete those dumps', 'n', /y|yes/) || raise('Cancelled.')
   deletable_dumps.each do |dump|
     File.delete dump unless File.directory? dump
   end

data/lib/geordi/commands/deploy.rb

@@ -38,17 +38,17 @@ option :current_branch, aliases: '-c', type: :boolean,
 def deploy(target_stage = nil)
   # Set/Infer default values
   branch_stage_map = { 'master' => 'staging', 'production' => 'production' }
-  if target_stage && (Util.deploy_targets.exclude? target_stage)
+  if target_stage && !Util.deploy_targets.include?(target_stage)
     # Target stage autocompletion from available stages
     target_stage = Util.deploy_targets.find { |t| t.start_with? target_stage }
-    target_stage || warn('Given deployment stage not found')
+    target_stage || Interaction.warn('Given deployment stage not found')
   end
 
   # Ask for required information
-  target_stage ||= prompt 'Deployment stage:', branch_stage_map.fetch(Util.current_branch, 'staging')
+  target_stage ||= Interaction.prompt 'Deployment stage:', branch_stage_map.fetch(Util.current_branch, 'staging')
   if options.current_branch
     stage_file = "config/deploy/#{target_stage}.rb"
-    Util.file_containing?(stage_file, 'DEPLOY_BRANCH') || raise(<<-ERROR)
+    Util.file_containing?(stage_file, 'DEPLOY_BRANCH') || Interaction.fail(<<-ERROR)
 To deploy from the current branch, configure #{stage_file} to respect the
 environment variable DEPLOY_BRANCH. Example:
 
@@ -57,38 +57,38 @@ set :branch, ENV['DEPLOY_BRANCH'] || 'master'
 
     source_branch = target_branch = Util.current_branch
   else
-    source_branch = prompt 'Source branch:', Util.current_branch
-    target_branch = prompt 'Deploy branch:', branch_stage_map.invert.fetch(target_stage, 'master')
+    source_branch = Interaction.prompt 'Source branch:', Util.current_branch
+    target_branch = Interaction.prompt 'Deploy branch:', branch_stage_map.invert.fetch(target_stage, 'master')
   end
 
   merge_needed = (source_branch != target_branch)
   push_needed = merge_needed || `git cherry -v | wc -l`.strip.to_i > 0
   push_needed = false if Util.testing? # Hard to test
 
-  announce "Checking whether your #{source_branch} branch is ready" ############
+  Interaction.announce "Checking whether your #{source_branch} branch is ready" ############
   Util.system! "git checkout #{source_branch}"
   if (`git status -s | wc -l`.strip != '0') && !Util.testing?
-    warn "Your #{source_branch} branch holds uncommitted changes."
-    prompt('Continue anyway?', 'n', /y|yes/) || raise('Cancelled.')
+    Interaction.warn "Your #{source_branch} branch holds uncommitted changes."
+    Interaction.prompt('Continue anyway?', 'n', /y|yes/) || raise('Cancelled.')
   else
-    note 'All good.'
+    Interaction.note 'All good.'
   end
 
   if merge_needed
-    announce "Checking what's in your #{target_branch} branch right now" #######
+    Interaction.announce "Checking what's in your #{target_branch} branch right now" #######
     Util.system! "git checkout #{target_branch} && git pull"
   end
 
-  announce 'You are about to:' #################################################
-  note "Merge branch #{source_branch} into #{target_branch}" if merge_needed
+  Interaction.announce 'You are about to:' #################################################
+  Interaction.note "Merge branch #{source_branch} into #{target_branch}" if merge_needed
   if push_needed
-    note 'Push these commits:' if push_needed
+    Interaction.note 'Push these commits:' if push_needed
     Util.system! "git --no-pager log origin/#{target_branch}..#{source_branch} --oneline"
   end
-  note "Deploy to #{target_stage}"
-  note "From current branch #{source_branch}" if options.current_branch
+  Interaction.note "Deploy to #{target_stage}"
+  Interaction.note "From current branch #{source_branch}" if options.current_branch
 
-  if prompt('Go ahead with the deployment?', 'n', /y|yes/)
+  if Interaction.prompt('Go ahead with the deployment?', 'n', /y|yes/)
     puts
     git_call = []
     git_call << "git merge #{source_branch}" if merge_needed
@@ -107,9 +107,9 @@ set :branch, ENV['DEPLOY_BRANCH'] || 'master'
 
     Util.system! capistrano_call, show_cmd: true
 
-    success 'Deployment complete.'
+    Interaction.success 'Deployment complete.'
   else
     Util.system! "git checkout #{source_branch}"
-    raise 'Deployment cancelled.'
+    Interaction.fail 'Deployment cancelled.'
   end
 end

data/lib/geordi/commands/drop_databases.rb

@@ -28,7 +28,7 @@ option :mysql, banner: 'PORT_OR_SOCKET',
 
 def drop_databases
   require 'geordi/db_cleaner'
-  raise '-P and -M are mutually exclusive' if options.postgres_only && options.mysql_only
+  Interaction.fail '-P and -M are mutually exclusive' if options.postgres_only && options.mysql_only
   mysql_flags = nil
   postgres_flags = nil
 
@@ -38,7 +38,7 @@ def drop_databases
       mysql_flags = "--port=#{mysql_port} --protocol=TCP"
     rescue AttributeError
       unless File.exist? options.mysql
-        raise "Path #{options.mysql} is not a valid MySQL socket"
+        Interaction.fail "Path #{options.mysql} is not a valid MySQL socket"
       end
       mysql_flags = "--socket=#{options.mysql}"
     end
@@ -54,5 +54,5 @@ def drop_databases
   cleaner.clean_mysql unless options.postgres_only
   cleaner.clean_postgres unless options.mysql_only
 
-  success 'Done.'
+  Interaction.success 'Done.'
 end

data/lib/geordi/commands/dump.rb

@@ -21,7 +21,6 @@ dump into the development database after downloading it.
 DESC
 
 option :load, aliases: ['-l'], type: :string, desc: 'Load a dump'
-option :select_server, default: false, type: :boolean, aliases: '-s'
 
 def dump(target = nil, *_args)
   require 'geordi/dump_loader'
@@ -30,33 +29,33 @@ def dump(target = nil, *_args)
   if target.nil?
     if options.load
       # validate load option
-      raise 'Missing a dump file.' if options.load == 'load'
+      Interaction.fail 'Missing a dump file.' if options.load == 'load'
       File.exist?(options.load) || raise('Could not find the given dump file: ' + options.load)
 
       loader = DumpLoader.new(options.load)
 
-      announce "Sourcing dump into the #{loader.config['database']} db"
+      Interaction.announce "Sourcing dump into the #{loader.config['database']} db"
       loader.load
 
-      success "Your #{loader.config['database']} database has now the data of #{options.load}."
+      Interaction.success "Your #{loader.config['database']} database has now the data of #{options.load}."
 
     else
-      announce 'Dumping the development database'
+      Interaction.announce 'Dumping the development database'
       Util.system! 'dumple development'
-      success 'Successfully dumped the development database.'
+      Interaction.success 'Successfully dumped the development database.'
     end
 
   else
-    announce 'Dumping the database of ' + target
+    Interaction.announce 'Dumping the database of ' + target
     dump_path = Geordi::Remote.new(target).dump(options)
 
     if options.load
       loader = DumpLoader.new(dump_path)
 
-      announce "Sourcing dump into the #{loader.config['database']} db"
+      Interaction.announce "Sourcing dump into the #{loader.config['database']} db"
       loader.load
 
-      success "Your #{loader.config['database']} database has now the data of #{target}."
+      Interaction.success "Your #{loader.config['database']} database has now the data of #{target}."
     end
   end
 end

data/lib/geordi/commands/firefox.rb

@@ -15,7 +15,7 @@ option :setup, banner: 'FIREFOX_VERSION',
 
 def firefox(*command)
   if options.setup
-    raise 'Firefox version required (e.g. --setup 24.0)' if options.setup == 'setup'
+    Interaction.fail 'Firefox version required (e.g. --setup 24.0)' if options.setup == 'setup'
 
     require 'geordi/firefox_for_selenium'
     Geordi::FirefoxForSelenium.install(options.setup)
@@ -27,7 +27,7 @@ def firefox(*command)
     FirefoxForSelenium.setup_firefox
 
     puts
-    note_cmd command.join(' ')
+    Interaction.note_cmd command.join(' ')
     system *command # Util.system! would reset the Firefox PATH
   end
 end

data/lib/geordi/commands/migrate.rb

@@ -10,11 +10,11 @@ LONGDESC
 def migrate
   invoke_cmd 'bundle_install'
   invoke_cmd 'yarn_install'
-  announce 'Migrating'
+  Interaction.announce 'Migrating'
 
   if File.directory?('db/migrate')
     if Util.file_containing?('Gemfile', /parallel_tests/)
-      note 'Development and parallel test databases'
+      Interaction.note 'Development and parallel test databases'
       puts
 
       Util.system! 'bundle exec rake db:migrate parallel:prepare'
@@ -22,6 +22,6 @@ def migrate
       invoke_cmd 'rake', 'db:migrate'
     end
   else
-    note 'No migrations directory found.'
+    Interaction.note 'No migrations directory found.'
   end
 end

data/lib/geordi/commands/png_optimize.rb

@@ -10,10 +10,10 @@ LONGDESC
 def png_optimize(path)
   require 'fileutils'
 
-  announce 'Optimizing .png files'
+  Interaction.announce 'Optimizing .png files'
 
   if `which pngcrush`.strip.empty?
-    raise 'Please install pngcrush first (sudo apt-get install pngcrush)'
+    Interaction.fail 'Please install pngcrush first (sudo apt-get install pngcrush)'
   end
 
   po = PngOptimizer.new
@@ -22,10 +22,10 @@ def png_optimize(path)
   elsif File.file?(path)
     po.optimize_inplace(path)
   else
-    raise 'Neither directory nor file: ' + path
+    Interaction.fail 'Neither directory nor file: ' + path
   end
 
-  success 'PNG optimization completed.'
+  Interaction.success 'PNG optimization completed.'
 end
 
 class PngOptimizer
@@ -64,7 +64,7 @@ class PngOptimizer
       FileUtils.rm(input_file)
       FileUtils.mv(temp_file.to_s, input_file.to_s)
     else
-      raise 'Error:' + $CHILD_STATUS
+      Interaction.fail 'Error:' + $?
     end
   end
 

data/lib/geordi/commands/rake.rb

@@ -13,7 +13,7 @@ def rake(*args)
   %w[development test cucumber].each do |env| # update long_desc when changing this
     if File.exist? "config/environments/#{env}.rb"
       call = %w[bundle exec rake] + args + ["RAILS_ENV=#{env}"]
-      note_cmd call.join(' ')
+      Interaction.note_cmd call.join(' ')
 
       Util.system! *call
     end

data/lib/geordi/commands/remove_executable_flags.rb

@@ -1,13 +1,13 @@
 desc 'remove-executable-flags', 'Remove executable-flags from files that should not be executable'
 def remove_executable_flags
-  announce 'Removing executable-flags'
+  Interaction.announce 'Removing executable-flags'
 
   patterns = %w[
     *.rb *.html *.erb *.haml *.yml *.css *.sass *.rake *.png *.jpg
     *.gif *.pdf *.txt *.rdoc *.feature Rakefile VERSION README Capfile
   ]
   patterns.each do |pattern|
-    note pattern
+    Interaction.note pattern
     `find . -name "#{pattern}" -exec chmod -x {} ';'`
   end
   puts 'Done.'

data/lib/geordi/commands/rspec.rb

@@ -11,19 +11,19 @@ def rspec(*files)
     invoke_cmd 'bundle_install'
     invoke_cmd 'yarn_install'
 
-    announce 'Running specs'
+    Interaction.announce 'Running specs'
 
     if Util.file_containing?('Gemfile', /parallel_tests/) && files.empty?
-      note 'All specs at once (using parallel_tests)'
+      Interaction.note 'All specs at once (using parallel_tests)'
       Util.system! 'bundle exec rake parallel:spec', fail_message: 'Specs failed.'
 
     else
       # tell which specs will be run
       if files.empty?
         files << 'spec/'
-        note 'All specs in spec/'
+        Interaction.note 'All specs in spec/'
       else
-        note 'Only: ' + files.join(', ')
+        Interaction.note 'Only: ' + files.join(', ')
       end
 
       command = ['bundle exec']
@@ -41,6 +41,6 @@ def rspec(*files)
       Util.system! command.join(' '), fail_message: 'Specs failed.'
     end
   else
-    note 'RSpec not employed.'
+    Interaction.note 'RSpec not employed.'
   end
 end

data/lib/geordi/commands/security_update.rb

@@ -2,39 +2,63 @@ 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')
   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/) || raise('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
 
-    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? || raise('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/) || raise('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/) || raise('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
@@ -42,13 +66,46 @@ def security_update(step = 'prepare')
     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