testability-driver 0.9.2

data/README

@@ -0,0 +1 @@
+release notes

data/bin/start_app_perf

@@ -0,0 +1,199 @@
+#! /usr/bin/ruby1.8
+# Add '.rb' to work around a bug in IronRuby's File#dirname
+$:.unshift(File.dirname(__FILE__ + '.rb') + '/../lib') unless $:.include?(File.dirname(__FILE__ + '.rb') + '/../lib')
+
+
+require 'tdriver'  # contains the reporter!
+require 'nokogiri'
+require 'date'
+require 'optparse'
+
+include TDriverReportDataPresentation
+
+##################################
+## PARSE COMMAND LINE OPTIONS
+@settings = {}
+@settings[:iterations] = nil
+@settings[:signals] = ["applicationReady()"]
+@settings[:events] = ["Paint"]
+@settings[:output_filename] = "startperf_report.html"
+@settings[:app_name] = ""
+@settings[:objects] = ""
+@settings[:sut_type] = "sut_qt"
+@data = {}
+
+begin
+	options = OptionParser.new do |opts|
+		opts.banner = "Usage: start_app_perf [OPTIONS] <application>\nNote: 'applicationStart()' signal and 'Paint' events will be collected by default.\nOptions:\n"
+		opts.on("-n ITERATIONS", "--iterations", "Required. Number of iterations of the start test.") do |s| @settings[:iterations] = s.to_i; end
+		opts.on("-s SYGNALS", "--signals", "Comma separated list of signals to collect, don't use spaces.") do |s| @settings[:signals] << s.split(',').collect{|a| a.strip}; end
+		opts.on("-e EVENTS", "--events", "Comma separated list of events to collect, don't use spaces.") do |s| @settings[:events] << s.split(',').collect{|a| a.strip}; end
+		opts.on("-o FILENAME", "--output", "Filename for the output html report. Defaults to 'startperf_report.html'") do |s|  @settings[:output_filename] = s; end
+		opts.on("-t SUTTYPE", "--suttype", "Sut type to be used. 'sut_qt' will be used as default type.") do |s|  @settings[:sut_type] = s; end
+		@settings[:opts] = opts
+	end.parse!
+	raise OptionParser::MissingArgument.new("number of iterations not provided. use the -n option to provide it.") if @settings[:iterations] == nil
+	raise OptionParser::MissingArgument.new("application to run not provided.") if ARGV.length < 1 
+	raise OptionParser::InvalidArgument.new("too many arguments provided." + ARGV.to_s) if ARGV.length > 1
+	@settings[:app_name] = ARGV[0].sub(/\.exe/, '')	
+rescue OptionParser::MissingArgument, OptionParser::InvalidArgument, Exception => e
+	puts e.message 
+	puts
+	puts @settings[:opts]
+	exit
+end
+
+
+# HARDCODED => Sut type, 
+# signals to listen: 'applicationReady()'
+# events to listen: 'Paint'
+
+##################################
+## METHODS
+
+# convert string argument into integer
+def toi(arg)
+  while(arg.length > 0 && arg[0] == '0')
+		arg = arg[1..-1]
+  end
+  arg.to_i
+end
+
+# Run Application
+def run(iteration)
+	# start application and set events & signals to listen. SLEEP prevents other communications to affect the performance of the application while starting
+	app = @sut.run(:name => @settings[:app_name], :events_to_listen => @settings[:events].join(','), :signals_to_listen => @settings[:signals].join(','), :sleep_after_launch => 5)
+	strOut = ""
+
+	# process Events
+	if !@settings[:events].empty?
+		events = app.get_events
+		app.disable_events
+		#puts events
+		doc = Nokogiri::XML.parse(events)
+		first_time_stamp = nil
+		node_set = doc.xpath('//object[@name = "QtApplicationEvents"]/objects/object')
+		timer_counter = 0
+		index = 0
+		target_object = nil
+		while(index < node_set.size)
+				node = node_set.at(index)
+				time_str = node.xpath("#{node.path}/attributes/attribute[@name = \"timeStamp\"]/value").first.text
+				time_stamp = Time.local(toi(time_str[0..3]), toi(time_str[4..5]), toi(time_str[6..7]), toi(time_str[8..9]), toi(time_str[10..11]), toi(time_str[12..13]), toi(time_str[14..16])*1000)
+				if (first_time_stamp == nil)
+						first_time_stamp = time_stamp
+						strOut << "application started at " << first_time_stamp.to_s << "\n"
+						strOut << "events:\n"
+				else
+						event_name = node.attribute("name").text
+						delta_time_seconds = time_stamp.to_i-first_time_stamp.to_i
+						delta_time_milliseconds = (time_stamp.usec/1000) - (first_time_stamp.usec/1000)
+						delta_time = delta_time_seconds*1000
+						delta_time = delta_time + delta_time_milliseconds
+
+						strOut << (delta_time).to_s << "\t" << event_name
+						target_object = node.xpath("#{node.path}/objects/object").first
+						if(target_object)
+								target_object_name = target_object.attribute("name").text
+								target_object_type = target_object.attribute("type").text
+								strOut << "\t" << target_object_type << "(" << target_object_name << ")"
+						end
+						strOut << "\n"
+						
+						#DATACOLLECTION!
+						event_method_name = target_object.nil? ? event_name : "#{event_name}:#{target_object_type}(#{target_object_name})"
+						@data[event_method_name] = Array.new if @data[event_method_name] == nil
+						@data[event_method_name][iteration] = delta_time
+				end
+				index = index + 1
+		end
+	end
+	
+	
+	# process signals
+	if !@settings[:signals].empty?
+		signals = app.fixture('signal', 'get_signal')
+		app.fixture('signal', 'remove_signals')
+		#puts signals 
+		doc = Nokogiri::XML.parse(signals)
+		first_time_stamp = nil
+		node_set = doc.xpath('//tasInfo[@name = "QtSignals"]/object')
+		timer_counter = 0
+		index = 0
+		target_object = nil
+		while(index < node_set.size)
+				node = node_set.at(index)
+				time_str = node.xpath("#{node.path}/attributes/attribute[@name = \"timeStamp\"]/value").first.text
+				time_stamp = Time.local(toi(time_str[0..3]), toi(time_str[4..5]), toi(time_str[6..7]), toi(time_str[8..9]), toi(time_str[10..11]), toi(time_str[12..13]), toi(time_str[14..16])*1000)
+				if (first_time_stamp == nil)
+						first_time_stamp = time_stamp
+						strOut << "application started at " << first_time_stamp.to_s << "\n" if (strOut == "")
+						strOut << "signals:\n"
+				else
+						signal_name = node.attribute("name").text
+						delta_time_seconds = time_stamp.to_i-first_time_stamp.to_i
+						delta_time_milliseconds = (time_stamp.usec/1000) - (first_time_stamp.usec/1000)
+						delta_time = delta_time_seconds*1000
+						delta_time = delta_time + delta_time_milliseconds
+						
+						#DATACOLLECTION!
+						@data[signal_name] = Array.new if @data[signal_name] == nil
+						@data[signal_name][iteration] = delta_time
+						
+						strOut << (delta_time).to_s << "\t" << signal_name << "\n"
+				end
+				index = index + 1
+		end
+	end
+	
+	# print out the list of events and signals
+	puts strOut
+	app.close
+end
+
+# Create HTML Graph Report
+def gen_html_report
+	include TDriverReportWriter
+	write_style_sheet("tdriver_report_style.css")
+	html_file = File.new(@settings[:output_filename], "w+")
+	html_file << '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+		<html xmlns="http://www.w3.org/1999/xhtml">
+		<head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta http-eqiv="cache-control" content="no-cache">
+		<link rel="stylesheet" title="TDriverReportStyle" href="tdriver_report_style.css"/>
+		<title>'+ "Application Start Performance" +'</title>
+		</head><body>'
+	html_file << insert_graph_css
+	html_file << insert_html_graph( @data, nil, nil, "500")
+	html_file << insert_html_table( @data , 500)
+	html_file << '</body></html>'
+end
+
+##################################
+## MAIN
+# Print options summary
+puts ">> Application: " + @settings[:app_name]
+puts ">> Iterations: " + @settings[:iterations].to_s
+puts ">> Signals: " + @settings[:signals].to_s
+puts ">> Events: " + @settings[:events].to_s
+
+# Connect to TDriver
+@sut = TDriver.sut( :Id => @settings[:sut_type] )
+
+# Run iterations
+@settings[:iterations].times do |iteration|
+	puts "\nITERATION " + (iteration + 1).to_s + " OF " +  @settings[:iterations].to_s
+	run(iteration)
+end
+
+# Print Summary
+puts "\nDATA Collected"
+@data.each_key do |key|
+	puts "Signal/Event: " + key.to_s + " Values: " + @data[key].join(',') 
+end
+
+# Generate HTML report
+gen_html_report
+puts "\nHTML Report created at " + @settings[:output_filename]
+
+# Disconnect from Tdriver
+@sut.disconnect

