framework_gem 0.1.0

data/lib/lib/test_case/monitoring/passport_monitor.rb

@@ -0,0 +1,50 @@
+require './lib/test_case/monitoring/base_monitor'
+
+# This class should be included in the MonitoringTest module
+class PassportMonitor < BaseMonitor
+  def passport_menu
+    dut.roi.text.new(:x => 412, :y => 280, :width => 142, :height => 54, :similarity => 70,
+                        text: 'Menu', only_digits: false, ref_img: '')
+  end
+
+  def passport_guide
+    dut.roi.color.new(:x => 328, :y => 948, :width => 102, :height => 102, :similarity => 90, 
+                      :rgb => [188, 190, 188], :ref_img => "")
+  end
+
+  def parental_control
+    roi_resolution(dut.roi.text.new(:x => 788, :y => 686, :width => 408, :height => 90, :similarity => 70, :text => 'Disable Parental Control', :only_digits => false, :ref_img => ""),
+                   dut.height, dut.width)
+  end
+
+  def check_menu
+    #Sara vs Passport check
+    channel_guide = dut.roi.text.new(:x => 362, :y => 498, :width => 194, :height => 62, :similarity => 70, :text => 'CHANNEL', :only_digits => false, :ref_img => "")
+    channel_guide_roi = roi_resolution(channel_guide, dut.height, dut.width)
+    dut.press_key('exit', :sleep_time=>2.sec)
+    set_err_result(@health_hash, 'This is a Sara platform not Passport', 'P3.1') if channel_guide_roi.wait_until_displayed?(10000, key: 'menu')
+
+    #passport check
+    passport_main_menu = roi_resolution(passport_menu, dut.height, dut.width)
+    tries = 0
+    dut.press_key('exit', :sleep_time=>2.sec)
+    dut.press_key('menu', :sleep_time=>2.sec)
+    until passport_main_menu.displayed?(timeout:2000) || tries == 7 do
+      dut.press_key('right_arrow', :sleep_time=>1.sec)
+      tries += 1
+    end
+
+    set_err_result(@health_hash, 'Unable to nav to menu. Check platform or device health', 'P3.2') if tries == 7
+    # Lots of errors reported due to wrong plat rather than device issue.
+  end
+
+  def find_mac
+    dut.press_key('exit', :sleep_time=>2.sec)
+    {} #do nothing for now just return empty hash (no mac info just exit out of guide)
+  end
+
+  def check_live_tv?
+    report_parental_controls(parental_control)
+    super
+  end
+end

data/lib/lib/test_case/monitoring/report_monitor.rb

