espressif/Unity
1
0
Fork 0
mirror of https://github.com/ThrowTheSwitch/Unity.git synced 2025-06-20 22:13:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Starting to enforce our coding style. The first step is that we’ve pulled in Rubocop to check out Ruby syntax. There is likely a bit of customization to do yet AND there is definitely that backlog of todo’s that we just told it to ignore.

Browse Source
This commit is contained in:
Mark VanderVoord
2017-03-28 08:44:32 -04:00
parent 550d58ba2d
commit 3062c39725
18 changed files with 1414 additions and 910 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.travis.yml
View File

@ -12,7 +12,9 @@ matrix:
before_install: before_install:
- if [ "$TRAVIS_OS_NAME" == "osx" ]; then rvm install 2.1 && rvm use 2.1 && ruby -v; fi - if [ "$TRAVIS_OS_NAME" == "osx" ]; then rvm install 2.1 && rvm use 2.1 && ruby -v; fi
- if [ "$TRAVIS_OS_NAME" == "linux" ]; then sudo apt-get install --assume-yes --quiet gcc-multilib; fi - if [ "$TRAVIS_OS_NAME" == "linux" ]; then sudo apt-get install --assume-yes --quiet gcc-multilib; fi
install: gem install rspec install:
- gem install rspec
- gem install rubocop
script: script:
- cd test && rake ci - cd test && rake ci
- make -s - make -s

126
auto/colour_prompt.rb
View File

@ -4,63 +4,63 @@
# [Released under MIT License. Please refer to license.txt for details] # [Released under MIT License. Please refer to license.txt for details]
# ========================================== # ==========================================
if RUBY_PLATFORM =~/(win|w)32$/ if RUBY_PLATFORM =~ /(win|w)32$/
begin begin
require 'Win32API' require 'Win32API'
rescue LoadError rescue LoadError
puts "ERROR! \"Win32API\" library not found" puts 'ERROR! "Win32API" library not found'
puts "\"Win32API\" is required for colour on a windows machine" puts '"Win32API" is required for colour on a windows machine'
puts " try => \"gem install Win32API\" on the command line" puts ' try => "gem install Win32API" on the command line'
puts puts
end end
# puts # puts
# puts 'Windows Environment Detected...' # puts 'Windows Environment Detected...'
# puts 'Win32API Library Found.' # puts 'Win32API Library Found.'
# puts # puts
end end
class ColourCommandLine class ColourCommandLine
def initialize def initialize
if RUBY_PLATFORM =~/(win|w)32$/ if RUBY_PLATFORM =~ /(win|w)32$/
get_std_handle = Win32API.new("kernel32", "GetStdHandle", ['L'], 'L') get_std_handle = Win32API.new('kernel32', 'GetStdHandle', ['L'], 'L')
@set_console_txt_attrb = @set_console_txt_attrb =
Win32API.new("kernel32","SetConsoleTextAttribute",['L','N'], 'I') Win32API.new('kernel32', 'SetConsoleTextAttribute', %w(L N), 'I')
@hout = get_std_handle.call(-11) @hout = get_std_handle.call(-11)
end end
end end
def change_to(new_colour) def change_to(new_colour)
if RUBY_PLATFORM =~/(win|w)32$/ if RUBY_PLATFORM =~ /(win|w)32$/
@set_console_txt_attrb.call(@hout,self.win32_colour(new_colour)) @set_console_txt_attrb.call(@hout, win32_colour(new_colour))
else else
"\033[30;#{posix_colour(new_colour)};22m" "\033[30;#{posix_colour(new_colour)};22m"
end end
end end
def win32_colour(colour) def win32_colour(colour)
case colour case colour
when :black then 0 when :black then 0
when :dark_blue then 1 when :dark_blue then 1
when :dark_green then 2 when :dark_green then 2
when :dark_cyan then 3 when :dark_cyan then 3
when :dark_red then 4 when :dark_red then 4
when :dark_purple then 5 when :dark_purple then 5
when :dark_yellow, :narrative then 6 when :dark_yellow, :narrative then 6
when :default_white, :default, :dark_white then 7 when :default_white, :default, :dark_white then 7
when :silver then 8 when :silver then 8
when :blue then 9 when :blue then 9
when :green, :success then 10 when :green, :success then 10
when :cyan, :output then 11 when :cyan, :output then 11
when :red, :failure then 12 when :red, :failure then 12
when :purple then 13 when :purple then 13
when :yellow then 14 when :yellow then 14
when :white then 15 when :white then 15
else else
0 0
end end
end end
def posix_colour(colour) def posix_colour(colour)
# ANSI Escape Codes - Foreground colors # ANSI Escape Codes - Foreground colors
# | Code | Color | # | Code | Color |
# | 39 | Default foreground color | # | 39 | Default foreground color |
@ -81,35 +81,39 @@ class ColourCommandLine
# | 96 | Light cyan | # | 96 | Light cyan |
# | 97 | White | # | 97 | White |
case colour case colour
when :black then 30 when :black then 30
when :red, :failure then 31 when :red, :failure then 31
when :green, :success then 32 when :green, :success then 32
when :yellow then 33 when :yellow then 33
when :blue, :narrative then 34 when :blue, :narrative then 34
when :purple, :magenta then 35 when :purple, :magenta then 35
when :cyan, :output then 36 when :cyan, :output then 36
when :white, :default_white then 37 when :white, :default_white then 37
when :default then 39 when :default then 39
else else
39 39
end end
end end
def out_c(mode, colour, str) def out_c(mode, colour, str)
case RUBY_PLATFORM case RUBY_PLATFORM
when /(win|w)32$/ when /(win|w)32$/
change_to(colour) change_to(colour)
$stdout.puts str if mode == :puts $stdout.puts str if mode == :puts
$stdout.print str if mode == :print $stdout.print str if mode == :print
change_to(:default_white) change_to(:default_white)
else else
$stdout.puts("#{change_to(colour)}#{str}\033[0m") if mode == :puts $stdout.puts("#{change_to(colour)}#{str}\033[0m") if mode == :puts
$stdout.print("#{change_to(colour)}#{str}\033[0m") if mode == :print $stdout.print("#{change_to(colour)}#{str}\033[0m") if mode == :print
end end
end end
end # ColourCommandLine end # ColourCommandLine
def colour_puts(role,str) ColourCommandLine.new.out_c(:puts, role, str) end def colour_puts(role, str)
def colour_print(role,str) ColourCommandLine.new.out_c(:print, role, str) end ColourCommandLine.new.out_c(:puts, role, str)
end
def colour_print(role, str)
ColourCommandLine.new.out_c(:print, role, str)
end

38
auto/colour_reporter.rb
View File

@ -2,38 +2,38 @@
# Unity Project - A Test Framework for C # Unity Project - A Test Framework for C
# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams # Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
# [Released under MIT License. Please refer to license.txt for details] # [Released under MIT License. Please refer to license.txt for details]
# ========================================== # ==========================================
require "#{File.expand_path(File.dirname(__FILE__))}/colour_prompt" require "#{File.expand_path(File.dirname(__FILE__))}/colour_prompt"
$colour_output = true $colour_output = true
def report(message) def report(message)
if not $colour_output if !$colour_output
$stdout.puts(message) $stdout.puts(message)
else else
message = message.join('\n') if (message.class == Array) message = message.join('\n') if message.class == Array
message.each_line do |line| message.each_line do |line|
line.chomp! line.chomp!
colour = case(line) colour = case line
when /(?:total\s+)?tests:?\s+(\d+)\s+(?:total\s+)?failures:?\s+\d+\s+Ignored:?/i when /(?:total\s+)?tests:?\s+(\d+)\s+(?:total\s+)?failures:?\s+\d+\s+Ignored:?/i
($1.to_i == 0) ? :green : :red Regexp.last_match(1).to_i == 0 ? :green : :red
when /PASS/ when /PASS/
:green :green
when /^OK$/ when /^OK$/
:green :green
when /(?:FAIL|ERROR)/ when /(?:FAIL|ERROR)/
:red :red
when /IGNORE/ when /IGNORE/
:yellow :yellow
when /^(?:Creating|Compiling|Linking)/ when /^(?:Creating|Compiling|Linking)/
:white :white
else else
:silver :silver
end end
colour_puts(colour, line) colour_puts(colour, line)
end end
end end
$stdout.flush $stdout.flush
$stderr.flush $stderr.flush
end end

267
auto/generate_module.rb
View File

@ -12,8 +12,8 @@ require 'rubygems'
require 'fileutils' require 'fileutils'
require 'pathname' require 'pathname'
#TEMPLATE_TST # TEMPLATE_TST
TEMPLATE_TST ||= %q[#include "unity.h" TEMPLATE_TST ||= '#include "unity.h"
%2$s#include "%1$s.h" %2$s#include "%1$s.h"
void setUp(void) void setUp(void)
@ -28,115 +28,104 @@ void test_%1$s_NeedToImplement(void)
{ {
TEST_IGNORE_MESSAGE("Need to Implement %1$s"); TEST_IGNORE_MESSAGE("Need to Implement %1$s");
} }
] '.freeze
#TEMPLATE_SRC # TEMPLATE_SRC
TEMPLATE_SRC ||= %q[%2$s#include "%1$s.h" TEMPLATE_SRC ||= '%2$s#include "%1$s.h"
] '.freeze
#TEMPLATE_INC # TEMPLATE_INC
TEMPLATE_INC ||= %q[#ifndef _%3$s_H TEMPLATE_INC ||= '#ifndef _%3$s_H
#define _%3$s_H #define _%3$s_H
%2$s %2$s
#endif // _%3$s_H #endif // _%3$s_H
] '.freeze
class UnityModuleGenerator class UnityModuleGenerator
############################ ############################
def initialize(options=nil) def initialize(options = nil)
here = File.expand_path(File.dirname(__FILE__)) + '/' here = File.expand_path(File.dirname(__FILE__)) + '/'
@options = UnityModuleGenerator.default_options @options = UnityModuleGenerator.default_options
case(options) case options
when NilClass then @options when NilClass then @options
when String then @options.merge!(UnityModuleGenerator.grab_config(options)) when String then @options.merge!(UnityModuleGenerator.grab_config(options))
when Hash then @options.merge!(options) when Hash then @options.merge!(options)
else raise "If you specify arguments, it should be a filename or a hash of options" else raise 'If you specify arguments, it should be a filename or a hash of options'
end end
# Create default file paths if none were provided # Create default file paths if none were provided
@options[:path_src] = here + "../src/" if @options[:path_src].nil? @options[:path_src] = here + '../src/' if @options[:path_src].nil?
@options[:path_inc] = @options[:path_src] if @options[:path_inc].nil? @options[:path_inc] = @options[:path_src] if @options[:path_inc].nil?
@options[:path_tst] = here + "../test/" if @options[:path_tst].nil? @options[:path_tst] = here + '../test/' if @options[:path_tst].nil?
@options[:path_src] += '/' unless (@options[:path_src][-1] == 47) @options[:path_src] += '/' unless @options[:path_src][-1] == 47
@options[:path_inc] += '/' unless (@options[:path_inc][-1] == 47) @options[:path_inc] += '/' unless @options[:path_inc][-1] == 47
@options[:path_tst] += '/' unless (@options[:path_tst][-1] == 47) @options[:path_tst] += '/' unless @options[:path_tst][-1] == 47
#Built in patterns # Built in patterns
@patterns = { 'src' => {'' => { :inc => [] } }, @patterns = { 'src' => { '' => { inc: [] } },
'test'=> {'' => { :inc => [] } }, 'test' => { '' => { inc: [] } },
'dh' => {'Driver' => { :inc => [create_filename('%1$s','Hardware.h')] }, 'dh' => { 'Driver' => { inc: [create_filename('%1$s', 'Hardware.h')] },
'Hardware' => { :inc => [] } 'Hardware' => { inc: [] } },
}, 'dih' => { 'Driver' => { inc: [create_filename('%1$s', 'Hardware.h'), create_filename('%1$s', 'Interrupt.h')] },
'dih' => {'Driver' => { :inc => [create_filename('%1$s','Hardware.h'), create_filename('%1$s','Interrupt.h')] }, 'Interrupt' => { inc: [create_filename('%1$s', 'Hardware.h')] },
'Interrupt'=> { :inc => [create_filename('%1$s','Hardware.h')] }, 'Hardware' => { inc: [] } },
'Hardware' => { :inc => [] } 'mch' => { 'Model' => { inc: [] },
}, 'Conductor' => { inc: [create_filename('%1$s', 'Model.h'), create_filename('%1$s', 'Hardware.h')] },
'mch' => {'Model' => { :inc => [] }, 'Hardware' => { inc: [] } },
'Conductor'=> { :inc => [create_filename('%1$s','Model.h'), create_filename('%1$s','Hardware.h')] }, 'mvp' => { 'Model' => { inc: [] },
'Hardware' => { :inc => [] } 'Presenter' => { inc: [create_filename('%1$s', 'Model.h'), create_filename('%1$s', 'View.h')] },
}, 'View' => { inc: [] } } }
'mvp' => {'Model' => { :inc => [] },
'Presenter'=> { :inc => [create_filename('%1$s','Model.h'), create_filename('%1$s','View.h')] },
'View' => { :inc => [] }
}
}
end end
############################ ############################
def self.default_options def self.default_options
{ {
:pattern => "src", pattern: 'src',
:includes => includes: {
{ src: [],
:src => [], inc: [],
:inc => [], tst: []
:tst => [],
}, },
:update_svn => false, update_svn: false,
:boilerplates => {}, boilerplates: {},
:test_prefix => 'Test', test_prefix: 'Test',
:mock_prefix => 'Mock', mock_prefix: 'Mock'
} }
end end
############################ ############################
def self.grab_config(config_file) def self.grab_config(config_file)
options = self.default_options options = default_options
unless (config_file.nil? or config_file.empty?) unless config_file.nil? || config_file.empty?
require 'yaml' require 'yaml'
yaml_guts = YAML.load_file(config_file) yaml_guts = YAML.load_file(config_file)
options.merge!(yaml_guts[:unity] || yaml_guts[:cmock]) options.merge!(yaml_guts[:unity] || yaml_guts[:cmock])
raise "No :unity or :cmock section found in #{config_file}" unless options raise "No :unity or :cmock section found in #{config_file}" unless options
end end
return(options) options
end end
############################ ############################
def files_to_operate_on(module_name, pattern=nil) def files_to_operate_on(module_name, pattern = nil)
#strip any leading path information from the module name and save for later # strip any leading path information from the module name and save for later
subfolder = File.dirname(module_name) subfolder = File.dirname(module_name)
module_name = File.basename(module_name) module_name = File.basename(module_name)
#create triad definition # create triad definition
prefix = @options[:test_prefix] || 'Test' prefix = @options[:test_prefix] || 'Test'
triad = [ { :ext => '.c', :path => @options[:path_src], :prefix => "", :template => TEMPLATE_SRC, :inc => :src, :boilerplate => @options[:boilerplates][:src] }, triad = [{ ext: '.c', path: @options[:path_src], prefix: '', template: TEMPLATE_SRC, inc: :src, boilerplate: @options[:boilerplates][:src] },
{ :ext => '.h', :path => @options[:path_inc], :prefix => "", :template => TEMPLATE_INC, :inc => :inc, :boilerplate => @options[:boilerplates][:inc] }, { ext: '.h', path: @options[:path_inc], prefix: '', template: TEMPLATE_INC, inc: :inc, boilerplate: @options[:boilerplates][:inc] },
{ :ext => '.c', :path => @options[:path_tst], :prefix => prefix, :template => TEMPLATE_TST, :inc => :tst, :boilerplate => @options[:boilerplates][:tst] }, { ext: '.c', path: @options[:path_tst], prefix: prefix, template: TEMPLATE_TST, inc: :tst, boilerplate: @options[:boilerplates][:tst] }]
]
#prepare the pattern for use # prepare the pattern for use
pattern = (pattern || @options[:pattern] || 'src').downcase pattern = (pattern || @options[:pattern] || 'src').downcase
patterns = @patterns[pattern] patterns = @patterns[pattern]
raise "ERROR: The design pattern '#{pattern}' specified isn't one that I recognize!" if patterns.nil? raise "ERROR: The design pattern '#{pattern}' specified isn't one that I recognize!" if patterns.nil?
#single file patterns (currently just 'test') can reject the other parts of the triad # single file patterns (currently just 'test') can reject the other parts of the triad
if (pattern == 'test') triad.select! { |v| v[:inc] == :tst } if pattern == 'test'
triad.reject!{|v| v[:inc] != :tst }
end
# Assemble the path/names of the files we need to work with. # Assemble the path/names of the files we need to work with.
files = [] files = []
@ -145,26 +134,26 @@ class UnityModuleGenerator
submodule_name = create_filename(module_name, pattern_file) submodule_name = create_filename(module_name, pattern_file)
filename = cfg[:prefix] + submodule_name + cfg[:ext] filename = cfg[:prefix] + submodule_name + cfg[:ext]
files << { files << {
:path => (Pathname.new("#{cfg[:path]}#{subfolder}") + filename).cleanpath, path: (Pathname.new("#{cfg[:path]}#{subfolder}") + filename).cleanpath,
:name => submodule_name, name: submodule_name,
:template => cfg[:template], template: cfg[:template],
:boilerplate => cfg[:boilerplate], boilerplate: cfg[:boilerplate],
:includes => case(cfg[:inc]) includes: case (cfg[:inc])
when :src then (@options[:includes][:src] || []) | pattern_traits[:inc].map{|f| f % [module_name]} when :src then (@options[:includes][:src] || []) | pattern_traits[:inc].map { |f| f % [module_name] }
when :inc then (@options[:includes][:inc] || []) when :inc then (@options[:includes][:inc] || [])
when :tst then (@options[:includes][:tst] || []) | pattern_traits[:inc].map{|f| "#{@options[:mock_prefix]}#{f}" % [module_name]} when :tst then (@options[:includes][:tst] || []) | pattern_traits[:inc].map { |f| "#{@options[:mock_prefix]}#{f}" % [module_name] }
end end
} }
end end
end end
return files files
end end
############################ ############################
def create_filename(part1, part2="") def create_filename(part1, part2 = '')
if part2.empty? if part2.empty?
case(@options[:naming]) case (@options[:naming])
when 'bumpy' then part1 when 'bumpy' then part1
when 'camel' then part1 when 'camel' then part1
when 'snake' then part1.downcase when 'snake' then part1.downcase
@ -172,49 +161,45 @@ class UnityModuleGenerator
else part1.downcase else part1.downcase
end end
else else
case(@options[:naming]) case (@options[:naming])
when 'bumpy' then part1 + part2 when 'bumpy' then part1 + part2
when 'camel' then part1 + part2 when 'camel' then part1 + part2
when 'snake' then part1.downcase + "_" + part2.downcase when 'snake' then part1.downcase + '_' + part2.downcase
when 'caps' then part1.upcase + "_" + part2.upcase when 'caps' then part1.upcase + '_' + part2.upcase
else part1.downcase + "_" + part2.downcase else part1.downcase + '_' + part2.downcase
end end
end end
end end
############################ ############################
def generate(module_name, pattern=nil) def generate(module_name, pattern = nil)
files = files_to_operate_on(module_name, pattern) files = files_to_operate_on(module_name, pattern)
#Abort if all of the module files already exist # Abort if all of the module files already exist
all_files_exist = true all_files_exist = true
files.each do |file| files.each do |file|
if not File.exist?(file[:path]) all_files_exist = false unless File.exist?(file[:path])
all_files_exist = false
end
end end
raise "ERROR: File #{files[0][:name]} already exists. Exiting." if all_files_exist raise "ERROR: File #{files[0][:name]} already exists. Exiting." if all_files_exist
# Create Source Modules # Create Source Modules
files.each_with_index do |file, i| files.each_with_index do |file, _i|
# If this file already exists, don't overwrite it. # If this file already exists, don't overwrite it.
if File.exist?(file[:path]) if File.exist?(file[:path])
puts "File #{file[:path]} already exists!" puts "File #{file[:path]} already exists!"
next next
end end
# Create the path first if necessary. # Create the path first if necessary.
FileUtils.mkdir_p(File.dirname(file[:path]), :verbose => false) FileUtils.mkdir_p(File.dirname(file[:path]), verbose: false)
File.open(file[:path], 'w') do |f| File.open(file[:path], 'w') do |f|
f.write("#{file[:boilerplate]}\n" % [file[:name]]) unless file[:boilerplate].nil? f.write("#{file[:boilerplate]}\n" % [file[:name]]) unless file[:boilerplate].nil?
f.write(file[:template] % [ file[:name], f.write(file[:template] % [file[:name],
file[:includes].map{|f| "#include \"#{f}\"\n"}.join, file[:includes].map { |f| "#include \"#{f}\"\n" }.join,
file[:name].upcase ] file[:name].upcase])
)
end end
if (@options[:update_svn]) if @options[:update_svn]
`svn add \"#{file[:path]}\"` `svn add \"#{file[:path]}\"`
if $?.exitstatus == 0 if $CHILD_STATUS.exitstatus == 0
puts "File #{file[:path]} created and added to source control" puts "File #{file[:path]} created and added to source control"
else else
puts "File #{file[:path]} created but FAILED adding to source control!" puts "File #{file[:path]} created but FAILED adding to source control!"
@ -227,8 +212,7 @@ class UnityModuleGenerator
end end
############################ ############################
def destroy(module_name, pattern=nil) def destroy(module_name, pattern = nil)
files_to_operate_on(module_name, pattern).each do |filespec| files_to_operate_on(module_name, pattern).each do |filespec|
file = filespec[:path] file = filespec[:path]
if File.exist?(file) if File.exist?(file)
@ -243,66 +227,65 @@ class UnityModuleGenerator
puts "File #{file} does not exist so cannot be removed." puts "File #{file} does not exist so cannot be removed."
end end
end end
puts "Destroy Complete" puts 'Destroy Complete'
end end
end end
############################ ############################
#Handle As Command Line If Called That Way # Handle As Command Line If Called That Way
if ($0 == __FILE__) if $PROGRAM_NAME == __FILE__
destroy = false destroy = false
options = { } options = {}
module_name = nil module_name = nil
# Parse the command line parameters. # Parse the command line parameters.
ARGV.each do |arg| ARGV.each do |arg|
case(arg) case arg
when /^-d/ then destroy = true when /^-d/ then destroy = true
when /^-u/ then options[:update_svn] = true when /^-u/ then options[:update_svn] = true
when /^-p\"?(\w+)\"?/ then options[:pattern] = $1 when /^-p\"?(\w+)\"?/ then options[:pattern] = Regexp.last_match(1)
when /^-s\"?(.+)\"?/ then options[:path_src] = $1 when /^-s\"?(.+)\"?/ then options[:path_src] = Regexp.last_match(1)
when /^-i\"?(.+)\"?/ then options[:path_inc] = $1 when /^-i\"?(.+)\"?/ then options[:path_inc] = Regexp.last_match(1)
when /^-t\"?(.+)\"?/ then options[:path_tst] = $1 when /^-t\"?(.+)\"?/ then options[:path_tst] = Regexp.last_match(1)
when /^-n\"?(.+)\"?/ then options[:naming] = $1 when /^-n\"?(.+)\"?/ then options[:naming] = Regexp.last_match(1)
when /^-y\"?(.+)\"?/ then options = UnityModuleGenerator.grab_config($1) when /^-y\"?(.+)\"?/ then options = UnityModuleGenerator.grab_config(Regexp.last_match(1))
when /^(\w+)/ when /^(\w+)/
raise "ERROR: You can't have more than one Module name specified!" unless module_name.nil? raise "ERROR: You can't have more than one Module name specified!" unless module_name.nil?
module_name = arg module_name = arg
when /^-(h|-help)/ when /^-(h|-help)/
ARGV = [] ARGV = [].freeze
else else
raise "ERROR: Unknown option specified '#{arg}'" raise "ERROR: Unknown option specified '#{arg}'"
end end
end end
if (!ARGV[0]) unless ARGV[0]
puts [ "\nGENERATE MODULE\n-------- ------", puts ["\nGENERATE MODULE\n-------- ------",
"\nUsage: ruby generate_module [options] module_name", "\nUsage: ruby generate_module [options] module_name",
" -i\"include\" sets the path to output headers to 'include' (DEFAULT ../src)", " -i\"include\" sets the path to output headers to 'include' (DEFAULT ../src)",
" -s\"../src\" sets the path to output source to '../src' (DEFAULT ../src)", " -s\"../src\" sets the path to output source to '../src' (DEFAULT ../src)",
" -t\"C:/test\" sets the path to output source to 'C:/test' (DEFAULT ../test)", " -t\"C:/test\" sets the path to output source to 'C:/test' (DEFAULT ../test)",
" -p\"MCH\" sets the output pattern to MCH.", ' -p"MCH" sets the output pattern to MCH.',
" dh - driver hardware.", ' dh - driver hardware.',
" dih - driver interrupt hardware.", ' dih - driver interrupt hardware.',
" mch - model conductor hardware.", ' mch - model conductor hardware.',
" mvp - model view presenter.", ' mvp - model view presenter.',
" src - just a source module, header and test. (DEFAULT)", ' src - just a source module, header and test. (DEFAULT)',
" test - just a test file.", ' test - just a test file.',
" -d destroy module instead of creating it.", ' -d destroy module instead of creating it.',
" -n\"camel\" sets the file naming convention.", ' -n"camel" sets the file naming convention.',
" bumpy - BumpyCaseFilenames.", ' bumpy - BumpyCaseFilenames.',
" camel - camelCaseFilenames.", ' camel - camelCaseFilenames.',
" snake - snake_case_filenames. (DEFAULT)", ' snake - snake_case_filenames. (DEFAULT)',
" caps - CAPS_CASE_FILENAMES.", ' caps - CAPS_CASE_FILENAMES.',
" -u update subversion too (requires subversion command line)", ' -u update subversion too (requires subversion command line)',
" -y\"my.yml\" selects a different yaml config file for module generation", ' -y"my.yml" selects a different yaml config file for module generation',
"" ].join("\n") ''].join("\n")
exit exit
end end
raise "ERROR: You must have a Module name specified! (use option -h for help)" if module_name.nil? raise 'ERROR: You must have a Module name specified! (use option -h for help)' if module_name.nil?
if (destroy) if destroy
UnityModuleGenerator.new(options).destroy(module_name) UnityModuleGenerator.new(options).destroy(module_name)
else else
UnityModuleGenerator.new(options).generate(module_name) UnityModuleGenerator.new(options).generate(module_name)

371
auto/generate_test_runner.rb
View File

