testability-driver 1.1.1 → 1.2.1

data/lib/tdriver/tdriver.rb

@@ -25,130 +25,174 @@
 #
 # Please see class documentation for more info
 
-# initializing TDriver
+# initializing tdriver
 $TDRIVER_INITIALIZED = false
 
-# unicode support
-$KCODE = 'u'
+# unicode support for 1.8.7
+$KCODE = 'u' if RUBY_VERSION < "1.9"
 
 # prevent Object#id Warnings
 Object.send( :undef_method, :id ) if Object.respond_to?( :id )
 
-# TODO: document me
-def require_relative( file )
-
-  # require with full expanded path
-  require File.expand_path( File.join( File.dirname( caller.first.scan( /(.*?):/ ).to_s ), file ) )
-
-end
-
 # load all required components
 require File.expand_path( File.join( File.dirname( __FILE__ ), 'loader.rb' ) )
 
 module TDriver
 
-	# Function to create and (or if already created re-) connect SUT object 
-	# === params
-	# hash:: Defines SUT type, identification attributes etc. 
-	#   :type:: Valid values are :S60 (for Series 60) and :QT (for QT)
-	#   :id:: Valid id that can be matched in tdriver_parameters.xml
-	# === raises
-	# ArgumentError:: Wrong argument Type '%s' (Expected Hash)
-	# ArgumentError:: SUT type not defined
-	# ArgumentError:: SUT type '%s' not supported
-	# ArgumentError:: Sut id not given
-	# MobyUtil::ParameterFileNotFoundError:: if paramter file (tdriver_parameters.xml in TDriver home directory) is not found
-	# === returns
-	# Object:: Object that SutFactory returns 
-	# === example
-	#  @sut = TDriver.connect_sut(:Id =>'sut_qt') # for qt, id in configuration file sut_qt
-	def self.connect_sut( sut_attributes = {} )
-
-		MobyBase::SUTFactory.instance.make( sut_attributes )
-
-	end
-
-	# Function to disconnect SUT object.  
-	# === params
-	# hash:: Defines SUT type, identification attributes etc. 
-	#   :id:: Valid id that can be matched in tdriver_parameters.xml and is already connected
-	# === raises
-	# ArgumentError:: Not connected to device 'id' if not connected at all / device already disconnected
-	# ArgumentError:: Sut id not given
-	# === returns
-	# Object:: SUT object 
-	# === example
-	#  @sut = TDriver.disconnect_sut(:Id =>'sut_qt') # for qt, should be connected already
-	def self.disconnect_sut( sut_attributes = {} )
-
-		MobyBase::SUTFactory.instance.disconnect_sut( sut_attributes )
-
-	end
-
-	# Function to reboot SUT object.  
-	# === params
-	# hash:: Defines SUT type, identification attributes etc. 
-	#   :id:: Valid id that can be matched in tdriver_parameters.xml and is already connected
-	# === raises
-	# ArgumentError:: Not connected to device 'id' if not connected at all / device already disconnected
-	# ArgumentError:: Sut id not given
-	# === example
-	#  @sut = TDriver.reboot_sut(:Id =>'sut_qt') # for Qt, should be connected already   
-	def self.reboot_sut( sut_attributes = {} )
-
-		MobyBase::SUTFactory.instance.reboot_sut( sut_attributes )
-
-	end
-
-	# Wrapper for SUT functionality. For documentation, please see TDriver::connect_sut
-	def self.sut( *args )
-
-		self.connect_sut( *args )
-
-	end
-
-	# Wrapper for MobyUtil::Parameter.configured_suts to retrieve all configured sut names
-	def self.suts
-
-		$parameters.configured_suts
-
-	end
-
-	# Wrapper for MobyUtil::ParameterUserAPI class with methods e.g. [] and []=, files and load_xml etc.
-	def self.parameter( *arguments )
-
-    if arguments.count == 0
+  class << self
+
+    # Function to create and (or if already created re-) connect SUT object 
+    # === params
+    # hash:: Defines SUT type, identification attributes etc. 
+    #   :id:: Valid id that can be matched in tdriver_parameters.xml
+    # === raises
+    # ArgumentError:: Wrong argument Type '%s' (Expected Hash)
+    # ArgumentError:: SUT type not defined
+    # ArgumentError:: SUT type '%s' not supported
+    # ArgumentError:: Sut id not given
+    # MobyUtil::ParameterFileNotFoundError:: if paramter file (tdriver_parameters.xml in TDriver home directory) is not found
+    # === returns
+    # Object:: Object that SutFactory returns 
+    # === example
+    #  @sut = TDriver.connect_sut(:Id =>'sut_qt') # for qt, id in configuration file sut_qt
+    def connect_sut( sut_attributes = {} )
+
+      MobyBase::SUTFactory.instance.make( sut_attributes )
+
+    end
+
+    # Function to disconnect SUT object.  
+    # === params
+    # hash:: Defines SUT type, identification attributes etc. 
+    #   :id:: Valid id that can be matched in tdriver_parameters.xml and is already connected
+    # === raises
+    # ArgumentError:: Not connected to device 'id' if not connected at all / device already disconnected
+    # ArgumentError:: Sut id not given
+    # === returns
+    # Object:: SUT object 
+    # === example
+    #  @sut = TDriver.disconnect_sut(:Id =>'sut_qt') # for qt, should be connected already
+    def disconnect_sut( sut_attributes = {} )
+
+      MobyBase::SUTFactory.instance.disconnect_sut( sut_attributes )
+
+    end
+
+    # Function to reboot SUT object.  
+    # === params
+    # hash:: Defines SUT type, identification attributes etc. 
+    #   :id:: Valid id that can be matched in tdriver_parameters.xml and is already connected
+    # === raises
+    # ArgumentError:: Not connected to device 'id' if not connected at all / device already disconnected
+    # ArgumentError:: Sut id not given
+    # === example
+    #  @sut = TDriver.reboot_sut(:Id =>'sut_qt') # for Qt, should be connected already   
+    def reboot_sut( sut_attributes = {} )
+
+      MobyBase::SUTFactory.instance.reboot_sut( sut_attributes )
+
+    end
+
+    # Wrapper for SUT functionality. For documentation, please see TDriver::connect_sut
+    def sut( *args )
+
+      connect_sut( *args )
+
+    end
+
+    # Wrapper for TDriver::Parameter.configured_suts to retrieve all configured sut names
+    def suts
+
+      $parameters.configured_suts
+
+    end
+
+    # Wrapper for TDriver::ParameterUserAPI class with methods e.g. [] and []=, files and load_xml etc.
+    def parameter( *arguments )
+
+      if arguments.count == 0
+      
+        $parameters_api
+            
+      else
+      
+        $parameters_api[ *arguments ]
+      
+      end
+
+    end
+
+    # TODO: document me
+    def state_object( options )
+
+      # create state object with given options
+      MobyBase::StateObject.new( options )
+
+    end
     
