sim 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Mzg2OTc5MTlmNDY4OGEzNWU5MDA2NmRiNGFkYmY0YWE5ODQ5NjZhZA==
+  data.tar.gz: !binary |-
+    OGFjMjBkZjA2OWIyNjM3ZjMzMWNiNGMxMGExNTIxOTBiYTVmM2NkOQ==
+SHA512:
+  metadata.gz: !binary |-
+    YjJkOWE2ZjRjMjk3MGI3MjMxMGZhZGFkNTU1YWJhZWVlZGNmM2E2Nzg3ZDEx
+    ZTVlMDk2YThkOWUzNmM2YzY5Y2E0NTY1MzgwMDNiOWJmNmRhNjdjN2I1MGMw
+    MDZlNTViMzViYTJlNTMyZTIxN2EyNmViMzc3ZDljY2JiZjU2NWE=
+  data.tar.gz: !binary |-
+    ZGFiZjY3NjcyYWZhYjQ4Mzk2OGVlMjRkYjYxOTY3NjZhNGI3ZGY1OGVjN2Iw
+    ZGM0MDhmOWZkN2ZiN2E0NjUxOWIzMGNlZDdmZTdlZjQzZTg2MWZlZWY0Njlj
+    YzcwMTI2ZGQzZjJkMzlhMGZiOTdmOGQ2NTU2ZjE0YzIxZjI4MTA=

data/Gemfile

@@ -0,0 +1,11 @@
+ source 'https://rubygems.org'
+
+gem "system-getifaddrs", "~> 0.2"
+gem 'rspec-rails', '~> 2.0'
+gem "parallel_tests", '~> 0.16'
+gem 'selenium-webdriver', '~> 2.39'
+gem 'poltergeist', '~> 1.5'
+gem 'cucumber-rails', '~> 1.4', :require => false
+gem 'ci_reporter', '~> 1.9'
+gem "capybara", "~> 2.1"
+gem 'database_cleaner', '~> 1.2'

data/History.md

@@ -0,0 +1,3 @@
+# Version 0.0.0
+
+Release date: 1/23/2014

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009-2012 Jonas Nicklas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# Rspec-Capybara-Jenkins
+
+## Key benefits
+
+- Integrate Capybara with:
+Jenkins
+parallel_test
+thread-safe HTML reporting
+- pre-configured switch between:
+local
+remote
+fail fast
+
+## Setup
+
+sim requires Ruby 1.9.3 or later. To install, type:
+
+```bash
+gem install sim
+```
+
+
+
+
+
+
+

data/lib/sim/all_inc.rb

@@ -0,0 +1,5 @@
+Dir['./config/environment.rb'].map {|f| require f}
+
+require 'sim/support/config'
+require 'sim/support/database_cleaner'
+require 'sim/support/web_testing'

data/lib/sim/custom_parallel_html_formatter.rb

@@ -0,0 +1,65 @@
+require_relative 'parallel_html_formatter'
+require 'erb'
+require_relative 'support/utilities'
+require_relative 'html_report'
+
+class CustomParallelHtmlFormatter < ParallelHtmlFormatter
+  include ERB::Util
+  include HTMLReport
+
+  def initialize(output)
+    super
+    #  raise "output has to be a file path!" unless output.is_a?(String)
+    @output_dir = File.dirname(@output)
+  end
+
+  def example_passed(example)
+    example_passed_helper(example, @buffer)
+  end
+
+  def example_failed(example)
+    example_failed_helper(example, @buffer)
+  end
+
+  def example_group_started(example_group)
+    super(example_group)
+  end
+
+  def example_group_finished(example_group)
+    super(example_group)
+  end
+
+  def example_started(example)
+    super(example)
+  end
+
+  def print_screenshot(example)
+    print_screenshot_helper(example, @buffer)
+  end
+
+  def example_pending(example)
+    super(example)
+  end
+
+  def extra_failure_content(failure)
+    content = []
+    content << "<span>"
+    content << ""
+    content << "</span>"
+    super + content.join($/)
+  end
+
+  def link_for(file_name)
+    return unless file_name && File.exists?(file_name)
+
+    description = File.extname(file_name).upcase[1..-1]
+    path = Pathname.new(file_name)
+    "<a href='#{path.relative_path_from(Pathname.new(@output_dir))}'>#{description}</a>&nbsp;"
+  end
+
+  # def start(example_count)
+  #   lock_output do
+  #     super(example_count)
+  #   end
+  # end
+end

