framework_gem 0.1.0

data/lib/User_Lib/screen/stb/spectrum/spectrum_library.rb

@@ -0,0 +1,384 @@
+require './lib/screen/stb/spectrum/spectrum_screen'
+# DO NOT ADD DSL REQUIRES HERE. Load them in methods that need them, otherwise syntax completion will be slow.
+
+# Defines Spectrum-specific methods on the My Library screen.
+
+class SpectrumLibrary < SpectrumScreen
+
+  # Public: Navigates to My Library from Live TV.
+  #
+  # Returns nothing.
+  def navigate_from_live_tv
+    dut.press_key.MENU(:sleep_time => 8.sec)
+    dut.press_key.SELECT(:sleep_time => 5.sec)
+  end
+
+  # Public: Checks if the My Library screen is displayed.
+  #
+  # timeout - Integer total milliseconds to check before timing out  (default: 0.sec).
+  #
+  # Returns a Boolean true if the screen is displayed, otherwise false.
+  def displayed?(args={})
+    dut.roi.text.library.displayed?(args)
+  end
+
+  # Public: Navigates to Library screen and check for expiring soon ROIs
+  #
+  # Returns True or false.
+  def expiring_soon?
+  	if dut.roi.text.expiring_soon_1.displayed?(:timeout => 7000)
+  	return true
+   	#elsif dut.roi.text.expiring_soon_2.displayed?(:timeout => 7000)
+  	#return true
+  	end
+  end
+
+  # Public: Navigates to this screen and verifies it.
+  #
+  # Returns True or false.
+  def expiring_soon
+  	if dut.roi.text.expiring_soon_2.displayed?(:timeout => 7000)
+  	return true
+  	elsif dut.roi.text.expiring_soon.displayed?(:timeout => 7000)
+  	logger.info("Expiring soon Displayed")		
+  	return true
+  	end
+  end
+
+  # Public: check if a given rectangle area is valid which should contain ':x', ':y', ':width', and ':height'
+  #
+  # Args:
+  #   box: Hash. It should contain ':x', ':y', ':width', and ':height'
+  #
+  # Returns Bool. If invalid, return false, otherwise return true
+  def is_a_box(args={})
+      # get required parameters
+      if ! args.any?
+        loginfo "Invalid parameters, should have ':box'"
+        return false
+      else
+        if args.include?(:box)
+          box = args[:box]
+        else
+          return false
+        end
+      end
+      # check given area
+      if !box.is_a?(Hash)
+        return false
+      end
+      if !(box.include?(:x) and box.include?(:y) and box.include?(:width) and box.include?(:height))
+        loginfo "Invalid box format, which must set ':x', ':y', ':width', and ':height'"
+        return false
+      end
+      return true
+  end
+
+  # Public: Retrieve text in a given box.
+  #
+  # Args:
+  #   box: Hash.
+  #            the rectangle area used to retrieve the contained text. default:
+  #            {:x=>63, :y=>355, :width=>308, :height=>691}
+  #
+  # Returns String. The text in a given box
+  def text_in_box(args={})
+      # set default parameters
+      box={:x=>63, :y=>355, :width=>308, :height=>691}
+        
+      # get required parameters
+      if ! args.any?
+        loginfo "Invalid parameters, should have ':box'"
+        return ""
+      else
+        if args.include?(:box)
+          box = args[:box]
+        end
+      end
+      # check given box
+      if ! dut.screens.library.is_a_box(:box=>box)
+        return ""
+      end
+      # create a text roi
+      text_roi = dut.roi.text.new(:rectangle=>box)
+      retrieved_text = text_roi.retrieve
+      return retrieved_text
+  end
+
+  # Public: Check if a given text is in a given box.
+  #
+  # Args:
+  #   box: Hash.
+  #        the rectangle area used to check if the
+  #        given text is in the box. default:
+  #        {:x=>63, :y=>355, :width=>308, :height=>691}
+  #
+  #   text:  String. The given string to be checked
+  #
+  # Returns Bool. If the given text is in the given area, return true, 
+  #          otherwise, return false
+  def include_in_box(args={})
+      # set default parameters
+      box={:x=>63, :y=>355, :width=>308, :height=>691}
+      text=""
+        
+      # get required parameters
+      if ! args.any?
+        loginfo "Invalid parameters, should have ':text' and ':box'"
+        return false
+      else
+        if args.include?(:text)
+          text = args[:text]
+        end
+        if args.include?(:box)
+          box = args[:box]
+        end
+      end
+      # check the given text
+      if !(text.is_a?(String) and (!text.empty?))
+        loginfo("'text' must be non-empty string.")
+        return false
+      end
+      # check given box
+      if ! dut.screens.library.is_a_box(:box=>box)
+        return false
+      end
+      # create a text roi
+      text_roi = dut.roi.text.new(:rectangle=>box)
+      retrieved_text = text_roi.retrieve
+      return retrieved_text.include?(text)
+  end
+
+  # Public: Count the number of assets in an asset page along one direction.
+  #
+  # Args:
+  #   nav_key: the navigation key pressed for counting. It must one 
+  #            of the navigation keys. default: "down_arrow"
+  #   box: 
+  #            the rectangle area used to check if the
+  #            image in the area changes as a key is pressed. If not 
+  #            changing, it means we are already at the buttom. default:
+  #            {:x=>75,:y=>439,:width=>1700,:height=>622}
+  #
+  #   nassets:  integer. It's the number of assets passed
+  #            when pressing the given key each time. default: 7
+  #
+  #   similarity: integer.
+  #
+  # Notes:
+  #   When counting vertically from row 0, it returns the number of assets 
+  #   where every row is fully filled. When counting horizontally from
+  #   column 0 and set nassets 1 and set the box cover the whole row, it
+  #
+  # Returns Integer. The number of assets counted when can not move.
+  #         nil if the given 'nassets' is not an integer or 'box' is invalid
+  def count_assets_one_dir(args={})
+      # set default parameters
+      nav_key="down_arrow"
+      box={:x=>75,:y=>439,:width=>1700,:height=>622}
+      nassets=7
+      similarity=95
+        
+      # get required parameters
+      if ! args.any?
+        loginfo "Use default settings."
+      else
+        if args.include?(:nav_key)
+          nav_key = args[:nav_key]
+        end
+        if args.include?(:box)
+          box = args[:box]
+        end
+        if args.include?(:nassets)
+          nassets = args[:nassets]
+        end
+        if args.include?(:similarity)
+          similarity = args[:similarity]
+        end
+      end
+      # check given area
+      if !dut.screens.library.is_a_box(:box=>box)
+        return
+      end
+      # check if nassets is an integer
+      if !nassets.is_a?(Integer)
+        loginfo "'nassets' should be an integer."
+        return
+      end
+      
+      # check if similarity is an integer
+      if !similarity.is_a?(Integer)
+        loginfo "'similarity' should be an integer."
+        return
+      end
+      # count the number of time the key is pressed
+      ncount = 0
+      con_check = true
+      img_args = {
+                  :rectangle=>box, 
+                  :similarity=>similarity,
+                  :img_x=>box[:x],
+                  :img_y=>box[:y],
+                  :img_width=>box[:width],
+                  :img_height=>box[:height]
+      }
+      while con_check do
+        snap_img = dut.capture_screen
+        img_args[:ref_img] = snap_img
+        dut.press_key(nav_key, :sleep_time=>3.sec)
+        check_img = dut.roi.image.new(img_args)
+        con_check = !check_img.displayed?
+        if con_check
+          ncount = ncount + 1
+        end
+       end
+      result = ncount*nassets
+      return result
+  end
+
+  # Public: Check if a given rgb is valid.
+  #
+  # Args:
+  #   rgb: Integer Array of 3 values (0 - 255) for red, green, blue.
+  #
+  # Returns Bool. true if rgb meets the requirement, otherwise false
+  def rgb_validate(args={})
+    # get required parameters
+    if ! args.any?
+      loginfo "Invalid parameters, should have ':rgb'."
+      return false
+    else
+      if args.include?(:rgb)
+        rgb = args[:rgb]
+      end
+    end
+    
+    # check if 'rgb' is valid
+    if ! rgb.is_a?(Array)
+      loginfo "Given ':rgb' should be an array with 3 integers from 0-255."
+      return false
+    else
+      if rgb.length != 3
+        loginfo "Given ':rgb' should be an array with 3 integers from 0-255."
+        return false
+      else
+        rgb.each{|aa|
+          if ! aa.is_a?(Integer)
+            loginfo "Given ':rgb' should be an array with 3 integers from 0-255."
+            return false
+          else
+            if aa<0 or aa>255
+              loginfo "Given ':rgb' should be an array with 3 integers from 0-255."
+              return false
+            end
+          end
+        }
+      end
+    end
+    return true
+  end
+
+  # Public: Check if a given box is black.
+  #
+  # Args:
+  #   box: 
+  #            the rectangle area used to check if it is black
+  #            {:x=>112,:y=>702,:width=>234,:height=>112}
+  #   similarity: Integer color similarity threshold 0 - 100 (default: 90).
+  #
+  # Returns Bool. true if the box is black, otherwise false
+  #         nil if the given 'box' or 'similarity' is invalid.
+  def if_box_black(args={})
+    # set default return and parameters
+    result = nil
+    
+    # box: a rectangle to check if it fills with banner
+    box = {:x=>112,:y=>702,:width=>234,:height=>112}
+    similarity = 90
+    
+    # get required parameters
+    if ! args.any?
+      loginfo "Invalid parameters, should have ':box'. Default is used."
+    else
+      if args.include?(:box)
+        box = args[:box]
+      end
+      if args.include?(:similarity)
+        similarity = args[:similarity]
+      end
+    end
+    
+    # check if each box is valid
+    if ! dut.screens.library.is_a_box(:box=>box)
+        return result
+    end
+    # validate similarity
+    if ! (similarity.is_a?(Integer) and similarity>=0 and similarity<=100)
+      return result
+    end
+    # check if poster is there or not
+    background = dut.roi.black.new(:rectangle=>box, :blackness=>similarity)
+    if background.displayed?
+      result = true
+    else
+      result = false
+    end
+    return result
+  end
+
+  # Public: Check if a given box matches the given rgb color.
+  #
+  # Args:
+  #   box: 
+  #        the rectangle area used to check if it is black
+  #        {:x=>112,:y=>702,:width=>234,:height=>112}
+  #   rgb: Integer Array of 3 values (0 - 255) for red, green, blue (default: [0,41,61]).
+  #   similarity: Integer color similarity threshold 0 - 100 (default: 90).
+  #
+  # Returns Bool. true if the box is black, otherwise false
+  #         nil if the given 'box' or 'rgb' or 'similarity' is invalid
+  def if_box_color(args={})
+    # set default return and parameters
+    result = nil
+    # box: a rectangle to check if it fills with banner
+    box = {:x=>163,:y=>768,:width=>125,:height=>74}
+    rgb = [0,41,61]
+    similarity = 90
+    # get required parameters
+    if ! args.any?
+      loginfo "Invalid parameters, should have ':box' and ':rgb'. Default is used."
+    else
+      if args.include?(:box)
+        box = args[:box]
+      end
+      if args.include?(:rgb)
+        rgb = args[:rgb]
+      end
+      if args.include?(:similarity)
+        similarity = args[:similarity]
+      end
+    end
+    
+    # check if each box is valid
+    if ! dut.screens.library.is_a_box(:box=>box)
+        return result
+    end
+    # check if 'rgb' is valid
+    if ! dut.screens.library.rgb_validate(:rgb=>rgb)
+      return result
+    end
+    # validate similarity
+    if ! (similarity.is_a?(Integer) and similarity>=0 and similarity<=100)
+      return result
+    end
+    # check if poster is there or not
+    background = dut.roi.color.new(:rectangle=>box, :rgb=>rgb, :similarity=>similarity)
+    if background.displayed?
+      result = true
+    else
+      result = false
+    end
+    return result
+  end
+
+end

