geordi 1.2.3 → 1.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTRmNjIxM2QxMjA3MjdlZTZiNDAzMDUyNzVjNDY0YTkyM2RjNDFkYQ==
+    ZTg1YjZmMGRjNzQ1YTY4ZTJmNzE2ZmE4Yzc4YjQzOGU3YThlNTY0ZQ==
   data.tar.gz: !binary |-
-    MjZmNjkxNWI4OWQ1ZGM2ZGQyMjhkNjAxOTBmMjU2Y2RlODM1MmQwZQ==
+    YTVjMTg5NTA0YmU2NDQzZGU5ZWY1Yjc1NjNmODkyMmVhOGYwNGFiMA==
 SHA512:
   metadata.gz: !binary |-
-    ODgzN2M4YzgwZDAzOTg0ZWQ0ZmE1ZGYxNzhkYmFlMDE0MjYxZmRmNThjNWNi
-    ZDIxMTkzOWFjNDUzZmEwOGQ3ZjAzMTg4YTE1NWVkZTZiODVjMDQ1OTliZmM1
-    ZWM1MmI5YWU5OTZmZTU4NjdjZjc3NjcxZWM2MTg4YzAzODRmZTc=
+    YWI3YjAzMDE3ZWVmMmFjNGU3ZWM0NTI1MjljZWRiNzE0N2QwYTU1MTlkMjBh
+    ZWEzMzFiMGEyODY1OWNlMmE3ZTBjMTc0MTMwZDU0MDJiYmU2M2IyNWY1NDNk
+    ODMyZGJkYjdhNTNjM2NhMDEwZjVmYjYxYjBkNzhlZmRjZjg5MzM=
   data.tar.gz: !binary |-
-    Zjk4MGFmNTNhNDBlZWNiZDhlNzM1ZGMwZmM4ZTZjMTEzYzEzOTUxNGVjODE0
-    ZGNiYWMyODIwMTc4MTgwMjlhOTA5OWJkN2NmOGQyMzQ0N2U0MzRjYjc4OTM5
-    NzY1MGJlOWY5ODNlOWUyNmMxNzdmZjZiZDMwMjEwMmI0OGFiMmY=
+    ODhkNTY5ZmNhOTdkMmM3OWRlNzEzMGJkZjBlYWRhMTQxNjMzZGIyNDIzZmVi
+    ZjU0MTFmNDBjYmU4MjYyMzIwMzNhZmFjMTZhYTY3ZGRiYjJkOWE5MjZkMzgz
+    YmQ0MjgwMGFkMjg3MjdiMjIwNWYxOGVhMjc2N2UzZjdiMzU5YzA=

data/.gitignore

@@ -1,8 +1,7 @@
 *.gem
 .bundle
 .idea
