rwebunit 1.0.3 → 1.3.0

data/lib/rwebunit/itest_plugin.rb

@@ -6,23 +6,43 @@ module RWebUnit
     def connect_to_itest(message_type, body)
       begin
         the_message = message_type + "|" + body
-        if @last_message == the_message then
+        if @last_message == the_message then # ignore the message same as preivous one
           return
         end
         itest_port = $ITEST2_TRACE_PORT || 7025
         itest_socket = Socket.new(Socket::AF_INET,Socket::SOCK_STREAM,0)
-        itest_socket.connect(Socket.pack_sockaddr_in(itest_port, 'localhost'))
+        itest_socket.connect(Socket.pack_sockaddr_in(itest_port, '127.0.0.1'))
         itest_socket.puts(the_message)
         @last_message = the_message
         itest_socket.close
       rescue => e
       end
     end
+    alias connect_to_itest2 connect_to_itest
 
     def debug(message)
       connect_to_itest(" DEBUG", message + "\r\n") if $RUN_IN_ITEST
     end
 
+
+    # Support of iTest to ajust the intervals between keystroke/mouse operations
+    def operation_delay
+      begin
+        if $ITEST2_OPERATION_DELAY && $ITEST2_OPERATION_DELAY > 0 &&
+          $ITEST2_OPERATION_DELAY && $ITEST2_OPERATION_DELAY < 30000  then # max 30 seconds
+            sleep($ITEST2_OPERATION_DELAY / 1000)
+        end
+
+        while $ITEST2_PAUSE
+            debug("Paused, waiting ...")
+            sleep 1
+        end
+      rescue => e
+        puts "Error on delaying: #{e}"
+        # ignore
+      end
+    end
+
     # find out the line (and file) the execution is on, and notify iTest via Socket
     def dump_caller_stack
       return unless $ITEST2_TRACE_EXECUTION
@@ -43,5 +63,6 @@ module RWebUnit
         puts "failed to capture log: #{e}"
       end
     end
+
   end
 end

data/lib/rwebunit/popup.rb

@@ -0,0 +1,147 @@
+module RWebUnit
+  module Popup
+
+    #= Popup
+    #
+
+    # Start background thread to click popup windows
+    #  Warning:
+    #    Make browser window active
+    #    Don't mouse your mouse to focus other window during test execution
+    def check_for_popups
+      autoit = WIN32OLE.new('AutoItX3.Control')
+      #
+      # Do forever - assumes popups could occur anywhere/anytime in your
+      # application.
+      loop do
+        # Look for window with given title. Give up after 1 second.
+        ret = autoit.WinWait('Windows Internet Explorer', '', 1)
+        #
+        # If window found, send appropriate keystroke (e.g. {enter}, {Y}, {N}).
+        if (ret==1) then
+          autoit.Send('{enter}')
+        end
+        #
+        # Take a rest to avoid chewing up cycles and give another thread a go.
+        # Then resume the loop.
+        sleep(3)
+      end
+    end
+
+    ##
+    #  Check for "Security Information" and "Security Alert" alert popup, click 'Yes'
+    #
+    # Usage: For individual test suite
+    #
+    # before(:all) do
+    #  $popup = Thread.new { check_for_alerts }
+    #  open_in_browser
+    #  ...
+    # end
+    #
+    # after(:all) do
+    #   close_browser
+    #   Thread.kill($popup)
+    # end
+    #
+    # or for all tests,
+    #  $popup = Thread.new { check_for_alerts }
+    #  at_exit{ Thread.kill($popup) }
+    def check_for_security_alerts
+      autoit = WIN32OLE.new('AutoItX3.Control')
+      loop do
+        ["Security Alert", "Security Information"].each do |win_title|
+          ret = autoit.WinWait(win_title, '', 1)
+          if (ret==1) then
+            autoit.Send('{Y}')
+          end
+        end
+        sleep(3)
+      end
+    end
+
+    def verify_alert(title = "Microsoft Internet Explorer", button = "OK")
+      if is_windows? && !is_firefox?
+        WIN32OLE.new('AutoItX3.Control').ControlClick(title, '', button)
+      else
+        raise "This function only supports IE"
+      end
+    end
+
+    def click_button_in_security_information_popup(button = "&Yes")
+      verify_alert("Security Information", "", button)
+    end
+    alias click_security_information_popup click_button_in_security_information_popup
+
+    def click_button_in_security_alert_popup(button = "&Yes")
+      verify_alert("Security Alert", "", button)
+    end
+    alias click_security_alert_popup click_button_in_security_alert_popup
+
+    def click_button_in_javascript_popup(button = "OK")
+      verify_alert()
+    end
+    alias click_javascript_popup click_button_in_javascript_popup
+
+    ##
+    # This only works for IEs
+    #   Cons:
+    #     - Slow
+    #     - only works in IE
+    #     - does not work for security alert ?
+    def ie_popup_clicker(button_name = "OK", max_wait = 15)
+      require 'watir/contrib/enabled_popup'
+      require 'win32ole'
+      hwnd = ie.enabled_popup(15)
+      if (hwnd)  #yeah! a popup
+        popup = WinClicker.new
+        popup.makeWindowActive(hwnd) #Activate the window.
+        popup.clickWindowsButton_hwnd(hwnd, button_name) #Click the button
+        #popup.clickWindowsButton(/Internet/,button_name,30)
+        popup = nil
+      end
+    end
+
+    def click_popup_window(button, wait_time= 9, user_input=nil )
+      @web_browser.start_clicker(button, wait_time, user_input)
+      sleep 0.5
+    end
+    # run a separate process waiting for the popup window to click
+    #
+    #
+    def prepare_to_click_button_in_popup(button = "OK", wait_time = 3)
+      #  !@web_browser.is_firefox?
+      # TODO: firefox is OK
+      if RUBY_PLATFORM =~ /mswin/  then
+        start_checking_js_dialog(button, wait_time)
+      else
+        raise "this only support on Windows and on IE"
+      end
+    end
+
+    # Start a background process to click the button on a javascript popup window
+    def start_checking_js_dialog(button = "OK", wait_time = 3)
+      w = WinClicker.new
+      longName = File.expand_path(File.dirname(__FILE__)).gsub("/", "\\" )
+      shortName = w.getShortFileName(longName)
+      c = "start ruby #{shortName}\\clickJSDialog.rb #{button} #{wait_time} "
+      w.winsystem(c)
+      w = nil
+    end
+
+    # Click the button in javascript popup dialog
+    # Usage:
+    #   click_button_in_popup_after { click_link('Cancel')}
+    #   click_button_in_popup_after("OK") { click_link('Cancel')}
+    #
+    def click_button_in_popup_after(options = {:button => "OK", :wait_time => 3}, &block)
+      if is_windows?  then
+        start_checking_js_dialog(options[:button], options[:wait_time])
+        yield
+      else
+        raise "this only support on Windows and on IE"
+      end
+    end
+
+  end
+end

data/lib/rwebunit/rspec_helper.rb

@@ -21,59 +21,10 @@ module RWebUnit
     include RWebUnit::Utils
     include RWebUnit::Assert
 
-    # open a browser, and set base_url via hash, but does not acually
-    #
-    # example:
-    #   open_browser :base_url => http://localhost:8080
-    #
-    # There are 3 ways to set base url 
-    #   1. pass as first argument
-    #   2. If running using iTest2, used as confiured
-    #   3. Use default value set
-    def open_browser(base_url = nil, options = {})
-      base_url ||= $ITEST2_PROJECT_BASE_URL
-      base_url ||= $BASE_URL 
-      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" == $ITEST2_BROWSER || "Firefox" == $BROWSER
-      ($ITEST2_HIDE_BROWSER) ? $HIDE_IE = true : $HIDE_IE = false
-
-      uri = URI.parse(base_url)
-      uri_base = "#{uri.scheme}://#{uri.host}:#{uri.port}"
-      if options[:start_new]
-        @web_browser = WebBrowser.new(uri_base, nil, options)
-      else 
-        # Reuse existing browser
-        @web_browser = WebBrowser.reuse(uri_base, options)
-      end
-
-      if options[:go]
-        (uri.path.length == 0) ?  begin_at("/") :  begin_at(uri.path)
-      end
-      return @web_browser
-    end
-    alias open_browser_with open_browser
-
     # --
     #  Content
     # --
 
-    def page_title
-      @web_browser.page_title
-    end
-
-    def page_source
-      @web_browser.page_source
-    end
-
     def table_source(table_id)
       table(:id, table_id).innerHTML
       # elem = @web_browser.document.getElementById(table_id)
@@ -92,9 +43,6 @@ module RWebUnit
       @web_browser.get_html_in_element(elem_id)
     end
 
-    def element_by_id(elem_id)
-      @web_browser.element_by_id(elem_id)
-    end
 
     def button_by_id(button_id)
       button(:id, button_id)
@@ -123,18 +71,26 @@ module RWebUnit
     def save_page(file_name = nil)
       @web_browser.save_page(file_name)
     end
