testability-driver-qt-sut-plugin 1.0.3 → 1.0.4

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/controllers/find_object.rb

@@ -40,7 +40,7 @@ module MobyController
 	  end
 
 	  # enable hooking for performance measurement & debug logging
-	  MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+	  TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 	end #module FindObjectCommand
 	

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/controllers/fixture.rb

@@ -31,7 +31,7 @@ module MobyController
 			# == raises
 			# NotImplementedError: raised if unsupported command type       
 			def execute
-				Kernel::raise ArgumentError.new( "Fixture '%s' not found for sut id '%s'" % [ @name, @sut_adapter.sut_id ] ) if ( plugin_params =  MobyUtil::Parameter[ @sut_adapter.sut_id.to_sym ][ :fixtures ][ @params[:name].to_sym, nil ] ).nil?
+				Kernel::raise ArgumentError.new( "Fixture '%s' not found for sut id '%s'" % [ @name, @sut_adapter.sut_id ] ) if ( plugin_params =  $parameters[ @sut_adapter.sut_id.to_sym ][ :fixtures ][ @params[:name].to_sym, nil ] ).nil?
 
         fixture_plugin = plugin_params.kind_of?(String) ? plugin_params : plugin_params[:plugin] 
 				@sut_adapter.send_service_request(Comms::MessageGenerator.generate(make_fixture_message(fixture_plugin, @params)))
@@ -43,8 +43,7 @@ module MobyController
 			end
 
 			# enable hooking for performance measurement & debug logging
-			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
-
+			TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 		end # Fixture
 

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/controllers/group.rb

@@ -43,7 +43,7 @@ module MobyController
 			end
 
 			# enable hooking for performance measurement & debug logging
-			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+			TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 		end #module Group
 

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/controllers/infologger_command.rb

@@ -52,7 +52,7 @@ module MobyController
 			end
 
 			# enable hooking for performance measurement & debug logging
-			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+			TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 
 		end # InfoLoggerCommand

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/controllers/key_sequence.rb

@@ -64,10 +64,10 @@ module MobyController
 									Kernel::raise ArgumentError.new( "Wrong argument type %s for key (Expected: %s)" % [ key.class, "Symbol/Fixnum" ] ) unless [ Fixnum, Symbol ].include?( key.class ) 
 
 									# verify that keymap is defined for sut if symbol used. 
-									Kernel::raise ArgumentError.new("Symbol #{ key.inspect } cannot be used due to no keymap defined for #{ sut.id } in TDriver configuration file.") if key.kind_of?( Symbol ) && MobyUtil::Parameter[ sut.id ][ :keymap ].nil?
+									Kernel::raise ArgumentError.new("Symbol #{ key.inspect } cannot be used due to no keymap defined for #{ sut.id } in TDriver configuration file.") if key.kind_of?( Symbol ) && $parameters[ sut.id ][ :keymap ].nil?
 
 									# retrieve corresponding scan code (type of string, convert to fixnum) for symbol from keymap if available 
-									key = MobyUtil::Parameter[ sut.id ][ :keymap ][ key ].hex unless MobyUtil::Parameter[ sut.id ][ :keymap ][ key ].nil?
+									key = $parameters[ sut.id ][ :keymap ][ key ].hex unless $parameters[ sut.id ][ :keymap ][ key ].nil?
 
 									# raise exception if value is other than fixnum
 									Kernel::raise ArgumentError.new( "Scan code for :%s not defined in keymap" % key ) unless key.kind_of?( Fixnum )
@@ -90,7 +90,7 @@ module MobyController
 			end
 
 			# enable hooking for performance measurement & debug logging
-			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+			TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 		end #class
 

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/controllers/screen_capture.rb

@@ -44,7 +44,7 @@ module MobyController
 			end
 
 			# enable hooking for performance measurement & debug logging
-			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+			TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 
 		end # ScreenCapture

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/controllers/tap.rb

@@ -42,7 +42,7 @@ module MobyController
 			end
 
 			# enable hooking for performance measurement & debug logging
-			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+			TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 		end # Tap
 

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/controllers/widget.rb

@@ -32,37 +32,53 @@ module MobyController
 			# == raises
 			# NotImplementedError: raised if unsupported command type       
 			def execute
-			  command_params = {:eventType => get_event_type, :name => get_command_name}
-			  command_params.merge!(get_command_params) if get_command_params
+
+			  command_params = { :eventType => get_event_type, :name => get_command_name }
+
+			  command_params.merge!( get_command_params ) if get_command_params
 
 			  builder = Nokogiri::XML::Builder.new{
-				TasCommands( :id=> get_application_id, :transitions => get_transitions, :service => get_service || 'uiCommand' ) {
-				  Target( :TasId => get_object_id, :type => get_object_type ) {
-					if get_command_value.kind_of? Array
-					  get_command_value.each do | command_part |
-						Command( command_part[ :value ], command_part[ :params ] )
+
+				  TasCommands( :id => get_application_id, :transitions => get_transitions, :service => get_service || 'uiCommand' ) {
+
+				    Target( :TasId => get_object_id, :type => get_object_type ) {
+
+					  if get_command_value.kind_of?( Array )
+
+					    get_command_value.each do | command_part |
+						    Command( command_part[ :value ], command_part[ :params ] )
+					    end
+
+            elsif get_command_value
+
+  					    Command( get_command_value, command_params )
+
+					  else
+
+  					    Command( command_params )
+
 					  end
-					else
-					  Command( get_command_value || "", command_params )
-					end
+
+				    }
 				  }
-				}
 			  }						  
 
 			  if @sut_adapter.group?
-				@sut_adapter.append_command(builder.doc.root.children)
+  				@sut_adapter.append_command( builder.doc.root.children )
 			  else
-				@sut_adapter.send_service_request(Comms::MessageGenerator.generate(builder.to_xml))
+	  			@sut_adapter.send_service_request( Comms::MessageGenerator.generate( builder.to_xml ) )
 			  end
 
 			end
 
 			def set_adapter( adapter )
+
 				@sut_adapter = adapter
+
 			end
 
 			# enable hooking for performance measurement & debug logging
-			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+			TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 
 		end #module Action

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/plugin.rb

@@ -20,6 +20,11 @@
 # verify that TDriver is loaded
 Kernel::raise RuntimeError.new( "This SUT plugin requires Testability Driver and cannot be launched in standalone mode" ) unless (defined?( MATTI ) || defined?( TDriver ))
 
+include TDriverVerify
+
+require 'socket'
+require 'zlib'
+
 module MobyPlugin
 
 	module QT
@@ -95,8 +100,8 @@ module MobyPlugin
 			def self.make_sut( sut_id )
 
 				# tcp/ip read/write timeouts, default: 15 (seconds)
-				socket_read_timeout  = MobyUtil::Parameter[ sut_id ][ :socket_read_timeout,  "15" ].to_i
-				socket_write_timeout = MobyUtil::Parameter[ sut_id ][ :socket_write_timeout, "15" ].to_i
+				socket_read_timeout  = $parameters[ sut_id ][ :socket_read_timeout,  "15" ].to_i
+				socket_write_timeout = $parameters[ sut_id ][ :socket_write_timeout, "15" ].to_i
 
 				MobyBase::SUT.new(
 					MobyBase::SutController.new( "QT", MobyController::QT::SutAdapter.new( sut_id, socket_read_timeout, socket_write_timeout ) ), 
@@ -107,7 +112,7 @@ module MobyPlugin
 			end
 
 			# enable hooking for performance measurement & debug logging
-			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+			TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 			# register plugin
 			MobyUtil::PluginService.instance.register_plugin( self ) # Note: self is MobyPlugin::QT::SUT

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/sut/adapter.rb

@@ -24,16 +24,18 @@ module MobyController
     # Sut adapter that used TCP/IP connections to send and receive data from QT side. 
     class SutAdapter < MobyController::SutAdapter
       
-      attr_reader :sut_id
+      attr_reader(
+        :sut_id,
+        :socket_received_bytes,
+        :socket_sent_bytes,
+        :socket_received_packets,
+        :socket_sent_packets
+      )
 
       attr_accessor(
-
-            :socket_read_timeout,
-            :socket_write_timeout,
-            :socket_received_bytes,
-            :socket_sent_bytes
-
-            )
+        :socket_read_timeout,
+        :socket_write_timeout
+      )
       
       # TODO: better way to set the host and port parameters   
       # Initialize the tcp adapter for communicating with the device.
@@ -47,8 +49,12 @@ module MobyController
 
         @socket = nil
         @connected = false
-        @socket_received_bytes=0
-        @socket_sent_bytes=0
+
+        @socket_received_bytes = 0
+        @socket_sent_bytes = 0
+
+        @socket_received_packets = 0
+        @socket_sent_packets = 0
 
         @sut_id = sut_id
 
@@ -56,6 +62,7 @@ module MobyController
         @socket_read_timeout = receive_timeout
         @socket_write_timeout = send_timeout
 
+
         @counter = rand( 1000 )
 
         # connect socket
@@ -63,6 +70,7 @@ module MobyController
 
       end
 
+      # TODO: document me
       def disconnect
 
         @socket.close if @connected
@@ -71,18 +79,19 @@ module MobyController
 
       end
 
+      # TODO: document me
       def connect( id = nil )
 
         id ||= @sut_id
 
         begin
 
-          @socket = TCPSocket.open( MobyUtil::Parameter[ id ][ :qttas_server_ip ], MobyUtil::Parameter[ id ][ :qttas_server_port ].to_i )
+          @socket = TCPSocket.open( $parameters[ id ][ :qttas_server_ip ], $parameters[ id ][ :qttas_server_port ].to_i )
 
         rescue => ex
 
-          ip = "no ip" if ( ip = MobyUtil::Parameter[ id ][ :qttas_server_ip, "" ] ).empty?
-          port = "no port" if ( port = MobyUtil::Parameter[ id ][ :qttas_server_port, "" ] ).empty?
+          ip = "no ip" if ( ip = $parameters[ id ][ :qttas_server_ip, "" ] ).empty?
+          port = "no port" if ( port = $parameters[ id ][ :qttas_server_port, "" ] ).empty?
 
           Kernel::raise IOError.new("Unable to connect QTTAS server, verify that it is running properly (#{ ip }:#{ port }): .\nException: #{ ex.message }")
         end
@@ -91,18 +100,27 @@ module MobyController
 
       end
 
+      # TODO: document me
       def group?
+
         @_group
+
       end
 
       # Set the document builder for the grouped behaviour message.
       def set_message_builder(builder)
+
         @_group = true
+
         @_builder = builder
+
       end
 
+      # TODO: document me
       def append_command(node_list)
+
         node_list.each {|ch| @_builder.doc.root.add_child(ch)}          
+
       end
 
       # Sends a grouped command message to the server. Sets group to false and nils the builder
@@ -110,11 +128,17 @@ module MobyController
       # == returns    
       # the amout of commands grouped (and send)
       def send_grouped_request
+
         @_group = false
+
         size = @_builder.doc.root.children.size
+
         send_service_request(Comms::MessageGenerator.generate(@_builder.to_xml))
+
         @_builder = nil
+
         size
+
       end
 
       # Send the message to the qt server         
@@ -131,7 +155,7 @@ module MobyController
         message.message_id = ( @counter += 1 )
 
         # write request message to socket
-        write_socket( message.make_binary_message(@counter) )
+        write_socket( message.make_binary_message( @counter ) )
 
         # read response to determine was the message handled properly and parse the header
         # header[ 0 ] = command_flag
@@ -141,6 +165,7 @@ module MobyController
         # header[ 4 ] = message_id
 
         header = nil
+
         body = nil
 
         read_message_id = 0
@@ -149,8 +174,10 @@ module MobyController
         
           header = read_socket( 12 ).unpack( 'CISCI' )
 
+          body = read_socket( header[ 1 ] )
+
           # read the message body and compare crc checksum
-          Kernel::raise IOError.new( "CRC do not match. Maybe the message is corrupted!" ) if CRC::Crc16.crc16_ibm( body = read_socket( header[ 1 ] ) , 0xffff ) != header[ 2 ]
+          Kernel::raise IOError, "CRC do not match, response message body may be corrupted!" if CRC::Crc16.crc16_ibm( body, 0xffff ) != header[ 2 ]
           
           # validate response message; check that response message id matches the request
           # if smaller than expected try to read the next message but if bigger raise error
@@ -158,14 +185,15 @@ module MobyController
 
           if read_message_id < @counter
 
-            MobyUtil::Logger.instance.log "warning" , "Response to request did not match: \"#{ header[ 4 ].to_s }\"<\"#{ @counter.to_s }\""
+            $logger.log "warning", "Response to request did not match: \"#{ header[ 4 ].to_s }\"<\"#{ @counter.to_s }\""
 
           elsif read_message_id > @counter
 
-            MobyUtil::Logger.instance.log "fatal" , "Response to request did not match: \"#{ header[ 4 ].to_s }\">\"#{ @counter.to_s }\""
+            $logger.log "fatal", "Response to request did not match: \"#{ header[ 4 ].to_s }\">\"#{ @counter.to_s }\""
 
             # save to file?
-            MobyUtil::Logger.instance.log "fatal" , body
+            $logger.log "fatal", body
+
             Kernel::raise RuntimeError.new( "Response to request did not match: \"#{ header[ 4 ].to_s }\"!=\"#{ @counter.to_s }\"" )
 
           end
@@ -174,8 +202,11 @@ module MobyController
       
         # inflate the message body if compressed
         if ( header[ 3 ] == 2 )
-      
-          body = Zlib::Inflate.inflate( body ) unless ( body = body[ 4..-1 ] ).empty?
+
+          # remove leading 4 bytes
+          body = body[ 4 .. -1 ]
+
+          body = Zlib::Inflate.inflate( body ) unless body.empty?
 
         end
 
@@ -184,13 +215,19 @@ module MobyController
         #   0 -> ERROR_MSG
         #   1 -> VALID_MSG
         #   2 -> OK_MESSAGE
-		if header[ 0 ] == 0
-		  if body =~ /The application with Id \d+ is no longer available/
-			Kernel::raise MobyBase::ApplicationNotAvailableError.new( body ) 
-		  else
-			Kernel::raise RuntimeError.new( body ) 
-		  end
-		end
+        if header[ 0 ] == 0
+
+          if body =~ /The application with Id \d+ is no longer available/
+
+            Kernel::raise MobyBase::ApplicationNotAvailableError, body
+
+          else
+
+            Kernel::raise RuntimeError, body
+
+          end
+
+        end
 
         # return the body ( and crc if required )
         return_crc ? [ body, header[ 2 ] ] : body
@@ -199,6 +236,7 @@ module MobyController
 
     private
 
+      # TODO: document me
       def read_socket( bytes_count )
 
         # store time before start receving data
@@ -214,26 +252,119 @@ module MobyController
 
         }
 
