testcentricity_apps 4.0.10

data/lib/testcentricity_apps/app_elements/switch.rb

@@ -0,0 +1,66 @@
+module TestCentricity
+  module AppElements
+    class AppSwitch < AppUIElement
+      def initialize(name, parent, locator, context)
+        super
+        @type = :switch
+      end
+
+      # Is switch in ON state?
+      #
+      # @return [Boolean]
+      # @example
+      #   use_face_id_switch.on?
+      #
+      def on?
+        obj = element
+        object_not_found_exception(obj)
+
+        if Environ.is_ios?
+          state =  obj.attribute(:value)
+          state.to_bool
+        else
+          state = obj.attribute(:checked)
+          state.boolean? ? state : state == 'true'
+        end
+      end
+
+      alias checked? on?
+      alias selected? on?
+
+      # Set the state of a switch object to ON.
+      #
+      # @example
+      #   use_face_id_switch.on
+      #
+      def on
+        obj = element
+        object_not_found_exception(obj)
+        obj.click unless on?
+      end
+
+      # Set the state of a switch object to OFF.
+      #
+      # @example
+      #   use_face_id_switch.off
+      #
+      def off
+        obj = element
+        object_not_found_exception(obj)
+        obj.click if on?
+      end
+
+      # Set the ON/OFF state of a switch object.
+      #
+      # @param state [Boolean] true = on / false = off
+      # @example
+      #   use_face_id_switch.set_switch_state(true)
+      #
+      def set_switch_state(state)
+        obj = element
+        object_not_found_exception(obj)
+        state ? on : off
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/app_elements/textfield.rb

@@ -0,0 +1,51 @@
+module TestCentricity
+  module AppElements
+    class AppTextField < AppUIElement
+      def initialize(name, parent, locator, context)
+        super
+        @type = :textfield
+      end
+
+      # Is text field set to read-only?
+      #
+      # @return [Boolean]
+      # @example
+      #   comments_field.read_only?
+      #
+      def read_only?
+        obj = element
+        object_not_found_exception(obj)
+        !!obj.attribute('readonly')
+      end
+
+      # Return maxlength character count of a text field.
+      #
+      # @return [Integer]
+      # @example
+      #   max_num_chars = comments_field.get_max_length
+      #
+      def get_max_length
+        obj = element
+        object_not_found_exception(obj)
+        max_length = obj.attribute('maxlength')
+        max_length.to_i unless max_length.blank?
+      end
+
+      # Return placeholder text of a text field.
+      #
+      # @return [String]
+      # @example
+      #   placeholder_message = username_field.get_placeholder
+      #
+      def get_placeholder
+        obj = element
+        object_not_found_exception(obj)
+        if AppiumConnect.is_webview?
+          obj.attribute('placeholder')
+        else
+          obj.text
+        end
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/appium_server.rb

@@ -0,0 +1,76 @@
+require 'childprocess'
+
+#
+# This class is designed to start and stop the Appium Server process.  In order to use it you must have Appium
+# and node installed on your computer.  You can pass parameters to Appium at startup via the constructor.
+#
+module TestCentricity
+  class AppiumServer
+    attr_accessor :process
+
+    def initialize(params = {})
+      @params = params
+    end
+
+    #
+    # Start the Appium Server
+    #
+    def start
+      # terminate any currently running Appium Server
+      if running?
+        system('killall -9 node')
+        puts 'Terminating existing Appium Server'
+        sleep(5)
+        puts 'Appium Server is being restarted'
+      else
+        puts 'Appium Server is starting'
+      end
+      # start new Appium Server
+      @process = ChildProcess.build(*parameters)
+      process.start
+      # wait until confirmation that Appium Server is running
+      wait = Selenium::WebDriver::Wait.new(timeout: 30)
+      wait.until { running? }
+      puts "Appium Server is running - PID = #{process.pid}"
+    end
+
+    #
+    # Check to see if Appium Server is running
+    #
+    def running?
+      endpoint = if ENV['APPIUM_SERVER_VERSION'] && ENV['APPIUM_SERVER_VERSION'].to_i == 1
+                   'http://0.0.0.0:4723/wd/hub/sessions'
+                 else
+                   'http://0.0.0.0:4723/sessions'
+                 end
+      response = false
+      begin
+        response = Net::HTTP.get_response(URI(endpoint))
+      rescue
+      end
+      response && response.code_type == Net::HTTPOK
+    end
+
+    #
+    # Stop the Appium Server
+    #
+    def stop
+      process.stop
+      puts 'Appium Server has been terminated'
+    end
+
+    private
+
+    # :nocov:
+    def parameters
+      cmd = ['appium']
+      @params.each do |key, value|
+        cmd << '--' + key.to_s
+        cmd << value.to_s if not value.nil? and value.size > 0
+      end
+      cmd
+    end
+    # :nocov:
+  end
+end
+

data/lib/testcentricity_apps/data_objects/data_objects_helper.rb

