rwebspec-mechanize 0.2.1

data/CHANGELOG

@@ -0,0 +1,12 @@
+0.2
+  - upgrade rwebspec 4
+
+0.1.4
+ - send different socket
+
+0.1.3
+ - remove dependeny on Santize, using Nokogiri for get html text view
+
+0.1.2
+ - click_button_with_id default to submit the form if the button not found
+

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2006-2008 Zhimin Zhan, zhimin@zhimin.com
+
+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

@@ -0,0 +1,41 @@
+
+RWebSpec wraps the popular web testing framework WATIR with RSpec Syntax to provide better easy to read automated web test cases. By using TestWise/Watir recorder, the RWebSpec test scripts can be recorded in Firefox. TestWise, The Next-Generation Functional Testing IDE,  makes editing/executing test cases with ease. 
+
+Sample RWebSpec Test:
+
+load File.dirname(__FILE__) + '/test_helper.rb'
+
+specification "User Profile" do
+  include TestHelper
+
+  before(:all) do
+    open_browser("http://demo.adminwise.com")
+    reset_database
+  end
+
+  after(:all) do
+    fail_safe { logout }
+  end
+
+  story "[8] User can change password" do
+    login_as("bob", "password")
+    click_link("Profile")
+    click_link("Change password")
+    
+    password_change_page = expect_page PasswordChangePage
+    password_change_page.enter_current("password")
+    password_change_page.enter_new("newpass")
+    password_change_page.enter_confirm("newpass")
+    password_change_page.click_button("Change")
+    
+    logout
+    login_as("bob", "newpass")
+    assert_link_present_with_text("Profile") # login Ok
+  end
+
+end
+
+
+
+TestWise Homepage: http://www.testwisely.com/en/testwise
+  

data/Rakefile

@@ -0,0 +1,102 @@
+require 'rubygems'
+require 'rspec/core/rake_task'
+# require 'rake/rdoctask'
+require 'rake/gempackagetask'
+# require 'rdoc' # require rdoc 2
+# gem 'darkfish-rdoc'
+# require 'darkfish-rdoc'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+#require 'rwebspec'
+
+desc "Default task"
+task :default => [ :clean, :spec, :rdoc, :chm, :gem]
+
+desc "Continous build"
+task :build => [:clean, :spec]
+
+desc "Clean generated files"
+task :clean do
+  rm_rf 'pkg'
+  rm_rf 'doc'
+  rm_rf 'chm'
+end
+
+desc 'Run all specs'
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ['--format', 'specdoc', '--colour']
+  # t.libs = ["lib", "server/lib" ]
+  t.pattern = Dir['spec/**/*_spec.rb'].sort
+end
+
+# Generate the RDoc documentation
+# Rake::RDocTask.new { |rdoc|
+#   rdoc.rdoc_dir = 'doc'
+#   rdoc.title = 'rWebUnit'
+#   rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+#   rdoc.rdoc_files.include('README')
+#   rdoc.rdoc_files.include('lib/rwebspec.rb')
+#   rdoc.rdoc_files.include('lib/rwebspec/*.rb')
+# }
+
+=begin
+# using DarkFish - http://deveiate.org/projects/Darkfish-Rdoc/
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = 'RWebSpec-Mechanize'
+  rdoc.rdoc_files.include('lib/rwebspec.rb')
+  rdoc.rdoc_files.include('lib/rwebspec/*.rb')  
+  rdoc.rdoc_files.include('lib/extensions/*.rb')  
+  rdoc.rdoc_files.delete("lib/rwebspec/web_testcase.rb")
+  rdoc.rdoc_files.delete("lib/rwebspec/checkJSDialog.rb")
+  rdoc.options += [
+        '-SHN',
+        '-f', 'darkfish',  # This is the important bit
+  ]
+end
+
+Rake::RDocTask.new("chm") do |rdoc|
+  rdoc.rdoc_dir = 'chm'
+  rdoc.title = 'RWebSpec-Mechanize'
+  rdoc.rdoc_files.include('lib/rwebspec.rb')
+  rdoc.rdoc_files.include('lib/rwebspec/*.rb')
+  rdoc.rdoc_files.delete("lib/rwebspec/web_testcase.rb")
+  rdoc.rdoc_files.delete("lib/rwebspec/checkJSDialog.rb")
+    rdoc.options += [
+        '-SHN',
+        '-f', 'chm',  # This is the important bit
+      ]
+end
+
+=end
+
+spec = Gem::Specification.new do |s|
+  s.platform= Gem::Platform::RUBY
+  s.name = "rwebspec-mechanize"
+  s.version = "0.2.1"
+  s.summary = "Web application load testing specification in Ruby"
+  s.description = "Load test specification for web applications in RSpec syntax and Watir"
+
+  s.author  = "Zhimin Zhan"
+  s.email   = "zhimin@agileway.com.au"
+  s.homepage= "http://github.com/zhimin/rwebspec-mechanize/tree/master"
+  s.rubyforge_project = "rwebspec-mechanize"
+
+  s.has_rdoc    = true
+  s.requirements << 'none'
+  s.require_path    = "lib"
+  s.autorequire     = "rwebspec-mechanize"
+
+  s.files = [ "Rakefile", "README", "CHANGELOG", "MIT-LICENSE" ]
+  s.files = s.files + Dir.glob( "lib/**/*" )
+  s.files = s.files + Dir.glob( "test/**/*" )
+  s.files = s.files + Dir.glob( "sample/**/*")
+  s.files = s.files + Dir.glob( "docs/**/*" )
+  s.add_dependency(%q<rspec>, ["2.10.0"])
+  s.add_dependency("mechanize", ">= 2.5")
+  s.add_dependency("nokogiri")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+end