-Gemfile.lock
 pkg/*
 .DS_Store
 .pt_project_id
-
+tmp

data/Gemfile

@@ -2,3 +2,10 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in geordi.gemspec
 gemspec
+
+gem 'aruba'
+gem 'pry'
+gem 'highline'
+
+# Required for running features that test parallel test execution
+gem 'parallel_tests' if ENV['GEORDI_TESTING']

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    geordi (1.3.0)
+      thor (>= 0.18.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.13.0)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    builder (3.2.2)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.0)
+    contracts (0.13.0)
+    cucumber (2.3.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.4.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 3.2.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.4.0)
+      gherkin (~> 3.2.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    gherkin (3.2.0)
+    highline (1.7.8)
+    method_source (0.8.2)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  geordi!
+  highline
+  pry
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -32,9 +32,9 @@ Run a capistrano command on all deploy targets.
 Example: `geordi capistrano deploy`
 
 
-### geordi cleanup-directory
+### geordi clean
 
-Remove unneeded files.
+Remove unneeded files from the current directory.
 
 
 ### geordi commit
@@ -57,13 +57,44 @@ Run Cucumber features.
 
 Example: `geordi cucumber features/authentication_feature:3`
 
-Runs Cucumber as you want: with `bundle exec`, `cucumber_spinner` detection,
-separate Firefox for Selenium, etc.
+Runs Cucumber as you want: with `bundle exec`, using parallel tests, with
+a VNC session holding Selenium test browsers, support for using a dedicated
+testing firefox and beta support for rerunning failed scenarios.
 
+- *@solo:* Generally, features are run in parallel. However, scenarios tagged
+with @solo are excluded and will be run sequentially, _after_ the parallel run.
 
-### geordi deploy
+- *Debugging:* Sometimes, the dot-printing Cucumber formatter does not show
+errors. In case a feature fails without a message, try running it with `--debug`
+or `-d`.
 
-Guided deployment.
+- *Options:* Any unknown option will be passed through to Cucumber,
+e.g. `--format pretty`.
+
+
+### geordi deploy [STAGE]
+
+Guided deployment across branches.
+
+Example: `geordi deploy production`
+
+Merge, push and deploy with a single command! There are several scenarios where
+this command comes in handy:
+
+1) *Production deploy:* From the master branch, run `geordi deploy production`.
+   This will merge `master` to `production`, push and deploy to production.
+
+2) *Feature branch deploy:* From the feature branch, run `geordi deploy staging`.
+   This will merge the feature branch to `master`, push and deploy to staging.
+
+3) *Simple deploy:* If the source branch matches the target branch, merging will
+   be skipped.
+
+Calling the command without arguments will infer the target stage from the
+current branch and fall back to master/staging.
+
+When your project does not have a `deploy:migrations` task, this command will
+run `cap deploy` instead when called with `-M`: `geordi deploy -M staging`.
 
 
 ### geordi devserver
@@ -100,6 +131,20 @@ dump into the development database after downloading it.
 Open the current Eurest cantina menu.
 
 
+### geordi firefox COMMAND
+
+Run a command with VNC set up (and the test firefox, if present).
+
+Example: `geordi firefox b cucumber` or `geordi firefox --setup 24.0`
+
+Useful when you need Firefox for Selenium or the VNC set up, but can't use the
+`geordi cucumber` command.
+
+*Install* a special Firefox by calling with `--setup <version>`.
+
+This command is aliased `chrome` for users running Selenium in Chrome.
+
+
 ### geordi help [COMMAND]
 
 Describe available commands or one specific command.
@@ -116,7 +161,7 @@ environment and `rake parallel:prepare` afterwards. Otherwise, invokes `geordi r
 with `db:migrate`.
 
 
-### geordi png-optimize
+### geordi png-optimize PATH
 
 Optimize .png files.
 
@@ -199,16 +244,6 @@ After setting up, runs all tests when called with the `--test` option:
 See `geordi help setup` for details.
 
 
-### geordi setup-firefox-for-selenium VERSION
-
-Install a special firefox for running Selenium tests.
-
-
-### geordi setup-vnc
-
-Setup VNC for running Selenium tests there.
-
-
 ### geordi shell TARGET
 
 Open a shell on a Capistrano deploy target.
@@ -255,19 +290,16 @@ See `geordi help update` for details.
 Print the current version of geordi.
 
 
-### geordi vnc-show
+### geordi vnc
 
 Show the hidden VNC window.
 
+Example: `geordi vnc` or `geordi vnc --setup`
 
-### geordi with-firefox-for-selenium COMMAND
-
-Run a command with firefox for selenium set up.
+Launch a VNC session to the hidden screen where `geordi cucumber` runs Selenium
+tests.
 
-Example: `geordi with-firefox-for-selenium b cucumber`
-
-Useful when you need Firefox for Selenium, but can't use the `geordi cucumber`
-command.
+When called with `--setup`, will guide through the setup of VNC.
 
 
 b
@@ -311,3 +343,11 @@ calling your local geordi like so (adjust paths to your needs):
 
 Don't forget to update this README. The whole `geordi` section is auto-generated
 by `rake update_readme`.
+
+Geordi is (partially) tested with Cucumber and Aruba. Run all tests with `rake`.
+Of course you're free to use `geordi tests` ;)
+
+**Note** that Geordi still needs to support Ruby 1.8.7, so make sure you only
+use syntax that was valid back then (e.g. the :old => hash syntax).
+Unfortunately, it is really hard to get Geordi's tests running on 1.8.7, so you
+need to make sure it runs on 1.8.7 manually.

data/Rakefile

@@ -1,6 +1,13 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
+desc 'Default: Run all tests'
+task :default => :features
+
+task :features do
+  system 'cucumber'
+end
+
 task :update_readme do
   require File.expand_path('../lib/geordi/cli', __FILE__)
 
@@ -39,4 +46,5 @@ For details on commands, e.g. supported options, run `geordi help <command>`.
 
   updated_readme = readme.sub(geordi_section_regex, geordi_section)
   File.open('README.md', 'w') { |f| f.puts updated_readme.strip }
+  puts 'README.me updated.'
 end

data/bin/cuc-vnc-setup

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 puts 'DEPRECATED: Use `geordi vn[c] --setup` instead'
-exec 'geordi', 'setup-vnc'
+exec 'geordi', 'vnc', '--setup'

data/bin/run_tests

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 puts 'DEPRECATED: Use `geordi f[irefox]` instead'
-exec 'geordi', 'with-firefox-for-selenium', *ARGV
+exec 'geordi', 'firefox', *ARGV

data/features/console.feature

@@ -0,0 +1,6 @@
+Feature: The console command
+
+  Scenario: Opening a local Rails console
+    When I run `geordi console`
+    Then the output should contain "# Opening a local Rails console"
+      And the output should contain "Util.system! bundle exec rails console development"

data/features/cucumber.feature

@@ -0,0 +1,129 @@
+Feature: The cucumber command
+
+  Background:
+    Given a file named "config/cucumber.yml" with:
+    """
+    default: features
+    rerun: features
+    """
+
+  Scenario: Run a single feature
+    Given a file named "features/single.feature" with:
+    """
+    Feature: Running a single feature
+      Scenario: A single scenario
+    """
+
+    When I run `geordi cucumber features/single.feature`
+    Then the output should contain "# Running features"
+      And the output should contain "> Only: features/single.feature"
+    But the output should not contain "parallel"
+
+
+  Scenario: Multiple features are run in parallel
+    Given a file named "features/one.feature" with:
+    """
+    Feature: One
+      Scenario: One
+    """
+    And a file named "features/two.feature" with:
+    """
+    Feature: Two
+      Scenario: Two
+    """
+
+    When I run `geordi cucumber`
+    Then the output should contain "# Running features"
+      And the output should contain "> All features in features/"
+      And the output should contain "> Using parallel_tests"
+
+
+  Scenario: Rerunning tests until they pass
+    Given a file named "features/step_definitions/test_steps.rb" with:
+    """
+    Given /^this test fails$/ do
+      raise
+    end
+    """
+    And a file named "features/failing.feature" with:
+    """
+    Feature: Failing feature
+      Scenario: Failing scenario
+        And this test fails
+    """
+
+    When I run `geordi cucumber --rerun=2`
+    Then the output should contain "# Running features"
+      And the output should contain "# Rerun #1 of 2"
+      And the output should contain "# Rerun #2 of 2"
+      And the output should contain "Rerunning failed scenarios"
+      And the output should contain "Using the rerun profile"
+      And the exit status should be 1
+
+
+  Scenario: Running all features in a given subfolder
+    Given a file named "features/sub/one.feature" with:
+    """
+    Feature: Testfeature
+    """
+    And a file named "features/sub/two.feature" with:
+    """
+    Feature: Testfeature
+    """
+
+    When I run `geordi cucumber features/sub`
+    Then the output should contain "> Only: features/sub/two.feature, features/sub/one.feature"
+      And the output should contain "> Using parallel_tests"
+
+
+  Scenario: Using the @solo tag
+
+    The cucumber command runs all features without the @solo tag. If any of the
+    .feature files contains '@solo', it boots Cucumber a second time and runs
+    only the features tagged with @solo.
+
+    Given a file named "features/no_solo.feature" with:
+    """
+    Feature: Test without solo tag
+      Scenario: This scenario can run in parallel
+    """
+    And a file named "features/solo.feature" with:
+    """
+    Feature: Solo test
+      @solo
+      Scenario: This scenario must NOT run in parallel
+    """
+
+    When I run `geordi cucumber --verbose`
+    Then the output should contain "# Running features"
+      And the output should match /^> .*cucumber .*--tags ~@solo/
+      And the output should contain "# Running @solo features"
+      And the output should match /^> .*cucumber .*--tags @solo/
+
+
+  Scenario: When there are no scenarios tagged @solo, the extra run is skipped
+    Given a file named "features/no_solo.feature" with:
+    """
+    Feature: Test without solo tag
+      Scenario: This scenario can run in parallel
+    """
+
+    When I run `geordi cucumber --verbose`
+    Then the output should contain "# Running features"
+      And the output should match /^> .*cucumber .*--tags ~@solo/
+    But the output should not contain "# Running @solo features"
+      And the output should not match /^> .*cucumber .*--tags @solo/
+
+
+  Scenario: Specifying a firefox version to use
+    Given a file named "features/sub/one.feature" with:
+    """
+    Feature: Testfeature
+    """
+    And a file named ".firefox-version" with:
+    """
+    24.0
+    """
+
+    When I run `geordi cucumber --verbose`
+    Then the output should match /^> PATH=.*24.0:\$PATH.* cucumber/

data/features/dump.feature

@@ -0,0 +1,31 @@
+Feature: The dump command
+
+  Scenario: Creating a dump of the development database
+    When I run `geordi dump`
+    Then the output should contain "Util.system! dumple development"
+      And the output should contain "Successfully dumped the development database"
+
+
+  Scenario: Creating a dump of a remote database
+    Given a file named "Capfile" with "Capfile exists"
+    And a file named "config/deploy.rb" with:
+    """
+    """
+    And a file named "config/deploy/staging.rb" with:
+    """
+    set :rails_env, 'staging'
+    set :deploy_to, '/var/www/example.com'
+    set :user, 'user'
+
+    server 'www.example.com'
+    """
+
+    When I run `geordi dump staging`
+    Then the output should contain "# Dumping the database of staging"
+      And the output should contain "> Connecting to www.example.com"
+      And the output should contain "Util.system! ssh user@www.example.com -t cd /var/www/example.com/current && bash --login -c 'dumple staging --for_download'"
+      And the output should contain "> Downloading remote dump to tmp/staging.dump"
+      # Omitting the absolute path in this regex (.*)
+      And the output should match %r<Util.system! scp user@www.example.com:~/dumps/dump_for_download.dump .*/tmp/aruba/tmp/staging.dump>
+      And the output should contain "> Dumped the staging database to tmp/staging.dump"
+

