testcentricity 2.4.1 → 3.0.0

data/lib/testcentricity/app_core/screen_section.rb

@@ -0,0 +1,350 @@
+require 'test/unit'
+
+module TestCentricity
+  class ScreenSection < BaseScreenSectionObject
+    include Test::Unit::Assertions
+
+    attr_reader   :context, :name
+    attr_accessor :locator
+    attr_accessor :parent
+    attr_accessor :parent_list
+    attr_accessor :list_index
+
+    def initialize(name, parent, locator, context)
+      @name        = name
+      @parent      = parent
+      @locator     = locator
+      @context     = context
+      @parent_list = nil
+      @list_index  = nil
+    end
+
+    def get_locator
+      if @locator.zero? && defined?(section_locator)
+        my_locator = section_locator
+      else
+        my_locator = @locator
+      end
+      locators = []
+      if @context == :section && !@parent.nil?
+        locators.push(@parent.get_locator)
+      end
+
+      if @parent_list.nil?
+        locators.push(my_locator)
+      else
+        locators.push(@parent_list.get_locator)
+        if @list_index.nil?
+          locators.push(my_locator)
+        else
+          list_key = my_locator.keys[0]
+          list_value = "#{my_locator.values[0]}[#{@list_index}]"
+          locators.push( { list_key => list_value } )
+        end
+      end
+      locators
+    end
+
+    def set_list_index(list, index = 1)
+      @parent_list = list unless list.nil?
+      @list_index  = index
+    end
+
+    def get_item_count
+      raise 'No parent list defined' if @parent_list.nil?
+      @parent_list.get_item_count
+    end
+
+    def get_list_items
+      items = []
+      (1..get_item_count).each do |item|
+        set_list_index(nil, item)
+        items.push(get_value)
+      end
+      items
+    end
+
+    def get_object_type
+      :section
+    end
+
+    def get_name
+      @name
+    end
+
+    def set_parent(parent)
+      @parent = parent
+    end
+
+    def self.trait(trait_name, &block)
+      define_method(trait_name.to_s, &block)
+    end
+
+    def self.element(element_name, locator)
+      define_section_element(element_name, TestCentricity::AppUIElement, locator)
+    end
+
+    def self.elements(element_hash)
+      element_hash.each do |element_name, locator|
+        element(element_name, locator)
+      end
+    end
+
+    def self.button(element_name, locator)
+      define_section_element(element_name, TestCentricity::AppButton, locator)
+    end
+
+    def self.buttons(element_hash)
+      element_hash.each do |element_name, locator|
+        button(element_name, locator)
+      end
+    end
+
+    def self.textfield(element_name, locator)
+      define_section_element(element_name, TestCentricity::AppTextField, locator)
+    end
+
+    def self.textfields(element_hash)
+      element_hash.each do |element_name, locator|
+        textfield(element_name, locator)
+      end
+    end
+
+    def self.switch(element_name, locator)
+      define_section_element(element_name, TestCentricity::AppSwitch, locator)
+    end
+
+    def self.switches(element_hash)
+      element_hash.each do |element_name, locator|
+        switch(element_name, locator)
+      end
+    end
+
+    def self.checkbox(element_name, locator)
+      define_section_element(element_name, TestCentricity::AppCheckBox, locator)
+    end
+
+    def self.checkboxes(element_hash)
+      element_hash.each do |element_name, locator|
+        checkbox(element_name, locator)
+      end
+    end
+
+    def self.label(element_name, locator)
+      define_section_element(element_name, TestCentricity::AppLabel, locator)
+    end
+
+    def self.labels(element_hash)
+      element_hash.each do |element_name, locator|
+        label(element_name, locator)
+      end
+    end
+
+    def self.list(element_name, locator)
+      define_section_element(element_name, TestCentricity::AppList, locator)
+    end
+
+    def self.lists(element_hash)
+      element_hash.each do |element_name, locator|
+        list(element_name, locator)
+      end
+    end
+
+    def self.selectlist(element_name, locator)
+      define_section_element(element_name, TestCentricity::AppSelectList, locator)
+    end
+
+    def self.selectlists(element_hash)
+      element_hash.each do |element_name, locator|
+        selectlist(element_name, locator)
+      end
+    end
+
+    def self.image(element_name, locator)
+      define_section_element(element_name, TestCentricity::AppImage, locator)
+    end
+
+    def self.images(element_hash)
+      element_hash.each do |element_name, locator|
+        image(element_name, locator)
+      end
+    end
+
+    def self.alert(element_name, locator)
+      define_method(element_name) do
+        ivar_name = "@#{element_name}"
+        ivar = instance_variable_get(ivar_name)
+        return ivar if ivar
+        instance_variable_set(ivar_name, TestCentricity::AppAlert.new(element_name, self, locator, :page))
+      end
+    end
+
+    def self.section(section_name, obj, locator = 0)
+      define_section_element(section_name, obj, locator)
+    end
+
+    def self.sections(section_hash)
+      section_hash.each do |section_name, class_name|
+        section(section_name, class_name)
+      end
+    end
+
+
+    def click
+      section = find_section
+      section_not_found_exception(section)
+      section.click
+    end
+
+    def tap
+      section = find_section
+      section_not_found_exception(section)
+      x = section.location.x
+      y = section.location.y
+      tap_action = Appium::TouchAction.new.tap(element: section, x: x, y: y)
+      tap_action.perform
+    end
+
+    def double_tap
+      section = find_section
+      section_not_found_exception(section)
+      x = section.location.x
+      y = section.location.y
+      tap_action = Appium::TouchAction.new.double_tap(element: section, x: x, y: y)
+      tap_action.perform
+    end
+
+    def exists?
+      section = find_section
+      section != nil
+    end
+
+    def enabled?
+      section = find_section
+      section_not_found_exception(section)
+      section.enabled?
+    end
+
+    def disabled?
+      section = find_section
+      section_not_found_exception(section)
+      section.enabled?
+    end
+
+    def visible?
+      section = find_section
+      return false if section.nil?
+
+      section.displayed?
+    end
+
+    def hidden?
+      !visible?
+    end
+
+    def wait_until_exists(seconds = nil, post_exception = true)
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { exists? }
+    rescue
+      if post_exception
+        raise "Could not find Section object '#{get_name}' (#{get_locator}) after #{timeout} seconds" unless exists?
+      else
+        exists?
+      end
+    end
+
+    def wait_until_gone(seconds = nil, post_exception = true)
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { !exists? }
+    rescue
+      if post_exception
+        raise "Section object '#{get_name}' (#{get_locator}) remained visible after #{timeout} seconds" if exists?
+      else
+        exists?
+      end
+    end
+
+    def wait_until_visible(seconds = nil, post_exception = true)
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { visible? }
+    rescue
+      if post_exception
+        raise "Could not find Section object '#{get_name}' (#{get_locator}) after #{timeout} seconds" unless visible?
+      else
+        visible?
+      end
+    end
+
+    def wait_until_hidden(seconds = nil, post_exception = true)
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { hidden? }
+    rescue
+      if post_exception
+        raise "Section object '#{get_name}' (#{get_locator}) remained visible after #{timeout} seconds" if visible?
+      else
+        visible?
+      end
+    end
+
+
+    def width
+      section = find_section
+      section_not_found_exception(section)
+      section.size.width
+    end
+
+    def height
+      section = find_section
+      section_not_found_exception(section)
+      section.size.height
+    end
+
+    def x_loc
+      section = find_section
+      section_not_found_exception(section)
+      section.location.x
+    end
+
+    def y_loc
+      section = find_section
+      section_not_found_exception(section)
+      section.location.y
+    end
+
+    private
+
+    def find_section
+      obj = nil
+      locators = get_locator
+      locators.each do |loc|
+        if obj.nil?
+          obj = find_element(loc.keys[0], loc.values[0])
+          puts "Found object #{loc}" if ENV['DEBUG']
+        else
+          obj = obj.find_element(loc.keys[0], loc.values[0])
+          puts "Found object #{loc}" if ENV['DEBUG']
+        end
+      end
+      obj
+    rescue
+      nil
+    end
+
+    def section_not_found_exception(obj)
+      raise ObjectNotFoundError.new("Section object '#{get_name}' (#{get_locator}) not found") unless obj
+    end
+
+    def self.define_section_element(element_name, obj, locator)
+      define_method(element_name) do
+        ivar_name = "@#{element_name}"
+        ivar = instance_variable_get(ivar_name)
+        return ivar if ivar
+        instance_variable_set(ivar_name, obj.new(element_name, self, locator, :section))
+      end
+    end
+  end
+end