-    
-    def save_content_to_file(content, file_name = nil)      
+
+    def save_content_to_file(content, 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)}"
       File.open(file_name, "w").puts content
     end
 
-    # When running 
+    # When running
     def debugging?
       $ITEST2_DEBUGGING && $ITEST2_RUNNING_AS == "test_case"
     end
-    
+
+    # RSpec Matchers
+    #
+    # Example,
+    #   a_number.should be_odd_number
+    def be_odd_number
+      simple_matcher("must be odd number") { |actual| actual && actual.to_id % 2 == 1}
+    end
+
   end
 
 end

data/lib/rwebunit/test_script.rb

@@ -0,0 +1,8 @@
+module RWebUnit
+  module TestScript
+    include RWebUnit::Driver
+    include RWebUnit::Utils
+    include RWebUnit::Assert
+    
+  end
+end

data/lib/rwebunit/test_utils.rb

@@ -11,32 +11,54 @@ module RWebUnit
     # 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
+    #
+    #  %a - The abbreviated weekday name (``Sun'')
+    #  %A - The  full  weekday  name (``Sunday'')
+    #  %b - The abbreviated month name (``Jan'')
+    #  %B - The  full  month  name (``January'')
+    #  %c - The preferred local date and time representation
+    #  %d - Day of the month (01..31)
+    #  %H - Hour of the day, 24-hour clock (00..23)
+    #  %I - Hour of the day, 12-hour clock (01..12)
+    #  %j - Day of the year (001..366)
+    #  %m - Month of the year (01..12)
+    #  %M - Minute of the hour (00..59)
+    #  %p - Meridian indicator (``AM''  or  ``PM'')
+    #  %S - Second of the minute (00..60)
+    #  %U - Week  number  of the current year,
+    #          starting with the first Sunday as the first
+    #          day of the first week (00..53)
+    #  %W - Week  number  of the current year,
+    #          starting with the first Monday as the first
+    #          day of the first week (00..53)
+    #  %w - Day of the week (Sunday is 0, 0..6)
+    #  %x - Preferred representation for the date alone, no time
+    #  %X - Preferred representation for the time alone, no date
+    #  %y - Year without a century (00..99)
+    #  %Y - Year with century
+    #  %Z - Time zone name
+    #  %% - Literal ``%'' character
+
+    def today(format = '%d/%m/%Y')
+      format_date(Time.now, format)
     end
     alias getToday_AU today
     alias getToday_US today
     alias getToday today
 
 
-    def days_before(days)
+    def days_before(days, format = '%d/%m/%Y')
       nil if !(days.instance_of?(Fixnum))
-      format_date(Time.now - days * 24 * 3600)
+      format_date(Time.now - days * 24 * 3600, format)
     end
 
     def yesterday
       days_before(1)
     end
 
-    def days_from_now(days)
+    def days_from_now(days, format = '%d/%m/%Y')
       nil if !(days.instance_of?(Fixnum))
-      format_date(Time.now + days * 24 * 3600)
+      format_date(Time.now + days * 24 * 3600, format)
     end
     alias days_after days_from_now
 
@@ -78,20 +100,71 @@ module RWebUnit
     end
     alias random_string_in_collection random_string_in
 
-    def this_file
-      __FILE__
+
+    WORDS = %w(alias consequatur aut perferendis sit voluptatem accusantium doloremque aperiam eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo aspernatur aut odit aut fugit sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt neque dolorem ipsum quia dolor sit amet consectetur adipisci velit sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem ut enim ad minima veniam quis nostrum exercitationem ullam corporis nemo enim ipsam voluptatem quia voluptas sit suscipit laboriosam nisi ut aliquid ex ea commodi consequatur quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae et iusto odio dignissimos ducimus qui blanditiis praesentium laudantium totam rem voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident sed ut perspiciatis unde omnis iste natus error similique sunt in culpa qui officia deserunt mollitia animi id est laborum et dolorum fuga et harum quidem rerum facilis est et expedita distinctio nam libero tempore cum soluta nobis est eligendi optio cumque nihil impedit quo porro quisquam est qui minus id quod maxime placeat facere possimus omnis voluptas assumenda est omnis dolor repellendus temporibus autem quibusdam et aut consequatur vel illum qui dolorem eum fugiat quo voluptas nulla pariatur at vero eos et accusamus officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae itaque earum rerum hic tenetur a sapiente delectus ut aut reiciendis voluptatibus maiores doloribus asperiores repellat)
+
+    # Pick a random value out of a given range.
+    def value_in_range(range)
+      case range.first
+      when Integer then number_in_range(range)
+      when Time then time_in_range(range)
+      when Date then date_in_range(range)
+      else range.to_a.rand
+      end
+    end
+
+    # Generate a given number of words. If a range is passed, it will generate
+    # a random number of words within that range.
+    def words(total)
+      (1..interpret_value(total)).map { WORDS.rand }.join(' ')
+    end
+
+    # Generate a given number of sentences. If a range is passed, it will generate
+    # a random number of sentences within that range.
+    def sentences(total)
+      (1..interpret_value(total)).map do
+        words(5..20).capitalize
+      end.join('. ')
+    end
+
+    # Generate a given number of paragraphs. If a range is passed, it will generate
+    # a random number of paragraphs within that range.
+    def paragraphs(total)
+      (1..interpret_value(total)).map do
+        sentences(3..8).capitalize
+      end.join("\n\n")
     end