data/lib/sim/fail_fast.rb

@@ -0,0 +1,39 @@
+require_relative 'all_inc.rb'
+
+require 'rspec/rails'
+require 'capybara/rails'
+
+require_relative 'support/config'
+
+puts "loading fail_fast.rb"
+
+RSpec.configure do |config|
+  config.fail_fast = true
+
+  config.after(:each) do
+    if example.exception
+      # stub in browser close method
+      Selenium::WebDriver::Driver.class_eval do
+        def quit
+          puts "preventing browser close"
+          #STDOUT.puts "#{self.class}#quit: no-op"
+        end
+      end
+
+      # stub in driver close method
+      Selenium::WebDriver::Chrome::Service.class_eval do
+        def stop
+          puts "preventing ChromeDriver stop"
+          #STDOUT.puts "#{self.class}#stop: no-op"
+        end
+      end
+      
+      # stub in Capybara's reset which to resets browser to about page
+      Capybara::Selenium::Driver.class_eval do
+        def reset!
+          puts "preventing reset to about page"
+        end
+      end
+    end
+  end
+end

data/lib/sim/html_formatter.rb

@@ -0,0 +1,67 @@
+require 'rspec/core/formatters/html_formatter'
+require 'erb'
+require_relative 'support/utilities'
+require_relative 'html_report'
+
+class CapybaraHtmlFormatter < RSpec::Core::Formatters::HtmlFormatter
+  include ERB::Util
+  include HTMLReport
+
+  def initialize(output)
+    super
+    # raise "output has to be a file path!" unless output.is_a?(String)
+    @output_dir = File.dirname(@output)
+  end
+
+  def example_passed(example)
+    example_passed_helper(example, @output)
+
+    @printer.flush
+    @output.flush
+  end
+
+  def example_failed(example)
+    example_failed_helper(example, @output)
+    
+    @printer.flush
+    @output.flush
+  end
+
+  def example_group_started(example_group)
+    super(example_group)
+  end
+
+  def example_group_finished(example_group)
+    super(example_group)
+  end
+
+  def example_started(example)
+    super(example)
+  end
+
+  def print_screenshot(example)
+    print_screenshot_helper(example, @output)
+   
+    @output.flush
+  end
+
+  def example_pending(example)
+    super(example)
+  end
+
+  def extra_failure_content(failure)
+    content = []
+    content << "<span>"
+    content << ""
+    content << "</span>"
+    super + content.join($/)
+  end
+
+  def link_for(file_name)
+    return unless file_name && File.exists?(file_name)
+
+    description = File.extname(file_name).upcase[1..-1]
+    path = Pathname.new(file_name)
+    "<a href='#{path.relative_path_from(Pathname.new(@output_dir))}'>#{description}</a>&nbsp;"
+  end
+end

data/lib/sim/html_report.rb