@ -4,50 +4,49 @@
# [Released under MIT License. Please refer to license.txt for details] # [Released under MIT License. Please refer to license.txt for details]
# ========================================== # ==========================================
File.expand_path(File.join(File.dirname(__FILE__),'colour_prompt')) File.expand_path(File.join(File.dirname(__FILE__), 'colour_prompt'))
class UnityTestRunnerGenerator class UnityTestRunnerGenerator
def initialize(options = nil) def initialize(options = nil)
@options = UnityTestRunnerGenerator.default_options @options = UnityTestRunnerGenerator.default_options
case(options) case (options)
when NilClass then @options when NilClass then @options
when String then @options.merge!(UnityTestRunnerGenerator.grab_config(options)) when String then @options.merge!(UnityTestRunnerGenerator.grab_config(options))
when Hash then @options.merge!(options) when Hash then @options.merge!(options)
else raise "If you specify arguments, it should be a filename or a hash of options" else raise 'If you specify arguments, it should be a filename or a hash of options'
end end
require "#{File.expand_path(File.dirname(__FILE__))}/type_sanitizer" require "#{File.expand_path(File.dirname(__FILE__))}/type_sanitizer"
end end
def self.default_options def self.default_options
{ {
:includes => [], includes: [],
:defines => [], defines: [],
:plugins => [], plugins: [],
:framework => :unity, framework: :unity,
:test_prefix => "test|spec|should", test_prefix: 'test|spec|should',
:mock_prefix => "Mock", mock_prefix: 'Mock',
:setup_name => "setUp", setup_name: 'setUp',
:teardown_name => "tearDown", teardown_name: 'tearDown',
:main_name => "main", #set to :auto to automatically generate each time main_name: 'main', # set to :auto to automatically generate each time
:main_export_decl => "", main_export_decl: '',
:cmdline_args => false, cmdline_args: false,
:use_param_tests => false, use_param_tests: false
} }
end end
def self.grab_config(config_file) def self.grab_config(config_file)
options = self.default_options options = default_options
unless (config_file.nil? or config_file.empty?) unless config_file.nil? || config_file.empty?
require 'yaml' require 'yaml'
yaml_guts = YAML.load_file(config_file) yaml_guts = YAML.load_file(config_file)
options.merge!(yaml_guts[:unity] || yaml_guts[:cmock]) options.merge!(yaml_guts[:unity] || yaml_guts[:cmock])
raise "No :unity or :cmock section found in #{config_file}" unless options raise "No :unity or :cmock section found in #{config_file}" unless options
end end
return(options) (options)
end end
def run(input_file, output_file, options=nil) def run(input_file, output_file, options = nil)
tests = [] tests = []
testfile_includes = [] testfile_includes = []
used_mocks = [] used_mocks = []
@ -55,25 +54,25 @@ class UnityTestRunnerGenerator
@options.merge!(options) unless options.nil? @options.merge!(options) unless options.nil?
module_name = File.basename(input_file) module_name = File.basename(input_file)
#pull required data from source file # pull required data from source file
source = File.read(input_file) source = File.read(input_file)
source = source.force_encoding("ISO-8859-1").encode("utf-8", :replace => nil) source = source.force_encoding('ISO-8859-1').encode('utf-8', replace: nil)
tests = find_tests(source) tests = find_tests(source)
headers = find_includes(source) headers = find_includes(source)
testfile_includes = (headers[:local] + headers[:system]) testfile_includes = (headers[:local] + headers[:system])
used_mocks = find_mocks(testfile_includes) used_mocks = find_mocks(testfile_includes)
testfile_includes = (testfile_includes - used_mocks) testfile_includes = (testfile_includes - used_mocks)
testfile_includes.delete_if{|inc| inc =~ /(unity|cmock)/} testfile_includes.delete_if { |inc| inc =~ /(unity|cmock)/ }
#build runner file # build runner file
generate(input_file, output_file, tests, used_mocks, testfile_includes) generate(input_file, output_file, tests, used_mocks, testfile_includes)
#determine which files were used to return them # determine which files were used to return them
all_files_used = [input_file, output_file] all_files_used = [input_file, output_file]
all_files_used += testfile_includes.map {|filename| filename + '.c'} unless testfile_includes.empty? all_files_used += testfile_includes.map { |filename| filename + '.c' } unless testfile_includes.empty?
all_files_used += @options[:includes] unless @options[:includes].empty? all_files_used += @options[:includes] unless @options[:includes].empty?
all_files_used += headers[:linkonly] unless headers[:linkonly].empty? all_files_used += headers[:linkonly] unless headers[:linkonly].empty?
return all_files_used.uniq all_files_used.uniq
end end
def generate(input_file, output_file, tests, used_mocks, testfile_includes) def generate(input_file, output_file, tests, used_mocks, testfile_includes)
@ -86,7 +85,7 @@ class UnityTestRunnerGenerator
create_main(output, input_file, tests, used_mocks) create_main(output, input_file, tests, used_mocks)
end end
if (@options[:header_file] && !@options[:header_file].empty?) if @options[:header_file] && !@options[:header_file].empty?
File.open(@options[:header_file], 'w') do |output| File.open(@options[:header_file], 'w') do |output|
create_h_file(output, @options[:header_file], tests, testfile_includes, used_mocks) create_h_file(output, @options[:header_file], tests, testfile_includes, used_mocks)
end end
@ -97,93 +96,90 @@ class UnityTestRunnerGenerator
tests_and_line_numbers = [] tests_and_line_numbers = []
source_scrubbed = source.clone source_scrubbed = source.clone
source_scrubbed = source_scrubbed.gsub(/"[^"\n]*"/, '') # remove things in strings source_scrubbed = source_scrubbed.gsub(/"[^"\n]*"/, '') # remove things in strings
source_scrubbed = source_scrubbed.gsub(/\/\/.*$/, '') # remove line comments source_scrubbed = source_scrubbed.gsub(/\/\/.*$/, '') # remove line comments
source_scrubbed = source_scrubbed.gsub(/\/\*.*?\*\//m, '') # remove block comments source_scrubbed = source_scrubbed.gsub(/\/\*.*?\*\//m, '') # remove block comments
lines = source_scrubbed.split(/(^\s*\#.*$) # Treat preprocessor directives as a logical line lines = source_scrubbed.split(/(^\s*\#.*$) # Treat preprocessor directives as a logical line
| (;|\{|\}) /x) # Match ;, {, and } as end of lines | (;|\{|\}) /x) # Match ;, {, and } as end of lines
lines.each_with_index do |line, index| lines.each_with_index do |line, _index|
#find tests # find tests
if line =~ /^((?:\s*TEST_CASE\s*\(.*?\)\s*)*)\s*void\s+((?:#{@options[:test_prefix]}).*)\s*\(\s*(.*)\s*\)/ next unless line =~ /^((?:\s*TEST_CASE\s*\(.*?\)\s*)*)\s*void\s+((?:#{@options[:test_prefix]}).*)\s*\(\s*(.*)\s*\)/
arguments = $1 arguments = Regexp.last_match(1)
name = $2 name = Regexp.last_match(2)
call = $3 call = Regexp.last_match(3)
params = $4 params = Regexp.last_match(4)
args = nil args = nil
if (@options[:use_param_tests] and !arguments.empty?) if @options[:use_param_tests] && !arguments.empty?
args = [] args = []
arguments.scan(/\s*TEST_CASE\s*\((.*)\)\s*$/) {|a| args << a[0]} arguments.scan(/\s*TEST_CASE\s*\((.*)\)\s*$/) { |a| args << a[0] }
end
tests_and_line_numbers << { :test => name, :args => args, :call => call, :params => params, :line_number => 0 }
end end
tests_and_line_numbers << { test: name, args: args, call: call, params: params, line_number: 0 }
end end
tests_and_line_numbers.uniq! {|v| v[:test] } tests_and_line_numbers.uniq! { |v| v[:test] }
#determine line numbers and create tests to run # determine line numbers and create tests to run
source_lines = source.split("\n") source_lines = source.split("\n")
source_index = 0; source_index = 0
tests_and_line_numbers.size.times do |i| tests_and_line_numbers.size.times do |i|
source_lines[source_index..-1].each_with_index do |line, index| source_lines[source_index..-1].each_with_index do |line, index|
if (line =~ /#{tests_and_line_numbers[i][:test]}/) next unless (line =~ /#{tests_and_line_numbers[i][:test]}/)
source_index += index source_index += index
tests_and_line_numbers[i][:line_number] = source_index + 1 tests_and_line_numbers[i][:line_number] = source_index + 1
break break
end
end end
end end
return tests_and_line_numbers tests_and_line_numbers
end end
def find_includes(source) def find_includes(source)
# remove comments (block and line, in three steps to ensure correct precedence)
#remove comments (block and line, in three steps to ensure correct precedence)
source.gsub!(/\/\/(?:.+\/\*|\*(?:$|[^\/])).*$/, '') # remove line comments that comment out the start of blocks source.gsub!(/\/\/(?:.+\/\*|\*(?:$|[^\/])).*$/, '') # remove line comments that comment out the start of blocks
source.gsub!(/\/\*.*?\*\//m, '') # remove block comments source.gsub!(/\/\*.*?\*\//m, '') # remove block comments
source.gsub!(/\/\/.*$/, '') # remove line comments (all that remain) source.gsub!(/\/\/.*$/, '') # remove line comments (all that remain)
#parse out includes # parse out includes
includes = { includes = {
:local => source.scan(/^\s*#include\s+\"\s*(.+)\.[hH]\s*\"/).flatten, local: source.scan(/^\s*#include\s+\"\s*(.+)\.[hH]\s*\"/).flatten,
:system => source.scan(/^\s*#include\s+<\s*(.+)\s*>/).flatten.map { |inc| "<#{inc}>" }, system: source.scan(/^\s*#include\s+<\s*(.+)\s*>/).flatten.map { |inc| "<#{inc}>" },
:linkonly => source.scan(/^TEST_FILE\(\s*\"\s*(.+)\.[cC]\w*\s*\"/).flatten linkonly: source.scan(/^TEST_FILE\(\s*\"\s*(.+)\.[cC]\w*\s*\"/).flatten
} }
return includes includes
end end
def find_mocks(includes) def find_mocks(includes)
mock_headers = [] mock_headers = []
includes.each do |include_path| includes.each do |include_path|
include_file = File.basename(include_path) include_file = File.basename(include_path)
mock_headers << include_path if (include_file =~ /^#{@options[:mock_prefix]}/i) mock_headers << include_path if include_file =~ /^#{@options[:mock_prefix]}/i
end end
return mock_headers mock_headers
end end
def create_header(output, mocks, testfile_includes=[]) def create_header(output, mocks, testfile_includes = [])
output.puts('/* AUTOGENERATED FILE. DO NOT EDIT. */') output.puts('/* AUTOGENERATED FILE. DO NOT EDIT. */')
create_runtest(output, mocks) create_runtest(output, mocks)
output.puts("\n/*=======Automagically Detected Files To Include=====*/") output.puts("\n/*=======Automagically Detected Files To Include=====*/")
output.puts("#include \"#{@options[:framework].to_s}.h\"") output.puts("#include \"#{@options[:framework]}.h\"")
output.puts('#include "cmock.h"') unless (mocks.empty?) output.puts('#include "cmock.h"') unless mocks.empty?
output.puts('#include <setjmp.h>') output.puts('#include <setjmp.h>')
output.puts('#include <stdio.h>') output.puts('#include <stdio.h>')
if (@options[:defines] && !@options[:defines].empty?) if @options[:defines] && !@options[:defines].empty?
@options[:defines].each {|d| output.puts("#define #{d}")} @options[:defines].each { |d| output.puts("#define #{d}") }
end end
if (@options[:header_file] && !@options[:header_file].empty?) if @options[:header_file] && !@options[:header_file].empty?
output.puts("#include \"#{File.basename(@options[:header_file])}\"") output.puts("#include \"#{File.basename(@options[:header_file])}\"")
else else
@options[:includes].flatten.uniq.compact.each do |inc| @options[:includes].flatten.uniq.compact.each do |inc|
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h','')}.h\""}") output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h', '')}.h\""}")
end end
testfile_includes.each do |inc| testfile_includes.each do |inc|
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h','')}.h\""}") output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h', '')}.h\""}")
end end
end end
mocks.each do |mock| mocks.each do |mock|
output.puts("#include \"#{mock.gsub('.h','')}.h\"") output.puts("#include \"#{mock.gsub('.h', '')}.h\"")
end end
output.puts('#include "CException.h"') if @options[:plugins].include?(:cexception) output.puts('#include "CException.h"') if @options[:plugins].include?(:cexception)
if @options[:enforce_strict_ordering] if @options[:enforce_strict_ordering]
@ -194,7 +190,7 @@ class UnityTestRunnerGenerator
end end
end end
def create_externs(output, tests, mocks) def create_externs(output, tests, _mocks)
output.puts("\n/*=======External Functions This Runner Calls=====*/") output.puts("\n/*=======External Functions This Runner Calls=====*/")
output.puts("extern void #{@options[:setup_name]}(void);") output.puts("extern void #{@options[:setup_name]}(void);")
output.puts("extern void #{@options[:teardown_name]}(void);") output.puts("extern void #{@options[:teardown_name]}(void);")
@ -205,32 +201,32 @@ class UnityTestRunnerGenerator
end end
def create_mock_management(output, mock_headers) def create_mock_management(output, mock_headers)
unless (mock_headers.empty?) unless mock_headers.empty?
output.puts("\n/*=======Mock Management=====*/") output.puts("\n/*=======Mock Management=====*/")
output.puts("static void CMock_Init(void)") output.puts('static void CMock_Init(void)')
output.puts("{") output.puts('{')
if @options[:enforce_strict_ordering] if @options[:enforce_strict_ordering]
output.puts(" GlobalExpectCount = 0;") output.puts(' GlobalExpectCount = 0;')
output.puts(" GlobalVerifyOrder = 0;") output.puts(' GlobalVerifyOrder = 0;')
output.puts(" GlobalOrderError = NULL;") output.puts(' GlobalOrderError = NULL;')
end end
mocks = mock_headers.map {|mock| File.basename(mock)} mocks = mock_headers.map { |mock| File.basename(mock) }
mocks.each do |mock| mocks.each do |mock|
mock_clean = TypeSanitizer.sanitize_c_identifier(mock) mock_clean = TypeSanitizer.sanitize_c_identifier(mock)
output.puts(" #{mock_clean}_Init();") output.puts(" #{mock_clean}_Init();")
end end
output.puts("}\n") output.puts("}\n")
output.puts("static void CMock_Verify(void)") output.puts('static void CMock_Verify(void)')
output.puts("{") output.puts('{')
mocks.each do |mock| mocks.each do |mock|
mock_clean = TypeSanitizer.sanitize_c_identifier(mock) mock_clean = TypeSanitizer.sanitize_c_identifier(mock)
output.puts(" #{mock_clean}_Verify();") output.puts(" #{mock_clean}_Verify();")
end end
output.puts("}\n") output.puts("}\n")
output.puts("static void CMock_Destroy(void)") output.puts('static void CMock_Destroy(void)')
output.puts("{") output.puts('{')
mocks.each do |mock| mocks.each do |mock|
mock_clean = TypeSanitizer.sanitize_c_identifier(mock) mock_clean = TypeSanitizer.sanitize_c_identifier(mock)
output.puts(" #{mock_clean}_Destroy();") output.puts(" #{mock_clean}_Destroy();")
@ -240,19 +236,19 @@ class UnityTestRunnerGenerator
end end
def create_suite_setup_and_teardown(output) def create_suite_setup_and_teardown(output)
unless (@options[:suite_setup].nil?) unless @options[:suite_setup].nil?
output.puts("\n/*=======Suite Setup=====*/") output.puts("\n/*=======Suite Setup=====*/")
output.puts("static void suite_setup(void)") output.puts('static void suite_setup(void)')
output.puts("{") output.puts('{')
output.puts(@options[:suite_setup]) output.puts(@options[:suite_setup])
output.puts("}") output.puts('}')
end end
unless (@options[:suite_teardown].nil?) unless @options[:suite_teardown].nil?
output.puts("\n/*=======Suite Teardown=====*/") output.puts("\n/*=======Suite Teardown=====*/")
output.puts("static int suite_teardown(int num_failures)") output.puts('static int suite_teardown(int num_failures)')
output.puts("{") output.puts('{')
output.puts(@options[:suite_teardown]) output.puts(@options[:suite_teardown])
output.puts("}") output.puts('}')
end end
end end
@ -261,124 +257,124 @@ class UnityTestRunnerGenerator
va_args1 = @options[:use_param_tests] ? ', ...' : '' va_args1 = @options[:use_param_tests] ? ', ...' : ''
va_args2 = @options[:use_param_tests] ? '__VA_ARGS__' : '' va_args2 = @options[:use_param_tests] ? '__VA_ARGS__' : ''
output.puts("\n/*=======Test Runner Used To Run Each Test Below=====*/") output.puts("\n/*=======Test Runner Used To Run Each Test Below=====*/")
output.puts("#define RUN_TEST_NO_ARGS") if @options[:use_param_tests] output.puts('#define RUN_TEST_NO_ARGS') if @options[:use_param_tests]
output.puts("#define RUN_TEST(TestFunc, TestLineNum#{va_args1}) \\") output.puts("#define RUN_TEST(TestFunc, TestLineNum#{va_args1}) \\")
output.puts("{ \\") output.puts('{ \\')
output.puts(" Unity.CurrentTestName = #TestFunc#{va_args2.empty? ? '' : " \"(\" ##{va_args2} \")\""}; \\") output.puts(" Unity.CurrentTestName = #TestFunc#{va_args2.empty? ? '' : " \"(\" ##{va_args2} \")\""}; \\")
output.puts(" Unity.CurrentTestLineNumber = TestLineNum; \\") output.puts(' Unity.CurrentTestLineNumber = TestLineNum; \\')
output.puts(" if (UnityTestMatches()) { \\") if (@options[:cmdline_args]) output.puts(' if (UnityTestMatches()) { \\') if @options[:cmdline_args]
output.puts(" Unity.NumberOfTests++; \\") output.puts(' Unity.NumberOfTests++; \\')
output.puts(" CMock_Init(); \\") unless (used_mocks.empty?) output.puts(' CMock_Init(); \\') unless used_mocks.empty?
output.puts(" UNITY_CLR_DETAILS(); \\") unless (used_mocks.empty?) output.puts(' UNITY_CLR_DETAILS(); \\') unless used_mocks.empty?
output.puts(" if (TEST_PROTECT()) \\") output.puts(' if (TEST_PROTECT()) \\')
output.puts(" { \\") output.puts(' { \\')
output.puts(" CEXCEPTION_T e; \\") if cexception output.puts(' CEXCEPTION_T e; \\') if cexception
output.puts(" Try { \\") if cexception output.puts(' Try { \\') if cexception
output.puts(" #{@options[:setup_name]}(); \\") output.puts(" #{@options[:setup_name]}(); \\")
output.puts(" TestFunc(#{va_args2}); \\") output.puts(" TestFunc(#{va_args2}); \\")
output.puts(" } Catch(e) { TEST_ASSERT_EQUAL_HEX32_MESSAGE(CEXCEPTION_NONE, e, \"Unhandled Exception!\"); } \\") if cexception output.puts(' } Catch(e) { TEST_ASSERT_EQUAL_HEX32_MESSAGE(CEXCEPTION_NONE, e, "Unhandled Exception!"); } \\') if cexception
output.puts(" } \\") output.puts(' } \\')
output.puts(" if (TEST_PROTECT()) \\") output.puts(' if (TEST_PROTECT()) \\')
output.puts(" { \\") output.puts(' { \\')
output.puts(" #{@options[:teardown_name]}(); \\") output.puts(" #{@options[:teardown_name]}(); \\")
output.puts(" CMock_Verify(); \\") unless (used_mocks.empty?) output.puts(' CMock_Verify(); \\') unless used_mocks.empty?
output.puts(" } \\") output.puts(' } \\')
output.puts(" CMock_Destroy(); \\") unless (used_mocks.empty?) output.puts(' CMock_Destroy(); \\') unless used_mocks.empty?
output.puts(" UnityConcludeTest(); \\") output.puts(' UnityConcludeTest(); \\')
output.puts(" } \\") if (@options[:cmdline_args]) output.puts(' } \\') if @options[:cmdline_args]
output.puts("}\n") output.puts("}\n")
end end
def create_reset(output, used_mocks) def create_reset(output, used_mocks)
output.puts("\n/*=======Test Reset Option=====*/") output.puts("\n/*=======Test Reset Option=====*/")
output.puts("void resetTest(void);") output.puts('void resetTest(void);')
output.puts("void resetTest(void)") output.puts('void resetTest(void)')
output.puts("{") output.puts('{')
output.puts(" CMock_Verify();") unless (used_mocks.empty?) output.puts(' CMock_Verify();') unless used_mocks.empty?
output.puts(" CMock_Destroy();") unless (used_mocks.empty?) output.puts(' CMock_Destroy();') unless used_mocks.empty?
output.puts(" #{@options[:teardown_name]}();") output.puts(" #{@options[:teardown_name]}();")
output.puts(" CMock_Init();") unless (used_mocks.empty?) output.puts(' CMock_Init();') unless used_mocks.empty?
output.puts(" #{@options[:setup_name]}();") output.puts(" #{@options[:setup_name]}();")
output.puts("}") output.puts('}')
end end
def create_main(output, filename, tests, used_mocks) def create_main(output, filename, tests, used_mocks)
output.puts("\n\n/*=======MAIN=====*/") output.puts("\n\n/*=======MAIN=====*/")
main_name = (@options[:main_name].to_sym == :auto) ? "main_#{filename.gsub('.c','')}" : "#{@options[:main_name]}" main_name = @options[:main_name].to_sym == :auto ? "main_#{filename.gsub('.c', '')}" : (@options[:main_name]).to_s
if (@options[:cmdline_args]) if @options[:cmdline_args]
if (main_name != "main") if main_name != 'main'
output.puts("#{@options[:main_export_decl]} int #{main_name}(int argc, char** argv);") output.puts("#{@options[:main_export_decl]} int #{main_name}(int argc, char** argv);")
end end
output.puts("#{@options[:main_export_decl]} int #{main_name}(int argc, char** argv)") output.puts("#{@options[:main_export_decl]} int #{main_name}(int argc, char** argv)")
output.puts("{") output.puts('{')
output.puts(" int parse_status = UnityParseOptions(argc, argv);") output.puts(' int parse_status = UnityParseOptions(argc, argv);')
output.puts(" if (parse_status != 0)") output.puts(' if (parse_status != 0)')
output.puts(" {") output.puts(' {')
output.puts(" if (parse_status < 0)") output.puts(' if (parse_status < 0)')
output.puts(" {") output.puts(' {')
output.puts(" UnityPrint(\"#{filename.gsub('.c','')}.\");") output.puts(" UnityPrint(\"#{filename.gsub('.c', '')}.\");")
output.puts(" UNITY_PRINT_EOL();") output.puts(' UNITY_PRINT_EOL();')
if (@options[:use_param_tests]) if @options[:use_param_tests]
tests.each do |test| tests.each do |test|
if ((test[:args].nil?) or (test[:args].empty?)) if test[:args].nil? || test[:args].empty?
output.puts(" UnityPrint(\" #{test[:test]}(RUN_TEST_NO_ARGS)\");") output.puts(" UnityPrint(\" #{test[:test]}(RUN_TEST_NO_ARGS)\");")
output.puts(" UNITY_PRINT_EOL();") output.puts(' UNITY_PRINT_EOL();')
else else
test[:args].each do |args| test[:args].each do |args|
output.puts(" UnityPrint(\" #{test[:test]}(#{args})\");") output.puts(" UnityPrint(\" #{test[:test]}(#{args})\");")
output.puts(" UNITY_PRINT_EOL();") output.puts(' UNITY_PRINT_EOL();')
end end
end end
end end
else else
tests.each { |test| output.puts(" UnityPrint(\" #{test[:test]}\");\n UNITY_PRINT_EOL();")} tests.each { |test| output.puts(" UnityPrint(\" #{test[:test]}\");\n UNITY_PRINT_EOL();") }
end end
output.puts(" return 0;") output.puts(' return 0;')
output.puts(" }") output.puts(' }')
output.puts(" return parse_status;") output.puts(' return parse_status;')
output.puts(" }") output.puts(' }')
else else
if (main_name != "main") if main_name != 'main'
output.puts("#{@options[:main_export_decl]} int #{main_name}(void);") output.puts("#{@options[:main_export_decl]} int #{main_name}(void);")
end end
output.puts("int #{main_name}(void)") output.puts("int #{main_name}(void)")
output.puts("{") output.puts('{')
end end
output.puts(" suite_setup();") unless @options[:suite_setup].nil? output.puts(' suite_setup();') unless @options[:suite_setup].nil?
output.puts(" UnityBegin(\"#{filename.gsub(/\\/,'\\\\\\')}\");") output.puts(" UnityBegin(\"#{filename.gsub(/\\/, '\\\\\\')}\");")
if (@options[:use_param_tests]) if @options[:use_param_tests]
tests.each do |test| tests.each do |test|
if ((test[:args].nil?) or (test[:args].empty?)) if test[:args].nil? || test[:args].empty?
output.puts(" RUN_TEST(#{test[:test]}, #{test[:line_number]}, RUN_TEST_NO_ARGS);") output.puts(" RUN_TEST(#{test[:test]}, #{test[:line_number]}, RUN_TEST_NO_ARGS);")
else else
test[:args].each {|args| output.puts(" RUN_TEST(#{test[:test]}, #{test[:line_number]}, #{args});")} test[:args].each { |args| output.puts(" RUN_TEST(#{test[:test]}, #{test[:line_number]}, #{args});") }
end end
end end
else else
tests.each { |test| output.puts(" RUN_TEST(#{test[:test]}, #{test[:line_number]});") } tests.each { |test| output.puts(" RUN_TEST(#{test[:test]}, #{test[:line_number]});") }
end end
output.puts() output.puts
output.puts(" CMock_Guts_MemFreeFinal();") unless used_mocks.empty? output.puts(' CMock_Guts_MemFreeFinal();') unless used_mocks.empty?
output.puts(" return #{@options[:suite_teardown].nil? ? "" : "suite_teardown"}(UnityEnd());") output.puts(" return #{@options[:suite_teardown].nil? ? '' : 'suite_teardown'}(UnityEnd());")
output.puts("}") output.puts('}')
end end
def create_h_file(output, filename, tests, testfile_includes, used_mocks) def create_h_file(output, filename, tests, testfile_includes, used_mocks)
filename = File.basename(filename).gsub(/[-\/\\\.\,\s]/, "_").upcase filename = File.basename(filename).gsub(/[-\/\\\.\,\s]/, '_').upcase
output.puts("/* AUTOGENERATED FILE. DO NOT EDIT. */") output.puts('/* AUTOGENERATED FILE. DO NOT EDIT. */')
output.puts("#ifndef _#{filename}") output.puts("#ifndef _#{filename}")
output.puts("#define _#{filename}\n\n") output.puts("#define _#{filename}\n\n")
output.puts("#include \"#{@options[:framework].to_s}.h\"") output.puts("#include \"#{@options[:framework]}.h\"")
output.puts('#include "cmock.h"') unless (used_mocks.empty?) output.puts('#include "cmock.h"') unless used_mocks.empty?
@options[:includes].flatten.uniq.compact.each do |inc| @options[:includes].flatten.uniq.compact.each do |inc|
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h','')}.h\""}") output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h', '')}.h\""}")
end end
testfile_includes.each do |inc| testfile_includes.each do |inc|
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h','')}.h\""}") output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h', '')}.h\""}")
end end
output.puts "\n" output.puts "\n"
tests.each do |test| tests.each do |test|
if ((test[:params].nil?) or (test[:params].empty?)) if test[:params].nil? || test[:params].empty?
output.puts("void #{test[:test]}(void);") output.puts("void #{test[:test]}(void);")
else else
output.puts("void #{test[:test]}(#{test[:params]});") output.puts("void #{test[:test]}(#{test[:params]});")
@ -388,50 +384,49 @@ class UnityTestRunnerGenerator
end end
end end
if ($0 == __FILE__) if $PROGRAM_NAME == __FILE__
options = { :includes => [] } options = { includes: [] }
yaml_file = nil yaml_file = nil
#parse out all the options first (these will all be removed as we go) # parse out all the options first (these will all be removed as we go)
ARGV.reject! do |arg| ARGV.reject! do |arg|
case(arg) case (arg)
when '-cexception' when '-cexception'
options[:plugins] = [:cexception]; true options[:plugins] = [:cexception]; true
when /\.*\.ya?ml/ when /\.*\.ya?ml/
options = UnityTestRunnerGenerator.grab_config(arg); true options = UnityTestRunnerGenerator.grab_config(arg); true
when /--(\w+)=\"?(.*)\"?/ when /--(\w+)=\"?(.*)\"?/
options[$1.to_sym] = $2; true options[Regexp.last_match(1).to_sym] = Regexp.last_match(2); true
when /\.*\.h/ when /\.*\.h/
options[:includes] << arg; true options[:includes] << arg; true
else false else false
end end
end end
#make sure there is at least one parameter left (the input file) # make sure there is at least one parameter left (the input file)
if !ARGV[0] unless ARGV[0]
puts ["\nusage: ruby #{__FILE__} (files) (options) input_test_file (output)", puts ["\nusage: ruby #{__FILE__} (files) (options) input_test_file (output)",
"\n input_test_file - this is the C file you want to create a runner for", "\n input_test_file - this is the C file you want to create a runner for",
" output - this is the name of the runner file to generate", ' output - this is the name of the runner file to generate',
" defaults to (input_test_file)_Runner", ' defaults to (input_test_file)_Runner',
" files:", ' files:',
" *.yml / *.yaml - loads configuration from here in :unity or :cmock", ' *.yml / *.yaml - loads configuration from here in :unity or :cmock',
" *.h - header files are added as #includes in runner", ' *.h - header files are added as #includes in runner',
" options:", ' options:',
" -cexception - include cexception support", ' -cexception - include cexception support',
" --setup_name=\"\" - redefine setUp func name to something else", ' --setup_name="" - redefine setUp func name to something else',
" --teardown_name=\"\" - redefine tearDown func name to something else", ' --teardown_name="" - redefine tearDown func name to something else',
" --main_name=\"\" - redefine main func name to something else", ' --main_name="" - redefine main func name to something else',
" --test_prefix=\"\" - redefine test prefix from default test|spec|should", ' --test_prefix="" - redefine test prefix from default test|spec|should',
" --suite_setup=\"\" - code to execute for setup of entire suite", ' --suite_setup="" - code to execute for setup of entire suite',
" --suite_teardown=\"\" - code to execute for teardown of entire suite", ' --suite_teardown="" - code to execute for teardown of entire suite',
" --use_param_tests=1 - enable parameterized tests (disabled by default)", ' --use_param_tests=1 - enable parameterized tests (disabled by default)',
" --header_file=\"\" - path/name of test header file to generate too" ' --header_file="" - path/name of test header file to generate too'].join("\n")
].join("\n")
exit 1 exit 1
end end
#create the default test runner name if not specified # create the default test runner name if not specified
ARGV[1] = ARGV[0].gsub(".c","_Runner.c") if (!ARGV[1]) ARGV[1] = ARGV[0].gsub('.c', '_Runner.c') unless ARGV[1]
UnityTestRunnerGenerator.new(options).run(ARGV[0], ARGV[1]) UnityTestRunnerGenerator.new(options).run(ARGV[0], ARGV[1])
end end