-    alias current_file this_file
-    
-    def this_directory
-      File.dirname(this_file)
+
+    # If an array or range is passed, a random value will be selected to match.
+    # All other values are simply returned.
+    def interpret_value(value)
+      case value
+      when Array then value.rand
+      when Range then value_in_range(value)
+      else value
+      end
     end
-    alias current_directory this_directory
-    
+
     private
-    def format_date(date, date_format = nil)
-      date_format ||=  "%02d/%02d/%04d"
-      sprintf(date_format, date.day, date.month, date.year)
+
+    def time_in_range(range)
+      Time.at number_in_range(Range.new(range.first.to_i, range.last.to_i, range.exclude_end?))
+    end
+
+    def date_in_range(range)
+      Date.jd number_in_range(Range.new(range.first.jd, range.last.jd, range.exclude_end?))
+    end
+
+    def number_in_range(range)
+      if range.exclude_end?
+        rand(range.last - range.first) + range.first
+      else
+        rand((range.last+1) - range.first) + range.first
+      end
+    end
+
+    def format_date(date, date_format = '%d/%m/%Y')
+      date.strftime(date_format)
     end
 
   end

data/lib/rwebunit/using_pages.rb

@@ -0,0 +1,49 @@
+module RWebUnit
+  module UsingPages
+
+    # support Ruby 1.9
+    def self.extended(kclass)
+      caller_file = caller[1]
+      if caller_file && caller_file =~ /^(.*):\d+.*$/ 
+        file = $1
+        dir = File.expand_path(File.dirname(file))
+        kclass.const_set "TestFileDir", dir
+      end
+    end
+
+    # Example
+    #  pages :all
+    #  pages :login_page, :payment_page
+    #  pages :login_page, :payment_page, :page_dir => "c:/tmp"
+    def pages(*args)
+      return if args.nil? or args.empty?
+
+      test_file_dir = class_eval{  self::TestFileDir }
+      default_page_dir = File.join(test_file_dir, "pages")
+      #puts "debug: default_page_dir :#{default_page_dir}}"
+      page_dir = default_page_dir
+
+      page_files = []
+      args.each do |x|
+        if x.class == Hash && x[:page_dir]
+          page_dir = x[:page_dir]
+        else
+          page_files << x
+        end
+      end
+
+      if page_files.size == 1 && page_files[0] == :all
+        Dir[File.expand_path(page_dir)+ "/*_page.rb"].each { |page_file|
+          load page_file
+        }
+        return
+      end
+
+      page_files.each do |page|
+        page_file = File.join(page_dir, page.to_s)
+        load page_file
+      end
+    end
+
+  end
+end

data/lib/rwebunit/web_browser.rb

@@ -43,6 +43,15 @@ module RWebUnit
         @browser = existing_browser
       else
         if (options[:firefox] &&  $firewatir_loaded) || ($firewatir_loaded and !$watir_loaded)
+          # 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 "debug: XXX #{e}"
+            sleep 1
+          end
           @browser = FireWatir::Firefox.start(base_url)
         elsif $watir_loaded
           @browser = Watir::IE.new
@@ -113,6 +122,14 @@ module RWebUnit
     end
     alias html_body page_source
 
+    def html
+      @browser.html
+    end
+
+    def text
+      @browser.text
+    end
+
     def page_title
       if is_firefox?
         @browser.title
@@ -160,11 +177,12 @@ module RWebUnit
     end
     alias close close_browser
 
+    #TODO determine browser type, check FireWatir support or not
     def self.close_all_browsers
-      if is_firefox? then
-        @browser.close_all
-      else
+      if RUBY_PLATFORM.downcase.include?("mswin")
         Watir::IE.close_all
+      else
+        # raise "not supported in FireFox yet."
       end
     end
 
