awetestlib 0.1.29 → 0.1.30pre1

data/.gitignore

@@ -67,3 +67,4 @@ dump.rdb
 config/settings.yml
 PROJECT_NAME
 *.log
+awetest_reports/

data/bin/awetestlib

@@ -1,6 +1,11 @@
 $: << "./lib"
+
+$base_time = Time.now
+$load_times = Hash.new
+$capture_load_times = true
+
 require File.join(File.dirname(__FILE__),"awetestlib-helpers")
-require 'fileutils'
+require 'fileutils'  #: load_time
 
 cmd = ARGV[0]
 
@@ -30,8 +35,8 @@ elsif cmd == 'driver_setup'
   awetestlib_driver_setup
 else
 
-require 'optparse'
-require 'awetestlib'
+require 'optparse'  #; load_time('optparse')
+require 'awetestlib'  #; load_time
 
 options = { }
 OptionParser.new do |opts|
@@ -77,12 +82,18 @@ OptionParser.new do |opts|
   opts.on("-o", "--output_to_log", "Write to log file") do
     options[:output_to_log] = true
   end
+  opts.on("-c", "--classic_watir", "Use Classic Watir for IE instead of Watir-webdriver") do
+    options[:classic_watir] = true
+  end
   opts.on("", "--log_path_subdir LOG_PATH_SUBDIR", "Specify log path relative to root_path.") do |log_path_subdir|
     options[:log_path_subdir] = log_path_subdir
   end
   opts.on("", "--report_all_test_refs REPORT_ALL_TEST_REFS", "Include list of all error/test case reference ids actually validated.") do
     options[:report_all_test_refs] = true
   end
+  opts.on("", "--capture_load_times CAPTURE_LOAD_TIMES", "Capture load time for gem requires.") do
+    options[:capture_load_times] = true
+  end
 
 end.parse!
 
@@ -92,6 +103,10 @@ options[:environment]["url"] = options[:environment_url]
 options[:environment]["nodename"] = options[:environment_nodename]
 check_script_type(options)
 
+$watir_script       = options[:classic_watir]
+$capture_load_times = options[:capture_load_times] unless $capture_load_times
+
+
 IS_WIN_2008 = File.exists?("config/win2008.txt")
 Awetestlib::Runner.new(options)
 

data/bin/awetestlib-helpers.rb

@@ -40,3 +40,22 @@ def check_script_type(options)
     options[:script_file] = ARGV[0]
   end
 end
+
+def load_time(what = nil, time = Time.now)
+  if $capture_load_times
+    caller = Kernel.caller
+    called = $"
+    unless what
+      what = "#{caller[0]} => #{called[called.length - 1]}"
+    end
+    elapsed = time - $base_time
+    msg = "#{what} #{sprintf('%.4f', elapsed)}"
+    $load_times[time.to_f] = msg
+    begin
+      debug_to_report("#{time.to_f}: #{msg}")
+    rescue
+      puts("#{time.to_f}: #{msg}")
+    end
+    $base_time = time
+  end
+end

data/lib/awetestlib.rb

@@ -27,13 +27,13 @@ module Awetestlib
   #require 'active_support/inflector'
   #require 'active_support/core_ext/object'
   #require 'active_support/core_ext/hash'
-  require 'awetestlib/runner'
-  require 'andand'
-  require 'awetestlib/regression/runner'
-  require 'pry'
+  require 'awetestlib/runner'  #; load_time
+  require 'andand'  #; load_time
+  require 'awetestlib/regression/runner'  #; load_time
+  require 'pry'  #; load_time
 
   if USING_OSX
-    require 'appscript'
+    require 'appscript'  #; load_time
   end
 
   #require 'roo' #moved to awetestlib runner

data/lib/awetestlib/html_report.rb

@@ -5,7 +5,7 @@ module Awetestlib
     # Initialize the report class
     # @private
     def initialize(report_name)
-      @reportname = report_name
+      @reportname     = report_name
       @reportContent1 = ''
       @reportContent2 = ''
     end
@@ -16,13 +16,17 @@ module Awetestlib
       # Get current time
       t = Time.now
 
+      @col_1_p        = '65%'
+      @col_2_p        = '25%'
+      @col_3_p        = '10%'
+
       # Create the report name
-      strTime = "#{t.strftime("%Y%m%d_%H%M%S")}"
-      strNiceTime = "#{t.strftime("%m/%d/%Y @ %H:%M:%S")}"
-      strTotalReport = "#{reportName}_#{strTime}.html"
+      rpt_time        = "#{t.strftime("%Y%m%d_%H%M%S")}"
+      rpt_nice_time   = "#{t.strftime("%m/%d/%Y @ %H:%M:%S")}"
+      rpt_file_name   = "#{reportName}_#{rpt_time}.html"
 
       # Create the HTML report
