awetestlib 0.1.30-x86-mingw32 → 1.2.4-x86-mingw32

data/lib/awetestlib/regression/waits.rb

@@ -13,10 +13,10 @@ module Awetestlib
       # @param [Fixnum] seconds The number of seconds to wait.
       # @param [Boolean] dbg If true, includes a trace in the message
       # @param [String] desc Contains a message or description intended to appear in the log and/or report output.
-      def sleep_for(seconds, dbg = true, desc = '')
-        trace = "\n#{get_debug_list}" if dbg
+      def sleep_for(seconds, desc = '')
+        trace = $debug ? "\n#{get_debug_list}" : ''
         msg = build_message("Sleeping for #{seconds} seconds.", desc, trace)
-        info_to_log(msg)
+        info_to_log(msg, 3)
         sleep(seconds)
       end
 
@@ -51,6 +51,7 @@ module Awetestlib
         start = Time.now.to_f
         # TODO: try Watir::Wait.until { browser.element(how, what).exists? } instead of this (cumbersome) case statement
         # TODO: above fails on frame
+        # TODO: Webdriver compatibility?
         Watir::Wait.until { browser.exists? }
         begin
           case element
@@ -88,12 +89,11 @@ module Awetestlib
           end
         end
         stop = Time.now.to_f
-        #debug_to_log("#{__method__}: start:#{start} stop:#{stop}")
-        #    sleep 1
-        passed_to_log("#{msg} (#{stop - start} seconds)")
+        msg += " (#{"%.5f" % (stop - start)} seconds)"
+        passed_to_log(msg)
         true
       rescue
-        failed_to_log("Unable to complete #{msg}: '#{$!}'")
+        failed_to_log(unable_to(msg))
       end
 
       # Wait _while_ expression in *&block* returns true.
@@ -111,7 +111,7 @@ module Awetestlib
       # @return [Boolean] True if condition returns false within time limit.
       def wait_while(browser, desc, timeout = 45, &block)
         #TODO: Would like to be able to see the block code in the log message instead of the identification
-        msg   = "Wait while #{desc}:"
+        msg   = build_message("Wait while", desc)
         start = Time.now.to_f
         Watir::Wait.until { browser.exists? }
         begin
@@ -128,9 +128,8 @@ module Awetestlib
           end
         end
         stop = Time.now.to_f
-        #debug_to_log("#{__method__}: start:#{start} stop:#{stop} block: #{block.to_s}")
-                                                                     #    sleep 1
-        passed_to_log("#{msg} (#{"%.5f" % (stop - start)} seconds)") #  {#{block.to_s}}")
+        msg += " (#{"%.5f" % (stop - start)} seconds)"
+        passed_to_log(msg)
         true
       rescue
         failed_to_log("Unable to complete #{msg}. '#{$!}'")
@@ -146,7 +145,7 @@ module Awetestlib
       # @return [Boolean] True if condition in *&block* returns true within time limit.
       def wait_until(browser, desc, timeout = 45, skip_pass = false, &block)
         #TODO: Would like to be able to see the block code in the log message instead of the identification
-        msg   = "Wait until #{desc}"
+        msg   = build_message("Wait until", desc)
         start = Time.now.to_f
         Watir::Wait.until { browser.exists? }
         begin
@@ -160,12 +159,11 @@ module Awetestlib
           end
         end
         stop = Time.now.to_f
-        #debug_to_log("#{__method__}: start:#{start} stop:#{stop} block: #{block.to_s}")
-                                                                                      #    sleep 1
-        passed_to_log("#{msg} (#{"%.5f" % (stop - start)} seconds)") unless skip_pass #  {#{block.to_s}}")
+        msg += " (#{"%.5f" % (stop - start)} seconds)"
+        passed_to_log(msg) unless skip_pass #  {#{block.to_s}}")
         true
       rescue
-        failed_to_log("Unable to complete #{msg}  '#{$!}'")
+        failed_to_log(unable_to(msg))
       end
 
       alias wait_until_true wait_until
@@ -179,147 +177,77 @@ module Awetestlib
       # @param [String, Regexp] what A string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
       # @param [String] desc Contains a message or description intended to appear in the log and/or report output
       # @param [Fixnum] timeout Maximum time to wait, in seconds.
-      # @param [Boolean] verbose When set to true, more debug information is written to the log and
-      # all steps return pass/fail messages in the report.
-      # @return [Boolean] True if condition returns false within time limit.
-      def wait_until_ready(browser, how, what, desc = '', timeout = 90, verbose = false)
-        msg = "#{__method__.to_s.titleize}: element: #{how}='#{what}'"
-        msg << " #{desc}" if desc.length > 0
-        proc_exists  = Proc.new { browser.element(how, what).exists? }
-        proc_enabled = Proc.new { browser.element(how, what).enabled? }
-        case how
-          when :href
+      # @param [Boolean] verbose When set to true, actual wait time is reported.
+      # @param [Boolean] quiet When set to true, only fail messages are logged and reported.
+      # @return [Boolean] True if element is ready within time limit.
+      def wait_until_ready(browser, how, what, desc = '', timeout = 90, verbose = true, quiet = false)
+        msg = build_message("Wait until element :#{how}=>'#{what}') is ready.", desc)
+        ok  = false
+        start = Time.now.to_f if verbose
+        Watir::Wait.until(timeout) { browser.exists? }
+
+        if $using_webdriver
+          proc_present = Proc.new { browser.element(how, what).present? }
+          if Watir::Wait.until(timeout) { proc_present.call(nil) }
+            ok = true
+          end
+        else
+          proc_exists  = Proc.new { browser.element(how, what).exists? }
+          proc_enabled = Proc.new { browser.element(how, what).enabled? }
+          if how == :href
             proc_exists  = Proc.new { browser.link(how, what).exists? }
             proc_enabled = Proc.new { browser.link(how, what).enabled? }
-        end
-        if verbose
-          if wait_until(browser, "#{msg} Element exists.", timeout) { proc_exists.call(nil) }
-            if wait_until(browser, "#{msg} Element enabled.", timeout) { proc_enabled.call(nil) }
-              passed_to_log(msg)
-              true
-            else
-              failed_to_log(msg)
-            end
-          else
-            failed_to_log(msg)
           end
-        else
-          start = Time.now.to_f
-          Watir::Wait.until { browser.exists? }
           if Watir::Wait.until(timeout) { proc_exists.call(nil) }
             if Watir::Wait.until(timeout) { proc_enabled.call(nil) }
-              stop = Time.now.to_f
-              #debug_to_log("#{__method__}: start:#{"%.5f" % start} stop:#{"%.5f" % stop}")
-              passed_to_log("#{msg} (#{"%.5f" % (stop - start)} seconds)")
-              true
-            else
-              failed_to_log(msg)
+              ok = true
             end
-          else
-            failed_to_log(msg)
           end
         end
-      rescue
-        failed_to_log("Unable to #{msg}. '#{$!}'")
-      end
 
-      # Wait _until_ element, identified by attribute *how* and its value *what*, exists.
-      # If it exists within *timeout* seconds then wait _until_ it is enabled.  Report only failures.
-      # @param [Watir::Browser] browser A reference to the browser window or container element to be tested.
-      # @param [Symbol] how The element attribute used to identify the specific element.
-      #   Valid values depend on the kind of element.
-      #   Common values: :text, :id, :title, :name, :class, :href (:link only)
-      # @param [String, Regexp] what A string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
-      # @param [String] desc Contains a message or description intended to appear in the log and/or report output
-      # @param [Fixnum] timeout Maximum time to wait, in seconds.
-      # @param [Boolean] quiet When set to true, only fail messages are logged and reported.
-      # @return [Boolean] True if condition returns false within time limit.
-      def wait_until_ready_quiet(browser, how, what, desc = '', timeout = 45, quiet = true)
-        msg = "#{__method__.to_s.titleize}: element: #{how}='#{what}'"
-        msg << " #{desc}" if desc.length > 0
-        proc_exists  = Proc.new { browser.element(how, what).exists? }
-        proc_enabled = Proc.new { browser.element(how, what).enabled? }
-        case how
-          when :href
-            proc_exists  = Proc.new { browser.link(how, what).exists? }
-            proc_enabled = Proc.new { browser.link(how, what).enabled? }
+        if verbose
+          stop = Time.now.to_f
+          msg += " (#{"%.5f" % (stop - start)} seconds)"
         end
-        start = Time.now.to_f
-        Watir::Wait.until { browser.exists? }
-        sleep_for(1)
-        if Watir::Wait.until(timeout) { proc_exists.call(nil) }
-          if Watir::Wait.until(timeout) { proc_enabled.call(nil) }
-            stop = Time.now.to_f
-            #debug_to_log("#{msg}: start:#{"%.5f" % start} stop:#{"%.5f" % stop}")
-            passed_to_log("#{msg} (#{"%.5f" % (stop - start)} seconds)") unless quiet
-            true
-          else
-            failed_to_log(msg)
+        if ok
+          unless quiet
+            passed_to_log(msg)
           end
         else
           failed_to_log(msg)
         end
+        ok
       rescue
-        failed_to_log("Unable to #{msg}. '#{$!}'")
+        failed_to_log(unable_to(msg))
+      end
+
+      # Wait _until_ element, identified by attribute *how* and its value *what*, exists.
+      # If it exists within *timeout* seconds then wait _until_ it is enabled. By default reports only failures.
+      # @param (see #wait_until_ready)
+      # @return [Boolean] True if  element is ready within time limit.
+      def wait_until_ready_quiet(browser, how, what, desc = '', timeout = 90, quiet = true, verbose = false)
+        wait_until_ready(browser, how, what, desc, timeout, verbose, quiet)
       end
 
-      def wait_until_text(browser, strg, desc = '', timeout = 60)
-        if not strg.class.to_s.match('String')
+      def wait_until_text(browser, strg, desc = '', refs = '', timeout = 60)
+        unless strg.class.to_s.match('String')
           raise "#{__method__} requires String for search target. #{strg.class} is not supported."
         end
-        wait_until(browser, "'#{strg}' #{desc}", timeout) { browser.text.include? strg }
+        wait_until(browser, "'#{strg}' #{desc} #{refs}", timeout) { browser.text.include? strg }
       end
 
       alias wait_until_by_text wait_until_text
 
-      def wait_until_enabled(browser, what, how, value, desc = '')
-        # TODO: This can be simplified
-        start = Time.now.to_f
-        Watir::Wait.until { browser.exists? }
-        sleep_for(1)
-        begin
-          case what
-            when :link
-              Watir::Wait.until { browser.link(how, value).enabled? }
-            when :button
-              Watir::Wait.until { browser.button(how, value).enabled? }
-            when :radio
-              Watir::Wait.until { browser.radio(how, value).enabled? }
-            when :checkbox
-              Watir::Wait.until { browser.checkbox(how, value).enabled? }
-            when :div
-              Watir::Wait.until { browser.div(how, value).enabled? }
-            when :select_list
-              Watir::Wait.until { browser.select_list(how, value).enabled? }
-            when :text_field
-              Watir::Wait.until { browser.text_field(how, value).enabled? }
-            when :table
-              Watir::Wait.until { browser.table(how, value).enabled? }
-            else
-              Watir::Wait.until { browser.element(how, value).enabled? }
-          end
-        rescue => e
-          if e.class.to_s =~ /TimeOutException/
-            failed_to_log("Wait until (#{what} :#{how}=>#{value}) enabled. #{desc}: '#{$!}' #{desc}")
-            return false
-          elsif not rescue_me(e, __method__, "#{block.to_s}", "#{browser.class}")
-            raise e
-          end
-        end
-        stop = Time.now.to_f
-        #debug_to_log("#{__method__}: start:#{start} stop:#{stop}")
-        #    sleep 1
-        passed_to_log("Wait until (#{what} :#{how}=>#{value}) enabled. #{desc} (#{stop - start} seconds)")
-        true
-      rescue
-        failed_to_log("Unable to complete wait until (#{what} :#{how}=>#{value}) enabled. #{desc}: '#{$!}'")
+      def wait_until_enabled(browser, element, how, what, desc = '')
+        wait_until_ready(browser, how, what, desc, timeout = 90, verbose = true, quiet = false)
       end
 
-      def wait_until_visible(browser, element, how, what, desc = '')
+      def wait_until_visible(browser, element, how, what, desc = '', timeout = 60)
+        msg = build_message("Wait until #{element} :#{how}=>'#{what}') is visible.", desc)
         start = Time.now.to_f
         Watir::Wait.until { browser.exists? }
         sleep_for(1)
-        Watir::Wait.until(20) { browser.element(how, what).exists? }
+        Watir::Wait.until(timeout) { browser.element(how, what).exists? }
         begin
           case element
             when :link
@@ -349,12 +277,11 @@ module Awetestlib
           end
         end
         stop = Time.now.to_f
-        #debug_to_log("#{__method__}: start:#{start} stop:#{stop}")
-        #    sleep 1
-        passed_to_log("Wait until (#{element} :#{how}=>#{what}) visible. #{desc} (#{stop - start} seconds)")
+        msg += " (#{"%.5f" % (stop - start)} seconds)"
+        passed_to_log(msg)
         true
       rescue
-        failed_to_log("Unable to complete wait until (#{element} :#{how}=>#{what}) visible. #{desc}: '#{$!}'")
+        failed_to_log(unable_to(msg))
       end
 
       # @!endgroup Core

data/lib/awetestlib/runner.rb

@@ -1,5 +1,6 @@
 require 'open-uri'  #; load_time
 module Awetestlib
+  # TODO replace this with regression/runner.  Only one script type.
   # Parent class. Each script type will have a Runner that inherits from this class.
   class Runner
     def initialize(options = {})
@@ -9,8 +10,10 @@ module Awetestlib
 
     def check_script_type(script_type)
       case script_type
-        when "Regression" ; "Regression" #Should this be regression? possible rename
-        else              ; script_type
+        when 'Regression', 'Awetest', 'AwetestDSL', 'Awetestlib'
+          'Regression'
+        else
+          script_type
       end
     end
   end

data/lib/version.rb

@@ -1,4 +1,13 @@
 module Awetestlib
-  VERSION = "0.1.30"
-  VERSION_DATE = "2013-05-21"
+  VERSION      = "1.2.4"
+  VERSION_DATE = "2016-07-19"
+  if Dir.exists?('.git')
+    require 'git'
+    git      = Git.open(Dir.pwd)
+    branch   = git.current_branch
+    commit   = git.gblob(branch).log(5).first
+    BRANCH   = branch
+    SHA      = commit.sha
+    SHA_DATE = commit.date
+  end
 end

data/setup_samples/sample_cucumber/features/step_definitions/predefined_steps.rb

@@ -5,20 +5,20 @@ rescue
 end
 
 def setup_classic_watir
-  require 'watir'
-  require 'win32ole'
-  $ai           = ::WIN32OLE.new('AutoItX3.Control')
-  $first_index  = 1
-  $timestamp    = Time.now.strftime("%Y%m%d%H%M%S")
-  $watir_script = true
-  Watir::IE.close_all
-  Watir::IE.visible = true
-end
+    require 'watir'
+    require 'win32ole'
+    $ai          = ::WIN32OLE.new('AutoItX3.Control')
+    $first_index = 1
+    $timestamp     = Time.now.strftime("%Y%m%d%H%M%S")
+    $watir_script = true
+    Watir::IE.close_all
+    Watir::IE.visible = true
+  end
 
 def setup_watir_webdriver
   require 'watir-webdriver'
-  $first_index  = 0
-  $timestamp    = Time.now.strftime("%Y%m%d%H%M%S")
+  $first_index = 0
+  $timestamp     = Time.now.strftime("%Y%m%d%H%M%S")
   $watir_script = false
 end
 
@@ -29,7 +29,7 @@ end
 
 def open_safari
   setup_watir_webdriver
-  @browser = Watir::Browser.new(:remote, :desired_capabilities => :'safari')
+  @browser = Watir::Browser.new(:remote, :desired_capabilities=>:'safari')
 end
 
 def open_chrome
@@ -52,7 +52,7 @@ end
 
 def navigate_to_environment_url
   if @params and @params['environment'] and @params['environment']['url']
-    url = @params['environment']['url']
+  url = @params['environment']['url']
   elsif @login and @login['url']
     url = @login['url']
   elsif @role and @login[@role] and @login[@role]['url']
@@ -63,24 +63,24 @@ end
 
 def open_a_browser
   if @params
-    puts "@params: #{@params}"
-    case @params["browser"]
-      when "FF"
-        open_firefox
-      when "IE"
-        open_internet_explorer
-      when "C", "GC"
-        open_chrome
-      when "S"
-        open_safari
-    end
-  else
-    if $watir_script
-      open_internet_explorer
-    else
-      open_firefox
-    end
-  end
+     puts "@params: #{@params}"
+ 	  case @params["browser"]
+       when "FF"
+         open_firefox
+       when "IE"
+         open_internet_explorer
+       when "C", "GC"
+         open_chrome
+       when "S"
+       	 open_safari
+ 	  end
+ 	else
+     if $watir_script
+       open_internet_explorer
+     else
+       open_firefox
+     end
+   end
 end
 
 Given /^I run with Watir$/ do
@@ -187,7 +187,7 @@ And /^I enter the value for "(.*?)" in text field with "?(.*?)"? "(.*?)"$/ do |i
   if index =~ /zipcode/
     value = @var[index].to_i.to_s
   else
-    value = @var[index]
+    value = index
   end
   step "I enter \"#{value}\" in text field with #{how} \"#{what}\""
 end
@@ -260,9 +260,9 @@ When /^I wait until "?(.*?)"? with "?(.*?)"? "(.*?)" is ready$/ do |element, how
   #what = Regexp.new(Regexp.escape(what)) unless how =~ /index|text/i or what.is_a?(Regexp)
   ok = false
   if $watir_script
