framework_gem 0.1.0

data/lib/lib/logger/tmc_logger.rb

@@ -0,0 +1,30 @@
+require 'logger'
+require './lib/logger/multi_io'
+
+# The TmcLogger class manages logging for TMC test scripts
+class TmcLogger
+  attr_reader(:logger)
+
+  DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%6N%:z'
+
+  # Public: Initializes a TMC logger.
+  #
+  # Returns nothing.
+  def initialize(log_path, log_level)
+    @log_level = log_level || 'debug'  # needed for syntax eval
+    if log_path.nil?
+      @logger = Logger.new(STDERR)
+      @logger = Logger.new(STDOUT)
+    else
+      file = File.open(log_path, File::WRONLY | File::APPEND | File::CREAT)
+      file.sync = true    # flush log file buffer immediately
+      STDOUT.sync = true  # flush STDOUT buffer immediately
+      @logger = Logger.new(MultiIO.new(file, STDOUT))
+    end
+    @logger.formatter = proc do |severity, datetime, progname, msg|
+      "[#{datetime.strftime(DATETIME_FORMAT)}] [#{severity}] #{msg}\n"
+    end
+    @logger.level = Logger.const_get(@log_level.upcase.to_sym)
+  end
+
+end

data/lib/lib/mixins/assignable.rb

@@ -0,0 +1,19 @@
+# This module creates an attr reader for each key in the provided hash and assigns the corresponding value, so that
+# items may be accessed like this: Fruits.new.BANANA
+
+module Assignable
+
+  private
+
+  # Internal: Assigns the given key-value pairs as instance variables
+  def assign(hash={})
+    @enum ||= {}
+    @enum.update(hash)
+    hash.each do |k,v|
+      self.class.send(:attr_reader, k)
+      self.instance_variable_set("@#{k}", v)
+    end
+  end
+
+end
+

data/lib/lib/mixins/can_have_special_methods.rb

@@ -0,0 +1,50 @@
+# We make use of public_methods for syntax completion, but sometimes we want just a subset of the public methods on an
+# instance of some class. For example, only some of the methods on an Roi instance actually perform Roi evaluations, so
+# we want to flag those. This mixin allows us to do that by calling special_method(:meth) after a method definition.
+
+module CanHaveSpecialMethods
+
+  # Public: Includes this module.
+  #
+  # base - Class or Module to include this Module.
+  #
+  # Returns nothing.
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    @@special_methods = {}
+
+    # Public: Adds the given symbol to the list of special methods.
+    #
+    # sym - Symbol to add.
+    #
+    # Returns nothing.
+    def special_method(sym)
+      @@special_methods[self] ||= []
+      @@special_methods[self] << sym
+    end
+
+    # Public: Gets the list of special methods.
+    #
+    # Returns an Array of Symbol special method names.
+    def special_methods
+      for_class = @@special_methods.fetch(self, [])
+      for_super = self.superclass.respond_to?(:special_methods) ? self.superclass.special_methods : []
+      (for_super + for_class).uniq
+    end
+
+  end
+
+  private
+
+  # Internal: Gets special methods for this class.
+  #
+  # Returns an Array of Symbol special method names.
+  def special_methods
+    self.class.special_methods
+  end
+
+end

data/lib/lib/mixins/enumish.rb

@@ -0,0 +1,16 @@
+# The Enum module provides a more traditional-looking enum object. Note that the common Ruby idiom for enums is to
+# declare constants in a module, which can be accessed like this: Fruits::BANANA
+
+module Enumish
+
+  def enum(hash={})
+    @enum ||= {}
+    @enum.update(hash)
+    hash.each do |k,v|
+      self.class.send(:attr_reader, k)
+      self.instance_variable_set("@#{k}".to_sym, v)
+    end
+  end
+
+end
+

data/lib/lib/new_platform.rb

