spec_ui 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+= 0.0.2
+* Made setup much easier
+
+= 0.0.1
+* Applied [#7685] spec_ui feedback and patch (Patch from Alvin Schur)

data/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/spec/ui.rb
+lib/spec/ui/behaviour.rb
+lib/spec/ui/configuration.rb
+lib/spec/ui/formatter.rb
+lib/spec/ui/rake_tasks.rb
+lib/spec/ui/rmagick_not_installed.png
+lib/spec/ui/screenshot_helper.rb
+lib/spec/ui/selenium_helper.rb
+lib/spec/ui/version.rb
+lib/spec/ui/watir_helper.rb
+lib/spec/ui/webapp_helper.rb
+lib/spec/ui/win32screenshot_not_installed.png
+lib/spec/ui/wrong_win32screenshot.png
+examples/selenium/Rakefile
+examples/selenium/README.txt
+examples/selenium/spec/google/find_rspecs_homepage_spec.rb
+examples/selenium/spec/spec_helper.rb
+examples/watir/Rakefile
+examples/watir/README.txt
+examples/watir/spec/google/find_rspecs_homepage_spec.rb
+examples/watir/spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,12 @@
+README for spec/ui
+==================
+
+spec/ui is an add-on to RSpec that lets you use a UI-testing framework
+such as Selenium or Watir/Safariwatir from RSpec. spec/ui also makes it
+easy to create HTML reports with screenshots as described in this blogpost:
+
+http://blog.aslakhellesoy.com/articles/2006/12/02/getting-screenshots-from-watir
+
+As much as possible of the supporting code has been factored out to separate files
+under spec/ui, and the distribution contains examples with a spec_helper and a Rakefile
+that you can copy into your own project and tweak if needed.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'spec', 'ui', 'version')
+
+AUTHOR = "Aslak Hellesoy"  # can also be an array of Authors
+EMAIL = "rspec-user@rubyforge.org"
+DESCRIPTION = "Run UI RSpec examples with screenshot reports"
+GEM_NAME = "spec_ui" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "rspec" # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+RELEASE_TYPES = %w( gem ) # can use: gem, tar, zip
+
+
+NAME = "spec_ui"
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (Spec::Ui::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "spec/ui documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  #p.extra_deps     - An array of rubygem dependencies.
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+end

data/examples/selenium/README.txt

@@ -0,0 +1,29 @@
+= Using Selenium with spec/ui =
+
+The files in this directory are examples illustrating how to use Selenium
+with spec/ui. Prerequisites:
+
+* Install Java 1.4 or later
+* Download SeleniumRC 0.9.0 or later (http://www.openqa.org/selenium-rc/)
+* Copy selenium-server.jar into the spec directory.
+* Copy selenium.rb into the spec directory.
+
+After this is installed, open two shells in this directory.
+
+In the first one, run:
+
+  java -jar spec/selenium-server.jar
+
+In the second one, run:
+
+  rake spec:ui
+  
+= Note for OS X users =
+
+== Firefox 2.0.0.1 ==
+If you experience that the selenium server is just hanging, read this:
+http://forums.openqa.org/message.jspa?messageID=16541
+
+== Safari ==
+You may have to set up Safari's proxy settings manually:
+http://forums.openqa.org/thread.jspa?messageID=20570&#20570

data/examples/selenium/Rakefile

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/spec/spec_helper'
+Spec::Ui.create_tasks

data/examples/selenium/spec/google/find_rspecs_homepage_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Google's search page" do
+  before(:all) do
+    @browser = Selenium::SeleniumDriver.new("localhost", 4444, "*safari", "http://www.google.no", 10000)
+    @browser.start
+  end
+    
+  before(:each) do
+    @browser.open('http://www.google.no')
+  end
+
+  it "should find rspec's home page when I search for rspec" do
+    @browser.type "name=q", "rspec"
+    @browser.click_and_wait "name=btnG"
+    @browser.is_text_present("rspec.rubyforge.org").should be_true
+  end
+
+  it "should find rspec's home page when I search for 'better than fudge' (will probably fail)" do
+    @browser.type "name=q", "better than fudge"
+    @browser.click_and_wait "name=btnG"
+    @browser.is_text_present("rspec.rubyforge.org").should be_true
+  end
+
+  it "should not find Ali G when I search for rspec" do
+    @browser.type "name=q", "rspec"
+    @browser.click_and_wait "name=btnG"
+    @browser.is_text_present("Ali G").should be_false
+  end
+
+  after(:each) do
+    save_screenshot_and_source(@browser)
+  end
+
+  after(:all) do
+    @browser.kill! rescue nil
+  end
+end

data/examples/selenium/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# You don't need to tweak the $LOAD_PATH if you have RSpec and Spec::Ui installed as gems
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../../../rspec/lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../../lib')
+
+require 'rubygems'
+require 'spec'
+require 'spec/ui'
+
+Spec::Runner.configure do |config|
+  config.spec_ui_report_dir = File.dirname(__FILE__) + '/report'
+end

data/examples/watir/README.txt

@@ -0,0 +1,12 @@
+= Using Watir with spec/ui =
+
+The files in this directory are examples illustrating how to use Watir
+with spec/ui. Prerequisites:
+
+* See the general prerequisites in the toplevel README
+* gem install watir -y # If you're on Windows
+* gem install safariwatir -y # If you're on OS X
+
+After this is installed, run the watir specs:
+
+  rake spec:ui

data/examples/watir/Rakefile

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/spec/spec_helper'
+Spec::Ui.create_tasks

data/examples/watir/spec/google/find_rspecs_homepage_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Google's search page" do
+  before(:all) do
+    @browser = Watir::Browser.new
+  end
+  
+  before(:each) do
+    @browser.goto('http://www.google.com')
+  end
+
+  it "should find rspec's home page when I search for rspec" do
+    @browser.text_field(:name, "q").set("rspec")
+    @browser.button(:name, "btnG").click
+    @browser.should have_link(:url, "http://rspec.rubyforge.org/")
+  end
+
+  it "should find rspec's home page when I search for 'better than fudge' (this is supposed to fail)" do
+    @browser.text_field(:name, "q").set("better than fudge")
+    @browser.button(:name, "btnG").click
+    @browser.should have_link(:url, "http://rspec.rubyforge.org/")
+  end
+
+  it "should not find Ali G when I search for respec" do
+    @browser.text_field(:name, "q").set("respec")
+    @browser.button(:name, "btnG").click
+    @browser.should_not have_text("Ali G")
+  end
+
+  after(:each) do
+    save_screenshot_and_source(@browser)
+  end
+
+  after(:all) do
+    @browser.kill! rescue nil
+  end
+end

data/examples/watir/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# You don't need to tweak the $LOAD_PATH if you have RSpec and Spec::Ui installed as gems
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../../../rspec/lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../../lib')
+
+require 'rubygems'
+require 'spec'
+require 'spec/ui'
+
+Spec::Runner.configure do |config|
+  config.spec_ui_report_dir = File.dirname(__FILE__) + '/report'
+end

data/lib/spec/ui.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/ui/configuration'
+require File.dirname(__FILE__) + '/ui/behaviour'
+require File.dirname(__FILE__) + '/ui/webapp_helper'
+require File.dirname(__FILE__) + '/ui/watir_helper'
+require File.dirname(__FILE__) + '/ui/selenium_helper'
+require File.dirname(__FILE__) + '/ui/screenshot_helper'
+require File.dirname(__FILE__) + '/ui/rake_tasks'

data/lib/spec/ui/behaviour.rb

@@ -0,0 +1,6 @@
+class Spec::DSL::Behaviour
+  def before_eval #:nodoc:
+    include Spec::Ui::WebappHelper
+    include Spec::Watir # This gives us Watir matchers
+  end
+end

data/lib/spec/ui/configuration.rb

@@ -0,0 +1,7 @@
+class Spec::DSL::Configuration
+  attr_accessor :spec_ui_report_dir
+  
+  def spec_ui_image_dir
+    File.join(spec_ui_report_dir, 'images')
+  end
+end

data/lib/spec/ui/formatter.rb

@@ -0,0 +1,15 @@
+module Spec
+  module Ui
+    class ScreenshotFormatter < Spec::Runner::Formatter::HtmlFormatter
+      def extra_failure_content(failure)
+        super + "        <div><a href=\"images/#{current_example_number}.png\"><img width=\"25%\" height=\"25%\" src=\"images/#{current_example_number}.png\"></a></div>\n"
+      end
+    end
+
+    class WebappFormatter < ScreenshotFormatter
+      def extra_failure_content(failure)
+        super + "        <div><a href=\"images/#{current_example_number}.html\">HTML source</a></div>\n"
+      end
+    end
+  end
+end

data/lib/spec/ui/rake_tasks.rb

@@ -0,0 +1,31 @@
+module Spec
+  module Ui
+    def self.create_tasks
+      require 'spec/rake/spectask'
+
+      if Spec::Runner.configuration.spec_ui_report_dir.nil?
+        STDERR.puts <<-EOF
+You must tell Spec::Ui where the report should go.
+Please put the following in your spec/spec_helper.rb file:
+
+require 'spec'
+require 'spec/ui'
+
+Spec::Runner.configure do |config|
+  config.spec_ui_report_dir = File.dirname(__FILE__) + '/report'
+end
+EOF
+      end
+        
+      FileUtils.rm_rf(Spec::Runner.configuration.spec_ui_report_dir) if File.exist?(Spec::Runner.configuration.spec_ui_report_dir)
+      FileUtils.mkdir_p(Spec::Runner.configuration.spec_ui_report_dir)
+      
+      desc "Run UI Specs"
+      Spec::Rake::SpecTask.new('spec:ui') do |t|
+        t.spec_files = FileList['spec/**/*.rb']
+        t.spec_opts = ['--require', 'spec/spec_helper', '--format', 'Spec::Ui::WebappFormatter']
+        t.out = "#{Spec::Runner.configuration.spec_ui_report_dir}/index.html"
+      end
+    end
+  end
+end

data/lib/spec/ui/screenshot_helper.rb

@@ -0,0 +1,62 @@
+require 'fileutils'
+
+module Spec
+  module Ui
+    module ScreenshotHelper
+      def md(dir)
+        FileUtils.mkdir_p(dir) unless File.directory?(dir)
+      end
+      
+      if RUBY_PLATFORM =~ /darwin/
+        def save_screenshot(dir, spec_number)
+          md(dir)
+          img_path = "#{dir}/#{spec_number}.png"
+          # How do we capture the current window??
+          `screencapture #{img_path}`
+        end
+      else # Win32
+        begin
+          require 'rubygems'
+          require 'RMagick'
+          gem 'win32screenshot', '>=0.0.2'
+          require 'win32screenshot'
+          def save_screenshot(dir, spec_number)
+            md(dir)
+            width, height, bmp = ::Win32::Screenshot.foreground
+            begin
+              img = Magick::Image.from_blob(bmp)[0]
+              img_path = "#{dir}/#{spec_number}.png"
+              dir = File.dirname(img_path)
+              FileUtils.mkdir_p(dir) unless File.exist?(dir)
+              img.write(img_path)
+              img
+            rescue Magick::ImageMagickError => e
+              if e.message =~ /Insufficient image data in file/
+                e.message << "\nTry this:\n1) Open your app (e.g. Internet Explorer)\n2) Resize the app to be bigger (without maximizing).\n3) close it so Windows remembers its size.\n" +
+                "This *may* make this error go away."
+              end
+              raise e
+            end
+          end
+        rescue Gem::LoadError => e
+          def save_screenshot(dir, spec_number)
+            md(dir)
+            FileUtils.cp(File.dirname(__FILE__) + '/wrong_win32screenshot.png', "#{dir}/#{spec_number}.png")
+          end
+        rescue LoadError => e
+          if(e.message =~ /win32screenshot/)
+            def save_screenshot(dir, spec_number)
+              md(dir)
+              FileUtils.cp(File.dirname(__FILE__) + '/win32screenshot_not_installed.png', "#{dir}/#{spec_number}.png")
+            end
+          else
+            def save_screenshot(dir, spec_number)
+              md(dir)
+              FileUtils.cp(File.dirname(__FILE__) + '/rmagick_not_installed.png', "#{dir}/#{spec_number}.png")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spec/ui/selenium_helper.rb

@@ -0,0 +1,21 @@
+module Selenium
+  class SeleniumDriver
+    def click_and_wait(locator, timeout="5000")
+      click(locator)
+      wait_for_page_to_load(timeout)
+    end
+
+    def open_and_wait(url, timeout="5000")
+      open(url)
+      wait_for_page_to_load(timeout)
+    end
+
+    def html
+      get_html_source
+    end
+    
+    def kill!
+      stop
+    end
+  end
+end

data/lib/spec/ui/version.rb

@@ -0,0 +1,11 @@
+module Spec
+  module Ui
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 1
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/lib/spec/ui/watir_helper.rb

@@ -0,0 +1,167 @@
+require File.dirname(__FILE__) + '/webapp_helper'
+require 'rubygems'
+
+if RUBY_PLATFORM =~ /darwin/
+  require 'safariwatir'
+  Watir::Browser = Watir::Safari
+else
+  require 'watir'
+  Watir::Browser = Watir::IE
+
+  class Watir::Browser
+    alias old_initialize initialize
+    # Brings the IE to the foreground (provided Win32::Screenshot is installed)
+    def initialize
+      result = old_initialize
+      ::Win32::Screenshot.setForegroundWindow(self.getIE.hwnd) rescue nil
+      result
+    end
+  end
+end
+
+class Watir::Browser
+  def kill!
+    close
+  end
+  
+  alias contain_text? contains_text
+
+  alias old_goto goto
+  # Redefinition of Watir's original goto, which gives a better
+  # exception message (the URL is in the message)
+  def goto(url)
+    begin
+      old_goto(url)
+    rescue => e
+      e.message << "\nURL: #{url}"
+      raise e
+    end
+  end
+end
+
+module Spec
+  # Matchers for Watir::IE/Watir::Safari instances
+  module Watir
+    # RSpec matcher that passes if @browser#text matches +text+ (String or Regexp) 
+    def have_text(text)
+      Spec::Watir::HaveText.new(text)
+    end
+
+    class HaveText # :nodoc
+      def initialize(text_or_regexp)
+        @text_or_regexp = text_or_regexp
+      end
+      
+      def matches?(browser)
+        @browser = browser
+        if @text_or_regexp.is_a?(Regexp)
+          !!browser.text =~ @text_or_regexp
+        else
+          !!browser.text.index(@text_or_regexp.to_s)
+        end
+      end
+      
+      def failure_message
+        "Expected browser to have text matching #{@text_or_regexp}, but it was not found in:\n#{@browser.text}"
+      end
+
+      def negative_failure_message
+        "Expected browser to not have text matching #{@text_or_regexp}, but it was found in:\n#{@browser.text}"
+      end
+    end
+
+    # RSpec matcher that passes if @browser#html matches +text+ (String or Regexp) 
+    def have_html(text)
+      Spec::Watir::HaveHtml.new(text)
+    end
+
+    class HaveHtml # :nodoc
+      def initialize(text_or_regexp)
+        @text_or_regexp = text_or_regexp
+      end
+      
+      def matches?(browser)
+        @browser = browser
+        if @text_or_regexp.is_a?(Regexp)
+          !!browser.html =~ @text_or_regexp
+        else
+          !!browser.html.index(@text_or_regexp.to_s)
+        end
+      end
+      
+      def failure_message
+        "Expected browser to have HTML matching #{@text_or_regexp}, but it was not found in:\n#{@browser.html}"
+      end
+
+      def negative_failure_message
+        "Expected browser to not have HTML matching #{@text_or_regexp}, but it was found in:\n#{@browser.html}"
+      end
+    end
+
+    # RSpec matcher that passes if @browser#link(+how+,+what+) returns an existing link.
+    def have_link(how, what)
+      Spec::Watir::HaveLink.new(how, what)
+    end
+
+    class HaveLink # :nodoc
+      def initialize(how, what)
+        @how, @what = how, what
+      end
+      
+      def matches?(browser)
+        @browser = browser
+        begin
+          link = @browser.link(@how, @what)
+          if link.respond_to?(:assert_exists)
+            # IE
+            link.assert_exists
+            true
+          else
+            # Safari
+            link.exists?
+          end
+        rescue ::Watir::Exception::UnknownObjectException => e
+          false
+        end
+      end
+      
+      def failure_message
+        "Expected browser to have link(#{@how}, #{@what}), but it was not found"
+      end
+
+      def negative_failure_message
+        "Expected browser not to have link(#{@how}, #{@what}), but it was found"
+      end
+    end
+
+    # RSpec matcher that passes if @browser#text_field(+how+,+what+) returns an existing text field.
+    def have_text_field(how, what)
+      Spec::Watir::HaveTextField.new(how, what)
+    end
+
+    class HaveTextField # :nodoc
+      def initialize(how, what)
+        @how, @what = how, what
+      end
+      
+      def matches?(browser)
+        @browser = browser
+        begin
+          text_field = @browser.text_field(@how, @what)
+          text_field.assert_exists
+          true
+        rescue ::Watir::Exception::UnknownObjectException => e
+          false
+        end
+      end
+      
+      def failure_message
+        "Expected browser to have text_field(#{@how}, #{@what}), but it was not found"
+      end
+
+      def negative_failure_message
+        "Expected browser not to have text_field(#{@how}, #{@what}), but it was found"
+      end
+    end
+  end
+end

data/lib/spec/ui/webapp_helper.rb

@@ -0,0 +1,23 @@
+require 'spec'
+require File.dirname(__FILE__) + '/screenshot_helper'
+require File.dirname(__FILE__) + '/formatter'
+
+module Spec
+  module Ui
+    module WebappHelper
+      include Spec::Ui::ScreenshotHelper
+      @@spec_number = 0
+
+      # Call this method from your teardown block to have source and screenshot written to disk.
+      def save_screenshot_and_source(browser)
+        save_screenshot(Spec::Runner.configuration.spec_ui_image_dir, @@spec_number)
+        save_source(Spec::Runner.configuration.spec_ui_image_dir, @@spec_number, browser.html)
+        @@spec_number += 1
+      end
+
+      def save_source(dir, spec_number, html)
+        File.open("#{dir}/#{spec_number}.html", "w") {|io| io.write(html)}
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.1
+specification_version: 1
+name: spec_ui
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-05-01 00:00:00 +02:00
+summary: Run UI RSpec examples with screenshot reports
+require_paths: 
+- lib
+email: rspec-user@rubyforge.org
+homepage: http://rspec.rubyforge.org
+rubyforge_project: rspec
+description: Run UI RSpec examples with screenshot reports
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Aslak Hellesoy
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/spec/ui.rb
+- lib/spec/ui/behaviour.rb
+- lib/spec/ui/configuration.rb
+- lib/spec/ui/formatter.rb
+- lib/spec/ui/rake_tasks.rb
+- lib/spec/ui/rmagick_not_installed.png
+- lib/spec/ui/screenshot_helper.rb
+- lib/spec/ui/selenium_helper.rb
+- lib/spec/ui/version.rb
+- lib/spec/ui/watir_helper.rb
+- lib/spec/ui/webapp_helper.rb
+- lib/spec/ui/win32screenshot_not_installed.png
+- lib/spec/ui/wrong_win32screenshot.png
+- examples/selenium/Rakefile
+- examples/selenium/README.txt
+- examples/selenium/spec/google/find_rspecs_homepage_spec.rb
+- examples/selenium/spec/spec_helper.rb
+- examples/watir/Rakefile
+- examples/watir/README.txt
+- examples/watir/spec/google/find_rspecs_homepage_spec.rb
+- examples/watir/spec/spec_helper.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: