mirror of
https://github.com/ThrowTheSwitch/Unity.git
synced 2025-06-02 18:47:24 +08:00
4f2de8c87e
git-svn-id: http://unity.svn.sourceforge.net/svnroot/unity/trunk@99 e7d17a6e-8845-0410-bbbc-c8efb4fdad7e
278 lines
9.2 KiB
Ruby
278 lines
9.2 KiB
Ruby
# ==========================================
|
|
# Unity Project - A Test Framework for C
|
|
# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
|
# [Released under MIT License. Please refer to license.txt for details]
|
|
# ==========================================
|
|
|
|
File.expand_path(File.join(File.dirname(__FILE__),'colour_prompt'))
|
|
|
|
class UnityTestRunnerGenerator
|
|
|
|
def initialize(options = nil)
|
|
@options = { :includes => [], :plugins => [], :framework => :unity }
|
|
case(options)
|
|
when NilClass then @options
|
|
when String then @options.merge!(UnityTestRunnerGenerator.grab_config(options))
|
|
when Hash then @options.merge!(options)
|
|
else raise "If you specify arguments, it should be a filename or a hash of options"
|
|
end
|
|
end
|
|
|
|
def self.grab_config(config_file)
|
|
options = { :includes => [], :plugins => [], :framework => :unity }
|
|
unless (config_file.nil? or config_file.empty?)
|
|
require 'yaml'
|
|
yaml_guts = YAML.load_file(config_file)
|
|
options.merge!(yaml_guts[:unity] ? yaml_guts[:unity] : yaml_guts[:cmock])
|
|
raise "No :unity or :cmock section found in #{config_file}" unless options
|
|
end
|
|
return(options)
|
|
end
|
|
|
|
def run(input_file, output_file, options=nil)
|
|
tests = []
|
|
includes = []
|
|
used_mocks = []
|
|
|
|
@options.merge!(options) unless options.nil?
|
|
module_name = File.basename(input_file)
|
|
|
|
#pull required data from source file
|
|
File.open(input_file, 'r') do |input|
|
|
tests = find_tests(input)
|
|
includes = find_includes(input)
|
|
used_mocks = find_mocks(includes)
|
|
end
|
|
|
|
#build runner file
|
|
File.open(output_file, 'w') do |output|
|
|
create_header(output, used_mocks)
|
|
create_externs(output, tests, used_mocks)
|
|
create_mock_management(output, used_mocks)
|
|
create_suite_setup_and_teardown(output)
|
|
create_runtest(output, used_mocks)
|
|
create_reset(output, used_mocks)
|
|
create_main(output, input_file, tests)
|
|
end
|
|
|
|
all_files_used = [input_file, output_file]
|
|
all_files_used += includes.map {|filename| filename + '.c'} unless includes.empty?
|
|
all_files_used += @options[:includes] unless @options[:includes].empty?
|
|
return all_files_used.uniq
|
|
end
|
|
|
|
def find_tests(input_file)
|
|
tests_raw = []
|
|
tests_and_line_numbers = []
|
|
|
|
input_file.rewind
|
|
source_raw = input_file.read
|
|
source_scrubbed = source_raw.gsub(/\/\/.*$/, '') #remove line comments
|
|
source_scrubbed = source_scrubbed.gsub(/\/\*.*?\*\//m, '') #remove block comments
|
|
lines = source_scrubbed.split(/(^\s*\#.*$) # Treat preprocessor directives as a logical line
|
|
| (;|\{|\}) /x) # Match ;, {, and } as end of lines
|
|
|
|
lines.each_with_index do |line, index|
|
|
if line =~ /^\s*void\s+test(.*?)\s*\(\s*void\s*\)/
|
|
tests_raw << ("test" + $1)
|
|
end
|
|
end
|
|
|
|
source_lines = source_raw.split("\n")
|
|
source_index = 0;
|
|
|
|
tests_raw.each do |test|
|
|
source_lines[source_index..-1].each_with_index do |line, index|
|
|
if (line =~ /#{test}/)
|
|
source_index += index
|
|
tests_and_line_numbers << {:name => test, :line_number => (source_index+1)}
|
|
break
|
|
end
|
|
end
|
|
end
|
|
return tests_and_line_numbers
|
|
end
|
|
|
|
def find_includes(input_file)
|
|
input_file.rewind
|
|
includes = []
|
|
input_file.readlines.each do |line|
|
|
scan_results = line.scan(/^\s*#include\s+\"\s*(.+)\.[hH]\s*\"/)
|
|
includes << scan_results[0][0] if (scan_results.size > 0)
|
|
end
|
|
return includes
|
|
end
|
|
|
|
def find_mocks(includes)
|
|
mock_headers = []
|
|
includes.each do |include_file|
|
|
mock_headers << File.basename(include_file) if (include_file =~ /^mock/i)
|
|
end
|
|
return mock_headers
|
|
end
|
|
|
|
def create_header(output, mocks)
|
|
output.puts('/* AUTOGENERATED FILE. DO NOT EDIT. */')
|
|
output.puts("#include \"#{@options[:framework].to_s}.h\"")
|
|
output.puts('#include "cmock.h"') unless (mocks.empty?)
|
|
@options[:includes].flatten.uniq.compact.each do |includes|
|
|
output.puts("#include \"#{includes.gsub('.h','')}.h\"")
|
|
end
|
|
output.puts('#include <setjmp.h>')
|
|
output.puts('#include <stdio.h>')
|
|
output.puts('#include "CException.h"') if @options[:plugins].include?(:cexception)
|
|
mocks.each do |mock|
|
|
output.puts("#include \"#{mock.gsub('.h','')}.h\"")
|
|
end
|
|
output.puts('')
|
|
output.puts('char MessageBuffer[50];')
|
|
if @options[:enforce_strict_ordering]
|
|
output.puts('int GlobalExpectCount;')
|
|
output.puts('int GlobalVerifyOrder;')
|
|
output.puts('char* GlobalOrderError;')
|
|
end
|
|
end
|
|
|
|
|
|
def create_externs(output, tests, mocks)
|
|
output.puts('')
|
|
output.puts("extern void setUp(void);")
|
|
output.puts("extern void tearDown(void);")
|
|
output.puts('')
|
|
tests.each do |test|
|
|
output.puts("extern void #{test[:name]}(void);")
|
|
end
|
|
output.puts('')
|
|
end
|
|
|
|
|
|
def create_mock_management(output, mocks)
|
|
unless (mocks.empty?)
|
|
output.puts("static void CMock_Init(void)")
|
|
output.puts("{")
|
|
if @options[:enforce_strict_ordering]
|
|
output.puts(" GlobalExpectCount = 0;")
|
|
output.puts(" GlobalVerifyOrder = 0;")
|
|
output.puts(" GlobalOrderError = NULL;")
|
|
end
|
|
mocks.each do |mock|
|
|
output.puts(" #{mock}_Init();")
|
|
end
|
|
output.puts("}\n")
|
|
|
|
output.puts("static void CMock_Verify(void)")
|
|
output.puts("{")
|
|
mocks.each do |mock|
|
|
output.puts(" #{mock}_Verify();")
|
|
end
|
|
output.puts("}\n")
|
|
|
|
output.puts("static void CMock_Destroy(void)")
|
|
output.puts("{")
|
|
mocks.each do |mock|
|
|
output.puts(" #{mock}_Destroy();")
|
|
end
|
|
output.puts("}\n")
|
|
end
|
|
end
|
|
|
|
def create_suite_setup_and_teardown(output)
|
|
unless (@options[:suite_setup].nil?)
|
|
output.puts("static int suite_setup(void)")
|
|
output.puts("{")
|
|
output.puts(@options[:suite_setup])
|
|
output.puts("}")
|
|
end
|
|
unless (@options[:suite_teardown].nil?)
|
|
output.puts("static int suite_teardown(int num_failures)")
|
|
output.puts("{")
|
|
output.puts(@options[:suite_teardown])
|
|
output.puts("}")
|
|
end
|
|
end
|
|
|
|
def create_runtest(output, used_mocks)
|
|
cexception = @options[:plugins].include? :cexception
|
|
output.puts("static void runTest(UnityTestFunction test)")
|
|
output.puts("{")
|
|
output.puts(" if (TEST_PROTECT())")
|
|
output.puts(" {")
|
|
output.puts(" CEXCEPTION_T e;") if cexception
|
|
output.puts(" Try {") if cexception
|
|
output.puts(" CMock_Init();") unless (used_mocks.empty?)
|
|
output.puts(" setUp();")
|
|
output.puts(" test();")
|
|
output.puts(" CMock_Verify();") unless (used_mocks.empty?)
|
|
output.puts(" } Catch(e) { TEST_ASSERT_EQUAL_HEX32_MESSAGE(CEXCEPTION_NONE, e, \"Unhandled Exception!\"); }") if cexception
|
|
output.puts(" }")
|
|
output.puts(" CMock_Destroy();") unless (used_mocks.empty?)
|
|
output.puts(" if (TEST_PROTECT() && !TEST_IS_IGNORED)")
|
|
output.puts(" {")
|
|
output.puts(" tearDown();")
|
|
output.puts(" }")
|
|
output.puts("}")
|
|
end
|
|
|
|
def create_reset(output, used_mocks)
|
|
output.puts("void resetTest()")
|
|
output.puts("{")
|
|
output.puts(" CMock_Verify();") unless (used_mocks.empty?)
|
|
output.puts(" CMock_Destroy();") unless (used_mocks.empty?)
|
|
output.puts(" tearDown();")
|
|
output.puts(" CMock_Init();") unless (used_mocks.empty?)
|
|
output.puts(" setUp();")
|
|
output.puts("}")
|
|
end
|
|
|
|
def create_main(output, filename, tests)
|
|
output.puts()
|
|
output.puts()
|
|
output.puts("int main(void)")
|
|
output.puts("{")
|
|
output.puts(" suite_setup();") unless @options[:suite_setup].nil?
|
|
output.puts(" Unity.TestFile = \"#{filename}\";")
|
|
output.puts(" UnityBegin();")
|
|
output.puts()
|
|
output.puts(" // RUN_TEST calls runTest")
|
|
tests.each do |test|
|
|
output.puts(" RUN_TEST(#{test[:name]}, #{test[:line_number]});")
|
|
end
|
|
output.puts()
|
|
output.puts(" return #{@options[:suite_teardown].nil? ? "" : "suite_teardown"}(UnityEnd());")
|
|
output.puts("}")
|
|
end
|
|
end
|
|
|
|
|
|
if ($0 == __FILE__)
|
|
options = { :includes => [] }
|
|
yaml_file = nil
|
|
|
|
#parse out all the options first
|
|
ARGV.reject! do |arg|
|
|
case(arg)
|
|
when '-cexception'
|
|
options[:plugins] = [:cexception]; true
|
|
when /\w+\.yml/
|
|
options = UnityTestRunnerGenerator.grab_config(arg); true
|
|
else false
|
|
end
|
|
end
|
|
|
|
#make sure there is at least one parameter left (the input file)
|
|
if !ARGV[0]
|
|
puts ["usage: ruby #{__FILE__} (yaml) (options) input_test_file output_test_runner (includes)",
|
|
" blah.yml - will use config options in the yml file (see CMock docs)",
|
|
" -cexception - include cexception support"].join("\n")
|
|
exit 1
|
|
end
|
|
|
|
#create the default test runner name if not specified
|
|
ARGV[1] = ARGV[0].gsub(".c","_Runner.c") if (!ARGV[1])
|
|
|
|
#everything else is an include file
|
|
options[:includes] = (ARGV.slice(2..-1).flatten.compact) if (ARGV.size > 2)
|
|
|
|
UnityTestRunnerGenerator.new(options).run(ARGV[0], ARGV[1])
|
|
end
|