@@ -0,0 +1,178 @@
+# All this module should do is interface with the SWORD app and includes essential components for the final reports.
+# Will mutate the hash while the test runs.
+
+module ReportMonitor
+  # TODO delete this after test development
+  def log_hash(*msg, hash)
+    logger.warn("#{msg[0]}: #{hash}", tag: "HASH")
+    logger.warn("hash id is #{hash.object_id} ")
+    logger.warn("hash id is #{hash}")
+  end
+
+  def invalid_report
+    @dut_id = instance_variable_get(:@primary_device_id)
+    resp = tmc_get("/api/config/hardware/devices?devices=#{@dut_id}")
+    @cfg = resp['devices'].first
+    res = confirm_platform(@cfg)
+    logger.warn('past confirm platform')
+    log_hash('invalid report', res)
+    send_legacy_err_hash(res, "Legacy")
+    "Legacy: #{res}"
+  end
+
+  # Should return string with information as to failure if legacy platform.
+  def confirm_platform(config)
+    # maybe when we confirm platofrm, just let it blow up
+    # if it doesn't include any of the platforms we have created?
+    # (found a platform called 'adsg,' lol)
+    platform = config['platform']
+    name = config['name']
+    legacy_plats = %w[hd dvr]
+    return 'Legacy platform please update' if platform == '' || platform.nil? # if no platform at all.
+    legacy = legacy_plats.select { |el| platform.downcase.include?(el) }
+    return 'Legacy platform please update' unless legacy.empty? # give legacy error      
+  end
+
+  # This function grabs what we need w/o calling dut, which hasn't been initialized yet.
+  def send_legacy_err_hash(result, err_code)
+    res_hash = {}
+    res_hash[:tmc_name] = server_info['hostname']
+    res_hash[:tmc_start_time] = Time.now
+    res_hash[:tmc_run_id] = job_name
+    res_hash[:error_code] = err_code
+    res_hash[:slot] = @dut_id
+    res_hash[:result] = result
+    res_hash[:tmc_script_name] = name
+    res_hash[:script_error_time] = Time.now + 500
+    res_hash[:username] = tmc_get('/api/login')['name']
+    sword_send_results(res_hash, true)
+  end
+  # Public Function used to determine throughout checks if there is a fail. 
+  #
+  # Returns nothing.
+  def set_err_result(results_hash, err_msg, err_code)
+    logger.warn("#{results_hash}")
+    results_hash[:result] = err_msg
+    results_hash[:error_code] = err_code
+    results_hash[:script_error_time] = Time.now
+    log_hash("set err ", results_hash)
+    results_hash[:vid_link] = take_screenshot
+    sword_send_results(results_hash)
+    @test_case.fail "Device is not healthy: #{err_code} : #{err_msg}"
+  end
+
+  # Public: All sword reports need these common fields no matter what. Mutates the health check hash. Called at beginning of test script  
+  #
+  # results_hash - Hash including all results from test so far.
+  #
+  # returns nothing.
+  def assign_test_params(results_hash)
+    log_hash('beginning ', results_hash)
+    results_hash[:tmc_name] = server_info['hostname']
+    results_hash[:tmc_run_id] = job
+    results_hash[:tmc_start_time] = job_start_time
+    results_hash[:tmc_script_name] = name
+    results_hash[:slot] = "Slot #{dut.id}"
+    results_hash[:username] = tmc_get('/api/login')['name']
+    log_hash('assign_test_params ', results_hash)
+    results_hash
+  end
+
+  # Public: Assign the parameters for the email. Will return a boolean if it's needed. Mutates hash instance inside method.
+  #
+  # results_hash - Hash including all results from test so far. 
+  # err_code - String of the error result found. (default: nil)
+  #
+  # Returns boolean
+  def assign_email_params?(results_hash, legacy)
+    log_hash('email params 1 ', results_hash)
+    # Return out if no err_code sent
+    if results_hash.fetch(:result, "").downcase == 'pass'
+      results_hash[:email] = 'false'
+      return false
+    end
+
+    if !@test_case.nil?
+      results_hash[:recipient] = @test_case.test_data['recipient']
+      results_hash[:recipient] = "   "     #for jim until we set recipients or test_data
+    else
+      results_hash[:recipient] = test_data['recipient']
+    end
+
+    results_hash[:subject] = results_hash.fetch(:subject, "Health Check results on #{server_info['hostname']}")
+    results_hash[:recipient] = results_hash.fetch(:recipient, " ") # pass comma seperated string for default ('person1@charter, person2@charter')
+    results_hash[:email] = 'true'
+    results_hash[:message] = generate_email_msg(results_hash, legacy ? @dut_id : nil) unless results_hash[:message]
+    log_hash('email params 2 ', results_hash)
+    return true
+  end
+
+  # Should only get called if email result is true. Adds email message to result hash.
+  #
+  # returns nothing
+  def generate_email_msg(hash, id=nil)
+    slot_num = nil
+    platform = nil
+    screenshot = nil
+    if id
+      slot_num = id
+      platform = hash[:result]
+    else
+      slot_num = dut.id
+      platform = dut.platform
+      screenshot = hash[:vid_link]
+    end
+    msg = ''
+    msg << "Slot #{slot_num}, Error_Code: #{hash[:error_code]}, Result: #{hash[:result]}"
+    msg << ", Platform: #{platform}, Screenshot: #{screenshot}" unless id
+    msg
+  end
+
+  def take_screenshot
+    ss = dut.capture_screen(format: :raw)
+    aws_write_s3(
+      'charter-testworkbench-com',
+      "health_check/#{server_name.gsub(' ', '')}/#{dut.id}/#{dut.platform}",ss)
+  end
+  
+  # Public: Use to send results from TMC to SWORD. Will also send an email to recipients by default, if disabled will only send results to a custom report.
+  #
+  # args is the hash to pass into the function. We recommend using the following key value pairs
+  # fail_cond will be a string describing fail condition, if pass then is nil (default: nil)
+  #
+  # message - String: The text designated for email body. (default: nil)
+  # subject - String: The text designated for email subject. (default: nil)
+  # vid_link - String: Any link with image / video to send into sword. (default: nil (will send text of "No Video Link found" if none sent))
+  # email - String: Send email to recipients (default: "true")
+
+  # Returns nothing.
+  def sword_send_results(result_hash, legacy = false)
+    logger.warn('sword send')
+    url = nil
+    # If true, send email. Else endpoint just adds to SWORD db.
+    if assign_email_params?(result_hash, legacy)
+      url = "https://sword-prod.enwd.co.sa.charterlab.com:443/automation_units/send_email_for_rack?"
+    else
+      url = "https://sword-prod.enwd.co.sa.charterlab.com:443/automation_units/tmc_stb_healthcheck?"
+    end
+    result_hash[:script_error_time] = Time.now
+    log_hash('sword send results ', result_hash) # Remove once testing is complete TODO
+    # new hash with SWORD friendly params. We could just standardize the keys as well
+    # then we won't need a new hash.
+    params = {
+      tmc_name: result_hash[:tmc_name], slot: result_hash[:slot], tmc_run_id: result_hash[:tmc_run_id],
+      tmc_start_time: result_hash[:tmc_start_time], tmc_script_name: result_hash[:tmc_script_name],
+      email_to_list: result_hash[:recipient], send_email_tf: result_hash[:email], message_to_send: result_hash[:message],
+      subject_line: result_hash[:subject], link_to_video: result_hash[:vid_link], script_error_time: result_hash[:script_error_time],
+      mac_address: result_hash[:mac], resolution: result_hash[:resolution], model: result_hash[:model], serial_number: result_hash[:serial_number],
+      device_id: result_hash[:device_id], account: result_hash[:account], screenshot_1: result_hash[:screenshot_1], screenshot_2: result_hash[:screenshot_2],
+      ip: result_hash[:ip], username: result_hash[:username], result: result_hash[:result], error_code: result_hash[:error_code]
+    }
+    log_hash('final params ', params)
+    url = url.concat(params.collect { |k,v| "#{k}=#{URI::escape(v.to_s)}" }.join('&'))
+    logger.debug("Reporting URL: #{url}")
+    # response = Net::HTTP.get_response(URI.parse(url))
+    response = web_request(:GET, url)
+    logger.debug("---#{response.body}--")
+  end
+end