-      $parameters_api
-          
-    else
+    # == nodoc
+    # Wrapper for MobyUtil::Logger class
+    def logger
+
+      $logger
+      
+    end
+
+    # == nodoc
+    # TODO: document me
+    def config_dir
+
+      if ENV['TDRIVER_HOME']
+      
+        config_dir = ENV['TDRIVER_HOME']
+            
+      elsif MobyUtil::EnvironmentHelper.windows?
+      
+        config_dir = "c:/tdriver"
+      
+      else
+
+        config_dir = "/etc/tdriver"
+      
+      end
+        
+      File.expand_path( config_dir )
+    
+    end
     
-      $parameters_api[ *arguments ]
+    # == nodoc
+    # TODO: document me
+    def library_dir
+    
+      File.expand_path( File.dirname( __FILE__ ) )
     
     end
+  
+  private
 
-	end
+    # TODO: document me
+    def initialize_tdriver
+    
+      # initialize parameters
+      $parameters.init
 
-	# Wrapper for MobyUtil::Logger class
-	def self.logger
+      # enable logging engine
+      $logger.enable_logging
 
-    $logger
-    
-	end
+      # set xml cache buffer size 
+      MobyUtil::XML.buffer_size = $parameters[ :xml_cache_buffer_size, 10 ].to_i
 
-	# enable hooking for performance measurement & debug logging
-	TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+      # initialization done, everything is ready
+      $TDRIVER_INITIALIZED = true
 
-end # TDriver
+    end
 
-# initialize parameters
-$parameters.init
+  end
 
-# enable logging engine
-$logger.enable_logging
+  # enable hooking for performance measurement & debug logging
+  TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
-# reporting modules
-require File.expand_path( File.join( File.dirname( __FILE__ ), 'report/report.rb' ) ) if MobyUtil::Parameter[ :enable_reporter, 'true' ]=='true'
+  # initialize TDriver
+  initialize_tdriver
 
-# initialization done, everything is ready
-$TDRIVER_INITIALIZED = true
+end # TDriver

data/lib/tdriver/util/common/boolean.rb

@@ -0,0 +1,51 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## If you have questions regarding the use of this file, please contact 
+## Nokia at testabilitydriver@nokia.com . 
+## 
+## This library is free software; you can redistribute it and/or 
+## modify it under the terms of the GNU Lesser General Public 
+## License version 2.1 as published by the Free Software Foundation 
+## and appearing in the file LICENSE.LGPL included in the packaging 
+## of this file. 
+## 
+############################################################################
+
+# extend Ruby TrueClass and FalseClass class functionality
+class TrueClass
+
+  def true?
+
+    /^true$/i.match( self.to_s ) != nil
+  
+  end
+  
+  def false?
+  
+    false
+  
+  end
+
+end
+
+class FalseClass
+
+  def true?
+  
+    false
+  
+  end
+  
+  def false?
+  
+    /^false$/i.match( self.to_s ) != nil
+  
+  end
+
+end

