testability-driver 0.9.2

data/lib/tdriver-devtools/doc/xslt/update

@@ -0,0 +1,3 @@
+ruby html.rb > output.html
+cat output.html
+

data/lib/tdriver-devtools/plugin/placeholder.txt

@@ -0,0 +1 @@
+placeholder

data/lib/tdriver-devtools/tdriver-devtools.rb

@@ -0,0 +1,404 @@
+#!/usr/bin/env ruby
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+$tdriver_devtools_initialized = true
+
+def safe_require( *paths )
+
+  found = false
+
+  paths.each{ | path |
+
+    begin
+
+      require path
+
+      found = true
+
+      break
+
+    rescue LoadError
+
+      #puts "path #{ path } not found"
+
+    end
+
+  }
+
+  abort("Unable to load one of files: %s" % paths.inspect ) unless found
+
+end
+
+require 'rubygems'
+require 'rdoc/rdoc'
+require 'optparse'
+require 'nokogiri'
+
+safe_require('tdriver/version.rb',  File.expand_path( File.join( File.dirname( __FILE__ ), '../tdriver/version.rb' ) ) )
+safe_require('tdriver/util/common/loader.rb',  File.expand_path( File.join( File.dirname( __FILE__ ), '../tdriver/util/common/loader.rb' ) ) )
+
+require 'tmpdir'
+require 'fileutils'
+
+# default options
+@options = { 
+ 
+  :verbose => false,
+  :tests => '.',
+  :delete => false
+
+}
+
+@optparse = OptionParser.new do | opts |
+
+  # Set a banner, displayed at the top of the help screen.
+  opts.banner = "Usage: #{ $0 } [options] [source] [destination]"
+
+  opts.separator( "" )
+
+  opts.separator "Specific options:"
+
+  opts.on(
+  
+    '-g', 
+    '--generate TYPE',
+      'Available types:',
+      '  doc        : Generate documentation from source files.', 
+      '               Feature test result files and images are optional',
+      ' ',
+      '               Default source folder is "behaviours/"',
+      '               Default destination file is "doc/document.xml"',
+      ' ',
+      '  behaviours : Generate behaviour XML files from implementation.',
+      '               All behaviour implementation files with .rb extension in',
+      '               source folder and its subfolders will be processed.', 
+      ' ',
+      '               Default source folder is current folder.',
+      '               Default destination folder is "behaviours/"',
+      ' ',
+      '  both       : Generate behaviour XML files and documentation',
+      '               Behaviour XML files are saved to temp. folder and deleted',
+      '               after documentation XML is saved. Copies also all XSLT ',
+      '               templates to destination folder. See -r flag also.', 
+      ' ',
+      '               Default source folder (implementation) is current folder.',
+      '               Default destination folder is "doc/document.xml"',
+      ' '
+      
+  ) do | mode |
+
+    case mode.downcase.to_s
+    
+      when 'doc'
+        @options[ :generate ] = mode.to_sym
+        @options[ :source ] ||= 'behaviours/'
+        @options[ :destination ] ||= 'doc/document.xml'
+
+      when 'behaviours'
+        @options[ :generate ] = mode.to_sym
+        @options[ :source ] ||= '.'
+        @options[ :destination ] ||= 'behaviours/'
+            
+      when 'both'
+        @options[ :generate ] = mode.to_sym
+        @options[ :source ] ||= '.'
+        @options[ :destination_behaviours ] = File.expand_path( File.join( Dir.tmpdir, "tdriver-devtools-behaviours" ) ) 
+        @options[ :destination ] ||= 'doc/document.xml'
+            
+    else
+
+      puts "Invalid value for generate option: #{ mode }", ""
+      puts opts, ""
+      exit
+      
+    end
+      
+  end
+
+=begin
+  opts.on( 
+    '-b', 
+    '--behaviours [FOLDER]', 
+    'Source folder for behaviour XML files (DOC)' 
+  ) do | folder |
+  
+  end
+=end
+
+  opts.on( 
+    '-i', 
+    '--images [FOLDER]', 
+    'Source folder for all images used in documentation' 
+  ) do | folder |
+  
+  end
+
+  opts.on( 
+    '-t', 
+    '--tests [FOLDER]', 
+    'Source folder for feature test result files', ' ' 
+  ) do | folder |
+
+    @options[ :tests ] = folder
+  
+  end
+
+=begin
+  opts.on( 
+    '-o', 
+    '--output FOLDER', 
+      'User defined destionation folder for documentation and',
+      'behaviours XML files. Default output folder is either',
+      '"doc" or "behaviours"', ' '
+       
+  ) do | folder |
+  
+  end
+=end
+
+  opts.on( 
+    '-r', 
+    '--render',
+    'Render also HTML output when generating documentation' ) do
+
+    @options[:render] = true
+
+  end
+
+  opts.on( 
+    '-d', 
+    '--delete', 
+    'Delete all existing behaviour XML files from output folder before generating new.', 
+    'Warning! Please option use this option with caution' ) do 
+    
+    @options[:delete] = true
+    
+  end
+
+  opts.separator ""
+  opts.separator "Common options:"
+
+  opts.on( '-v', '--version', 'Testability Driver version information' ) do
+
+    puts ENV['TDRIVER_VERSION']
+    exit
+
+  end
+
+  opts.on( '-V', '--verbose', 'Output more information' ) do
+
+    @options[ :verbose ] = true
+
+  end
+
+  # This displays the help screen, all programs are
+  # assumed to have this option.
+  opts.on_tail("-h", "--help", "Display this message") do
+
+    puts '', opts, ''
+    exit
+
+  end
+
+  # show help if no command line arguments given
+  if ARGV.empty? 
+  
+    puts '', opts, ''
+    exit
+    
+  end
+
+end
+
+def execute_tdriver_devtools
+
+  @optparse.parse!
+
+  case @options[ :generate ]
+
+    when :behaviours
+
+      $source = File.expand_path( ARGV[ 0 ] || @options[ :source ] )
+      $destination = File.expand_path( ARGV[ 1 ] || @options[ :destination ] )
+
+      destination_folder = File.expand_path( $destination )
+
+      if MobyUtil::FileHelper.folder_exist?( destination_folder )
+
+          if @options[ :delete ] == true
+
+            Dir.glob( File.join( destination_folder, '**', '**', '*.xml' ) ) do |entry|
+
+              begin
+              
+                File.delete( entry )
+
+              rescue Exception => exception
+              
+                warn("Unable to delete file %s (%s: %s)" % [ entry, exception.class, exception.message ] )
+              
+              end
+    
+            end
+          
+          end
+      
+      else
+          
+        begin
+
+          MobyUtil::FileHelper.mkdir_path( destination_folder )        
+
+        rescue Exception => exception
+        
+          raise RuntimeError.new("Unable to create destination folder %s (%s: %s)" % [ destination_folder, exception.class, exception.message ])
+        
+        end
+      
+      end
+
+      # run behaviour xml generator
+      require File.expand_path( File.join( File.dirname( __FILE__ ), 'behaviour/xml/generate.rb' ) )
+
+      puts ''
+
+    when :doc
+
+      $source = File.expand_path( ARGV[0] || @options[ :source ] )
+      $tests = File.expand_path( @options[ :tests ] )
+      $destination = File.expand_path( ARGV[1] || @options[ :destination ] )
+
+      destination_folder = File.dirname( $destination )
+
+      begin
+
+        unless MobyUtil::FileHelper.folder_exist?( destination_folder )
+
+          MobyUtil::FileHelper.mkdir_path( destination_folder )        
+        
+        end
+
+      rescue Exception => exception
+      
+        raise RuntimeError.new("Unable to create destination folder %s (%s: %s)" % [ destination_folder, exception.class, exception.message ])
+      
+      end
+
+      require File.expand_path( File.join( File.dirname( __FILE__ ), 'doc/generate.rb' ) ) #'lib/tdriver-devtools/behaviour/xml/generate.rb'
+
+    when :both
+    
+      destination_folder = @options[ :destination_behaviours ]
+
+      begin
+        unless MobyUtil::FileHelper.folder_exist?( destination_folder )
+          MobyUtil::FileHelper.mkdir_path( destination_folder )        
+        else
+          if @options[ :delete ] == true
+            Dir.glob( File.join( destination_folder, '*.xml' ) ) do |entry|
+              begin
+                #puts "Delete #{ entry }"
+                File.delete( entry )
+              rescue Exception => exception
+                warn("Unable to delete file %s (%s: %s)" % [ entry, exception.class, exception.message ] )
+              end
+            end
+          end
+        end
+      rescue Exception => exception
+        raise RuntimeError.new("Unable to create destination folder %s (%s: %s)" % [ destination_folder, exception.class, exception.message ])
+      end
+
+      $source = File.expand_path( ARGV[ 0 ] || @options[ :source ] )
+      $destination = destination_folder
+
+      # run 'implementation to behaviour xml' generator
+      require File.expand_path( File.join( File.dirname( __FILE__ ), 'behaviour/xml/generate.rb' ) )
+
+      # documentation
+      $source = destination_folder
+      $tests = File.expand_path( @options[ :tests ] )
+      $destination = File.expand_path( ARGV[1] || @options[ :destination ] )
+      destination_folder = File.dirname( $destination )
+
+      begin
+        unless MobyUtil::FileHelper.folder_exist?( destination_folder )
+          MobyUtil::FileHelper.mkdir_path( destination_folder )        
+        end
+      rescue Exception => exception
+        raise RuntimeError.new("Unable to create destination folder %s (%s: %s)" % [ destination_folder, exception.class, exception.message ])
+      end
+
+      require File.expand_path( File.join( File.dirname( __FILE__ ), 'doc/generate.rb' ) )
+
+      begin
+          
+        FileUtils.cp( Dir.glob( File.expand_path( File.join( File.dirname( __FILE__ ), 'doc/xslt/*.xsl' ) ) ), destination_folder )
+
+        puts "Template XSLT file(s) copied to destination folder succesfully\n\n"
+
+      rescue Exception => exception
+      
+        warn("Error while copying template xslt files to destination due to %s (%s)" % [ exception.message, exception.class ] )
+      
+      end
+
+      if @options[:render] == true
+
+        begin
+
+          doc = Nokogiri::XML( open( $destination , 'r' ).read )
+
+          puts "Generating HTML output file(s) of documentation"
+
+          Dir.glob( File.expand_path( File.join( destination_folder, '*.xsl' ) ) ) do | template |
+
+            File.open( 
+              File.join( 
+                destination_folder, 
+                "#{ File.basename( $destination ).gsub( File.extname( $destination ), '' ) }_#{ File.basename( template ).gsub( File.extname( template ), '' ) }.html" 
+              ), 
+              'w' 
+            ){ | file | 
+
+                file << Nokogiri::XSLT( open( template, 'r' ).read ).transform( doc ) 
+
+            }
+
+          end
+
+        rescue Exception => exception
+        
+          warn("Error while geneating HTML files from template(s) due to %s (%s)" % [ exception.message, exception.class ] )
+
+        end
+
+      end
+
+  else
+
+    puts '', @optparse, ''
+
+  end
+
+end
+
+execute_tdriver_devtools
+

data/lib/tdriver-devtools/tests/feature_tests/example/flick-example.rb

@@ -0,0 +1,233 @@
+############################################################################
+## 
+## 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
+      
+    attr_accessor :x
+    attr_reader :y
+    attr_writer :z
+
+    def y
+    
+    end
+
+    def x=(value)
+    end
+ 
+    # == 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, z = ',', optional_params = {}, y = ',' )
+    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 )