RWebSpec::WebBrowser

Wrapping WATIR IE and FireWatir Firefox

Attributes

context[RW]

Public Class Methods

attach_browser(how, what, options={}) click to toggle source

Attach to existing browser

Usage:

WebBrowser.attach_browser(:title, "iTest2")
WebBrowser.attach_browser(:url, "http://www.itest2.com")
WebBrowser.attach_browser(:url, "http://www.itest2.com", {:browser => "Firefox", :base_url => "http://www.itest2.com"})
WebBrowser.attach_browser(:title, /agileway\.com\.au\/attachment/)  # regular expression

# File lib/rwebspec/web_browser.rb, line 622
def self.attach_browser(how, what, options={})
  default_options = {:browser => "IE"}
  options = default_options.merge(options)
  site_context = Context.new(options[:base_url]) if options[:base_url]
  if (options[:browser] == "Firefox")
    ff = FireWatir::Firefox.attach(how, what)        
    return WebBrowser.new_from_existing(ff, site_context)
  else
    return WebBrowser.new_from_existing(Watir::IE.attach(how, what), site_context)
  end
end

close_all_browsers(browser_type = :ie) click to toggle source

# File lib/rwebspec/web_browser.rb, line 337
def self.close_all_browsers(browser_type = :ie)      
                    if browser_type == :ie
    Watir::IE.close_all
  elsif browser_type == :firefox
    # raise "not supported in FireFox yet."
                            FireWatir::Firefox.new.close_all    
  end
end

is_windows?() click to toggle source

is it running in MS Windows platforms?

# File lib/rwebspec/web_browser.rb, line 722
def self.is_windows?
  RUBY_PLATFORM.downcase.include?("mswin") or RUBY_PLATFORM.downcase.include?("mingw")
end

new(base_url = nil, existing_browser = nil, options = {}) click to toggle source

# File lib/rwebspec/web_browser.rb, line 48
def initialize(base_url = nil, existing_browser = nil, options = {})
  default_options = {:speed => "zippy",
    :visible => true,
    :highlight_colour => 'yellow',
    :close_others => true
  }
  options = default_options.merge options
  @context = Context.new base_url if base_url

  case RUBY_PLATFORM
  when /java/
    # Java, maybe firewatir or celerity
    puts "Ruby java platform"
    raise "Not supported, no FireWatir or Celerity detected" unless $firewatir_loaded || $celerity_loaded
    if $firewatir_loaded && $celerity_loaded then
      # choose one out of two, :default to celerity
      if options[:firefox] then
        initialize_firefox_browser(existing_browser, base_url, options)
      else
        initialize_celerity_browser(base_url, options)
      end
    elsif $firewatir_loaded
      initialize_firefox_browser(existing_browser, base_url, options)
    else
      initialize_celerity_browser(base_url, options)
    end

  when /mswin|windows|mingw/
    raise "Not supported, no Watir or FireWatir detected" unless $watir_loaded || $firewatir_loaded
    if $firewatir_loaded && options[:firefox] then
      initialize_firefox_browser(existing_browser, base_url, options)
    else
      initialize_ie_browser(existing_browser, options)
    end
  else
    raise "Not supported, no FireWatirdetected" unless $firewatir_loaded
    initialize_firefox_browser(existing_browser, base_url, options)
  end
end

new_from_existing(underlying_browser, web_context = nil) click to toggle source

for popup windows

# File lib/rwebspec/web_browser.rb, line 159
def self.new_from_existing(underlying_browser, web_context = nil)
  return WebBrowser.new(web_context ? web_context.base_url : nil, underlying_browser, {:close_others => false})
end

reuse(base_url, options) click to toggle source

# File lib/rwebspec/web_browser.rb, line 146
def self.reuse(base_url, options)
  if self.is_windows? && $ITEST2_BROWSER != "Firefox"
    Watir::IE.each do |browser_window|
      return WebBrowser.new(base_url, browser_window, options)
    end
    #puts "no browser instance found"
    WebBrowser.new(base_url, nil, options)
  else
    WebBrowser.new(base_url, nil, options)
  end