380
auto/parseOutput.rb
View File

@ -1,12 +1,12 @@
#============================================================ #============================================================
# Author: John Theofanopoulos # Author: John Theofanopoulos
# A simple parser. Takes the output files generated during the build process and # A simple parser. Takes the output files generated during the build process and
# extracts information relating to the tests. # extracts information relating to the tests.
# #
# Notes: # Notes:
# To capture an output file under VS builds use the following: # To capture an output file under VS builds use the following:
# devenv [build instructions] > Output.txt & type Output.txt # devenv [build instructions] > Output.txt & type Output.txt
# #
# To capture an output file under GCC/Linux builds use the following: # To capture an output file under GCC/Linux builds use the following:
# make | tee Output.txt # make | tee Output.txt
# #
@ -16,209 +16,203 @@
# file : file to scan for results # file : file to scan for results
#============================================================ #============================================================
class ParseOutput class ParseOutput
# The following flag is set to true when a test is found or false otherwise. # The following flag is set to true when a test is found or false otherwise.
@testFlag @testFlag
@xmlOut @xmlOut
@arrayList @arrayList
@totalTests @totalTests
@classIndex @classIndex
# Set the flag to indicate if there will be an XML output file or not # Set the flag to indicate if there will be an XML output file or not
def setXmlOutput() def setXmlOutput
@xmlOut = true @xmlOut = true
end
# if write our output to XML
def writeXmlOuput
output = File.open('report.xml', 'w')
output << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
@arrayList.each do |item|
output << item << "\n"
end end
output << "</testsuite>\n"
# if write our output to XML end
def writeXmlOuput()
output = File.open("report.xml", "w") # This function will try and determine when the suite is changed. This is
output << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" # is the name that gets added to the classname parameter.
@arrayList.each do |item| def testSuiteVerify(testSuiteName)
output << item << "\n" if @testFlag == false
end @testFlag = true
output << "</testsuite>\n" # Split the path name
testName = testSuiteName.split('/')
# Remove the extension
baseName = testName[testName.size - 1].split('.')
@testSuite = 'test.' + baseName[0]
printf "New Test: %s\n", @testSuite
end end
end
# This function will try and determine when the suite is changed. This is
# is the name that gets added to the classname parameter. # Test was flagged as having passed so format the output
def testSuiteVerify(testSuiteName) def testPassed(array)
if @testFlag == false lastItem = array.length - 1
@testFlag = true; testName = array[lastItem - 1]
# Split the path name testSuiteVerify(array[@className])
testName = testSuiteName.split("/") printf "%-40s PASS\n", testName
# Remove the extension if @xmlOut == true
baseName = testName[testName.size - 1].split(".") @arrayList.push ' <testcase classname="' + @testSuite + '" name="' + testName + '"/>'
@testSuite = "test." + baseName[0] end
printf "New Test: %s\n", @testSuite end
# Test was flagged as having passed so format the output.
# This is using the Unity fixture output and not the original Unity output.
def testPassedUnityFixture(array)
testSuite = array[0].sub('TEST(', '')
testSuite = testSuite.sub(',', '')
testName = array[1].sub(')', '')
if @xmlOut == true
@arrayList.push ' <testcase classname="' + testSuite + '" name="' + testName + '"/>'
end
end
# Test was flagged as being ingored so format the output
def testIgnored(array)
lastItem = array.length - 1
testName = array[lastItem - 2]
reason = array[lastItem].chomp
testSuiteVerify(array[@className])
printf "%-40s IGNORED\n", testName
if testName.start_with? 'TEST('
array2 = testName.split(' ')
@testSuite = array2[0].sub('TEST(', '')
@testSuite = @testSuite.sub(',', '')
testName = array2[1].sub(')', '')
end
if @xmlOut == true
@arrayList.push ' <testcase classname="' + @testSuite + '" name="' + testName + '">'
@arrayList.push ' <skipped type="TEST IGNORED"> ' + reason + ' </skipped>'
@arrayList.push ' </testcase>'
end
end
# Test was flagged as having failed so format the line
def testFailed(array)
lastItem = array.length - 1
testName = array[lastItem - 2]
reason = array[lastItem].chomp + ' at line: ' + array[lastItem - 3]
testSuiteVerify(array[@className])
printf "%-40s FAILED\n", testName
if testName.start_with? 'TEST('
array2 = testName.split(' ')
@testSuite = array2[0].sub('TEST(', '')
@testSuite = @testSuite.sub(',', '')
testName = array2[1].sub(')', '')
end
if @xmlOut == true
@arrayList.push ' <testcase classname="' + @testSuite + '" name="' + testName + '">'
@arrayList.push ' <failure type="ASSERT FAILED"> ' + reason + ' </failure>'
@arrayList.push ' </testcase>'
end
end
# Figure out what OS we are running on. For now we are assuming if it's not Windows it must
# be Unix based.
def detectOS
myOS = RUBY_PLATFORM.split('-')
@className = if myOS.size == 2
if myOS[1] == 'mingw32'
1
else
0
end
else
0
end
end
# Main function used to parse the file that was captured.
def process(name)
@testFlag = false
@arrayList = []
detectOS
puts 'Parsing file: ' + name
testPass = 0
testFail = 0
testIgnore = 0
puts ''
puts '=================== RESULTS ====================='
puts ''
File.open(name).each do |line|
# Typical test lines look like this:
# <path>/<test_file>.c:36:test_tc1000_opsys:FAIL: Expected 1 Was 0
# <path>/<test_file>.c:112:test_tc5004_initCanChannel:IGNORE: Not Yet Implemented
# <path>/<test_file>.c:115:test_tc5100_initCanVoidPtrs:PASS
#
# where path is different on Unix vs Windows devices (Windows leads with a drive letter)
lineArray = line.split(':')
lineSize = lineArray.size
# If we were able to split the line then we can look to see if any of our target words
# were found. Case is important.
if (lineSize >= 4) || (line.start_with? 'TEST(')
# Determine if this test passed
if line.include? ':PASS'
testPassed(lineArray)
testPass += 1
elsif line.include? ':FAIL:'
testFailed(lineArray)
testFail += 1
elsif line.include? ':IGNORE:'
testIgnored(lineArray)
testIgnore += 1
elsif line.start_with? 'TEST('
if line.include? ' PASS'
lineArray = line.split(' ')
testPassedUnityFixture(lineArray)
testPass += 1
end
# If none of the keywords are found there are no more tests for this suite so clear
# the test flag
else
@testFlag = false
end end
end else
# Test was flagged as having passed so format the output
def testPassed(array)
lastItem = array.length - 1
testName = array[lastItem - 1]
testSuiteVerify(array[@className])
printf "%-40s PASS\n", testName
if @xmlOut == true
@arrayList.push " <testcase classname=\"" + @testSuite + "\" name=\"" + testName + "\"/>"
end
end
# Test was flagged as having passed so format the output.
# This is using the Unity fixture output and not the original Unity output.
def testPassedUnityFixture(array)
testSuite = array[0].sub("TEST(", "")
testSuite = testSuite.sub(",", "")
testName = array[1].sub(")", "")
if @xmlOut == true
@arrayList.push " <testcase classname=\"" + testSuite + "\" name=\"" + testName + "\"/>"
end
end
# Test was flagged as being ingored so format the output
def testIgnored(array)
lastItem = array.length - 1
testName = array[lastItem - 2]
reason = array[lastItem].chomp
testSuiteVerify(array[@className])
printf "%-40s IGNORED\n", testName
if testName.start_with? "TEST("
array2 = testName.split(" ")
@testSuite = array2[0].sub("TEST(", "")
@testSuite = @testSuite.sub(",", "")
testName = array2[1].sub(")", "")
end
if @xmlOut == true
@arrayList.push " <testcase classname=\"" + @testSuite + "\" name=\"" + testName + "\">"
@arrayList.push " <skipped type=\"TEST IGNORED\"> " + reason + " </skipped>"
@arrayList.push " </testcase>"
end
end
# Test was flagged as having failed so format the line
def testFailed(array)
lastItem = array.length - 1
testName = array[lastItem - 2]
reason = array[lastItem].chomp + " at line: " + array[lastItem - 3]
testSuiteVerify(array[@className])
printf "%-40s FAILED\n", testName
if testName.start_with? "TEST("
array2 = testName.split(" ")
@testSuite = array2[0].sub("TEST(", "")
@testSuite = @testSuite.sub(",", "")
testName = array2[1].sub(")", "")
end
if @xmlOut == true
@arrayList.push " <testcase classname=\"" + @testSuite + "\" name=\"" + testName + "\">"
@arrayList.push " <failure type=\"ASSERT FAILED\"> " + reason + " </failure>"
@arrayList.push " </testcase>"
end
end
# Figure out what OS we are running on. For now we are assuming if it's not Windows it must
# be Unix based.
def detectOS()
myOS = RUBY_PLATFORM.split("-")
if myOS.size == 2
if myOS[1] == "mingw32"
@className = 1
else
@className = 0
end
else
@className = 0
end
end
# Main function used to parse the file that was captured.
def process(name)
@testFlag = false @testFlag = false
@arrayList = Array.new end
end
detectOS() puts ''
puts '=================== SUMMARY ====================='
puts "Parsing file: " + name puts ''
puts 'Tests Passed : ' + testPass.to_s
puts 'Tests Failed : ' + testFail.to_s
testPass = 0 puts 'Tests Ignored : ' + testIgnore.to_s
testFail = 0 @totalTests = testPass + testFail + testIgnore
testIgnore = 0 if @xmlOut == true
puts "" heading = '<testsuite tests="' + @totalTests.to_s + '" failures="' + testFail.to_s + '"' + ' skips="' + testIgnore.to_s + '">'
puts "=================== RESULTS =====================" @arrayList.insert(0, heading)
puts "" writeXmlOuput
File.open(name).each do |line| end
# Typical test lines look like this:
# <path>/<test_file>.c:36:test_tc1000_opsys:FAIL: Expected 1 Was 0
# <path>/<test_file>.c:112:test_tc5004_initCanChannel:IGNORE: Not Yet Implemented
# <path>/<test_file>.c:115:test_tc5100_initCanVoidPtrs:PASS
#
# where path is different on Unix vs Windows devices (Windows leads with a drive letter)
lineArray = line.split(":")
lineSize = lineArray.size
# If we were able to split the line then we can look to see if any of our target words
# were found. Case is important.
if ((lineSize >= 4) || (line.start_with? "TEST("))
# Determine if this test passed
if line.include? ":PASS"
testPassed(lineArray)
testPass += 1
elsif line.include? ":FAIL:"
testFailed(lineArray)
testFail += 1
elsif line.include? ":IGNORE:"
testIgnored(lineArray)
testIgnore += 1
elsif line.start_with? "TEST("
if line.include? " PASS"
lineArray = line.split(" ")
testPassedUnityFixture(lineArray)
testPass += 1
end
# If none of the keywords are found there are no more tests for this suite so clear
# the test flag
else
@testFlag = false
end
else
@testFlag = false
end
end
puts ""
puts "=================== SUMMARY ====================="
puts ""
puts "Tests Passed : " + testPass.to_s
puts "Tests Failed : " + testFail.to_s
puts "Tests Ignored : " + testIgnore.to_s
@totalTests = testPass + testFail + testIgnore
if @xmlOut == true
heading = "<testsuite tests=\"" + @totalTests.to_s + "\" failures=\"" + testFail.to_s + "\"" + " skips=\"" + testIgnore.to_s + "\">"
@arrayList.insert(0, heading)
writeXmlOuput()
end
# return result # return result
end end
end end
# If the command line has no values in, used a default value of Output.txt # If the command line has no values in, used a default value of Output.txt
parseMyFile = ParseOutput.new parseMyFile = ParseOutput.new
if ARGV.size >= 1 if ARGV.size >= 1
ARGV.each do |a| ARGV.each do |a|
if a == "-xml" if a == '-xml'
parseMyFile.setXmlOutput(); parseMyFile.setXmlOutput
else else
parseMyFile.process(a) parseMyFile.process(a)
break break
end
end end
end
end end