data/lib/testcentricity/app_elements/app_element_helper.rb

@@ -88,6 +88,8 @@ module TestCentricity
       end
     end
 
+    alias value get_value
+
     def get_caption
       obj = element
       object_not_found_exception(obj)
@@ -98,18 +100,25 @@ module TestCentricity
         else
           obj.text
         end
-      elsif Environ.device_os == :ios
+      elsif Environ.is_ios?
         case obj.tag_name
         when 'XCUIElementTypeNavigationBar'
-          obj.attribute('name')
+          obj.attribute(:name)
         else
-          obj.attribute('label')
+          obj.attribute(:label)
         end
       else
-        obj.text
+        caption = obj.text
+        if caption.blank? && obj.attribute(:class) == 'android.view.ViewGroup'
+          caption_obj = obj.find_element(:xpath, '//android.widget.TextView')
+          caption = caption_obj.text
+        end
+        caption
       end
     end
 
+    alias caption get_caption
+
     def exists?
       begin
         element.displayed?
@@ -297,8 +306,8 @@ module TestCentricity
     def scroll(direction)
       obj = element
       object_not_found_exception(obj)
-      if Environ.device_os == :ios
-        execute_script('mobile: scroll', direction: direction.to_s, element: obj)
+      if Environ.is_ios?
+        $driver.execute_script('mobile: scroll', direction: direction.to_s, element: obj)
       else
         case direction
         when :down
@@ -323,8 +332,8 @@ module TestCentricity
     def swipe(direction)
       obj = element
       object_not_found_exception(obj)
-      if Environ.device_os == :ios
-        execute_script('mobile: swipe', direction: direction.to_s, element: obj)
+      if Environ.is_ios?
+        $driver.execute_script('mobile: swipe', direction: direction.to_s, element: obj)
       else
         actions = Appium::TouchAction.new
         actions.scroll(element: obj).perform

data/lib/testcentricity/app_elements/checkbox.rb

@@ -8,7 +8,7 @@ module TestCentricity
     def checked?
       obj = element
       object_not_found_exception(obj)
-      obj.attribute('checked') == 'true'
+      obj.selected?
     end
 
     # Set the check state of a checkbox object.
@@ -33,9 +33,9 @@ module TestCentricity
       obj = element
       object_not_found_exception(obj)
       if state
-        obj.click unless obj.attribute('checked') == 'true'
+        obj.click unless obj.selected?
       else
-        obj.click if obj.attribute('checked') == 'true'
+        obj.click if obj.selected?
       end
     end
   end

data/lib/testcentricity/data_objects/environment.rb

@@ -1,52 +1,44 @@
 module TestCentricity
-  class EnvironData < TestCentricity::ExcelDataSource
-    attr_accessor	:current
-
-    WKS_ENVIRONS ||= 'Environments'
-
-    def find_environ(environ_name, source_type = :excel)
-      case source_type
-      when :excel
-        data = ExcelData.read_row_data(XL_PRIMARY_DATA_FILE, WKS_ENVIRONS, environ_name)
-      when :yaml
-        data = read_yaml_node_data('environments.yml', environ_name)
-      when :json
-        data = read_json_node_data('environments.json', environ_name)
-      end
-      @current = Environ.new(data)
-      Environ.current = @current
-    end
-  end
-
-
   class Environ < TestCentricity::DataObject
     @session_id = Time.now.strftime('%d%H%M%S%L')
     @session_time_stamp = Time.now.strftime('%Y%m%d%H%M%S')
