testability-driver 0.9.2

data/lib/tdriver/report/report.rb

@@ -0,0 +1,47 @@
+############################################################################
+##
+## 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.expand_path( File.join( File.dirname( __FILE__ ), 'error_recovery/tdriver_error_recovery_settings' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'error_recovery/tdriver_error_recovery' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'error_recovery/tdriver_custom_error_recovery' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_file_capture' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_crash_file_capture' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_writer' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_combine' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_data_table' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_creator' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_junit_xml' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_api' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_test_run' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_test_case_run' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_cucumber' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_cucumber_listener' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_cucumber_reporter' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_rspec' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_test_unit' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_grouping' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_execution_statistics' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report_data_presentation' ) )
+
+if MobyUtil::Parameter[ :custom_error_recovery_module, nil ]!=nil
+  require MobyUtil::Parameter[ :custom_error_recovery_module ]
+end
+
+
+ 

data/lib/tdriver/report/report_api.rb

@@ -0,0 +1,207 @@
+############################################################################
+## 
+## 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 TDriverReportAPI
+
+  def tdriver_log_data(data)
+    Kernel::raise ArgumentError.new("Argument to method cannot be nil.") if data.nil?
+    if $tdriver_reporter!=nil
+      $tdriver_reporter.set_user_data(data)
+    end
+  end
+
+  def tdriver_capture_state(capture_screen_shot=true)    
+    if $tdriver_reporter
+      $new_test_case.capture_dump(capture_screen_shot) if $new_test_case
+    end
+  end
+  
+  def tdriver_log_data_in_total_run_table(column_name,value)
+    Kernel::raise ArgumentError.new("Argument to method cannot be nil.") if column_name.nil? || value.nil?
+    if $tdriver_reporter!=nil
+      $tdriver_reporter.set_user_table_data(column_name,value)
+    end
+  end
+  
+  def tdriver_report_log(message)
+  	Kernel::raise ArgumentError.new("Argument message was not a String.") unless message.nil? or message.kind_of?(String)
+    if $tdriver_reporter
+      $new_test_case.set_test_case_execution_log(message) if $new_test_case
+    end
+  end
+
+  def tdriver_report_set_test_case_status(status)
+  	Kernel::raise ArgumentError.new("Argument status was not a String.") unless status.nil? or status.kind_of?(String)
+    if $tdriver_reporter!=nil
+      $tdriver_reporter.set_test_case_user_defined_status(status)
+    end
+  end
+  def tdriver_report_total_tests_run()
+    total=0
+    if $tdriver_reporter!=nil
+      total=$tdriver_reporter.total_run
+    end
+    return total.to_i
+  end
+  def tdriver_report_total_passed_tests()
+    total=0
+    if $tdriver_reporter!=nil
+      total=$tdriver_reporter.total_passed
+    end
+    return total.to_i
+  end
+  def tdriver_report_total_failed_tests()
+    total=0
+    if $tdriver_reporter!=nil
+      total=$tdriver_reporter.total_failed
+    end
+    return total.to_i
+  end
+  def tdriver_report_total_not_run_tests()
+    total=0
+    if $tdriver_reporter!=nil
+      total=$tdriver_reporter.total_not_run
+    end
+    return total.to_i
+  end
+  def tdriver_report_folder()
+    folder=nil
+    if $tdriver_reporter!=nil
+      folder=$tdriver_reporter.report_folder
+    end
+    return folder.to_s
+  end
+  def tdriver_report_start_time()
+    start_time=nil
+    if $tdriver_reporter!=nil
+      start_time=$tdriver_reporter.start_time
+    end
+    return start_time.to_s
+  end
+  def tdriver_report_run_time()
+    run_time=nil
+    if $tdriver_reporter!=nil
+      run_time=$tdriver_reporter.run_time
+    end
+    return run_time.to_s
+  end
+  def tdriver_report_total_crash_files()
+    crash_files=0
+    if $tdriver_reporter!=nil
+      crash_files=$tdriver_reporter.total_crash_files
+    end
+    return crash_files.to_i
+  end
+  def tdriver_report_total_device_resets()
+    device_resets=0
+    if $tdriver_reporter!=nil
+      device_resets=$tdriver_reporter.total_device_resets
+    end
+    return device_resets.to_i
+  end
+  def tdriver_report_combine_reports(reports)
+    if $tdriver_reporter!=nil
+      $tdriver_reporter.combine_results(reports)
+    else
+      require 'tdriver'
+      include TDriverReportCreator
+      start_run
+      $tdriver_reporter.combine_results(reports)
+    end
+  end
+
+  #old api methods
+
+  def matti_log_data(data)
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_log_data(data)
+  end
+  def matti_report_log(message)
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+  	tdriver_report_log(message)
+  end
+  def matti_report_set_test_case_status(status)
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+  	tdriver_report_set_test_case_status(status)
+  end
+  def matti_report_total_tests_run()
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_total_tests_run()
+  end
+  def matti_report_total_passed_tests()
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_total_passed_tests()
+  end
+  def matti_report_total_failed_tests()
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_total_failed_tests()
+  end
+  def matti_report_total_not_run_tests()
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_total_not_run_tests()
+  end
+  def matti_report_folder()
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_folder()
+  end
+  def matti_report_start_time()
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_start_time()
+  end
+  def matti_report_run_time()
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_run_time()
+  end
+  def matti_report_total_crash_files()
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_total_crash_files()
+  end
+  def matti_report_total_device_resets()
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_total_device_resets()
+  end
+  def matti_report_combine_reports(reports)
+    file, line = caller.first.split(":")
+    $stderr.puts "%s:%s warning: method deprecated" % [ file, line]
+    tdriver_report_combine_reports(reports)
+  end
+  
+  
+end #TDriverReportAPI
+
+module MattiReportAPI
+
+  include TDriverReportAPI
+
+end
+
+ 

