rwebunit 0.2.0 → 0.7.2

data/lib/rwebunit/driver.rb

@@ -0,0 +1,296 @@
+# The Mixin is normally included in the spec/tests and pages, provide
+# convenient methods to drive the browser.
+#
+# Instead of
+#    browser.click_button("submit")
+# You can just use
+#    click_button("submit")
+#
+
+module RWebUnit
+  module Driver
+
+    # Verify the next page following an operation.
+    #
+    # Typical usage:
+    #   login_page.click_login
+    #   expect_page HomePage
+    def expect_page(page_clazz)
+      page_clazz.new(@web_tester)
+    end
+
+    # Using Ruby block syntax to create interesting domain specific language,
+    # may be appeal to someone.
+
+    # Example:
+    #  on @page do |i|
+    #    i.enter_text('btn1')
+    #    i.click_button('btn1')
+    #  end
+    def on(page, &block)
+      yield page
+    end
+
+    def test_context
+      @web_tester.test_context
+    end
+
+    def begin_at(url)
+      @web_tester.begin_at(url)
+    end
+
+    def ie; @web_tester.ie; end
+
+    def close_browser
+      @web_tester.close_browser
+    end
+    alias close_ie close_browser
+
+    # browser navigation
+    def go_back; @web_tester.go_back; end
+    def go_forward; @web_tester.go_forward; end
+    def goto_page(page); @web_tester.goto_page(page); end
+    def refresh; @web_tester.refresh; end
+    alias refresh_page refresh
+
+    def attach_browser(how, what); WebTester.attach_browser(how, what); end
+
+    ##
+    #  Delegate to WebTester
+    #
+
+    # Depends on which object type, you can use following attribute
+    # More details: http://wiki.openqa.org/display/WTR/Methods+supported+by+Element
+    #
+    # :id 	 Used to find an element that has an "id=" attribute. Since each id should be unique, according to the XHTML specification, this is recommended as the most reliable method to find an object. *
+    # :name 	Used to find an element that has a "name=" attribute. This is useful for older versions of HTML, but "name" is deprecated in XHTML. *
+    # :value 	Used to find a text field with a given default value, or a button with a given caption, or a text field
+    # :text 	Used for links, spans, divs and other element that contain text.
+    # :index 	Used to find the nth element of the specified type on a page. For example, button(:index, 2) finds the second button. Current versions of WATIR use 1-based indexing, but future versions will use 0-based indexing.
+    # :class 	Used for an element that has a "class=" attribute.
+    # :title 	Used for an element that has a "title=" attribute.
+    # :xpath 	Finds the item using xpath query.
+    # :method 	Used only for forms, the method attribute of a form is either GET or POST.
+    # :action 	Used only for form elements, specifies the URL where the form is to be submitted.
+    # :href 	Used to identify a link by its "href=" attribute.
+    # :src 	Used to identify an image by its URL.
+    #
+
+    # area 	<area> tags
+    # button 	<input> tags with type=button, submit, image or reset
+    # check_box 	<input> tags with type=checkbox
+    # div 	<div> tags
+    # form 	<form> tags
+    # frame 	frames, including both the <frame> elements and the corresponding pages
+    # h1 - h6 	<h1>, <h2>, <h3>, <h4>, <h5>, <h6> tags
+    # hidden 	<input> tags with type=hidden
+    # image 	<img> tags
+    # label 	<label> tags (including "for" attribute)
+    # li 	<li> tags
+    # link 	<a> (anchor) tags
+    # map 	<map> tags
+    # radio 	<input> tags with the type=radio; known as radio buttons
+    # select_list 	<select> tags, known as drop-downs or drop-down lists
+    # span 	<span> tags
+    # table 	<table> tags, including row and cell methods for accessing nested elements
+    # text_field 	<input> tags with the type=text (single-line), type=textarea (multi-line), and type=password
+    # p 	<p> (paragraph) tags, because
+    def area(*args); @web_tester.area(*args); end
+    def button(*args);  @web_tester.button(*args); end
+    def cell(*args);  @web_tester.cell(*args); end
+    alias td cell
+    def checkbox(*args);  @web_tester.checkbox(*args); end
+    alias check_box checkbox	# seems watir doc is wrong, checkbox not check_box
+    def div(*args); @web_tester.div(*args); end
+    def form(*args);  @web_tester.form(*args); end
+    def frame(*args);  @web_tester.frame(*args); end
+    def h1(*args); @web_tester.h1(*args); end
+    def h2(*args); @web_tester.h2(*args); end
+    def h3(*args); @web_tester.h3(*args); end
+    def h4(*args); @web_tester.h4(*args); end
+    def h5(*args); @web_tester.h5(*args); end
+    def h6(*args); @web_tester.h6(*args); end
+    def hidden(*args); @web_tester.hidden(*args); end
+    def image(*args);  @web_tester.image(*args); end
+    def li(*args);  @web_tester.li(*args); end
+    def link(*args);  @web_tester.link(*args); end
+    def map(*args);  @web_tester.map(*args); end
+    def pre(*args);  @web_tester.pre(*args); end
+    def row(*args);  @web_tester.row(*args); end
+    alias tr row
+    def radio(*args);  @web_tester.radio(*args); end
+    def select_list(*args);  @web_tester.select_list(*args); end
+    def span(*args); @web_tester.span(*args); end
+    def table(*args); @web_tester.table(*args); end
+    def text_field(*args);  @web_tester.text_field(*args); end
+
+    def paragraph(*args);  @web_tester.paragraph(*args); end
+    def file_field(*args);  @web_tester.file_field(*args); end
+    def label(*args); @web_tester.span(*args); end
+
+    def contains_text(text); @web_tester.contains_text(text); end
+
+
+    def links; @web_tester.links; end
+    def buttons; @web_tester.buttons; end
+    def select_lists; @web_tester.select_lists; end
+    def checkboxes; @web_tester.checkboxes; end
+    def radios; @web_tester.radios; end
+    def text_fields; @web_tester.text_fields; end
+
+
+    # enter text into a text field
+    def enter_text(elementName, elementValue)
+      @web_tester.set_form_element(elementName, elementValue)
+    end
+    alias set_form_element enter_text
+
+
+    #links
+    def click_link_with_text(linkText)
+      @web_tester.click_link_with_text(linkText)
+    end
+
+    def click_link_with_id(link_id)
+      @web_tester.click_link_with_id(link_id)
+    end
+    alias click_link click_link_with_id
+
+    ##
+    # buttons
+
+    # submit the form using the first (index) submit button
+    def submit()
+      @web_tester.submit()
+    end
+
+    # click a form submit button with specified button id
+    def submit(button_id)
+      @web_tester.submit(button_id)
+    end
+
+    def click_button(button_id)
+      @web_tester.click_button(button_id)
+    end
+    alias click_button_with_id click_button
+
+    def click_button_with_caption(caption)
+      @web_tester.click_button_with_caption(caption)
+    end
+    alias click_button_with_text click_button_with_caption
+
+    def click_button_with_value(value)
+      @web_tester.click_button_with_value(value)
+    end
+
+    # Radios
+    def click_radio_option(name, value)
+      @web_tester.click_radio_option(name, value)
+    end
+    alias click_radio_button click_radio_option
+
+    def clear_radio_option(name, value)
+      @web_tester.clear_radio_option(name, value)
+    end
+    alias clear_radio_button clear_radio_option
+
+    # Filefield
+    def select_file_for_upload(file_field, file_path)
+      @web_tester.select_file_for_upload(file_field, file_path)
+    end
+
+    # Check one or more checkboxes with same name, can accept a string or an array of string as values checkbox, pass array as values will try to set mulitple checkboxes.
+    #
+    # page.check_checkbox('bad_ones', 'Chicken Little')
+    # page.check_checkbox('good_ones', ['Cars', 'Toy Story'])
+    def check_checkbox(name, value=nil)
+      @web_tester.check_checkbox(name, value)
+    end
+
+    # Uncheck one or more checkboxes with same name
+    def uncheck_checkbox(name, value=nil)
+      @web_tester.uncheck_checkbox(name, value)
+    end
+
+    # combo box
+    def select_option(selectName, option)
+      @web_tester.select_option(selectName, option)
+    end
+
+    def new_popup_window(options)
+      @web_tester.new_popup_window(options)
+    end
+
+
+    # Wait for specific seconds for an Ajax update finish.
+    # Trick: In your Rails application,
+    #     :loading 	=> "Element.show('search_indicator');
+    #     :complete	=> "Element.hide('search_indicator');
+    #
+    #   <%= image_tag("indicator.gif", :id => 'search_indicator', :style => 'display:none') %>
+    #
+    # Typical usage:
+    #    ajax_wait_for_element("search_indicator", 30)
+    #    ajax_wait_for_element("search_indicator", 30, "show")
+    #    ajax_wait_for_element("search_indicator", 30, "hide")
+    #    ajax_wait_for_element("search_indicator", 30, "show", 5) # check every 5 seconds
+    #
+    # Warning: this method has not been fully tested, if you are not using Rails, change your parameter accordingly.
+    #
+    def ajax_wait_for_element(element_id, seconds, status='show', check_interval=2)
+      count = 0
+      check_interval = 2 if check_interval < 1 or check_interval > seconds
+      while count < (seconds / check_interval) do
+        search_indicator = @web_tester.element_by_id(element_id)
+        search_indicator_outer_html = search_indicator.outerHtml if search_indicator
+        if status == 'hide'
+          return true if search_indicator_outer_html and !search_indicator_outer_html.include?('style="DISPLAY: none"')
+        else
+          return true if search_indicator_outer_html and search_indicator_outer_html.include?('style="DISPLAY: none"')
+        end
+        sleep check_interval if check_interval > 0 and check_interval < 5 * 60 # wait max 5 minutes
+        count += 1
+      end
+      return false
+    end
+
+    def wait_for_element(element_id, timeout = 30, interval = 0.5)
+      start_time = Time.now
+      until @web_tester.element_by_id(element_id) do
+        sleep(interval)
+        if (Time.now - start_time) > timeout
+          raise RuntimeError, "failed to find element: #{element_id} for max #{timeout}"
+        end
+      end
+    end
+
+    def element_text(elem_id)
+      @web_tester.element_value(elem_id)
+    end
+
+    # fail the test if user can perform the operation
+    def shall_not_allow
+      operation_performed_ok = false
+      begin
+        yield
+        operation_performed_ok  = true
+      rescue
+      end
+
+      raise "Operation shall not be allowed" if operation_performed_ok
+    end
+    alias do_not_allow shall_not_allow
+
+    # ---
+    # For debugging
+    # ---
+    def dump_response(stream = nil)
+      @web_tester.dump_response(stream)
+    end
+
+    def click_popup_window(button, waitTime= 9, user_input=nil )
+      @web_tester.start_clicker(button, waitTime, user_input)
+    end
+
+  end
+end