@@ -0,0 +1,119 @@
+require_relative 'support/utilities'
+
+module HTMLReport
+  def example_passed_helper(example, output_buffer)
+    move_tmp_to_final(example)
+    @printer.move_progress(percent_done)
+
+    description = example.metadata[:description_args].join('')
+    run_time = example.execution_result[:run_time]
+    formatted_run_time = sprintf("%.5f", run_time)
+    output_buffer.puts "    <dd class=\"example passed\"><span class=\"passed_spec_name\">#{h(description)}</span><span class='duration'>#{formatted_run_time}s</span>"
+
+    output_buffer.puts "<div class=\"screenshots\">"
+    print_screenshot(example)
+    output_buffer.puts "</div>"
+
+    output_buffer.puts "</dd>"
+  end
+
+  def example_failed_helper(example, output_buffer)
+    move_tmp_to_final(example)
+    unless @header_red
+      @header_red = true
+      @printer.make_header_red
+    end
+
+    unless @example_group_red
+      @example_group_red = true
+      @printer.make_example_group_header_red(example_group_number)
+    end
+
+    @printer.move_progress(percent_done)
+
+    exception = example.metadata[:execution_result][:exception]
+    exception_details = if exception
+    {
+      :class => exception.class.to_s,
+      :message => exception.message,
+      :backtrace => format_backtrace(exception.backtrace, example).join("\n")
+    }
+    else
+      false
+    end
+    extra = extra_failure_content(exception)
+
+    pending_fixed = example.execution_result[:pending_fixed]
+    description = example.description
+    run_time = example.execution_result[:run_time]
+    failure_id = @failed_examples.size
+    exception = exception_details
+    extra_content = (extra == "") ? false : extra
+    escape_backtrace = true
+    formatted_run_time = sprintf("%.5f", run_time)
+
+    output_buffer.puts "    <dd class=\"example #{pending_fixed ? 'pending_fixed' : 'failed'}\">"
+    output_buffer.puts "      <span class=\"failed_spec_name\">#{h(description)}</span>"
+    output_buffer.puts "      <span class=\"duration\">#{formatted_run_time}s</span>"
+    output_buffer.puts "      <div class=\"failure\" id=\"failure_#{failure_id}\">"
+    if exception
+      output_buffer.puts "        <div class=\"class\"><pre>#{h(exception[:class])}</pre></div>"
+      output_buffer.puts "        <div class=\"message\"><pre>#{h(exception[:message])}</pre></div>"
+      if escape_backtrace
+        output_buffer.puts "        <div class=\"backtrace\"><pre>#{h exception[:backtrace]}</pre></div>"
+      else
+        output_buffer.puts "        <div class=\"backtrace\"><pre>#{exception[:backtrace]}</pre></div>"
+      end
+    end
+    output_buffer.puts extra_content if extra_content
+    output_buffer.puts "      </div>"
+
+    output_buffer.puts "<div class=\"rerun_command\">bundle exec rspec " + example.metadata[:file_path] + ":" + example.metadata[:line_number].to_s + $local_run_args + "</div>"
+    output_buffer.puts "<div class=\"screenshots\">"
+    output_buffer.puts "</div>"
+    print_screenshot(example)
+    output_buffer.puts "    </dd>"
+  end
+
+  def print_screenshot_helper(example, output_buffer)
+    file_count = Dir[File.join(example.metadata[:screenshot_path], '*.html')].count
+    max_columns = 8
+    curr_column = 0
+
+    if file_count > 0 then output_buffer.puts "<table>" end
+
+    Dir[File.join(example.metadata[:screenshot_path], '*.html')].sort_by{|filename| filename }.each do |path|
+      if curr_column == 0 then output_buffer.puts "<tr>" end
+      output_buffer.puts "  <td>"
+
+      path_to_html = Pathname.new(path).relative_path_from(Pathname.new(@output_dir))
+      file_name_no_extension = File.basename(path_to_html.basename, '.*')
+      directory = Pathname.new(path).dirname
+      relative_path_to_img = File.join(path_to_html.dirname, file_name_no_extension) + '.png'
+      absolute_path_to_img = File.join(directory, file_name_no_extension) + '.png'
+      
+      if File.file?(absolute_path_to_img)
+        output_buffer.puts "    <a href=\"#{relative_path_to_img}\" style=\"text-decoration: none;\">"
+        output_buffer.puts "      <img src=\"#{relative_path_to_img}\" alt=\"#{item}\" height=\"100\" width=\"100\">"
+        output_buffer.puts "    </a>"
+        output_buffer.puts "    </br>"
+      end
+      output_buffer.puts "    <a href=\"#{path_to_html}\" style=\"text-decoration: none;\">"
+      output_buffer.puts "      <pre align=\"center\">#{dealphabetize_names(File.basename(path, '.*'))}</pre>"
+      output_buffer.puts "    </a>"
+      output_buffer.puts "  </td>"
+      if curr_column == (max_columns - 1) then output_buffer.puts "</tr>" end
+      curr_column = (curr_column + 1) % (max_columns - 1)
+    end
+
+    if (curr_column != 0) then output_buffer.puts("</tr>") end
+    if (file_count > 0) then output_buffer.puts("</table>") end
+  end
+
+  def move_tmp_to_final(example)
+  if path_to_tmp(example) != path_to_screenshot(example)
+      FileUtils.mv(path_to_tmp(example), path_to_screenshot(example))
+    end
+end
+end
+

data/lib/sim/local.rb

@@ -0,0 +1,13 @@
+require_relative 'all_inc.rb'
+
+require_relative 'support/config'
+require 'capybara/rails'
+
+puts "loading local.rb"
+
+# Capybara local run
+Capybara.javascript_driver = :selenium
+Capybara.default_driver = :selenium
+Capybara.register_driver :selenium do |app|
+  Capybara::Selenium::Driver.new(app, :browser => :chrome)
+end