data/features/firefox.feature

@@ -0,0 +1,53 @@
+Feature: The firefox/chrome command
+
+  This command is used internally by the cucumber command.
+
+  Scenario: Running a command with VNC set up
+    Given a file named "testfile" with "testcontent"
+
+    When I run `geordi firefox cat testfile`
+    Then the output should contain "> VNC is ready to hold Selenium test browsers. Use `geordi vnc` to view them."
+      And the output should contain "testcontent"
+    But the output should not contain "Firefox for Selenium"
+
+
+  Scenario: The command is aliased as "chrome"
+    Given a file named "testfile" with "testcontent"
+
+    When I run `geordi chrome cat testfile`
+    Then the output should contain "> VNC is ready to hold Selenium test browsers. Use `geordi vnc` to view them."
+      And the output should contain "testcontent"
+
+
+    # Could not get this to work
+#  Scenario: Running a command with VNC and Firefox set up
+#    Given a mocked home directory
+#    Given a file named ".firefox-version" with "1337"
+#      And a file named "bin/firefoxes/1337/firefox" with "<fake>"
+#      And a file named "testfile" with "testcontent"
+#
+#    When I run `geordi firefox cat testfile`
+#    Then the output should contain "> VNC is ready"
+#      And the output should contain "> Firefox for Selenium set up"
+#      And the output should contain "testcontent"
+
+
+  Scenario: Having a .firefox-version that is not installed yet
+    Given a file named ".firefox-version" with "1337"
+      And a file named "testfile" with "testcontent"
+
+    When I run `geordi firefox cat testfile` interactively
+      And I type "yes"
+    Then the output should contain "> Firefox 1337 not found"
+      And the output should contain "Run tests anyway?"
+      And the output should contain "testcontent"
+
+
+  Scenario: A .firefox-version file with "system" is ignored (legacy support)
+    Given a file named ".firefox-version" with "system"
+      And a file named "testfile" with "testcontent"
+
+    When I run `geordi firefox cat testfile`
+    Then the output should contain "> VNC is ready"
+      And the output should contain "testcontent"
+    But the output should not contain "Firefox for Selenium"