end

Public Instance Methods

area(*args) click to toggle source

Wrapp of Watir’s area to support Firefox and Watir

Note: FireWatir does not support area directly, treat it as text_field

# File lib/rwebspec/web_browser.rb, line 181
def area(*args)
  if is_firefox?
    text_field(*args)
  else
    @browser.send("area", *args)
  end
end

base_url=(new_base_url) click to toggle source

# File lib/rwebspec/web_browser.rb, line 305
def base_url=(new_base_url)
  if @context
    @conext.base_url = new_base_url
    return
  end
  @context = Context.new base_url
end

begin_at(relative_url) click to toggle source

# File lib/rwebspec/web_browser.rb, line 354
def begin_at(relative_url)
  @browser.goto full_url(relative_url)
end

browser_opened?() click to toggle source

# File lib/rwebspec/web_browser.rb, line 358
def browser_opened?
  begin
    @browser != nil
  rescue => e
    return false
  end
end

celerity() click to toggle source

# File lib/rwebspec/web_browser.rb, line 693
def celerity
  raise "can't call this as it is configured to use Celerity" unless RUBY_PLATFORM =~ /java/
  @browser
end

check_checkbox(checkBoxName, values=nil) click to toggle source

Check a checkbox Usage:

check_checkbox("agree")
check_checkbox("agree", "true")

# File lib/rwebspec/web_browser.rb, line 514
def check_checkbox(checkBoxName, values=nil)
  if values
    values.class == Array ? arys = values : arys = [values]
    arys.each {|cbx_value|
                                    if Watir::VERSION =~ /^1/ then             
            checkbox(:name, checkBoxName, cbx_value).set                                         
                                    else
            checkbox(:name => checkBoxName, :value => cbx_value).set
                                    end
    }
  else
    checkbox(:name, checkBoxName).set
  end
end

clear_radio_button(radio_group, radio_option) click to toggle source

Alias for: clear_radio_option

clear_radio_option(radio_group, radio_option) click to toggle source

Clear a radio button

Usage:
  click_radio_option("country", "Australia")

# File lib/rwebspec/web_browser.rb, line 564
def clear_radio_option(radio_group, radio_option)
                    if Watir::VERSION =~ /^2/ then
    radio(:name => radio_group, :value => radio_option).clear                               
                    else
    radio(:name, radio_group, radio_option).clear
                    end
end

Also aliased as: clear_radio_button

click_button(caption, opts={}) click to toggle source

Alias for: click_button_with_caption

click_button_with_caption(caption, opts={}) click to toggle source

Click a button with caption Usage:

click_button_with_caption("Confirm payment")

# File lib/rwebspec/web_browser.rb, line 469
def click_button_with_caption(caption, opts={})
    if opts && opts[:index]
      wait_before_and_after { button(:caption => caption, :index => opts[:index]).click }
    else
      wait_before_and_after { button(:caption, caption).click }
    end
end

Also aliased as: click_button, click_button_with_text

click_button_with_id(id, opts = {}) click to toggle source

Click a button with give HTML id Usage:

click_button_with_id("btn_sumbit")

# File lib/rwebspec/web_browser.rb, line 447
def click_button_with_id(id, opts = {})
  if opts && opts[:index]
      wait_before_and_after { button(:id => id,  :index => opts[:index]).click  }
  else
      wait_before_and_after { button(:id, id).click }
  end
end

click_button_with_name(name, opts={}) click to toggle source

Click a button with give name Usage:

click_button_with_name("confirm")

# File lib/rwebspec/web_browser.rb, line 458
def click_button_with_name(name, opts={})
  if opts && opts[:index]
    wait_before_and_after { button(:name => name, :index => opts[:index]).click }
  else
    wait_before_and_after { button(:name, name).click }
  end
end

click_button_with_text(caption, opts={}) click to toggle source

Alias for: click_button_with_caption

click_button_with_value(value, opts={}) click to toggle source

Click a button with value Usage:

click_button_with_value("Confirm payment")

