framework_gem 0.1.0

data/lib/lib/keys/sara/sara_keys.rb

@@ -0,0 +1,60 @@
+
+  require './lib/keys/base_keys'
+
+  # The SaraKeys class extends Keys, adding keys common to all Saras.
+  
+  class SaraKeys < BaseKeys
+  
+    #TODO: the following is an example code snippit, please update it before use
+    # Public: Initializes Sara keys.
+    def initialize
+      assign(
+          # Renamed digits because an attribute name may not begin with a digit.
+          :NUM_0 => '0',
+          :NUM_1 => '1',
+          :NUM_2 => '2',
+          :NUM_3 => '3',
+          :NUM_4 => '4',
+          :NUM_5 => '5',
+          :NUM_6 => '6',
+          :NUM_7 => '7',
+          :NUM_8 => '8',
+          :NUM_9 => '9',
+          # Renamed arrows so they are sorted together. This is consistent with the naming for "volume" and "channel".
+          :ARROW_UP => 'up_arrow',
+          :ARROW_DOWN => 'down_arrow',
+          :ARROW_LEFT => 'left_arrow',
+          :ARROW_RIGHT => 'right_arrow',
+          :SELECT => 'select',
+          :POWER => 'power',
+          :VOLUME_UP => 'volume_up',
+          :VOLUME_DOWN => 'volume_down',
+          :CHANNEL_UP => 'channel_up',
+          :CHANNEL_DOWN => 'channel_down',
+          :MUTE => 'mute',
+          :FAV => 'fav',
+          :GUIDE => 'guide',
+          :INFO => 'info',
+          :LAST => 'last',
+          :MENU => 'menu',
+          :EXIT => 'exit',
+          :FAST_FORWARD => 'fastforward',
+          :REWIND => 'rewind',
+          #:SETTINGS => 'settings', # on old remote, could be 'SET UP'? new remote, 'OPTIONS'?
+          :DVR => 'list',
+          :PLAY => 'play',
+          :PAUSE => 'pause',
+          # Renamed skip-back for readability.
+          :SKIP_BACK => 'skipback',
+          :RECORD => 'record',
+          :PAGE_DOWN => 'page_down',
+          :PAGE_UP => 'page_up',
+          :ON_DEMAND => 'mod',  # new remote doesn't have this
+          :A => 'a',  # new remote doesn't have this
+          :B => 'b',  # new remote doesn't have this
+          :C => 'c',  # new remote doesn't have this
+          :D => 'd'  # new remote doesn't have this
+      )
+    end
+  
+  end  

data/lib/lib/keys/stb/iguide/iguide_keys.rb

@@ -0,0 +1,56 @@
+require './lib/keys/base_keys'
+
+# The IguideKeys class extends Keys, adding keys common to all Iguides.
+
+class IguideKeys < BaseKeys
+
+  # Public: Initializes iGuide keys.
+  def initialize
+    assign(
+        # TODO: THIS IS JUST A COPY OF SPECTRUM KEYS. THE IGUIDE KEYS MAY BE DIFFERENT. SOMEONE SHOULD FIX THIS.
+        # Renamed digits because an attribute name may not begin with a digit.
+        :NUM_0 => '0',
+        :NUM_1 => '1',
+        :NUM_2 => '2',
+        :NUM_3 => '3',
+        :NUM_4 => '4',
+        :NUM_5 => '5',
+        :NUM_6 => '6',
+        :NUM_7 => '7',
+        :NUM_8 => '8',
+        :NUM_9 => '9',
+        # Renamed arrows so they are sorted together. This is consistent with the naming for "volume" and "channel".
+        :ARROW_UP => 'up_arrow',
+        :ARROW_DOWN => 'down_arrow',
+        :ARROW_LEFT => 'left_arrow',
+        :ARROW_RIGHT => 'right_arrow',
+        :SELECT => 'select',
+        :POWER => 'power',
+        :VOLUME_UP => 'volume_up',
+        :VOLUME_DOWN => 'volume_down',
+        :CHANNEL_UP => 'channel_up',
+        :CHANNEL_DOWN => 'channel_down',
+        :MUTE => 'mute',
+        :GUIDE => 'guide',
+        :INFO => 'info',
+        :LAST => 'last',
+        :MENU => 'menu',
+        :EXIT => 'exit',
+        #:SETTINGS => 'settings', # on old remote, could be 'SET UP'? new remote, 'OPTIONS'?
+        :DVR => 'list',
+        :PLAY => 'play',
+        # Renamed skip-back for readability.
+        :SKIP_BACK => 'skipback',
+        :RECORD => 'record',
+        :PAGE_DOWN => 'page_down',
+        :PAGE_UP => 'page_up',
+        :ON_DEMAND => 'mod',  # new remote doesn't have this
+        :A => 'a',  # new remote doesn't have this
+        :B => 'b',  # new remote doesn't have this
+        :C => 'c',  # new remote doesn't have this
+        :D => 'd'  # new remote doesn't have this
+    )
+  end
+
+end
+

