awetestlib 0.1.23 → 0.1.24

data/lib/awetestlib/logging.rb

@@ -102,62 +102,44 @@ module Awetestlib
       return { :result => passed, :msg => output_str }
     end
 
-    # Put status message to the log and output window
-    # TODO: figure out a way to do the leveling automatically based on actual call depth within script (and project library?)
-    # When using to mark test groupings, include
-    # level 'lvl' (numeric literal, 1 through 9, usually 1-4)
-    # indicating test grouping hierarchy:
-    #   0  lowest level test case, a single validation
-    #      a.k.a TEST CASE, VALIDATION
-    #      not normally used in scripts as it is
-    #      implied by method with 'validate' in name
-    #   1  group of closely related level 0 validations
-    #      a.k.a TEST GROUP
-    #      should never be followed by another level 1
-    #      or higher level message without intervening
-    #      level 0 validations.
-    #   2  group of closely related level 1 validation sets.
-    #      a.k.a TEST SET, SUBMODULE, USE CASE
-    #      should never be followed by another level 2
-    #      or higher level message without intervening
-    #      lower levels.
-    #   3  group of closely related level 2 validation sets.
-    #      a.k.a TEST SET, TEST SUITE, MODULE, USE CASE
-    #      should never be followed by another level 3
-    #      or higher level message without intervening
-    #      lower levels.
-    #   4  group of closely related level 3 validation sets.
-    #      a.k.a TEST SUITE, APPLICATION UNDER TEST, PLAN, PROJECT
-    #      should never be followed by another level 4
-    #      or higher level message without intervening
-    #      lower levels. Will seldom appear directly in
-    #      scripts
 
     # Write a status message to the log and report indicating location or activity
-    # in the script.
-    # @param [String] message The text to place in the log and report
-    # @param [Fixnum] lvl A number from 0 to 9 to roughly indicate call level within
-    # the script.  '0' forces a message to the report without a specific level attached.
+    # in the script. mark_test_level automatically determines the call hierarchy level
+    # of the calling method within the script and project utility methods.  The top level
+    # method of the script is always level 1.  The method also prefixes the calling method
+    # name (titleized) to the message to be placed in the log.
+    # @param [String] message The text to place in the log and report after the titleized
+    # calling method name.
+    # @param [Fixnum] lvl '0' forces a message to the report without a specific level
+    # attached. Any other integer is ignored in favor of the calculated level
     # @param [String] desc Any additional information to add to the message.
     # @param [Boolean] dbg When set to true adds a trace to the message.
     # @return [void]
-    def mark_testlevel(message, lvl, desc = '', dbg = nil)
+    def mark_test_level(message = '', lvl = nil, desc = '', dbg = nil)
+      call_arr = get_call_array()
+      #debug_to_log("#{call_arr.to_yaml}")
       strg = ''
-      strg << message
-      strg << " [#{desc}]" if desc.length > 0
-      strg << " #{get_debug_list}" if dbg or @debug_calls
-      @report_class.add_to_report(strg, "&nbsp", lvl)
-      log_message(INFO, strg, lvl, 1)
+      call_script, call_line, call_meth = parse_caller(call_arr[1])
+      if not lvl or lvl > 1
+        lvl, list = get_test_level
+        strg << "#{call_meth.titleize}"
+      end
+      strg << " #{message}" if message.length > 0
+      strg << " (#{desc})" if desc.length > 0
+      strg << " [#{call_line}]"
+      strg << "\n#{list.to_yaml}" if dbg or @debug_calls
+      @report_class.add_to_report(strg, "&nbsp", lvl || 1) unless Awetestlib::Runner.nil?
+      log_message(INFO, strg, lvl, nil, 1)
     rescue
       failed_to_log("#{__method__}: #{$!}")
     end
 
-    alias mark_test_level mark_testlevel
+    alias mark_testlevel mark_test_level
 
     # @param [String] message The text to place in the log
     # @return [void]
     def info_to_log(message, lnbr = nil)
-      log_message(INFO, message, nil, lnbr)
+      log_message(INFO, message, 0, lnbr)
     end
 
     alias message_tolog info_to_log
@@ -188,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")
+      @report_class.add_to_report(message, "PASSED") unless Awetestlib::Runner.nil?
       log_message(INFO, "#{message}", PASS, lnbr)
     end
 
@@ -204,7 +186,7 @@ module Awetestlib
       message << " \n#{get_debug_list}" if dbg 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")
+      @report_class.add_to_report("#{message}" + " [#{get_caller(lnbr)}]", "FAILED") unless Awetestlib::Runner.nil?
       log_message(WARN, "#{message}", FAIL, lnbr)
     end
 
@@ -220,7 +202,7 @@ module Awetestlib
       message << " \n#{get_debug_list}" if dbg 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")
+      @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)
     end
@@ -230,7 +212,7 @@ module Awetestlib
     # @param [String] message The text to place in the log and report
     # @return [void]
     def message_to_report(message, dbg = false)
-      mark_testlevel("#{message}", 0, '', dbg)
+      mark_testlevel(message, 0, '', dbg)
     end
 
     # @param [String] message The text to place in the log and report
@@ -306,7 +288,7 @@ module Awetestlib
       @start_timestamp = Time.now unless ts
       utc_ts = @start_timestamp.getutc
       loc_tm = "#{@start_timestamp.strftime("%H:%M:%S")} #{@start_timestamp.zone}"
-      mark_testlevel(">> Starting #{@myName.titleize} #{utc_ts} (#{loc_tm})", 0)
+      message_to_report(">> Starting #{@myName.titleize} #{utc_ts} (#{loc_tm})")
     end
 
     alias start_to_log start_run
@@ -314,16 +296,15 @@ module Awetestlib
     # @private
     # Tally and report duration, validation and failure counts, and end time for the script.
     # @param [DateTime] ts Time stamp indicating the time the script completed.
-    def finish_run(ts = nil)
+    def finish_run(ts = Time.now)
       tally_error_references
-      timestamp = Time.now unless ts
-      mark_testlevel(">> Duration: #{sec2hms(timestamp - @start_timestamp)}", 0)
-      mark_testlevel(">> Validations: #{@my_passed_count + @my_failed_count} | "+
-                     "Fails: #{@my_failed_count}", 0) if @my_passed_count and @my_failed_count
-      utc_ts = timestamp.getutc
-      loc_tm = "#{timestamp.strftime("%H:%M:%S")} #{timestamp.zone}"
-      debug_to_log(">> End #{@myName.titleize} #{utc_ts} (#{loc_tm})")
-
+      message_to_report(
+          ">> #{@myName.titleize} duration: #{sec2hms(ts - @start_timestamp)}")
+      message_to_report(">> #{@myName.titleize} validations: #{@my_passed_count + @my_failed_count} "+
+                         "fail: #{@my_failed_count}]") if @my_passed_count and @my_failed_count
+      utc_ts = ts.getutc
+      loc_tm = "#{ts.strftime("%H:%M:%S")} #{ts.zone}"
+      message_to_report(">> End #{@myName.titleize} #{utc_ts} (#{loc_tm})")
     end
 
     alias finish_to_log finish_run
@@ -333,22 +314,22 @@ module Awetestlib
       tags_tested = 0
       tags_hit    = 0
       if @my_error_hits and @my_error_hits.length > 0
-        mark_testlevel(">> Tagged Error Hits:", 0)
+        message_to_report(">> Tagged Error Hits:")
         tags_hit = @my_error_hits.length
         @my_error_hits.each_key do |ref|
-          mark_testlevel("#{ref} - #{@my_error_hits[ref]}", 0)
+          message_to_report("#{ref} - #{@my_error_hits[ref]}")
         end
       end
       if list_tags
         if @my_error_references and @my_error_references.length > 0
-          mark_testlevel(">> Error and Test Case Tags:", 0)
+          message_to_report(">> Error and Test Case Tags:")
           tags_tested = @my_error_references.length
           @my_error_references.each_key do |ref|
-            mark_testlevel("#{ref} - #{@my_error_references[ref]}", 0)
+            message_to_report("#{ref} - #{@my_error_references[ref]}")
           end
-          mark_testlevel(">> Fails were hit on #{tags_hit} of #{tags_tested} error/test case references", 0)
+          message_to_report(">> Fails were hit on #{tags_hit} of #{tags_tested} error/test case references")
         else
-          mark_testlevel(">> No Error or Test Case References found.", 0)
+          message_to_report(">> No Error or Test Case References found.")
         end
       end
     end

data/lib/awetestlib/regression/legacy.rb

@@ -701,8 +701,8 @@ module Awetestlib
       # It's *:value* attribute can also be used when needed by specifying *value*.
       # @param (see #set_file_field_by_name)
       # @return (see #click_button_by_id)
-      def clear_checkbox_by_name(browser, what, value = nil, desc = '')
-        clear(browser, :checkbox, :id, what, value, desc)
+      def clear_checkbox_by_id(browser, strg, value = nil, desc = '')
+        clear_checkbox(browser, :id, strg, desc)
       end
 
       # Clear (unset) radio button identified by the attribute specified in *how* with value *what*.

data/lib/awetestlib/regression/runner.rb

@@ -95,7 +95,7 @@ module Awetestlib
         @targetBrowser  = browser_to_use(options[:browser], options[:version])
         @targetVersion  = @targetBrowser.version
         @browserAbbrev  = @targetBrowser.abbrev
-        @myRoot         = options[:root_path]
+        @myRoot         = options[:root_path] || Dir.pwd  # NOTE: bug fix pmn 05dec2012
         @myName         = File.basename(options[:script_file]).sub(/\.rb$/, '')
 
         if options[:output_to_log]

data/lib/awetestlib/regression/utilities.rb

@@ -122,7 +122,7 @@ module Awetestlib
         2.upto(workbook.last_column) do |col|
           scriptName = workbook.cell(1, col)
           if scriptName == @myName
-            var_col = col
+            var_col              = col
             script_found_in_data = true
             break
           end
@@ -145,7 +145,7 @@ module Awetestlib
         password_col = 0
         url_col      = 0
         name_col     = 0
-        login_index   = find_sheet_with_name(workbook, 'Login')
+        login_index  = find_sheet_with_name(workbook, 'Login')
         if login_index and login_index >= 0
           workbook.default_sheet = workbook.sheets[login_index]
 
@@ -153,7 +153,7 @@ module Awetestlib
             a_cell = workbook.cell(1, col)
             case a_cell
               when @myName
-                login_col = col
+                login_col             = col
                 script_found_in_login = true
                 break
               when 'role'
@@ -938,6 +938,51 @@ module Awetestlib
         debug_to_log("#{__method__}: #{method} #{$!}")
       end
 
+      def unable_to(message = '', no_dolbang = false)
+        call_arr                          = get_call_array()
+        call_script, call_line, call_meth = parse_caller(call_arr[1])
+        strg                              = "Unable to #{call_meth.titleize}:"
+        strg << " #{message}" if message.length > 0
+        strg << " '#{$!}'" unless no_dolbang
+        strg
+      end
+
+      def parse_caller(caller)
+        call_script, call_line, call_meth = caller.split(':')
+        call_script.gsub!(/\.rb/, '')
+        call_script = call_script.camelize
+        call_meth =~ /in .([\w\d_]+)./
+        call_meth = $1
+        [call_script, call_line, call_meth]
+      end
+
+      def get_test_level
+        arr       = []
+        each_line = 0
+        call_list = Kernel.caller
+        #debug_to_log("#{call_list.to_yaml}")
+        call_list.each_index do |x|
+          myCaller = call_list[x].to_s
+          myCaller =~ /([\(\)\w_\_\-\.]+\:\d+\:?.*?)$/
+          string = $1
+          unless string =~ /logging\.rb|mark_testlevel|mark_test_level|debug_to_report|debug_toreport/
+            if string.length > 0
+              if string =~ /each|each_key/
+                each_line = string.match(/\:(\d+)\:/)[1]
+              elsif string.match(/\:(\d+)\:/)[1] == each_line
+                next
+              else
+                arr << string.gsub(/eval/, @myName)
+              end
+            end
+          end
+          break if myCaller =~ /:in .run.$|runner\.rb/
+        end
+        #debug_to_log("#{arr.length} #{nice_array(arr)}")
+        [arr.length, arr]
+      end
+
+
     end
   end
 end

data/lib/version.rb

@@ -1,4 +1,4 @@
 module Awetestlib
-  VERSION = "0.1.23"
-  VERSION_DATE = "2012-11-15"
+  VERSION = "0.1.24"
+  VERSION_DATE = "2012-12-06"
 end

data/test/demo.rb

@@ -6,7 +6,7 @@ module Demo
   end
 
   def test_account_lookup(browser)
-    mark_testlevel('Account Lookup', 1)
+    mark_testlevel()
     browser.image(:title, 'Account Name Lookup').click
     sleep_for(5)
     popup = attach_browser_by_url(browser, /Parent/)
@@ -22,7 +22,7 @@ module Demo
   end
 
   def login(browser)
-    mark_testlevel('Zoho Login', 2)
+    mark_testlevel()
     user     = "joeklienwatir@gmail.com" #@zohologin.cell(2,2)
     password = "watir001"                #@zohologin.cell(2,3)
     go_to_url(browser, "https://accounts.zoho.com/login?serviceurl=https://www.zoho.com/&hide_signup=true&css=https://www.zoho.com/css/login.css")
@@ -37,11 +37,12 @@ module Demo
   end
 
   def navigate_to_crm(browser)
-    mark_testlevel('Navigate to CRM', 1)
+    mark_testlevel()
     click_text(browser, 'CRM')
   end
 
   def test_zoho(browser)
+    mark_testlevel()
     #get_variables("#{@myRoot}/zoho_variables.xls")
     navigate_to_crm(browser) #In Project Util
     create_account(browser)
@@ -52,7 +53,7 @@ module Demo
   end
 
   def create_account(browser)
-    mark_testlevel('Create New Account', 3)
+    mark_testlevel()
     sleep_for(3)
     click_link(browser, 'Accounts')
     sleep_for(3)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: awetestlib
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 43
   prerelease: 
   segments: 
   - 0
   - 1
-  - 23
-  version: 0.1.23
+  - 24
+  version: 0.1.24
 platform: ruby
 authors: 
 - Anthony Woo
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-15 00:00:00 Z
+date: 2012-12-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: watir-webdriver