# File lib/rwebspec/web_browser.rb, line 482
def click_button_with_value(value, opts={})
    if opts && opts[:index]
      wait_before_and_after { button(:value => value, :index => opts[:index]).click }
    else
      wait_before_and_after { button(:value, value).click }
    end
end

click_link(text, opts = {}) click to toggle source

Alias for: click_link_with_text

click_link_with_id(link_id, opts = {}) click to toggle source

links

# File lib/rwebspec/web_browser.rb, line 426
def click_link_with_id(link_id, opts = {})
  if opts && opts[:index]
    wait_before_and_after { link(:id => link_id, :index => opts[:index]).click }
  else
    wait_before_and_after { link(:id, link_id).click }
  end 
end

click_link_with_text(text, opts = {}) click to toggle source

# File lib/rwebspec/web_browser.rb, line 434
def click_link_with_text(text, opts = {})
  if opts && opts[:index]
    wait_before_and_after { link(:text => text, :index => opts[:index]).click }
  else
    wait_before_and_after { link(:text, text).click }          
  end 
end

Also aliased as: click_link

click_radio_button(radio_group, radio_option) click to toggle source

Alias for: click_radio_option

click_radio_option(radio_group, radio_option) click to toggle source

Click a radio button

Usage:
  click_radio_option("country", "Australia")

# File lib/rwebspec/web_browser.rb, line 552
def click_radio_option(radio_group, radio_option)
                    if Watir::VERSION =~ /^1/ then
    radio(:name, radio_group, radio_option).set                              
                    else
    radio(:name => radio_group, :value => radio_option).set
                    end
end

Also aliased as: click_radio_button

close() click to toggle source

Alias for: close_browser

close_browser() click to toggle source

Close the browser window. Useful for automated test suites to reduce test interaction.

# File lib/rwebspec/web_browser.rb, line 324
def close_browser
  case @browser.class.to_s
  when "FireWatir::Firefox"
    @browser.close
  when "Watir::IE"
    @browser.getIE.quit
  else
    puts "#{@browser.class} can't close, ignore"
  end
  sleep 2
end

Also aliased as: close

contains_text(text) click to toggle source

# File lib/rwebspec/web_browser.rb, line 261
def contains_text(text)
  @browser.contains_text(text);
end

dump_response(stream = nil) click to toggle source

For deubgging

# File lib/rwebspec/web_browser.rb, line 655
def dump_response(stream = nil)
  stream.nil? ?  puts(page_source) : stream.puts(page_source)
end

element(how, what) click to toggle source

This is the main method for accessing a generic element with a given attibute

*  how   - symbol - how we access the element. Supports all values except :index and :xpath
*  what  - string, integer or regular expression - what we are looking for,

Valid values for ‘how’ are listed in the Watir Wiki - wiki.openqa.org/display/WTR/Methods+supported+by+Element

returns an Watir::Element object

Typical Usage

element(:class, /foo/)      # access the first element with class 'foo'. We can use a string in place of the regular expression
element(:id, "11")          # access the first element that matches an id

# File lib/rwebspec/web_browser.rb, line 205
def element(how, what)
  return @browser.element(how, what)
end

element_by_id(elem_id) click to toggle source

Deprecated: using Watir style directly instead

# File lib/rwebspec/web_browser.rb, line 574
def element_by_id(elem_id)
  if is_firefox?
    # elem = @browser.document.getElementById(elem_id)
    # elem = div(:id, elem_id) || label(:id, elem_id)  || button(:id, elem_id) || 
                            # span(:id, elem_id) || hidden(:id, elem_id) || link(:id, elem_id) || radio(:id, elem_id)
                            elem = browser.element_by_xpath("//*[@id='#{elem_id}']")
  else
    elem = @browser.document.getElementById(elem_id)
  end
end

element_source(elementId) click to toggle source

# File lib/rwebspec/web_browser.rb, line 595
def element_source(elementId)
  elem = element_by_id(elementId)
  assert_not_nil(elem, "HTML element: #{elementId} not exists")
  elem.innerHTML
end

element_value(elementId) click to toggle source