data/lib/sim/local_phantomjs.rb

@@ -0,0 +1,7 @@
+require_relative 'all_inc.rb'
+
+require 'capybara/rails'
+
+require 'capybara/poltergeist'
+# Capybara.default_driver = :poltergeist
+Capybara.javascript_driver = :poltergeist

data/lib/sim/logger_base.rb

@@ -0,0 +1,64 @@
+module ParallelTests
+  module RSpec
+  end
+end
+
+begin
+  require 'rspec/core/formatters/base_text_formatter'
+  base = RSpec::Core::Formatters::BaseTextFormatter
+rescue LoadError
+  require 'spec/runner/formatter/base_text_formatter'
+  base = Spec::Runner::Formatter::BaseTextFormatter
+end
+
+ParallelTests::RSpec::LoggerBaseBase = base
+
+class ParallelTests::RSpec::LoggerBase < ParallelTests::RSpec::LoggerBaseBase
+  RSPEC_1 = !defined?(RSpec::Core::Formatters::BaseTextFormatter) # do not test for Spec, this will trigger deprecation warning in rspec 2
+
+  def initialize(*args)
+    super
+    
+    @output ||= args[1] || args[0] # rspec 1 has output as second argument
+
+    if String === @output # a path ?
+      FileUtils.mkdir_p(File.dirname(@output))
+      File.open(@output, 'w'){} # overwrite previous results
+      @output = File.open(@output, 'a')
+    elsif File === @output # close and restart in append mode
+      @output.close
+      @output = File.open(@output.path, 'a')
+    end
+  end
+
+  #stolen from Rspec
+  def close
+    @output.close  if (IO === @output) & (@output != $stdout)
+  end
+
+  # do not let multiple processes get in each others way
+  def lock_output
+    if File === @output
+      begin
+        @output.flock File::LOCK_EX
+        yield
+      ensure
+        @output.flock File::LOCK_UN
+      end
+    else
+      yield
+    end
+  end
+
+  def lock_output_begin
+    if File === @output
+      @output.flock File::LOCK_EX
+    end
+  end
+
+  def lock_output_end
+    if File === @output
+      @output.flock File::LOCK_UN
+    end
+  end
+end

data/lib/sim/parallel_html_formatter.rb