data/lib/rwebunit/rspec_helper.rb

@@ -0,0 +1,108 @@
+require 'uri'
+
+# example
+#   should link_by_text(text, options).size > 0
+
+module RWebUnit
+  module RSpecHelper
+    include RWebUnit::Driver
+    include RWebUnit::Utils
+    include RWebUnit::Assert
+
+    def browser
+      @web_tester
+    end
+
+	def open_browser_preconfigured(options = {})
+		open_browser(ENV['ITEST_PROJECT_BASE_URL'], options)
+	end
+	
+    # open a browser, and set base_url via hash, but does not acually
+    #
+    # example:
+    #   open_browser :base_url => http://localhost:8080
+    def open_browser(base_url = nil, options = {})      
+      raise "base_url must be set" if base_url .nil?
+      
+       default_options = {:speed => "fast",
+        :visible => true,
+        :highlight_colour => 'yellow',
+        :close_others => true,
+        :start_new => false, 	# start a new browser always
+        :go => true}
+      
+      options = default_options.merge options 
+	options[:firefox] = true if "Firefox" == ENV['ITEST_BROWSER']
+
+      uri = URI.parse(base_url)
+      uri_base = "#{uri.scheme}://#{uri.host}:#{uri.port}"
+      if options[:start_new]
+        @web_tester = WebTester.new(uri_base, options)
+      else
+        @web_tester ||= WebTester.new(uri_base, options)
+      end
+	
+	  if options[:go]
+      (uri.path.length == 0) ?  begin_at("/") :  begin_at(uri.path)
+      end
+      return @web_tester
+    end
+	alias open_browser_with open_browser
+
+    # --
+    #  Content
+    # --
+    def page_title
+      @web_tester.page_title
+    end
+
+    def page_source
+      @web_tester.page_source
+    end
+
+    def table_source(table_id)
+      elem = @@browser.document.getElementById(table_id)
+      raise "The element '#{table_id}' is not a table or there are multple elements with same id" unless elem.name.uppercase == "TABLE"
+      elem.innerHTML
+    end
+    alias table_source_by_id table_source
+
+    def element_text(elem_id)
+      @web_tester.element_value(elem_id)
+    end
+    alias element_text_by_id element_text
+
+    #TODO: is it working?
+    def element_source(elem_id)
+      @web_tester.get_html_in_element(elem_id)
+    end
+
+    def element_by_id(elem_id)
+      @web_tester.element_by_id(elem_id)
+    end
+
+    def button_by_id(button_id)
+      button(:id, button_id)
+    end
+
+    def buttons_by_caption(text)
+      button(:text, text)
+    end
+    alias buttons_by_text buttons_by_caption
+
+    def link_by_id(link_id)
+      link(:id, link_id)
+    end
+
+    # default options: exact => true
+    def links_by_text(link_text, options = {})
+      options.merge!({:exact=> true})
+      links.select { |link|
+        options[:exact] ? link.text == link_text :  link.text.include?(link_text)
+      }
+    end
+    alias links_with_text links_by_text
+
+  end
+
+end

data/lib/rwebunit/test_context.rb

@@ -1,19 +1,24 @@
 #***********************************************************
-#* Copyright (c) 2006, Zhimin Zhan.
+#* Copyright (c) 2006, 2007 Zhimin Zhan.
 #* Distributed open-source, see full license in MIT-LICENSE
 #***********************************************************
 
 module RWebUnit
 
-   ##
-   #  Store test optionns
-   #
-   class TestContext
-      attr_accessor :base_url
+  ##
+  #  Store test optionns
+  #
+  class TestContext
+    attr_accessor :base_url
 
-      def setBaseUrl(baseUrl)
-         @base_url = baseUrl
-      end
-   end
+    def initialize(base_url)
+      set_base_url(base_url)
+    end
+
+    def set_base_url(baseUrl)
+      @base_url = baseUrl
+    end
+
+  end
 
 end

data/lib/rwebunit/test_utils.rb

@@ -3,78 +3,87 @@
 #* Distributed open-source, see full license in MIT-LICENSE
 #***********************************************************
 
+# useful hekoer methods for testing
+#
 module RWebUnit
-   module Utils
-
-      #useful methods for test data
-      def getToday_AU()
-         format_date(Time.now, "%02d/%02d/%04d")
-      end
-      alias getToday getToday_AU
-
-      def getToday_US()
-         sprintf("%02d/%02d/%04d", Time.now.month, Time.now.day, Time.now.year)
-      end
-
-      def getDaysBefore(days)
-         nil if !(days.instance_of?(Fixnum))
-         format_date(Time.now - days * 24 * 3600)
-      end
-
-      def getYesterday
-         getDaysBefore(1)
-      end
-
-      def getDaysAfter(days)
-         nil if !(days.instance_of?(Fixnum))
-         format_date(Time.now + days * 24 * 3600)
-      end
-
-      def getTomorrow
-         getDaysAfter(1)
-      end
-
-      #TODO: getDaysBefore, getDaysAfter, getYesterday, getTomorrow
-
-      # return a random number >= min, but <= max
-      def randomNumber(min, max)
-         rand(max-min+1)+min
+  module Utils
+
+    # default date format returned is 29/12/2007.
+    # if supplied parameter is not '%m/%d/%Y' -> 12/29/2007
+    # Otherwise, "2007-12-29", which is most approiate date format
+    def today(format = '%d/%m/%y')
+      if format.downcase == '%d/%m/%y'
+        format_date(Time.now, "%02d/%02d/%04d")
+      elsif format.downcase == '%m/%d/%y'
+        sprintf("%02d/%02d/%04d", Time.now.month, Time.now.day, Time.now.year)
+      else
+        sprintf("%04d-%02d-%02d", Time.now.year, Time.now.month, Time.now.day)
       end
