rwebunit 0.2.0 → 0.7.2

data/lib/rwebunit/web_tester.rb

@@ -3,408 +3,374 @@
 #* Distributed open-source, see full license in MIT-LICENSE
 #***********************************************************
 
-require 'watir/watir_simple.rb'
-require 'runit/assert'
-
-module RWebUnit
-
-   ##
-   #  Wrapping WATIR and provide assertions
-   #
-   class WebTester
-      include Watir::Simple
-      include RUNIT::Assert
-
-      attr_accessor :test_context
-
-      def initialize
-         @test_context = TestContext.new
-      end
-
-      def beginAt(relativeURL)
-         url = @test_context.base_url  + relativeURL
-         new_browser_at(url) # create @@browser
-      end
-
-      def closeBrowser
-         begin
-            close_browser
-         rescue
-         end
-      end
-
-      def browser_opened?
-         begin
-            @@browser != nil
-         rescue => e
-            return false
-         end
-      end
-
-      def goBack
-         go_back()
-      end
-
-      def goForward
-         go_forward()
-      end
-
-      def gotoPage(page)
-         navigate_to(page)
-      end
-
-      # assertions
-      def assertTitleEquals(title)
-         assert_equals(title, html_title())
-      end
-
-      # text fields
-      def setFormElement(elementName, elementValue)
-         enter_text_into_field_with_name(elementName, elementValue)
-      end
-      alias enterText setFormElement
-
-      def assertTextPresentInTextField(textfieldName, text, msg = nil)
-         assert_text_in_field(textfieldName, text, msg)
-      end
-
-      #links
-      def clickLink(linkId)
-         click_link_with_id(linkId)
-      end
-
-      def clickLinkWithText(linkText)
-         click_link_with_text(linkText)
-      end
-
-      def assertLinkPresentWithExactText(linkText)
-         html_links.each { |link|
-            return if linkText == link.text
-         }
-         fail( "can't find the link with text: #{linkText}")
-      end
-
-      def assertLinkNotPresentWithExactText(linkText)
-         html_links.each { |link|
-            assert(linkText != link.text, "unexpected link (exact): #{linkText} found")
-         }
-      end
-
-      def assertLinkPresentWithText(linkText)
-         html_links.each { |link|
-            return if link.text.include?(linkText)
-         }
-         fail( "can't find the link containing text: #{linkText}")
-      end
-
-      def assertLinkNotPresentWithText(linkText)
-         html_links.each { |link|
-            assert(!link.Text.include?(linkText), "unexpected link containing: #{linkText} found")
-         }
-      end
-
-
-      ##
-      # buttons
-
-      # submit first submit button
-      def submit(buttonName = nil)
-         if (buttonName.nil?) then
-            html_buttons.each { |button|
-               next if button.type != 'submit'
-               button.click
-               return
-            }
-         else
-            click_button_with_name(buttonName)
-         end
-      end
-
-      def clickButton(buttonId)
-         click_button_with_id(buttonId)
-      end
-
-      def clickButtonWithCaption(caption)
-         click_button_with_caption(caption)
-      end
-
-      def clickButtonWithValue(value)
-         click_button_with_value(value)
-      end
-
-      def assertButtonNotPresent(buttonId)
-         html_buttons.each { |button|
-            assert(button.id != buttonId, "unexpected button id: #{buttonId} found")
-         }
-      end
-
-      def assertButtonNotPresentWithText(text)
-         html_buttons.each { |button|
-            assert(button.value != text, "unexpected button id: #{text} found")
-         }
-      end
-
-      def assertButtonPresent(buttonID)
-         html_buttons.each { |button|
-            return if buttonID == button.id
-         }
-         assert(false, "can't find the button with id: #{buttonID}")
-      end
-
-      def assertButtonPresentWithText(buttonText)
-         html_buttons.each { |button|
-            return if buttonText == button.value
-         }
-         assert(false, "can't find the button with text: #{buttonText}")
-      end
-
-      # checkbox
-      def checkCheckbox(checkBoxName)
-         @@browser.checkbox(:name, checkBoxName).set
-      end
-
-      def uncheckCheckbox(checkBoxName)
-         @@browser.checkbox(:name, checkBoxName).clear
-      end
-
-      def assertCheckboxNotSelected(checkBoxName)
-         html_checkboxes.each { |checkbox|
-            if (checkbox.name == checkBoxName) then
-               assert(!checkbox.isSet?, "Checkbox #{checkBoxName} checked unexpected")
-            end
-         }
-      end
-
-      def assertCheckboxSelected(checkBoxName)
-         html_checkboxes.each { |checkbox|
-            if (checkbox.name == checkBoxName) then
-               assert(checkbox.isSet?, "Checkbox #{checkBoxName} not checked")
-            end
-         }
-      end
-
-      # combo box
-      def selectOption(selectName, option)
-         @@browser.select_from_combobox_with_name(selectName, option)
-      end
-
-      def assertOptionValueNotPresent(selectName, optionValue)
-         html_selects.each { |select|
-            continue unless select.name == selectName
-            select.o.each do |option| # items in the list
-               assert(!(option.value == optionValue), "unexpected select option: #{optionValue} for #{selectName} found")
-            end
-         }
-      end
-
-      def assertOptionNotPresent(selectName, optionLabel)
-         html_selects.each { |select|
-            next unless select.name == selectName
-            select.o.each do |option| # items in the list
-               assert(!(option.text == optionLabel), "unexpected select option: #{optionLabel} for #{selectName} found")
-            end
-         }
-      end
-
-
-      def assertOptionValuePresent(selectName, optionValue)
-         html_selects.each { |select|
-            next unless select.name == selectName
-            select.o.each do |option| # items in the list
-               return if option.value == optionValue
-            end
-         }
-         assert(false, "can't find the combob box with value: #{optionValue}")
-      end
-
-      def assertOptionPresent(selectName, optionLabel)
-         html_selects.each { |select|
-            next unless select.name == selectName
-            select.o.each do |option| # items in the list
-               return if option.text == optionLabel
-            end
-         }
-         assert(false, "can't find the combob box: #{selectName} with value: #{optionLabel}")
-      end
-
-      def assertOptionEquals(selectName, optionLabel)
-         html_selects.each { |select|
-            next unless select.name == selectName
-            select.o.each do |option| # items in the list
-               if (option.text == optionLabel) then
-                  assert_equal(select.value, option.value, "Select #{selectName}'s value is not equal to expected option label: '#{optionLabel}'")
-               end
-            end
-         }
-      end
-
-
-      def assertOptionValueEquals(selectName, optionValue)
-         html_selects.each { |select|
-            next unless select.name == selectName
-            assert_equal(select.value, optionValue, "Select #{selectName}'s value is not equal to expected: '#{optionValue}'")
-         }
-      end
-
-
-      #radio
-
-      # radioGroup is the name field, radio options 'value' field
-      def assertRadioOptionNotPresent(radioGroup, radioOption)
-         html_radios.each { |radio|
-            if (radio.name == radioGroup) then
-               assert(!(radioOption == radio.value), "unexpected radio option: " + radioOption  + " found")
-            end
-         }
-      end
-
-      def assertRadioOptionPresent(radioGroup, radioOption)
-         html_radios.each { |radio|
-            return if (radio.name == radioGroup) and (radioOption == radio.value)
-         }
-         fail("can't find the radio option : '#{radioOption}'")
-      end
-
-      def assertRadioOptionSelected(radioGroup, radioOption)
-         html_radios.each { |radio|
-            if (radio.name == radioGroup and radioOption == radio.value) then
-               assert(radio.isSet?, "Radio button #{radioGroup}-[#{radioOption}] not checked")
-            end
-         }
-      end
-
-      def assertRadioOptionNotSelected(radioGroup, radioOption)
-         html_radios.each { |radio|
-            if (radio.name == radioGroup and radioOption == radio.value) then
-               assert(!radio.isSet?, "Radio button #{radioGroup}-[#{radioOption}] checked unexpected")
-            end
-         }
-      end
-
-      # the method is protected in JWebUnit
-      def clickRadioOption(radioGroup, radioOption)
-         html_radios.each { |radio|
-            if (radio.name == radioGroup and radioOption == radio.value) then
-               radio.set
-            end
-         }
-      end
-
-      #text
-      def assertTextPresent(text)
-         assert((html_body().include? text), 'expected text: ' + text + ' not found')
-      end
-
-      def assertTextNotPresent(text)
-         assert(!(html_body().include? text), 'expected text: ' + text + ' found')
-      end
-
-
-      def assertTextInTable(tableId, text)
-         elem = @@browser.document.getElementById(tableId)
-         assert_not_nil(elem, "tableId #{tableId} not exists")
-         assert_equal(elem.tagName, "TABLE")
-         puts elem.innerHTML if $DEBUG
-         assert(elem.innerHTML.include?(text), "the text #{text} not found in table #{tableId}")
-      end
-
-      def assertTextNotInTable(tableId, text)
-         elem = @@browser.document.getElementById(tableId)
-         assert_equal(elem.name.uppercase, "TABLE")
-         assert_not_nil(elem, "tableId #{tableId} not exists")
-         assert(!elem.innerHTML.include?(text), "unexpected text #{text} found in table #{tableId}")
-      end
-
-      def assertElementPresent(elementID)
-         assert_not_nil(@@browser.document.getElementById(elementID), "element with id #{elementID} not found")
-      end
-
-      def assertElementNotPresent(elementID)
-         assert_nil(@@browser.document.getElementById(elementID), "unexpected element with id #{elementID} found")
-      end
-
-      def assertTextInElement(elementID, text)
-         assertElementPresent(elementID)
-         elem = @@browser.document.getElementById(elementID)
-         assert_not_nil(elem.innerText, "element #{elementID} has no text")
-         assert(elem.innerText.include?(text), "the text #{text} not found in element #{elementID}")
-      end
-
-      def getElementValue(elementId)
-         assertElementPresent(elementId)
-         elem = @@browser.document.getElementById(elementId)
-         elem_val = elem.invoke('innerText')
-      end
-
-      # new API
-      def getHtmlInElement(elementId)
-         elem = @@browser.document.getElementById(elementId)
-         assert_not_nil(elem, "HTML element: #{elementId} not exists")
-         elem.innerHTML
-      end
-
-      def getElementById(elementId)
-         elem = @@browser.document.getElementById(elementId)
-      end
-
-
-      # ---
-      # For deubgging
-      # ---
-      def dumpResponse(stream = nil)
-         if stream.nil?
-            puts html_body # std out
-         else
-            stream.puts html_body
-         end
-      end
-
-      private
-      def html_body
-         @@browser.html()
-      end
-
-      def html_title
-         @@browser.document.title
-      end
-
-      def html_links
-         @@browser.links
-      end
-
-      def html_buttons
-         @@browser.buttons
-      end
-
-      def html_selects
-         @@browser.select_lists
-      end
-
-      def html_checkboxes
-         @@browser.checkboxes
-      end
-
-      def html_radios
-         @@browser.radios
-      end
-
-      def assert_equals(expected, actual, msg=nil)
-         assert(expected == actual, (msg.nil?) ? "Expected: #{expected} diff from actual: #{actual}" : msg)
-      end
-      alias assert_equal assert_equals
+begin
+  require 'watir'
+  require 'watir/contrib/enabled_popup'
+  require 'watir/close_all'
+  $watir_loaded = true
+rescue LoadError => e
+  $watir_loaded = false
+end
 
