geordi 0.18.0 → 1.0.0

data/lib/geordi/commands/rake.rb

@@ -0,0 +1,21 @@
+desc 'rake TASK', 'Run a rake task in several Rails environments'
+long_desc <<-LONGDESC
+Example: `geordi rake db:migrate`
+
+TASK is run in the following Rails environments (if present):
+
+- development
+- test
+- cucumber
+LONGDESC
+
+def rake(*args)
+  for env in %w(development test cucumber) # update long_desc when changing this
+    if File.exists? "config/environments/#{env}.rb"
+      call = %w[bundle exec rake] + args + ["RAILS_ENV=#{env}"]
+      note_cmd call.join(' ')
+
+      Util.system! *call
+    end
+  end
+end

data/lib/geordi/commands/remove_executable_flags.rb

@@ -0,0 +1,14 @@
+desc 'remove-executable-flags', 'Remove executable-flags from files that should not be executable'
+def remove_executable_flags
+  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
+  ]
+  for pattern in patterns
+    note pattern
+    `find . -name "#{pattern}" -exec chmod -x {} ';'`
+  end
+  puts 'Done.'
+end

data/lib/geordi/commands/rspec.rb

@@ -0,0 +1,40 @@
+desc 'rspec [FILES]', 'Run RSpec'
+long_desc <<-LONGDESC
+Example: `geordi rspec spec/models/user_spec.rb:13`
+
+Runs RSpec as you want: with RSpec 1/2 detection, `bundle exec`, rspec_spinner
+detection, etc.
+LONGDESC
+
+def rspec(*files)
+  if File.exists?('spec/spec_helper.rb')
+    invoke_cmd 'bundle_install'
+
+    announce 'Running specs'
+
+    if file_containing?('Gemfile', /parallel_tests/) and files.empty?
+      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/'
+      else
+        note 'Only: ' + files.join(', ')
+      end
+
+      command = ['bundle exec']
+      # differentiate RSpec 1/2
+      command << (File.exists?('script/spec') ? 'spec -c' : 'rspec')
+      command << '-r rspec_spinner -f RspecSpinner::Bar' if file_containing?('Gemfile', /rspec_spinner/)
+      command << files.join(' ')
+
+      puts
+      Util.system! command.join(' '), :fail_message => 'Specs failed.'
+    end
+  else
+    note 'RSpec not employed.'
+  end
+end

data/lib/geordi/commands/security_update.rb

@@ -0,0 +1,56 @@
+desc 'security-update [step]', 'Support for performing security updates'
+long_desc <<-LONGDESC
+Preparation for security update: `geordi security-update`
+
+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.
+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: pull master and production branches, checkout production'
+    wait 'Continue?'
+
+    Util.system! 'git checkout master', :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'
+    puts
+    note 'Please apply the security update now.'
+    note 'When you are done, run `geordi security-update finish`.'
+
+
+  when 'finish'
+    announce 'Finishing security update'
+
+    # ensure everything is committed
+    `git status --porcelain`.empty? or fail('There are uncommitted changes.')
+    note 'Working directory clean.'
+
+    print 'Have you successfully run all tests? [yN] '
+    exit unless $stdin.gets =~ /[yes]+/
+
+    note 'About to: push production, checkout & pull master, merge production, push master, deploy all stages'
+    wait 'Continue?'
+
+    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
+
+    invoke_cmd 'all_targets', 'deploy:migrations'
+
+    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.'
+  end
+end

data/lib/geordi/commands/setup.rb

@@ -0,0 +1,33 @@
+desc 'setup', 'Setup a project for the first time'
+long_desc <<-LONGDESC
+Example: `geordi setup`
+
+Check out a repository, cd into its directory. Now let `setup` do the tiring
+work: run `bundle install`, create `database.yml`, create databases, migrate
+(all if applicable).
+
+After setting up, loads a dump into the development db when called with the
+`--dump` option:
+
+    geordi setup -d staging
+
+After setting up, runs all tests when called with the `--test` option:
+
+    geordi setup -t
+
+See `geordi help setup` for details.
+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'
+
+def setup
+  invoke_cmd 'create_databases'
+  invoke_cmd 'migrate'
+
+  success 'Successfully set up the project.'
+
+  invoke_cmd 'dump', options.dump, :load => true if options.dump
+  invoke_cmd 'tests' if options.test
+end

data/lib/geordi/commands/setup_firefox_for_selenium.rb

