testability-driver 0.9.2

data/lib/tdriver/report/report_cucumber_reporter.rb

@@ -0,0 +1,335 @@
+############################################################################
+## 
+## 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__ ), 'report' ) )
+#Report module which contains the Cucumber, Test::Unit and RSpec report formatters
+begin
+module TDriverReport
+  #Class for formatting cucumber report
+  class CucumberReporter
+    include TDriverReportCreator
+    #This method initializes new test run
+    #
+    # === params
+    # === returns
+    # === raises
+    def initialize(step_mother, io, options)
+      #super(step_mother, io, options)
+      start_run()
+      @options = options
+      @current_feature_element = nil
+      @current_feature = nil
+      @tc_status=nil
+      @current_feature_group=nil
+    end
+    def after_features(features)
+        end_test_case(@current_feature_element,@tc_status)
+    end
+    #This method visits the executed cucumber step and updates the results in to TDriver report
+    #
+    # === params
+    # === returns
+    # === raises
+    def step_name(keyword, step_match, status, source_indent, background)
+      if status == :passed
+        step_name = step_match.format_args(lambda{|param| "*#{param}*"})
+        update_test_case("#{step_name} PASSED")
+        @tc_status='passed'
+      end
+      if status == :failed
+        step_name = step_match.format_args(lambda{|param| "*#{param}*"})
+        update_test_case("#{step_name} FAILED")
+        @tc_status='failed'
+      end
+      if status == :skipped
+        step_name = step_match.format_args(lambda{|param| "*#{param}*"})
+        update_test_case("#{step_name} SKIPPED")
+      end
+      if status == :undefined
+        step_name = step_match.format_args(lambda{|param| "*#{param}*"})
+        update_test_case("#{step_name} NOT RUN")
+        @tc_status='not run'
+      end
+    end
+    #This method visits the exception caused by a failed step
+    #and updates the result in to TDriver report
+    #
+    # === params
+    # === returns
+    # === raises
+    def exception(exception, status)
+      if status == :failed
+        capture_screen_test_case()
+        update_test_case(exception.message)
+        update_test_case(exception.backtrace)       
+      end
+      update_test_case('-') if status == :passed
+    end
+    #This method visits cucumber scenario name and starts a new test case when
+    #new scenario is executed
+    #and updates the result in to TDriver report
+    #
+    # === params
+    # === returns
+    # === raises
+    def scenario_name(keyword, name, file_colon_line, source_indent)
+      visit_feature_element_name(keyword, name, file_colon_line, source_indent)
+    end
+    def feature_name(keyword,name)
+      @current_feature_group=keyword + " " + name.gsub(/[:]/,' ')
+      add_report_group('Features:'+@current_feature_group+'|')
+    end
+    #This method determines when new test case needs to be started
+    #based on the scenario name info if scenario name is different then a new test case
+    #is started
+    #
+    # === params
+    # === returns
+    # === raises
+    def visit_feature_element_name(keyword, name, file_colon_line, source_indent)
+      line = %Q("#{name}")
+      @current_feature_element=line if @current_feature_element.nil?
+      unless line == @current_feature_element
+        end_test_case(@current_feature_element,@tc_status)
+        @current_feature_element=line
+      end
+      start_test_case(@current_feature_element)
+      add_test_case_group(@current_feature_group)
+      @tc_status=nil
+    end
+    #This method records the cucumber outline table results in to one test case
+    #
+    # === params
+    # === returns
+    # === raises
+    def before_outline_table(outline_table)
+     update_test_case("running outline: ")
+    end
+    #This method records the cucumber outline table results in to one test case
+    #
+    # === params
+    # === returns
+    # === raises
+    def after_table_row(table_row)
+      if table_row.exception
+        @tc_status='failed'
+        capture_screen_test_case()
+        update_test_case("#{format_table_row(table_row)} FAILED")
+        update_test_case(table_row.exception)
+      else
+        @tc_status='passed' if @tc_status==nil
+        update_test_case("#{format_table_row(table_row)} PASSED")
+      end
+    end
+    def format_table_row(row)
+      begin
+        [row.name, row.line]
+      rescue Exception => e
+        row
+      end
+    end
+    def tag_name(tag_name)
+    end
+    def comment_line(comment_line)
+    end
+    def after_tags(tags)
+    end
+    def after_feature_element(feature_element)
+    end
+    def after_background(background)
+    end
+    def before_examples_array(examples_array)
+    end
+    def examples_name(keyword, name)
+    end
+    def py_string(string)
+    end
+    def print_feature_element_name(keyword, name, file_colon_line, source_indent)
+    end
+    def before_table_row(table_row)
+        return unless @table
+        @col_index = 0
+      end
+    def table_cell_value(value, status)
+        return unless @table
+        status ||= @status || :passed
+      end
+  end
+end
+
+module MattiReport
+  #Class for formatting cucumber report
+  class CucumberReporter
+    include TDriverReportCreator
+    #This method initializes new test run
+    #
+    # === params
+    # === returns
+    # === raises
+    def initialize(step_mother, io, options)
+      file, line = caller.first.split(":")
+      $stderr.puts "%s:%s warning: MattiReport deprecated, use TDriverReport instead" % [ file, line]
+      #super(step_mother, io, options)
+      start_run()
+      @options = options
+      @current_feature_element = nil
+      @current_feature = nil
+      @tc_status=nil
+      @current_feature_group=nil
+    end
+    def after_features(features)
+        end_test_case(@current_feature_element,@tc_status)
+    end
+    #This method visits the executed cucumber step and updates the results in to TDriver report
+    #
+    # === params
+    # === returns
+    # === raises
+    def step_name(keyword, step_match, status, source_indent, background)
+      if status == :passed
+        step_name = step_match.format_args(lambda{|param| "*#{param}*"})
+        update_test_case("#{step_name} PASSED")
+        @tc_status='passed'
+      end
+      if status == :failed
+        step_name = step_match.format_args(lambda{|param| "*#{param}*"})
+        update_test_case("#{step_name} FAILED")
+        @tc_status='failed'
+      end
+      if status == :skipped
+        step_name = step_match.format_args(lambda{|param| "*#{param}*"})
+        update_test_case("#{step_name} SKIPPED")
+      end
+      if status == :undefined
+        step_name = step_match.format_args(lambda{|param| "*#{param}*"})
+        update_test_case("#{step_name} NOT RUN")
+        @tc_status='not run'
+      end
+    end
+    #This method visits the exception caused by a failed step
+    #and updates the result in to TDriver report
+    #
+    # === params
+    # === returns
+    # === raises
+    def exception(exception, status)
+      if status == :failed
+        capture_screen_test_case()
+        update_test_case(exception.message)
+        update_test_case(exception.backtrace)
+      end
+      update_test_case('-') if status == :passed
+    end
+    #This method visits cucumber scenario name and starts a new test case when
+    #new scenario is executed
+    #and updates the result in to TDriver report
+    #
+    # === params
+    # === returns
+    # === raises
+    def scenario_name(keyword, name, file_colon_line, source_indent)
+      visit_feature_element_name(keyword, name, file_colon_line, source_indent)
+    end
+    def feature_name(keyword, name)
+      @current_feature_group=keyword + " " + name      
+      add_report_group('Features:'+@current_feature_group+'|')
+    end
+    #This method determines when new test case needs to be started
+    #based on the scenario name info if scenario name is different then a new test case
+    #is started
+    #
+    # === params
+    # === returns
+    # === raises
+    def visit_feature_element_name(keyword, name, file_colon_line, source_indent)
+      line = %Q("#{name}")
+      @current_feature_element=line if @current_feature_element.nil?
+      unless line == @current_feature_element
+        end_test_case(@current_feature_element,@tc_status)
+        @current_feature_element=line
+      end
+      start_test_case(@current_feature_element)
+      add_test_case_group(@current_feature_group)
+      @tc_status=nil
+    end
+    #This method records the cucumber outline table results in to one test case
+    #
+    # === params
+    # === returns
+    # === raises
+    def before_outline_table(outline_table)
+     update_test_case("running outline: ")
+    end
+    #This method records the cucumber outline table results in to one test case
+    #
+    # === params
+    # === returns
+    # === raises
+    def after_table_row(table_row)
+      if table_row.exception
+        @tc_status='failed'
+        capture_screen_test_case()
+        update_test_case("#{format_table_row(table_row)} FAILED")
+        update_test_case(table_row.exception)
+      else
+        @tc_status='passed' if @tc_status==nil
+        update_test_case("#{format_table_row(table_row)} PASSED")
+      end
+    end
+    def format_table_row(row)
+      begin
+        [row.name, row.line]
+      rescue Exception => e
+        row
+      end
+    end
+    def tag_name(tag_name)
+    end
+    def comment_line(comment_line)
+    end
+    def after_tags(tags)
+    end
+    def after_feature_element(feature_element)
+    end
+    def after_background(background)
+    end
+    def before_examples_array(examples_array)
+    end
+    def examples_name(keyword, name)
+    end
+    def py_string(string)
+    end
+    def print_feature_element_name(keyword, name, file_colon_line, source_indent)
+    end
+    def before_table_row(table_row)
+        return unless @table
+        @col_index = 0
+      end
+    def table_cell_value(value, status)
+        return unless @table
+        status ||= @status || :passed
+      end
+  end
+end
+
+
+rescue LoadError
+
+end