data/lib/lib/test_case/monitoring/roku_monitor.rb

@@ -0,0 +1,102 @@
+require './lib/test_case/monitoring/base_monitor'
+
+# This class should be included in the MonitoringTest module
+class RokuMonitor < BaseMonitor
+
+  def roku_menu
+    dut.roi.text.new(x: 180, y: 240, width: 360,height: 62, similarity: 70,text: 'Home', only_digits: false, ref_img: '')
+  end
+
+  def system_text
+    dut.roi.text.new(x: 186, y: 250, width: 360,
+                     height: 44, similarity: 70,
+                     text: 'System', only_digits: false, ref_img: '')
+  end
+
+  def roku_mac
+    dut.roi.text.new(x: 972, y: 690, :width => 335, :height => 58, :similarity => 70, :text => '', :only_digits => false, :ref_img => "")
+  end
+
+  def roku_hardware_type
+    dut.roi.text.new(:x => 972, :y => 314, :width => 534, :height => 58, :similarity => 70, :text => '', :only_digits => false, :ref_img => "")
+  end
+
+  def roku_sn
+    dut.roi.text.new(:x => 972, :y => 375, :width => 335, :height => 58, :similarity => 70, :text => '', :only_digits => false, :ref_img => "")
+  end
+
+  def roku_curr_app
+    # Checks text on selected app
+    dut.roi.text.new(:x => 176, :y => 176, :width => 270, :height => 40, :similarity => 70, :text => '', :only_digits => false, :ref_img => "")
+  end
+
+  def check_health
+    # Should do nothing since roku doesn't need to check a guide or live tv  
+  end
+
+  def check_power
+    # Should do nothing since roku doesn't need to check a guide or live tv
+    # just press keys to exit screensaver if that is present
+    dut.press_key('select', sleep_time: 500)
+    dut.press_key('last', sleep_time: 500)
+  end
+
+  # def spectrum_app_avail
+  # Andrew said don't do this anymore.
+  #     checked_apps = []
+  #     app_roi = roi_resolution(roku_curr_app, @height, @width)
+  #     app_roi.text= 'Spectrum TV'
+  #     dut.press_key('right_arrow', sleep_time: 1000)
+  #     row = 1
+  #     until app_roi.displayed?(timeout:1000)
+  #         curr_app = app_roi.retrieve
+  #         already_checked = checked_apps.include?(curr_app)
+  #         if already_checked
+  #             dut.press_key('right_arrow', sleep_time:1000)
+  #             row += 1
+  #             @nav_right = true
+  #         end 
+  #         checked_apps.push(curr_app) unless already_checked
+  #         unless @nav_right
+  #             dut.press_key('down_arrow', sleep_time:1000)
+  #         end
+  #         set_err_result(@health_hash, 'Unable to find spectrum app') if row > 3
+  #         @nav_right = false
+  #     end
+  #     2.times { dut.press_key('menu', sleep_time: 500) }
+  #     nil
+  # end
+
+  def roku_nav_settings
+    menu_roi = roi_resolution(roku_menu, @height, @width)
+    set_err_result(@health_hash,'Failed to nav to Roku home. May need to be set up.', 'R3.1') unless menu_roi.press_key_until_displayed?('menu',  presses: 10, timeout: 15_000, try_every: 300)
+    menu_roi.text = 'Settings'
+    set_err_result(@health_hash,'Failed to nav to Roku settings', 'R3.2') unless menu_roi.press_key_until_displayed?('up_arrow', presses: 10, timeout: 15_000, try_every: 300)
+  end
+
+  def find_mac
+    @height = dut.height
+    @width = dut.width
+    system_roi = roi_resolution(system_text, @height, @width)
+    # Logic
+    roku_nav_settings
+    dut.press_key('right_arrow', sleep_time: 1000)
+    set_err_result(@health_hash, 'Failed to nav to Roku system info', 'R3.3') unless system_roi.press_key_until_displayed?('down_arrow', presses: 10, timeout: 15_000, try_every: 300)
+    2.times { dut.press_key('right_arrow', sleep_time: 1000) }
+    roku_report_sys_info
+  end
+
+  def roku_report_sys_info
+    roku_mac_roi = roi_resolution(roku_mac, @height, @width)
+    roku_hw_roi = roi_resolution(roku_hardware_type, @height, @width)
+    roku_sn_roi = roi_resolution(roku_sn, @height, @width)
+    @health_hash[:screenshot_1] = take_screenshot
+    @health_hash[:mac] = roku_mac_roi.retrieve.gsub(':', '')
+    set_err_result(@health_hash, 'No connection found', 'R4') unless @health_hash[:mac].match(/[0-9]/)
+    @health_hash[:serial_number] = roku_sn_roi.retrieve
+    @health_hash[:model] = roku_hw_roi.retrieve
+    # dut.press_key('menu', sleep_time: 3.sec)
+    # result = spectrum_app_avail
+    # 2.times { dut.press_key('menu', sleep_time: 800) }
+  end
+end

