awetestlib 0.1.29pre3-x86-mingw32 → 0.1.29pre4-x86-mingw32

data/README.md

@@ -3,9 +3,7 @@ Awetestlib
 
 Run automated regression and mobile tests
 
-After completing this guide you will be able to run tests locally from command line or from an IDE
-
-v0.1.29pre3 fixes an issue with running scripts against Safari on OSX
+After completing this guide you will be able to run tests locally from command line or from an IDE.
 
 ------------
 
@@ -18,21 +16,23 @@ You can check your Ruby version using:
 
     ruby -v
 
-Additionally, you will need to install DevKit to compile a few dependent gems. You can download DevKit
+Additionally, for Windows, you will need to install the RubyInstaller DevKit to compile a few dependent gems. You can download DevKit
 [here](http://rubyinstaller.org/downloads/)
+and the installation directions can be found
+[here](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit)
 
 ## Install
 
-In a terminal or command prompt, install the awetestlib gem
+In a terminal or command prompt, install the awetestlib gem:
 
     gem install awetestlib --no-ri --no-rdoc
 
-Note: This could take up to 5 minutes for first time installs and you may need to use 'sudo'
+Note: This could take up to 5 minutes for first time installs.  You may need to use 'sudo' on OSX
 
 
 ## Setup Regression Module
 
-To setup the regression module, run the following command and verify the step
+Run the following command and verify the step
   
     awetestlib regression_setup
 
@@ -99,10 +99,18 @@ The full list of parameters for the command line currently are:
 
     Usage: awetestlib <script_file> [parameters] [options]
         -b, --browser BROWSER            Specify a browser (IE, FF, S, C)
-        -l, --library LIBRARY            Specify a library to be loaded
         -r, --root_path ROOT_PATH        Specify the root path
+        -l, --library LIBRARY            Specify a library to be loaded
         -x, --excel EXCEL_FILE           Specify an excel file containing variables to be loaded
         -v, --version VERSION            Specify a browser version
+        -e, --environment_url URL        Specify the environment URL
+        -f, --environment_nodename NODE  Specify the environment node name
+        -n, --environment_name NAME      Specify the environment name
+        -u, --selenium_remote_url URL    Specify the device's remote url and port
+        -s, --screencap_path PATH        Specify the path where screenshots will be saved
+        -o, --output_to_log              Write to log file
+            --log_path_subdir SUBDIR     Specify log path relative to root_path
+            --report_all_test_refs       Include list of all error/test case reference ids actually validated
 
 To start writing your own script, refer to the [Scripting Guide/Wiki](https://github.com/3qilabs/awetestlib/wiki/Getting-Started---Scripting) wiki
 

data/awetestlib.windows.gemspec

@@ -32,7 +32,8 @@ Gem::Specification.new do |s|
   s.add_dependency('pry')
   s.add_dependency('rdoc', '~> 3.11')
   s.add_dependency('cucumber')
-  s.add_dependency('calabash-android', '0.4.2')
+  s.add_dependency('calabash-android', '0.4.3')
+  s.add_dependency('sys-uname')
   s.require_paths = ["lib"]
   s.files = `git ls-files`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/awetestlib_osx.gemspec

@@ -16,14 +16,8 @@ Gem::Specification.new do |s|
   s.description = %q{Awetest DSL for automated testing of browser-based applications.}
 
   s.add_dependency('watir-webdriver')
-  #s.add_dependency('watir', '1.8.1')
-  #s.add_dependency('commonwatir', '1.8.1')
-  #s.add_dependency('firewatir', '1.8.1')
   s.add_dependency('activesupport', '~> 3.0.0')
   s.add_dependency('andand')
-  #s.add_dependency('watirloo')
-  #s.add_dependency('win32-process')
-  #s.add_dependency('win32screenshot')
   s.add_dependency('spreadsheet', '0.6.8')
   s.add_dependency('google-spreadsheet-ruby', '0.1.6')
   s.add_dependency('roo', '1.10.1')
@@ -32,10 +26,10 @@ Gem::Specification.new do |s|
   s.add_dependency('nokogiri')
   s.add_dependency('i18n')
   s.add_dependency('rb-appscript')
-  #s.add_dependency('json', '1.6.1') #for safari support
   s.add_dependency('pry')
   s.add_dependency('cucumber')
   s.add_dependency('calabash-cucumber')
+  s.add_dependency('sys-uname')
   s.require_paths = ["lib"]   #,"ext"]
   s.files = `git ls-files`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/bin/awetestlib-android-setup.rb

@@ -16,6 +16,7 @@ def awetestlib_android_setup
   msg("Question") do
     puts "I'm about to create an android project named #{@proj_dir} in this directory"
     puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
     puts "NOTE: You may need to run this command as an administrator."
   end
   exit 2 unless STDIN.gets.chomp == ''
@@ -24,4 +25,4 @@ def awetestlib_android_setup
     puts "Configuring files and settings"
   end
 
-end
+end

data/bin/awetestlib-cucumber-setup.rb

@@ -16,6 +16,7 @@ def awetestlib_cucumber_setup
   msg("Question") do
     puts "I'm about to create a cucumber project named #{@proj_dir} in this directory"
     puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
     puts "NOTE: You may need to run this command as an administrator."
   end
   exit 2 unless STDIN.gets.chomp == ''
@@ -26,4 +27,4 @@ def awetestlib_cucumber_setup
     puts "cucumber yahoo_mail.feature"
   end
 
-end
+end

data/bin/awetestlib-driver-setup.rb

@@ -9,6 +9,7 @@ def awetestlib_driver_setup
     puts "I'm about to put the chromedriver and IEDriverServer in this directory"
     puts "If it already exists, we will overwrite it"
     puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
     puts "NOTE: You may need to run this command as an administrator."
   end
   exit 2 unless STDIN.gets.chomp == ''

data/bin/awetestlib-helpers.rb

@@ -10,7 +10,7 @@ def print_usage
   Usage Options:
   
     awetestlib regression_setup
-      setup awetest regression and register autoitx3.dll
+      setup awetest regression and register autoitx3.dll in Windows
 
     awetestlib rubymine_setup <project_name>
       setup a rubymine project 
@@ -39,4 +39,4 @@ def check_script_type(options)
     options[:script_type] = 'Regression'
     options[:script_file] = ARGV[0]
   end
-end
+end

data/bin/awetestlib-mobile-app-setup.rb

@@ -17,6 +17,7 @@ def awetestlib_mobile_app_setup
     puts "I'm about to create a mobile app project named #{ARGV[1]} in this directory" if ARGV[1]
     puts "I'm about to create a mobile app project named sample_mobile_app in this directory" if ARGV[1].nil?
     puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
     puts "NOTE: You may need to run this command as an administrator."
   end
   exit 2 unless STDIN.gets.chomp == ''

data/bin/awetestlib-netbeans-setup.rb

@@ -43,6 +43,7 @@ def awetestlib_netbeans_setup
     puts "I'm about to create a netbeans project named #{ARGV[1]} in this directory" if ARGV[1]
     puts "I'm about to create a netbeans project named sample_netbeans in this directory" if ARGV[1].nil?
     puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
     puts "NOTE: You may need to run this command as an administrator."
   end
   exit 2 unless STDIN.gets.chomp == ''
@@ -56,4 +57,4 @@ def awetestlib_netbeans_setup
     puts "Configuring files and settings"
   end
 
-end
+end

data/bin/awetestlib-regression-setup.rb

@@ -1,16 +1,30 @@
 def awetestlib_regression_setup
-  msg("Question") do
-    puts "I'm about to setup awetest regression support and register the AutoIt.dll"
-    puts "Please hit return to confirm that's what you want."
-	puts "NOTE: You may need to run this command as an administrator."
-  end
-  exit 2 unless STDIN.gets.chomp == ''
-  
-  autoit_file = File.join(File.dirname(__FILE__),"AutoItX3.dll")
-  system("regsvr32 #{autoit_file}")
+  using_windows = !!((RUBY_PLATFORM =~ /(win|w)(32|64)$/) || (RUBY_PLATFORM =~ /mswin|mingw/))
+  using_osx     = RUBY_PLATFORM =~ /darwin/
+
+  if using_windows
+    msg("Question") do
+      puts "I'm about to setup awetest regression support and register the AutoItX3.dll"
+      puts "Please hit return to confirm that's what you want."
+      puts "Enter anything else and hit return to abort."
+      puts "NOTE: You may need to run this command as an administrator."
+    end
+    exit 2 unless STDIN.gets.chomp == ''
+
+    autoit_file = File.join(File.dirname(__FILE__),"AutoItX3.dll")
+    system("regsvr32 #{autoit_file}")
 
-  msg("Info") do
-    puts "Configuring files and settings"
+    msg("Info") do
+      puts "Configuring files and settings for Windows"
+    end
+  elsif using_osx
+    msg("Info") do
+      puts "Currently nothing needed to configure settings for OSX"
+    end
+  else
+    msg("Error") do
+      puts "Unsupported operating system: #{RUBY_PLATFORM}"
+    end
   end
 
-end
+end

data/bin/awetestlib-rubymine-setup.rb

@@ -20,21 +20,26 @@ def awetestlib_rubymine_setup
   @source_dir = File.join(File.dirname(__FILE__), '..', 'setup_samples', 'sample_rubymine')
 
   if File.exists?(@rubymine_dir)
-    puts "Rubymine project directory already exists."
+    puts "Rubymine project directory (#{@rubymine_dir}) already exists."
     exit 1
   end
 
   msg("Question") do
-    puts "I'm about to create a rubymine project named #{ARGV[1]} in this directory" if ARGV[1]
-    puts "I'm about to create a rubymine project named sample_rubymine in this directory" if ARGV[1].nil?
+    if ARGV[1]
+      puts "I'm about to create a rubymine project named #{ARGV[1]} in this directory"
+    else
+      puts "I'm about to create a rubymine project named sample_rubymine in this directory"
+    end
     puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
     puts "NOTE: You may need to run this command as an administrator."
   end
   exit 2 unless STDIN.gets.chomp == ''
+
   FileUtils.cp_r(@source_dir, @rubymine_dir)
   edit_config_file
   msg("Info") do
     puts "Configuring files and settings"
   end
 
-end
+end

data/lib/awetestlib/logging.rb

@@ -182,12 +182,12 @@ module Awetestlib
 
     # @param [String] message The text to place in the log and report
     # @return [void]
-    def failed_to_log(message, lnbr = nil, dbg = false)
-      message << " \n#{get_debug_list}" if dbg or @debug_calls or @debug_calls_fail_only
+    def failed_to_log(message, lnbr = nil, dbg = false, exception = nil)
+      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?
-      log_message(WARN, "#{message}", FAIL, lnbr)
+      log_message(WARN, "#{message}", FAIL, lnbr, nil, exception)
     end
 
     alias validate_failed_tolog failed_to_log
@@ -198,13 +198,13 @@ module Awetestlib
 
     # @param [String] message The text to place in the log and report
     # @return [void]
-    def fatal_to_log(message, lnbr = nil, dbg = false)
-      message << " \n#{get_debug_list}" if dbg or (@debug_calls and not @debug_calls_fail_only)
+    def fatal_to_log(message, lnbr = nil, dbg = false, exception = nil)
+      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?
       debug_to_report("#{__method__}:\n#{dump_caller(lnbr)}")
-      log_message(FATAL, "#{message} (#{lnbr})", FAIL, lnbr)
+      log_message(FATAL, "#{message} (#{lnbr})", FAIL, lnbr, nil, exception)
     end
 
     alias fatal_tolog fatal_to_log

data/lib/awetestlib/regression/browser.rb

@@ -720,7 +720,9 @@ module Awetestlib
       # @param [Watir::Browser] browser A reference to the browser window or container element to be tested.
       # @param [String] title The title of the window to be closed.  Matched from beginning of string.
       # @param [String] button The display name of the button to be clicked.
-      # @param [String] text The text of the window to be closed.  Matched from beginning of string.
+      # @param [String] text The text of the window to be closed.  Matched from beginning of string in Windows
+      # with Internet Explorer (regular expressions will fail). Use enough of beginning of the text string, in quotes,
+      # to assure the correct modal is found. This will give best portability.
       # @param [String] side A string identifying which mouse button to click.
       # @param [Fixnum] wait Number of seconds to wait for the popup to be seen.
       def close_modal(browser, title="", button="OK", text='', side = 'primary', wait = WAIT)
@@ -743,17 +745,18 @@ module Awetestlib
       end
 
     # TODO: Logging
-      # Close a Safari modal popup by closing the frontmost Safari dialog.  MacOS only
+      # Close a Safari modal popup by closing the frontmost Safari dialog.  Mac OSX only.
       def close_modal_s
         # simply closes the frontmost Safari dialog
-        Appscript.app("Safari").activate; Appscript.app("System Events").processes["Safari"].key_code(52)
+        Appscript.app("Safari").activate
+        Appscript.app("System Events").processes["Safari"].key_code(52)
       end
 
-      # Close an IE modal popup by its title.
+      # Close an IE modal popup by its title using AutoItX3. Windows only.
       # @param [Watir::Browser] browser A reference to the browser window or container element to be tested.
       # @param [String] title The title of the window to be closed.  Matched from beginning of string.
       # @param [String] button The display name of the button to be clicked.
-      # @param [String] text The text of the window to be closed.  Matched from beginning of string.
+      # @param [String] text The text of the window to be closed.  Matched from beginning of string.  Do not use regular expression
       # @param [String] side A string identifying which mouse button to click.
       # @param [Fixnum] wait Number of seconds to wait for the popup to be seen.
       # @param [String] desc Contains a message or description intended to appear in the log and/or report output
@@ -762,7 +765,7 @@ module Awetestlib
         #TODO needs simplifying, incorporating text verification, and debug code cleaned up
         title = translate_popup_title(title)
         msg   = "Modal window (popup) '#{title}'"
-        if @ai.WinWait(title, text, wait)
+        if @ai.WinWait(title, text, wait) > 0
           myHandle = @ai.WinGetHandle(title, text)
           if myHandle.length > 0
             debug_to_log("hwnd: #{myHandle.inspect}")
@@ -770,7 +773,7 @@ module Awetestlib
             window_handle = "[HANDLE:#{myHandle}]"
             sleep_for(0.5)
             @ai.WinActivate(window_handle)
-            if @ai.WinActive(window_handle)
+            if @ai.WinActive(window_handle) > 0
               debug_to_log("#{msg} activated.")
               controlHandle = @ai.ControlGetHandle(title, '', "[CLASS:Button; TEXT:#{button}]")
               if not controlHandle.length > 0
@@ -779,16 +782,16 @@ module Awetestlib
               end
               debug_to_log("Handle for button '#{button}': [#{controlHandle}]")
               debug_to_log("#{msg} focus gained.")
-              if @ai.ControlClick(title, '', "[CLASS:Button; TEXT:#{button}]")
+              if @ai.ControlClick(title, '', "[CLASS:Button; TEXT:#{button}]") > 0
                 passed_to_log("#{msg} #{side} click on '[CLASS:Button; TEXT:#{button}]' successful.")
                 sleep_for(0.5)
-                if @ai.WinExists(window_handle)
+                if @ai.WinExists(window_handle) > 0
                   debug_to_log("#{msg} close popup failed on click '#{button}'. Trying WinClose. (#{__LINE__})")
                   @ai.WinClose(title, text)
-                  if @ai.WinExists(window_handle)
+                  if @ai.WinExists(window_handle) > 0
                     debug_to_log("#{msg} close popup failed with WinClose(#{window_handle}). (#{__LINE__})")
                     @ai.WinKill(window_handle)
-                    if @ai.WinExists(window_handle)
+                    if @ai.WinExists(window_handle) > 0
                       debug_to_log("#{msg} close popup failed with WinKill(#{window_handle}). (#{__LINE__})")
                     else
                       debug_to_log("#{msg} closed successfully with WinKill(#{window_handle}).")
@@ -820,7 +823,7 @@ module Awetestlib
 
       #  private :close_modal_ie
 
-      # Close an IE modal popup by its title. Calls close_modal_ie.
+      # Close an Internet Explorer modal popup by its title. Calls close_modal_ie. Windows only.
       # @deprecated Use close_modal.
       # @param [String] title The title of the window to be closed.  Matched from beginning of string.
       # @param [String] button The display name of the button to be clicked.

data/lib/awetestlib/regression/runner.rb

@@ -216,6 +216,9 @@ module Awetestlib
 
       def require_gems
 
+        require 'sys/uname'
+        include Sys
+
         case @targetBrowser.abbrev
 
           when 'IE'
@@ -267,6 +270,7 @@ module Awetestlib
       end
 
       def start
+        get_os
         before_run
         run
       rescue Exception => e

data/lib/awetestlib/regression/utilities.rb

@@ -15,13 +15,13 @@ module Awetestlib
       end
 
       def setup
-        #    if @os_sysname =~ /Windows.+Server\s+2003/
+        #    if @os.name =~ /Windows.+Server\s+2003/
         ##  'Microsoft(R) Windows(R) Server 2003, Enterprise Edition'
         #      @vertical_hack_ie   = 110
         #      @vertical_hack_ff   = 138
         #      @horizontal_hack_ie = 5
         #      @horizontal_hack_ff = 4
-        #    elsif @os_sysname =~ /Windows XP Professional/
+        #    elsif @os.name =~ /Windows XP Professional/
         #  'Microsoft Windows XP Professional'
         @vertical_hack_ie        = 118
         @vertical_hack_ff        = 144
@@ -428,7 +428,7 @@ module Awetestlib
             myList << "[#{$1.gsub(/eval/, @myName)}] "
             break
           end
-          break if x > depth or myCaller =~ /:in .run.$/
+          break if x > depth or myCaller =~ /:in .run.$/  # this break causes error in Ruby 1.9.x
         end
         if @projName
           call_list.each_index do |x|
@@ -439,7 +439,7 @@ module Awetestlib
               break
             end
           end
-          break if x > depth or myCaller =~ /:in .run.$/
+          break if x > depth or myCaller =~ /:in .run.$/  # this break causes error in Ruby 1.9.
         end
         myList
       end
@@ -1041,6 +1041,16 @@ module Awetestlib
         return false
       end
 
+      def get_os
+        @os = OpenStruct.new(
+          :name     => Uname.sysname,
+          :version  => Uname.version,
+          :release  => Uname.release,
+          :nodename => Uname.nodename,
+          :machine  => Uname.machine
+        )
+      end
+
     end
   end
 end