framework_gem 0.1.0

data/lib/lib/selenium/webdriver/webdriver.rb

@@ -0,0 +1,254 @@
+require './lib/selenium/selenium'
+
+# Webdriver defines all the Webdriver methods in a module so that they can be included by other classes
+
+module Webdriver
+  include Selenium
+
+  @closed = false
+
+  # Public: Navigates forward.
+  #
+  # Returns a Boolean true if successfully pressed Forward, otherwise false.
+  def forward?
+    ret = selenium_post('forward', {})
+    !ret.nil?
+  end
+
+  # Public: Refreshes the current URL.
+  #
+  # Returns a Boolean true if successfully pressed Refresh, otherwise false.
+  def refresh?
+    ret = selenium_post('refresh', {})
+    !ret.nil?
+  end
+
+  # Public: Navigates to the specified screen or URL.
+  #
+  # url - String URL to navigate to.
+  #
+  # Returns a Boolean true if successfully pressed Refresh, otherwise false.
+  def navigate?(url)
+    ret = selenium_post('navigate', {:url => url})
+    !ret.nil?
+  end
+
+  # Public: Closes the browser.
+  #
+  # Returns a Boolean true if successfully closed the browser, otherwise false.
+  def close?
+    ret = selenium_delete(nil, {})
+    if ret.nil?
+      false
+    else
+      @closed = true
+      true
+    end
+  end
+
+  # Public: Clicks the specified element.
+  #         For any String criteria, a Regular Expression may be used by adding the 'regexp:' prefix.
+  #
+  # selector          - String CSS selector to locate the element (default: nil).
+  # id                - String element id (default: nil).
+  # class_name        - String element class name (default: nil).
+  # tag_name          - String element tag name (default: nil).
+  # value             - String element value (default: nil).
+  # name              - String element name (default: nil).
+  # text              - String element text (default: nil).
+  # xpath             - String xpath to locate the element (default: nil).
+  #                     NOTE: xpath is unreliable and should be used sparingly.
+  # type              - String type of the element (default: nil).
+  # description       - String description of the element (default: nil).
+  # index             - Integer index of element to use among all matching elements (default: nil).
+  #                     By default, exactly one element must match.
+  # is_visible        - Boolean indicating whether the element is visible (default: nil).
+  # is_on_screen      - Boolean indicating whether any part of the element is within screen boundaries (default: nil).
+  # is_tappable       - Boolean indicating whether the element may be tapped (default: nil).
+  # is_password       - Boolean indicating whether the element is a password field (default: nil).
+  # is_enabled        - Boolean indicating whether the element is enabled (default: nil).
+  # is_checked        - Boolean indicating whether the element is checked (default: nil).
+  # is_selected       - Boolean indicating whether the element is selected (default: nil).
+  # is_checkable      - Boolean indicating whether the element can be checked (default: nil).
+  # is_focusable      - Boolean indicating whether the element can be focused (default: nil).
+  # is_long_pressable - Boolean indicating whether the element can be long-pressed (default: nil).
+  # is_scrollable     - Boolean indicating whether the element can be scrolled (default: nil).
+  # is_recordable     - Boolean indicating whether the element can be recorded (default: nil).
+  # x                 - Integer x coordinate of the element (default: nil).
+  # y                 - Integer y coordinate of the element (default: nil).
+  # width             - Integer width of the element (default: nil).
+  # height            - Integer height of the element (default: nil).
+  # coordinates       - Boolean indicating whether absolute coordinates are given (default: false).
+  # min               - Integer minimum number of matching elements to require (default: 0).
+  #                     By default, no restriction is imposed.
+  # max               - Integer maximum number of matching elements to require (default: nil).
+  #                     By default, no restriction is imposed.
+  # timeout           - Integer total milliseconds to allow for element search (default: 30.sec).
+  #
+  # Returns a Boolean true if successfully clicked the element, otherwise false.
+  def click?(attrs={})
+    ret = selenium_post('click', attrs)
+    !ret.nil?
+  end
+
+  # Public: Double-clicks the specified element.
+  #         For any String criteria, a Regular Expression may be used by adding the 'regexp:' prefix.
+  #
+  # delay             - Integer delay between clicks in milliseconds (default: 100.ms).
+  # selector          - String CSS selector to locate the element (default: nil).
+  # id                - String element id (default: nil).
+  # class_name        - String element class name (default: nil).
+  # tag_name          - String element tag name (default: nil).
+  # value             - String element value (default: nil).
+  # name              - String element name (default: nil).
+  # text              - String element text (default: nil).
+  # xpath             - String xpath to locate the element (default: nil).
+  #                     NOTE: xpath is unreliable and should be used sparingly.
+  # type              - String type of the element (default: nil).
+  # description       - String description of the element (default: nil).
+  # index             - Integer index of element to use among all matching elements (default: nil).
+  #                     By default, exactly one element must match.
+  # is_visible        - Boolean indicating whether the element is visible (default: nil).
+  # is_on_screen      - Boolean indicating whether any part of the element is within screen boundaries (default: nil).
+  # is_tappable       - Boolean indicating whether the element may be tapped (default: nil).
+  # is_password       - Boolean indicating whether the element is a password field (default: nil).
+  # is_enabled        - Boolean indicating whether the element is enabled (default: nil).
+  # is_checked        - Boolean indicating whether the element is checked (default: nil).
+  # is_selected       - Boolean indicating whether the element is selected (default: nil).
+  # is_checkable      - Boolean indicating whether the element can be checked (default: nil).
+  # is_focusable      - Boolean indicating whether the element can be focused (default: nil).
+  # is_long_pressable - Boolean indicating whether the element can be long-pressed (default: nil).
+  # is_scrollable     - Boolean indicating whether the element can be scrolled (default: nil).
+  # is_recordable     - Boolean indicating whether the element can be recorded (default: nil).
+  # x                 - Integer x coordinate of the element (default: nil).
+  # y                 - Integer y coordinate of the element (default: nil).
+  # width             - Integer width of the element (default: nil).
+  # height            - Integer height of the element (default: nil).
+  # coordinates       - Boolean indicating whether absolute coordinates are given (default: false).
+  # min               - Integer minimum number of matching elements to require (default: 0).
+  #                     By default, no restriction is imposed.
+  # max               - Integer maximum number of matching elements to require (default: nil).
+  #                     By default, no restriction is imposed.
+  # timeout           - Integer total milliseconds to allow for element search (default: 30.sec).
+  #
+  # Returns a Boolean true if successfully double-clicked the element, otherwise false.
+  def double_click?(attrs={})
+    ret = selenium_post('double-click', attrs)
+    !ret.nil?
+  end
+
+  # Public: Types the given text in the specified element.
+  #         For any String criteria, a Regular Expression may be used by adding the 'regexp:' prefix.
+  #
+  # keys              - String or Array of String keys to type.
+  # selector          - String CSS selector to locate the element (default: nil).
+  # id                - String element id (default: nil).
+  # class_name        - String element class name (default: nil).
+  # tag_name          - String element tag name (default: nil).
+  # value             - String element value (default: nil).
+  # name              - String element name (default: nil).
+  # text              - String element text (default: nil).
+  # xpath             - String xpath to locate the element (default: nil).
+  #                     NOTE: xpath is unreliable and should be used sparingly.
+  # type              - String type of the element (default: nil).
+  # description       - String description of the element (default: nil).
+  # index             - Integer index of element to use among all matching elements (default: nil).
+  #                     By default, exactly one element must match.
+  # is_visible        - Boolean indicating whether the element is visible (default: nil).
+  # is_on_screen      - Boolean indicating whether any part of the element is within screen boundaries (default: nil).
+  # is_tappable       - Boolean indicating whether the element may be tapped (default: nil).
+  # is_password       - Boolean indicating whether the element is a password field (default: nil).
+  # is_enabled        - Boolean indicating whether the element is enabled (default: nil).
+  # is_checked        - Boolean indicating whether the element is checked (default: nil).
+  # is_selected       - Boolean indicating whether the element is selected (default: nil).
+  # is_checkable      - Boolean indicating whether the element can be checked (default: nil).
+  # is_focusable      - Boolean indicating whether the element can be focused (default: nil).
+  # is_long_pressable - Boolean indicating whether the element can be long-pressed (default: nil).
+  # is_scrollable     - Boolean indicating whether the element can be scrolled (default: nil).
+  # is_recordable     - Boolean indicating whether the element can be recorded (default: nil).
+  # x                 - Integer x coordinate of the element (default: nil).
+  # y                 - Integer y coordinate of the element (default: nil).
+  # width             - Integer width of the element (default: nil).
+  # height            - Integer height of the element (default: nil).
+  # coordinates       - Boolean indicating whether absolute coordinates are given (default: false).
+  # min               - Integer minimum number of matching elements to require (default: 0).
+  #                     By default, no restriction is imposed.
+  # max               - Integer maximum number of matching elements to require (default: nil).
+  #                     By default, no restriction is imposed.
+  # timeout           - Integer total milliseconds to allow for element search (default: 30.sec).
+  #
+  # Returns a Boolean true if successfully typed in the element, otherwise false.
+  def type?(keys, attrs={})
+    if keys.is_a?(Array)
+      attrs[:keys] = keys
+    else
+      attrs[:keys] = keys.split('')
+    end
+    ret = selenium_post('type', attrs)
+    !ret.nil?
+  end
+
+  # Public: Sends the given keys to the specified element.
+  #         For any String criteria, a Regular Expression may be used by adding the 'regexp:' prefix.
+  #
+  # keys              - String or Array of String keys to send.
+  # combine           - Boolean indicating whether the keys should be combined (default: false).
+  #                     This should be used to send combinations like `Control+A'. The following keys are supported:
+  #                     https://seleniumhq.github.io/selenium/docs/api/dotnet/html/T_OpenQA_Selenium_Keys.htm
+  # selector          - String CSS selector to locate the element (default: nil).
+  # id                - String element id (default: nil).
+  # class_name        - String element class name (default: nil).
+  # tag_name          - String element tag name (default: nil).
+  # value             - String element value (default: nil).
+  # name              - String element name (default: nil).
+  # text              - String element text (default: nil).
+  # xpath             - String xpath to locate the element (default: nil).
+  #                     NOTE: xpath is unreliable and should be used sparingly.
+  # type              - String type of the element (default: nil).
+  # description       - String description of the element (default: nil).
+  # index             - Integer index of element to use among all matching elements (default: nil).
+  #                     By default, exactly one element must match.
+  # is_visible        - Boolean indicating whether the element is visible (default: nil).
+  # is_on_screen      - Boolean indicating whether any part of the element is within screen boundaries (default: nil).
+  # is_tappable       - Boolean indicating whether the element may be tapped (default: nil).
+  # is_password       - Boolean indicating whether the element is a password field (default: nil).
+  # is_enabled        - Boolean indicating whether the element is enabled (default: nil).
+  # is_checked        - Boolean indicating whether the element is checked (default: nil).
+  # is_selected       - Boolean indicating whether the element is selected (default: nil).
+  # is_checkable      - Boolean indicating whether the element can be checked (default: nil).
+  # is_focusable      - Boolean indicating whether the element can be focused (default: nil).
+  # is_long_pressable - Boolean indicating whether the element can be long-pressed (default: nil).
+  # is_scrollable     - Boolean indicating whether the element can be scrolled (default: nil).
+  # is_recordable     - Boolean indicating whether the element can be recorded (default: nil).
+  # x                 - Integer x coordinate of the element (default: nil).
+  # y                 - Integer y coordinate of the element (default: nil).
+  # width             - Integer width of the element (default: nil).
+  # height            - Integer height of the element (default: nil).
+  # coordinates       - Boolean indicating whether absolute coordinates are given (default: false).
+  # min               - Integer minimum number of matching elements to require (default: 0).
+  #                     By default, no restriction is imposed.
+  # max               - Integer maximum number of matching elements to require (default: nil).
+  #                     By default, no restriction is imposed.
+  # timeout           - Integer total milliseconds to allow for element search (default: 30.sec).
+  #
+  # Returns a Boolean true if successfully typed in the element, otherwise false.
+  def send?(keys, attrs={})
+    if keys.is_a?(Array)
+      attrs[:keys] = keys
+    else
+      attrs[:keys] = [keys]
+    end
+    ret = selenium_post('send', attrs)
+    !ret.nil?
+  end
+
+  private
+
+  # Internal: Returns true if the web driver is closed.
+  #
+  # Returns a Boolean indicating whether the driver is closed.
+  def closed?
+    @closed
+  end
+
+end