@@ -0,0 +1,100 @@
+require 'yaml'
+require 'json'
+require 'virtus'
+require 'time'
+require 'chronic'
+require 'faker'
+
+
+module TestCentricity
+
+  PRIMARY_DATA_PATH ||= 'config/test_data/'
+  PRIMARY_DATA_FILE ||= "#{PRIMARY_DATA_PATH}data."
+  YML_PRIMARY_DATA_FILE  ||= "#{PRIMARY_DATA_FILE}yml"
+  JSON_PRIMARY_DATA_FILE ||= "#{PRIMARY_DATA_FILE}json"
+
+
+  class DataObject
+    attr_accessor :current
+    attr_accessor :context
+    attr_accessor :hash_table
+
+    def initialize(data)
+      @hash_table = data
+    end
+
+    def self.current
+      @current
+    end
+
+    def self.current=(current)
+      @current = current
+    end
+  end
+
+
+  class DataPresenter
+    include Virtus.model
+
+    attr_accessor :current
+    attr_accessor :context
+
+    def initialize(data)
+      self.attributes = data unless data.nil?
+    end
+
+    def self.current
+      @current
+    end
+
+    def self.current=(current)
+      @current = current
+    end
+  end
+
+
+# :nocov:
+  class DataSource
+    attr_accessor :file_path
+    attr_accessor :node
+
+    def read_yaml_node_data(file_name, node_name)
+      @file_path = "#{PRIMARY_DATA_PATH}#{file_name}"
+      @node = node_name
+      data = YAML.load_file(@file_path)
+      data[node_name]
+    end
+
+    def read_json_node_data(file_name, node_name)
+      @file_path = "#{PRIMARY_DATA_PATH}#{file_name}"
+      @node = node_name
+      raw_data = File.read(@file_path)
+      data = JSON.parse(raw_data)
+      data[node_name]
+    end
+
+    private
+
+    def self.calculate_dynamic_value(value)
+      test_value = value.split('!', 2)
+      parameter = test_value[1].split('.', 2)
+      case parameter[0]
+      when 'Date'
+        result = eval("Chronic.parse('#{parameter[1]}')")
+      when 'FormattedDate', 'FormatDate'
+        date_time_params = parameter[1].split(' format! ', 2)
+        date_time = eval("Chronic.parse('#{date_time_params[0].strip}')")
+        result = date_time.to_s.format_date_time("#{date_time_params[1].strip}")
+      else
+        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
+  end
+# :nocov:
+end
+

data/lib/testcentricity_apps/data_objects/environment.rb