data/lib/lib/keys/stb/odn/odn_keys.rb

@@ -0,0 +1,63 @@
+require './lib/keys/base_keys'
+
+# The OdnKeys class extends Keys, adding keys common to all Odns.
+
+class OdnKeys < BaseKeys
+
+  # Public: Initializes ODN keys.
+  def initialize
+    assign(
+      # Renamed digits because an attribute name may not begin with a digit.
+      :NUM_0 => '0',
+      :NUM_1 => '1',
+      :NUM_2 => '2',
+      :NUM_3 => '3',
+      :NUM_4 => '4',
+      :NUM_5 => '5',
+      :NUM_6 => '6',
+      :NUM_7 => '7',
+      :NUM_8 => '8',
+      :NUM_9 => '9',
+      :HASH => 'hash',
+      :STAR => 'star',
+      :ARROW_UP => 'up_arrow',
+      :ARROW_DOWN => 'down_arrow',
+      :ARROW_LEFT => 'left_arrow',
+      :ARROW_RIGHT => 'right_arrow',
+      :DAY_UP => 'day_up',
+      :DAY_DOWN => 'day_down',
+      :SELECT => 'select',
+      :POWER => 'power',
+      :VOLUME_UP => 'volume_up',
+      :VOLUME_DOWN => 'volume_down',
+      :CHANNEL_UP => 'channel_up',
+      :CHANNEL_DOWN => 'channel_down',
+      :MUTE => 'mute',
+      :FAV => 'fav',
+      :GUIDE => 'guide',
+      :INFO => 'info',
+      :LAST => 'last',
+      :MENU => 'menu',
+      :EXIT => 'exit',
+      :FAST_FORWARD => 'fastforward',
+      :REPLAY => 'replay',
+      :REWIND => 'rewind',
+      :SETTINGS => 'settings',
+      :DVR => 'list',
+      :LIVE => 'live',
+      :PLAY => 'play',
+      :PAUSE => 'pause',
+      :STOP => 'stop',
+      :SKIP_BACK => 'skipback',
+      :RECORD => 'record',
+      :PAGE_DOWN => 'page_down',
+      :PAGE_UP => 'page_up',
+      :ON_DEMAND => 'mod',
+      :A => 'a',
+      :B => 'b',
+      :C => 'c',
+      :D => 'd'
+    )
+  end
+
+end

data/lib/lib/keys/stb/spectrum/spectrum_keys.rb