data/lib/lib/test_case/boilerplate/functional.rb

@@ -0,0 +1,7 @@
+require './lib/test_case/functional_test_case'
+
+class Test < FunctionalTestCase
+  def run
+# user code here
+  end
+end

data/lib/lib/test_case/boilerplate/performance.rb

@@ -0,0 +1,7 @@
+require './lib/test_case/performance_test_case'
+
+class Test < PerformanceTestCase
+  def run
+# user code here
+  end
+end

data/lib/lib/test_case/ci_test.rb

@@ -0,0 +1,47 @@
+
+module CiTest
+  def run
+    # The behavior of a CI script is controlled by script options, so that multiple CI tests can use the same script,
+    # but with different inputs/outputs depending on the needs of the test.
+    ci_actions = Hash[test_data.fetch(:_ci_actions, {})].fetch(id, [])
+    ci_actions = [ci_actions] unless ci_actions.is_a?(Array)
+    logger.info("CI Actions: #{ci_actions.inspect}")
+
+    # Perform test actions by step
+    ci_actions.each do |ci_action|
+      # Define actions
+      do_actions = proc do
+        # Get the actions list
+        actions = ci_action.fetch(:actions, [])
+        actions = [actions] unless actions.is_a?(Array)
+        actions.each do |action|
+          obj = self
+          # Get the methods list
+          methods = action.fetch(:method, [])
+          methods = [methods] unless methods.is_a?(Array)
+          # Get the params list
+          params = action.fetch(:params, [])
+          params = [params] unless params.is_a?(Array)
+          logger.info("#{methods.join('.')}(#{params.map {|p| p.inspect}.join(', ')})", tag: 'ACTION')
+          methods.each_with_index do |sym, i|
+            if params.empty? || i < (methods.count - 1)
+              # Send method
+              obj = obj.send(sym.to_sym)
+            else
+              # Send final method with specified parameters
+              obj = obj.send(sym.to_sym, *params)
+            end
+          end
+        end
+      end
+
+      # Perform actions, in a step if specified
+      if ci_action[:step].nil?
+        do_actions.call
+      else
+        test_step(ci_action[:step], name: 'Verify something', &do_actions)
+      end
+    end
+
+  end
+end