data/lib/tdriver/util/common/crc16.rb

@@ -17,84 +17,126 @@
 ## 
 ############################################################################
 
-module CRC
-
-  class Crc16
+module TDriver
 
-    @@CCITT_16 = [
-      0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
-      0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
-      0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
-      0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
-      0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
-      0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
-      0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
-      0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
-      0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
-      0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
-      0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
-      0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
-      0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
-      0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
-      0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
-      0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
-      0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
-      0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
-      0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
-      0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
-      0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
-      0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
-      0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
-      0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
-      0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
-      0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
-      0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
-      0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
-      0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
-      0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
-      0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
-      0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
-    ] 
-
-    @@IBM_16 = [
-      0x0000, 0x1081, 0x2102, 0x3183,  
-      0x4204, 0x5285, 0x6306, 0x7387,
-      0x8408, 0x9489, 0xa50a, 0xb58b,  
-      0xc60c, 0xd68d, 0xe70e, 0xf78f
-    ] 
-
-    def self.crc16( buf, crc = 0 )
-      buf.each_byte{ | x | crc = ( ( crc << 8 ) ^ @@CCITT_16[ ( crc >> 8 ) ^ x ] ) & 0xffff }
-      crc
-    end
+  class Checksum
 
-    # use native crc calculation routines if available; using native crc routines increase performance ~10%
-    if defined?( TDriver::NativeExtensions )
+    class << self
 
-      def self.crc16_ibm( buf, crc = 0 )
+      private
+    
+      def initialize_class
+          
+        @CCITT_16 = [
+          0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
+          0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
+          0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
+          0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
+          0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
+          0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
+          0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
+          0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
+          0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
+          0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
+          0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
+          0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
+          0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
+          0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
+          0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
+          0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
+          0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
+          0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
+          0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
+          0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
+          0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
+          0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
+          0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
+          0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
+          0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
+          0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
+          0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
+          0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
+          0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
+          0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
+          0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
+          0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
+        ] 
 
-        TDriver::NativeExtensions::CRC.crc16_ibm( buf )
+        @IBM_16 = [
+          0x0000, 0x1081, 0x2102, 0x3183,  
+          0x4204, 0x5285, 0x6306, 0x7387,
+          0x8408, 0x9489, 0xa50a, 0xb58b,  
+          0xc60c, 0xd68d, 0xe70e, 0xf78f
+        ] 
 
       end
 
-    else
-
-      # fallback when native extensions are not supported (e.g. jruby)
-      def self.crc16_ibm( buf, crc = 0 )
-        crc = 0xffff
-        buf.each_byte do | c |
-          crc = ( ( crc >> 4 ) & 0x0fff ) ^ @@IBM_16[ ( ( crc ^ c ) & 15 ) ]
-          c >>= 4
-          crc = ( ( crc >> 4 ) & 0x0fff ) ^ @@IBM_16[ ( ( crc ^ c ) & 15 ) ]
-        end
-        ~crc & 0xffff
+    public
+
+      # CRC-16-CCITT    
+      def crc16( buf, crc = 0 )
+
+        # calculate the checksum
+        buf.each_byte{ | x | crc = ( ( crc << 8 ) ^ @CCITT_16[ ( crc >> 8 ) ^ x ] ) & 0xffff }
+
+        # result
+        crc
+
+      end # crc16
+
+      # check if implementation is already loaded from TDriver native Ruby C Extension; native crc routines are ~10% faster
+      unless instance_methods.include?( 'crc16_ibm' )
+      
+        # IBM-CRC-16: fallback when native extensions are not supported (e.g. jruby)
+        def crc16_ibm( buf, crc = 0xffff )
+
+          buf.each_byte do | c |
+
+            crc = ( ( crc >> 4 ) & 0x0fff ) ^ @IBM_16[ ( ( crc ^ c ) & 15 ) ]
+
+            crc = ( ( crc >> 4 ) & 0x0fff ) ^ @IBM_16[ ( ( crc ^ ( c >> 4 ) ) & 15 ) ]
+
+          end
+
+          # result
+          ~crc & 0xffff
+
+        end # crc16_ibm
+      
+      end # unless
+      
+    end # self
+
+    # enable hooking for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+    # initialize the class
+    initialize_class
+    
+  end
+
+end
+
+# deprecated
+module CRC
+
+  class Crc16
+  
+    class << self
+    
+      def method_missing( id, *args )
+      
+        #warn_caller "$1:$2 warning: deprecated method, use TDriver::Checksum##{ id.to_s } instead of CRC::Crc16##{ id.to_s }"
+      
+        TDriver::Checksum.__send__( id, *args )
+            
       end
     
     end
 
     # enable hooking for performance measurement & debug logging
     TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
-
-  end # Crc16
-
-end # CRC
+  
+  end
+  
+end