@@ -0,0 +1,59 @@
+require './lib/keys/base_keys'
+
+# The SpectrumKeys class extends Keys, adding keys common to all Spectrums.
+
+class SpectrumKeys < BaseKeys
+
+  # Public: Initializes Spectrum keys.
+  def initialize
+    assign(
+        # Renamed digits because an attribute name may not begin with a digit.
+        :NUM_0 => '0',
+        :NUM_1 => '1',
+        :NUM_2 => '2',
+        :NUM_3 => '3',
+        :NUM_4 => '4',
+        :NUM_5 => '5',
+        :NUM_6 => '6',
+        :NUM_7 => '7',
+        :NUM_8 => '8',
+        :NUM_9 => '9',
+        # Renamed arrows so they are sorted together. This is consistent with the naming for "volume" and "channel".
+        :ARROW_UP => 'up_arrow',
+        :ARROW_DOWN => 'down_arrow',
+        :ARROW_LEFT => 'left_arrow',
+        :ARROW_RIGHT => 'right_arrow',
+        :SELECT => 'select',
+        :POWER => 'power',
+        :VOLUME_UP => 'volume_up',
+        :VOLUME_DOWN => 'volume_down',
+        :CHANNEL_UP => 'channel_up',
+        :CHANNEL_DOWN => 'channel_down',
+        :MUTE => 'mute',
+        :FAV => 'fav',
+        :GUIDE => 'guide',
+        :INFO => 'info',
+        :LAST => 'last',
+        :MENU => 'menu',
+        :EXIT => 'exit',
+        :FAST_FORWARD => 'fastforward',
+        :REWIND => 'rewind',
+        #:SETTINGS => 'settings', # on old remote, could be 'SET UP'? new remote, 'OPTIONS'?
+        :DVR => 'list',
+        :PLAY => 'play',
+        :PAUSE => 'pause',
+        # Renamed skip-back for readability.
+        :SKIP_BACK => 'skipback',
+        :RECORD => 'record',
+        :PAGE_DOWN => 'page_down',
+        :PAGE_UP => 'page_up',
+        :ON_DEMAND => 'mod',  # new remote doesn't have this
+        :A => 'a',  # new remote doesn't have this
+        :B => 'b',  # new remote doesn't have this
+        :C => 'c',  # new remote doesn't have this
+        :D => 'd'  # new remote doesn't have this
+    )
+  end
+
+end
+

data/lib/lib/keys/stb/stb_keys.rb

@@ -0,0 +1,13 @@
+require './lib/mixins/enumish'
+
+# The StbKeys class enumerates keys common to all Stbs.
+
+class StbKeys
+  include Enumish
+
+  def initialize
+    enum
+  end
+
+end
+

data/lib/lib/keys/tivo/tivo_keys.rb

@@ -0,0 +1,26 @@
+require './lib/keys/base_keys'
+
+# The TivoKeys class extends Keys, adding keys common to all Tivos.
+
+class TivoKeys < BaseKeys
+
+  # Public: Initializes Tivo keys.
+  def initialize
+    assign(
+        # Renamed arrows so they are sorted together. This is consistent with the naming for "volume" and "channel".
+        :ARROW_UP => 'up_arrow',
+        :ARROW_DOWN => 'down_arrow',
+        :ARROW_LEFT => 'left_arrow',
+        :ARROW_RIGHT => 'right_arrow',
+        :SELECT => 'select',
+        :SELECT_LONG => 'select_long',
+        :MENU => 'menu',
+        :MENU_LONG => 'menu_long',
+        :MENU_DOUBLE => 'menu_double',
+        :PLAY => 'play',
+        :PAUSE => 'play'
+    )
+  end
+
+end
+

data/lib/lib/logger/multi_io.rb

@@ -0,0 +1,14 @@
+# Ripped straight from SO. This allows us to log to multiple targets simultaneously.
+class MultiIO
+  def initialize(*targets)
+    @targets = targets
+  end
+
+  def write(*args)
+    @targets.each {|t| t.write(*args)}
+  end
+
+  def close
+    @targets.each(&:close)
+  end
+end

data/lib/lib/logger/tmc_dut_logger.rb