data/lib/lib/test_case/functional_test_case.rb

@@ -0,0 +1,27 @@
+require './lib/test_case/test_case'
+
+# FunctionalTestCase manages test flow for functional tests
+
+class FunctionalTestCase < TestCase
+
+  # Public: Initializes a functional test case. NOT FOR USE IN TESTS.
+  #
+  # Returns nothing.
+  def initialize(*args)
+    super
+    @sword_report_error = true
+  end
+
+  # Public: Defines test case flow for functional tests.
+  #
+  # Returns nothing.
+  def perform
+    begin
+      super
+    rescue Exception => e
+      # swallow all exceptions, we have already logged/reported them at this point
+    end
+  end
+
+end
+

data/lib/lib/test_case/make_boilerplate.rb

@@ -0,0 +1,32 @@
+type = ARGV.shift.downcase
+name = ARGV.shift
+args = ARGV.map do |a|
+  parts = a.split('=')
+  [parts[0], (parts[1] || '').split(',')]
+end.to_h
+
+pre_lines = [
+    "require './lib/test_case/#{type}_test_case'",
+    '',
+    "class #{name} < #{type.capitalize}TestCase",
+    ''
+]
+any_prereqs = false
+%w(prereqs_for_test prereqs_for_dut).each do |p_type|
+  p_value = args.fetch(p_type, [])
+  unless p_value.empty?
+    any_prereqs = true
+    pre_lines << "  #{p_type}(#{p_value.map {|p| p.to_sym.inspect}.join(', ')})"
+  end
+end
+pre_lines << '' if any_prereqs
+pre_lines << '  def run'
+
+post_lines = [
+    '  end',
+    "end\n"
+]
+
+puts pre_lines.join("\n")
+puts '======='
+puts post_lines.join("\n")