data/lib/tdriver/report/report_combine.rb

@@ -0,0 +1,86 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+
+
+
+class ReportCombine
+    #This method combines previous test results with the current test execution
+    #
+    # === params
+    # status: last run test case
+    # === returns
+    # nil
+    # === raises
+    def copy_results_from_directory(report_dir)
+      current_working_dir=Dir.getwd
+      if File::directory?(report_dir)==true
+         #FileUtils.cp_r report_dir, @report_folder
+         FileUtils.cp_r report_dir+'/cases', @report_folder
+         FileUtils.copy(report_dir+'/failed_cases.xml',@report_folder+'/failed_cases.xml') if File.exist?(report_dir+'/failed_cases.xml')
+         FileUtils.copy(report_dir+'/passed_cases.xml',@report_folder+'/passed_cases.xml') if File.exist?(report_dir+'/passed_cases.xml')
+         FileUtils.copy(report_dir+'/all_cases.xml',@report_folder+'/all_cases.xml') if File.exist?(report_dir+'/all_cases.xml')
+         FileUtils.copy(report_dir+'/not_run_cases.xml',@report_folder+'/not_run_all_cases.xml') if File.exist?(report_dir+'/not_run_cases.xml')
+      end
+      Dir.chdir(report_dir+'/cases')
+      executed_tests=Dir['*/']
+
+      @total_passed=read_result_storage('passed').count
+      @total_failed=read_result_storage('failed').count
+      @total_not_run=read_result_storage('not run').count
+      @total_run=read_result_storage('all').count
+      
+      $test_case_run_index+=executed_tests.count.to_i
+      
+      report_arr=report_dir.split( /[\/|\\]+/)      
+      #include folder in to the current run
+      @attached_test_reports << report_arr.last
+
+      Dir.chdir(current_working_dir)
+    end
+
+    #This copies and reads the previous results data
+    #
+    # === params
+    # status: last run test case
+    # === returns
+    # nil
+    # === raises
+    def extract_results_from_directory(report_dir)      
+      if File::directory?(report_dir)==true
+        copy_results_from_directory(report_dir)
+      end
+    end
+
+    #This method combines previous test results with the current test execution
+    #
+    # === params
+    # status: last run test case
+    # === returns
+    # nil
+    # === raises
+    def combine_results(reports)
+      report_locations_arr=reports.split(',')
+      report_locations_arr.each do |report_location|
+        extract_results_from_directory(report_location)
+      end
+    end
+
+end

data/lib/tdriver/report/report_crash_file_capture.rb