@@ -0,0 +1,251 @@
+# The TmcDeviceLogger class manages logging for TMC devices
+class TmcDutLogger
+
+  # Public: Initializes a DUT logger.
+  #
+  # Returns nothing.
+  def initialize(dut, logger, test_case)
+    @dut = dut
+    @logger = logger
+    @test_case = test_case
+  end
+
+  # Public: Logs a debug message.
+  #
+  # msg            - String debug message to log.
+  # screenshot     - Boolean to capture and display a screenshot (default: false).
+  # use_last_image - Boolean to display the last captured image (default: false).
+  # screen_image   - String path to image to display (default: nil).
+  # image_suffix   - String suffix to use for new image capture (default: '')
+  # attach         - Boolean to attach the displayed image to ITMS/SWORD (default: false)
+  # attach_comment - String comment to associate with attached image, if attach is true (default: 'Screenshot from TMC')
+  # return_title   - String Return Title to associate with attached image, if attach is true (default: nil)
+  #
+  # Returns nothing.
+  def debug(msg, args={})
+    do_log(:debug, msg, args)
+  end
+
+  # Public: Logs an info message.
+  #
+  # msg            - String info message to log.
+  # screenshot     - Boolean to capture and display a screenshot (default: false).
+  # use_last_image - Boolean to display the last captured image (default: false).
+  # screen_image   - String path to image to display (default: nil).
+  # image_suffix   - String suffix to use for new image capture (default: '')
+  # attach         - Boolean to attach the displayed image to ITMS/SWORD (default: false)
+  # attach_comment - String comment to associate with attached image, if attach is true (default: 'Screenshot from TMC')
+  # return_title   - String Return Title to associate with attached image, if attach is true (default: nil)
+  #
+  # Returns nothing.
+  def info(msg, args={})
+    do_log(:info, msg, args)
+  end
+
+  # Public: Logs a warning message.
+  #
+  # msg            - String warning message to log.
+  # screenshot     - Boolean to capture and display a screenshot (default: false).
+  # use_last_image - Boolean to display the last captured image (default: false).
+  # screen_image   - String path to image to display (default: nil).
+  # image_suffix   - String suffix to use for new image capture (default: '')
+  # attach         - Boolean to attach the displayed image to ITMS/SWORD (default: false)
+  # attach_comment - String comment to associate with attached image, if attach is true (default: 'Screenshot from TMC')
+  # return_title   - String Return Title to associate with attached image, if attach is true (default: nil)
+  #
+  # Returns nothing.
+  def warn(msg, args={})
+    do_log(:warn, msg, args)
+  end
+
+  # Public: Logs an error message.
+  #
+  # msg            - String error message to log.
+  # screenshot     - Boolean to capture and display a screenshot (default: true).
+  # use_last_image - Boolean to display the last captured image (default: false).
+  # screen_image   - String path to image to display (default: nil).
+  # image_suffix   - String suffix to use for new image capture (default: '')
+  # attach         - Boolean to attach the displayed image to ITMS/SWORD (default: false)
+  # attach_comment - String comment to associate with attached image, if attach is true (default: 'Screenshot from TMC')
+  # return_title   - String Return Title to associate with attached image, if attach is true (default: nil)
+  #
+  # Returns nothing.
+  def error(msg, args={})
+    args[:screenshot] = args.fetch(:screenshot, true)
+    if msg.is_a?(Exception)
+      # "hidden" functionality to log an exception
+      msg = "#{msg.message}\n\t#{msg.backtrace.join("\t\n")}"
+    end
+    do_log(:error, msg, args)
+  end
+
+  # Public: Logs an ROI.
+  #
+  # roi_object     - ROI object to log.
+  # message        - String custom ROI message to log (default: 'Region Of Interest').
+  # screenshot     - Boolean to capture and display a screenshot (default: true).
+  # use_last_image - Boolean to display the last captured image (default: false).
+  # screen_image   - String path to image to display (default: nil).
+  # attach         - Boolean to attach the displayed image to ITMS/SWORD (default: false).
+  # attach_comment - String comment to associate with attached image, if attach is true (default: 'Screenshot from TMC').
+  # return_title   - String Return Title to associate with attached image, if attach is true (default: nil).
+  # expected_text  - String expected text to log for Text ROIs (default: nil).
+  #                  If default, the expected text associated with the ROI object will be used.
+  # similarity     - Integer similarity to log for all ROI types (default: nil).
+  #                  If default, the threshold/level associated with the ROI object will be used.
+  #
+  # Returns nothing.
+  def roi(roi, args={})
+    msg = args.fetch(:message, 'Region Of Interest')
+    # Capture new screenshot unless explicitly set false
+    args[:screenshot] = args.fetch(:screenshot, true)
+    args[:image1_rect] = [roi.x, roi.y, roi.width, roi.height]
+    args[:image2] = roi.ref_img.empty? ? nil : roi.ref_img
+    args[:image2_rect] = [roi.x, roi.y, roi.width, roi.height]
+    if roi.is_a?(ImageRoi) && !roi.img_x.nil?
+      args[:image2_rect] = [roi.img_x, roi.img_y, roi.img_width, roi.img_height]
+    end
+    info = "#{roi.class.name}#{roi.name.nil? ? '' : ':' + roi.name}"
+    do_log(:info, msg, args.merge(tag: 'ROI', info: info))
+  end
+
+  # Public: Logs a key press.
+  #
+  # key            - String key to log.
+  # message        - String custom ROI message to log (default: 'Key Press').
+  # screenshot     - Boolean to capture and display a screenshot (default: false).
+  # use_last_image - Boolean to display the last captured image (default: false).
+  # screen_image   - String path to image to display (default: nil).
+  # attach         - Boolean to attach the displayed image to ITMS/SWORD (default: false).
+  # attach_comment - String comment to associate with attached image, if attach is true (default: 'Screenshot from TMC').
+  # return_title   - String Return Title to associate with attached image, if attach is true (default: nil).
+  #
+  # Returns nothing.
+  def keypress(key, args={})
+    key = [key] unless key.is_a?(Array)
+    msg = args.fetch(:message, 'Key Press')
+    do_log(:info, msg, args.merge(tag: 'KEYPRESS', info: key.join(','), screenshot: true))
+  end
+
+  # Public: Logs a duration message.
+  #
+  # ms             - Integer duration in milliseconds to log.
+  # message        - String custom duration message to log (default: 'Time: N ms').
+  # screenshot     - Boolean to capture and display a screenshot (default: false).
+  # use_last_image - Boolean to display the last captured image (default: false).
+  # screen_image   - String path to image to display (default: nil).
+  # attach         - Boolean to attach the displayed image to ITMS/SWORD (default: false).
+  # attach_comment - String comment to associate with attached image, if attach is true (default: 'Screenshot from TMC').
+  # return_title   - String Return Title to associate with attached image, if attach is true (default: nil).
+  #
+  # Returns nothing.
+  def duration(ms, args={})
+    msg = "#{args.fetch(:message, 'Duration')}: #{ms} ms"
+    do_log(:info, msg, args.merge(tag: 'DURATION', info: ms.to_s))
+  end
+
+  private
+
+  DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%6N%:z'
+
+  # Internal: Sets the specified tag to be used by default if no other tags are specified.
+  def set_tag(tag)
+    @default_tag = tag
+  end
+
+  # Internal: Unsets any default tag.
+  def unset_tag
+    @default_tag = nil
+  end
+
+  # Internal: Formats the given object for TMC logging and logs it with the specified level.
+  #
+  # level          - Symbol log level to use.
+  # obj            - Object to log.
+  # tag            - String tag to assign (default: nil).
+  # info           - String free-form info to include (default: nil).
+  # image1         - String path to image to use for image #1 (default: nil).
+  #                  Will be overridden by screenshot or last image, if specified.
+  # image1_rect    - Array of Integer x, y, width, and height values for image #1 (default: nil).
+  #                  Will be overridden if obj is an ImageRoi.
+  # image2         - String path to image to use for image #2 (default: nil).
+  #                  Will be overridden if obj is an Roi.
+  # image2_rect    - Array of Integer x, y, width, and height values for image #1 (default: nil).
+  #                  Will be overridden if obj is an Roi.
+  # screenshot     - Boolean to capture and display a screenshot (default: false).
+  # use_last_image - Boolean to display the last captured image (default: false).
+  # screen_image   - String path to image to display (default: nil).
+  # attach         - Boolean to attach the displayed image to ITMS/SWORD (default: false).
+  # attach_comment - String comment to associate with attached image, if attach is true
+  #                  (default: 'Screenshot from TMC').
+  # return_title   - String Return Title to associate with attached image, if attach is true (default: nil).
+  #
+  # Returns nothing.
+  def do_log(level, obj, args={})
+    # Log format: [DateTime] [LogLevel] [Tag] [Info] [Image1] [Image2] [Source] - Message
+    #
+    # DateTime - ISO 8601 formatted timestamp. Will always be present. Declared by Logger.format.
+    # LogLevel - Log severity: DEBUG, INFO, WARN, ERROR, FATAL. Will always be present. Declared by Logger.format.
+    # Tag      - Log tag, e.g. "ROI", "IR", "DURATION". If not present, will be replaced by `.'
+    # Info     - Free-form additional info field. If not present, will be replaced by `.'
+    #            If tag is "ROI", will be in format RoiType:RoiName, where :RoiName will not appear for dynamic ROIs.
+    #            If tag is "IR",  will be the name of the key pressed.
+    #            If tag is "DURATION", will be the duration in milliseconds.
+    # Image1   - Path to the screen image, typically. If not present, will be replaced by `.'
+    #            Format is ImagePath:X,Y,W,H where :X,Y,W,H will not be present unless log is for an ROI.
+    # Image2   - Path to the ROI reference image, typically. If not present, will be replaced by `.'
+    #            Format is same as above. If present, should always include the rectangle.
+    # Source   - A string like "logger.rb:13 in `roi'". Will always be present.
+    # Message  - The message. Will always be present (could be an empty string).
+    tag = args.fetch(:tag, @default_tag)
+    info = args[:info]
+    image1 = args[:image1]
+    image2 = args[:image2]
+    source = args[:source]
+    if source.nil?
+      trace = TestTrace.new(@test_case, caller, exclude_files: [File.basename(__FILE__)])
+      source = trace.path
+      source += ":#{trace.line_in_method}" unless trace.line_in_method.nil?
+    end
+    screenshot = args.fetch(:screenshot, false)
+    screen_image = args[:screen_image]
+    attach = args.fetch(:attach, false)
+    attach_comment = args.fetch(:attach_comment, 'Screenshot from TMC')
+    return_title = args[:return_title]
+    use_last_image = args.fetch(:use_last_image, false)
+    msg = obj
+    if obj.is_a?(Exception)
+      msg = obj.message
+    end
+    # Capture screen if requested
+    begin
+      if !screen_image.nil?
+        image1 = screen_image
+      elsif screenshot && !@dut.nil?
+        image1 = if use_last_image
+          @test_case.send(:get_dut, @dut).save_last_screen_captured
+        else
+          @test_case.send(:get_dut, @dut).capture_screen
+        end
+      end
+      if attach && !image1.nil?
+        sword_attach_screenshot(attach_comment, return_title, image1)
+      end
+    rescue Exception => e  # signals handled by `@test_case.trap_signals'
+      @logger.logger.error(".... [#{caller[0].split(/[\\\/]/).last}] - #{e.message}\n\t#{e.backtrace.join("\n\t")}")
+    end
+    # Assign rectangles
+    if !image1.nil? && !args[:image1_rect].nil?
+      image1 += ":#{args[:image1_rect].join(',')}"
+    end
+    if !image2.nil? && !args[:image2_rect].nil?
+      image2 += ":#{args[:image2_rect].join(',')}"
+    end
+    tag = tag.nil? ? '.' + (('' if info.nil?) || ' ') : "[#{tag}] "
+    info = info.nil? ? '.' + (('' if image1.nil?) || ' ') : "[#{info}] "
+    image1 = image1.nil? ? '.' + (('' if image2.nil?) || ' ') : "[#{image1}] "
+    image2 = image2.nil? ? '.' : "[#{image2}]"
+    @logger.logger.send(level, "#{tag}#{info}#{image1}#{image2} [#{source}] - #{msg}")
+  end
+
+end