@@ -0,0 +1,187 @@
+
+require 'rspec/core/formatters/html_printer'
+require 'parallel_tests'
+require 'parallel_tests/rspec/logger_base'
+
+class ParallelHtmlFormatter < ParallelTests::RSpec::LoggerBase
+  def initialize(output)
+    super(output)
+
+    @buffer = StringIO.new
+    @header_buffer = StringIO.new
+
+    @example_group_number = 0
+    @example_number = 0
+    @header_red = nil
+    @printer = RSpec::Core::Formatters::HtmlPrinter.new(@buffer)
+
+    @header_printer = RSpec::Core::Formatters::HtmlPrinter.new(@header_buffer)
+
+    if ENV[:TEST_ENV_NUMBER.to_s] == ""
+      # puts %[hello from process #{ENV[:TEST_ENV_NUMBER.to_s].inspect}]
+      # puts ENV[:TEST_ENV_NUMBER.to_s].class
+
+      # lock this whole section so other threads don't get ahead of the html header flush
+      lock_output do
+        @header_printer.print_html_start
+        @header_buffer.puts "<input id=\"curr_duration\" type=\"hidden\" value=\"0\"/>"
+        @header_buffer.puts "<input id=\"curr_example_count\" type=\"hidden\" value=\"0\"/>"
+        @header_buffer.puts "<input id=\"curr_failure_count\" type=\"hidden\" value=\"0\"/>"
+        @output.puts @header_buffer.string
+      
+        @output.flush
+      end
+    end
+  end
+
+  private
+  def method_missing(m, *a, &b)
+    # no-op
+  end
+
+  public
+  def message(message)
+  end
+
+  # The number of the currently running example_group
+  def example_group_number
+    @example_group_number
+  end
+
+  # The number of the currently running example (a global counter)
+  def example_number
+    @example_number
+  end
+
+  def start(example_count)
+    super(example_count)
+  end
+
+  def example_group_started(example_group)
+    super(example_group)
+    @example_group_red = false
+    @example_group_number += 1
+
+    unless example_group_number == 1
+      @printer.print_example_group_end
+    end
+    @printer.print_example_group_start( example_group_number, example_group.description, example_group.parent_groups.size )
+  end
+
+  def start_dump
+    @printer.print_example_group_end
+  end
+
+  def example_started(example)
+    super(example)
+    @example_number += 1
+  end
+
+  def example_passed(example)
+    @printer.move_progress(percent_done)
+    @printer.print_example_passed( example.description, example.execution_result[:run_time] )
+  end
+
+  def example_failed(example)
+    super(example)
+
+    unless @header_red
+      @header_red = true
+      @printer.make_header_red
+    end
+
+    unless @example_group_red
+      @example_group_red = true
+      @printer.make_example_group_header_red(example_group_number)
+    end
+
+    @printer.move_progress(percent_done)
+
+    exception = example.metadata[:execution_result][:exception]
+    exception_details = if exception
+      {
+        :message => exception.message,
+        :backtrace => format_backtrace(exception.backtrace, example).join("\n")
+      }
+    else
+      false
+    end
+    extra = extra_failure_content(exception)
+
+    @printer.print_example_failed(
+      example.execution_result[:pending_fixed],
+      example.description,
+      example.execution_result[:run_time],
+      @failed_examples.size,
+      exception_details,
+      (extra == "") ? false : extra,
+      true
+    )
+  end
+
+  def example_pending(example)
+
+    @printer.make_header_yellow unless @header_red
+    @printer.make_example_group_header_yellow(example_group_number) unless @example_group_red
+    @printer.move_progress(percent_done)
+    @printer.print_example_pending( example.description, example.metadata[:execution_result][:pending_message] )
+  end
+
+  # Override this method if you wish to output extra HTML for a failed spec. For example, you
+  # could output links to images or other files produced during the specs.
+  #
+  def extra_failure_content(exception)
+    require 'rspec/core/formatters/snippet_extractor'
+    backtrace = exception.backtrace.map {|line| backtrace_line(line)}
+    backtrace.compact!
+    @snippet_extractor ||= RSpec::Core::Formatters::SnippetExtractor.new
+    "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
+  end
+
+  def percent_done
+    result = 100.0
+    if @example_count > 0
+      result = (((example_number).to_f / @example_count.to_f * 1000).to_i / 10.0).to_f
+    end
+    result
+  end
+
+  def dump_failures
+  end
+
+  def dump_pending
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    # @printer.print_summary(
+    #   dry_run?,
+    #   duration,
+    #   example_count,
+    #   failure_count,
+    #   pending_count
+    # )
+    # TODO - kill dry_run?
+
+    formatted_duration = sprintf("%.5f", duration)
+
+    @buffer.puts "<script type=\"text/javascript\">"
+    @buffer.puts "  var curr_duration = parseFloat(document.getElementById('curr_duration').value) + #{formatted_duration};"
+    @buffer.puts "  document.getElementById('curr_duration').value = curr_duration;"
+    @buffer.puts "  document.getElementById('duration').innerHTML = 'Finished in <strong>' + curr_duration.toFixed(3) + ' seconds</strong>';"
+    @buffer.puts "</script>"
+    @buffer.puts "<script type=\"text/javascript\">"
+    @buffer.puts "  var curr_example_count = Number(document.getElementById('curr_example_count').value) + #{example_count};"
+    @buffer.puts "  var curr_failure_count = Number(document.getElementById('curr_failure_count').value) + #{failure_count};"
+    @buffer.puts "  document.getElementById('curr_example_count').value = curr_example_count;"
+    @buffer.puts "  document.getElementById('curr_failure_count').value = curr_failure_count;"
+    @buffer.puts "  document.getElementById('totals').innerHTML = curr_example_count + ' example(s),' + curr_failure_count + ' failure(s)';"
+    @buffer.puts "</script>"
+    @buffer.puts "</div>"
+    @buffer.puts "</div>"
+
+    lock_output do
+      @output.puts @buffer.string
+      @output.flush
+    end
+  end
+end

data/lib/sim/remote.rb