+        # useless?
         Kernel::raise IOError.new( "Socket reading error for %i bytes - No data retrieved" % [ bytes_count ] ) if read_buffer.nil?
 
         @socket_received_bytes += read_buffer.size
+
+        @socket_received_packets += 1
+
         read_buffer
+        
+=begin
+        begin
+
+          read_buffer = @socket.read_nonblock( bytes_count )
+
+        rescue Errno::EWOULDBLOCK
+
+          if TCPSocket.select( [ @socket ], nil, nil, @socket_read_timeout )
+
+            read_buffer = @socket.read_nonblock( bytes_count )
+
+          else
+
+            Kernel::raise IOError.new( "Socket reading timeout (%i) exceeded for %i bytes" % [ @socket_read_timeout, bytes_count ] )
+
+          end
+
+        end
+
+        read_buffer
+=end
+
+=begin
+        #Kernel::raise ThreadError, "Timeout within critical session" if Thread.critical
+
+        begin
+
+          # store current thread
+          main_thread = Thread.current
+
+          # create timeout thread
+          timeout_thread = Thread.new( @socket_read_timeout ){ | timeout, bytes_count |
+
+            # sleep the timeout
+            sleep time
+
+            # raise exception if timeout exceeds
+            main_thread.raise IOError.new( "Socket reading timeout (%i) exceeded for %i bytes" % [ timeout, bytes_count ] ) if main_thread.alive?
+
+          }
+          
+          # read data from socket          
+          @socket.read( bytes_count )
+
+        ensure
+
+          # ensure that timeout thread is terminated
+          timeout_thread.kill if timeout_thread && timeout_thread.alive?
+
+          @socket_received_bytes += bytes_count 
+
+        end
+=end
 
       end
 