data/bin/tdriver-devtools

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path( File.join( File.dirname( __FILE__ ), '../lib/tdriver-devtools/tdriver-devtools.rb' ) )
+

data/config/sut_parameters.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. 
+## 
+############################################################################
+# Generic configuration file for sut data.
+# Can be used to provide ruby code for sut configurations.
+module SutParameters
+  # Verify blocks define the verify_always blocks that are automatically added to given sut.  
+  # Takes an array of VerifyBlock objects
+  # VerifyBlock parameters:
+  # - Proc block 
+  # - Expected return value
+  # - Error message
+  # Configured verify_always blocks will not return the failed error block code in the error message.
+  VERIFY_BLOCKS = [
+                   # Example block
+                   MobyUtil::VerifyBlock.new(
+                                             Proc.new { |sut|
+                                               # Verifies that some application is always running
+                                               sut.application.name != "qttasserver"
+                                             }, 
+                                             true, "Top most application is qttas, no application is running")                                           
+                  ]
+end
+  

data/ext/extconf.rb

@@ -0,0 +1,67 @@
+############################################################################
+## 
+## 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 File.join( File.dirname(__FILE__), '../lib/tdriver/util/loader' )
+
+MobyUtil::GemHelper.install( MobyUtil::FileHelper.tdriver_home ){ | tdriver_home_folder |
+
+  [ 
+    # default parameters & sut configuration
+    [ "../xml/defaults/*.xml",  "defaults/", true ],
+
+    # parameters
+    [ "../xml/parameters/tdriver_parameters.xml", "tdriver_parameters.xml", false ],
+    [ "../xml/parameters/tdriver_parameters.xml", "default/tdriver_parameters.xml", true ],
+    [ "../config/sut_parameters.rb", "sut_parameters.rb", true ],
+
+    # templates
+    [ "../xml/templates/*.xml",  "templates/", true ],
+    [ "../xml/templates/*.xml",  "default/templates/", true ],
+
+    # behaviours
+    [ "../xml/behaviours/*.xml",  "behaviours/", true ],
+    [ "../xml/behaviours/*.xml",  "default/behaviours/", true ],
+
+    # create logfiles fodler
+    [ nil, "logfiles/", false ]
+
+    # documentation
+    #[ "../doc/", "doc/", true ]
+
+    ].each { | task |
+
+      source, destination, overwrite = task
+
+      if source.nil?
+
+        MobyUtil::FileHelper.mkdir_path( File.join( tdriver_home_folder, destination ) ) unless MobyUtil::FileHelper.folder_exist?( File.join( tdriver_home_folder, destination ) )
+
+      else
+
+        MobyUtil::FileHelper.copy_file( source, "#{ tdriver_home_folder }/#{ destination }", false, overwrite, true )
+
+      end
+
+  }
+
+}
+
+MobyUtil::Stats.report( 'install', 'Installed gem' )
+
+sleep ( 5 ) # do not remove!!