@@ -0,0 +1,72 @@
+puts "loading support/remote.rb"
+
+require_relative 'all_inc.rb'
+require_relative 'support/config'
+require 'selenium-webdriver'
+require 'rspec/rails'
+require 'capybara/rails'
+
+def set_app_address()
+    require 'system/getifaddrs'
+    ip = $webserver_ip != nil ? $webserver_ip : System.get_ifaddrs.find{ |socket| socket[1][:inet_addr] != "127.0.0.1" } [1][:inet_addr]
+    port = $webserver_port != nil ? $webserver_port : Capybara.current_session.server.port
+    Capybara.app_host = "http://#{ip}:#{port}"
+    puts "Registering http://#{ip}:#{port} as root server"
+end
+
+Capybara.javascript_driver = :selenium_chrome
+Capybara.default_driver = :selenium_phantomjs
+
+# Capybara remote run
+# # init ip
+caps = Selenium::WebDriver::Remote::Capabilities.chrome
+# caps.version = "8"
+caps.platform = :WINDOWS
+
+Capybara.register_driver :selenium_chrome do |app|
+  Capybara::Selenium::Driver.new(
+    app,
+    :browser => :remote,
+    :url => "http://#{$grid_host}:#{$grid_port}/wd/hub",
+    :desired_capabilities => caps
+    )
+end
+
+# Capybara remote run phantomjs
+# # init ip
+caps_phantomjs = Selenium::WebDriver::Remote::Capabilities.phantomjs
+# caps.version = "8"
+# caps_phantomjs.platform = :WINDOWS
+
+Capybara.register_driver :selenium_phantomjs do |app|
+  Capybara::Selenium::Driver.new(
+    app,
+    :browser => :remote,
+    :url => "http://#{$grid_host}:#{$grid_port}/wd/hub",
+    :desired_capabilities => caps_phantomjs
+    )
+end
+
+if is_cucumber()
+  puts "yes"
+  Before do |scenario|
+    set_app_address()
+  end
+end
+
+if is_rspec()
+  puts "no"
+  RSpec.configure do |config|
+    config.include Capybara::DSL
+
+    # this allows each test to use the proper port when using
+    # Capybara's "random available port"
+    config.before(:each) do
+      next if Capybara.current_session.server.nil?
+
+      set_app_address()
+    end
+  end
+end
+
+

data/lib/sim/support/config.rb

@@ -0,0 +1,10 @@
+$cucumber_base_report_dir = "features/report"
+$base_screenshot_dir = 'spec/reports/HTML/screenshots'
+$local_run_args = ' -r html_formatter.rb -f CapybaraHtmlFormatter -o spec/reports/HTML/index.html -r fail_fast.rb -r local.rb '
+
+$grid_host = "10.242.1.187"
+$grid_port = "4444"
+
+# webserver_ip
+#$webserver_ip = '10.242.1.171'
+#$webserver_port = 3000

data/lib/sim/support/cucumber_util.rb

@@ -0,0 +1,21 @@
+module Utilities
+	def full_title(page_title)
+	  base_title = "Ruby on Rails Tutorial Sample App"
+	  if page_title.empty?
+	    base_title
+	  else
+	    "#{base_title} | #{page_title}"
+	  end
+	end
+
+	def path_to(page_name)
+		case page_name
+		when /homepage/
+			root_path
+		else
+			raise "Can't find mapping from \"{page_name}\" to a path."
+		end
+	end
+end
+
+World(Utilities)

data/lib/sim/support/database_cleaner.rb

@@ -0,0 +1,14 @@
+require 'rspec/rails'
+require 'database_cleaner'
+
+DatabaseCleaner.strategy = :truncation
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+  config.before :each do
+    DatabaseCleaner.start
+  end
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

data/lib/sim/support/rspec_util.rb