@@ -0,0 +1,423 @@
+module TestCentricity
+  class EnvironData < TestCentricity::DataSource
+    attr_accessor	:current
+    attr_accessor :data_source_type
+    attr_accessor	:generic_data
+    attr_accessor	:environ_specific_data
+
+    def self.find_environ(environ_name, source_type = :yaml)
+      raise 'No environment specified' if environ_name.nil?
+
+      @data_source_type = source_type
+      data = case source_type
+             when :yaml
+               # read generic test data from data.yml file
+               @generic_data ||= YAML.load_file(YML_PRIMARY_DATA_FILE)
+               # read environment specific test data
+               data_file = "#{PRIMARY_DATA_PATH}#{environ_name}_data.yml"
+               @environ_specific_data = if File.exist?(data_file)
+                                          YAML.load_file(data_file)
+                                        else
+                                          {}
+                                        end
+               read('Environments', environ_name)
+             when :json
+               # read generic test data from data.json file
+               raw_data = File.read(JSON_PRIMARY_DATA_FILE)
+               @generic_data = JSON.parse(raw_data)
+               # read environment specific test data
+               data_file = "#{PRIMARY_DATA_PATH}#{environ_name}_data.json"
+               @environ_specific_data = if File.exist?(data_file)
+                                          raw_data = File.read(data_file)
+                                          JSON.parse(raw_data)
+                                        else
+                                          {}
+                                        end
+
+               read('Environments', environ_name)
+             else
+               raise "#{source_type} is not a supported data source type"
+             end
+      @current = Environ.new(data)
+      Environ.current = @current
+    end
+
+    def self.read(key_name, node_name)
+      if @environ_specific_data.key?(key_name) && @environ_specific_data[key_name].key?(node_name)
+        node_data = @environ_specific_data[key_name][node_name]
+      else
+        raise "No key named #{key_name} in generic and environment-specific data" unless @generic_data.key?(key_name)
+        raise "No node named #{node_name} in #{key_name} section of generic and environment-specific data" unless @generic_data[key_name].key?(node_name)
+
+        node_data = @generic_data[key_name][node_name]
+      end
+
+      if node_data.is_a?(Hash)
+        node_data.each do |key, value|
+          node_data[key] = calculate_dynamic_value(value) if value.to_s.start_with?('eval!')
+        end
+      end
+      node_data
+    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')
+    @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 :session_state
+    attr_accessor :session_code
+    attr_accessor :app_session_id
+    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 :driver_name
+    attr_accessor :appium_driver
+    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 :user_id
+    attr_accessor :password
+    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 :ios_bundle_id
+    attr_accessor :ios_test_id
+    attr_accessor :android_apk_path
+    attr_accessor :android_app_id
+    attr_accessor :android_test_id
+    attr_accessor :default_max_wait_time
+    attr_accessor :deep_link_prefix
+
+    attr_accessor :mac_bundle_id
+
+    def initialize(data)
+      @user_id	     = data['USER_ID']
+      @password	     = data['PASSWORD']
+      @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']
+      @ios_bundle_id = data['IOS_BUNDLE_ID']
+      @ios_test_id   = data['IOS_TEST_ID']
+      @android_apk_path = data['ANDROID_APK_PATH']
+      @android_app_id   = data['ANDROID_APP_ID']
+      @android_test_id  = data['ANDROID_TEST_ID']
+      @deep_link_prefix = data['DEEP_LINK_PREFIX']
+      @mac_bundle_id = data['MAC_BUNDLE_ID']
+
+      super
+    end
+
+    def self.new_app_session
+      @app_session_id = Time.now.strftime('%Y%m%d%H%M%S%L')
+    end
+
+    def self.app_session_id
+      @app_session_id
+    end
+
+    def self.session_code
+      if @session_code.nil?
+        characters = ('a'..'z').to_a
+        @session_code = (0..12).map { characters.sample }.join
+      end
+      @session_code
+    end
+
+    def self.session_id
+      @session_id
+    end
+
+    def self.session_time_stamp
+      @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
+      else
+        @test_environment.downcase.to_sym
+      end
+    end
+
+    def self.default_max_wait_time=(timeout)
+      @default_max_wait_time = timeout
+    end
+
+    def self.default_max_wait_time
+      @default_max_wait_time
+    end
+
+    def self.session_state=(session_state)
+      @session_state = session_state
+    end
+
+    def self.session_state
+      @session_state
+    end
+
+    def self.os=(os)
+      @os = os
+    end
+
+    def self.os
+      @os
+    end
+
+    def self.device=(device)
+      @device = device
+    end
+
+    def self.device
+      @device
+    end
+
+    def self.is_device?
+      @device == :device
+    end
+
+    def self.is_simulator?
+      @device == :simulator
+    end
+
+    def self.is_web?
+      @device == :web
+    end
+
+    def self.device_type=(type)
+      type = type.downcase.to_sym if type.is_a?(String)
+      @device_type = type
+    end
+
+    def self.device_type
+      @device_type
+    end
+
+    def self.device_name=(name)
+      @device_name = name
+    end
+
+    def self.device_name
+      @device_name
+    end
+
+    def self.device_os=(os)
+      @device_os = os.downcase.to_sym
+    end
+
+    def self.device_os
+      @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
+
+    def self.is_android?
+      @device_os == :android
+    end
+
+    def self.is_macos?
+      @device_os == :mac
+    end
+
+    def self.device_orientation=(orientation)
+      orientation = orientation.downcase.to_sym if orientation.is_a?(String)
+      @device_orientation = orientation
+    end
+
+    def self.device_orientation
+      @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
+
+    def self.driver
+      @driver
+    end
+
+    def self.driver_name=(name)
+      name = name.downcase.to_sym if name.is_a?(String)
+      @driver_name = name
+    end
+
+    def self.driver_name
+      @driver_name
+    end
+
+    def self.appium_driver=(driver_instance)
+      @appium_driver = driver_instance
+    end
+
+    def self.appium_driver
+      @appium_driver
+    end
+
+    def self.tunneling=(state)
+      @tunneling = state
+    end
+
+    def self.tunneling
+      @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
+
+    def self.set_signed_in(signed_in)
+      @signed_in = signed_in
+    end
+
+    def self.is_signed_in?
+      @signed_in
+    end
+
+    def self.portal_state=(portal_state)
+      @portal_status = portal_state
+    end
+
+    def self.portal_state
+      @portal_status
+    end
+
+    def self.portal_context=(portal_context)
+      @portal_context = portal_context
+    end
+
+    def self.portal_context
+      @portal_context
+    end
+
+    def self.set_external_page(state)
+      @external_page = state
+    end
+
+    def self.save_screen_shot(screen_shot)
+      @screen_shots.push(screen_shot)
+    end
+
+    def self.get_screen_shots
+      @screen_shots
+    end
+
+    def self.reset_contexts
+      @screen_shots = []
+    end
+
+    # :nocov:
+    def self.report_header
+      # build the Cucumber HTML report header
+      report_header = "\n<b><u>TEST ENVIRONMENT</u>:</b> #{ENV['TEST_ENVIRONMENT']}\n"
+      report_header = "#{report_header}  <b>Driver:</b>\t #{Environ.driver}\n" if Environ.driver
+      report_header = "#{report_header}  <b>Driver Name:</b>\t #{Environ.driver_name}\n" if Environ.driver_name
+      report_header = "#{report_header}  <b>Platform:</b>\t #{Environ.platform}\n" if Environ.platform
+      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