-      def assert_nil(actual, msg="")
-         assert(actual.nil?, msg)
-      end
+begin
+  require "firewatir";
+  $firewatir_loaded = true
+rescue LoadError => e
+  $firewatir_loaded = false
+end
 
-      def assert_not_nil(actual, msg="")
-         assert(!actual.nil?, msg)
-      end
+raise "You have must at least Watir or Firewatir installed" unless $watir_loaded || $firewatir_loaded
 
-      def fail(message)
-         assert(false, message)
-      end
+module RWebUnit
 
-   end
+  ##
+  #  Wrapping WATIR and provide *assertions*
+  #
+  class WebTester
+
+    attr_accessor :test_context
+
+    def initialize(base_url = nil, options = {})
+      default_options = {:speed => "fast",
+        :visible => true,
+        :highlight_colour => 'yellow',
+      :close_others => true}
+      options = default_options.merge options
+      @test_context = TestContext.new base_url if base_url
+
+      if (options[:firefox] &&  $firewatir_loaded) || ($firewatir_loaded and !$watir_loaded)
+        @@browser = FireWatir::Firefox.start(base_url)
+      elsif $watir_loaded 
+        @@browser = Watir::IE.new
+        if options[:speed] == 'slow' then @@browser.set_slow_speed  else @@browser.set_fast_speed end
+        @@browser.activeObjectHighLightColor = options[:highlight_colour]
+        @@browser.visible = options[:visible]
+        @@browser.close_others if options[:close_others]
+      else 
+        raise "rWebUnit initialiazation error, most likely Watir or Firewatir not present"
+      end
+    end
+
+    ##
+    #  Delegate to Watir
+    #
+    def area(*args); @@browser.area(*args); end
+    def button(*args);  @@browser.button(*args); end
+    def cell(*args); @@browser.cell(*args); end
+    alias td cell
+    def checkbox(*args);  @@browser.checkbox(*args); end
+    alias check_box checkbox	# seems watir doc is wrong, checkbox not check_box
+    def div(*args); @@browser.div(*args); end
+    def form(*args);  @@browser.form(*args); end
+    def frame(*args);  @@browser.frame(*args); end
+    def h1(*args); @@browser.h1(*args); end
+    def h2(*args); @@browser.h2(*args); end
+    def h3(*args); @@browser.h3(*args); end
+    def h4(*args); @@browser.h4(*args); end
+    def h5(*args); @@browser.h5(*args); end
+    def h6(*args); @@browser.h6(*args); end
+    def hidden(*args); @@browser.hidden(*args); end
+    def image(*args);  @@browser.image(*args); end
+    def li(*args);  @@browser.li(*args); end
+    def link(*args);  @@browser.link(*args); end
+    def map(*args);  @@browser.map(*args); end
+    def pre(*args);  @@browser.pre(*args); end
+    def radio(*args);  @@browser.radio(*args); end
+    def row(*args);  @@browser.row(*args); end
+    alias tr row
+    def select_list(*args);  @@browser.select_list(*args); end
+    def span(*args); @@browser.span(*args); end
+    def table(*args); @@browser.table(*args); end
+    def text_field(*args);  @@browser.text_field(*args); end
+
+    def paragraph(*args);  @@browser.paragraph(*args); end
+    def file_field(*args);  @@browser.file_field(*args); end
+    def label(*args); @@browser.span(*args); end
+
+    def contains_text(text); @@browser.contains_text(text); end
+
+    def page_source
+      @@browser.html()
+      #@@browser.document.body
+    end
+    alias html_body page_source
+
+    def page_title
+      if is_firefox?
+        @@browser.title
+      else
+        @@browser.document.title
+      end
+    end
+
+    def links; @@browser.links; end
+    def buttons; @@browser.buttons; end
+    def select_lists; @@browser.select_lists; end
+    def checkboxes; @@browser.checkboxes; end
+    def radios; @@browser.radios; end
+    def text_fields; @@browser.text_fields; end
+
+    # current url
+    def url; @@browser.url; end
+
+    def base_url=(new_base_url)
+      if @test_context
+        @test_conext.base_url = new_base_url
+        return
+      end
+      @test_context = TestContext.new base_url
+    end
+
+    def is_firefox?
+      begin
+        @@browser.class == FireWatir::Firefox
+      rescue => e
+        return false
+      end
+    end
+
+    # Close the browser window.  Useful for automated test suites to reduce
+    # test interaction.
+    def close_browser
+      if is_firefox? then
+        puts "[debug] about to close firefox"
+        @@browser.close
+      else
+        @@browser.getIE.quit
+      end
+      sleep 2
+    end
+
+    def self.close_all_browsers
+      if is_firefox? then
+        @@browser.close_all
+      else
+        Watir::IE.close_all
+      end
+    end
+
+    def full_url(relative_url)
+      if @test_context && @test_context.base_url
+        @test_context.base_url + relative_url
+      else
+        relative_url
+      end
+    end
+
+    def begin_at(relative_url)
+      @@browser.goto full_url(relative_url)
+    end
+
+    def browser_opened?
+      begin
+        @@browser != nil
+      rescue => e
+        return false
+      end
+    end
+
+    # Some browsers (i.e. IE) need to be waited on before more actions can be
+    # performed.  Most action methods in Watir::Simple already call this before
+    # and after.
+    def wait_for_browser
+      @@browser.waitForIE unless is_firefox?
+    end
+
+
+    # A convenience method to wait at both ends of an operation for the browser
+    # to catch up.
+    def wait_before_and_after
+      wait_for_browser
+      yield
+      wait_for_browser
+    end
+
+
+    def go_back;  @@browser.back; end
+    def go_forward; @@browser.forward; end
+    def goto_page(page); @@browser.goto full_url(page); end
+    def refresh; @@browser.refresh; end
+
+    def focus; @@browser.focus; end
+    def close_others; @@browser.close_others; end
+
+    # text fields
+    def enter_text_into_field_with_name(name, text)
+      wait_before_and_after { text_field(:name, name).set(text) }
+    end
+    alias set_form_element enter_text_into_field_with_name
+    alias enter_text enter_text_into_field_with_name
+
+    #links
+    def click_link(link_id)
+      wait_before_and_after { link(:id, link_id).click }
+    end
+    alias click_link_with_id click_link
+
+    def click_link_with_text(text)
+      wait_before_and_after { link(:text, text).click }
+    end
+
+    ##
+    # buttons
+
+    def click_button_with_id(id)
+      wait_before_and_after { button(:id, id).click }
+    end
+    alias click_button click_button_with_id
+
+    def click_button_with_name(name)
+      wait_before_and_after { button(:name, name).click }
+    end
+
+    def click_button_with_caption(caption)
+      wait_before_and_after { button(:caption, caption).click }
+    end
+
+    def click_button_with_value(value)
+      wait_before_and_after { button(:value, value).click }
+    end
+
+    def select_option(selectName, option)
+      #      @@browser.selectBox(:name, selectName).select(option)
+      select_list(:name, selectName).select(option)
+    end
+
+    # submit first submit button
+    def submit(buttonName = nil)
+      if (buttonName.nil?) then
+        buttons.each { |button|
+          next if button.type != 'submit'
+          button.click
+          return
+        }
+      else
+        click_button_with_name(buttonName)
+      end
+    end
+
+    # checkbox
+    def check_checkbox(checkBoxName, values=nil)
+      if values
+        values.class == Array ? arys = values : arys = [values]
+        arys.each {|cbx_value|
+          checkbox(:name, checkBoxName, cbx_value).set
+        }
+      else
+        checkbox(:name, checkBoxName).set
+      end
+    end
+
+    def uncheck_checkbox(checkBoxName, values = nil)
+      if values
+        values.class == Array ? arys = values : arys = [values]
+        arys.each {|cbx_value|
+          checkbox(:name, checkBoxName, cbx_value).clear
+        }
+      else
+        checkbox(:name, checkBoxName).clear
+      end
+    end
+
+
+    # the method is protected in JWebUnit
+    def click_radio_option(radio_group, radio_option)
+      radio(:name, radio_group, radio_option).set
+    end
+
+    def clear_radio_option(radio_group, radio_option)
+      radio(:name, radio_group, radio_option).clear
+    end
+
+    def element_by_id(elem_id)
+      elem = @@browser.document.getElementById(elem_id)
+    end
+
+    def element_value(elementId)
+      if is_firefox? then
+        elem = element_by_id(elementId)
+        elem ? elem.invoke('innerText') : nil
+      else
+        elem = element_by_id(elementId)
+        elem ? elem.invoke('innerText') : nil
+      end
+    end
+
+    def element_source(elementId)
+      elem = element_by_id(elementId)
+      assert_not_nil(elem, "HTML element: #{elementId} not exists")
+      elem.innerHTML
+    end
+
+    def select_file_for_upload(file_field, file_path)
+      file_field(:name, file_field).set(file_path)
+    end
+
+    def start_window(url = nil); @@browser.start_window(url); end
+    def self.attach_browser(how, what)
+      if is_firefox? then
+        raise "not implemented yet"
+      else
+        Watir::IE.attach(how, what)
+      end
+    end
+
+    # Attach a Watir::IE instance to a popup window.
+    #
+    # Typical usage
+    #   new_popup_window(:url => "http://www.google.com/a.pdf")
+    def new_popup_window(options, browser = "ie")
+      if is_firefox?
+        raise "not implemented"
+      else
+        Watir::IE.attach(:url, options[:url])
+      end
+    end
+
+    # ---
+    # For deubgging
+    # ---
+    def dump_response(stream = nil)
+      if stream.nil?
+        puts page_source # std out
+      else
+        stream.puts page_source
+      end
+    end
+
+    # A Better Popup Handler using the latest Watir version. Posted by Mark_cain@rl.gov
+    #
+    # http://wiki.openqa.org/display/WTR/FAQ#FAQ-HowdoIattachtoapopupwindow%3F
+    #
+    def start_clicker( button , waitTime= 9, user_input=nil)
+      # get a handle if one exists
+      hwnd = @@browser.enabled_popup(waitTime)
+      if (hwnd)  # yes there is a popup
+        w = WinClicker.new
+        if ( user_input )
+          w.setTextValueForFileNameField( hwnd, "#{user_input}" )
+        end
+        # I put this in to see the text being input it is not necessary to work
+        sleep 3
+        # "OK" or whatever the name on the button is
+        w.clickWindowsButton_hwnd( hwnd, "#{button}" )
+        #
+        # this is just cleanup
+        w = nil
+      end
+    end
+
+    # return underlying browser
+    def ie
+      raise "can't call this as it is configured to use Firefox" if is_firefox?
+      @@browser
+    end
+
+    def firefox
+      raise "can't call this as it is configured to use IE" unless is_firefox?
+      @@browser
+    end
+
+  end
 
 end