data/lib/rwebspec-mechanize/assert.rb

@@ -0,0 +1,388 @@
+require 'test/unit/assertions'
+
+module RWebSpec
+  module Mechanize
+  module Assert
+    include Test::Unit::Assertions
+
+    def assert_not(condition, msg = "")
+      perform_assertion { assert(!condition, msg) }
+    end
+
+    def assert_nil(actual, msg="")
+      perform_assertion { assert(actual.nil?, msg) }
+    end
+
+    def assert_not_nil(actual, msg="")
+      perform_assertion { assert(!actual.nil?, msg) }
+    end
+
+    def fail(message)
+      perform_assertion { assert(false, message) }
+    end
+
+    # assertions
+    def assert_title_equals(title)
+      assert_equals(title, @web_browser.page_title)
+    end
+
+    alias assert_title assert_title_equals
+
+    # Assert text present in page source (html)
+    #   assert_text_in_page_source("<b>iTest2</b>  Cool") # <b>iTest2</b>  Cool
+    def assert_text_in_page_source(text)
+      perform_assertion { assert((@web_browser.page_source.include? text), 'expected html: ' + text + ' not found') }
+    end
+
+    # Assert text not present in page source (html)
+    #   assert_text_not_in_page_source("<b>iTest2</b>  Cool") # <b>iTest2</b>  Cool
+    def assert_text_not_in_page_source(text)
+      perform_assertion { assert(!(@web_browser.page_source.include? text), 'expected html: ' + text + ' found') }
+    end
+
+    # Assert text present in page source (html)
+    #   assert_text_present("iTest2 Cool") # <b>iTest2</b>  Cool
+    def assert_text_present(text)
+      perform_assertion { assert((@web_browser.text.include? text), 'expected text: ' + text + ' not found') }
+    end
+
+    # Assert text not present in page source (html)
+    #   assert_text_not_present("iTest2 Cool") # <b>iTest2</b>  Cool
+    def assert_text_not_present(text)
+      perform_assertion { assert(!(@web_browser.text.include? text), 'expected text: ' + text + ' found') }
+    end
+
+
+    ##
+    # Link
+
+    # Assert a link with specified text (exact match) in the page
+    #
+    #  <a href="">Click Me</a>
+    #  assert_link_present_with_exact("Click Me") => true
+    #  assert_link_present_with_exact("Click") => false
+    #
+    def assert_link_present_with_exact(link_text)
+      @web_browser.links.each { |link|
+        return if link_text == link.text
+      }
+      fail( "can't find the link with text: #{link_text}")
+    end
+
+    def assert_link_not_present_with_exact(link_text)
+      @web_browser.links.each { |link|
+        perform_assertion { assert(link_text != link.text, "unexpected link (exact): #{link_text} found") }
+      }
+    end
+
+    # Assert a link containing specified text in the page
+    #  
+    #  <a href="">Click Me</a>
+    #  assert_link_present_with_text("Click ") # => 
+    #
+    def assert_link_present_with_text(link_text)
+      @web_browser.links.each { |link|
+        return if link.text.include?(link_text)
+      }
+      fail( "can't find the link containing text: #{link_text}")
+    end
+
+    def assert_link_not_present_with_text(link_text)
+      @web_browser.links.each { |link|
+        perform_assertion { assert(!link.text.include?(link_text), "unexpected link containing: #{link_text} found") }
+      }
+    end
+
+
+    ##
+    # Checkbox
+    def assert_checkbox_not_selected(checkbox_name)
+      @web_browser.checkboxes.each { |checkbox|
+        if (checkbox.name == checkbox_name) then
+          perform_assertion {  assert(!checkbox.isSet?, "Checkbox #{checkbox_name} is checked unexpectly") }
+        end
+      }
+    end
+
+    alias assert_checkbox_not_checked assert_checkbox_not_selected
+
+    def assert_checkbox_selected(checkbox_name)
+      @web_browser.checkboxes.each { |checkbox|
+        if (checkbox.name == checkbox_name) then
+          perform_assertion { assert(checkbox.isSet?, "Checkbox #{checkbox_name} not checked") }
+        end
+      }
+    end
+
+    alias assert_checkbox_checked assert_checkbox_selected
+
+    ##
+    # select
+    def assert_option_value_not_present(select_name, option_value)
+      @web_browser.select_lists.each { |select|
+        continue unless select.name == select_name
+        select.o.each do |option| # items in the list
+          perform_assertion {  assert(!(option.value == option_value), "unexpected select option: #{option_value} for #{select_name} found") }
+        end
+      }
+    end
+
+    alias assert_select_value_not_present assert_option_value_not_present
+
+    def assert_option_not_present(select_name, option_label)
+      @web_browser.select_lists.each { |select|
+        next unless select.name == select_name
+        select.o.each do |option| # items in the list
+          perform_assertion {  assert(!(option.text == option_label), "unexpected select option: #{option_label} for #{select_name} found") }
+        end
+      }
+    end
+
+    alias assert_select_label_not_present assert_option_not_present
+
+    def assert_option_value_present(select_name, option_value)
+      @web_browser.select_lists.each { |select|
+        next unless select.name == select_name
+        select.o.each do |option| # items in the list
+          return if option.value == option_value
+        end
+      }
+      fail("can't find the combo box with value: #{option_value}")
+    end
+
+    alias assert_select_value_present assert_option_value_present
+    alias assert_menu_value_present assert_option_value_present
+
+    def assert_option_present(select_name, option_label)
+      @web_browser.select_lists.each { |select|
+        next unless select.name == select_name
+        select.o.each do |option| # items in the list
+          return if option.text == option_label
+        end
+      }
+      fail("can't find the combob box: #{select_name} with value: #{option_label}")
+    end
+
+    alias assert_select_label_present assert_option_present
+    alias assert_menu_label_present assert_option_present
+
+    def assert_option_equals(select_name, option_label)
+      @web_browser.select_lists.each { |select|
+        next unless select.name == select_name
+        select.o.each do |option| # items in the list
+          if (option.text == option_label) then
+            perform_assertion { assert_equal(select.value, option.value, "Select #{select_name}'s value is not equal to expected option label: '#{option_label}'") }
+          end
+        end
+      }
+    end
+
+    alias assert_select_label assert_option_equals
+    alias assert_menu_label assert_option_equals
+
+    def assert_option_value_equals(select_name, option_value)
+      @web_browser.select_lists.each { |select|
+        next unless select.name == select_name
+        perform_assertion {  assert_equal(select.value, option_value, "Select #{select_name}'s value is not equal to expected: '#{option_value}'") }
+      }
+    end
+
+    alias assert_select_value assert_option_value_equals
+    alias assert_menu_value assert_option_value_equals
+
+    ##
+    # radio
+
+    # radio_group is the name field, radio options 'value' field
+    def assert_radio_option_not_present(radio_group, radio_option)
+      @web_browser.radios.each { |radio|
+        if (radio.name == radio_group) then
+          perform_assertion {  assert(!(radio_option == radio.value), "unexpected radio option: " + radio_option  + " found") }
+        end
+      }
+    end
+
+    def assert_radio_option_present(radio_group, radio_option)
+      @web_browser.radios.each { |radio|
+        return if (radio.name == radio_group) and (radio_option == radio.value)
+      }
+      fail("can't find the radio option : '#{radio_option}'")
+    end
+
+    def assert_radio_option_selected(radio_group, radio_option)
+      @web_browser.radios.each { |radio|
+        if (radio.name == radio_group and radio_option == radio.value) then
+          perform_assertion { assert(radio.isSet?, "Radio button #{radio_group}-[#{radio_option}] not checked") }
+        end
+      }
+    end
+
+    alias assert_radio_button_checked assert_radio_option_selected
+    alias assert_radio_option_checked assert_radio_option_selected
+
+    def assert_radio_option_not_selected(radio_group, radio_option)
+      @web_browser.radios.each { |radio|
+        if (radio.name == radio_group and radio_option == radio.value) then
+          perform_assertion {  assert(!radio.isSet?, "Radio button #{radio_group}-[#{radio_option}] checked unexpected") }
+        end
+      }
+    end
+
+    alias assert_radio_button_not_checked assert_radio_option_not_selected
+    alias assert_radio_option_not_checked assert_radio_option_not_selected
+
+    ##
+    # Button
+    def assert_button_not_present(button_id)
+      @web_browser.buttons.each { |button|
+        perform_assertion { assert(button.id != button_id, "unexpected button id: #{button_id} found") }
+      }
+    end
+
+    def assert_button_not_present_with_text(text)
+      @web_browser.buttons.each { |button|
+        perform_assertion { assert(button.value != text, "unexpected button id: #{text} found") }
+      }
+    end
+
+    def assert_button_present(button_id)
+      @web_browser.buttons.each { |button|
+        return if button_id == button.id
+      }
+      fail("can't find the button with id: #{button_id}")
+    end
+
+    def assert_button_present_with_text(button_text)
+      @web_browser.buttons.each { |button|
+        return if button_text == button.value
+      }
+      fail("can't find the button with text: #{button_text}")
+    end
+
+
+    def assert_equals(expected, actual, msg=nil)
+      perform_assertion { assert(expected == actual, (msg.nil?) ? "Expected: #{expected} diff from actual: #{actual}" : msg) }
+    end
+
+
+    # Check a HTML element exists or not
+    # Example:
+    #  assert_exists("label", "receipt_date")
+    #  assert_exists(:span, :receipt_date)
+    def assert_exists(tag, element_id)
+      perform_assertion { assert(eval("#{tag}(:id, '#{element_id.to_s}').exists?"), "Element '#{tag}' with id: '#{element_id}' not found") }
+    end
+
+    alias assert_exists? assert_exists
+    alias assert_element_exists assert_exists
+
+    def assert_not_exists(tag, element_id)
+      perform_assertion {  assert_not(eval("#{tag}(:id, '#{element_id.to_s}').exists?"), "Unexpected element'#{tag}' + with id: '#{element_id}' found")}
+    end
+
+    alias assert_not_exists? assert_not_exists
+    alias assert_element_not_exists? assert_not_exists
+
+
+    # Assert tag with element id is visible?, eg. 
+    #   assert_visible(:div, "public_notice")
+    #   assert_visible(:span, "public_span")
+    def assert_visible(tag, element_id)
+      perform_assertion { assert(eval("#{tag}(:id, '#{element_id.to_s}').visible?"), "Element '#{tag}' with id: '#{element_id}' not visible") }
+    end
+
+    # Assert tag with element id is hidden?, example 
+    #   assert_hidden(:div, "secret")
+    #   assert_hidden(:span, "secret_span")
+    def assert_hidden(tag, element_id)
+      perform_assertion { assert(!eval("#{tag}(:id, '#{element_id.to_s}').visible?"), "Element '#{tag}' with id: '#{element_id}' is visible") }
+    end
+
+    alias assert_not_visible assert_hidden
+
+
+    # Assert given text appear inside a table (inside <table> tag like below) 
+    #
+    # <table id="t1">
+    #
+    # <tbody>
+    #   <tr id="row_1">
+    #     <td id="cell_1_1">A</td>
+    #     <td id="cell_1_2">B</td>
+    #   </tr>
+    #   <tr id="row_2">
+    #     <td id="cell_2_1">a</td>
+    #     <td id="cell_2_2">b</td>
+    #   </tr>
+    # </tbody>
+    #
+    # </table>
+    #
+    # The plain text view of above table
+    #  A B a b
+    # 
+    # Examples
+    #  assert_text_present_in_table("t1", ">A<")  # => true
+    #  assert_text_present_in_table("t1", ">A<", :just_plain_text => true)  # => false        
+    def assert_text_present_in_table(table_id, text, options = { :just_plain_text => false })
+      perform_assertion { assert(table_source(table_id, options).include?(text), "the text #{text} not found in table #{table_id}") }
+    end
+
+    alias assert_text_in_table assert_text_present_in_table
+
+    def assert_text_not_present_in_table(table_id, text, options = { :just_plain_text => false })
+      perform_assertion { assert_not(table_source(table_id, options).include?(text), "the text #{text} not found in table #{table_id}") }
+    end
+
+    alias assert_text_not_in_table assert_text_not_present_in_table
+
+    # Assert a text field (with given name) has the value
+    #
+    # <input id="tid" name="text1" value="text already there" type="text">
+    # 
+    # assert_text_field_value("text1", "text already there") => true
+    #
+    def assert_text_field_value(textfield_name, text)
+      perform_assertion { assert_equal(text, text_field(:name, textfield_name).value) }
+    end
+
+
+    #-- Not tested
+    # -----
+
+    def assert_text_in_element(element_id, text)
+      elem = element_by_id(element_id)
+      assert_not_nil(elem.innerText, "element #{element_id} has no text")
+      perform_assertion { assert(elem.innerText.include?(text), "the text #{text} not found in element #{element_id}") }
+    end
+
+    # Use 
+    #
+
+    #TODO for drag-n-drop, check the postion in list
+    #    def assert_position_in_list(list_element_id)
+    #      raise "not implemented"
+    #    end
+
+    private
+    def table_source(table_id, options)
+      elem_table = table(:id, table_id.to_s)
+      elem_table_text = elem_table.text
+      elem_table_html = is_firefox? ? elem_table.innerHTML : elem_table.html
+      table_source = options[:just_plain_text] ? elem_table_text : elem_table_html
+    end
+
+
+    def perform_assertion(&block)
+      begin
+        yield
+      rescue StandardError => e
+        # puts "[DEBUG] Assertion error: #{e}"
+        take_screenshot if $take_screenshot
+        raise e
+      end
+    end
+
+  end
+end
+end