@@ -0,0 +1,6 @@
+desc 'setup-firefox-for-selenium VERSION', 'Install a special firefox for running Selenium tests'
+def setup_firefox_for_selenium(version)
+  require 'geordi/firefox_for_selenium'
+
+  Geordi::FirefoxForSelenium.install(version)
+end

data/lib/geordi/commands/setup_vnc.rb

@@ -0,0 +1,84 @@
+class ::String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red() colorize(31) end
+  def pink() colorize(35) end
+  def green() colorize(32) end
+end
+
+desc 'setup-vnc', 'Setup VNC for running Selenium tests there'
+def setup_vnc
+  `clear`
+
+  instruct <<-TEXT
+    This script will help you install a VNC server and a VNC viewer.
+
+    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 #{"geordi
+    vnc_show".pink}.
+
+    Please open a second shell to execute instructions.
+  TEXT
+
+  announce 'Setup VNC server'
+
+  if installed?('vncserver')
+    success 'It appears you already have a VNC server installed. Good job!'
+  else
+    instruct <<-TEXT
+      Please run #{'sudo apt-get install vnc4server'.pink}.
+    TEXT
+
+    instruct <<-TEXT
+      We will now set a password for your VNC server.
+
+      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
+      your machine.
+
+      Please run #{'vncserver :20'.pink} and #{'enter a secure password'.red}.
+    TEXT
+
+    instruct <<-TEXT
+      Now stop the server again.
+      Please run #{'vncserver -kill :20'.pink}.
+    TEXT
+  end
+
+  announce 'Setup VNC viewer'
+
+  if installed?('vncviewer')
+    success 'It appears you already have a VNC viewer installed. Good job!'
+  else
+    instruct <<-TEXT
+      Please run #{'sudo apt-get install xtightvncviewer'.pink}.
+    TEXT
+  end
+
+  instruct <<-TEXT, false
+    All done. Our cucumber script will now automatically run Selenium features
+    in VNC.
+    #{"Happy cuking!".green}
+  TEXT
+
+end
+
+private
+
+def instruct(text, wait = true)
+  text =~ /^( *)./
+  level = $1 ? $1.size : 0
+  text.gsub!(/^ {#{level}}/, '')
+  puts text
+
+  wait('[ENTER]') if wait
+end
+
+def installed?(app)
+  `which #{app}`
+  $?.success?
+end

data/lib/geordi/commands/shell.rb

@@ -0,0 +1,20 @@
+# This method has a triple 'l' because :shell is a Thor reserved word. However,
+# it can still be called with `geordi shell` :)
+
+desc 'shell TARGET', 'Open a shell on a Capistrano deploy target'
+long_desc <<-LONGDESC
+Example: `geordi shell production`
+
+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'
+
+def shelll(target, *args)
+  require 'geordi/remote'
+
+  announce 'Opening a shell on ' + target
+  Geordi::Remote.new(target).shell(options)
+end

data/lib/geordi/commands/test.rb

@@ -0,0 +1,9 @@
+desc 'tests', 'Run all employed tests'
+def tests
+  invoke_cmd 'with_rake'
+  invoke_cmd 'unit'
+  invoke_cmd 'rspec'
+  invoke_cmd 'cucumber'
+
+  success 'Successfully ran tests.'
+end

data/lib/geordi/commands/unit.rb

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

data/lib/geordi/commands/update.rb

@@ -0,0 +1,33 @@
+desc 'update', 'Bring a project up to date'
+long_desc <<-LONGDESC
+Example: `geordi update`
+
+Performs: `git pull`, `bundle install` (if necessary) and migrates (if applicable).
+
+After updating, loads a dump into the development db when called with the
+`--dump` option:
+
+    geordi update -d staging
+
+After updating, runs all tests when called with the `--test` option:
+
+    geordi update -t
+
+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'
+
+def update
+  announce 'Updating repository'
+  Util.system! 'git pull', :show_cmd => true
+
+  invoke_cmd 'migrate'
+
+  success 'Successfully updated the project.'
+
+  invoke_cmd 'dump', options.dump, :load => true if options.dump
+  invoke_cmd 'tests' if options.test
+end

data/lib/geordi/commands/version.rb

@@ -0,0 +1,7 @@
+desc 'version', 'Print the current version of geordi'
+def version
+  require 'geordi/version'
+  puts 'Geordi ' + Geordi::VERSION
+end
+map '-v' => :version
+map '--version' => :version

data/lib/geordi/commands/vnc_show.rb

@@ -0,0 +1,6 @@
+desc 'vnc-show', 'Show the hidden VNC window'
+def vnc_show
+  require 'geordi/cucumber'
+
+  Geordi::Cucumber.new.launch_vnc_viewer
+end

data/lib/geordi/commands/with_firefox_for_selenium.rb

@@ -0,0 +1,18 @@
+desc 'with-firefox-for-selenium COMMAND', 'Run a command with firefox for selenium set up'
+long_desc <<-LONGDESC
+Example: `geordi with-firefox-for-selenium b cucumber`
+
+Useful when you need Firefox for Selenium, but can't use the `geordi cucumber`
+command.
+LONGDESC
+
+def with_firefox_for_selenium(*command)
+  note 'Setting up Firefox for Selenium ...'
+  require 'geordi/cucumber'
+  Cucumber.new.setup_vnc
+  FirefoxForSelenium.setup_firefox
+  puts
+
+  note_cmd command.join
+  Util.system! *command
+end

data/lib/geordi/commands/with_rake.rb

@@ -0,0 +1,11 @@
+desc 'with-rake', 'Run tests with `rake`'
+def with_rake
+  if file_containing?('Rakefile', /^task.+default.+(spec|test)/)
+    invoke_cmd 'bundle_install'
+
+    announce 'Running tests with `rake`'
+    Util.system! 'rake'
+  else
+    note '`rake` does not run tests.'
+  end
+end

data/lib/geordi/{cuc.rb → cucumber.rb}

@@ -1,34 +1,32 @@
-require "rubygems"
-require File.join(File.dirname(__FILE__), 'firefox_for_selenium')
+require 'rubygems'
 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__)
+
 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]
 
-    def run
-      4.times { puts }
-      puts "Running Cucumber tests..."
-      puts "========================="
+    def run(argv)
+      self.argv = argv
 
       consolidate_rerun_txt_files
       show_features_to_run
-
       setup_vnc
 
       command = use_parallel_tests? ? parallel_execution_command : serial_execution_command
+      note 'Command: ' + command if argv.include? '-v'
 
-      if argv.include? "-v"
-        puts command
-        2.times { puts }
-      end
-
-      2.times { puts }
-      exec command
+      puts
+      system command
     end
 
     def launch_vnc_viewer
@@ -38,10 +36,11 @@ module Geordi
         end
         unless $?.success?
           if $?.exitstatus == 127
-            puts "VNC viewer not found. Install it using cuc-vnc-setup."
+            fail 'VNC viewer not found. Install it with `geordi setup-vnc`.'
           else
-            puts "VNC viewer could not be opened:"
+            note 'VNC viewer could not be opened:'
             puts error
+            puts
           end
         end
       }
@@ -58,21 +57,16 @@ 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(File.join(File.dirname(__FILE__), '../../bin/launchy_browser'))
+        ENV["BROWSER"] = ENV["LAUNCHY_BROWSER"] = File.expand_path('../../../bin/launchy_browser', __FILE__)
         ENV["DISPLAY"] = VNC_DISPLAY
 
-        puts
-        puts "Selenium is running in a VNC window. Use cuc-show to view it."
+        note 'Selenium is running in a VNC window. Use `geordi vnc-show` to view it.'
       end
     end
 
-
     private
 
-    attr_writer :argv
-    def argv
-      @argv ||= ARGV
-    end
+    attr_accessor :argv
 
     def serial_execution_command
       format_args = []
@@ -83,7 +77,7 @@ module Geordi
     end
 
     def parallel_execution_command
-      puts "Using parallel_tests ...\n\n"
+      note 'Using parallel_tests'
       self.argv = argv - command_line_features
       gem 'parallel_tests', parallel_tests_version
       require 'parallel_tests'
@@ -112,13 +106,12 @@ module Geordi
     end
 
     def show_features_to_run
-      unless features_to_run.empty?
-        passed_by = (features_to_run == rerun_txt_features && features_to_run != command_line_features) ? 'rerun.txt' : 'command line'
-        2.times { puts }
-        puts "features to run (passed by #{passed_by}):"
-        puts "-----------------------------------------"
-        puts features_to_run.join("\n")
-        puts "-----------------------------------------"
+      if features_to_run.empty?
+        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
       end
     end
 
@@ -170,8 +163,7 @@ module Geordi
     def consolidate_rerun_txt_files
       parallel_rerun_files = Dir.glob("parallel_rerun*.txt")
       unless parallel_rerun_files.empty?