data/lib/User_Lib/screen/stb/spectrum/spectrum_live_tv.rb

@@ -0,0 +1,259 @@
+require './lib/screen/stb/spectrum/spectrum_screen'
+# DO NOT ADD DSL REQUIRES HERE. Load them in methods that need them, otherwise syntax completion will be slow.
+
+# Defines Spectrum-specific methods on the LiveTv screen.
+
+class SpectrumLiveTv < SpectrumScreen
+
+  # Public: Navigate to Channel Banner from Live TV and check if Channel Banner is displayed.
+  #
+  # Returns Boolean true/false if Channel Banner is/is not displayed
+  def nav_to_chan_banner?
+    dut.press_key.SELECT(:sleep_time=>1.sec)
+    dut.roi.color.launch_channelbar.wait_until_displayed?(timeout=5000)
+  end
+
+  # Public: Check if Channel Banner is displayed.
+  # 
+  # Returns Boolean true/false if Channel Banner is/is not displayed
+  def chan_banner_displayed?
+    dut.roi.color.launch_channelbar.wait_until_displayed?(timeout=5000)
+  end
+  
+  # Public: Navigate to Info from Live TV and check if Channel Banner is displayed.
+  #
+  # Returns Boolean true/false if Channel Banner is/is not displayed
+  def nav_to_info?
+    dut.press_key.INFO(:sleep_time=>1.sec)
+    return false unless dut.roi.image.live_info.wait_until_displayed?(timeout=5000)
+  end
+
+  # Public: Check if Info is displayed.
+  #
+  # Returns Boolean true/false if Channel Banner is/is not displayed
+  def info_displayed?
+    dut.roi.image.live_info.wait_until_displayed?(timeout=5000)
+  end
+  
+  # Public: Sets channel number
+  #
+  # channel - integer of channel number (0-999)
+  #
+  # Examples
+  #
+  #   dut.screens.live_tv.set_channel?(23)
+  #   # => 'True'
+  #
+  # Returns true if channel is changed successfully
+  def set_channel?(channel)
+  	digit1 = (channel/100).floor
+  	channel = channel - (digit1 * 100)
+  	digit2 = (channel/10).floor
+  	digit3 = channel - (digit2 * 10)
+  	dut.press_key(digit1.to_s, :sleep_time=>1.sec)
+  	dut.press_key(digit2.to_s, :sleep_time=>1.sec)
+  	dut.press_key(digit3.to_s, :sleep_time=>1.sec)
+  end
+
+  # Public: Checks if Live TV is displayed.
+  #
+  # timeout - Integer total milliseconds to check before timing out  (default: 0.sec).
+  #
+  # Returns a Boolean true if displayed, otherwise false.
+  def displayed?(args={})
+    dut.roi.video.fullscreen_motion.displayed?(args)
+  end
+
+  # Public: Selects network of currently selected channel in miniguide
+  #
+  # Returns true if network is selected successfully, otherwise false
+  def select_current_miniguide_network?
+    counter = 0
+    while counter < 6 and not dut.roi.color.miniguide_channel_highlight.displayed?(:timeout => 3000, :verifies_for => 1000) do
+      dut.press_key.ARROW_LEFT(:sleep_time=>3.sec)
+      counter = counter + 1
+    end
+    return false if counter > 5
+    dut.press_key.SELECT(:sleep_time=>3.sec)
+  end
+
+  # Public: navigate to closed captioning option
+  #
+  # Returns nothing.
+  def caption_available_liveTV?
+     sleep(delay=20)
+     if dut.roi.text.livetv_caption_text.displayed?
+       val=dut.roi.text.livetv_caption_text.retrieve
+       logger.info("caption is displayed in live tv and caption displayed is" "#{val}")
+      end
+  end
+
+  # Public: navigate to accessibility option
+  #
+  # Returns nothing.
+  def caption_available_livetv?
+   
+   for i in 1..10
+     val=dut.roi.text.liveTV_caption.retrieve
+     until val
+      if val!=''
+       return true
+       break
+      end
+     end
+   end
+   
+     
+    
+  end
+
+  # Public: check if live tv is displayed
+  #
+  # Returns boolean
+  def check_livetv_display?
+    begin
+  for i in 1..5
+  	if dut.roi.video.fullscreen_motion.displayed?(:timeout => 7000)
+  	break
+  	else
+  	dut.press_key('guide', :sleep_time=>3.sec)
+  	start_channel = 1 + rand(100)
+  	dut.screens.live_tv.set_channel?(channel=start_channel)
+  	sleep(3.sec)
+  	dut.press_key('select', :sleep_time=>3.sec)
+  	end 
+  end   
+  ##Handles Exception##
+  rescue=>exception
+  loginfo "check_livtv_display?:: failed"
+  loginfo exception.message
+  loginfo exception.backtrace
+  return false
+  end
+  return true
+  end
+
+  # Public: For stopping the video play
+  #
+  #search count is the nuber of assets to search for integer
+  #
+  # Returns boolean value
+  def exittolivetv
+  ################
+  ###DEFINE flag##
+  ################
+  begin
+  #dut.press_key('stop', :sleep_time=>5.sec) 
+  2.times{dut.press_key.EXIT}
+  sleep(5.sec)
+  #####################
+  ##Handles Exception##
+  #####################
+  rescue=>exception
+  loginfo "exittolivetv :: failed"
+  loginfo exception.message
+  loginfo exception.backtrace
+  return false
+  end
+  end
+
+  # Public: For identifying unpurchased assets
+  #
+  #search count is the nuber of assets to search for integer
+  #
+  # Returns boolean value
+  def exittolivetvteardown
+  ################
+  ###DEFINE flag##
+  ################
+  begin
+  for i in 1..5
+  	if dut.roi.video.fullscreen_motion.displayed?
+  		logger.info("Test Successful performing teardown")
+   		break
+  	else
+  		dut.press_key.GUIDE
+  		sleep(3.sec)
+  		start_channel = 1 + rand(100)
+  		dut.screens.live_tv.set_channel?(start_channel)
+  		sleep(3.sec)
+  		dut.press_key.SELECT
+  	end
+  end
+  #####################
+  ##Handles Exception##
+  #####################
+  rescue=>exception
+  loginfo "exittolivetvteardown :: failed"
+  loginfo exception.message
+  loginfo exception.backtrace
+  return false
+  end
+  logger.info("Test Successful performing teardown")
+   
+  end
+
+  # Public: Check if videoplay is detected end poweroff if yes
+  #
+  # Returns Boolean true/false if My DVR is/is not displayed
+  def poweroff?
+  begin
+  for i in 1..2
+  if dut.roi.video.fullscreen_motion.displayed?
+  	logger.info("Video Detected, Turning off")
+  	dut.press_key.POWER
+  	sleep(5.sec)
+  	return true
+  else
+  	dut.screens.live_tv.exittolivetvteardown
+  end
+  end
+   
+  ##Handles Exception##
+  rescue=>exception
+  loginfo "purchase_available_asset(:: failed"
+  loginfo exception.message
+  loginfo exception.backtrace
+  return false
+  end
+  end
+
+ # Public: Turns the STB off and then powers on the STB
+#
+# Returns boolean value
+#
+#
+#Author: Shankar Tharakeswaran
+def poweroff_on?
+################
+###DEFINE flag##
+################
+begin
+dut.press_key('power', :sleep_time=>5.sec)
+vplay=false
+for i in 1..3
+if not dut.roi.video.fullscreen_motion.displayed?
+ dut.press_key('power', :sleep_time=>5.sec)
+ if dut.roi.video.fullscreen_motion.displayed?
+ vplay=true
+ break
+ end
+end 
+end 
+
+if not vplay==true
+return false 
+end
+
+#####################
+##Handles Exception##
+#####################
+rescue=>exception
+loginfo "poweroff_on?:: failed"
+loginfo exception.message
+loginfo exception.backtrace
+return false
+end
+end
+ 
+end