182
auto/stylize_as_junit.rb
View File

@ -12,7 +12,6 @@ require 'pp'
VERSION = 1.0 VERSION = 1.0
class ArgvParser class ArgvParser
# #
# Return a structure describing the options. # Return a structure describing the options.
# #
@ -20,41 +19,41 @@ class ArgvParser
# The options specified on the command line will be collected in *options*. # The options specified on the command line will be collected in *options*.
# We set default values here. # We set default values here.
options = OpenStruct.new options = OpenStruct.new
options.results_dir = "." options.results_dir = '.'
options.root_path = "." options.root_path = '.'
options.out_file = "results.xml" options.out_file = 'results.xml'
opts = OptionParser.new do |opts| opts = OptionParser.new do |opts|
opts.banner = "Usage: unity_to_junit.rb [options]" opts.banner = 'Usage: unity_to_junit.rb [options]'
opts.separator "" opts.separator ''
opts.separator "Specific options:" opts.separator 'Specific options:'
opts.on("-r", "--results <dir>", "Look for Unity Results files here.") do |results| opts.on('-r', '--results <dir>', 'Look for Unity Results files here.') do |results|
#puts "results #{results}" # puts "results #{results}"
options.results_dir = results options.results_dir = results
end end
opts.on("-p", "--root_path <path>", "Prepend this path to files in results.") do |root_path| opts.on('-p', '--root_path <path>', 'Prepend this path to files in results.') do |root_path|
options.root_path = root_path options.root_path = root_path
end end
opts.on("-o", "--output <filename>", "XML file to generate.") do |out_file| opts.on('-o', '--output <filename>', 'XML file to generate.') do |out_file|
#puts "out_file: #{out_file}" # puts "out_file: #{out_file}"
options.out_file = out_file options.out_file = out_file
end end
opts.separator "" opts.separator ''
opts.separator "Common options:" opts.separator 'Common options:'
# No argument, shows at tail. This will print an options summary. # No argument, shows at tail. This will print an options summary.
opts.on_tail("-h", "--help", "Show this message") do opts.on_tail('-h', '--help', 'Show this message') do
puts opts puts opts
exit exit
end end
# Another typical switch to print the version. # Another typical switch to print the version.
opts.on_tail("--version", "Show version") do opts.on_tail('--version', 'Show version') do
puts "unity_to_junit.rb version #{VERSION}" puts "unity_to_junit.rb version #{VERSION}"
exit exit
end end
@ -62,9 +61,8 @@ class ArgvParser
opts.parse!(args) opts.parse!(args)
options options
end # parse() end # parse()
end # class OptparseExample
end # class OptparseExample
class UnityToJUnit class UnityToJUnit
include FileUtils::Verbose include FileUtils::Verbose
@ -77,44 +75,44 @@ class UnityToJUnit
def run def run
# Clean up result file names # Clean up result file names
results = @targets.map {|target| target.gsub(/\\/,"/")} results = @targets.map { |target| target.tr('\\', '/') }
#puts "Output File: #{@out_file}" # puts "Output File: #{@out_file}"
f = File.new(@out_file, "w") f = File.new(@out_file, 'w')
write_xml_header(f) write_xml_header(f)
write_suites_header( f ) write_suites_header(f)
results.each do |result_file| results.each do |result_file|
lines = File.readlines(result_file).map { |line| line.chomp } lines = File.readlines(result_file).map(&:chomp)
if lines.length == 0 if lines.empty?
raise "Empty test result file: #{result_file}" raise "Empty test result file: #{result_file}"
else else
result_output = get_details(result_file, lines) result_output = get_details(result_file, lines)
tests,failures,ignored = parse_test_summary(lines) tests, failures, ignored = parse_test_summary(lines)
result_output[:counts][:total] = tests result_output[:counts][:total] = tests
result_output[:counts][:failed] = failures result_output[:counts][:failed] = failures
result_output[:counts][:ignored] = ignored result_output[:counts][:ignored] = ignored
result_output[:counts][:passed] = (result_output[:counts][:total] - result_output[:counts][:failed] - result_output[:counts][:ignored]) result_output[:counts][:passed] = (result_output[:counts][:total] - result_output[:counts][:failed] - result_output[:counts][:ignored])
end end
#use line[0] from the test output to get the test_file path and name # use line[0] from the test output to get the test_file path and name
test_file_str = lines[0].gsub("\\","/") test_file_str = lines[0].tr('\\', '/')
test_file_str = test_file_str.split(":") test_file_str = test_file_str.split(':')
test_file = if (test_file_str.length < 2) test_file = if test_file_str.length < 2
result_file result_file
else else
test_file_str[0] + ':' + test_file_str[1] test_file_str[0] + ':' + test_file_str[1]
end end
result_output[:source][:path] = File.dirname(test_file) result_output[:source][:path] = File.dirname(test_file)
result_output[:source][:file] = File.basename(test_file) result_output[:source][:file] = File.basename(test_file)
# save result_output # save result_output
@unit_name = File.basename(test_file, ".*") @unit_name = File.basename(test_file, '.*')
write_suite_header( result_output[:counts], f) write_suite_header(result_output[:counts], f)
write_failures( result_output, f ) write_failures(result_output, f)
write_tests( result_output, f ) write_tests(result_output, f)
write_ignored( result_output, f ) write_ignored(result_output, f)
write_suite_footer( f ) write_suite_footer(f)
end end
write_suites_footer( f ) write_suites_footer(f)
f.close f.close
end end
@ -125,77 +123,83 @@ class UnityToJUnit
def set_root_path(path) def set_root_path(path)
@root = path @root = path
end end
def set_out_file(filename) def set_out_file(filename)
@out_file = filename @out_file = filename
end end
def usage(err_msg=nil)
def usage(err_msg = nil)
puts "\nERROR: " puts "\nERROR: "
puts err_msg if err_msg puts err_msg if err_msg
puts "Usage: unity_to_junit.rb [options]" puts 'Usage: unity_to_junit.rb [options]'
puts "" puts ''
puts "Specific options:" puts 'Specific options:'
puts " -r, --results <dir> Look for Unity Results files here." puts ' -r, --results <dir> Look for Unity Results files here.'
puts " -p, --root_path <path> Prepend this path to files in results." puts ' -p, --root_path <path> Prepend this path to files in results.'
puts " -o, --output <filename> XML file to generate." puts ' -o, --output <filename> XML file to generate.'
puts "" puts ''
puts "Common options:" puts 'Common options:'
puts " -h, --help Show this message" puts ' -h, --help Show this message'
puts " --version Show version" puts ' --version Show version'
exit 1 exit 1
end end
protected protected
def get_details(result_file, lines)
def get_details(_result_file, lines)
results = get_results_structure results = get_results_structure
lines.each do |line| lines.each do |line|
line = line.gsub("\\","/") line = line.tr('\\', '/')
src_file,src_line,test_name,status,msg = line.split(/:/) src_file, src_line, test_name, status, msg = line.split(/:/)
line_out = ((@root and (@root != 0)) ? "#{@root}#{line}" : line ).gsub(/\//, "\\") line_out = (@root && (@root != 0) ? "#{@root}#{line}" : line).gsub(/\//, '\\')
case(status) case status
when 'IGNORE' then results[:ignores] << {:test => test_name, :line => src_line, :message => msg} when 'IGNORE' then results[:ignores] << { test: test_name, line: src_line, message: msg }
when 'FAIL' then results[:failures] << {:test => test_name, :line => src_line, :message => msg} when 'FAIL' then results[:failures] << { test: test_name, line: src_line, message: msg }
when 'PASS' then results[:successes] << {:test => test_name, :line => src_line, :message => msg} when 'PASS' then results[:successes] << { test: test_name, line: src_line, message: msg }
end end
end end
return results results
end end
def parse_test_summary(summary) def parse_test_summary(summary)
if summary.find { |v| v =~ /(\d+) Tests (\d+) Failures (\d+) Ignored/ } if summary.find { |v| v =~ /(\d+) Tests (\d+) Failures (\d+) Ignored/ }
[$1.to_i,$2.to_i,$3.to_i] [Regexp.last_match(1).to_i, Regexp.last_match(2).to_i, Regexp.last_match(3).to_i]
else else
raise "Couldn't parse test results: #{summary}" raise "Couldn't parse test results: #{summary}"
end end
end end
def here; File.expand_path(File.dirname(__FILE__)); end
def here
File.expand_path(File.dirname(__FILE__))
end
private private
def get_results_structure def get_results_structure
return { {
:source => {:path => '', :file => ''}, source: { path: '', file: '' },
:successes => [], successes: [],
:failures => [], failures: [],
:ignores => [], ignores: [],
:counts => {:total => 0, :passed => 0, :failed => 0, :ignored => 0}, counts: { total: 0, passed: 0, failed: 0, ignored: 0 },
:stdout => [], stdout: []
} }
end end
def write_xml_header( stream ) def write_xml_header(stream)
stream.puts "<?xml version='1.0' encoding='utf-8' ?>" stream.puts "<?xml version='1.0' encoding='utf-8' ?>"
end end
def write_suites_header( stream ) def write_suites_header(stream)
stream.puts "<testsuites>" stream.puts '<testsuites>'
end end
def write_suite_header( counts, stream ) def write_suite_header(counts, stream)
stream.puts "\t<testsuite errors=\"0\" skipped=\"#{counts[:ignored]}\" failures=\"#{counts[:failed]}\" tests=\"#{counts[:total]}\" name=\"unity\">" stream.puts "\t<testsuite errors=\"0\" skipped=\"#{counts[:ignored]}\" failures=\"#{counts[:failed]}\" tests=\"#{counts[:total]}\" name=\"unity\">"
end end
def write_failures( results, stream ) def write_failures(results, stream)
result = results[:failures] result = results[:failures]
result.each do |item| result.each do |item|
filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*')) filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*'))
@ -206,7 +210,7 @@ class UnityToJUnit
end end
end end
def write_tests( results, stream ) def write_tests(results, stream)
result = results[:successes] result = results[:successes]
result.each do |item| result.each do |item|
filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*')) filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*'))
@ -214,7 +218,7 @@ class UnityToJUnit
end end
end end
def write_ignored( results, stream ) def write_ignored(results, stream)
result = results[:ignores] result = results[:ignores]
result.each do |item| result.each do |item|
filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*')) filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*'))
@ -226,37 +230,37 @@ class UnityToJUnit
end end
end end
def write_suite_footer( stream ) def write_suite_footer(stream)
stream.puts "\t</testsuite>" stream.puts "\t</testsuite>"
end end
def write_suites_footer( stream ) def write_suites_footer(stream)
stream.puts "</testsuites>" stream.puts '</testsuites>'
end end
end #UnityToJUnit end # UnityToJUnit
if __FILE__ == $0 if __FILE__ == $PROGRAM_NAME
#parse out the command options # parse out the command options
options = ArgvParser.parse(ARGV) options = ArgvParser.parse(ARGV)
#create an instance to work with # create an instance to work with
utj = UnityToJUnit.new utj = UnityToJUnit.new
begin begin
#look in the specified or current directory for result files # look in the specified or current directory for result files
targets = "#{options.results_dir.gsub(/\\/, '/')}**/*.test*" targets = "#{options.results_dir.tr('\\', '/')}**/*.test*"
results = Dir[targets] results = Dir[targets]
raise "No *.testpass, *.testfail, or *.testresults files found in '#{targets}'" if results.empty? raise "No *.testpass, *.testfail, or *.testresults files found in '#{targets}'" if results.empty?
utj.set_targets(results) utj.set_targets(results)
#set the root path # set the root path
utj.set_root_path(options.root_path) utj.set_root_path(options.root_path)
#set the output XML file name # set the output XML file name
#puts "Output File from options: #{options.out_file}" # puts "Output File from options: #{options.out_file}"
utj.set_out_file(options.out_file) utj.set_out_file(options.out_file)
#run the summarizer # run the summarizer
puts utj.run puts utj.run
rescue Exception => e rescue Exception => e
utj.usage e.message utj.usage e.message