-    if Watir::Wait.until { @browser.element(how, what).exists? }
-      if Watir::Wait.until { @browser.element(how, what).visible? }
-        if Watir::Wait.until { @browser.element(how, what).enabled? }
+    if Watir::Wait.until {@browser.element(how, what).exists?}
+      if Watir::Wait.until {@browser.element(how, what).visible?}
+        if Watir::Wait.until {@browser.element(how, what).enabled?}
           ok = true
         end
       end
@@ -276,8 +276,8 @@ When /^I wait until "?(.*?)"? with "?(.*?)"? "(.*?)" is ready$/ do |element, how
       when 'text field'
         sleep 2
         #if @browser.text_field(how.to_sym, what).wait_until_present
-        ok = true
-      #end
+          ok = true
+        #end
       else
         if @browser.element(how.to_sym, what).wait_until_present
           ok = true
@@ -311,16 +311,45 @@ And /^I close the browser$/ do
   @browser.close
 end
 
+When(/^I should see "([^"]*)" but proceed if not present$/) do |arg|
+  @text_list[arg]= @browser.link(:text, "#{arg}").exists?
+  File.open(@error_file,"w") do |f|
+    f.write(@text_list.to_json)
+  end
+
+  if @browser.link(:text, "#{arg}").exists?
+    # Do not take a screen shot
+  else
+    step "I take a screenshot"
+  end
+end
+
+Then(/^I interact with window having title "(.*?)"$/) do |arg1| # title of child window
+  sleep 5
+  counter = 0
+  if arg1 == "Parent_Window_Title"
+    @browser.driver.switch_to.window(@browser.driver.window_handles[0])
+  else
+    @browser.windows.each do |win|
+      if win.title == arg1 # switches control to child window
+        @browser.driver.switch_to.window(@browser.driver.window_handles[counter])
+      else
+        counter = counter + 1
+      end
+    end
+  end
+end
+
 Given /^I load data spreadsheet "(.*?)" for "(.*?)"$/ do |file, feature|
   require 'roo'
-  @workbook     = Excel.new(file)
-  @feature_name = feature #File.basename(feature, ".feature")
+  @workbook               = Excel.new(file)
+  @feature_name           = feature     #File.basename(feature, ".feature")
   step "I load @login from spreadsheet"
   step "I load @var from spreadsheet"
 end
 
 Then /^I load @login from spreadsheet$/ do
-  @login                  = Hash.new
+  @login                 = Hash.new
   @workbook.default_sheet = @workbook.sheets[0]
 
   script_col   = 0
@@ -369,10 +398,10 @@ Then /^I load @login from spreadsheet$/ do
 end
 
 Then /^I load @var from spreadsheet$/ do
-  @var                    = Hash.new
+  @var                   = Hash.new
   @workbook.default_sheet = @workbook.sheets[1]
-  script_col              = 0
-  name_col                = 0
+  script_col             = 0
+  name_col               = 0
 
   1.upto(@workbook.last_column) do |col|
     header = @workbook.cell(1, col)
@@ -391,9 +420,40 @@ Then /^I load @var from spreadsheet$/ do
   end
 end
 
-#Before do
-#  unless awetestlib?
-#    manifest_file = File.join(File.dirname(__FILE__), '..', 'manifest.json')
-#    @params = JSON.parse(File.open(manifest_file).read)['params'] #Have access to all params in manifest file
-#  end
-#end
+And(/^I take a screenshot$/) do
+  take_screenshot
+end
+
+Before do
+  # unless awetestlib?
+  #   manifest_file = File.join(File.dirname(__FILE__), '..', 'manifest.json')
+  #   @params = JSON.parse(File.open(manifest_file).read)['params'] #Have access to all params in manifest file
+  # end
+  @text_list = Hash.new()
+  @error_file = File.join(File.dirname(__FILE__), '..', '..', 'error.txt')
+
+  if $step_no.to_i < 3
+    $step_no = 2
+  else
+    $step_no = $step_no + 2
+  end
+end
+
+AfterStep() do
+  $step_no = $step_no + 1
+end
+
+After do |scenario|
+  if scenario.failed?
+    take_screenshot
+  else
+    $step_no = $step_no - 1
+  end
+end
+
+def take_screenshot
+  abc = File.expand_path("../..",File.dirname(__FILE__))
+  file_na = abc.split("/").last
+  file_path = File.join(File.dirname(__FILE__), '..', '..', "#{file_na.to_s}_#{$step_no}.jpg")
+  @browser.screenshot.save(file_path)
+end