@@ -0,0 +1,302 @@
+resolutionsToMake = ["720","1080"]
+roiTypes = ["black","color","image","text","video"]
+screenTypes = ["dvr","guide","library","log_in","live_tv","main_menu","mini_guide","movies","on_demand","parental_controls","product_page","search","settings","tv_shows","video_store"]
+
+def writeFile(path,content)
+  dirAndFile = path.split("/")
+  tempdir = dirAndFile[0]
+  i = 0
+  while (i+=1) < dirAndFile.length
+    Dir.mkdir(tempdir) unless Dir.exist?(tempdir)
+    tempdir += "/#{dirAndFile[i]}"
+  end
+  File.open(path, "w") {|f| f.write(content)}
+end
+
+
+if ARGV.length < 1
+  puts "please give platform name, if the platform already exists, this will overwrite it"
+  exit
+end
+puts "making #{ARGV[0]} platform"
+
+lowerPlat = ARGV[0].strip().gsub(" ", "_").downcase()
+upperPlat = ""
+lowerPlat.split("_").each{|wordToCap|
+    upperPlat += wordToCap.capitalize()
+}
+
+
+
+#Resolution specific files
+resolutionsToMake.each do |res|
+writeFile("platform/#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}.rb","
+  require './lib/platform/#{lowerPlat}/#{lowerPlat}'
+  require './lib/rois/#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_rois'
+  
+  # Adds to or modifies the #{upperPlat} platform with #{res}p-specific functionality.
+  
+  class #{upperPlat}#{res} < #{upperPlat}
+  
+    # Public: Initializes an #{upperPlat} #{res}p device.
+    def initialize(*args)
+      super(*args)
+      @roi = #{upperPlat}#{res}Rois.new(self)
+    end
+  
+  end
+")
+requireStr = ""
+defineStr = ""
+roiTypes.each do |roiT|
+writeFile("rois/#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_#{roiT}_rois.rb","
+require './lib/rois/#{lowerPlat}/#{lowerPlat}_#{roiT}_rois'
+
+# Defines #{upperPlat} #{res}p-specific #{roiT.capitalize()} ROIs.
+
+class #{upperPlat}#{res}#{roiT.capitalize()}Rois < #{upperPlat}#{roiT.capitalize()}Rois
+
+end
+")
+requireStr += "  require './lib/rois/#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_#{roiT}_rois'\n"
+defineStr += "      @#{roiT} = #{upperPlat}#{res}#{roiT.capitalize()}Rois.new(@dut)\n"
+end
+writeFile("rois/#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_rois.rb","
+  require './lib/rois/#{lowerPlat}/#{lowerPlat}_rois'
+#{requireStr}
+  
+  # Adds to or modifies the #{upperPlat} ROIs with #{upperPlat} #{res}p-specific ROIs.
+  
+  class #{upperPlat}#{res}Rois < #{upperPlat}Rois
+  
+    # Public: Initializes #{upperPlat}#{res}Rois. NOT FOR USE IN TESTS.
+    def initialize(*args)
+      super(*args)
+      # Add Rois common to all #{upperPlat}#{res} here
+#{defineStr}
+    end
+  
+  end
+")
+end
+
+#roi files
+requireStr = ""
+defineStr = ""
+roiTypes.each do |roiT|
+writeFile("rois/#{lowerPlat}/#{lowerPlat}_#{roiT}_rois.rb","
+  require './lib/rois/#{roiT}_rois'
+
+  # Defines #{upperPlat}-specific #{roiT.capitalize()} ROIs.
+  
+  class #{upperPlat}#{roiT.capitalize()}Rois < #{roiT.capitalize()}Rois
+  
+  end
+    
+")
+requireStr += "  require './lib/rois/#{lowerPlat}/#{lowerPlat}_#{roiT}_rois'\n"
+defineStr += "      @#{roiT} = #{upperPlat}#{roiT.capitalize()}Rois.new(@dut)\n"
+end
+
+writeFile("rois/#{lowerPlat}/#{lowerPlat}_rois.rb","
+  require './lib/rois/rois'
+#{requireStr}
+  
+  # Adds to or modifies the base ROIs with #{upperPlat}-specific ROIs.
+  
+  class #{upperPlat}Rois < Rois
+  
+    # Public: Initializes #{upperPlat}Rois. NOT FOR USE IN TESTS.
+    def initialize(*args)
+      super(*args)
+      # Add Rois common to all #{upperPlat}s here
+#{defineStr}
+    end
+  
+  end
+")
+
+#screen files
+writeFile("screen/#{lowerPlat}/#{lowerPlat}_screen.rb","
+  require './lib/screen/screen'
+
+  # Defines #{upperPlat}-specific implementation for a screen
+  
+  class #{upperPlat}Screen < Screen
+  
+    # Public: Navigates to any #{upperPlat} screen from any other #{upperPlat} screen.
+    #
+    # sleep_time - Integer total milliseconds to sleep after performing the navigation (default: 0).
+    #
+    # Returns nothing.
+    def navigate(args={})
+      # TODO: Implement correct sequence
+      dut.press_key.GUIDE(:sleep_time => 5.sec)  # navigate to guide
+      dut.press_key.EXIT(:sleep_time => 1.sec)   # exit to live tv
+      dut.press_key.EXIT(:sleep_time => 3.sec)   # close live tv banner
+      unless respond_to?(:navigate_from_live_tv)
+        raise \"Navigation from Live TV is not defined! \#{self.class.name}.navigate_from_live_tv must be implemented.\"
+      end
+      navigate_from_live_tv
+    end
+  
+  end
+")
+
+requireStr = ""
+defineStr = ""
+screenTypes.each do |screenT|
+writeFile("screen/#{lowerPlat}/#{lowerPlat}_#{screenT}.rb", "
+  require './lib/screen/#{lowerPlat}/#{lowerPlat}_screen'
+
+  # Defines #{upperPlat}-specific methods on the #{screenT.capitalize()} screen.
+  
+  class #{upperPlat}#{screenT.capitalize()} < #{upperPlat}Screen
+  
+    # Public: Navigates to #{screenT.capitalize()} from Live TV.
+    # 
+    # Returns nothing.
+    def navigate_from_live_tv
+      # TODO: implement 
+      #raise 'NOT IMPLEMENTED'
+    end
+    
+    # Public: Check if #{screenT.capitalize()} is displayed.
+    #
+    # timeout - Integer total milliseconds to check before timing out (default: 10.sec).
+    #
+    # Returns Boolean true if #{screenT.capitalize()} is displayed, otherwise false.
+    def displayed?(args={})
+      # TODO: implement ROI below
+      #dut.roi.text.#{screenT}.displayed?(args)
+    end
+  
+  end
+")
+requireStr += "  require './lib/screen/#{lowerPlat}/#{lowerPlat}_#{screenT}'\n"
+defineStr += "      @#{screenT} = #{upperPlat}#{screenT.capitalize()}.new(@dut)\n"
+end
+
+writeFile("screens/#{lowerPlat}/#{lowerPlat}_screens.rb" , "
+  require './lib/screens/screens'
+#{requireStr}
+  
+  # Adds to or modifies the screens with #{upperPlat}-specific screens.
+  
+  class #{upperPlat}Screens < Screens
+  
+    #WARNING the bellow snippet is an example and will need to be updated
+    #TODO
+    attr_reader(:dvr, :library, :movies, :tv_shows, :video_store, :login)
+  
+    # Public: Initializes #{upperPlat}Screens. NOT FOR USE IN TESTS.
+    def initialize(*args)
+      super(*args)
+#{defineStr}
+    end
+  
+  end    
+")
+
+#key file
+writeFile("keys/#{lowerPlat}/#{lowerPlat}_keys.rb", "
+  require './lib/keys/base_keys'
+
+  # The #{upperPlat}Keys class extends Keys, adding keys common to all #{upperPlat}s.
+  
+  class #{upperPlat}Keys < BaseKeys
+  
+    #TODO: the following is an example code snippit, please update it before use
+    # Public: Initializes #{upperPlat} 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  
+")
+
+#platform file
+writeFile("platform/#{lowerPlat}/#{lowerPlat}.rb", "
+  require './lib/platform/platform'
+  require './lib/screens/#{lowerPlat}/#{lowerPlat}_screens'
+  require './lib/rois/#{lowerPlat}/#{lowerPlat}_rois'
+  require './lib/keys/#{lowerPlat}/#{lowerPlat}_keys'
+  
+  # Adds to or modifies the platform with #{upperPlat}-specific functionality.
+  
+  class #{upperPlat} < Platform
+  
+    # Public: Initializes a #{upperPlat} device.
+    def initialize(*args)
+      super(*args)
+      @screens = #{upperPlat}Screens.new(self)
+      @roi = #{upperPlat}Rois.new(self)
+      set_keys(#{upperPlat}Keys.new)
+    end
+  
+    # Public: Initializes the #{upperPlat} and brings it to the Live TV screen.
+    #
+    # Returns a Boolean true if the device was initialized, otherwise false.
+    def init?
+      super do
+        logger.warn('INIT NOT IMPLEMENTED')
+        true
+        #screens.main_menu.navigate_to_samsungApps
+        #2.times { press_key.ARROW_RIGHT(:sleep_time => 2.sec) }
+        #press_key.ARROW_DOWN(:sleep_time => 2.sec)
+        #press_key.SELECT
+        #roi.text.livetv_text.wait_until_displayed?(25.sec)  # returns this
+      end
+    end
+  
+  end
+  
+")
+
+puts "done making #{ARGV[0]} platform"

data/lib/lib/new_sub_platform.rb

@@ -0,0 +1,90 @@
+resolutionsToMake = ["720","1080"]
+roiTypes = ["black","color","image","text","video"]
+screenTypes = ["dvr","guide","library","log_in","live_tv","main_menu","mini_guide","movies","on_demand","parental_controls","product_page","search","settings","tv_shows","video_store"]
+
+def writeFile(path,content)
+  dirAndFile = path.split("/")
+  tempdir = dirAndFile[0]
+  i = 0
+  while (i+=1) < dirAndFile.length
+    Dir.mkdir(tempdir) unless Dir.exist?(tempdir)
+    tempdir += "/#{dirAndFile[i]}"
+  end
+  File.open(path, "w") {|f| f.write(content)}
+end
+
+
+if ARGV.length < 2
+  puts "please give the platform name and subplatform name, if the sub platform already exists, this will overwrite it"
+  exit
+end
+puts "making #{ARGV[2]}/#{ARGV[0]} #{ARGV[1]} sub platform"
+
+lowerPlat = ARGV[0].strip().gsub(" ", "_").downcase()
+upperPlat = ""
+lowerPlat.split("_").each{|wordToCap|
+    upperPlat += wordToCap.capitalize()
+}
+
+lowerSubPlat = ARGV[1].strip().gsub(" ", "_").downcase()
+upperSubPlat = ""
+lowerSubPlat.split("_").each{|wordToCap|
+    upperSubPlat += wordToCap.capitalize()
+}
+
+modifiedPath = ""
+modifiedPath = "#{ARGV[2]}/" if ARGV.length > 2
+
+#Resolution specific files
+resolutionsToMake.each do |res|
+writeFile("platform/#{modifiedPath}#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_#{lowerSubPlat}/#{lowerPlat}_#{res}_#{lowerSubPlat}.rb","
+  require './lib/platform/#{modifiedPath}#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}'
+  require './lib/rois/#{modifiedPath}#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_#{lowerSubPlat}/#{lowerPlat}_#{res}_#{lowerSubPlat}_rois'
+  
+  # Adds to or modifies the #{upperPlat} #{res} #{lowerSubPlat} platform with #{res}p-specific functionality.
+  
+  class #{upperPlat}#{res}#{upperSubPlat} < #{upperPlat}#{res}
+  
+    # Public: Initializes an #{upperPlat} #{res}p #{upperSubPlat} device.
+    def initialize(*args)
+      super(*args)
+      @roi = #{upperPlat}#{res}#{upperSubPlat}Rois.new(self)
+    end
+  
+  end
+")
+requireStr = ""
+defineStr = ""
+roiTypes.each do |roiT|
+writeFile("rois/#{modifiedPath}#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_#{lowerSubPlat}/#{lowerPlat}_#{res}_#{lowerSubPlat}_#{roiT}_rois.rb","
+require './lib/rois/#{modifiedPath}#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_#{roiT}_rois'
+
+# Defines #{upperPlat} #{res}p-specific #{upperSubPlat} #{roiT.capitalize()} ROIs.
+
+class #{upperPlat}#{res}#{upperSubPlat}#{roiT.capitalize()}Rois < #{upperPlat}#{res}#{roiT.capitalize()}Rois
+
+end
+")
+requireStr += "  require './lib/rois/#{modifiedPath}#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_#{lowerSubPlat}/#{lowerPlat}_#{res}_#{lowerSubPlat}_#{roiT}_rois'\n"
+defineStr += "      @#{roiT} = #{upperPlat}#{res}#{upperSubPlat}#{roiT.capitalize()}Rois.new(@dut)\n"
+end
+writeFile("rois/#{modifiedPath}#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_#{lowerSubPlat}/#{lowerPlat}_#{res}_#{lowerSubPlat}_rois.rb","
+  require './lib/rois/#{modifiedPath}#{lowerPlat}/#{lowerPlat}_#{res}/#{lowerPlat}_#{res}_rois'
+#{requireStr}
+  
+  # Adds to or modifies the #{upperPlat} ROIs with #{upperPlat} #{res}p #{upperSubPlat} specific ROIs.
+  
+  class #{upperPlat}#{res}#{upperSubPlat}Rois < #{upperPlat}#{res}Rois
+  
+    # Public: Initializes #{upperPlat}#{res}Rois. NOT FOR USE IN TESTS.
+    def initialize(*args)
+      super(*args)
+      # Add Rois common to all #{upperPlat}#{res}#{upperSubPlat} here
+#{defineStr}
+    end
+  
+  end
+")
+end
+
+puts "done making #{modifiedPath}#{upperPlat} #{upperSubPlat} sub platform"