13
auto/test_file_filter.rb
View File

@ -2,7 +2,7 @@
# Unity Project - A Test Framework for C # Unity Project - A Test Framework for C
# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams # Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
# [Released under MIT License. Please refer to license.txt for details] # [Released under MIT License. Please refer to license.txt for details]
# ========================================== # ==========================================
require'yaml' require'yaml'
@ -10,14 +10,15 @@ module RakefileHelpers
class TestFileFilter class TestFileFilter
def initialize(all_files = false) def initialize(all_files = false)
@all_files = all_files @all_files = all_files
if not @all_files == true if @all_files != true
if File.exist?('test_file_filter.yml') if File.exist?('test_file_filter.yml')
filters = YAML.load_file( 'test_file_filter.yml' ) filters = YAML.load_file('test_file_filter.yml')
@all_files, @only_files, @exclude_files = @all_files = filters[:all_files]
filters[:all_files], filters[:only_files], filters[:exclude_files] @only_files = filters[:only_files]
@exclude_files = filters[:exclude_files]
end end
end end
end end
attr_accessor :all_files, :only_files, :exclude_files attr_accessor :all_files, :only_files, :exclude_files
end end
end end

4
auto/type_sanitizer.rb
View File

@ -1,8 +1,6 @@
module TypeSanitizer module TypeSanitizer
def self.sanitize_c_identifier(unsanitized) def self.sanitize_c_identifier(unsanitized)
# convert filename to valid C identifier by replacing invalid chars with '_' # convert filename to valid C identifier by replacing invalid chars with '_'
return unsanitized.gsub(/[-\/\\\.\,\s]/, "_") unsanitized.gsub(/[-\/\\\.\,\s]/, '_')
end end
end end

67
auto/unity_test_summary.rb
View File

