testcentricity_web 4.4.7 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df25b2f03c601530a6cac7652a619802fdbcf541cfac60a372abd80cd88539dc
-  data.tar.gz: 06e5852b86f220a53716c5acda9e2621e9a0e673bb88c1b6808ebd1f9c2b6310
+  metadata.gz: c027bd7d2686918567b724b00a6414e4baedc58812e3177d870b646e24885f74
+  data.tar.gz: 79dd0592a8e0bb3c51a142214f9e0cef4b4a3712a90d12ec1f14224391404fcb
 SHA512:
-  metadata.gz: 0107a6c5d7a1bfe3ab8dd3d17c394e5ac2630ef7f53a2947c2916296c3281875d7c25b163a2270088f77e193878e7b128843518c39aa110e32b8c8b44b63c856
-  data.tar.gz: 50cebc5c0b3b0e5f07cf05a9d594916abd6c6edc3ccc3fc9025bae3c60c2793d3639b91770a48d54206ba6f3fc91c2b27a8d1a5ddbbc6da0a0898fa8661572f0
+  metadata.gz: f086bf05254d5cebe9461ddddcbbeae1d1a72e4b1a4ff9db2a17df1c728c3d0217459a604bafc1a7e60975857a206339310c6849aa6bb5380dc949682ec485b4
+  data.tar.gz: e4e037bf027de684205a7f34a5591b422043d63c6f4f521d4f52ca3a9094edd30b38163ddabe55b5273bda5b51896e79290762286e72cab762d6f256ab842da8

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 All notable changes to this project will be documented in this file.
 
 
+## [4.5.0] - 16-JAN-2024
+
+### Removed
+* Support for test data assets stored in Excel `.xls` has been removed because `.xls` files cannot be properly tracked
+and diffed by source control tools like git.
+* `ExcelData` and `ExcelDataSource` classes removed.
+* Removed dependence on `spreadsheet` gem.
+
+
 ## [4.4.7] - 13-JAN-2024
 
 ### Fixed

data/lib/testcentricity_web/data_objects/data_objects_helper.rb

@@ -10,7 +10,6 @@ module TestCentricity
 
   PRIMARY_DATA_PATH ||= 'config/test_data/'
   PRIMARY_DATA_FILE ||= "#{PRIMARY_DATA_PATH}data."
-  XL_PRIMARY_DATA_FILE   ||= "#{PRIMARY_DATA_FILE}xls"
   YML_PRIMARY_DATA_FILE  ||= "#{PRIMARY_DATA_FILE}yml"
   JSON_PRIMARY_DATA_FILE ||= "#{PRIMARY_DATA_FILE}json"
 
@@ -51,37 +50,6 @@ module TestCentricity
     def self.current=(current)
       @current = current
     end
-
-# :nocov:
-    def to_hash(node_name = nil)
-      data = {}
-      if node_name.nil?
-        data = { class: self.class.name, attributes: self.attributes }
-      else
-        data[node_name] = { class: self.class.name, attributes: self.attributes }
-      end
-      data
-    end
-
-    def to_yaml(node_name = nil)
-      data = to_hash(node_name)
-      data.to_yaml
-    end
-
-    def write_yaml_data(file_name, mode, node_name = nil)
-      File.open(file_name, mode) { |file| file.write(to_yaml(node_name)) }
-    end
-
-    def to_json(node_name = nil)
-      data = to_hash(node_name)
-      data.to_json
-    end
-
-    def write_json_data(file_name, mode, node_name = nil)
-      File.open(file_name, mode) { |file| file.write(to_json(node_name)) }
-    end
-
-# :nocov:
   end
 
 
@@ -97,12 +65,6 @@ module TestCentricity
       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)
       @file_path = "#{PRIMARY_DATA_PATH}#{file_name}"
       @node = node_name
@@ -111,12 +73,6 @@ module TestCentricity
       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
-
     private
 
     def self.calculate_dynamic_value(value)
@@ -138,48 +94,6 @@ module TestCentricity
       end
       result.to_s
     end
-  end
-# :nocov:
-
-
-  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 = "#{PRIMARY_DATA_PATH}#{environment}_data.xls"
-        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)
-      @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
-
-    # :nocov:
-    def read_excel_pool_data(sheet, row_name, parallel = false)
-      @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
     # :nocov:
   end
 end
-

data/lib/testcentricity_web/data_objects/environment.rb

@@ -1,15 +1,13 @@
 module TestCentricity
-  class EnvironData < TestCentricity::ExcelDataSource
+  class EnvironData < TestCentricity::DataSource
     attr_accessor	:current
     attr_accessor	:generic_data
     attr_accessor	:environ_specific_data
 
-    def self.find_environ(environ_name, source_type = :excel)
+    def self.find_environ(environ_name, source_type = :yaml)
       raise 'No environment specified' if environ_name.nil?
 
       data = case source_type
-             when :excel
-               ExcelData.read_row_data(XL_PRIMARY_DATA_FILE, 'Environments', environ_name)
              when :yaml
                # read generic test data from data.yml file
                @generic_data ||= YAML.load_file(YML_PRIMARY_DATA_FILE)
@@ -36,6 +34,8 @@ module TestCentricity
                                         end
 
                read('Environments', environ_name)
+             else
+               raise "#{source_type} is not a supported data source type"
              end
       @current = Environ.new(data)
       Environ.current = @current
@@ -379,7 +379,7 @@ module TestCentricity
     end
 
     def self.driver_name=(name)
-      name = name.downcase.to_sym if name.is_a?(String)
+      name = name.gsub(/\s+/, '_').downcase.to_sym if name.is_a?(String)
       @driver_name = name
     end
 
@@ -480,8 +480,8 @@ module TestCentricity
     end
 
     def self.report_header
-      report_header = "\n<b><u>TEST ENVIRONMENT</u>:</b> #{ENV['TEST_ENVIRONMENT']}\n"\
-      "  <b>Browser:</b>\t #{@browser.capitalize}\n"
+      report_header = "\n<b><u>TEST ENVIRONMENT</u>:</b> #{ENV['TEST_ENVIRONMENT']}\n"
+      report_header = "#{report_header}  <b>Browser:</b>\t #{@browser.capitalize}\n" if @browser
       report_header = "#{report_header}  <b>Device:</b>\t #{@device_name}\n" if @device_name
       report_header = "#{report_header}  <b>Device OS:</b>\t #{@device_os} #{@device_os_version}\n" if @device_os
       report_header = "#{report_header}  <b>Device type:</b>\t #{@device_type}\n" if @device_type

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '4.4.7'
+  VERSION = '4.5.0'
 end

data/lib/testcentricity_web/web_core/webdriver_helper.rb

@@ -65,7 +65,7 @@ module TestCentricity
       context = case Environ.driver
                 when :appium
                   initialize_appium
-                  'Appium'
+                  "#{Environ.device_os} #{Environ.device_type} #{Environ.device} on Appium"
                 when :webdriver
                   initialize_local_browser
                   'local browser instance'

data/lib/testcentricity_web.rb

@@ -16,7 +16,6 @@ require 'testcentricity_web/web_core/webdriver_helper'
 
 require 'testcentricity_web/data_objects/data_objects_helper'
 require 'testcentricity_web/data_objects/environment'
-require 'testcentricity_web/data_objects/excel_helper'
 
 require 'testcentricity_web/web_elements/ui_element'
 require 'testcentricity_web/web_elements/button'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcentricity_web
 version: !ruby/object:Gem::Version
-  version: 4.4.7
+  version: 4.5.0
 platform: ruby
 authors:
 - A.J. Mrozinski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-13 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -276,20 +276,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 4.14.0
-- !ruby/object:Gem::Dependency
-  name: spreadsheet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.7
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -343,7 +329,6 @@ files:
 - lib/testcentricity_web/browser_helper.rb
 - lib/testcentricity_web/data_objects/data_objects_helper.rb
 - lib/testcentricity_web/data_objects/environment.rb
-- lib/testcentricity_web/data_objects/excel_helper.rb
 - lib/testcentricity_web/exception_queue_helper.rb
 - lib/testcentricity_web/utility_helpers.rb
 - lib/testcentricity_web/version.rb

data/lib/testcentricity_web/data_objects/excel_helper.rb

@@ -1,276 +0,0 @@
-require 'spreadsheet'
-
-
-module TestCentricity
-  class ExcelData
-    @mru = {}
-
-    def self.worksheet_exists?(file, sheet)
-      exists = false
-      if File.exist?(file)
-        work_book  = Spreadsheet.open(file)
-        worksheets = work_book.worksheets
-        worksheets.each do |worksheet|
-          if worksheet.name == sheet
-            exists = true
-            break
-          end
-        end
-      end
-      exists
-    end
-
-    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)
-        # get column headings from row 0 of worksheet
-        headings = work_sheet.row(0)
-        # 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|
-            if heading == 'ROW_NAME'
-              exists = true
-              break
-            end
-            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 row_spec parameter
-          exists = false
-          work_sheet.each do |row|
-            if row[column_number] == row_spec
-              exists = true
-              break
-            end
-          end
-        end
-      end
-      exists
-    end
-
-    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)
-      # get column headings from row 0 of worksheet
-      headings = work_sheet.row(0)
-      # 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|
-          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
-        data = work_sheet.row(row_number)
-        # 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
-      columns = headings if columns.nil?
-      # create results hash table
-      result = Hash.new
-      columns.each do |column|
-        column_number = 0
-        found = false
-        headings.each do |heading|
-          if column == heading
-            value = data[column_number].to_s
-            value = calculate_dynamic_value(value) if value.start_with? 'eval!'
-            result[column] = value
-            found = true
-            break
-          end
-          column_number += 1
-        end
-        raise "Could not find a column named '#{column}' in worksheet #{sheet}" unless found
-      end
-      result
-    end
-
-    # :nocov:
-    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)
-
-      pool_spec_key = "#{sheet}:#{row_spec}"
-      if @mru.key?(pool_spec_key)
-        pool_spec = @mru[pool_spec_key]
-        row_start = pool_spec[:start_row]
-        row_end   = pool_spec[:num_rows]
-        pool_rows = (row_start..row_start + row_end - 1).to_a
-        mru_rows  = pool_spec[:used_rows]
-        new_row   = pool_rows.sample.to_i
-        if mru_rows.size == pool_spec[:num_rows]
-          mru_rows = [new_row]
-        else
-          while mru_rows.include?(new_row)
-            new_row = pool_rows.sample.to_i
-          end
-          mru_rows.push(new_row)
-          mru_rows.sort!
-        end
-
-        pool_spec = {
-          start_row: row_start,
-          num_rows:  row_end,
-          used_rows: mru_rows
-        }
-      else
-        # get column headings from row 0 of worksheet
-        headings      = work_sheet.row(0)
-        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 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] == row_spec
-            found.push(row_number)
-          elsif !found.empty?
-            break
-          end
-          row_number += 1
-        end
-        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]
-        }
-      end
-      @mru[pool_spec_key] = pool_spec
-
-      read_row_data(file, sheet, new_row, columns)
-    end
-
-    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)
-      # get column headings from row 0 of worksheet
-      headings = work_sheet.row(0)
-      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 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] == range_spec
-          found.push(row_number)
-        elsif !found.empty?
-          break
-        end
-        row_number += 1
-      end
-      raise "Could not find a row named '#{range_spec}' in worksheet #{sheet}" if found.empty?
-
-      result = []
-      found.each do |row|
-        result.push(read_row_data(file, sheet, row))
-      end
-      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
-    # :nocov:
-  end
-end