# File lib/rwebspec/web_browser.rb, line 585
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

elements(how, what) click to toggle source

this is the main method for accessing generic html elements by an attribute

Returns a HTMLElements object

Typical usage:

elements(:class, 'test').each { |l| puts l.to_s }  # iterate through all elements of a given attribute
elements(:alt, 'foo')[1].to_s                       # get the first element of a given attribute
elements(:id, 'foo').length                        # show how many elements are foung in the collection

# File lib/rwebspec/web_browser.rb, line 219
def elements(how, what)
  return @browser.elements(how, what)
end

enter_text(name, text) click to toggle source

Alias for: enter_text_into_field_with_name

enter_text_into_field_with_name(name, text) click to toggle source

text fields

# File lib/rwebspec/web_browser.rb, line 412
def enter_text_into_field_with_name(name, text)
  if is_firefox?
    wait_before_and_after { text_field(:name, name).value = text }
    sleep 0.3
  else
    wait_before_and_after { text_field(:name, name).set(text) }
  end
end

Also aliased as: set_form_element, enter_text

expect_page(page_clazz, argument = nil) click to toggle source

Verify the next page following an operation.

Typical usage:

browser.expect_page HomePage

# File lib/rwebspec/web_browser.rb, line 713
def expect_page(page_clazz, argument = nil)
  if argument
    page_clazz.new(self, argument)
  else
    page_clazz.new(self)
  end
end

firefox() click to toggle source

return underlying firefox browser object, raise error if not running using Firefox

# File lib/rwebspec/web_browser.rb, line 688
def firefox
  raise "can't call this as it is configured to use IE" unless is_firefox?
  @browser
end

full_url(relative_url) click to toggle source

# File lib/rwebspec/web_browser.rb, line 346
def full_url(relative_url)
  if @context && @context.base_url
    @context.base_url + relative_url
  else
    relative_url
  end
end

goto_page(page) click to toggle source

Go to a page