@@ -0,0 +1,167 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+
+
+class TDriverReportCrashFileCapture
+  include TDriverReportFileCapture
+  def initialize
+    @crash_file_locations=Array.new
+    @crash_file_suts=Array.new
+    @crash_file_names=Array.new
+    @crash_file_count=0
+    @monitor_crash_files='false'
+    read_crash_monitor_settings()
+    read_file_monitor_settings()
+  end
+
+  def return_settings_value_array(setting)
+    setting_value=setting
+    setting_arr=Array.new
+    setting_arr=setting_value.split(',')
+    setting_arr
+  end
+
+  def read_crash_monitor_settings()
+    @crash_file_locations=return_settings_value_array(MobyUtil::Parameter[ :report_crash_file_locations, nil ])
+    @crash_file_suts=return_settings_value_array(MobyUtil::Parameter[ :report_crash_file_monitored_sut_ids, nil ])
+    @crash_file_names=return_settings_value_array(MobyUtil::Parameter[ :report_crash_file_names, nil ])
+    @monitor_crash_files = MobyUtil::Parameter[ :report_crash_file_monitor, 'false' ]
+  end
+
+  def clean_crash_files_from_sut()
+    if @monitor_crash_files == 'true'
+      MobyBase::SUTFactory.instance.connected_suts.each do |sut_id, sut_attributes|
+        if sut_attributes[:is_connected]
+          @crash_file_suts.each do |monitored_sut|
+            if monitored_sut == sut_id.to_s
+              sut_crash_files=Array.new
+              sut_crash_files=list_sut_crash_files(sut_attributes[:sut])
+              sut_crash_files.each do |crash_file|
+                delete_crash_file(sut_attributes[:sut],crash_file[0])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def list_sut_crash_files(current_sut)
+    crash_file_arr=Array.new
+    @crash_file_count=0
+    #for every location:
+    @crash_file_locations.each do |location|
+          begin
+          #get file names
+          current_location_files = current_sut.ftp( :Command => :List_files, :Remote_dir => location )
+          #collect crash names and add paths
+          current_location_files.each do |sut_file|
+            if file_is_crash_file(sut_file)
+              crash_file_arr << [location.gsub("/",'\\')+'\\'+sut_file.to_s,sut_file.to_s]
+              @crash_file_count+=1
+            end
+          end
+          rescue => ex
+             #puts ex.message
+          end
+    end
+    crash_file_arr
+  end
+
+  def download_crash_file(current_sut,file_name,download_folder,download_file)
+    begin
+      current_sut.ftp( :Command => :Download, :Local_filename => download_folder+download_file, :Remote_filename => file_name )
+    rescue => ex
+       #puts ex.message
+    end
+  end
+
+  def delete_crash_file(current_sut,file_name)
+    begin
+      current_sut.ftp( :Command => :Delete, :Remote_filename => file_name )
+    rescue => ex
+       #puts ex.message
+    end
+  end
+
+  def file_is_crash_file(file_name)
+     is_crash_file=false
+     @crash_file_names.each do |crash_file_identity|
+       if file_name.to_s.include? crash_file_identity.to_s
+         is_crash_file=true
+       end
+     end
+     is_crash_file
+  end
+
+  def check_if_crash_files_exist()
+    sut_crash_files=Array.new
+    if @monitor_crash_files == 'true'
+      MobyBase::SUTFactory.instance.connected_suts.each do |sut_id, sut_attributes|
+        if sut_attributes[:is_connected]
+          @crash_file_suts.each do |monitored_sut|
+            if monitored_sut == sut_id.to_s
+              sut_crash_files << list_sut_crash_files(sut_attributes[:sut])
+            end
+          end
+        end
+      end
+      @crash_file_count
+    else
+      @crash_file_count
+    end
+  end
+
+  def download_crash_files(download_folder)
+   if @monitor_crash_files == 'true'
+      MobyBase::SUTFactory.instance.connected_suts.each do |sut_id, sut_attributes|
+        if sut_attributes[:is_connected]
+          @crash_file_suts.each do |monitored_sut|
+            if monitored_sut == sut_id.to_s
+              sut_crash_files=Array.new
+              sut_crash_files=list_sut_crash_files(sut_attributes[:sut])
+              sut_crash_files.each do |crash_file|
+                download_crash_file(sut_attributes[:sut],crash_file[0],download_folder.gsub("/",'\\')+'\\',crash_file[1])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def capture_crash_files()
+    if @monitor_crash_files == 'true'
+      begin
+        dump_folder=@test_case_folder+'/crash_files'
+        if File::directory?(dump_folder)==false
+          FileUtils.mkdir_p dump_folder
+        end
+        download_crash_files(dump_folder)
+      rescue Exception => e
+         @test_case_execution_log=@test_case_execution_log.to_s + '<br />' + "Unable to capture crash files: " + e.message
+      end
+    end
+  end
+end
+
+
+