-    @session_code
     @test_environment = ENV['TEST_ENVIRONMENT']
+    @a11y_standard = ENV['ACCESSIBILITY_STANDARD'] || 'best-practice'
+    @locale = ENV['LOCALE'] || 'en'
+    @language = ENV['LANGUAGE'] || 'English'
     @screen_shots = []
 
     attr_accessor :test_environment
+    attr_accessor :app_host
     attr_accessor :browser
     attr_accessor :browser_size
+    attr_accessor :headless
     attr_accessor :session_state
+    attr_accessor :session_code
     attr_accessor :os
     attr_accessor :device
     attr_accessor :device_name
     attr_accessor :device_type
     attr_accessor :device_os
+    attr_accessor :device_os_version
     attr_accessor :device_orientation
     attr_accessor :screen_size
     attr_accessor :platform
     attr_accessor :driver
+    attr_accessor :grid
     attr_accessor :tunneling
+    attr_accessor :locale
+    attr_accessor :language
+
+    attr_accessor :parallel
+    attr_accessor :process_num
 
     attr_accessor :signed_in
     attr_accessor :portal_status
     attr_accessor :portal_context
     attr_accessor :external_page
 
-    attr_accessor :default_max_wait_time
+    attr_accessor :a11y_standard
 
     attr_accessor :protocol
     attr_accessor :hostname
@@ -54,33 +46,60 @@ module TestCentricity
     attr_accessor :user_id
     attr_accessor :password
     attr_accessor :append
+    attr_accessor :app_id
+    attr_accessor :api_key
     attr_accessor :option1
     attr_accessor :option2
+    attr_accessor :option3
+    attr_accessor :option4
     attr_accessor :dns
     attr_accessor :db_username
     attr_accessor :db_password
     attr_accessor :ios_app_path
     attr_accessor :ios_ipa_path
     attr_accessor :android_apk_path
+    attr_accessor :default_max_wait_time
+    attr_accessor :deep_link_prefix
+    attr_accessor :ios_bundle_id
+    attr_accessor :android_app_id
 
     def initialize(data)
-      @protocol     	  = data['PROTOCOL']
-      @hostname         = data['HOST_NAME']
-      @base_url         = data['BASE_URL']
-      @user_id	        = data['USER_ID']
-      @password	        = data['PASSWORD']
-      @append	          = data['APPEND']
-      @option1	        = data['OPTIONAL_1']
-      @option2	        = data['OPTIONAL_2']
-      @dns	            = data['DNS']
-      @db_username      = data['DB_USERNAME']
-      @db_password      = data['DB_PASSWORD']
-      @ios_app_path     = data['IOS_APP_PATH']
-      @ios_ipa_path     = data['IOS_IPA_PATH']
+      @protocol      = data['PROTOCOL']
+      @hostname      = data['HOST_NAME']
+      @base_url      = data['BASE_URL']
+      @user_id	     = data['USER_ID']
+      @password	     = data['PASSWORD']
+      @append	       = data['APPEND']
+      @app_id 	     = data['APP_ID']
+      @api_key	     = data['API_KEY']
+      @option1	     = data['OPTIONAL_1']
+      @option2	     = data['OPTIONAL_2']
+      @option3	     = data['OPTIONAL_3']
+      @option4	     = data['OPTIONAL_4']
+      @dns	         = data['DNS']
+      @db_username   = data['DB_USERNAME']
+      @db_password   = data['DB_PASSWORD']
+      @ios_app_path  = data['IOS_APP_PATH']
+      @ios_ipa_path  = data['IOS_IPA_PATH']
       @android_apk_path = data['ANDROID_APK_PATH']
+      @deep_link_prefix = data['DEEP_LINK_PREFIX']
+      @ios_bundle_id    = data['IOS_BUNDLE_ID']
+      @android_app_id   = data['ANDROID_APP_ID']
+
+      url = @hostname.blank? ? "#{@base_url}#{@append}" : "#{@hostname}/#{@base_url}#{@append}"
+      @app_host = if @user_id.blank? || @password.blank?
+                    "#{@protocol}://#{url}"
+                  else
+                    "#{@protocol}://#{@user_id}:#{@password}@#{url}"
+                  end
+
       super
     end
 