data/lib/lib/test_case/monitoring/sara_monitor.rb

@@ -0,0 +1,33 @@
+require './lib/test_case/monitoring/base_monitor'
+require './lib/helpers/tmc_helpers/roi_helper/roi_helper'
+# This class should be included in the MonitoringTest module
+class SaraMonitor < BaseMonitor
+  include RoiHelper
+
+  def parental_control
+    roi_resolution(dut.roi.text.new(:x => 760, :y => 212, :width => 392, :height => 70, :similarity => 70, :text => 'Parental Control: ON', :only_digits => false, :ref_img => ""),
+    dut.height, dut.width)
+  end
+
+  def check_menu
+    #Saramenu
+    channel_guide = dut.roi.text.new(:x => 362, :y => 498, :width => 194, :height => 62, :similarity => 70, :text => 'CHANNEL', :only_digits => false, :ref_img => "")
+    channel_guide_roi = roi_resolution(channel_guide, dut.height, dut.width)
+    check1 = false
+    dut.press_key('exit', :sleep_time=>2.sec)
+    return nil if channel_guide_roi.wait_until_displayed?(10000, key: 'menu')
+
+    set_err_result(@health_hash, 'Unable to nav to menu. Check platform or device health', 'S3')
+    # Lots of errors reported due to wrong plat rather than device issue.
+  end
+
+  def find_mac
+    dut.press_key('exit', :sleep_time=>2.sec)
+    {} #do nothing for now just return empty hash (no mac info just exit out of guide)
+  end
+
+  def check_live_tv?
+    report_parental_controls(parental_control)
+    super
+  end
+end