@@ -0,0 +1,65 @@
+require 'capybara'
+
+$filename_padding = 3
+
+def alphabetize_names(filename)
+  example.metadata[:snapshot_count] + '-' + filename
+end
+
+def dealphabetize_names(filename)
+  filename[4..filename.length]
+end
+
+def save_snapshot(example,filename)
+
+    ordered_filename = alphabetize_names(filename)
+    save_html_to_file(example, ordered_filename)
+
+    if example.metadata[:js]
+      save_screenshot_to_file(example, ordered_filename)
+    end
+    example.metadata[:snapshot_count] = (example.metadata[:snapshot_count].to_i + 1).to_s.rjust($filename_padding, '0')
+end
+
+def save_html_to_file(example, filename)
+  File.open("#{path_to_tmp(example)}/#{filename}.html", 'w') {|f| f.write(page.html) }
+end
+
+def save_screenshot_to_file(example, filename)
+  page.save_screenshot("#{path_to_tmp(example)}/#{filename}.png")
+end
+
+def path_to_tmp(example)
+  if example.metadata[:tmp_path]
+    return example.metadata[:tmp_path]
+  end
+  example.metadata[:tmp_path] = path_to_screenshot(example)
+  example.metadata[:tmp_path]
+end
+
+def path_to_screenshot(example)
+  if example.metadata[:screenshot_path]
+    return example.metadata[:screenshot_path]
+  end
+	desc = example.metadata[:description_args].empty? ? example.metadata[:id] : example.metadata[:description_args].first.gsub('"',"'").gsub('|', '')
+	example.metadata[:screenshot_path] = path_of_example_groups(example, desc)
+  example.metadata[:screenshot_path]
+end
+
+def path_of_example_groups(example, desc)
+  # metadata maintains example_group structure as nested example_groups from inner to outer
+  # so we build array from inner to outer and then reverse it
+  groups = []
+  groups << desc
+  current_group = example.metadata[:example_group]
+  while (!current_group.nil?) do
+    groups << current_group[:description]
+    current_group = current_group[:example_group]
+  end
+
+  groups << $base_screenshot_dir
+
+  groups.reverse.join('/')
+  
+end
+

data/lib/sim/support/sim_util.rb

@@ -0,0 +1,7 @@
+def is_cucumber()
+  respond_to? :After
+end
+
+def is_rspec()
+  RSpec.respond_to? :configure
+end

data/lib/sim/support/web_testing.rb

@@ -0,0 +1,64 @@
+puts "loading support/web_testing.rb"
+
+require_relative 'config'
+require_relative 'sim_util'
+require_relative 'capybara_util'
+
+if is_cucumber
+  require_relative 'cucumber_util'
+  require 'capybara/cucumber'
+
+  FileUtils.rm_rf($cucumber_base_report_dir)
+  FileUtils.mkdir($cucumber_base_report_dir) # cucumber does not auto build directory when capturing screenshot
+
+  After do |scenario|
+    # if(scenario.failed?)
+      img_name = "#{scenario.__id__}.png"
+      path_to_img = File.join($cucumber_base_report_dir,img_name)
+
+      page.save_screenshot(path_to_img)
+
+      self.embed(path_to_img, "image/png", "SCREENSHOT")
+    # end
+  end
+end
+
+if is_rspec
+  require_relative 'rspec_util'
+  require 'capybara'
+  require 'rspec/rails'
+
+  # TESTING SUITE
+  FileUtils.rm_rf($base_screenshot_dir)
+
+  RSpec.configure do |config|
+    config.include Capybara::RSpecMatchers
+    config.include Capybara::DSL
+    config.include Rails.application.routes.url_helpers
+
+    # use default driver on all tests
+    # config.after do
+    #   Capybara.reset_sessions!
+    #   Capybara.use_default_driver
+    # end
+
+    config.before(:each) do
+      # don't test model
+      if example.metadata[:type] != :model
+        example.metadata[:id] = @example_number
+        example.metadata[:snapshot_count] = '000'
+        FileUtils.mkdir_p(path_to_tmp(example)) unless File.exists?(path_to_tmp(example))
+      end
+    end
+
+    config.after(:each) do
+      # don't test model
+      if example.metadata[:type] != :model
+        result_name = example.exception ? "failure" : "final"
+
+        save_snapshot(example,result_name)
+      end
+    end
+    # END TESTING SUITE
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: sim
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Raybeam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: system-getifaddrs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.39'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.39'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: cucumber-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Preconfigure rspec and capybara to work with jenkins
+email: jfu@raybeam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- History.md
+- License.txt
+- README.md
+- lib/sim/all_inc.rb
+- lib/sim/custom_parallel_html_formatter.rb
+- lib/sim/fail_fast.rb
+- lib/sim/html_formatter.rb
+- lib/sim/html_report.rb
+- lib/sim/local.rb
+- lib/sim/local_phantomjs.rb
+- lib/sim/logger_base.rb
+- lib/sim/parallel_html_formatter.rb
+- lib/sim/remote.rb
+- lib/sim/support/capybara_util.rb
+- lib/sim/support/config.rb
+- lib/sim/support/cucumber_util.rb
+- lib/sim/support/database_cleaner.rb
+- lib/sim/support/rspec_util.rb
+- lib/sim/support/sim_util.rb
+- lib/sim/support/web_testing.rb
+homepage: http://rubygems.org/gems/sim
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Integrate capybara with jenkins
+test_files: []