@ -4,7 +4,7 @@
# [Released under MIT License. Please refer to license.txt for details] # [Released under MIT License. Please refer to license.txt for details]
# ========================================== # ==========================================
#!/usr/bin/ruby # !/usr/bin/ruby
# #
# unity_test_summary.rb # unity_test_summary.rb
# #
@ -16,32 +16,30 @@ class UnityTestSummary
attr_reader :report, :total_tests, :failures, :ignored attr_reader :report, :total_tests, :failures, :ignored
def initialize(opts = {}) def initialize(_opts = {})
@report = '' @report = ''
@total_tests = 0 @total_tests = 0
@failures = 0 @failures = 0
@ignored = 0 @ignored = 0
end end
def run def run
# Clean up result file names # Clean up result file names
results = @targets.map {|target| target.gsub(/\\/,'/')} results = @targets.map { |target| target.tr('\\', '/') }
# Dig through each result file, looking for details on pass/fail: # Dig through each result file, looking for details on pass/fail:
failure_output = [] failure_output = []
ignore_output = [] ignore_output = []
results.each do |result_file| results.each do |result_file|
lines = File.readlines(result_file).map { |line| line.chomp } lines = File.readlines(result_file).map(&:chomp)
if lines.length == 0 if lines.empty?
raise "Empty test result file: #{result_file}" raise "Empty test result file: #{result_file}"
else else
output = get_details(result_file, lines) output = get_details(result_file, lines)
failure_output << output[:failures] unless output[:failures].empty? failure_output << output[:failures] unless output[:failures].empty?
ignore_output << output[:ignores] unless output[:ignores].empty? ignore_output << output[:ignores] unless output[:ignores].empty?
tests,failures,ignored = parse_test_summary(lines) tests, failures, ignored = parse_test_summary(lines)
@total_tests += tests @total_tests += tests
@failures += failures @failures += failures
@ignored += ignored @ignored += ignored
@ -80,67 +78,68 @@ class UnityTestSummary
@root = path @root = path
end end
def usage(err_msg=nil) def usage(err_msg = nil)
puts "\nERROR: " puts "\nERROR: "
puts err_msg if err_msg puts err_msg if err_msg
puts "\nUsage: unity_test_summary.rb result_file_directory/ root_path/" puts "\nUsage: unity_test_summary.rb result_file_directory/ root_path/"
puts " result_file_directory - The location of your results files." puts ' result_file_directory - The location of your results files.'
puts " Defaults to current directory if not specified." puts ' Defaults to current directory if not specified.'
puts " Should end in / if specified." puts ' Should end in / if specified.'
puts " root_path - Helpful for producing more verbose output if using relative paths." puts ' root_path - Helpful for producing more verbose output if using relative paths.'
exit 1 exit 1
end end
protected protected
def get_details(result_file, lines) def get_details(_result_file, lines)
results = { :failures => [], :ignores => [], :successes => [] } results = { failures: [], ignores: [], successes: [] }
lines.each do |line| lines.each do |line|
src_file,src_line,test_name,status,msg = line.split(/:/) src_file, src_line, test_name, status, msg = line.split(/:/)
line_out = ((@root && (@root != 0)) ? "#{@root}#{line}" : line ).gsub(/\//, "\\") line_out = (@root && (@root != 0) ? "#{@root}#{line}" : line).gsub(/\//, '\\')
case(status) case status
when 'IGNORE' then results[:ignores] << line_out when 'IGNORE' then results[:ignores] << line_out
when 'FAIL' then results[:failures] << line_out when 'FAIL' then results[:failures] << line_out
when 'PASS' then results[:successes] << line_out when 'PASS' then results[:successes] << line_out
end end
end end
return results results
end end
def parse_test_summary(summary) def parse_test_summary(summary)
if summary.find { |v| v =~ /(\d+) Tests (\d+) Failures (\d+) Ignored/ } if summary.find { |v| v =~ /(\d+) Tests (\d+) Failures (\d+) Ignored/ }
[$1.to_i,$2.to_i,$3.to_i] [Regexp.last_match(1).to_i, Regexp.last_match(2).to_i, Regexp.last_match(3).to_i]
else else
raise "Couldn't parse test results: #{summary}" raise "Couldn't parse test results: #{summary}"
end end
end end
def here; File.expand_path(File.dirname(__FILE__)); end def here
File.expand_path(File.dirname(__FILE__))
end
end end
if $0 == __FILE__ if $PROGRAM_NAME == __FILE__
#parse out the command options # parse out the command options
opts, args = ARGV.partition {|v| v =~ /^--\w+/} opts, args = ARGV.partition { |v| v =~ /^--\w+/ }
opts.map! {|v| v[2..-1].to_sym } opts.map! { |v| v[2..-1].to_sym }
#create an instance to work with # create an instance to work with
uts = UnityTestSummary.new(opts) uts = UnityTestSummary.new(opts)
begin begin
#look in the specified or current directory for result files # look in the specified or current directory for result files
args[0] ||= './' args[0] ||= './'
targets = "#{ARGV[0].gsub(/\\/, '/')}**/*.test*" targets = "#{ARGV[0].tr('\\', '/')}**/*.test*"
results = Dir[targets] results = Dir[targets]
raise "No *.testpass, *.testfail, or *.testresults files found in '#{targets}'" if results.empty? raise "No *.testpass, *.testfail, or *.testresults files found in '#{targets}'" if results.empty?
uts.set_targets(results) uts.set_targets(results)
#set the root path # set the root path
args[1] ||= Dir.pwd + '/' args[1] ||= Dir.pwd + '/'
uts.set_root_path(ARGV[1]) uts.set_root_path(ARGV[1])
#run the summarizer # run the summarizer
puts uts.run puts uts.run
rescue Exception => e rescue Exception => e
uts.usage e.message uts.usage e.message

28
examples/example_3/rakefile.rb
View File

@ -3,41 +3,41 @@ UNITY_ROOT = File.expand_path(File.dirname(__FILE__)) + '/../..'
require 'rake' require 'rake'
require 'rake/clean' require 'rake/clean'
require HERE+'rakefile_helper' require HERE + 'rakefile_helper'
TEMP_DIRS = [ TEMP_DIRS = [
File.join(HERE, 'build') File.join(HERE, 'build')
] ].freeze
TEMP_DIRS.each do |dir| TEMP_DIRS.each do |dir|
directory(dir) directory(dir)
CLOBBER.include(dir) CLOBBER.include(dir)
end end
task :prepare_for_tests => TEMP_DIRS task prepare_for_tests: TEMP_DIRS
include RakefileHelpers include RakefileHelpers
# Load default configuration, for now # Load default configuration, for now
DEFAULT_CONFIG_FILE = 'target_gcc_32.yml' DEFAULT_CONFIG_FILE = 'target_gcc_32.yml'.freeze
configure_toolchain(DEFAULT_CONFIG_FILE) configure_toolchain(DEFAULT_CONFIG_FILE)
task :unit => [:prepare_for_tests] do task unit: [:prepare_for_tests] do
run_tests get_unit_test_files run_tests get_unit_test_files
end end
desc "Generate test summary" desc 'Generate test summary'
task :summary do task :summary do
report_summary report_summary
end end
desc "Build and test Unity" desc 'Build and test Unity'
task :all => [:clean, :unit, :summary] task all: %i(clean unit summary)
task :default => [:clobber, :all] task default: %i(clobber all)
task :ci => [:default] task ci: [:default]
task :cruise => [:default] task cruise: [:default]
desc "Load configuration" desc 'Load configuration'
task :config, :config_file do |t, args| task :config, :config_file do |_t, args|
configure_toolchain(args[:config_file]) configure_toolchain(args[:config_file])
end end

143
examples/example_3/rakefile_helper.rb
View File

@ -1,23 +1,22 @@
require 'yaml' require 'yaml'
require 'fileutils' require 'fileutils'
require UNITY_ROOT+'/auto/unity_test_summary' require UNITY_ROOT + '/auto/unity_test_summary'
require UNITY_ROOT+'/auto/generate_test_runner' require UNITY_ROOT + '/auto/generate_test_runner'
require UNITY_ROOT+'/auto/colour_reporter' require UNITY_ROOT + '/auto/colour_reporter'
module RakefileHelpers module RakefileHelpers
C_EXTENSION = '.c'.freeze
C_EXTENSION = '.c'
def load_configuration(config_file) def load_configuration(config_file)
$cfg_file = config_file $cfg_file = config_file
$cfg = YAML.load(File.read($cfg_file)) $cfg = YAML.safe_load(File.read($cfg_file))
end end
def configure_clean def configure_clean
CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil? CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
end end
def configure_toolchain(config_file=DEFAULT_CONFIG_FILE) def configure_toolchain(config_file = DEFAULT_CONFIG_FILE)
config_file += '.yml' unless config_file =~ /\.yml$/ config_file += '.yml' unless config_file =~ /\.yml$/
load_configuration(config_file) load_configuration(config_file)
configure_clean configure_clean
@ -25,14 +24,14 @@ module RakefileHelpers
def get_unit_test_files def get_unit_test_files
path = $cfg['compiler']['unit_tests_path'] + 'Test*' + C_EXTENSION path = $cfg['compiler']['unit_tests_path'] + 'Test*' + C_EXTENSION
path.gsub!(/\\/, '/') path.tr!('\\', '/')
FileList.new(path) FileList.new(path)
end end
def get_local_include_dirs def get_local_include_dirs
include_dirs = $cfg['compiler']['includes']['items'].dup include_dirs = $cfg['compiler']['includes']['items'].dup
include_dirs.delete_if {|dir| dir.is_a?(Array)} include_dirs.delete_if { |dir| dir.is_a?(Array) }
return include_dirs include_dirs
end end
def extract_headers(filename) def extract_headers(filename)
@ -40,40 +39,36 @@ module RakefileHelpers
lines = File.readlines(filename) lines = File.readlines(filename)
lines.each do |line| lines.each do |line|
m = line.match(/^\s*#include\s+\"\s*(.+\.[hH])\s*\"/) m = line.match(/^\s*#include\s+\"\s*(.+\.[hH])\s*\"/)
if not m.nil? includes << m[1] unless m.nil?
includes << m[1]
end
end end
return includes includes
end end
def find_source_file(header, paths) def find_source_file(header, paths)
paths.each do |dir| paths.each do |dir|
src_file = dir + header.ext(C_EXTENSION) src_file = dir + header.ext(C_EXTENSION)
if (File.exists?(src_file)) return src_file if File.exist?(src_file)
return src_file
end
end end
return nil nil
end end
def tackit(strings) def tackit(strings)
if strings.is_a?(Array) result = if strings.is_a?(Array)
result = "\"#{strings.join}\"" "\"#{strings.join}\""
else else
result = strings strings
end end
return result result
end end
def squash(prefix, items) def squash(prefix, items)
result = '' result = ''
items.each { |item| result += " #{prefix}#{tackit(item)}" } items.each { |item| result += " #{prefix}#{tackit(item)}" }
return result result
end end
def build_compiler_fields def build_compiler_fields
command = tackit($cfg['compiler']['path']) command = tackit($cfg['compiler']['path'])
if $cfg['compiler']['defines']['items'].nil? if $cfg['compiler']['defines']['items'].nil?
defines = '' defines = ''
else else
@ -82,87 +77,86 @@ module RakefileHelpers
options = squash('', $cfg['compiler']['options']) options = squash('', $cfg['compiler']['options'])
includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items']) includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR) includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
return {:command => command, :defines => defines, :options => options, :includes => includes} { command: command, defines: defines, options: options, includes: includes }
end end
def compile(file, defines=[]) def compile(file, _defines = [])
compiler = build_compiler_fields compiler = build_compiler_fields
cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{file} " + cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{file} " \
"#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}" "#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}"
obj_file = "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}" obj_file = "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
execute(cmd_str + obj_file) execute(cmd_str + obj_file)
return obj_file obj_file
end end
def build_linker_fields def build_linker_fields
command = tackit($cfg['linker']['path']) command = tackit($cfg['linker']['path'])
if $cfg['linker']['options'].nil? options = if $cfg['linker']['options'].nil?
options = '' ''
else else
options = squash('', $cfg['linker']['options']) squash('', $cfg['linker']['options'])
end end
if ($cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?) if $cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?
includes = '' includes = ''
else else
includes = squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items']) includes = squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
end end
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR) includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
return {:command => command, :options => options, :includes => includes} { command: command, options: options, includes: includes }
end end
def link_it(exe_name, obj_list) def link_it(exe_name, obj_list)
linker = build_linker_fields linker = build_linker_fields
cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " + cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
(obj_list.map{|obj|"#{$cfg['linker']['object_files']['path']}#{obj} "}).join + (obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj} " }).join +
$cfg['linker']['bin_files']['prefix'] + ' ' + $cfg['linker']['bin_files']['prefix'] + ' ' +
$cfg['linker']['bin_files']['destination'] + $cfg['linker']['bin_files']['destination'] +
exe_name + $cfg['linker']['bin_files']['extension'] exe_name + $cfg['linker']['bin_files']['extension']
execute(cmd_str) execute(cmd_str)
end end
def build_simulator_fields def build_simulator_fields
return nil if $cfg['simulator'].nil? return nil if $cfg['simulator'].nil?
if $cfg['simulator']['path'].nil? command = if $cfg['simulator']['path'].nil?
command = '' ''
else else
command = (tackit($cfg['simulator']['path']) + ' ') (tackit($cfg['simulator']['path']) + ' ')
end end
if $cfg['simulator']['pre_support'].nil? pre_support = if $cfg['simulator']['pre_support'].nil?
pre_support = '' ''
else else
pre_support = squash('', $cfg['simulator']['pre_support']) squash('', $cfg['simulator']['pre_support'])
end end
if $cfg['simulator']['post_support'].nil? if $cfg['simulator']['post_support'].nil?
post_support = '' post_support = ''
else else
post_support = squash('', $cfg['simulator']['post_support']) post_support = squash('', $cfg['simulator']['post_support'])
end end
return {:command => command, :pre_support => pre_support, :post_support => post_support} { command: command, pre_support: pre_support, post_support: post_support }
end end
def execute(command_string, verbose=true, raise_on_fail=true) def execute(command_string, verbose = true, raise_on_fail = true)
report command_string report command_string
output = `#{command_string}`.chomp output = `#{command_string}`.chomp
report(output) if (verbose && !output.nil? && (output.length > 0)) report(output) if verbose && !output.nil? && !output.empty?
if (($?.exitstatus != 0) and (raise_on_fail)) if ($CHILD_STATUS.exitstatus != 0) && raise_on_fail
raise "Command failed. (Returned #{$?.exitstatus})" raise "Command failed. (Returned #{$CHILD_STATUS.exitstatus})"
end end
return output output
end end
def report_summary def report_summary
summary = UnityTestSummary.new summary = UnityTestSummary.new
summary.set_root_path(HERE) summary.set_root_path(HERE)
results_glob = "#{$cfg['compiler']['build_path']}*.test*" results_glob = "#{$cfg['compiler']['build_path']}*.test*"
results_glob.gsub!(/\\/, '/') results_glob.tr!('\\', '/')
results = Dir[results_glob] results = Dir[results_glob]
summary.set_targets(results) summary.set_targets(results)
summary.run summary.run
fail_out "FAIL: There were failures" if (summary.failures > 0) fail_out 'FAIL: There were failures' if summary.failures > 0
end end
def run_tests(test_files) def run_tests(test_files)
report 'Running system tests...' report 'Running system tests...'
# Tack on TEST define for compiling unit tests # Tack on TEST define for compiling unit tests
@ -181,9 +175,7 @@ module RakefileHelpers
extract_headers(test).each do |header| extract_headers(test).each do |header|
# Compile corresponding source file if it exists # Compile corresponding source file if it exists
src_file = find_source_file(header, include_dirs) src_file = find_source_file(header, include_dirs)
if !src_file.nil? obj_list << compile(src_file, test_defines) unless src_file.nil?
obj_list << compile(src_file, test_defines)
end
end end
# Build the test runner (generate if configured to do so) # Build the test runner (generate if configured to do so)
@ -215,18 +207,17 @@ module RakefileHelpers
end end
output = execute(cmd_str, true, false) output = execute(cmd_str, true, false)
test_results = $cfg['compiler']['build_path'] + test_base test_results = $cfg['compiler']['build_path'] + test_base
if output.match(/OK$/m).nil? test_results += if output.match(/OK$/m).nil?
test_results += '.testfail' '.testfail'
else else
test_results += '.testpass' '.testpass'
end end
File.open(test_results, 'w') { |f| f.print output } File.open(test_results, 'w') { |f| f.print output }
end end
end end
def build_application(main) def build_application(main)
report 'Building application...'
report "Building application..."
obj_list = [] obj_list = []
load_configuration($cfg_file) load_configuration($cfg_file)
@ -236,9 +227,7 @@ module RakefileHelpers
include_dirs = get_local_include_dirs include_dirs = get_local_include_dirs
extract_headers(main_path).each do |header| extract_headers(main_path).each do |header|
src_file = find_source_file(header, include_dirs) src_file = find_source_file(header, include_dirs)
if !src_file.nil? obj_list << compile(src_file) unless src_file.nil?
obj_list << compile(src_file)
end
end end
# Build the main source file # Build the main source file
@ -251,8 +240,8 @@ module RakefileHelpers
def fail_out(msg) def fail_out(msg)
puts msg puts msg
puts "Not returning exit code so continuous integration can pass" puts 'Not returning exit code so continuous integration can pass'
# exit(-1) # Only removed to pass example_3, which has failing tests on purpose. # exit(-1) # Only removed to pass example_3, which has failing tests on purpose.
# Still fail if the build fails for any other reason. # Still fail if the build fails for any other reason.
end end
end end

24
extras/fixture/rakefile.rb
View File

@ -12,34 +12,34 @@ require 'rake/testtask'
require HERE + 'rakefile_helper' require HERE + 'rakefile_helper'
TEMP_DIRS = [ TEMP_DIRS = [
File.join(HERE, 'build') File.join(HERE, 'build')
] ].freeze
TEMP_DIRS.each do |dir| TEMP_DIRS.each do |dir|
directory(dir) directory(dir)
CLOBBER.include(dir) CLOBBER.include(dir)
end end
task :prepare_for_tests => TEMP_DIRS task prepare_for_tests: TEMP_DIRS
include RakefileHelpers include RakefileHelpers
# Load default configuration, for now # Load default configuration, for now
DEFAULT_CONFIG_FILE = 'gcc_auto_stdint.yml' DEFAULT_CONFIG_FILE = 'gcc_auto_stdint.yml'.freeze
configure_toolchain(DEFAULT_CONFIG_FILE) configure_toolchain(DEFAULT_CONFIG_FILE)
task :unit => [:prepare_for_tests] do task unit: [:prepare_for_tests] do
run_tests run_tests
end end
desc "Build and test Unity Framework" desc 'Build and test Unity Framework'
task :all => [:clean, :unit] task all: %i(clean unit)
task :default => [:clobber, :all] task default: %i(clobber all)
task :ci => [:no_color, :default] task ci: %i(no_color default)
task :cruise => [:no_color, :default] task cruise: %i(no_color default)
desc "Load configuration" desc 'Load configuration'
task :config, :config_file do |t, args| task :config, :config_file do |_t, args|
configure_toolchain(args[:config_file]) configure_toolchain(args[:config_file])
end end

127
extras/fixture/rakefile_helper.rb
View File

@ -6,20 +6,19 @@
require 'yaml' require 'yaml'
require 'fileutils' require 'fileutils'
require HERE+'../../auto/unity_test_summary' require HERE + '../../auto/unity_test_summary'
require HERE+'../../auto/generate_test_runner' require HERE + '../../auto/generate_test_runner'
require HERE+'../../auto/colour_reporter' require HERE + '../../auto/colour_reporter'
module RakefileHelpers module RakefileHelpers
C_EXTENSION = '.c'.freeze
C_EXTENSION = '.c'
def load_configuration(config_file) def load_configuration(config_file)
unless ($configured) unless $configured
$cfg_file = HERE+"../../test/targets/#{config_file}" unless (config_file =~ /[\\|\/]/) $cfg_file = HERE + "../../test/targets/#{config_file}" unless config_file =~ /[\\|\/]/
$cfg = YAML.load(File.read($cfg_file)) $cfg = YAML.safe_load(File.read($cfg_file))
$colour_output = false unless $cfg['colour'] $colour_output = false unless $cfg['colour']
$configured = true if (config_file != DEFAULT_CONFIG_FILE) $configured = true if config_file != DEFAULT_CONFIG_FILE
end end
end end
@ -27,7 +26,7 @@ module RakefileHelpers
CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil? CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
end end
def configure_toolchain(config_file=DEFAULT_CONFIG_FILE) def configure_toolchain(config_file = DEFAULT_CONFIG_FILE)
config_file += '.yml' unless config_file =~ /\.yml$/ config_file += '.yml' unless config_file =~ /\.yml$/
config_file = config_file unless config_file =~ /[\\|\/]/ config_file = config_file unless config_file =~ /[\\|\/]/
load_configuration(config_file) load_configuration(config_file)
@ -35,22 +34,22 @@ module RakefileHelpers
end end
def tackit(strings) def tackit(strings)
if strings.is_a?(Array) result = if strings.is_a?(Array)
result = "\"#{strings.join}\"" "\"#{strings.join}\""
else else
result = strings strings
end end
return result result
end end
def squash(prefix, items) def squash(prefix, items)
result = '' result = ''
items.each { |item| result += " #{prefix}#{tackit(item)}" } items.each { |item| result += " #{prefix}#{tackit(item)}" }
return result result
end end
def build_compiler_fields def build_compiler_fields
command = tackit($cfg['compiler']['path']) command = tackit($cfg['compiler']['path'])
if $cfg['compiler']['defines']['items'].nil? if $cfg['compiler']['defines']['items'].nil?
defines = '' defines = ''
else else
@ -59,79 +58,77 @@ module RakefileHelpers
options = squash('', $cfg['compiler']['options']) options = squash('', $cfg['compiler']['options'])
includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items']) includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR) includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
return {:command => command, :defines => defines, :options => options, :includes => includes} { command: command, defines: defines, options: options, includes: includes }
end end
def compile(file, defines=[]) def compile(file, _defines = [])
compiler = build_compiler_fields compiler = build_compiler_fields
unity_include = $cfg['compiler']['includes']['prefix']+'../../src' unity_include = $cfg['compiler']['includes']['prefix'] + '../../src'
cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{unity_include} #{file} " + cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{unity_include} #{file} " \
"#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}" + "#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}" \
"#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}" "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
execute(cmd_str) execute(cmd_str)
end end
def build_linker_fields def build_linker_fields
command = tackit($cfg['linker']['path']) command = tackit($cfg['linker']['path'])
if $cfg['linker']['options'].nil? options = if $cfg['linker']['options'].nil?
options = '' ''
else else
options = squash('', $cfg['linker']['options']) squash('', $cfg['linker']['options'])
end end
if ($cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?) if $cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?
includes = '' includes = ''
else else
includes = squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items']) includes = squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
end end
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR) includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
return {:command => command, :options => options, :includes => includes} { command: command, options: options, includes: includes }
end end
def link_it(exe_name, obj_list) def link_it(exe_name, obj_list)
linker = build_linker_fields linker = build_linker_fields
cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " + cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
(obj_list.map{|obj|"#{$cfg['linker']['object_files']['path']}#{obj} "}).join + (obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj} " }).join +
$cfg['linker']['bin_files']['prefix'] + ' ' + $cfg['linker']['bin_files']['prefix'] + ' ' +
$cfg['linker']['bin_files']['destination'] + $cfg['linker']['bin_files']['destination'] +
exe_name + $cfg['linker']['bin_files']['extension'] exe_name + $cfg['linker']['bin_files']['extension']
execute(cmd_str) execute(cmd_str)
end end
def build_simulator_fields def build_simulator_fields
return nil if $cfg['simulator'].nil? return nil if $cfg['simulator'].nil?
if $cfg['simulator']['path'].nil? command = if $cfg['simulator']['path'].nil?
command = '' ''
else else
command = (tackit($cfg['simulator']['path']) + ' ') (tackit($cfg['simulator']['path']) + ' ')
end end
if $cfg['simulator']['pre_support'].nil? pre_support = if $cfg['simulator']['pre_support'].nil?
pre_support = '' ''
else else
pre_support = squash('', $cfg['simulator']['pre_support']) squash('', $cfg['simulator']['pre_support'])
end end
if $cfg['simulator']['post_support'].nil? if $cfg['simulator']['post_support'].nil?
post_support = '' post_support = ''
else else
post_support = squash('', $cfg['simulator']['post_support']) post_support = squash('', $cfg['simulator']['post_support'])
end end
return {:command => command, :pre_support => pre_support, :post_support => post_support} { command: command, pre_support: pre_support, post_support: post_support }
end end
def execute(command_string, verbose=true) def execute(command_string, verbose = true)
report command_string report command_string
output = `#{command_string}`.chomp output = `#{command_string}`.chomp
report(output) if (verbose && !output.nil? && (output.length > 0)) report(output) if verbose && !output.nil? && !output.empty?
if ($?.exitstatus != 0) raise "Command failed. (Returned #{$CHILD_STATUS.exitstatus})" if $CHILD_STATUS.exitstatus != 0
raise "Command failed. (Returned #{$?.exitstatus})" output
end
return output
end end
def report_summary def report_summary
summary = UnityTestSummary.new summary = UnityTestSummary.new
summary.set_root_path(HERE) summary.set_root_path(HERE)
results_glob = "#{$cfg['compiler']['build_path']}*.test*" results_glob = "#{$cfg['compiler']['build_path']}*.test*"
results_glob.gsub!(/\\/, '/') results_glob.tr!('\\', '/')
results = Dir[results_glob] results = Dir[results_glob]
summary.set_targets(results) summary.set_targets(results)
summary.run summary.run
@ -146,34 +143,34 @@ module RakefileHelpers
$cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil? $cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil?
# Get a list of all source files needed # Get a list of all source files needed
src_files = Dir[HERE+'src/*.c'] src_files = Dir[HERE + 'src/*.c']
src_files += Dir[HERE+'test/*.c'] src_files += Dir[HERE + 'test/*.c']
src_files += Dir[HERE+'test/main/*.c'] src_files += Dir[HERE + 'test/main/*.c']
src_files << '../../src/unity.c' src_files << '../../src/unity.c'
# Build object files # Build object files
src_files.each { |f| compile(f, test_defines) } src_files.each { |f| compile(f, test_defines) }
obj_list = src_files.map {|f| File.basename(f.ext($cfg['compiler']['object_files']['extension'])) } obj_list = src_files.map { |f| File.basename(f.ext($cfg['compiler']['object_files']['extension'])) }
# Link the test executable # Link the test executable
test_base = "framework_test" test_base = 'framework_test'
link_it(test_base, obj_list) link_it(test_base, obj_list)
# Execute unit test and generate results file # Execute unit test and generate results file
simulator = build_simulator_fields simulator = build_simulator_fields
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension'] executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension']
if simulator.nil? if simulator.nil?
cmd_str = executable + " -v -r" cmd_str = executable + ' -v -r'
else else
cmd_str = "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}" cmd_str = "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
end end
output = execute(cmd_str) output = execute(cmd_str)
test_results = $cfg['compiler']['build_path'] + test_base test_results = $cfg['compiler']['build_path'] + test_base
if output.match(/OK$/m).nil? test_results += if output.match(/OK$/m).nil?
test_results += '.testfail' '.testfail'
else else
test_results += '.testpass' '.testpass'
end end
File.open(test_results, 'w') { |f| f.print output } File.open(test_results, 'w') { |f| f.print output }
end end
end end