-        2.times { puts }
-        puts "consolidating parallel_rerun.txt files ..."
+        note 'Consolidating parallel_rerun.txt files ...'
 
         rerun_content = []
         parallel_rerun_files.each do |filename|
@@ -235,15 +227,12 @@ module Geordi
         98 # was already running after all
         true
       when 127 # not installed
-        puts "Could not launch VNC server. Install it by running cuc-vnc-setup."
-        puts
-        puts
+        warn 'Could not launch VNC server. Install it with `geordi setup-vnc`.'
         false
       else
-        puts "Starting VNC failed:"
+        warn 'Starting VNC failed:'
         puts error
         puts
-        puts
         false
       end
     end

data/lib/geordi/dump_loader.rb

@@ -1,86 +1,60 @@
 require 'rubygems'
 require 'highline'
+require 'geordi/interaction'
+require 'geordi/util'
 
+module Geordi
+  class DumpLoader
+    include Geordi::Interaction
 
-class DumpLoader
-
-  def initialize(argv)
-    @argv = argv
-    @verbose = !!@argv.delete('-v')
-  end
-
-  def dumps_dir
-    require 'etc'
-    user_dir = Etc.getpwuid.dir
-    File.join(user_dir, 'dumps')
-  end
+    def initialize(file)
+      @dump_file = file
+    end
 
-  def development_database_config
-    require 'yaml'
+    def development_database_config
+      require 'yaml'
 
-    @config ||= YAML::load(ERB.new(File.read('config/database.yml')).result)
-    @config['development']
-  end
-  alias_method :config, :development_database_config
-  
-  def mysql_command
-    ENV['MYSQL_PWD'] = config['password']
-    command = 'mysql --silent'
-    command << ' -u' << config['username']
-    command << ' --default-character-set=utf8'
-    command << ' ' << config['database']
-    command << ' < ' << dump_file
-  end
-  alias_method :mysql2_command, :mysql_command
+      @config ||= YAML::load(ERB.new(File.read('config/database.yml')).result)
+      @config['development']
+    end
+    alias_method :config, :development_database_config
   
-  def postgresql_command
-    ENV['PGPASSWORD'] = config['password']
-    command = 'pg_restore --no-owner --clean'
-    command << ' --username=' << config['username']
-    command << ' --host=' << config['host']
-    command << ' --dbname=' << config['database']
-    command << ' ' << dump_file
-  end
-
-  def source_dump!
-    source_command = send("#{config['adapter']}_command")
-    `#{source_command}`
-  end
-
-  def choose_dump_file
-    highline = HighLine.new
-
-    available_dumps = Dir.glob("#{dumps_dir}/*.dump").sort
-    selected_dump = highline.choose(*available_dumps) do |menu|
-      menu.hidden('') { exit }
+    def mysql_command
+      command = 'mysql --silent'
+      command << ' -p' << config['password']
+      command << ' -u' << config['username']
+      command << ' --default-character-set=utf8'
+      command << ' ' << config['database']
+      command << ' < ' << dump_file
     end
-  end
-
-  def dump_file
-    @dump_file ||= if @argv[0] && File.exists?(@argv[0])
-      @argv[0]
-    else
-      choose_dump_file
+    alias_method :mysql2_command, :mysql_command
+
+    def postgresql_command
+      ENV['PGPASSWORD'] = config['password']
+      command = 'pg_restore --no-owner --clean'
+      command << ' --username=' << config['username']
+      command << ' --host=' << config['host']
+      command << ' --dbname=' << config['database']
+      command << ' ' << dump_file
     end
-  end
 
-  def execute
-    puts "Sourcing #{dump_file} into #{config['database']} db ..." if @verbose
+    def dump_file
+      @dump_file ||= begin
+        dumps_glob = File.join(File.expand_path('~'), 'dumps', '*.dump')
+        available_dumps = Dir.glob(dumps_glob).sort
 
-    source_dump!
+        HighLine.new.choose(*available_dumps) do |menu|
+          menu.hidden('') { fail 'Abort.' }
+        end
+      end
+    end
+
+    def load
+      note 'Source file: ' + dump_file
 
-    if $?.success?
-      puts 'Successfully sourced the dump.' if @verbose
-    else
-      $stderr.puts "An error occured while loading the dump #{File.basename(dump_file)}."
+      source_command = send("#{config['adapter']}_command")
+      Util.system! source_command, :fail_message => "An error occured loading #{File.basename(dump_file)}"
     end
-    
-    $?.success?
-  end
 
-  def execute!
-    execute or exit(1)
   end
-
 end
-