+    def self.app_host
+      @app_host
+    end
+
     def self.session_code
       if @session_code.nil?
         characters = ('a'..'z').to_a
@@ -97,6 +116,22 @@ module TestCentricity
       @session_time_stamp
     end
 
+    def self.parallel=(state)
+      @parallel = state
+    end
+
+    def self.parallel
+      @parallel
+    end
+
+    def self.process_num=(num)
+      @process_num = num
+    end
+
+    def self.process_num
+      @process_num
+    end
+
     def self.test_environment
       if @test_environment.blank?
         nil
@@ -131,12 +166,12 @@ module TestCentricity
       @browser_size
     end
 
-    def self.screen_size=(size)
-      @screen_size = size
+    def self.headless=(state)
+      @headless = state
     end
 
-    def self.screen_size
-      @screen_size
+    def self.headless
+      @headless
     end
 
     def self.session_state=(session_state)
@@ -199,6 +234,14 @@ module TestCentricity
       @device_os
     end
 
+    def self.device_os_version=(version)
+      @device_os_version = version
+    end
+
+    def self.device_os_version
+      @device_os_version
+    end
+
     def self.is_ios?
       @device_os == :ios
     end
@@ -215,6 +258,14 @@ module TestCentricity
       @device_orientation
     end
 
+    def self.screen_size=(size)
+      @screen_size = size
+    end
+
+    def self.screen_size
+      @screen_size
+    end
+
     def self.driver=(type)
       @driver = type
     end
@@ -223,6 +274,14 @@ module TestCentricity
       @driver
     end
 
+    def self.grid=(type)
+      @grid = type
+    end
+
+    def self.grid
+      @grid
+    end
+
     def self.tunneling=(state)
       @tunneling = state
     end
@@ -231,10 +290,30 @@ module TestCentricity
       @tunneling
     end
 
+    def self.language=(language)
+      @language = language
+    end
+
+    def self.language
+      @language
+    end
+
+    def self.locale=(locale)
+      @locale = locale
+    end
+
+    def self.locale
+      @locale
+    end
+
     def self.platform=(platform)
       @platform = platform
     end
 
+    def self.platform
+      @platform
+    end
+
     def self.is_mobile?
       @platform == :mobile
     end
@@ -286,5 +365,20 @@ module TestCentricity
     def self.reset_contexts
       @screen_shots = []
     end
+
+    # :nocov:
+    def self.report_header
+      report_header = "\n<b><u>TEST ENVIRONMENT</u>:</b> #{ENV['TEST_ENVIRONMENT']}\n"\
+      "  <b>Target:</b>\t #{Environ.browser.capitalize}\n"
+      report_header = "#{report_header}  <b>Device:</b>\t #{Environ.device_name}\n" if Environ.device_name
+      report_header = "#{report_header}  <b>Device OS:</b>\t #{Environ.device_os} #{Environ.device_os_version}\n" if Environ.device_os
+      report_header = "#{report_header}  <b>Device type:</b>\t #{Environ.device_type}\n" if Environ.device_type
+      report_header = "#{report_header}  <b>OS:</b>\t\t #{Environ.os}\n" if Environ.os
+      report_header = "#{report_header}  <b>Locale:</b>\t #{Environ.locale}\n" if Environ.locale
+      report_header = "#{report_header}  <b>Language:</b>\t #{Environ.language}\n" if Environ.language
+      report_header = "#{report_header}  <b>Country:</b>\t #{ENV['COUNTRY']}\n" if ENV['COUNTRY']
+      "#{report_header}\n\n"
+    end
+    # :nocov:
   end
 end

data/lib/testcentricity/version.rb

@@ -1,3 +1,3 @@
 module TestCentricity
-  VERSION = '2.4.1'
+  VERSION = '3.0.0'
 end