data/lib/tdriver/report/report_data_presentation.rb

@@ -0,0 +1,152 @@
+############################################################################
+## 
+## 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 TDriverReportDataPresentation
+	include TDriverReportWriter
+	
+	## This method will create a .png image with a graph
+	## Arguments
+	# data:: Hash: Data to be ploted in the form of {"signal_name" => [ value 1, value 2, .., value n] , ...}
+	# filename:: String: filname for the image that will be generated. Should have .png extension
+	# title:: String: Title for the graph
+	## Returns
+	# String: String with the <img> tag to be inserted into an html file
+	## Exceptions
+	# ArgumentError: Thown when data or filname provided are either nil or the wrong types
+	def create_graph_image( data, filename, title = nil)
+		begin
+			require 'gruff'
+		rescue Exception => e
+			puts "Can't load the Gruff gem. If its missing from your system please run 'gem install gruff' to install it."
+			puts e.inspect
+		end
+		begin
+			raise ArgumentError, "ERROR create_graph_image: Data argument is either nil or not a Hash" if ( data.nil? or !data.kind_of? Hash )
+			raise ArgumentError, "ERROR create_graph_image: Values of the data Hash need to be arrays of minimum length 2" if ( !data.values[0].kind_of? Array or data.values[0].length < 2 )
+			raise ArgumentError, "ERROR create_graph_image: Filename argument is either missing or not a String" if ( filename.nil? or !filename.kind_of? String )
+			g = Gruff::Line.new
+			g.title = title unless title.nil?
+			data.each_key do |signal|
+				g.data( signal, data[signal])
+			end
+			# boring labels for now
+			#data[data.keys[0]].length.times do |i|
+			#	g.labels[i] = (i + 1).to_s
+			#end
+			g.write(filename)
+		rescue ArgumentError => e
+			puts e.message
+		end
+	end
+	
+	## This method returns an html img tag to an image with a graph of the data provided
+	## Arguments
+	# data:: Hash: Data to be ploted in the form of {"signal_name" => [ value 1, value 2, .., value n] , ...}
+	# filename:: String: filname for the image that will be generated. Should have .png extension
+	# title:: String: Title for the graph
+	# width:: String/Integer: desired width in number of pixels for the image. Defaults to "auto"
+	## Returns
+	# String: String with the <img> tag to be inserted into an html file
+	## Exceptions
+	# ArgumentError: Thown when data is either nil or the wrong types
+	def insert_html_graph( data, filename = nil , title = nil, width = nil )
+		filename = "graph.png" if filename.nil?
+		title = "Application Start Performance" if title.nil?
+		create_graph_image(data, filename, title)
+		html = "\n<img class='graph' src='#{filename}' style='width:#{ width.nil? ? 'auto' : width.to_s + 'px' }'/>\n"
+	end	
+	
+	## This method will create an html table tag with the data provided
+	## Arguments
+	# data:: Hash: Data to be ploted in the form of {"signal_name" => [ value 1, value 2, .., value n] , ...}
+	# width:: String/Integer: desired width in number of pixels for the table. Defaults to "auto"
+	## Returns
+	# String: String with the <table> tag to be inserted into an html file
+	## Exceptions
+	#
+	def insert_html_table( data, width = nil )
+		raise ArgumentError, "Data argument is either nul or not a Hash" if ( data.nil? or data.class.to_s != "Hash" )
+		html = "\n<table class='graph' style='width:#{ width.nil? ? 'auto' : width.to_s + 'px' }'>"
+		# table headers
+		( data[data.keys[0]].length + 1).times do |i|
+			html << ( i.zero? ? "\n<td class='tbl_header'>Signal/Event</td>" : "\n<td class='tbl_header'>#{i.to_s}</td>")
+		end
+		# table data
+		data.each_key do |signal|
+			html << "\n<tr>\n<td>#{signal}</td>"
+				data[signal].each do |value|
+					html << "\n<td class='tbl_body'>#{value.to_s}</td>"
+				end
+			html << "\n</tr>"
+		end
+		html << "\n</table>\n"
+	end
+
+	## This method inserts the graph specific styles
+	## Returns
+	# String: String with the <stile> tag to be added to an html page including either the graph or the table provided by this module
+	def insert_graph_css()
+		css = '
+			<style>	
+			table.graph
+			{ text-align: center;
+			font-family: Verdana;
+			font-weight: normal;
+			font-size: 11px;
+			color: #404040;
+			width: auto;
+			background-color: #fafafa;
+			border: 1px #6699CC solid;
+			border-collapse: collapse;
+			border-spacing: 0px; } 
+
+			td.tbl_header
+			{ border-bottom: 2px solid #6699CC;
+			border-left: 1px solid #6699CC;
+			background-color: #BEC8D1;
+			text-align: left;
+			text-indent: 5px;
+			font-family: Verdana;
+			font-weight: bold;
+			font-size: 11px;
+			color: #404040; }
+
+			td.tbl_body
+			{ border-bottom: 1px solid #9CF;
+			border-top: 0px;
+			border-left: 1px solid #9CF;
+			border-right: 0px;
+			text-align: left;
+			text-indent: 10px;
+			font-family: Verdana, sans-serif, Arial;
+			font-weight: normal;
+			font-size: 11px;
+			color: #404040;
+			background-color: #fafafa; }
+
+			img.graph
+			{border: 1px solid #9CF;
+			width:auto;
+			height:auto}
+			</style>
+			'
+	end
+end