-
-      def randomBoolean()
-         return randomNumber(0, 1) == 1
-      end
-
-      def randomChar(lowercase)
-         sprintf("%c", random_number(97, 122)) if lowercase
-         sprintf("%c", random_number(65, 90)) unless lowercase
-      end
-
-      def randomDigit()
-         sprintf("%c", randomNumber(48, 57))
-      end
-
-      def randomString(length, lowercase)
-         randomStr = ""
-         length.times {
-            randomStr += randomChar(lowercase)
-         }
-         randomStr
-      end
-
-      # Return a random string in a rangeof pre-defined strings
-      def randomStringInCollection(arr)
-         return nil if arr.empty?
-         index = random_number(0, arr.length-1)
-         arr[index]
-      end
-
-      private
-      def format_date(date, date_format = nil)
-         date_format ||=  "%02d/%02d/%04d"
-         sprintf(date_format, date.day, date.month, date.year)
-      end
-
-
-   end
+    end
+    alias getToday_AU today
+    alias getToday_US today
+    alias getToday today
+
+
+    def days_before(days)
+      nil if !(days.instance_of?(Fixnum))
+      format_date(Time.now - days * 24 * 3600)
+    end
+
+    def yesterday
+      days_before(1)
+    end
+
+    def days_from_now(days)
+      nil if !(days.instance_of?(Fixnum))
+      format_date(Time.now + days * 24 * 3600)
+    end
+    alias days_after days_from_now
+
+    def tomorrow
+      days_from_now(1)
+    end
+
+    # return a random number >= min, but <= max
+    def random_number(min, max)
+      rand(max-min+1)+min
+    end
+
+    def random_boolean
+      return random_number(0, 1) == 1
+    end
+
+    def random_char(lowercase = true)
+      sprintf("%c", random_number(97, 122)) if lowercase
+      sprintf("%c", random_number(65, 90)) unless lowercase
+    end
+    alias randomChar random_char
+
+    def random_digit()
+      sprintf("%c", random_number(48, 57))
+    end
+
+    def random_str(length, lowercase = true)
+      randomStr = ""
+      length.times {
+        randomStr += random_char(lowercase)
+      }
+      randomStr
+    end
+
+    # Return a random string in a rangeof pre-defined strings
+    def random_string_in(arr)
+      return nil if arr.empty?
+      index = random_number(0, arr.length-1)
+      arr[index]
+    end
+    alias random_string_in_collection random_string_in
+
+    private
+    def format_date(date, date_format = nil)
+      date_format ||=  "%02d/%02d/%04d"
+      sprintf(date_format, date.day, date.month, date.year)
+    end
+
+  end
 end