@@ -218,6 +236,10 @@ module RWebUnit
       @browser.goto full_url(page);
     end
 
+    def goto_url(url)
+      @browser.goto url
+    end
+
     # text fields
     def enter_text_into_field_with_name(name, text)
       if is_firefox?
@@ -334,7 +356,7 @@ module RWebUnit
     end
 
     def select_file_for_upload(file_field, file_path)
-      normalized_file_path = is_windows? ? file_path.gsub("/", "\\") : file_path
+      normalized_file_path = RUBY_PLATFORM.downcase.include?("mswin") ? file_path.gsub("/", "\\") : file_path
       file_field(:name, file_field).set(normalized_file_path)
     end
 
@@ -425,7 +447,7 @@ module RWebUnit
     end
 
 
-    def is_windows?
+    def self.is_windows?
       RUBY_PLATFORM.downcase.include?("mswin")
     end
 

data/lib/rwebunit/web_page.rb

@@ -29,7 +29,7 @@ module RWebUnit
     # page_text: text used to identify the page, title will be the first candidate
     attr_accessor :page_text
 
-    def initialize(the_browser, page_text=nil)
+    def initialize(the_browser, page_text = nil)
       @web_browser = the_browser
       @web_tester = the_browser
       @page_text = page_text
@@ -58,37 +58,33 @@ module RWebUnit
       @web_browser.dump_response(stream)
     end
 
+    
     def source
       @web_browser.page_source
     end
 
+    # return current page title
     def title
       @web_browser.page_title
     end
 
+    # return current page text
+    def text
+      @web_browser.text
+    end
+
     # TO validate
     def contains?(ary)
-      page_source = source
+      the_page_source = source
       found = false
       ary.each do |str|
-        found ||= page_source.include?(str)
+        found ||= the_page_source.include?(str)
       end
       return found
     end
-    alias include contains?
-
-
-    def	snapshot
-      if $ITEST2_DUMP_DIR
-        spec_run_id = $ITEST2_RUNNING_SPEC_ID || "unknown"
-        spec_run_dir_name = spec_run_id.to_s.rjust(4, "0") unless spec_run_id == "unknown"
-        spec_run_dir = File.join($ITEST2_DUMP_DIR, spec_run_dir_name)
-        Dir.mkdir(spec_run_dir) unless File.exists?(spec_run_dir)
-        file_name = Time.now.strftime("%m%d%H%M%S") + "_" + self.class.name.gsub("", "") + ".html"
-        file = File.join($ITEST2_DUMP_DIR, spec_run_dir_name, file_name)
-        page_source = browser.page_source
-        File.new(file, "w").puts source
-      end
+
+    def	snapshot(replace_css = false)    
+      save_current_page(:filename => Time.now.strftime("%m%d%H%M%S") + "_" + self.class.name.gsub(" ", "") + ".html" )
     end
 
   end

data/lib/rwebunit.rb

@@ -1,5 +1,5 @@
 #***********************************************************
-#* Copyright (c) 2006, Zhimin Zhan.
+#* Copyright (c) 2006 - 2009, Zhimin Zhan.
 #* Distributed open-source, see full license in MIT-LICENSE
 #***********************************************************
 
@@ -12,11 +12,11 @@ rescue LoadError => no_as1_err
 end
 require 'active_support/core_ext'
 require 'spec'
-require 'hpricot' # for parsing HTML
 
-RWEBUNIT_VERSION = "1.0.3"
+RWEBUNIT_VERSION = "1.3.0"
 
 # Extra full path to load libraries
+require File.dirname(__FILE__) + "/rwebunit/using_pages"
 require File.dirname(__FILE__) + "/rwebunit/test_utils"
 require File.dirname(__FILE__) + "/rwebunit/web_page"
 require File.dirname(__FILE__) + "/rwebunit/assert"
@@ -25,8 +25,8 @@ require File.dirname(__FILE__) + "/rwebunit/assert"
 require File.dirname(__FILE__) + "/rwebunit/itest_plugin"
 require File.dirname(__FILE__) + "/rwebunit/web_browser"
 require File.dirname(__FILE__) + "/rwebunit/driver"
+require File.dirname(__FILE__) + "/rwebunit/test_script"
 require File.dirname(__FILE__) + "/rwebunit/context"
-require File.dirname(__FILE__) + "/rwebunit/driver"
 require File.dirname(__FILE__) + "/rwebunit/rspec_helper"
 require File.dirname(__FILE__) + "/rspec_extensions"
 require File.dirname(__FILE__) + "/watir_extensions"