6
test/.rubocop.yml Normal file
View File

@ -0,0 +1,6 @@
# This is the configuration used to check the rubocop source code.
inherit_from: .rubocop_todo.yml
AllCops:
TargetRubyVersion: 2.1

510
test/.rubocop_todo.yml Normal file
View File

@ -0,0 +1,510 @@
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2017-03-28 08:23:05 -0400 using RuboCop version 0.48.0.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.
# Offense count: 2
Lint/AmbiguousBlockAssociation:
Exclude:
- '../auto/generate_module.rb'
# Offense count: 1
# Cop supports --auto-correct.
Lint/DeprecatedClassMethods:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 7
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyleAlignWith, SupportedStylesAlignWith, AutoCorrect.
# SupportedStylesAlignWith: keyword, variable, start_of_line
Lint/EndAlignment:
Exclude:
- '../auto/colour_prompt.rb'
- '../auto/colour_reporter.rb'
- '../auto/generate_module.rb'
- '../auto/parseOutput.rb'
- '../auto/stylize_as_junit.rb'
# Offense count: 2
Lint/RescueException:
Exclude:
- '../auto/stylize_as_junit.rb'
- '../auto/unity_test_summary.rb'
# Offense count: 2
Lint/ShadowingOuterLocalVariable:
Exclude:
- '../auto/generate_module.rb'
- '../auto/stylize_as_junit.rb'
# Offense count: 3
# Cop supports --auto-correct.
Lint/StringConversionInInterpolation:
Exclude:
- 'tests/test_generate_test_runner.rb'
# Offense count: 13
Lint/UselessAssignment:
Exclude:
- '../auto/generate_test_runner.rb'
- '../auto/stylize_as_junit.rb'
- '../auto/unity_test_summary.rb'
- 'rakefile_helper.rb'
# Offense count: 5
Lint/Void:
Exclude:
- '../auto/parseOutput.rb'
# Offense count: 45
Metrics/AbcSize:
Max: 80
# Offense count: 6
# Configuration parameters: CountComments, ExcludedMethods.
Metrics/BlockLength:
Max: 89
# Offense count: 4
# Configuration parameters: CountComments.
Metrics/ClassLength:
Max: 341
# Offense count: 14
Metrics/CyclomaticComplexity:
Max: 17
# Offense count: 226
# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
# URISchemes: http, https
Metrics/LineLength:
Max: 154
# Offense count: 39
# Configuration parameters: CountComments.
Metrics/MethodLength:
Max: 58
# Offense count: 3
# Configuration parameters: CountComments.
Metrics/ModuleLength:
Max: 204
# Offense count: 13
Metrics/PerceivedComplexity:
Max: 19
# Offense count: 2
# Cop supports --auto-correct.
Performance/StringReplacement:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 1
# Cop supports --auto-correct.
Security/YAMLLoad:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 10
Style/AccessorMethodName:
Exclude:
- '../auto/stylize_as_junit.rb'
- '../auto/unity_test_summary.rb'
- '../examples/example_3/rakefile_helper.rb'
- 'rakefile_helper.rb'
# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
# SupportedStyles: line_count_based, semantic, braces_for_chaining
# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
# FunctionalMethods: let, let!, subject, watch
# IgnoredMethods: lambda, proc, it
Style/BlockDelimiters:
Exclude:
- 'spec/generate_module_existing_file_spec.rb'
# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, SingleLineConditionsOnly, IncludeTernaryExpressions.
# SupportedStyles: assign_to_condition, assign_inside_condition
Style/ConditionalAssignment:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 12
Style/Documentation:
Exclude:
- 'spec/**/*'
- 'test/**/*'
- '../auto/colour_prompt.rb'
- '../auto/generate_module.rb'
- '../auto/generate_test_runner.rb'
- '../auto/parseOutput.rb'
- '../auto/stylize_as_junit.rb'
- '../auto/test_file_filter.rb'
- '../auto/type_sanitizer.rb'
- '../auto/unity_test_summary.rb'
- '../examples/example_3/rakefile_helper.rb'
- '../extras/fixture/rakefile_helper.rb'
- 'rakefile_helper.rb'
# Offense count: 2
# Cop supports --auto-correct.
Style/ElseAlignment:
Exclude:
- '../auto/generate_test_runner.rb'
# Offense count: 3
# Cop supports --auto-correct.
Style/EmptyLines:
Exclude:
- 'tests/test_generate_test_runner.rb'
# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: empty_lines, no_empty_lines
Style/EmptyLinesAroundBlockBody:
Exclude:
- 'rakefile_helper.rb'
- 'spec/generate_module_existing_file_spec.rb'
# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
Style/EmptyLinesAroundModuleBody:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 14
# Cop supports --auto-correct.
# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
Style/ExtraSpacing:
Exclude:
- '../auto/generate_test_runner.rb'
- 'rakefile_helper.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 1
# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
Style/FileName:
Exclude:
- '../auto/parseOutput.rb'
# Offense count: 4
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: format, sprintf, percent
Style/FormatString:
Exclude:
- '../auto/generate_module.rb'
# Offense count: 164
# Configuration parameters: AllowedVariables.
Style/GlobalVars:
Exclude:
- '../auto/colour_reporter.rb'
- '../examples/example_3/rakefile_helper.rb'
- '../extras/fixture/rakefile.rb'
- '../extras/fixture/rakefile_helper.rb'
- 'rakefile_helper.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 20
# Configuration parameters: MinBodyLength.
Style/GuardClause:
Exclude:
- '../auto/colour_prompt.rb'
- '../auto/generate_test_runner.rb'
- '../auto/parseOutput.rb'
- '../auto/stylize_as_junit.rb'
- '../auto/test_file_filter.rb'
- '../auto/unity_test_summary.rb'
- '../extras/fixture/rakefile_helper.rb'
- 'rakefile_helper.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 630
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
Style/HashSyntax:
Exclude:
- 'rakefile_helper.rb'
- 'spec/generate_module_existing_file_spec.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: MaxLineLength.
Style/IfUnlessModifier:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: IndentationWidth.
Style/IndentAssignment:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 5
# Cop supports --auto-correct.
# Configuration parameters: Width, IgnoredPatterns.
Style/IndentationWidth:
Exclude:
- '../auto/generate_test_runner.rb'
- 'spec/generate_module_existing_file_spec.rb'
# Offense count: 17
# Cop supports --auto-correct.
Style/LeadingCommentSpace:
Exclude:
- 'rakefile_helper.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 1
# Cop supports --auto-correct.
Style/LineEndConcatenation:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 8
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: snake_case, camelCase
Style/MethodName:
Exclude:
- '../auto/parseOutput.rb'
# Offense count: 40
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: symmetrical, new_line, same_line
Style/MultilineArrayBraceLayout:
Exclude:
- 'tests/test_generate_test_runner.rb'
# Offense count: 63
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: symmetrical, new_line, same_line
Style/MultilineHashBraceLayout:
Exclude:
- 'tests/test_generate_test_runner.rb'
# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
# SupportedStyles: aligned, indented
Style/MultilineOperationIndentation:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 3
# Cop supports --auto-correct.
Style/MutableConstant:
Exclude:
- 'rakefile_helper.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: both, prefix, postfix
Style/NegatedIf:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 1
# Cop supports --auto-correct.
Style/Not:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: AutoCorrect, EnforcedStyle, SupportedStyles.
# SupportedStyles: predicate, comparison
Style/NumericPredicate:
Exclude:
- 'spec/**/*'
- '../auto/colour_reporter.rb'
- '../auto/generate_module.rb'
# Offense count: 17
# Cop supports --auto-correct.
# Configuration parameters: AllowSafeAssignment.
Style/ParenthesesAroundCondition:
Exclude:
- '../auto/generate_test_runner.rb'
- 'rakefile_helper.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 7
# Cop supports --auto-correct.
Style/RedundantParentheses:
Exclude:
- '../auto/generate_test_runner.rb'
- 'rakefile_helper.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 13
# Cop supports --auto-correct.
# Configuration parameters: AllowMultipleReturnValues.
Style/RedundantReturn:
Exclude:
- 'rakefile_helper.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 13
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
# SupportedStyles: slashes, percent_r, mixed
Style/RegexpLiteral:
Exclude:
- '../auto/generate_test_runner.rb'
- '../auto/stylize_as_junit.rb'
- '../auto/type_sanitizer.rb'
- '../auto/unity_test_summary.rb'
- '../extras/fixture/rakefile_helper.rb'
- 'rakefile_helper.rb'
# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: AllowAsExpressionSeparator.
Style/Semicolon:
Exclude:
- '../auto/generate_test_runner.rb'
# Offense count: 5
# Cop supports --auto-correct.
Style/SpaceAfterComma:
Exclude:
- 'tests/test_generate_test_runner.rb'
# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyleInsidePipes, SupportedStylesInsidePipes.
# SupportedStylesInsidePipes: space, no_space
Style/SpaceAroundBlockParameters:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: space, no_space
Style/SpaceAroundEqualsInParameterDefault:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: AllowForAlignment.
Style/SpaceAroundOperators:
Exclude:
- 'rakefile_helper.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: space, no_space
Style/SpaceBeforeBlockBraces:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 13
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SupportedStylesForEmptyBraces, SpaceBeforeBlockParameters.
# SupportedStyles: space, no_space
# SupportedStylesForEmptyBraces: space, no_space
Style/SpaceInsideBlockBraces:
Exclude:
- 'rakefile_helper.rb'
- 'spec/generate_module_existing_file_spec.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 295
# Cop supports --auto-correct.
Style/SpaceInsideBrackets:
Exclude:
- 'tests/test_generate_test_runner.rb'
# Offense count: 6
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SupportedStylesForEmptyBraces.
# SupportedStyles: space, no_space, compact
# SupportedStylesForEmptyBraces: space, no_space
Style/SpaceInsideHashLiteralBraces:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 5
# Cop supports --auto-correct.
Style/SpaceInsideParens:
Exclude:
- 'tests/test_generate_test_runner.rb'
# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: use_perl_names, use_english_names
Style/SpecialGlobalVars:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 167
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiterals:
Exclude:
- 'rakefile_helper.rb'
- 'spec/generate_module_existing_file_spec.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowSafeAssignment.
# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
Style/TernaryParentheses:
Exclude:
- 'rakefile_helper.rb'
# Offense count: 152
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyleForMultiline, SupportedStylesForMultiline.
# SupportedStylesForMultiline: comma, consistent_comma, no_comma
Style/TrailingCommaInLiteral:
Exclude:
- 'spec/generate_module_existing_file_spec.rb'
- 'tests/test_generate_test_runner.rb'
# Offense count: 39
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: snake_case, camelCase
Style/VariableName:
Exclude:
- '../auto/parseOutput.rb'
# Offense count: 69
# Cop supports --auto-correct.
# Configuration parameters: SupportedStyles, WordRegex.
# SupportedStyles: percent, brackets
Style/WordArray:
EnforcedStyle: percent
MinSize: 12
# Offense count: 1
# Cop supports --auto-correct.
Style/ZeroLengthPredicate:
Exclude:
- 'rakefile_helper.rb'

24
test/rakefile
View File

@ -53,7 +53,7 @@ task :summary do
end end
desc "Build and test Unity" desc "Build and test Unity"
task :all => [:clean, :prepare_for_tests, :scripts, :unit, :summary] task :all => [:clean, :prepare_for_tests, :scripts, :unit, :style, :summary]
task :default => [:clobber, :all] task :default => [:clobber, :all]
task :ci => [:no_color, :default] task :ci => [:no_color, :default]
task :cruise => [:no_color, :default] task :cruise => [:no_color, :default]
@ -70,3 +70,25 @@ end
task :verbose do task :verbose do
$verbose = true $verbose = true
end end
namespace :style do
desc "Check style"
task :check do
`rubocop ../`
report "Style Checked."
end
desc "Attempt to Autocorrect style"
task :auto do
`rubocop ../ --auto-correct`
report "Autocorrected What We Could."
end
desc "Update style todo list"
task :todo do
`rubocop ../ --auto-gen-config`
report "Updated Style TODO List."
end
end
task :style => ['style:check']

10
test/tests/test_generate_test_runner.rb
View File

@ -1170,11 +1170,11 @@ def runner_test(test, runner, expected, test_defines, cmdline_args)
simulator = build_simulator_fields simulator = build_simulator_fields
cmdline_args ||= "" cmdline_args ||= ""
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension'] + " #{cmdline_args}" executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension'] + " #{cmdline_args}"
if simulator.nil? cmd_str = if simulator.nil?
cmd_str = executable executable
else else
cmd_str = "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}" "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
end end
output = execute(cmd_str, true) output = execute(cmd_str, true)
#compare to the expected pass/fail #compare to the expected pass/fail