data/lib/rwebspec-mechanize/context.rb

@@ -0,0 +1,25 @@
+#***********************************************************
+#* Copyright (c) 2006 - 2009 Zhimin Zhan.
+#* Distributed open-source, see full license in MIT-LICENSE
+#***********************************************************
+
+module RWebSpec
+  module Mechanize
+    ##
+    #  Store test optionns
+    #
+    class Context
+      attr_accessor :base_url
+
+      def initialize(base_url)
+        set_base_url(base_url)
+      end
+
+      def set_base_url(baseUrl)
+        @base_url = baseUrl
+      end
+
+    end
+
+  end
+end

data/lib/rwebspec-mechanize/extensions/firewatir_extensions.rb

@@ -0,0 +1,74 @@
+module FireWatir
+  class Firefox
+
+    @@firefox_started = false
+
+    def initialize(options = {})
+      if(options.kind_of?(Integer))
+        options = {:waitTime => options}
+      end
+
+      if(options[:profile])
+        profile_opt = "-no-remote -P #{options[:profile]}"
+      else
+        profile_opt = ""
+      end
+
+      waitTime = options[:waitTime] || 2
+
+      os = RUBY_PLATFORM
+      if RUBY_PLATFORM =~ /java/ then
+        require 'rbconfig'
+        os = Config::CONFIG['host_os']
+      end
+
+      case os
+      when /mswin/ || /mingw/
+        begin
+          # Get the path to Firefox.exe using Registry.
+          require 'win32/registry.rb'
+          path_to_bin = ""
+          Win32::Registry::HKEY_LOCAL_MACHINE.open('SOFTWARE\Mozilla\Mozilla Firefox') do |reg|
+            keys = reg.keys
+            reg1 = Win32::Registry::HKEY_LOCAL_MACHINE.open("SOFTWARE\\Mozilla\\Mozilla Firefox\\#{keys[0]}\\Main")
+            reg1.each do |subkey, type, data|
+              if(subkey =~ /pathtoexe/i)
+                path_to_bin = data
+              end
+            end
+          end
+        rescue LoadError => e
+          path_to_bin = '"C:\Program Files\Mozilla Firefox\firefox.exe"'
+        end
+
+      when /linux/i
+        path_to_bin = `which firefox`.strip
+      when /darwin/i
+        path_to_bin = '/Applications/Firefox.app/Contents/MacOS/firefox'
+      when /java/
+        raise "Error, should have set using rbconfig: #{os}"
+      end
+
+      @t = Thread.new { system("#{path_to_bin} -jssh #{profile_opt}")} unless @@firefox_started
+
+      sleep waitTime
+      begin
+        set_defaults()
+      rescue Watir::Exception::UnableToStartJSShException
+        if !@t # no new thread starting browser, try again
+          puts "Firefox with JSSH not detected after you indicated @@firefox_started"
+          @t = Thread.new { system("#{path_to_bin} -jssh #{profile_opt}")}
+          sleep waitTime
+          set_defaults
+        end
+      end
+      get_window_number()
+      set_browser_document()
+    end
+
+    def self.firefox_started=(value)
+      @@firefox_started = value
+    end
+
+  end
+end