1238106Sdes# ========================================== 2238106Sdes# Unity Project - A Test Framework for C 3238106Sdes# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams 4238106Sdes# [Released under MIT License. Please refer to license.txt for details] 5238106Sdes# ========================================== 6238106Sdes 7238106Sdes#!/usr/bin/ruby 8238106Sdes# 9238106Sdes# unity_test_summary.rb 10238106Sdes# 11238106Sdesrequire 'fileutils' 12238106Sdesrequire 'set' 13238106Sdes 14238106Sdesclass UnityTestSummary 15238106Sdes include FileUtils::Verbose 16238106Sdes 17238106Sdes attr_reader :report, :total_tests, :failures, :ignored 18238106Sdes 19238106Sdes def initialize(opts = {}) 20238106Sdes @report = '' 21238106Sdes @total_tests = 0 22238106Sdes @failures = 0 23238106Sdes @ignored = 0 24269257Sdes 25269257Sdes 26269257Sdes end 27269257Sdes 28269257Sdes def run 29269257Sdes # Clean up result file names 30269257Sdes results = @targets.map {|target| target.gsub(/\\/,'/')} 31269257Sdes 32269257Sdes # Dig through each result file, looking for details on pass/fail: 33269257Sdes failure_output = [] 34238106Sdes ignore_output = [] 35238106Sdes 36238106Sdes results.each do |result_file| 37238106Sdes lines = File.readlines(result_file).map { |line| line.chomp } 38238106Sdes if lines.length == 0 39238106Sdes raise "Empty test result file: #{result_file}" 40238106Sdes else 41238106Sdes output = get_details(result_file, lines) 42238106Sdes failure_output << output[:failures] unless output[:failures].empty? 43269257Sdes ignore_output << output[:ignores] unless output[:ignores].empty? 44238106Sdes tests,failures,ignored = parse_test_summary(lines) 45238106Sdes @total_tests += tests 46238106Sdes @failures += failures 47238106Sdes @ignored += ignored 48238106Sdes end 49238106Sdes end 50238106Sdes 51238106Sdes if @ignored > 0 52238106Sdes @report += "\n" 53238106Sdes @report += "--------------------------\n" 54238106Sdes @report += "UNITY IGNORED TEST SUMMARY\n" 55238106Sdes @report += "--------------------------\n" 56238106Sdes @report += ignore_output.flatten.join("\n") 57238106Sdes end 58238106Sdes 59291767Sdes if @failures > 0 60291767Sdes @report += "\n" 61291767Sdes @report += "--------------------------\n" 62238106Sdes @report += "UNITY FAILED TEST SUMMARY\n" 63238106Sdes @report += "--------------------------\n" 64238106Sdes @report += failure_output.flatten.join("\n") 65269257Sdes end 66238106Sdes 67269257Sdes @report += "\n" 68269257Sdes @report += "--------------------------\n" 69238106Sdes @report += "OVERALL UNITY TEST SUMMARY\n" 70238106Sdes @report += "--------------------------\n" 71269257Sdes @report += "#{@total_tests} TOTAL TESTS #{@failures} TOTAL FAILURES #{@ignored} IGNORED\n" 72238106Sdes @report += "\n" 73238106Sdes end 74238106Sdes 75238106Sdes def set_targets(target_array) 76238106Sdes @targets = target_array 77269257Sdes end 78238106Sdes 79238106Sdes def set_root_path(path) 80238106Sdes @root = path 81238106Sdes end 82238106Sdes 83238106Sdes def usage(err_msg=nil) 84238106Sdes puts "\nERROR: " 85269257Sdes puts err_msg if err_msg 86238106Sdes puts "\nUsage: unity_test_summary.rb result_file_directory/ root_path/" 87269257Sdes puts " result_file_directory - The location of your results files." 88238106Sdes puts " Defaults to current directory if not specified." 89238106Sdes puts " Should end in / if specified." 90238106Sdes puts " root_path - Helpful for producing more verbose output if using relative paths." 91238106Sdes exit 1 92269257Sdes end 93269257Sdes 94238106Sdes protected 95238106Sdes 96238106Sdes def get_details(result_file, lines) 97238106Sdes results = { :failures => [], :ignores => [], :successes => [] } 98238106Sdes lines.each do |line| 99238106Sdes src_file,src_line,test_name,status,msg = line.split(/:/) 100238106Sdes line_out = ((@root && (@root != 0)) ? "#{@root}#{line}" : line ).gsub(/\//, "\\") 101269257Sdes case(status) 102238106Sdes when 'IGNORE' then results[:ignores] << line_out 103238106Sdes when 'FAIL' then results[:failures] << line_out 104238106Sdes when 'PASS' then results[:successes] << line_out 105238106Sdes end 106238106Sdes end 107238106Sdes return results 108238106Sdes end 109238106Sdes 110238106Sdes def parse_test_summary(summary) 111238106Sdes if summary.find { |v| v =~ /(\d+) Tests (\d+) Failures (\d+) Ignored/ } 112238106Sdes [$1.to_i,$2.to_i,$3.to_i] 113238106Sdes else 114238106Sdes raise "Couldn't parse test results: #{summary}" 115238106Sdes end 116238106Sdes end 117238106Sdes 118238106Sdes def here; File.expand_path(File.dirname(__FILE__)); end 119238106Sdes 120238106Sdesend 121238106Sdes 122238106Sdesif $0 == __FILE__ 123238106Sdes 124238106Sdes #parse out the command options 125238106Sdes opts, args = ARGV.partition {|v| v =~ /^--\w+/} 126238106Sdes opts.map! {|v| v[2..-1].to_sym } 127238106Sdes 128238106Sdes #create an instance to work with 129238106Sdes uts = UnityTestSummary.new(opts) 130238106Sdes 131238106Sdes begin 132238106Sdes #look in the specified or current directory for result files 133238106Sdes args[0] ||= './' 134238106Sdes targets = "#{ARGV[0].gsub(/\\/, '/')}**/*.test*" 135238106Sdes results = Dir[targets] 136238106Sdes raise "No *.testpass, *.testfail, or *.testresults files found in '#{targets}'" if results.empty? 137238106Sdes uts.set_targets(results) 138238106Sdes 139238106Sdes #set the root path 140238106Sdes args[1] ||= Dir.pwd + '/' 141238106Sdes uts.set_root_path(ARGV[1]) 142269257Sdes 143269257Sdes #run the summarizer 144269257Sdes puts uts.run 145238106Sdes rescue Exception => e 146238106Sdes uts.usage e.message 147238106Sdes end 148238106Sdesend 149238106Sdes 150238106Sdes