-      strFile = File.open(strTotalReport, 'w')
+      rpt_file        = File.open(rpt_file_name, 'w')
 
       # Format the header of the HTML report
       @reportContent1 = '<html>
@@ -31,19 +35,22 @@ module Awetestlib
         <title>Awetestlib Test Run</title>
         <style type=text/css>
         .title { font-family: verdana; font-size: 30px;  font-weight: bold; align: left; color: #000000;}
-        .bold_text { font-family: verdana; font-size: 12px;  font-weight: bold;}
-        .bold_large_text { font-family: verdana; font-size: 13px;  font-weight: bold;}
-        .normal_text { font-family: verdana; font-size: 12px;  font-weight: normal;}
-        .small_text { font-family: verdana; font-size: 10px;  font-weight: normal; }
+        .bold_text { font-family: verdana; font-size: 11px;  font-weight: bold;}
+        .bold_large_text { font-family: verdana; font-size: 12px;  font-weight: bold;}
+        .normal_text { font-family: verdana; font-size: 11px; font-weight: normal;}
+        .center_text { font-family: verdana; font-size: 11px; font-weight: normal; text-align: center;}
+        .small_text { font-family: verdana; font-size: 9px;  font-weight: normal; }
         .border { border: 1px solid #000000;}
         .mark_testlevel_left { border-top: 1px solid #858585; border-left: 1px solid #858585;background-color:#E2F4FE;}
+        .mark_testlevel_middle { border-top: 1px solid #858585; background-color:#E2F4FE;}
         .mark_testlevel_right { border-top: 1px solid #858585; border-right: 1px solid #858585;background-color:#E2F4FE;}
         .border_left { border-top: 1px solid #858585; border-left: 1px solid #858585; border-right: 1px solid #858585;}
+        .border_middle { border-top: 1px solid #858585; border-right: 1px solid #858585;}
         .border_right { border-top: 1px solid #858585; border-right: 1px solid #858585;}
-        .result_ok { font-family: verdana; font-size: 12px;  font-weight: bold; text-align: center; color: green;}
-        .result_nok { font-family: verdana; font-size: 12px;  font-weight: bold; text-align: center; color: red;}
-        .overall_ok { font-family: verdana; font-size: 12px;  font-weight: bold; text-align: left; color: green;}
-        .overall_nok { font-family: verdana; font-size: 12px;  font-weight: bold; text-align: left; color: red;}
+        .result_ok { font-family: verdana; font-size: 11px;  font-weight: bold; text-align: center; color: green;}
+        .result_nok { font-family: verdana; font-size: 11px;  font-weight: bold; text-align: center; color: red;}
+        .overall_ok { font-family: verdana; font-size: 11px;  font-weight: bold; text-align: left; color: green;}
+        .overall_nok { font-family: verdana; font-size: 11px;  font-weight: bold; text-align: left; color: red;}
         .bborder_left { border-top: 1px solid #858585; border-left: 1px solid #858585; border-bottom: 1px solid #858585; background-color:#858585;font-family: verdana; font-size: 12px;  font-weight: bold; text-align: center; color: white;}
         .bborder_right { border-right: 1px solid #858585; background-color:#858585;font-family: verdana; font-size: 12px;  font-weight: bold; text-align: center; color: white;}
         </style>
@@ -51,11 +58,11 @@ module Awetestlib
         <body>
         <br>
         <center>
-        <table width=800 border=0 cellpadding=2 cellspacing=2>
+        <table width=auto border=0 cellpadding=2 cellspacing=2>
         <tbody>
         <tr>
         <td>
-        <table width=100% border=0 cellpadding=2 cellspacing=2>
+        <table width=90% border=0 cellpadding=2 cellspacing=2>
         <tbody>
         <tr>
         <td style=width: 150px;>&nbsp;</td>
@@ -67,17 +74,19 @@ module Awetestlib
         <br>
         <hr width=100% class=border size=1px>
         <center>
-        <table border=0 width=95% cellpadding=2 cellspacing=2>
+        <table border=0 width=100% cellpadding=2 cellspacing=2>
         <tbody>
         <tr>
+        <td width=10%><p class=normal_text></p></td>
         <td width=20%><p class=bold_text>Script</p></td>
         <td width=5%><p class=bold_text>:</p></td>
-        <td width=75%><p class=normal_text>' + @reportname.capitalize + '</p></td>
+        <td width=65%><p class=normal_text>' + @reportname.capitalize + '</p></td>
         </tr>
         <tr>
+        <td width=10%><p class=normal_text></p></td>
         <td width=20%><p class=bold_text>Test Execution</p></td>
         <td width=5%><p class=bold_text>:</p></td>
-        <td width=75%><p class=normal_text>' + strNiceTime + '</p></td>
+        <td width=65%><p class=normal_text>' + rpt_nice_time + '</p></td>
         </tr>
         <tr>'
 
@@ -87,56 +96,78 @@ module Awetestlib
         </center>
         <br>
         <center>
-        <table width=95% cellpadding=2 cellspacing=0>
+        <table width=100% cellpadding=2 cellspacing=0>
         <tbody>
         <tr>
-        <td class=bborder_left width=80%><p>Test Step</p></td>
-        <td class=bborder_left width=20%><p>Result</p></td>
-        </tr>'
+        <td class=bborder_left width=' + @col_1_p + '><p>Test Step</p></td>
+        <td class=bborder_left width=' + @col_2_p + '><p>Location</p></td>
+        <td class=bborder_left width=' + @col_3_p + '><p>Result</p></td>
+        </tr>' + "\n"
 
       # Close the report
-      strFile.close
+      rpt_file.close
 
-      return strTotalReport
+      return rpt_file_name
     end
 
     # Add a row to the report
     # @private
-    def add_to_report(step, result, level = 1)
+    def add_to_report(message, location, result, level = 1)
       # Format the body of the HTML report
-      if (result == 'PASSED')
-        @reportContent2 = @reportContent2 + '<tr><td class=border_left width=80%><p class=normal_text>' + step + '</p></td>'
-        @reportContent2 = @reportContent2 + '<td class=border_right width=20%><p class=result_ok>' + result + '</p></td>'
-      elsif (result == 'FAILED')
-        @reportContent2 = @reportContent2 + '<tr><td class=border_left width=80%><p class=normal_text>' + step + '</p></td>'
-        @reportContent2 = @reportContent2 + '<td class=border_right width=20%><p class=result_nok>' + result + '</p></td>'
-      elsif level < 1
-        @reportContent2 = @reportContent2 + '<tr><td class=border_left width=80%><p class=normal_text>' + step + '</p></td>'
-        @reportContent2 = @reportContent2 + '<td class=border_right width=20%><p class=result_nok>' + result + '</p></td>'
-      else
-        @reportContent2 = @reportContent2 + '<tr><td class=mark_testlevel_left width=80%><p class=bold_large_text>' + step + '</p></td>'
-        @reportContent2 = @reportContent2 + '<td class=mark_testlevel_right width=20%><p class=result_nok>' + result + '</p></td>'
+
+      left_class   = 'border_left'
+      right_class  = 'border_right'
+      pgph_class   = 'normal_text'
+      loc_class    = 'center_text'
+      rslt_class   = 'result_ok'
+      middle_class = 'border_middle'
+
+      rslt_class = 'result_nok' if result == "FAILED"
+      case result
+        when 'FAILED'
+          rslt_class = 'result_nok'
+        when 'PASSED'
+          rslt_class = 'result_ok'
+        else
+          if level
+            if level >= 1
+              pgph_class   = 'bold_large_text'
+              left_class   = 'mark_testlevel_left'
+              middle_class = 'mark_testlevel_middle'
+              right_class  = 'mark_testlevel_right'
+            end
+          end
       end
+
+      row = '<tr>
+        <td class=' + left_class + ' width=' + @col_1_p + '><p class=' + pgph_class + '>' + message + '</p></td>
+        <td class=' + middle_class + ' width=' + @col_2_p + '><p class=' + loc_class + '>' + location + '</p></td>
+        <td class=' + right_class + ' width=' + @col_3_p + '><p class=' + rslt_class + '>' + result + '</p></td>
+        </tr>'
+
+      @reportContent2 += row + "\n"
+
     end
 
     # Close the report HTML
     # @private
     def finish_report(reportName)
       # Open the HTML report
-      strFile = File.open(reportName, 'a')
+      rpt_file = File.open(reportName, 'a')
 
       @reportContent2 = @reportContent2 + '<tr>
-      <td class=bborder_left width=80%><p>&nbsp;</p></td>
-      <td class=bborder_left width=20%><p>&nbsp;</p></td>
+      <td class=bborder_left width=' + @col_1_p + '><p>&nbsp;</p></td>
+      <td class=bborder_left width=' + @col_2_p + '><p>&nbsp;</p></td>
+      <td class=bborder_left width=' + @col_3_p + '><p>&nbsp;</p></td>
       </tr>
       </table>'
 
-      strFile.puts(@reportContent1)
+      rpt_file.puts(@reportContent1)
 
-      strFile.puts(@reportContent2)
+      rpt_file.puts(@reportContent2)
 
       # Close the report
-      strFile.close
+      rpt_file.close
     end
   end
 end

data/lib/awetestlib/logging.rb

@@ -99,7 +99,7 @@ module Awetestlib
       # failed_to_log "SIKULI LOG:\n\n #{output_lines.join('\n')}"
       # end
 
-      return { :result => passed, :msg => output_str }
+      return { :result => passed, :msg => output_lines }
     end
 
 
@@ -126,9 +126,9 @@ module Awetestlib
       end
       strg << " #{message}" if message.length > 0
       strg << " (#{desc})" if desc.length > 0
-      strg << " [#{call_line}]"
+      strg << " [#{call_line}]" if dbg or @debug_calls
       strg << "\n#{list.to_yaml}" if dbg or @debug_calls
-      @report_class.add_to_report(strg, "&nbsp", lvl || 1) unless Awetestlib::Runner.nil?
+      @report_class.add_to_report(strg, "&nbsp", "&nbsp", lvl || 1) unless Awetestlib::Runner.nil?
       log_message(INFO, strg, lvl, nil, 1)
     rescue
       failed_to_log("#{__method__}: #{$!}")
@@ -170,7 +170,7 @@ module Awetestlib
       message << " \n#{get_debug_list}" if dbg or @debug_calls # and not @debug_calls_fail_only)
       @my_passed_count += 1 if @my_passed_count
       parse_error_references(message)
-      @report_class.add_to_report(message, "PASSED") unless Awetestlib::Runner.nil?
+      @report_class.add_to_report(message, get_caller(lnbr), "PASSED") unless Awetestlib::Runner.nil?
       log_message(INFO, "#{message}", PASS, lnbr)
     end
 
@@ -186,7 +186,7 @@ module Awetestlib
       message << " \n#{get_debug_list}" if dbg.to_s == 'true' or @debug_calls or @debug_calls_fail_only
       @my_failed_count += 1 if @my_failed_count
       parse_error_references(message, true)
-      @report_class.add_to_report("#{message}" + " [#{get_caller(lnbr)}]", "FAILED") unless Awetestlib::Runner.nil?
+      @report_class.add_to_report("#{message}", get_caller(lnbr), "FAILED") unless Awetestlib::Runner.nil?
       log_message(WARN, "#{message}", FAIL, lnbr, nil, exception)
     end
 
@@ -202,7 +202,7 @@ module Awetestlib
       message << " \n#{get_debug_list}" if dbg.to_s == 'true' or (@debug_calls and not @debug_calls_fail_only)
       @my_failed_count += 1 if @my_failed_count
       parse_error_references(message, true)
-      @report_class.add_to_report("#{message}" + " [#{get_caller(lnbr)}]", "FAILED") unless Awetestlib::Runner.nil?
+      @report_class.add_to_report("#{message}", get_caller(lnbr), "FAILED") unless Awetestlib::Runner.nil?
       debug_to_report("#{__method__}:\n#{dump_caller(lnbr)}")
       log_message(FATAL, "#{message} (#{lnbr})", FAIL, lnbr, nil, exception)
     end

data/lib/awetestlib/regression/browser.rb

@@ -40,6 +40,7 @@ module Awetestlib
 
       # Open a browser based on the command line parameters that identify the browser and
       # version to use for the test.
+      # @note Safari currently supported only on Mac OS X
       # @example
       #  browser = open_browser('www.google.com')
       # @param [String, Regexp] url When provided, the browser will go to this url.
@@ -53,10 +54,13 @@ module Awetestlib
               @myHwnd = @myBrowser.hwnd
             end
           when 'FF'
-            @myBrowser = open_ff_for_version
+            @myBrowser = open_ff
           when 'S'
-            aBrowser = Watir::Browser.new :safari
-            @myBrowser = aBrowser
+            if USING_OSX
+              @myBrowser = open_safari
+            else
+              raise "Safari is not supported under this operating system #{RUBY_PLATFORM}"
+            end
           when 'C', 'GC'
             @myBrowser = open_chrome
           else
@@ -82,18 +86,16 @@ module Awetestlib
         browser
       end
 
-      # Open FF (Firefox) browser instance.
-      # @param [Fixnum] version A number designating the version of the browser to be opened.
-      # @return [Watir::Browser, Firewatir::Browser]
-      # Returns Firewatir::Browser if target browser is Firefox version less than 4.0
-      def open_ff_for_version(version = @targetVersion)
-        browser = Watir::Browser.new :firefox
+      # Open Safari browser instance.
+      # @note Safari currently supported only on Mac OS X
+      # @return [Watir::Browser]
+      def open_safari
+        browser = Watir::Browser.new(:remote, :desired_capabilities=>:'safari')
       end
 
       # Open FF (Firefox) browser instance under FireWatir.
-      # @return [Firewatir::Browser]
+      # @return [Watir::Browser]
       def open_ff
-        # Watir::Browser.default = 'firefox'
         browser = Watir::Browser.new :firefox
       end
 
@@ -502,17 +504,18 @@ module Awetestlib
       end
 
       # Closes main browser session. Misnamed. Usually used at end of script to shut down browser.
-      def logout(browser, where = @myName, lnbr = __LINE__)
+      def close_browser(browser, where = @myName, lnbr = __LINE__)
         #TODO Firewatir 1.6.5 does not implement .exists for FireWatir::Firefox class
         debug_to_log("Logging out in #{where} at line #{lnbr}.", lnbr, true)
         debug_to_log("#{__method__}: browser: #{browser.inspect} (#{__LINE__})")
 
+        url   = browser.url
+        title = browser.title
+
         if ['FF', 'S'].include?(@browserAbbrev) || browser.exists?
           case @browserAbbrev
             when 'FF'
               if is_browser?(browser)
-                url   = browser.url
-                title = browser.title
                 debug_to_log("#{__method__}: Firefox browser url: [#{url}]")
                 debug_to_log("#{__method__}: Firefox browser title: [#{title}]")
                 debug_to_log("#{__method__}: Closing browser: #{where} (#{lnbr})")
@@ -525,16 +528,23 @@ module Awetestlib
 
               end
             when 'IE'
-              hwnd = browser.hwnd
-              pid  = Watir::IE::Process.process_id_from_hwnd(hwnd)
-              debug_to_log("#{__method__}: Closing browser: hwnd #{hwnd} pid #{pid} #{where} (#{lnbr}) (#{__LINE__})")
-              browser.close
-              if browser.exists? and pid > 0 and pid < 538976288 # value of uninitialized memory location
-                debug_to_log("Retry close browser: hwnd #{hwnd} pid #{pid} #{where} #{lnbr} (#{__LINE__})")
+              debug_to_log("#{__method__}: Internet Explorer browser url: [#{url}]")
+              debug_to_log("#{__method__}: Internet Explorer browser title: [#{title}]")
+              debug_to_log("#{__method__}: Closing browser: #{where} (#{lnbr})")
+              if $watir_script
+                hwnd = browser.hwnd
+                pid  = Watir::IE::Process.process_id_from_hwnd(hwnd)
+                debug_to_log("#{__method__}: Closing browser: hwnd #{hwnd} pid #{pid} #{where} (#{lnbr}) (#{__LINE__})")
+                browser.close
+                if browser.exists? and pid > 0 and pid < 538976288 # value of uninitialized memory location
+                  debug_to_log("Retry close browser: hwnd #{hwnd} pid #{pid} #{where} #{lnbr} (#{__LINE__})")
+                  browser.close
+                end
+                if browser.exists? and pid > 0 and pid < 538976288 # value of uninitialized memory location
+                  kill_browser(browser.hwnd, __LINE__, browser)
+                end
+              else
                 browser.close
-              end
-              if browser.exists? and pid > 0 and pid < 538976288 # value of uninitialized memory location
-                kill_browser(browser.hwnd, __LINE__, browser)
               end
             when 'S'
               if is_browser?(browser)
@@ -555,9 +565,6 @@ module Awetestlib
                 debug_to_log("Closing browser: #{where} (#{lnbr})")
                 if url and url.length > 1
                   browser.close
-                  #else
-                  #browser = FireWatir::Firefox.attach(:title, title)
-                  #browser.close
                 end
 
               end
@@ -565,12 +572,12 @@ module Awetestlib
               raise "Unsupported browser: '#{@browserAbbrev}'"
           end
         end
-        #  rescue => e
-        #    if not e.is_a?(Vapir::WindowGoneException)
-        #      raise e
-        #    end
+      rescue
+        failed_to_log(unable_to)
       end
 
+      alias logout close_browser
+
       # Close a browser popup window. Does not apply to modal popups.
       # @param [Watir::Browser] popup Reference to the popup to be closed
       def close_new_window_popup(popup)