zhimin-rwebspec 1.4.0

data/lib/rwebspec/itest_plugin.rb

@@ -0,0 +1,68 @@
+require 'socket'
+
+module RWebSpec
+  module ITestPlugin
+
+    def connect_to_itest(message_type, body)
+      begin
+        the_message = message_type + "|" + body
+        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, '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
+      begin
+        caller.each_with_index do |position, idx|
+          next unless position =~ /\A(.*?):(\d+)/
+          file = $1
+          # TODO: send multiple trace to be parse with pages.rb
+          # next if file =~ /example\/example_methods\.rb$/ or file =~ /example\/example_group_methods\.rb$/ or file =~ /driver\.rb$/ or file =~ /timeout\.rb$/ # don't include rspec or ruby trace
+
+          if file.include?("_spec.rb") || file.include?("_test.rb") || file.include?("_cmd.rb")
+            connect_to_itest(" TRACE", position)
+          end
+
+          break if idx > 4 or file =~ /"_spec\.rb$/
+        end
+      rescue => e
+        puts "failed to capture log: #{e}"
+      end
+    end
+
+  end
+end

data/lib/rwebspec/matchers/contains_text.rb

@@ -0,0 +1,37 @@
+class ContainsText
+
+  # this is what the matcher is called on.
+  # In this case:
+  #   foo.should contains(:bars)
+  # foo would be passed to the +initialize+
+  def initialize(expected)
+    @expected = expected
+  end
+
+  def matches?(actual)
+    @actual = actual
+    return actual && actual.include?(@expected)
+  end
+
+  def actual_text
+    @actual.to_s.length > 1000000 ? @actual[0, 1000] : @actual
+  end
+
+  # error message for should
+  def failure_message
+    "expected #{actual_text} not to contains #{@expected}, but it did't"
+  end
+
+  # error message for should_not
+  def negative_failure_message
+    "expected #{actual_text} not to contains #{@expected}, but it did"
+  end
+
+end
+
+
+# This method is the one you use with should/should_not
+def contains_text?(expected)
+  ContainsText.new(expected)
+end
+alias contains? contains_text?

data/lib/rwebspec/popup.rb

@@ -0,0 +1,147 @@
+module RWebSpec
+  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/rwebspec/rspec_helper.rb

@@ -0,0 +1,96 @@
+require 'uri'
+
+# ZZ patches to RSpec 1.1.2 - 1.1.4
+#  - add to_s method to example_group
+module Spec
+  module Example
+    class ExampleGroup
+      def to_s
+        @_defined_description
+      end
+    end
+  end
+end
+
+# example
+#   should link_by_text(text, options).size > 0
+
+module RWebSpec
+  module RSpecHelper
+    include RWebSpec::Driver
+    include RWebSpec::Utils
+    include RWebSpec::Assert
+
+    # --
+    #  Content
+    # --
+
+    def table_source(table_id)
+      table(:id, table_id).innerHTML
+      # elem = @web_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_browser.element_value(elem_id)
+    end
+    alias element_text_by_id element_text
+
+    #TODO: is it working?
+    def element_source(elem_id)
+      @web_browser.get_html_in_element(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})
+      matching_links = []
+      links.each { |link|
+        matching_links << link if (options[:exact] ? link.text == link_text :  link.text.include?(link_text))
+      }
+      return matching_links
+    end
+    alias links_with_text links_by_text
+
+    def save_page(file_name = nil)
+      @web_browser.save_page(file_name)
+    end
+
+    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
+    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/rwebspec/test_script.rb

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

data/lib/rwebspec/test_utils.rb

@@ -0,0 +1,171 @@
+#***********************************************************
+#* Copyright (c) 2006, Zhimin Zhan.
+#* Distributed open-source, see full license in MIT-LICENSE
+#***********************************************************
+
+# useful hekoer methods for testing
+#
+module RWebSpec
+  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
+    #
+    #  %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, format = '%d/%m/%Y')
+      nil if !(days.instance_of?(Fixnum))
+      format_date(Time.now - days * 24 * 3600, format)
+    end
+
+    def yesterday
+      days_before(1)
+    end
+
+    def days_from_now(days, format = '%d/%m/%Y')
+      nil if !(days.instance_of?(Fixnum))
+      format_date(Time.now + days * 24 * 3600, format)
+    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
+
+    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
+
+
+    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
+
+    # 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
+
+    private
+
+    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
+end