data/lib/lib/test_case/monitoring/spec_monitor.rb

@@ -0,0 +1,154 @@
+require './lib/test_case/monitoring/base_monitor'
+
+# This class should be included in the MonitoringTest module
+class SpecMonitor < BaseMonitor
+
+  def spectrum_menu_mylibrary
+    dut.roi.text.new(x: 18, y: 463, width: 457, height: 101, similarity: 80,
+                      text: 'My Library', only_digits: false, ref_img: '')
+  end
+
+  def mac_acc_info
+    dut.roi.text.new(x: 576, y: 434, width: 224, height: 102, similarity: 70,
+                    text: 'Account Info', only_digits: false, ref_img: '')
+  end
+
+  def equip_info
+    dut.roi.text.new(x: 708, y: 36, width: 500, height: 102, similarity: 70,
+                      text: 'Equipment Info', only_digits: false, ref_img: '')
+  end
+
+  def spectrum_settings
+    dut.roi.text.new(x: 640, y: 76, width: 644, height: 114, similarity: 80,
+                      text: 'Settings & Support', only_digits: false, ref_img: '')
+  end
+
+  def settings_and_support_text
+    dut.roi.text.new(x: 629, y: 90, width: 656, height: 102, similarity: 80,
+                      text: 'Settings & Support', only_digits: false, ref_img: '')
+  end
+
+  def restart_spectrum_guide
+    dut.roi.text.new(x: 424, y: 306, width: 980, height: 230, similarity: 70,
+                      text: 'We\'re Restarting Spectrum \n Guide', only_digits: false, ref_img: '')
+  end
+
+  def spec_mac
+    dut.roi.text.new(x: 800, y: 742, width: 310, height: 58, similarity: 70,
+                      text: '', only_digits: false, ref_img: '')
+  end
+
+  def spec_hardware_type
+    dut.roi.text.new(x: 684, y: 658, width: 286, height: 46, similarity: 70,
+                      text: '', only_digits: false, ref_img: '')
+  end
+
+  def spec_sn
+    dut.roi.text.new(x: 808, y: 784, width: 398, height: 58, similarity: 70,
+                      text: '', only_digits: false, ref_img: '')
+  end
+
+  def spec_an
+    dut.roi.text.new(x: 846, y: 434, width: 380, height: 100, similarity: 70,
+                      text: '', only_digits: false, ref_img: '')
+  end
+
+  def spec_dev_id
+    dut.roi.text.new(x: 392, y: 496, width: 470, height: 36, similarity: 70,
+                      text: '', only_digits: false, ref_img: '')
+  end
+
+  def parental_lock
+    roi_resolution(dut.roi.text.new(:x => 600, :y => 282, 
+                                    :width => 778, :height => 78, 
+                                    :similarity => 70, :text => 'Parental Control PIN', 
+                                    :only_digits => false, :ref_img => ""),
+                                    dut.height, dut.width)
+  end
+
+  def check_menu
+    log_hash('spec_menu ', @health_hash)
+    spectrum_main_menu = roi_resolution(spectrum_menu_mylibrary, dut.height, dut.width)
+    # Lots of errors reported due to wrong plat rather than device issue.
+    unless spectrum_main_menu.wait_until_displayed?(15_000, key: 'menu')
+      set_err_result(@health_hash, 'Unable to nav to menu. Check platform or device health', 'SP3.1') 
+    end
+  end
+
+  def instantiate_rois
+    @spectrum_main_menu = roi_resolution(spectrum_menu_mylibrary, dut.height, dut.width)
+    @spectrum_settings_roi = roi_resolution(spectrum_settings, dut.height, dut.width)
+    @restart_spec = roi_resolution(restart_spectrum_guide, dut.height, dut.width)
+    @spec_acct_roi = roi_resolution(spec_an, dut.height, dut.width)
+    @mac_roi = roi_resolution(spec_mac, dut.height, dut.width)
+    @sn_roi = roi_resolution(spec_sn, dut.height, dut.width)
+    @model_roi = roi_resolution(spec_hardware_type, dut.height, dut.width)
+    @dev_id_roi = roi_resolution(spec_dev_id, dut.height, dut.width)
+    @account_inf_roi = roi_resolution(mac_acc_info, dut.height, dut.width)
+    @equip_inf_roi = roi_resolution(equip_info, dut.height, dut.width)
+  end
+
+  def nav_equip_info
+    6.times { dut.press_key('down_arrow', sleep_time: 1.sec) }
+  # would like to have it check for ROI in future
+    dut.press_key('select', sleep_time: 1.sec)
+    @account_inf_roi.wait_until_displayed?(8000)
+    dut.press_key('right_arrow', sleep_time: 2.sec)
+    dut.press_key('select', sleep_time: 1.sec)
+    @equip_inf_roi.wait_until_displayed?(8000)    
+    @health_hash[:device_id] = @dev_id_roi.retrieve
+    @health_hash[:screenshot_1] = take_screenshot
+    dut.press_key('last', :sleep_time=>0.sec)
+    @account_inf_roi.wait_until_displayed?(8000)
+  end
+
+  def nav_account_info
+    dut.press_key('left_arrow', :sleep_time=>2.sec)
+    dut.press_key('select', :sleep_time=>0.sec)
+    @spectrum_settings_roi.wait_until_displayed?(8000)
+    @health_hash[:screenshot_2] = take_screenshot
+    log_hash('spec_nav_account_info ', @health_hash)
+  end
+
+  def set_mac_results
+    @health_hash[:account] = @spec_acct_roi.retrieve.gsub(" ", "")
+    @health_hash[:mac] = @mac_roi.retrieve
+    @health_hash[:serial_number] = @sn_roi.retrieve
+    @health_hash[:model] = @model_roi.retrieve
+    log_hash('spec_set_mac_results ', @health_hash)
+  end
+
+  def find_mac
+    log_hash('spec_mac_1 ', @health_hash)
+    # create instances of rois needed
+    instantiate_rois
+    # Will nav to settings, then find MAC
+    # Lambda to be used if another attempt is needed. (restart spec prompt will trigger)
+    try_again = lambda {
+        dut.press_key('select', :sleep_time=>5.sec)
+        dut.press_key('exit', :sleep_time=>5.sec)
+        set_err_result(@health_hash, "Failed to reach spec menu", 'SP3.2') unless @spectrum_main_menu.wait_until_displayed?(20000, key: "menu")
+        7.times { dut.press_key('down_arrow', :sleep_time=>3.sec) }
+        dut.press_key('select', :sleep_time=>0.sec)
+    }
+
+    7.times { dut.press_key('down_arrow', :sleep_time=>1.sec) } 
+    dut.press_key('select', :sleep_time=>0.sec)
+
+    if @restart_spec.displayed?(timeout: 1500)
+      try_again.call
+    end
+
+    set_err_result(@health_hash, 'Failed to nav to settings', 'SP3.3') unless @spectrum_settings_roi.wait_until_displayed?(30000)
+    nav_equip_info
+    nav_account_info
+    set_mac_results
+    2.times { dut.press_key('exit', :sleep_time=>3.sec) }
+    log_hash('spec_mac_2 ', @health_hash)
+  end
+
+  def check_live_video?
+    report_parental_controls(parental_lock)
+    super
+  end
+end