data/ext/native_extensions.c

@@ -0,0 +1,70 @@
+/*
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+*/
+
+#include "ruby.h"
+
+static const CRC_16[ 16 ] = {
+ 
+      0x0000, 0x1081, 0x2102, 0x3183,	
+			0x4204, 0x5285, 0x6306, 0x7387,
+			0x8408, 0x9489, 0xa50a, 0xb58b,	
+			0xc60c, 0xd68d, 0xe70e, 0xf78f
+
+};
+
+static VALUE crc16_ibm( VALUE self, VALUE string ) {
+
+  // verify argument type
+  Check_Type( string, T_STRING );
+  
+  const char* data = RSTRING_PTR( string );
+  
+  int len = RSTRING_LEN( string );
+    
+  int crc = 0xffff;
+
+  int c = 0;
+
+  while( len-- != 0 ){
+
+    c = *data++;
+
+		crc = ( ( crc >> 4 ) & 0x0fff ) ^ CRC_16[ ( ( crc ^ c ) & 15 ) ];
+
+		crc = ( ( crc >> 4 ) & 0x0fff ) ^ CRC_16[ ( ( crc ^ ( c >> 4 )) & 15 ) ];
+  }
+
+
+	return INT2FIX( ~crc & 0xffff );
+
+}
+
+void Init_native_extensions() {
+
+	VALUE mTDriver = rb_define_module( "TDriver" );
+
+	VALUE mNativeExtensions = rb_define_module_under( mTDriver, "NativeExtensions" );
+
+	VALUE mCRC = rb_define_module_under( mNativeExtensions, "CRC" );
+
+	rb_define_singleton_method( mCRC, "crc16_ibm", crc16_ibm, 1 );
+
+}

