testability-driver 0.9.2

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

@@ -0,0 +1,189 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+module MobyUtil
+
+  # Helper class to store verifyblock for 
+  # constant verifications for sut state
+  class VerifyBlock 
+
+    attr_accessor :block,:expected, :message,:source, :timeout
+
+    def initialize(block, expected, message = nil, timeout = nil, source = "")
+
+      @block = block
+      @expected = expected
+      @message = message
+      @timeout = timeout
+      @source = source
+
+    end
+
+  end
+
+  class KernelHelper
+
+    # Function to determine if given value is boolean
+    # == params
+    # value:: String containing boolean
+    # == returns
+    # TrueClass::
+    # FalseClass::
+    def self.boolean?( value )
+
+      /^(true|false)$/i.match( value.to_s ).kind_of?( MatchData ) rescue false
+
+    end
+
+    # Function to return boolean of given value
+    # == params
+    # value:: String containing boolean
+    # == returns
+    # TrueClass::
+    # FalseClass::
+    def self.to_boolean( value, default = nil )
+
+      /^(true|false)$/i.match( value.to_s ) ? $1.downcase == 'true' : default
+
+    end
+
+    # Function to return class constant from a string
+    # == params
+    # constant_name:: String containing path
+    # == returns
+    # Class
+    def self.get_constant( constant_name )
+
+      begin
+
+        constant_name.split("::").inject( Kernel ){ | scope, const_name | scope.const_get( const_name ) }
+
+      rescue 
+
+        Kernel::raise NameError.new( "Invalid constant %s" % constant_name )
+
+      end
+
+    end
+
+    def self.parse_caller( at )
+
+      if /^(.+?):(\d+)(?::in `(.*)')?/ =~ at
+
+        file = Regexp.last_match[ 1 ]
+        line = Regexp.last_match[ 2 ].to_i
+        method = Regexp.last_match[ 3 ]
+
+        [ file, line, method ]
+
+      end
+
+    end
+
+    def self.deprecated( deprecated_name, new_name = "" )
+
+      output = "warning: #{ deprecated_name } is deprecated"
+
+      output += "; use #{ new_name } instead" unless new_name.empty?
+
+      $stderr.puts output
+
+    end
+
+    # Searches for the given source file for a line
+    #
+    # === params
+    # from_file:: String defining the file to load. If at_line is nil, this argument can also contain a path and line number separated by : (eg. some_dir/some_file.rb:123).
+    # at_line:: (optional) Integer, number of the line (first line is 1).
+    # === returns
+    # String:: Contents of the line
+    # === throws
+    # RuntimeError:: from_file is not correctly formed, the file cannot be loaded or the line cannot be found.
+    def self.find_source( backtrace )
+
+      ret_str = "\n"
+
+      begin
+
+        call_stack = backtrace.to_s.split(':')
+        #puts "call_stack:" << backtrace.to_s
+
+        line_number = 0
+        if (call_stack.size() == 2)
+          line_number = call_stack[1].to_i
+
+        else
+          line_number = call_stack[call_stack.size()-2].to_i
+        end
+        #puts "line number: " << line_number.to_s
+
+        file_path = ""
+        if (call_stack.size() == 2)
+          file_path = call_stack[0]
+        else
+          (call_stack.size()-2).times do |index|
+            file_path << call_stack[index].to_s << ":"
+          end
+          file_path.slice!(file_path.size()-1) # remove the trailing colon
+        end
+        #puts "file path: " << file_path.to_s
+
+        lines_to_read = line_number >= 2 ? 3 : line_number
+        #puts "lines to read: " << lines_to_read.to_s
+
+        start_line = line_number #- (lines_to_read <= 1 ? 0 : 1)
+        #puts "start line:" << start_line.to_s
+
+        File.open(File.expand_path(file_path.to_s), "r") { |source|
+
+          lines = source.readlines
+          #puts "lines.size:" << lines.size
+          Kernel::raise RuntimeError.new("Only \"#{lines.size.to_s}\" lines exist in the source file.")if start_line > lines.size
+
+          lines_to_read = (lines.size - start_line + 1) < 3 ? (lines.size - start_line + 1) : lines_to_read
+
+          # the array is zero based, first line is at position 0
+          lines_to_read.times do |index|
+            if (line_number == (start_line + index))
+              ret_str << "=> "
+            else
+              ret_str << "   "
+            end
+            ret_str << lines[start_line + index - 1]
+          end
+
+        }
+
+      rescue Exception => e
+
+        #puts "exception:" << e.inspect
+        ret_str << "Unable to load source lines.\n" << e.inspect
+
+      end
+
+      return ret_str
+
+    end
+
+    # enable hooking for performance measurement & debug logging
+    MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+  end # KernelHelper
+
+end # MobyUtil

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

@@ -0,0 +1,39 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+require 'rbconfig'  # ??
+
+# common modules - should be generic and runnable as standalone
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'error.rb' ) )
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'array.rb' ) )
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'crc16.rb' ) )
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'environment.rb' ) )
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'file.rb' ) )
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'gem.rb' ) )
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'kernel.rb' ) )
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'retryable.rb' ) )
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'string.rb' ) )

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

@@ -0,0 +1,98 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+module MobyUtil
+
+  class Retryable
+
+    # Function to retry code block for x times if exception raises
+    # == params
+    # options:: Hash of options 
+    #   :tries  Number of tries to perform. Default is 1
+    #   :interval  Timeout between retry. Default is 0
+    #   :exception  Retry if given type of exception occures. Default is Exception (any error)
+    # == returns
+    def self.while( options = {}, &block )
+
+      options = { :tries => 1, :interval => 0, :exception => Exception }.merge( options )
+
+      attempt = 1
+
+      begin
+
+        # yield given block and pass attempt number as parameter
+        return yield( attempt )
+
+      rescue *options[ :exception ]
+  
+        #if ( options[ :tries ] -= 1) > 0 && ![ *options[ :unless ] ].include?( $!.class )
+
+        if ( attempt < options[ :tries ] ) && ![ *options[ :unless ] ].include?( $!.class )
+
+          sleep( options[ :interval ] ) if options[ :interval ] > 0
+
+          attempt += 1
+
+          retry
+
+        end
+
+        # raise exception with correct exception backtrace
+        Kernel::raise $!
+
+      end
+
+      nil
+    end
+
+    # Function to retry code block until timeout expires if exception raises 
+    # == params
+    # options:: Hash of options 
+    #   :timeout  Timeout until fail. Default is 0
+    #   :interval  Timeout between retry. Default is 0
+    #   :exception  Retry if given type of exception occures. Default is Exception (any error)
+    # == returns
+    def self.until( options = {}, &block )
+
+      options = { :timeout => 0, :interval => 0, :exception => Exception }.merge( options )      
+      start_time = Time.now
+
+      begin
+
+        return yield
+
+      rescue *options[ :exception ]
+
+        if (Time.now - start_time) <= options[ :timeout ] && ![ *options[ :unless ] ].include?( $!.class )
+          sleep( options[ :interval ] ) if options[ :interval ] > 0
+          retry
+        end
+
+        # raise exception with correct exception backtrace
+        Kernel::raise $!
+
+      end      
+    end
+
+    # enable hooking for performance measurement & debug logging
+    MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+  end # Retryable
+
+end # MobyUtil

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

@@ -0,0 +1,77 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+module MobyUtil
+
+  class StringHelper    
+
+    # Function determines if string is "true" or "false"
+    # == params
+    # string:: String
+    # == returns
+    # TrueClass/FalseClass 
+    def self.boolean?( string )
+
+      # raise exception if argument type other than String
+      Kernel::raise ArgumentError.new("Invalid argument format %s (Expected: %s)" % [ string.class, "String" ]) unless string.kind_of?( String )
+
+      /^(true|false)$/i.match( string ).kind_of?( MatchData )
+
+    end    
+
+    # Function determines if string is numeric
+    # == params
+    # string:: Numeric string
+    # == returns
+    # TrueClass/FalseClass 
+    def self.numeric?( string )
+
+      # raise exception if argument type other than String
+
+      Kernel::raise ArgumentError.new("Invalid argument format %s (Expected: %s)" % [ string.class, "String" ]) unless string.kind_of?( String )
+
+      /[0-9]+/.match( string ).kind_of?( MatchData )
+
+    end  
+
+    # Function converts "true" or "false" to boolean 
+    # == params
+    # string:: String
+    # == returns
+    # TrueClass/FalseClass 
+    def self.to_boolean( string )          
+
+      if MobyUtil::StringHelper::boolean?( string )
+
+        /true/i.match( string ).kind_of?( MatchData )
+
+      else
+
+        Kernel::raise ArgumentError.new("Invalid value '%s' for boolean (Expected: %s)" % [ string, "'true', 'false'" ] )
+
+      end      
+
+    end    
+
+    # enable hooking for performance measurement & debug logging
+    MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+  end # StringHelper
+
+end # MobyUtil

data/lib/tdriver/util/dbaccess/dbaccess.rb

@@ -0,0 +1,188 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+# Utility for handling database connections
+
+module MobyUtil
+
+	class DBAccess
+
+    DB_TYPE_MYSQL = 'mysql'
+    DB_TYPE_SQLITE = 'sqlite'
+
+	include Singleton
+		
+		# == description
+		# Initialize the singleton
+		# connection is maintained as long as the connectivity parameters remain the same
+		# this is to avoid constant connect as this takes time
+		#
+		def initialize
+			@@_connections = {}
+			@@_mysql = nil
+		end
+
+		# == description
+		# Class Method that returns existing connections
+		#
+		def DBAccess.connections()
+			return @@_connections
+		end
+		
+		# == description
+		# Runs an SQL query on the on the given MobyUtil::DBConnection 
+		#
+		# == arguments
+		# dbc
+		#  MobyUtil::DBConnection
+		#   description: object with the connection details of an open sql connection
+		#
+		# query_string
+		#  String
+		#   description: database-specific SQL query (note that mysql and sqlite have slightly different syntax)
+		#   example: "select * from tdriver_locale;"
+		#
+		# == returns
+		# Array
+		#  description: Array of rows returned by the server. Each row is an array of String values.
+		#
+		# == throws
+		# ArgumentError
+		#  description: if the argument provided is not the right object type
+		#
+	    def self.query( dbc, query_string )
+			# Create first instance of this class if it doesn't exist
+			self.instance
+			
+			raise ArgumentError.new("Invalid connection object provided.") if dbc.nil? or !dbc.kind_of? MobyUtil::DBConnection
+			
+			db_type = dbc.db_type
+			host = dbc.host
+			username = dbc.username
+			password = dbc.password
+			database_name = dbc.database_name
+			
+			# Check creation parameters
+		    raise DbTypeNotDefinedError.new( "Database type need to be either 'mysql' or 'sqlite'!" ) if  db_type == nil 
+            raise DbTypeNotSupportedError.new( "Database type '#{db_type}' not supported! Type need to be either 'mysql' or 'sqlite'!" ) unless  db_type == DB_TYPE_MYSQL or  db_type == DB_TYPE_SQLITE
+			if db_type == DB_TYPE_MYSQL
+				raise ArgumentError.new("Host must be provided as a non empty string.") if host.nil? or host.class != String or host.empty?
+				raise ArgumentError.new("Username must be provided as a non empty string.") if username.nil? or username.class != String or username.empty?
+				raise ArgumentError.new("Password must be provided as a string.") if password.nil? or password.class != String
+			end
+			raise ArgumentError.new("The database name must be provided as a non empty string.") if database_name.nil? or database_name.class != String or database_name.empty?
+			raise ArgumentError.new("The query qtring must be provided as a non empty string.") if query_string.nil? or query_string.class != String or query_string.empty?
+			
+			# Check for exsting connection for that host and create it if needed
+			if !@@_connections.has_key?( host + db_type + database_name ) # make connection ID unique by using host, type and db on the key
+				dbc.dbh = connect_db( db_type, host, username, password, database_name )
+				@@_connections[ host + db_type + database_name ] = dbc
+			end
+			
+			if db_type == DB_TYPE_MYSQL
+				query_result = @@_connections[ host + db_type + database_name ].dbh.query( query_string )
+			elsif dbc.db_type == DB_TYPE_SQLITE
+				query_result = @@_connections[ host + db_type + database_name ].dbh.query( query_string )
+			end
+			
+			# Return a uniform set of results as an array of rows, rows beeing an array of values ( Array<Array<String>> )
+			result = Array.new
+			if db_type == DB_TYPE_MYSQL and !query_result.nil?
+				query_result.num_rows.times do |i|
+					result << query_result.fetch_row
+				end				
+		    elsif db_type == DB_TYPE_SQLITE and !query_result.nil?
+				# Create Array<SQLite3::ResultSet::ArrayWithTypesAndFields<String>> type result
+				# it effectively behaves the same as with Array<Array<String>> but the inner Arrays have .fields and .types properties 
+				# which return the column name and type for each value on the row (Array) returned.
+				while ( row = query_result.next )
+					result << row
+				end
+				# it is essentially a prepare method so we need to call close to free the connection
+				query_result.close 
+		    end
+			return result
+		end		
+	
+		# == description
+		# Retunrs the number of affected rows on the latest sql query on the given MobyUtil::DBConnection 
+		#
+		# == arguments
+		# dbc
+		#  MobyUtil::DBConnection
+		#   description: object with the connection details of an open sql connection
+		#
+		# == returns
+		# Integer
+		#  description: number of rows affected
+		#
+		# == throws
+		# ArgumentError
+		#  description: if the argument provided is not the right object type
+		#
+		def self.affected_rows(dbc)
+			raise ArgumentError.new("Invalid connection object provided.") if dbc.nil? or !dbc.kind_of? MobyUtil::DBConnection
+			
+			# Check for exsting connection for that host and create it if needed
+			if !@@_connections.has_key?( dbc.host + dbc.db_type + dbc.database_name ) # make connection ID unique by using host, type and db on the key
+				dbc.dbh = connect_db(  dbc.db_type, dbc.host, dbc.username, dbc.password, dbc.database_name )
+				@@_connections[ dbc.host + dbc.db_type + dbc.database_name ] = dbc
+			end
+			result = 0
+			if dbc.db_type == DB_TYPE_MYSQL
+				result = @@_connections[ dbc.host + dbc.db_type + dbc.database_name ].dbh.affected_rows
+			elsif dbc.db_type == DB_TYPE_SQLITE
+				result = @@_connections[ dbc.host + dbc.db_type + dbc.database_name ].dbh.changes
+			end
+			return result
+		end
+		
+		
+		
+		private
+		
+		# == description
+		# Function establishes a new connection to as sql server and returns it's handle
+		#
+	    def self.connect_db(  db_type, host, username, password, database_name )
+
+			# if mysql API and connection are not initialized, then initialize the mysql API
+			if (  db_type == DB_TYPE_MYSQL ) && ( @@_mysql.nil? )
+				require 'mysql'
+				@@_mysql = Mysql::init
+            elsif  db_type == DB_TYPE_SQLITE
+                require 'sqlite3'
+			end
+
+			begin
+				dbh = @@_mysql.connect( host, username, password, database_name) if  db_type == DB_TYPE_MYSQL
+				dbh.query 'SET NAMES utf8' if db_type == DB_TYPE_MYSQL # set the utf8 encoding
+                dbh = SQLite3::Database.new( database_name ) if db_type == DB_TYPE_SQLITE				
+			rescue
+				raise SqlConnectError.new( $!.message )
+			end
+			
+			return dbh
+
+		end
+
+	end # class
+
+end # module
+