testcentricity_web 3.0.9 → 3.0.10

data/LICENSE.md

@@ -1,4 +1,4 @@
-TestCentricity™ Web Framework is Copyright (c) 2014-2018, Tony Mrozinski
+Copyright (c) 2011-2018, 2014-2018, Tony Mrozinski
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -24,4 +24,4 @@ NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -24,7 +24,15 @@ The TestCentricity™ Web gem supports running automated tests against the follo
 
 ## What's New
 
-A complete history of bug fixes and new features can be found in the {file:HISTORY.md HISTORY} file.
+A complete history of bug fixes and new features can be found in the {file:CHANGELOG.md CHANGELOG} file.
+
+###Version 3.0.10
+
+* Added `Image.broken?` method.
+* Added `UIElement.highlight` and `UIElement.unhighlight` methods.
+* `PageObject.verify_ui_states` and `PageSection.verify_ui_states` methods now takes screenshots that display a red dashed rectangular highlight around
+any UI element with property states that do not match expected results.
+* Removed deprecated `DataObject.set_current` method.
 
 ###Version 3.0.9
 
@@ -1550,21 +1558,27 @@ landscape orientation running on the BrowserStack service:
 TestCentricity™ Framework is Copyright (c) 2014-2018, Tony Mrozinski.
 All rights reserved.
 
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions
-are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in
-the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
-USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/lib/testcentricity_web/data_objects/data_objects_helper.rb

@@ -17,12 +17,6 @@ module TestCentricity
       @hash_table = data
     end
 
-    # @deprecated Please use {#current=} instead
-    def self.set_current(current)
-      warn "[DEPRECATION] 'TestCentricity::DataObject.set_current' is deprecated.  Please use 'current=' instead."
-      @current = current
-    end
-
     def self.current
       @current
     end
@@ -34,45 +28,73 @@ module TestCentricity
 
 
   class DataSource
-    attr_accessor :current
+    attr_accessor :file_path
+    attr_accessor :node
 
     def read_yaml_node_data(file_name, node_name)
-      data = YAML.load_file("#{XL_PRIMARY_DATA_PATH}#{file_name}")
+      @file_path = "#{XL_PRIMARY_DATA_PATH}#{file_name}"
+      @node = node_name
+      data = YAML.load_file(@file_path)
       data[node_name]
     end
 
+    def write_yaml_node_data(file_name, node_name, node_data)
+      data = read_yaml_node_data(file_name, node_name)
+      data[node_name] = node_data
+      File.write(@file_path, data.to_yaml)
+    end
+
     def read_json_node_data(file_name, node_name)
-      raw_data = File.read("#{XL_PRIMARY_DATA_PATH}#{file_name}")
+      @file_path = "#{XL_PRIMARY_DATA_PATH}#{file_name}"
+      @node = node_name
+      raw_data = File.read(@file_path)
       data = JSON.parse(raw_data)
       data[node_name]
     end
+
+    def write_json_node_data(file_name, node_name, node_data)
+      data = read_json_node_data(file_name, node_name)
+      data[node_name] = node_data
+      File.write(@file_path, data.to_json)
+    end
   end
 
 
   class ExcelDataSource < TestCentricity::DataSource
+    attr_accessor :worksheet
+    attr_accessor :row_spec
+
     def pick_excel_data_source(sheet, row_spec)
+      @worksheet = sheet
       if ENV['TEST_ENVIRONMENT']
         environment = ENV['TEST_ENVIRONMENT']
         data_file = "#{XL_PRIMARY_DATA_PATH}#{environment}_data.xls"
-        data_file = XL_PRIMARY_DATA_FILE unless ExcelData.rowspec_exists?(data_file, sheet, row_spec)
+        data_file = XL_PRIMARY_DATA_FILE unless ExcelData.row_spec_exists?(data_file, @worksheet, row_spec)
       else
         data_file = XL_PRIMARY_DATA_FILE
       end
+      @file_path = data_file
       data_file
     end
 
     def read_excel_row_data(sheet, row_name, parallel = false)
-      parallel == :parallel && ENV['PARALLEL'] ? row_spec = "#{row_name}#{ENV['TEST_ENV_NUMBER']}" : row_spec = row_name
-      ExcelData.read_row_data(pick_excel_data_source(sheet, row_spec), sheet, row_spec)
+      @row_spec = parallel == :parallel && ENV['PARALLEL'] ? "#{row_name}#{ENV['TEST_ENV_NUMBER']}" : row_name
+      ExcelData.read_row_data(pick_excel_data_source(sheet, @row_spec), sheet, @row_spec)
     end
 
     def read_excel_pool_data(sheet, row_name, parallel = false)
-      parallel == :parallel && ENV['PARALLEL'] ? row_spec = "#{row_name}#{ENV['TEST_ENV_NUMBER']}" : row_spec = row_name
-      ExcelData.read_row_from_pool(pick_excel_data_source(sheet, row_name), sheet, row_spec)
+      @row_spec = parallel == :parallel && ENV['PARALLEL'] ? "#{row_name}#{ENV['TEST_ENV_NUMBER']}" : row_name
+      ExcelData.read_row_from_pool(pick_excel_data_source(sheet, row_name), sheet, @row_spec)
     end
 
     def read_excel_range_data(sheet, range_name)
+      @row_spec = range_name
       ExcelData.read_range_data(pick_excel_data_source(sheet, range_name), sheet, range_name)
     end
+
+    def write_excel_row_data(sheet, row_name, row_data, parallel = false)
+      @row_spec = parallel == :parallel && ENV['PARALLEL'] ? "#{row_name}#{ENV['TEST_ENV_NUMBER']}" : row_name
+      ExcelData.write_row_data(pick_excel_data_source(sheet, @row_spec), sheet, @row_spec, row_data)
+    end
   end
 end

data/lib/testcentricity_web/data_objects/excel_helper.rb

@@ -11,7 +11,7 @@ module TestCentricity
     def self.worksheet_exists?(file, sheet)
       exists = false
       if File.exist?(file)
-        work_book  = Spreadsheet.open file
+        work_book  = Spreadsheet.open(file)
         worksheets = work_book.worksheets
         worksheets.each do |worksheet|
           if worksheet.name == sheet
@@ -23,15 +23,15 @@ module TestCentricity
       exists
     end
 
-    def self.rowspec_exists?(file, sheet, rowspec)
+    def self.row_spec_exists?(file, sheet, row_spec)
       exists = false
       if worksheet_exists?(file, sheet)
-        work_book  = Spreadsheet.open file
-        work_sheet = work_book.worksheet sheet
+        work_book  = Spreadsheet.open(file)
+        work_sheet = work_book.worksheet(sheet)
         # get column headings from row 0 of worksheet
         headings = work_sheet.row(0)
-        # if rowspec is a string then we have to find a matching row name
-        if rowspec.is_a? String
+        # if row_spec is a string then we have to find a matching row name
+        if row_spec.is_a? String
           column_number = 0
           exists = false
           headings.each do |heading|
@@ -42,27 +42,25 @@ module TestCentricity
             column_number += 1
           end
           raise "Could not find a column named ROW_NAME in worksheet #{sheet}" unless exists
-          # find first cell in ROW_NAME column containing a string that matches the rowspec parameter
+          # find first cell in ROW_NAME column containing a string that matches the row_spec parameter
           exists = false
-          row_number = 0
           work_sheet.each do |row|
-            if row[column_number] == rowspec
+            if row[column_number] == row_spec
               exists = true
               break
             end
-            row_number += 1
           end
         end
       end
       exists
     end
 
-    def self.read_row_from_pool(file, sheet, rowspec, columns = nil)
+    def self.read_row_from_pool(file, sheet, row_spec, columns = nil)
       raise "File #{file} does not exists" unless File.exist?(file)
-      work_book  = Spreadsheet.open file
-      work_sheet = work_book.worksheet sheet
+      work_book  = Spreadsheet.open(file)
+      work_sheet = work_book.worksheet(sheet)
 
-      pool_spec_key = "#{sheet}:#{rowspec}"
+      pool_spec_key = "#{sheet}:#{row_spec}"
       if @mru.key?(pool_spec_key)
         pool_spec = @mru[pool_spec_key]
         row_start = pool_spec[:start_row]
@@ -81,9 +79,9 @@ module TestCentricity
         end
 
         pool_spec = {
-            start_row: row_start,
-            num_rows:  row_end,
-            used_rows: mru_rows
+          start_row: row_start,
+          num_rows:  row_end,
+          used_rows: mru_rows
         }
       else
         # get column headings from row 0 of worksheet
@@ -98,24 +96,24 @@ module TestCentricity
           column_number += 1
         end
         raise "Could not find a column named ROW_NAME in worksheet #{sheet}" unless found
-        # find cell(s) in ROW_NAME column containing a string that matches the rowspec parameter
+        # find cell(s) in ROW_NAME column containing a string that matches the row_spec parameter
         found      = []
         row_number = 0
         work_sheet.each do |row|
-          if row[column_number] == rowspec
+          if row[column_number] == row_spec
             found.push(row_number)
           elsif !found.empty?
             break
           end
           row_number += 1
         end
-        raise "Could not find a row named '#{rowspec}' in worksheet #{sheet}" if found.empty?
+        raise "Could not find a row named '#{row_spec}' in worksheet #{sheet}" if found.empty?
 
         new_row   = found.sample.to_i
         pool_spec = {
-            start_row: found[0],
-            num_rows:  found.size,
-            used_rows: [new_row]
+          start_row: found[0],
+          num_rows:  found.size,
+          used_rows: [new_row]
         }
       end
       @mru[pool_spec_key] = pool_spec
@@ -123,14 +121,14 @@ module TestCentricity
       read_row_data(file, sheet, new_row, columns)
     end
 
-    def self.read_row_data(file, sheet, rowspec, columns = nil)
+    def self.read_row_data(file, sheet, row_spec, columns = nil)
       raise "File #{file} does not exists" unless File.exist?(file)
-      work_book  = Spreadsheet.open file
-      work_sheet = work_book.worksheet sheet
+      work_book  = Spreadsheet.open(file)
+      work_sheet = work_book.worksheet(sheet)
       # get column headings from row 0 of worksheet
       headings = work_sheet.row(0)
-      # if rowspec is a string then we have to find a matching row name
-      if rowspec.is_a? String
+      # if row_spec is a string then we have to find a matching row name
+      if row_spec.is_a? String
         column_number = 0
         found = false
         headings.each do |heading|
@@ -141,22 +139,22 @@ module TestCentricity
           column_number += 1
         end
         raise "Could not find a column named ROW_NAME in worksheet #{sheet}" unless found
-        # find first cell in ROW_NAME column containing a string that matches the rowspec parameter
+        # find first cell in ROW_NAME column containing a string that matches the row_spec parameter
         found = false
         row_number = 0
         work_sheet.each do |row|
-          if row[column_number] == rowspec
+          if row[column_number] == row_spec
             found = true
             break
           end
           row_number += 1
         end
-        raise "Could not find a row named '#{rowspec}' in worksheet #{sheet}" unless found
+        raise "Could not find a row named '#{row_spec}' in worksheet #{sheet}" unless found
         data = work_sheet.row(row_number)
-        # if rowspec is a number then ensure that it doesn't exceed the number of available rows
-      elsif rowspec.is_a? Numeric
-        raise "Row # #{rowspec} is greater than number of rows in worksheet #{sheet}" if rowspec > work_sheet.last_row_index
-        data = work_sheet.row(rowspec)
+        # if row_spec is a number then ensure that it doesn't exceed the number of available rows
+      elsif row_spec.is_a? Numeric
+        raise "Row # #{row_spec} is greater than number of rows in worksheet #{sheet}" if row_spec > work_sheet.last_row_index
+        data = work_sheet.row(row_spec)
       end
 
       # if no columns have been specified, return all columns
@@ -181,10 +179,10 @@ module TestCentricity
       result
     end
 
-    def self.read_range_data(file, sheet, rangespec)
+    def self.read_range_data(file, sheet, range_spec)
       raise "File #{file} does not exists" unless File.exist?(file)
-      work_book  = Spreadsheet.open file
-      work_sheet = work_book.worksheet sheet
+      work_book  = Spreadsheet.open(file)
+      work_sheet = work_book.worksheet(sheet)
       # get column headings from row 0 of worksheet
       headings = work_sheet.row(0)
       column_number = 0
@@ -197,18 +195,18 @@ module TestCentricity
         column_number += 1
       end
       raise "Could not find a column named ROW_NAME in worksheet #{sheet}" unless found
-      # find cell(s) in ROW_NAME column containing a string that matches the rangespec parameter
+      # find cell(s) in ROW_NAME column containing a string that matches the range_spec parameter
       found      = []
       row_number = 0
       work_sheet.each do |row|
-        if row[column_number] == rangespec
+        if row[column_number] == range_spec
           found.push(row_number)
         elsif !found.empty?
           break
         end
         row_number += 1
       end
-      raise "Could not find a row named '#{rangespec}' in worksheet #{sheet}" if found.empty?
+      raise "Could not find a row named '#{range_spec}' in worksheet #{sheet}" if found.empty?
 
       result = []
       found.each do |row|
@@ -217,6 +215,65 @@ module TestCentricity
       result
     end
 
+    def self.write_row_data(file, sheet, row_spec, row_data)
+      raise "File #{file} does not exists" unless File.exist?(file)
+      work_book  = Spreadsheet.open(file)
+      work_sheet = work_book.worksheet(sheet)
+      # get column headings from row 0 of worksheet
+      headings = work_sheet.row(0)
+      # find a matching row name
+      column_number = 0
+      found = false
+      headings.each do |heading|
+        if heading == 'ROW_NAME'
+          found = true
+          break
+        end
+        column_number += 1
+      end
+      raise "Could not find a column named ROW_NAME in worksheet #{sheet}" unless found
+      # find first cell in ROW_NAME column containing a string that matches the row_spec parameter
+      found = false
+      row_number = 0
+      work_sheet.each do |row|
+        if row[column_number] == row_spec
+          found = true
+          break
+        end
+        row_number += 1
+      end
+      raise "Could not find a row named '#{row_spec}' in worksheet #{sheet}" unless found
+      # iterate through the row_data Hash
+      row_data.each do |column, value|
+        column_number = 0
+        found = false
+        # find the column heading that matches the specified column name
+        headings.each do |heading|
+          if heading == column
+            found = true
+            break
+          end
+          column_number += 1
+        end
+        raise "Could not find a column named '#{column}' in worksheet #{sheet}" unless found
+        # set the value of the specified row and column
+        work_sheet.rows[row_number][column_number] = value
+      end
+      # iterate through all worksheets so that all worksheets are saved in new Excel document
+      worksheets = work_book.worksheets
+      worksheets.each do |worksheet|
+        headings = worksheet.row(0)
+        worksheet.rows[0][0] = headings[0]
+      end
+      # write all changes to new Excel document
+      outfile = file.gsub(File.basename(file), 'output.xls')
+      work_book.write outfile
+      # delete original Excel document
+      File.delete(file)
+      # rename new Excel document, replacing the original
+      File.rename(outfile, file)
+    end
+
     private
 
     def self.calculate_dynamic_value(value)
@@ -230,11 +287,11 @@ module TestCentricity
         date_time = eval("Chronic.parse('#{date_time_params[0].strip}')")
         result = date_time.to_s.format_date_time("#{date_time_params[1].strip}")
       else
-        if Faker.constants.include?(parameter[0].to_sym)
-          result = eval("Faker::#{parameter[0]}.#{parameter[1]}")
-        else
-          result = eval(test_value[1])
-        end
+        result = if Faker.constants.include?(parameter[0].to_sym)
+                   eval("Faker::#{parameter[0]}.#{parameter[1]}")
+                 else
+                   eval(test_value[1])
+                 end
       end
       result.to_s
     end

data/lib/testcentricity_web/exception_queue_helper.rb

@@ -2,7 +2,9 @@ module TestCentricity
   class ExceptionQueue
     include Capybara::DSL
 
-    @error_queue
+    attr_accessor :error_queue
+    attr_accessor :active_ui_element
+    attr_accessor :mru_ui_element
 
     def self.enqueue_assert_equal(expected, actual, error_message)
       unless expected == actual
@@ -29,9 +31,12 @@ module TestCentricity
       end
     ensure
       @error_queue = nil
+      @active_ui_element = nil
+      @mru_ui_element = nil
     end
 
-    def self.enqueue_comparison(state, actual, error_msg)
+    def self.enqueue_comparison(ui_object, state, actual, error_msg)
+      @active_ui_element = ui_object
       if state.is_a?(Hash) && state.length == 1
         state.each do |key, value|
           case key
@@ -94,11 +99,20 @@ module TestCentricity
       timestamp = Time.now.strftime('%Y%m%d%H%M%S')
       filename = "Screenshot-#{timestamp}"
       path = File.join Dir.pwd, 'reports/screenshots/', filename
+      # highlight the active UI element prior to taking a screenshot
+      unless @active_ui_element.nil? || @mru_ui_element == @active_ui_element
+        @active_ui_element.highlight(0)
+        @mru_ui_element = @active_ui_element
+      end
+      # take screenshot
       if Environ.driver == :appium
         AppiumConnect.take_screenshot("#{path}.png")
       else
         Capybara.save_screenshot "#{path}.png"
       end
+      # unhighlight the active UI element
+      @mru_ui_element.unhighlight unless @mru_ui_element.blank?
+      # add screenshot to queue
       puts "Screenshot saved at #{path}.png"
       screen_shot = {path: path, filename: filename}
       Environ.save_screen_shot(screen_shot)