data/lib/lib/test_case/monitoring/apple_monitor.rb

@@ -0,0 +1,104 @@
+require './lib/test_case/monitoring/base_monitor'
+
+class AppleMonitor < BaseMonitor
+
+  # ROI's
+  def apple_home
+    dut.roi.color.new(:x => 10, :y => 10, :width => 72, :height => 84, :similarity => 90, :rgb => [185, 187, 197], :ref_img => "")
+  end
+
+  def home_row
+    dut.roi.text.new(:x => 62, :y => 930, :width => 1608, :height => 44, :similarity => 70, :text => '', :only_digits => false, :ref_img => "")
+  end
+
+  def setting_img_1080
+    dut.roi.image.new(:x => 58, :y => 706, :width => 1616, :height => 58, :similarity => 90, :img_x => 58, :img_y => 726, :img_width => 342, :img_height => 38, :ref_img => "tsimages/reference/apple_tv/settings.jpg")
+  end
+
+  def setting_home
+    dut.roi.text.new(:x => 828, :y => 58, :width => 260, :height => 66, :similarity => 70, :text => 'Settings', :only_digits => false, :ref_img => "")
+  end
+
+  def general_selected
+    dut.roi.color.new(:x => 1698, :y => 200, :width => 46, :height => 30, :similarity => 90, :rgb => [237, 242, 244], :ref_img => "")
+  end
+
+  def apple_model
+    dut.roi.text.new(:x => 1322, :y => 286, :width => 502, :height => 60, :similarity => 70, :text => '', :only_digits => false, :ref_img => "")
+  end
+
+  def apple_sn
+    dut.roi.text.new(:x => 1322, :y => 360, :width => 502, :height => 60, :similarity => 70, :text => '', :only_digits => false, :ref_img => "")
+  end
+
+  def ip_add
+    dut.roi.text.new(:x => 1322, :y => 600, :width => 502, :height => 60, :similarity => 70, :text => '', :only_digits => false, :ref_img => "")
+  end
+
+  def mac_add
+    dut.roi.text.new(:x => 1390, :y => 696, :width => 448, :height => 62, :similarity => 70, :text => '', :only_digits => false, :ref_img => "")
+  end
+
+  def check_power
+    dut.press_key('exit', :sleep_time=>1.sec)
+    dut.press_key('exit', :sleep_time=>1.sec)
+    dut.press_key('menu', :sleep_time=>2.sec)
+    super
+  end
+  # Should do nothing since we don't need to check guide or live tv
+  def check_health
+    
+  end
+
+  def check_menu
+    app_home = roi_resolution(apple_home, dut.height, dut.width)
+    set_err_result(@health_hash, 'Unable to nav to menu. Check platform or device health', 'A3.1') unless app_home.press_key_until_displayed?('menu', presses: 12, timeout: 12.sec, try_every: 1.sec)
+
+    [nav_to_setting, nav_to_about].select { |a| return a unless a.nil? }[0]
+  end
+
+  def nav_to_setting
+    settings_txt_roi = roi_resolution(home_row, dut.height, dut.width)
+    # make sure we are at left most part of menu
+    4.times { dut.press_key('left_arrow', sleep_time: 500) }
+    if dut.height == 1080
+      setting_home_roi = setting_img_1080
+      set_err_result(@health_hash, 'Could not nav to settings', 'A3.2') unless setting_home_roi.press_key_until_displayed?('down_arrow', presses: 5, timeout: 15.sec, try_every: 3.sec)
+    else
+      # need to make 720 roi?
+    end
+    settings_txt_roi.text = 'Settings'
+    set_err_result(@health_hash, 'had trouble navigating to settings', 'A3.3') unless settings_txt_roi.press_key_until_displayed?('right_arrow', presses: 5, timeout: 5.sec, try_every: 750)
+  end
+
+  def nav_to_about
+    setting_home_roi = roi_resolution(setting_home, dut.height, dut.width)
+    general_selected_roi = roi_resolution(general_selected, dut.height, dut.width)
+    set_err_result(@health_hash, 'Not at settings', 'A3.4') unless setting_home_roi.press_key_until_displayed?('select', presses: 3, timeout: 4000, try_every: 750)
+  
+    general_selected_roi.press_key_until_displayed?('up_arrow', presses: 10, timeout: 10_000, try_every: 1000)
+    setting_home_roi.text = 'About'
+    set_err_result(@health_hash, 'Failed to nav to About Page', 'A3.5') unless setting_home_roi.press_key_until_displayed?('select', presses: 6, timeout:6000, try_every: 750)
+    
+    nil
+  end
+
+  def find_mac
+    url = take_screenshot
+    # if result.length > 0
+    #   return {result: result, url: url}
+    # end
+    apple_model_roi = roi_resolution(apple_model, dut.height, dut.width)
+    apple_sn_roi = roi_resolution(apple_sn, dut.height, dut.width)
+    ip_add_roi = roi_resolution(ip_add, dut.height, dut.width)
+    mac_add_roi = roi_resolution(mac_add, dut.height, dut.width)
+    @health_hash[:sn] = apple_sn_roi.retrieve.gsub(',', '').strip,
+    @health_hash[:model] = apple_model_roi.retrieve
+    @health_hash[:ip] = ip_add_roi.retrieve
+    @health_hash[:mac] = mac_add_roi.retrieve.upcase.gsub(':', '').gsub(' ', '')
+    @health_hash[:url] = url
+    
+
+    @health_hash
+  end
+end