data/features/shell.feature

@@ -0,0 +1,30 @@
+Feature: The shell command
+
+  Background:
+    Given a file named "Capfile" with "Capfile exists"
+
+
+  Scenario: It opens a remote shell on the primary server
+    Given a file named "config/deploy.rb" with "deploy.rb exists"
+    And a file named "config/deploy/geordi.rb" with:
+    """
+    set :user, 'deploy'
+    set :deploy_to, '/var/www/example.com'
+    server 'first.example.com'
+    server 'second.example.com'
+    """
+
+    When I run `geordi shell geordi`
+    Then the output should contain "Util.system! ssh deploy@first.example.com -t cd /var/www/example.com/current && bash --login"
+
+
+  Scenario: It understands Capistrano 3 syntax
+    Given a file named "config/deploy.rb" with "deploy.rb exists"
+    And a file named "config/deploy/geordi.rb" with:
+    """
+    set :deploy_to, '/var/www/example.com'
+    server 'first.example.com', user: 'deploy'
+    """
+
+    When I run `geordi shell geordi`
+    Then the output should contain "Util.system! ssh deploy@first.example.com -t cd /var/www/example.com/current && bash --login"

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'aruba/cucumber'
+require 'pry'
+
+# Disables execution of Util.system! calls
+ENV['GEORDI_TESTING'] = 'true'