data/lib/matti.rb

@@ -0,0 +1,30 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+=begin
+file, line = ( caller.first || "%s:%s" % [ __FILE__, __LINE__ ] ).split(":")
+$stderr.puts "%s:%s warning: require 'matti' deprecated, use require 'tdriver' instead also 'MATTI' is deprecated, use 'TDriver' instead " % [ file, line]
+=end
+
+$stderr.puts "%s:%s warning: require 'matti' deprecated, use require 'tdriver' instead. Please note that class 'MATTI' is also deprecated, use 'TDriver' instead " % ( caller.first || "%s:%s" % [ __FILE__, __LINE__ ] ).split(":")[ 0..1 ]
+
+# load matti resources and framework
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'tdriver/env' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'tdriver/version' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'tdriver/matti' ) )

data/lib/tdriver-devtools/behaviour/old/xml/example/flick-example.rb

@@ -0,0 +1,223 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of TDriver. 
+## 
+## 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 MobyBehaviour
+
+  module QT
+
+    # == description
+    # This module contains demonstration implementation containing tags for documentation generation using gesture as an example
+    #
+    # == behaviour
+    # QtExampleGestureBehaviour
+    #
+    # == requires
+    # testability-driver-sut-qt-plugin
+    #
+    # == input_type
+    # touch
+    #
+    # == sut_type
+    # qt
+    #
+    # == sut_version
+    # *
+    #
+    # == objects
+    # *;sut
+    #
+    module Gesture
+
+    include MobyBehaviour::QT::Behaviour
+      
+    # == description
+    # Cause a flick operation on the screen. 
+    #
+    # == arguments
+    # argument1
+    #  Integer
+    #    description:  Example argument1
+    #    example:    10
+    #    default:          
+    #  Hash
+    #    description:  Example argument 1 type 2
+    #    example:  { :optional_1 => "value_1", :optional_2 => "value_2" }
+    #    default:
+    #
+    # argument2
+    #  String
+    #    description:  Example argument2
+    #    example:    "Hello"
+    #    default:    
+    #
+    # == returns
+    # String
+    #  description:  Return value type
+    #   example:    "World"
+    # 
+    # == exceptions
+    # RuntimeError
+    #   description:  example exception
+    #
+    # ArgumentError
+    #   description:  example exception
+    #    
+    # == example
+    # flick( :Down, :Left, { :optional_1 => "value_1", :optional_2 => "value_2" } )
+    #
+    # == info
+    # See method X, table at Y
+    #
+    # == howto
+    # Example1
+    #   description: Basic use
+    #  code: @sut = TDriver.sut( :Id => "sut_qt" )
+    #    app = @sut.application
+    #    app.QPushButton( :text => "Close" ).flick :Left
+    #
+    def flick( direction, button = :Left, optional_params = {} )
+
+    begin
+          use_tap_screen = optional_params[:use_tap_screen].nil? ? MobyUtil::Parameter[ @sut.id][ :use_tap_screen, 'false'] :
+            optional_params[:use_tap_screen].to_s
+          optional_params[:useTapScreen] = use_tap_screen
+          
+          speed = calculate_speed(@sut.parameter(:gesture_flick_distance), @sut.parameter(:gesture_flick_speed))
+          distance = @sut.parameter(:gesture_flick_distance).to_i
+          params = {:gesture_type => :MouseGesture, :direction => direction, :speed => speed, :distance => distance, :isDrag => false, :button => button, :useTapScreen => use_tap_screen}
+          params.merge!(optional_params)
+     
+          do_gesture(params)    
+          do_sleep(speed)
+           
+        rescue Exception => e
+
+          MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed flick with direction \"#{direction}\", button \"#{button.to_s}\".;#{identity};flick;"
+          Kernel::raise e        
+        end      
+ 
+        MobyUtil::Logger.instance.log "behaviour" , "PASS;Operation flick executed successfully with direction \"#{direction}\", button \"#{button.to_s}\".;#{identity};flick;"
+
+        nil
+      end
+
+
+    private
+
+      # Performs the actual gesture operation. 
+      # Verifies that the parameters are correct and send the command
+      # to the sut. 
+      # gesture_type: :MouseGesture, :MouseGestureTo, :MouseGestureToCoordinates
+      # params = {:direction => :Up, duration => 2, :distance =>100, :isDrag =>false, :isMove =>false }
+      def do_gesture(params)
+          validate_gesture_params!(params)
+
+          if attribute('objectType') == 'Embedded'
+          params['x'] = center_x
+          params['y'] = center_y          
+          params['useCoordinates'] = 'true'
+          end
+
+        command = command_params #in qt_behaviour           
+        command.command_name(params[:gesture_type].to_s)
+        command.command_params( params )
+        @sut.execute_command( command )
+      end
+
+      def validate_gesture_params!(params)
+        #direction    
+        if params[:gesture_type] == :MouseGesture
+        if params[:direction].kind_of?(Integer)
+          raise ArgumentError.new( "Invalid direction." ) unless 0 <= params[:direction].to_i and params[:direction].to_i <= 360 
+        else
+          raise ArgumentError.new( "Invalid direction." ) unless @@_valid_directions.include?(params[:direction])  
+          params[:direction] = @@_direction_map[params[:direction]]
+        end
+        #distance
+        params[:distance] = params[:distance].to_i unless params[:distance].kind_of?(Integer)
+        raise ArgumentError.new( "Distance must be an integer and greater than zero." ) unless  params[:distance] > 0
+        elsif params[:gesture_type] == :MouseGestureToCoordinates
+        raise ArgumentError.new("X and Y must be integers.") unless params[:x].kind_of?(Integer) and params[:y].kind_of?(Integer)
+        elsif params[:gesture_type] == :MouseGestureTo
+        raise ArgumentError.new("targetId and targetType must be defined.") unless params[:targetId] and params[:targetType]
+        end        
+
+        #duration/speed 
+        params[:speed] = params[:speed].to_f unless params[:speed].kind_of?(Numeric)
+        raise ArgumentError.new( "Duration must be a number and greated than zero, was:" + params[:speed].to_s) unless params[:speed] > 0
+        duration_secs = params[:speed].to_f
+        duration_secs = duration_secs*1000
+        params[:speed] = duration_secs.to_i
+
+        #mouseMove true always
+        params[:mouseMove] = true
+
+        params[:button] = :Left unless params[:button]
+        raise ArgumentError.new( "Invalid button." ) unless @@_valid_buttons.include?(params[:button])
+        params[:button] = @@_buttons_map[params[:button]]
+
+        if params[:isMove] == true
+        params[:press] = 'false'
+        params[:release] = 'false'
+        end
+
+      end
+
+
+      def do_sleep(time)
+
+        if MobyUtil::Parameter[ @sut.id ][ :sleep_disabled, nil ] != 'true'
+        time = time.to_f
+        time = time * 1.3
+        #for flicks the duration of the gesture is short but animation (scroll etc..) may not
+        #so wait at least one second
+        time = 1 if time < 1  
+        sleep time
+        end
+
+      end
+
+      def calculate_speed(distance, speed)
+
+        distance = distance.to_f
+        speed = speed.to_f
+        duration = distance/speed
+        duration
+
+      end
+
+      def distance_to_point(x, y)
+
+        x = x.to_i
+        y = y.to_i
+        dist_x = x - center_x.to_i
+        dist_y = y - center_y.to_i
+
+        return 0 if dist_y == 0 and dist_x == 0     
+        distance = Math.hypot( dist_x, dist_y )
+        distance
+
+      end
+
+    end
+
+  end
+end
+
+MobyUtil::Logger.instance.hook_methods( MobyBehaviour::QT::Gesture )