Usage:
  open_browser("http://www.itest2.com"
  ....
  goto_page("/purchase")  # full url => http://www.itest.com/purchase

# File lib/rwebspec/web_browser.rb, line 401
def goto_page(page)
  @browser.goto full_url(page);
end

goto_url(url) click to toggle source

Go to a URL directly

goto_url("http://www.itest2.com/downloads")

# File lib/rwebspec/web_browser.rb, line 407
def goto_url(url)
  @browser.goto url
end

html() click to toggle source

Alias for: page_source

html_body() click to toggle source

Alias for: page_source

ie() click to toggle source

return underlying browser

# File lib/rwebspec/web_browser.rb, line 682
def ie
  raise "can't call this as it is configured to use Firefox" if is_firefox?
  @browser
end

initialize_celerity_browser(base_url, options) click to toggle source

# File lib/rwebspec/web_browser.rb, line 105
def initialize_celerity_browser(base_url, options)
  default_celerity_options = { :proxy => nil,  :browser => :firefox, :resynchronize => true, :log_level => :off }
  options = default_celerity_options.merge options
  options.each { |k, v| options.delete(k) unless default_celerity_options.keys.include?(k)}
  @browser = Celerity::Browser.new(options)
  @browser.goto(base_url)
end

initialize_firefox_browser(existing_browser, base_url, options) click to toggle source

# File lib/rwebspec/web_browser.rb, line 88
def initialize_firefox_browser(existing_browser, base_url, options)
  if existing_browser then
    @browser = existing_browser
    return
  end
  # JSSH is running, 9997
  begin
    require 'net/telnet'
    firefox_jssh = Net::Telnet::new("Host" => "127.0.0.1", "Port" => 9997)
    FireWatir::Firefox.firefox_started = true
  rescue => e
    puts "The firefox brower with JSSH is not available, #{e}"
    sleep 1
  end
  @browser = FireWatir::Firefox.start(base_url)
end

initialize_ie_browser(existing_browser, options) click to toggle source

# File lib/rwebspec/web_browser.rb, line 113
def initialize_ie_browser(existing_browser, options)
  if existing_browser then
    @browser = existing_browser
    if $ITEST2_EMULATE_TYPING && $ITEST2_TYPING_SPEED then
      @browser.set_slow_speed if $ITEST2_TYPING_SPEED == 'slow'
      @browser.set_fast_speed if $ITEST2_TYPING_SPEED == 'fast'
    else
      @browser.speed = :zippy
    end
    return
  end

  @browser = Watir::IE.new
  if $ITEST2_EMULATE_TYPING && $ITEST2_TYPING_SPEED then
    @browser.set_slow_speed if $ITEST2_TYPING_SPEED == 'slow'
    @browser.set_fast_speed if $ITEST2_TYPING_SPEED == 'fast'
  else
    @browser.speed = :zippy
  end
  @browser.activeObjectHighLightColor = options[:highlight_colour]
  @browser.visible = options[:visible] unless $HIDE_IE
  #NOTE: close_others fails
  if RUBY_VERSION =~ /^1\.8/ && options[:close_others] then
                            begin
            @browser.close_others
                            rescue => e1
                                    puts "Failed to close others"
                            end
  else
    puts "close other browser instances not working yet in Ruby 1.9.1 version of Watir"
  end
end

is_firefox?() click to toggle source

# File lib/rwebspec/web_browser.rb, line 313
def is_firefox?
  return false unless $firewatir_loaded
  begin
    @browser.class == FireWatir::Firefox
  rescue => e
    return false
  end
end

javascript_dialog() click to toggle source

Watir 1.9

# File lib/rwebspec/web_browser.rb, line 607
def javascript_dialog
        @browser.javascript_dialog
end

locate_input_element(how, what, types, value=nil) click to toggle source

Returns the specified ole object for input elements on a web page.

This method is used internally by Watir and should not be used externally. It cannot be marked as private because of the way mixins and inheritance work in watir

* how - symbol - the way we look for the object. Supported values are
               - :name
               - :id
               - :index
               - :value etc
* what  - string that we are looking for, ex. the name, or id tag attribute or index of the object we are looking for.
* types - what object types we will look at.
* value - used for objects that have one name, but many values. ex. radio lists and checkboxes

# File lib/rwebspec/web_browser.rb, line 239
def locate_input_element(how, what, types, value=nil)
  @browser.locate_input_element(how, what, types, value)
end

map(how, what=nil) click to toggle source

This is the main method for accessing map tags - msdn.microsoft.com/workshop/author/dhtml/reference/objects/map.asp?frame=true

*  how   - symbol - how we access the map,
*  what  - string, integer or regular expression - what we are looking for,

Valid values for ‘how’ are listed in the Watir Wiki - wiki.openqa.org/display/WTR/Methods+supported+by+Element

returns a map object

Typical Usage

map(:id, /list/)                 # access the first map that matches list.
map(:index,2)                    # access the second map on the page
map(:title, "A Picture")         # access a map using the tooltip text. See http://msdn.microsoft.com/workshop/author/dhtml/reference/properties/title_1.asp?frame=true

# File lib/rwebspec/web_browser.rb, line 257
def map(how, what=nil)
  @browser.map(how, what)
end

modal_dialog(how=nil, what=nil) click to toggle source

# File lib/rwebspec/web_browser.rb, line 189
def modal_dialog(how=nil, what=nil)
  @browser.modal_dialog(how, what)
end

new_popup_window(options, browser = "ie") click to toggle source

Attach a Watir::IE instance to a popup window.

Typical usage

new_popup_window(:url => "http://www.google.com/a.pdf")

# File lib/rwebspec/web_browser.rb, line 638
def new_popup_window(options, browser = "ie")
  if is_firefox?
    raise "not implemented"
  else
    if options[:url]
      Watir::IE.attach(:url, options[:url])
    elsif options[:title]
      Watir::IE.attach(:title, options[:title])
    else
      raise 'Please specify title or url of new pop up window'
    end
  end
end

page_source() click to toggle source

return HTML of current web page

# File lib/rwebspec/web_browser.rb, line 266
def page_source
  @browser.html()
  #@browser.document.body
end

Also aliased as: html_body, html

page_title() click to toggle source

# File lib/rwebspec/web_browser.rb, line 279
def page_title
  case @browser.class.to_s
  when "FireWatir::Firefox"
    @browser.title
  when "Watir::IE"
    @browser.document.title
  else
    @browser.title
  end
end

save_page(file_name = nil) click to toggle source

Save current web page source to file

usage:
   save_page("/tmp/01.html")
   save_page()  => # will save to "20090830112200.html"

# File lib/rwebspec/web_browser.rb, line 702
def save_page(file_name = nil)
  file_name ||= Time.now.strftime("%Y%m%d%H%M%S") + ".html"
  puts "about to save page: #{File.expand_path(file_name)}" if $DEBUG
  File.open(file_name, "w").puts page_source
end

select_file_for_upload(file_field, file_path) click to toggle source

# File lib/rwebspec/web_browser.rb, line 601
def select_file_for_upload(file_field, file_path)
  normalized_file_path = RUBY_PLATFORM.downcase.include?("mingw") ? file_path.gsub("/", "\\") : file_path
  file_field(:name, file_field).set(normalized_file_path)
end

select_option(selectName, option) click to toggle source

Select a dropdown list by name Usage:

select_option("country", "Australia")

# File lib/rwebspec/web_browser.rb, line 493
def select_option(selectName, option)
  select_list(:name, selectName).select(option)
end

set_form_element(name, text) click to toggle source

Also aliased as: set_hidden_field

Alias for: enter_text_into_field_with_name

set_hidden_field(name, text) click to toggle source

Alias for: set_form_element

show_all_objects() click to toggle source

# File lib/rwebspec/web_browser.rb, line 223
def show_all_objects
  @browser.show_all_objects
end

start_clicker( button, waitTime= 9, user_input=nil) click to toggle source

A Better Popup Handler using the latest Watir version. Posted by Mark_cain@rl.gov

wiki.openqa.org/display/WTR/FAQ#FAQ-HowdoIattachtoapopupwindow%3F

# File lib/rwebspec/web_browser.rb, line 663
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

start_window(url = nil) click to toggle source

# File lib/rwebspec/web_browser.rb, line 611
def start_window(url = nil)
  @browser.start_window(url);
end

submit(buttonName = nil) click to toggle source

submit first submit button

# File lib/rwebspec/web_browser.rb, line 498
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

text() click to toggle source

return plain text of current web page

# File lib/rwebspec/web_browser.rb, line 275
def text
  @browser.text
end

uncheck_checkbox(checkBoxName, values = nil) click to toggle source

Check a checkbox Usage:

uncheck_checkbox("agree")
uncheck_checkbox("agree", "false")

# File lib/rwebspec/web_browser.rb, line 533
def uncheck_checkbox(checkBoxName, values = nil)
  if values
    values.class == Array ? arys = values : arys = [values]
    arys.each {|cbx_value|
                                    if Watir::VERSION =~ /^1/ then     
            checkbox(:name, checkBoxName, cbx_value).clear
                                    else
            checkbox(:name => checkBoxName, :value => cbx_value).clear
                                    end
    }
  else
    checkbox(:name, checkBoxName).clear
  end
end

url() click to toggle source

current url

# File lib/rwebspec/web_browser.rb, line 301
def url
  @browser.url
end

wait_before_and_after() click to toggle source

A convenience method to wait at both ends of an operation for the browser to catch up.

# File lib/rwebspec/web_browser.rb, line 380
def wait_before_and_after
  wait_for_browser
  yield
  wait_for_browser
end

wait_for_browser() click to toggle source

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.

# File lib/rwebspec/web_browser.rb, line 369
def wait_for_browser
  if $celerity_loaded then
    # puts "ignore, using celerity"
  else
    @browser.waitForIE unless is_firefox?
  end
end

Home Classes Methods

In Files

Parent

Methods

Class/Module Index

RWebSpec::WebBrowser

Attributes

Public Class Methods

Public Instance Methods