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

data/lib/awetestlib/regression/runner.rb

@@ -1,40 +1,54 @@
-require 'awetestlib/regression/browser'  #; load_time
-require 'awetestlib/regression/find'  #; load_time
-require 'awetestlib/regression/user_input'  #; load_time
-require 'awetestlib/regression/waits'  #; load_time
-require 'awetestlib/regression/tables'  #; load_time
-require 'awetestlib/regression/page_data'  #; load_time
-require 'awetestlib/regression/drag_and_drop'  #; load_time
-require 'awetestlib/regression/utilities'  #; load_time
-require 'awetestlib/regression/legacy'  #; load_time
-require 'awetestlib/logging'  #; load_time
-require 'awetestlib/regression/validations'  #; load_time
-require 'awetestlib/html_report'  #; load_time
-#require 'rbconfig'  #; load_time
-require 'ostruct'  #; load_time
-require 'active_support'  #; load_time
-require 'active_support/inflector'  #; load_time
-#require 'sys/uname'  #; load_time
+require 'awetestlib/regression/browser'
+require 'awetestlib/regression/mobile'
+require 'awetestlib/regression/find'
+require 'awetestlib/regression/user_input'
+require 'awetestlib/regression/waits'
+require 'awetestlib/regression/tables'
+require 'awetestlib/regression/page_data'
+require 'awetestlib/regression/drag_and_drop'
+require 'awetestlib/regression/date_and_time'
+require 'awetestlib/regression/test_data'
+require 'awetestlib/regression/utilities'
+require 'awetestlib/regression/reporting'
+require 'awetestlib/regression/legacy'
+require 'awetestlib/logging'
+require 'awetestlib/regression/validations'
+require 'awetestlib/html_report'
+#require 'rbconfig'
+require 'ostruct'
+require 'csv'
+require 'etc'
+require 'yaml'
+require 'active_support'
+require 'active_support/inflector'
+require 'sys/uname'
+
+require 'watir-webdriver'
 
 module Awetestlib
   module Regression
     # Collects all the components needed to run the script and executes it.
     class Runner < Awetestlib::Runner
 
-    # order matters here
-    #  include Sys  #; load_time('include Sys')
-      include ActiveSupport::Inflector  #; load_time('include ActiveSupport::Inflector')
-      include Awetestlib::Logging  #; load_time('include Awetestlib::Logging')
-      include Awetestlib::Regression::Utilities  #; load_time('include Awetestlib::Regression::Utilities')
-      include Awetestlib::Regression::Browser  #; load_time('include Awetestlib::Regression::Browser')
-      include Awetestlib::Regression::Find  #; load_time('include Awetestlib::Regression::Find')
-      include Awetestlib::Regression::UserInput  #; load_time('include Awetestlib::Regression::UserInput')
-      include Awetestlib::Regression::Waits  #; load_time('include Awetestlib::Regression::Waits')
-      include Awetestlib::Regression::Tables  #; load_time('include Awetestlib::Regression::Tables')
-      include Awetestlib::Regression::PageData  #; load_time('include Awetestlib::Regression::PageData')
-      include Awetestlib::Regression::DragAndDrop  #; load_time('include Awetestlib::Regression::DragAndDrop')
-      include Awetestlib::Regression::Validations  #; load_time('include Awetestlib::Regression::Validations')
-      include Awetestlib::Regression::Legacy  #; load_time('include Awetestlib::Regression::Legacy')
+      # order matters here
+      # include Sys::Uname
+      include ActiveSupport::Inflector #; load_time('include ActiveSupport::Inflector')
+      include Awetestlib::Logging #; load_time('include Awetestlib::Logging')
+      include Awetestlib::Regression::Utilities #; load_time('include Awetestlib::Regression::Utilities')
+      include Awetestlib::Regression::Reporting
+      include Awetestlib::Regression::DateAndTime
+      include Awetestlib::Regression::TestData
+      include Awetestlib::Regression::Mobile
+      include Awetestlib::Regression::Browser #; load_time('include Awetestlib::Regression::Browser')
+      include Awetestlib::Regression::Find #; load_time('include Awetestlib::Regression::Find')
+      include Awetestlib::Regression::UserInput #; load_time('include Awetestlib::Regression::UserInput')
+      include Awetestlib::Regression::Waits #; load_time('include Awetestlib::Regression::Waits')
+      include Awetestlib::Regression::Tables #; load_time('include Awetestlib::Regression::Tables')
+      include Awetestlib::Regression::PageData #; load_time('include Awetestlib::Regression::PageData')
+      include Awetestlib::Regression::DragAndDrop #; load_time('include Awetestlib::Regression::DragAndDrop')
+      include Awetestlib::Regression::Validations #; load_time('include Awetestlib::Regression::Validations')
+      include Awetestlib::Regression::Legacy #; load_time('include Awetestlib::Regression::Legacy')
+      # load_time('includes')
 
       ::DEBUG   = 0
       ::INFO    = 1
@@ -43,44 +57,29 @@ module Awetestlib
       ::FATAL   = 4
       ::UNKNOWN = 5
 
-      ::TOP_LEVEL    = 7
-      ::SECOND_LEVEL = ::TOP_LEVEL - 1
+      # ::TOP_LEVEL    = 7
+      # ::SECOND_LEVEL = ::TOP_LEVEL - 1
 
-      ::WAIT = 20
-      ::PASS = '-PASS'
-      ::FAIL = '-FAIL'
+      ::WAIT    = 20
+      ::PASS    = '-PASS'
+      ::FAIL    = '-FAIL'
 
       attr_accessor :browser, :browser_abbrev, :version, :env,
-                    :library, :script_type, :script_file,
-                    :log_properties, :log_queue, :log_class,
-                    :notify_queue, :notify_class, :notify_id,
+                    :library, :script_type, :script_file, :script_name,
                     :screencap_path, :xls_path, :script_path, :user_token, :root_path,
-                    :debug_on_fail,
+                    :debug_dsl, :global_debug,
                     :environment, :environment_name, :environment_url, :environment_nodename,
-                    :cycle, :browser_sequence,
                     :output_to_log, :log_path_subdir, :report_all_test_refs,
-                    :timeout, :classic_watir, :capture_load_times
-
-      #def self.build(options)
-      #  #build_class = "Awetestlib::#{script_module_for options[:script_type]}::Runner".constantize
-      #  build_class = "Awetestlib::Runner".constantize
-      #  #options     = options.merge(:script_file => options[:script_file])
-      #  #if build_class.respond_to?(:runner_class)
-      #  #  build_class.runner_class(options)
-      #  #else
-      #    build_class.new(options)
-      #  #end
-      #end
+                    :timeout, :classic_watir, :capture_load_times, :platform, :pry,
+                    :emulator, :device_type, :device_id, :sdk, :options
 
       # TODO: Encapsulate in some kind of config
       ###################################
       def setup_global_test_vars(options)
-        @my_failed_count = 0
-        @my_passed_count = 0
-        @my_error_references         = Hash.new
-        @my_error_hits     = Hash.new
-
-        @report_all_refs  = options[:report_all_test_refs]
+        @my_failed_count     = 0
+        @my_passed_count     = 0
+        @my_error_references = Hash.new
+        @my_error_hits       = Hash.new
 
         if options[:environment]
           @myAppEnv = OpenStruct.new(
@@ -94,11 +93,11 @@ module Awetestlib
           @runenv = options[:environment_name]
         end
 
-        @targetBrowser  = browser_to_use(options[:browser], options[:version])
-        @targetVersion  = @targetBrowser.version
-        @browserAbbrev  = @targetBrowser.abbrev
-        @myRoot         = options[:root_path] || Dir.pwd  # NOTE: bug fix pmn 05dec2012
-        @myName         = File.basename(options[:script_file]).sub(/\.rb$/, '')
+        @targetBrowser, @actualBrowser = browser_to_use(options[:browser], options[:version])
+        @targetVersion                 = @targetBrowser.version
+        @browserAbbrev                 = @targetBrowser.abbrev
+        @myRoot                        = options[:root_path] || Dir.pwd # NOTE: bug fix pmn 05dec2012
+        self.script_name               = File.basename(options[:script_file]).sub(/\.rb$/, '')
 
         if options[:output_to_log]
           log_name = "#{@myName}_#{Time.now.strftime("%Y%m%d%H%M%S")}.log"
@@ -109,154 +108,111 @@ module Awetestlib
           else
             log_spec = log_name
           end
-          @myLog = init_logger(log_spec, @myName)
+          @logger = init_logger(log_spec, @myName)
         end
 
         if options[:xls_path]
           @xls_path = options[:xls_path]
         end
 
-        #TODO need to find way to calculate these on the fly
-        # window top border 30
-        # IE toolbars 86
-        @vertical_hack_ie   = 117
-        # FF toolbars 114
-        @vertical_hack_ff   = 144
-        # window left border 4
-        @horizontal_hack_ie = 5
-        @horizontal_hack_ff = 4
-        #
-        # @x_tolerance = 12
-        # @y_tolerance = 12
-        require_gems
       end
 
-      #def self.runner_class(options)
-      #  script_file = options[:script_file]
-      #  load script_file # force a load
-      #
-      #  runner_module = self.module_for script_file
-      #  klass_name    = "#{runner_module.to_s}::Runner"
-      #
-      #  # Define a Runner class in the test script's module inheriting from AwetestLegacy::Runner
-      #  runner_module.module_eval do
-      #    eval <<-RUBY
-      #  class #{klass_name} < Awetestlib::Runner
-      #    def initialize(options)
-      #      #super(options)
-      #      setup_global_test_vars(options)
-      #    end
-      #  end
-      #    RUBY
-      #  end
-      #
-      #  runner = runner_module::Runner.new(options)
-      #
-      #  if options[:library]
-      #    lib_file = options[:library]
-      #    load lib_file
-      #    lib_module = self.module_for lib_file
-      #    runner.extend(lib_module)
-      #  end
-      #
-      #  # Add in the methods defined in the script's module
-      #  runner.extend(runner_module)
-      #  runner
-      #end
-
       def initialize(options)
 
+        self.options = options
+
+        @myName          = File.basename(options[:script_file]).sub(/\.rb$/, '')
+        self.script_name = File.basename(options[:script_file]).sub(/\.rb$/, '')
+
+        if options[:debug_dsl]
+          $debug = true
+        end
+
+        log_message(DEBUG, with_caller("#{__LINE__}\n#{options.to_yaml}")) if $debug
+
         options.each_pair do |k, v|
           self.send("#{k}=", v)
         end
-        script_file = options[:script_file]
-        load script_file
+
+        if options[:pry]
+          require 'pry'
+        end
+
+        $mobile, $emulator, $simulator, $platform = mobile_browser?(options)
+
+        # load script file
+        # script_file                               = options[:script_file]
+        load options[:script_file] # ; load_time('Load script file', Time.now)
+
         setup_global_test_vars(options)
+        # require_gems
+
+        if USING_WINDOWS
+          require 'win32ole'
+          @ai = ::WIN32OLE.new('AutoItX3.Control')
+        else
+          # TODO: Need alternative for Mac?
+          @ai = ''
+        end
+
+        if @xls_path
+          require 'roo'
+        end
 
         # load and extend with library module if it exists
         if options[:library]
           lib_file = options[:library]
-          load lib_file # force a fresh load
+          load lib_file # ; load_time('Load library file', Time.now) # force a fresh load
           lib_module = module_for lib_file
           self.extend(lib_module)
         end
 
-        # load and extend with script
+        # load and extend with script to allow overrides in script
         script_file = options[:script_file]
-        load script_file # force a fresh load
-        runner_module = module_for script_file
-        self.extend(runner_module)
-
+        load script_file # ; load_time('Reload script file', Time.now) # force a fresh load
+        script_module = module_for script_file
+        self.extend(script_module)
       end
 
-      def browser_to_use(browser, browser_version = nil)
-        platform = ''
-        platform = 'Windows' if !!((RUBY_PLATFORM =~ /(win|w)(32|64)$/) || (RUBY_PLATFORM =~ /mswin|mingw/))
-        platform = 'OSX' if RUBY_PLATFORM =~ /darwin/
-
-        browser_abbrev =
-            Awetestlib::BROWSER_ALTERNATES[platform][browser] ?
-                Awetestlib::BROWSER_ALTERNATES[platform][browser] : browser
-        if not browser_version
-          case browser_abbrev
-            when 'IE'
-              browser_version = 8
-            when 'FF'
-              browser_version = 11
-            when 'C', 'GC'
-              browser_version = 10
-            when 'S'
-              browser_version = 10
-          end
-        end
-        return OpenStruct.new(
-              :name => (Awetestlib::BROWSER_MAP[browser_abbrev]),
-              :abbrev => browser_abbrev,
-              :version => browser_version
-        )
-      end
-
-      def require_gems
-
-        case @targetBrowser.abbrev
-
-          when 'IE'
-            if $watir_script
-              require 'watir/ie'  #; load_time
-              require 'watir'  #; load_time
-              require 'watir/process'  #; load_time
-              require 'watirloo'  #; load_time
-              require 'patches/watir'  #; load_time
-              Watir::IE.visible = true
-            else
-              require 'watir-webdriver'  #; load_time
-            end
-          when 'FF'
-            require 'watir-webdriver'  #; load_time
-          when 'S'
-            require 'watir-webdriver'  #; load_time
-
-          when 'C', 'GC'
-            require 'watir-webdriver'  #; load_time
-
-          # when 'CL'
-          #   require 'celerity'  #; load_time
-          #   require 'watir-webdriver'  #; load_timerequi
+      def mobile_browser?(options)
+        debug_to_log(with_caller("#{__LINE__}\n#{self.options.to_yaml}"))
+        mobile           = false
+        android_emulator = false
+        ios_simulator    = false
 
+        if options[:emulator] or options[:sdk] or options[:device_id] or
+            options[:device_type] or options[:environment_nodename] =~ /W:|E:|T:|K:|I:/
+          require 'appium_lib'
+          mobile = true
         end
 
-        if USING_WINDOWS
-          require 'watir/win32ole'  #; load_time
-          @ai = ::WIN32OLE.new('AutoItX3.Control')
-        else
-          # TODO: Need alternative for Mac?
-          @ai = ''
+        if options[:emulator]
+          android_emulator   = true
+          options[:platform] ||= :android
+        elsif options[:sdk]
+          ios_simulator      = true
+          options[:platform] ||= :ios
         end
 
-        if @xls_path
-          require 'roo'  #; load_time
-        end
+        [mobile, android_emulator, ios_simulator, options[:platform]]
+      end
+
+      def browser_to_use(target_abbrev, target_version = nil)
+
+        target = OpenStruct.new(
+            :name    => (Awetestlib::BROWSER_MAP[target_abbrev]),
+            :abbrev  => target_abbrev,
+            :version => target_version
+        )
+
+        actual = OpenStruct.new(
+            :name    => (Awetestlib::BROWSER_MAP[target_abbrev]),
+            :abbrev  => target_abbrev,
+            :version => '',
+            :driver  => ''
+        )
 
+        [target, actual]
       end
 
       def module_for(script_file)
@@ -264,43 +220,43 @@ module Awetestlib
       end
 
       def before_run
-        initiate_html_report
-        start_run
+        get_os
+        get_awetestlib_metadata
+        initiate_html_report($begin_time)
+        load_time('Total load time', $begin_time)
+        log_begin_run($begin_time)
       end
 
       def start
-        #get_os
         before_run
         run
       rescue Exception => e
-        failed_to_log(e.to_s)
+        failed_to_log(e.to_s, nil, e)
       ensure
         after_run
       end
 
       def after_run
-        finish_run
-        @report_class.finish_report(@html_report_file)
-        open_report_file
-        @myLog.close if @myLog
+        log_finish_run
+        full_html_path = @report_class.finish_report
+        open_report_file(full_html_path) unless Dir.pwd.include?("shamisen/tmp")
+        @logger.close if @logger
       end
 
-      def initiate_html_report
-        @html_report_name = File.join(FileUtils.pwd, 'awetest_reports', @myName)
-        @html_report_dir = File.dirname(@html_report_name)
-        FileUtils.mkdir @html_report_dir unless File.directory? @html_report_dir
-        @report_class = Awetestlib::HtmlReport.new(@myName)
-        @html_report_file = @report_class.create_report(@html_report_name)
+      def initiate_html_report(ts)
+        html_report_dir = File.join(FileUtils.pwd, 'awetest_report')
+        FileUtils.mkdir html_report_dir unless File.directory? html_report_dir
+        @report_class = Awetestlib::HtmlReport.new(@myName, html_report_dir, ts)
+        @report_class.create_report(@myName)
       end
 
-      def open_report_file
-        full_report_file = File.expand_path(@html_report_file)
+      def open_report_file(full_html_path)
         if USING_WINDOWS
-          system("explorer file:///#{full_report_file}")
+          system("start file:///#{full_html_path}")
         elsif USING_OSX
-          system("open #{full_report_file}")
+          system("open #{full_html_path}")
         else
-          puts "Can find report in #{full_report_file}"
+          log_message(DEBUG, "Report can be found in #{full_html_path}")
         end
 
       end

data/lib/awetestlib/regression/tables.rb

@@ -5,6 +5,75 @@ module Awetestlib
     module Tables
 
 
+      def dump_all_tables(browser, to_report = false)
+        tables  = browser.tables
+        msg     = ''
+        tbl_cnt = 0
+        tables.each do |tbl|
+          tbl_cnt += 1
+          row_cnt = 0
+          msg << "\n=================\ntable: #{tbl_cnt}\n=================\n#{tbl}\ntext:\n#{tbl.text}"
+          tbl.rows.each do |row|
+            row_cnt  += 1
+            cell_cnt = 0
+            msg << "\n=================\ntable: #{tbl_cnt} row: #{row_cnt}\n#{row.inspect}\n#{row}\ntext:'#{row.text}'"
+            row.each do |cell|
+              cell_cnt += 1
+              msg << " \ncell: #{cell_cnt}\n#{cell.inspect}\n#{row}\ntext: '#{cell.text}'"
+            end
+          end
+        end
+        if to_report
+          debug_to_report(msg)
+        else
+          debug_to_log(msg)
+        end
+      end
+
+      def dump_table_and_rows(table, to_report = false)
+        msg = "\n=================\ntable\n=================\nn#{table}\n#{table.to_yaml}\nrows:"
+        cnt = 0
+        table.rows.each do |r|
+          cnt += 1
+          msg << "\n#{cnt}: #{r.text}"
+        end
+        msg << "\n=================\n================="
+        if to_report
+          debug_to_report(msg)
+        else
+          debug_to_log(msg)
+        end
+      end
+
+      def dump_table_rows_and_cells(tbl)
+        msg     = ''
+        row_cnt = 0
+        msg << "\n=================\ntable: #{tbl.inspect}\n=================\n#{tbl}\ntext:\n#{tbl.text}"
+        tbl.rows.each do |row|
+          row_cnt  += 1
+          cell_cnt = 0
+          msg << "\n=================\nrow: #{row_cnt}\n#{row.inspect}\n#{row}\ntext:'#{row.text}'"
+          row.each do |cell|
+            cell_cnt += 1
+            msg << "\ncell: #{cell_cnt}\n#{cell.inspect}\n#{row}\ntext: '#{cell.text}'"
+          end
+        end
+        debug_to_log(msg)
+      end
+
+      alias dump_table_rows dump_table_rows_and_cells
+
+      def dump_row_cells(row)
+        msg      = ''
+        cell_cnt = 0
+        msg << "\n=================\nrow: #{row.inspect}\n#{row}\ntext:'#{row.text}'"
+        row.each do |cell|
+          cell_cnt += 1
+          msg << "\ncell: #{cell_cnt}\n#{cell.inspect}\n#{row}\ntext: '#{cell.text}'"
+        end
+        debug_to_log(msg)
+      end
+
       def get_index_for_column_head(panel, table_index, strg, desc = '')
         table = panel.tables[table_index]
         get_column_index(table, strg, desc, true)
@@ -43,7 +112,48 @@ module Awetestlib
         failed_to_log("Unable to #{msg} '#{$!}'")
       end
 
-      # Return the index of the last row of the specified table.
+      def get_parent_row(container, element, how, what, limit = 5)
+        msg    = "#{__method__}: #{element.to_s.upcase} :#{how}='#{what}'"
+        target = nil
+        parent = nil
+        case element
+          when :link
+            target = container.link(how, what)
+          when :select_list
+            target = container.select_list(how, what)
+          when :text_field
+            target = container.text_field(how, what)
+          when :checkbox
+            target = container.checkbox(how, what)
+          when :radio
+            target = container.radio(how, what)
+          else
+            fail "#{element.to_s.upcase} not supported."
+        end
+        if target
+          count  = 0
+          parent = target.parent
+          until parent.is_a?(Watir::TableRow) do
+            parent = parent.parent
+            count  += 1
+            if count > limit
+              failed_to_log("Parent row not within #{limit} ancestors.")
+            end
+          end
+        else
+          failed_to_log(msg)
+        end
+        if parent.is_a?(Watir::TableRow)
+          passed_to_log(msg)
+          parent
+        else
+          failed_to_log(msg)
+        end
+      rescue
+        failed_to_log(unable_to)
+      end
+
+    # Return the index of the last row of the specified table.
       # @param [Watir::Table] table A reference to the table in question.
       # @param [Fixnum] pad The number of zeroes to prefix the index to allow correct sorting.
       # @param [Fixnum] every A number indicating which rows in the table actually carry data if
@@ -116,7 +226,7 @@ module Awetestlib
       # after the row indicated by this argument. When omitted, the first hit is accepted.
       # @return [Fixnum] the index of the row containing *strg*
       def get_index_of_row_with_text(table, strg, column_index = nil, fail_if_found = false, after_index = nil)
-        debug_to_log("#{__method__}: #{get_callers(5)}")
+        debug_to_log(with_caller("#{get_callers(5)}")) if $debug
         if fail_if_found
           msg = 'No '
         else
@@ -298,14 +408,14 @@ module Awetestlib
       # @param [Fixnum] header_index The index of the row containing the header names.
       # @return [Hash] Two level hash of hashes. Internal hashes are 'name' which allows look-up of a column index
       # by the header name, and 'index' which allows look-up of the name by the column index.
-      def get_table_headers(table, header_index = 1)
+      def get_table_headers(table, header_index = 0)
         headers          = Hash.new
         headers['index'] = Hash.new
         headers['name']  = Hash.new
-        count            = 1
-        table[header_index].each do |cell|
+        count            = 0
+        table[header_index].cells.each do |cell|
           if cell.text.length > 0
-            name                    = cell.text.gsub(/\s+/, ' ')
+            name                    = cell.text.strip.gsub(/\s+/, ' ')
             headers['index'][count] = name
             headers['name'][name]   = count
           end
@@ -314,7 +424,7 @@ module Awetestlib
         #debug_to_log("#{__method__}: headers:\n#{headers.to_yaml}")
         headers
       rescue
-        failed_to_log("Unable to get content headers. '#{$!}'")
+        failed_to_log(unable_to)
       end
 
       # @param [Watir::Browser] browser A reference to the browser window or container element to be tested.