+      # TODO: document me
       def write_socket( data )
-      
+
         @socket_sent_bytes += data.size
 
+        @socket_sent_packets += 1
+
         @socket.write( data )
 
         # verify that there is no data in writing buffer 
         Kernel::raise IOError.new( "Socket writing timeout (%i) exceeded for %i bytes" % [ @socket_write_timeout, data.length ] ) if TCPSocket::select( nil, [ @socket ], nil, @socket_write_timeout ).nil?
+ 
+=begin
+
+        begin
+          
+          # store current thread
+          main_thread = Thread.current
+
+          # create timeout thread
+          timeout_thread = Thread.new( @socket_write_timeout ){ | timeout, data.size |
+
+            # sleep the timeout
+            sleep time
+
+            # raise exception if timeout exceeds
+            main_thread.raise IOError.new( "Socket writing timeout (%i) exceeded for %i bytes" % [ timeout, bytes_count ] ) if main_thread.alive?
+
+          }
+
+          # read data from socket          
+          @socket.write( data )
+
+        ensure
+
+          # ensure that timeout thread is terminated
+          timeout_thread.kill if timeout_thread and timeout_thread.alive?
+
+          @socket_sent_bytes += data.size
+
+        end
+
+=end
 
       end
 
       # enable hooking for performance measurement & debug logging
-      MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+      TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
     end # SutAdapter