data/geordi.gemspec

@@ -21,9 +21,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'thor', '>= 0.18.0'
-  # s.add_development_dependency 'debugger'
 
   s.post_install_message = <<-ATTENTION
-    Binary `geordi` installed
+Binary `geordi` installed
   ATTENTION
 end

data/lib/geordi/capistrano_config.rb

@@ -1,60 +1,57 @@
-require 'capistrano'
-
 module Geordi
   class CapistranoConfig
 
     attr_accessor :root
 
     def initialize(stage)
-      ENV['BUNDLE_BIN_PATH'] = 'Trick capistrano safeguard in deploy.rb into believing bundler is present by setting this variable.'
-
-      @stage = stage
-      @root = find_project_root!
-      load_capistrano_config
+      self.stage = stage
+      self.root = find_project_root!
+      load_deploy_info
     end
 
-    def user
-      @capistrano_config.fetch(:user)
+    def user(server)
+      cap2user = deploy_info[ /^set :user, ['"](.*?)['"]/, 1 ]
+      cap2user || deploy_info[ /^server ['"]#{ server }['"],.*user.{1,4}['"](.*?)['"]/, 1 ]
     end
 
     def servers
-      @capistrano_config.find_servers(:roles => [:app])
+      deploy_info.scan(/^server ['"](.*?)['"]/).flatten
     end
 
     def primary_server
-      @capistrano_config.find_servers(:roles => [:app], :only => { :primary => true }).first
+      # Actually, servers may have a :primary property. From Capistrano 3, the
+      # first listed server is the primary one by default, which is a good-
+      # enough default for us.
+      servers.first
     end
 
-    def path
-      @capistrano_config.fetch(:deploy_to) + '/current'
+    def remote_root
+      File.join deploy_info[ /^set :deploy_to, ['"](.*?)['"]/, 1 ], 'current'
     end
 
     def env
-      @capistrano_config.fetch(:rails_env, 'production')
+      deploy_info[ /^set :rails_env, ['"](.*?)['"]/, 1 ]
     end
 
     def shell
-      @capistrano_config.fetch(:default_shell, 'bash --login')
+      'bash --login'
     end
 
-
     private
 
-    def load_capistrano_config
-      config = ::Capistrano::Configuration.new
-      config.load('deploy')
-      config.load('config/deploy')
-      if @stage and @stage != ''
-        config[:stage] = @stage
-        config.find_and_execute_task(@stage)
-      end
+    attr_accessor :deploy_info, :stage
 
-      @capistrano_config = config
+    def load_deploy_info
+      self.deploy_info = File.read(File.join root, 'config/deploy.rb').tap do |info|
+        if stage
+          info << "\n" << File.read(File.join root, "config/deploy/#{ stage }.rb")
+        end
+      end
     end
 
     def find_project_root!
       current = Dir.pwd
-      until (File.exists? 'Capfile')
+      until File.exists?('Capfile')
         Dir.chdir '..'
         raise <<-ERROR if current == Dir.pwd
 Could not locate Capfile.