diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fcae2ad64..339bd23a1 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -15,12 +15,15 @@ jobs: unit-tests: name: "Unit Tests" runs-on: ubuntu-latest + strategy: + matrix: + ruby: ['2.7', '3.0', '3.1', '3.2'] steps: # Install Ruby Testing Tools - name: Setup Ruby Testing Tools run: | sudo gem install rspec - sudo gem install rubocop -v 0.57.2 + sudo gem install rubocop -v 1.57.2 # Checks out repository under $GITHUB_WORKSPACE - name: Checkout Latest Repo diff --git a/.gitignore b/.gitignore index e4bb017b1..211683a8b 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ build/ builddir/ test/sandbox .DS_Store +examples/example_1/subprojects/unity examples/example_1/test1.exe examples/example_1/test2.exe examples/example_2/all_tests.exe @@ -11,3 +12,8 @@ examples/example_2/all_tests.out examples/example_4/builddir *.sublime-project *.sublime-workspace +*.cmake +Makefile +CMakeFiles +CMakeCache.txt +!unityConfig.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index 3a16cdcc1..f7062199e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -49,11 +49,11 @@ set(UNITY_EXTENSION_FIXTURE_ENABLED $) set(UNITY_EXTENSION_MEMORY_ENABLED $>) if(${UNITY_EXTENSION_FIXTURE}) - message(STATUS "Unity: Bulding with the fixture extension.") + message(STATUS "Unity: Building with the fixture extension.") endif() if(${UNITY_EXTENSION_MEMORY}) - message(STATUS "Unity: Bulding with the memory extension.") + message(STATUS "Unity: Building with the memory extension.") endif() # Main target ------------------------------------------------------------------ @@ -76,6 +76,7 @@ target_include_directories(${PROJECT_NAME} $ $ $ + $ $:${CMAKE_CURRENT_SOURCE_DIR}/extras/memory/src>> $:${CMAKE_CURRENT_SOURCE_DIR}/extras/fixture/src>> ) @@ -99,37 +100,49 @@ set_target_properties(${PROJECT_NAME} target_compile_options(${PROJECT_NAME} PRIVATE - $<$:-Wcast-align - -Wcast-qual - -Wconversion - -Wexit-time-destructors - -Wglobal-constructors - -Wmissing-noreturn - -Wmissing-prototypes - -Wno-missing-braces - -Wold-style-cast - -Wshadow - -Wweak-vtables - -Werror - -Wall> - $<$:-Waddress - -Waggregate-return - -Wformat-nonliteral - -Wformat-security - -Wformat - -Winit-self - -Wmissing-declarations - -Wmissing-include-dirs - -Wno-multichar - -Wno-parentheses - -Wno-type-limits - -Wno-unused-parameter - -Wunreachable-code - -Wwrite-strings - -Wpointer-arith - -Werror - -Wall> - $<$:/Wall> + # Clang + $<$: + -Wcast-align + -Wcast-qual + -Wconversion + -Wexit-time-destructors + -Wglobal-constructors + -Wmissing-noreturn + -Wmissing-prototypes + -Wno-missing-braces + -Wold-style-cast + -Wshadow + -Wweak-vtables + -Werror + -Wall + $<$,8.0.0>:-Wextra-semi-stmt> + > + + # GCC + $<$: + -Waddress + -Waggregate-return + -Wformat-nonliteral + -Wformat-security + -Wformat + -Winit-self + -Wmissing-declarations + -Wmissing-include-dirs + -Wno-multichar + -Wno-parentheses + -Wno-type-limits + -Wno-unused-parameter + -Wunreachable-code + -Wwrite-strings + -Wpointer-arith + -Werror + -Wall + > + + # MSVC + $<$: + /Wall + > ) write_basic_package_version_file(${PROJECT_NAME}ConfigVersion.cmake diff --git a/LICENSE.txt b/LICENSE.txt index b9a329dde..e12b59e66 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2007-21 Mike Karlesky, Mark VanderVoord, Greg Williams +Copyright (c) 2007-24 Mike Karlesky, Mark VanderVoord, Greg Williams Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index cab2de39f..71488b3e9 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,28 @@ -Unity Test ![CI](https://github.com/ThrowTheSwitch/Unity/workflows/CI/badge.svg) -========== -__Copyright (c) 2007 - 2021 Unity Project by Mike Karlesky, Mark VanderVoord, and Greg Williams__ +# Unity Test ![CI][] -Welcome to the Unity Test Project, one of the main projects of ThrowTheSwitch.org. Unity Test is a -unit testing framework built for C, with a focus on working with embedded toolchains. +__Copyright (c) 2007 - 2023 Unity Project by Mike Karlesky, Mark VanderVoord, and Greg Williams__ -This project is made to test code targetting microcontrollers big and small. The core project is a -single C file and a pair of headers, allowing it to the added to your existing build setup without -too much headache. You may use any compiler you wish, and may use most existing build systems -including make, cmake, etc. If you'd like to leave the hard work to us, you might be interested -in Ceedling, a build tool also by ThrowTheSwitch.org. +Welcome to the Unity Test Project, one of the main projects of ThrowTheSwitch.org. +Unity Test is a unit testing framework built for C, with a focus on working with embedded toolchains. -If you're new to Unity, we encourage you to tour the [getting started guide](docs/UnityGettingStartedGuide.md) +This project is made to test code targetting microcontrollers big and small. +The core project is a single C file and a pair of headers, allowing it to be added to your existing build setup without too much headache. +You may use any compiler you wish, and may use most existing build systems including Make, CMake, etc. +If you'd like to leave the hard work to us, you might be interested in Ceedling, a build tool also by ThrowTheSwitch.org. -Getting Started -=============== -The [docs](docs/) folder contains a [getting started guide](docs/UnityGettingStartedGuide.md) -and much more tips about using Unity. +If you're new to Unity, we encourage you to tour the [getting started guide][]. -Unity Assertion Summary -======================= -For the full list, see [UnityAssertionsReference.md](docs/UnityAssertionsReference.md). +You can also find the [change log][] and [known issues][] in our documentation. -Basic Validity Tests --------------------- +## Getting Started + +The [docs][] folder contains a [getting started guide][] and much more tips about using Unity. + +## Unity Assertion Summary + +For the full list, see [UnityAssertionsReference.md][]. + +### Basic Validity Tests TEST_ASSERT_TRUE(condition) @@ -44,10 +43,10 @@ Another way of calling `TEST_ASSERT_FALSE` TEST_FAIL() TEST_FAIL_MESSAGE(message) -This test is automatically marked as a failure. The message is output stating why. +This test is automatically marked as a failure. +The message is output stating why. -Numerical Assertions: Integers ------------------------------- +### Numerical Assertions: Integers TEST_ASSERT_EQUAL_INT(expected, actual) TEST_ASSERT_EQUAL_INT8(expected, actual) @@ -55,9 +54,9 @@ Numerical Assertions: Integers TEST_ASSERT_EQUAL_INT32(expected, actual) TEST_ASSERT_EQUAL_INT64(expected, actual) -Compare two integers for equality and display errors as signed integers. A cast will be performed -to your natural integer size so often this can just be used. When you need to specify the exact size, -like when comparing arrays, you can use a specific version: +Compare two integers for equality and display errors as signed integers. +A cast will be performed to your natural integer size so often this can just be used. +When you need to specify the exact size, you can use a specific version. TEST_ASSERT_EQUAL_UINT(expected, actual) TEST_ASSERT_EQUAL_UINT8(expected, actual) @@ -65,8 +64,8 @@ like when comparing arrays, you can use a specific version: TEST_ASSERT_EQUAL_UINT32(expected, actual) TEST_ASSERT_EQUAL_UINT64(expected, actual) -Compare two integers for equality and display errors as unsigned integers. Like INT, there are -variants for different sizes also. +Compare two integers for equality and display errors as unsigned integers. +Like INT, there are variants for different sizes also. TEST_ASSERT_EQUAL_HEX(expected, actual) TEST_ASSERT_EQUAL_HEX8(expected, actual) @@ -74,9 +73,9 @@ variants for different sizes also. TEST_ASSERT_EQUAL_HEX32(expected, actual) TEST_ASSERT_EQUAL_HEX64(expected, actual) -Compares two integers for equality and display errors as hexadecimal. Like the other integer comparisons, -you can specify the size... here the size will also effect how many nibbles are shown (for example, `HEX16` -will show 4 nibbles). +Compares two integers for equality and display errors as hexadecimal. +Like the other integer comparisons, you can specify the size... +here the size will also effect how many nibbles are shown (for example, `HEX16` will show 4 nibbles). TEST_ASSERT_EQUAL(expected, actual) @@ -84,96 +83,126 @@ Another way of calling TEST_ASSERT_EQUAL_INT TEST_ASSERT_INT_WITHIN(delta, expected, actual) -Asserts that the actual value is within plus or minus delta of the expected value. This also comes in -size specific variants. - +Asserts that the actual value is within plus or minus delta of the expected value. +This also comes in size specific variants. TEST_ASSERT_GREATER_THAN(threshold, actual) -Asserts that the actual value is greater than the threshold. This also comes in size specific variants. - +Asserts that the actual value is greater than the threshold. +This also comes in size specific variants. TEST_ASSERT_LESS_THAN(threshold, actual) -Asserts that the actual value is less than the threshold. This also comes in size specific variants. - +Asserts that the actual value is less than the threshold. +This also comes in size specific variants. -Arrays ------- +### Arrays _ARRAY -You can append `_ARRAY` to any of these macros to make an array comparison of that type. Here you will -need to care a bit more about the actual size of the value being checked. You will also specify an -additional argument which is the number of elements to compare. For example: +You can append `_ARRAY` to any of these macros to make an array comparison of that type. +Here you will need to care a bit more about the actual size of the value being checked. +You will also specify an additional argument which is the number of elements to compare. +For example: TEST_ASSERT_EQUAL_HEX8_ARRAY(expected, actual, elements) _EACH_EQUAL -Another array comparison option is to check that EVERY element of an array is equal to a single expected -value. You do this by specifying the EACH_EQUAL macro. For example: +Another array comparison option is to check that EVERY element of an array is equal to a single expected value. +You do this by specifying the EACH_EQUAL macro. +For example: TEST_ASSERT_EACH_EQUAL_INT32(expected, actual, elements) -Numerical Assertions: Bitwise ------------------------------ +### Numerical Assertions: Bitwise TEST_ASSERT_BITS(mask, expected, actual) -Use an integer mask to specify which bits should be compared between two other integers. High bits in the mask are compared, low bits ignored. +Use an integer mask to specify which bits should be compared between two other integers. +High bits in the mask are compared, low bits ignored. TEST_ASSERT_BITS_HIGH(mask, actual) -Use an integer mask to specify which bits should be inspected to determine if they are all set high. High bits in the mask are compared, low bits ignored. +Use an integer mask to specify which bits should be inspected to determine if they are all set high. +High bits in the mask are compared, low bits ignored. TEST_ASSERT_BITS_LOW(mask, actual) -Use an integer mask to specify which bits should be inspected to determine if they are all set low. High bits in the mask are compared, low bits ignored. +Use an integer mask to specify which bits should be inspected to determine if they are all set low. +High bits in the mask are compared, low bits ignored. TEST_ASSERT_BIT_HIGH(bit, actual) -Test a single bit and verify that it is high. The bit is specified 0-31 for a 32-bit integer. +Test a single bit and verify that it is high. +The bit is specified 0-31 for a 32-bit integer. TEST_ASSERT_BIT_LOW(bit, actual) -Test a single bit and verify that it is low. The bit is specified 0-31 for a 32-bit integer. +Test a single bit and verify that it is low. +The bit is specified 0-31 for a 32-bit integer. -Numerical Assertions: Floats ----------------------------- +### Numerical Assertions: Floats TEST_ASSERT_FLOAT_WITHIN(delta, expected, actual) + TEST_ASSERT_DOUBLE_WITHIN(delta, expected, actual) Asserts that the actual value is within plus or minus delta of the expected value. + TEST_ASSERT_FLOAT_NOT_WITHIN(delta, expected, actual) + TEST_ASSERT_DOUBLE_NOT_WITHIN(delta, expected, actual) + +Asserts that the actual value is NOT within plus or minus delta of the expected value. + TEST_ASSERT_EQUAL_FLOAT(expected, actual) TEST_ASSERT_EQUAL_DOUBLE(expected, actual) Asserts that two floating point values are "equal" within a small % delta of the expected value. -String Assertions ------------------ + TEST_ASSERT_NOT_EQUAL_FLOAT(expected, actual) + TEST_ASSERT_NOT_EQUAL_DOUBLE(expected, actual) + +Asserts that two floating point values are NOT "equal" within a small % delta of the expected value. + + TEST_ASSERT_LESS_THAN_FLOAT(threshold, actual) + TEST_ASSERT_LESS_THAN_DOUBLE(threshold, actual) + TEST_ASSERT_GREATER_THAN_FLOAT(threshold, actual) + TEST_ASSERT_GREATER_THAN_DOUBLE(threshold, actual) + +Asserts that the actual value is less than or greater than the threshold. + +There are also `LESS_OR_EQUAL` and `GREATER_OR_EQUAL` variations. +These obey the same rules for equality as do `TEST_ASSERT_EQUAL_FLOAT` and `TEST_ASSERT_EQUAL_DOUBLE`: +If the two values are within a small % delta of the expected value, the assertion will pass. + +### String Assertions TEST_ASSERT_EQUAL_STRING(expected, actual) -Compare two null-terminate strings. Fail if any character is different or if the lengths are different. +Compare two null-terminate strings. +Fail if any character is different or if the lengths are different. TEST_ASSERT_EQUAL_STRING_LEN(expected, actual, len) -Compare two strings. Fail if any character is different, stop comparing after len characters. +Compare two strings. +Fail if any character is different, stop comparing after len characters. TEST_ASSERT_EQUAL_STRING_MESSAGE(expected, actual, message) -Compare two null-terminate strings. Fail if any character is different or if the lengths are different. Output a custom message on failure. +Compare two null-terminate strings. +Fail if any character is different or if the lengths are different. +Output a custom message on failure. TEST_ASSERT_EQUAL_STRING_LEN_MESSAGE(expected, actual, len, message) -Compare two strings. Fail if any character is different, stop comparing after len characters. Output a custom message on failure. +Compare two strings. +Fail if any character is different, stop comparing after len characters. +Output a custom message on failure. -Pointer Assertions ------------------- +### Pointer Assertions -Most pointer operations can be performed by simply using the integer comparisons above. However, a couple of special cases are added for clarity. +Most pointer operations can be performed by simply using the integer comparisons above. +However, a couple of special cases are added for clarity. TEST_ASSERT_NULL(pointer) @@ -183,18 +212,23 @@ Fails if the pointer is not equal to NULL Fails if the pointer is equal to NULL -Memory Assertions ------------------ +### Memory Assertions TEST_ASSERT_EQUAL_MEMORY(expected, actual, len) -Compare two blocks of memory. This is a good generic assertion for types that can't be coerced into acting like -standard types... but since it's a memory compare, you have to be careful that your data types are packed. +Compare two blocks of memory. +This is a good generic assertion for types that can't be coerced into acting like standard types... +but since it's a memory compare, you have to be careful that your data types are packed. -\_MESSAGE ---------- +### \_MESSAGE -you can append \_MESSAGE to any of the macros to make them take an additional argument. This argument -is a string that will be printed at the end of the failure strings. This is useful for specifying more -information about the problem. +You can append `\_MESSAGE` to any of the macros to make them take an additional argument. +This argument is a string that will be printed at the end of the failure strings. +This is useful for specifying more information about the problem. +[CI]: https://github.com/ThrowTheSwitch/Unity/workflows/CI/badge.svg +[getting started guide]: docs/UnityGettingStartedGuide.md +[change log]: docs/UnityChangeLog.md +[known issues]: docs/UnityKnownIssues.md +[docs]: docs/ +[UnityAssertionsReference.md]: docs/UnityAssertionsReference.md diff --git a/auto/__init__.py b/auto/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/auto/colour_reporter.rb b/auto/colour_reporter.rb index 1c3bc2162..b86b76c5d 100644 --- a/auto/colour_reporter.rb +++ b/auto/colour_reporter.rb @@ -12,7 +12,7 @@ def report(message) if !$colour_output $stdout.puts(message) else - message = message.join('\n') if message.class == Array + message = message.join('\n') if message.instance_of?(Array) message.each_line do |line| line.chomp! colour = case line diff --git a/auto/extract_version.py b/auto/extract_version.py new file mode 100755 index 000000000..1d137e5bd --- /dev/null +++ b/auto/extract_version.py @@ -0,0 +1,15 @@ +#!/usr/bin/env python3 +import re +import sys + +ver_re = re.compile(r"^#define\s+UNITY_VERSION_(?:MAJOR|MINOR|BUILD)\s+(\d+)$") +version = [] + +with open(sys.argv[1], "r") as f: + for line in f: + m = ver_re.match(line) + if m: + version.append(m.group(1)) + +print(".".join(version)) + diff --git a/auto/generate_module.rb b/auto/generate_module.rb index 0a88becc9..7b33c727f 100644 --- a/auto/generate_module.rb +++ b/auto/generate_module.rb @@ -13,7 +13,7 @@ require 'pathname' # TEMPLATE_TST -TEMPLATE_TST ||= '#ifdef TEST +TEMPLATE_TST ||= '#ifdef %5$s #include "unity.h" @@ -32,7 +32,7 @@ TEST_IGNORE_MESSAGE("Need to Implement %1$s"); } -#endif // TEST +#endif // %5$s '.freeze # TEMPLATE_SRC @@ -108,7 +108,8 @@ def self.default_options update_svn: false, boilerplates: {}, test_prefix: 'Test', - mock_prefix: 'Mock' + mock_prefix: 'Mock', + test_define: 'TEST' } end @@ -116,8 +117,8 @@ def self.default_options def self.grab_config(config_file) options = default_options unless config_file.nil? || config_file.empty? - require 'yaml' - yaml_guts = YAML.load_file(config_file) + require_relative 'yaml_helper' + yaml_guts = YamlHelper.load_file(config_file) options.merge!(yaml_guts[:unity] || yaml_guts[:cmock]) raise "No :unity or :cmock section found in #{config_file}" unless options end @@ -132,9 +133,9 @@ def files_to_operate_on(module_name, pattern = nil) # create triad definition 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: '.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], test_define: @options[:test_define] }] # prepare the pattern for use pattern = (pattern || @options[:pattern] || 'src').downcase @@ -154,6 +155,7 @@ def files_to_operate_on(module_name, pattern = nil) path: (Pathname.new("#{cfg[:path]}#{subfolder}") + filename).cleanpath, name: submodule_name, template: cfg[:template], + test_define: cfg[:test_define], boilerplate: cfg[:boilerplate], includes: case (cfg[:inc]) when :src then (@options[:includes][:src] || []) | (pattern_traits[:inc].map { |f| format(f, module_name) }) @@ -168,18 +170,19 @@ def files_to_operate_on(module_name, pattern = nil) end ############################ - def neutralize_filename(name, start_cap = true) + def neutralize_filename(name, start_cap: true) return name if name.empty? - name = name.split(/(?:\s+|_|(?=[A-Z][a-z]))|(?<=[a-z])(?=[A-Z])/).map { |v| v.capitalize }.join('_') - name = name[0].downcase + name[1..-1] unless start_cap - return name + + name = name.split(/(?:\s+|_|(?=[A-Z][a-z]))|(?<=[a-z])(?=[A-Z])/).map(&:capitalize).join('_') + name = name[0].downcase + name[1..] unless start_cap + name end ############################ def create_filename(part1, part2 = '') - name = part2.empty? ? part1 : part1 + '_' + part2 + name = part2.empty? ? part1 : "#{part1}_#{part2}" case (@options[:naming]) - when 'bumpy' then neutralize_filename(name,false).delete('_') + when 'bumpy' then neutralize_filename(name, start_cap: false).delete('_') when 'camel' then neutralize_filename(name).delete('_') when 'snake' then neutralize_filename(name).downcase when 'caps' then neutralize_filename(name).upcase @@ -211,8 +214,9 @@ def generate(module_name, pattern = nil) f.write("#{file[:boilerplate]}\n" % [file[:name]]) unless file[:boilerplate].nil? f.write(file[:template] % [file[:name], file[:includes].map { |ff| "#include \"#{ff}\"\n" }.join, - file[:name].upcase.gsub(/-/, '_'), - file[:name].gsub(/-/, '_')]) + file[:name].upcase.tr('-', '_'), + file[:name].tr('-', '_'), + file[:test_define]]) end if @options[:update_svn] `svn add \"#{file[:path]}\"` @@ -260,12 +264,12 @@ def destroy(module_name, pattern = nil) case arg when /^-d/ then destroy = true when /^-u/ then options[:update_svn] = true - when /^-p\"?(\w+)\"?/ then options[:pattern] = Regexp.last_match(1) - when /^-s\"?(.+)\"?/ then options[:path_src] = Regexp.last_match(1) - when /^-i\"?(.+)\"?/ then options[:path_inc] = Regexp.last_match(1) - when /^-t\"?(.+)\"?/ then options[:path_tst] = Regexp.last_match(1) - when /^-n\"?(.+)\"?/ then options[:naming] = Regexp.last_match(1) - when /^-y\"?(.+)\"?/ then options = UnityModuleGenerator.grab_config(Regexp.last_match(1)) + when /^-p"?(\w+)"?/ then options[:pattern] = Regexp.last_match(1) + when /^-s"?(.+)"?/ then options[:path_src] = Regexp.last_match(1) + when /^-i"?(.+)"?/ then options[:path_inc] = Regexp.last_match(1) + when /^-t"?(.+)"?/ then options[:path_tst] = Regexp.last_match(1) + when /^-n"?(.+)"?/ then options[:naming] = Regexp.last_match(1) + when /^-y"?(.+)"?/ then options = UnityModuleGenerator.grab_config(Regexp.last_match(1)) when /^(\w+)/ raise "ERROR: You can't have more than one Module name specified!" unless module_name.nil? diff --git a/auto/generate_test_runner.rb b/auto/generate_test_runner.rb old mode 100644 new mode 100755 index ea0b2c4a2..102f6f30a --- a/auto/generate_test_runner.rb +++ b/auto/generate_test_runner.rb @@ -1,3 +1,5 @@ +#!/usr/bin/ruby + # ========================================== # Unity Project - A Test Framework for C # Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams @@ -43,6 +45,7 @@ def self.default_options cmdline_args: false, omit_begin_end: false, use_param_tests: false, + use_system_files: true, include_extensions: '(?:hpp|hh|H|h)', source_extensions: '(?:cpp|cc|ino|C|c)' } @@ -51,8 +54,8 @@ def self.default_options def self.grab_config(config_file) options = default_options unless config_file.nil? || config_file.empty? - require 'yaml' - yaml_guts = YAML.load_file(config_file) + require_relative 'yaml_helper' + yaml_guts = YamlHelper.load_file(config_file) options.merge!(yaml_guts[:unity] || yaml_guts[:cmock]) raise "No :unity or :cmock section found in #{config_file}" unless options end @@ -67,7 +70,7 @@ def run(input_file, output_file, options = nil) source = source.force_encoding('ISO-8859-1').encode('utf-8', replace: nil) tests = find_tests(source) headers = find_includes(source) - testfile_includes = (headers[:local] + headers[:system]) + testfile_includes = @options[:use_system_files] ? (headers[:local] + headers[:system]) : (headers[:local]) used_mocks = find_mocks(testfile_includes) testfile_includes = (testfile_includes - used_mocks) testfile_includes.delete_if { |inc| inc =~ /(unity|cmock)/ } @@ -78,7 +81,7 @@ def run(input_file, output_file, options = nil) # determine which files were used to return them 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 += headers[:linkonly] unless headers[:linkonly].empty? all_files_used.uniq @@ -130,7 +133,8 @@ def find_tests(source) lines.each_with_index do |line, _index| # find tests - next unless line =~ /^((?:\s*(?:TEST_CASE|TEST_RANGE)\s*\(.*?\)\s*)*)\s*void\s+((?:#{@options[:test_prefix]}).*)\s*\(\s*(.*)\s*\)/m + next unless line =~ /^((?:\s*(?:TEST_(?:CASE|RANGE|MATRIX))\s*\(.*?\)\s*)*)\s*void\s+((?:#{@options[:test_prefix]}).*)\s*\(\s*(.*)\s*\)/m + next unless line =~ /^((?:\s*(?:TEST_(?:CASE|RANGE|MATRIX))\s*\(.*?\)\s*)*)\s*void\s+((?:#{@options[:test_prefix]})\w*)\s*\(\s*(.*)\s*\)/m arguments = Regexp.last_match(1) name = Regexp.last_match(2) @@ -140,19 +144,38 @@ def find_tests(source) if @options[:use_param_tests] && !arguments.empty? args = [] - arguments.scan(/\s*TEST_CASE\s*\((.*)\)\s*$/) { |a| args << a[0] } + type_and_args = arguments.split(/TEST_(CASE|RANGE|MATRIX)/) + (1...type_and_args.length).step(2).each do |i| + case type_and_args[i] + when 'CASE' + args << type_and_args[i + 1].sub(/^\s*\(\s*(.*?)\s*\)\s*$/m, '\1') + + when 'RANGE' + args += type_and_args[i + 1].scan(/(\[|<)\s*(-?\d+.?\d*)\s*,\s*(-?\d+.?\d*)\s*,\s*(-?\d+.?\d*)\s*(\]|>)/m).map do |arg_values_str| + exclude_end = arg_values_str[0] == '<' && arg_values_str[-1] == '>' + arg_values_str[1...-1].map do |arg_value_str| + arg_value_str.include?('.') ? arg_value_str.to_f : arg_value_str.to_i + end.push(exclude_end) + end.map do |arg_values| + Range.new(arg_values[0], arg_values[1], arg_values[3]).step(arg_values[2]).to_a + end.reduce(nil) do |result, arg_range_expanded| + result.nil? ? arg_range_expanded.map { |a| [a] } : result.product(arg_range_expanded) + end.map do |arg_combinations| + arg_combinations.flatten.join(', ') + end - arguments.scan(/\s*TEST_RANGE\s*\((.*)\)\s*$/).flatten.each do |range_str| - args += range_str.scan(/\[(-?\d+.?\d*), *(-?\d+.?\d*), *(-?\d+.?\d*)\]/).map do |arg_values_str| - arg_values_str.map do |arg_value_str| - arg_value_str.include?('.') ? arg_value_str.to_f : arg_value_str.to_i + when 'MATRIX' + single_arg_regex_string = /(?:(?:"(?:\\"|[^\\])*?")+|(?:'\\?.')+|(?:[^\s\]\["',]|\[[\d\S_-]+\])+)/.source + args_regex = /\[((?:\s*#{single_arg_regex_string}\s*,?)*(?:\s*#{single_arg_regex_string})?\s*)\]/m + arg_elements_regex = /\s*(#{single_arg_regex_string})\s*,\s*/m + + args += type_and_args[i + 1].scan(args_regex).flatten.map do |arg_values_str| + ("#{arg_values_str},").scan(arg_elements_regex) + end.reduce do |result, arg_range_expanded| + result.product(arg_range_expanded) + end.map do |arg_combinations| + arg_combinations.flatten.join(', ') end - end.map do |arg_values| - (arg_values[0]..arg_values[1]).step(arg_values[2]).to_a - end.reduce do |result, arg_range_expanded| - result.product(arg_range_expanded) - end.map do |arg_combinations| - arg_combinations.flatten.join(', ') end end end @@ -166,7 +189,7 @@ def find_tests(source) source_lines = source.split("\n") source_index = 0 tests_and_line_numbers.size.times do |i| - source_lines[source_index..-1].each_with_index do |line, index| + source_lines[source_index..].each_with_index do |line, index| next unless line =~ /\s+#{tests_and_line_numbers[i][:test]}(?:\s|\()/ source_index += index @@ -185,12 +208,11 @@ def find_includes(source) source.gsub!(/\/\/.*$/, '') # remove line comments (all that remain) # parse out includes - includes = { - local: source.scan(/^\s*#include\s+\"\s*(.+\.#{@options[:include_extensions]})\s*\"/).flatten, + { + local: source.scan(/^\s*#include\s+"\s*(.+\.#{@options[:include_extensions]})\s*"/).flatten, system: source.scan(/^\s*#include\s+<\s*(.+)\s*>/).flatten.map { |inc| "<#{inc}>" }, - linkonly: source.scan(/^TEST_FILE\(\s*\"\s*(.+\.#{@options[:source_extensions]})\s*\"/).flatten + linkonly: source.scan(/^TEST_SOURCE_FILE\(\s*"\s*(.+\.#{@options[:source_extensions]})\s*"/).flatten } - includes end def find_mocks(includes) @@ -212,10 +234,16 @@ def find_setup_and_teardown(source) def create_header(output, mocks, testfile_includes = []) output.puts('/* AUTOGENERATED FILE. DO NOT EDIT. */') output.puts("\n/*=======Automagically Detected Files To Include=====*/") + output.puts('extern "C" {') if @options[:externcincludes] output.puts("#include \"#{@options[:framework]}.h\"") output.puts('#include "cmock.h"') unless mocks.empty? + output.puts('}') if @options[:externcincludes] if @options[:defines] && !@options[:defines].empty? - @options[:defines].each { |d| output.puts("#ifndef #{d}\n#define #{d}\n#endif /* #{d} */") } + output.puts("/* injected defines for unity settings, etc */") + @options[:defines].each do |d| + def_only = d.match(/(\w+).*/)[1] + output.puts("#ifndef #{def_only}\n#define #{d}\n#endif /* #{def_only} */") + end end if @options[:header_file] && !@options[:header_file].empty? output.puts("#include \"#{File.basename(@options[:header_file])}\"") @@ -227,9 +255,11 @@ def create_header(output, mocks, testfile_includes = []) output.puts("#include #{inc.include?('<') ? inc : "\"#{inc}\""}") end end + output.puts('extern "C" {') if @options[:externcincludes] mocks.each do |mock| output.puts("#include \"#{mock}\"") end + output.puts('}') if @options[:externcincludes] output.puts('#include "CException.h"') if @options[:plugins].include?(:cexception) return unless @options[:enforce_strict_ordering] @@ -341,8 +371,9 @@ def create_reset(output) def create_run_test(output) require 'erb' - template = ERB.new(File.read(File.join(__dir__, 'run_test.erb')), nil, '<>') - output.puts("\n" + template.result(binding)) + file = File.read(File.join(__dir__, 'run_test.erb')) + template = ERB.new(file, trim_mode: '<>') + output.puts("\n#{template.result(binding)}") end def create_args_wrappers(output, tests) @@ -375,7 +406,7 @@ def create_main(output, filename, tests, used_mocks) output.puts(' {') output.puts(' if (parse_status < 0)') output.puts(' {') - output.puts(" UnityPrint(\"#{filename.gsub('.c', '')}.\");") + output.puts(" UnityPrint(\"#{filename.gsub('.c', '').gsub(/\\/, '\\\\\\')}.\");") output.puts(' UNITY_PRINT_EOL();') tests.each do |test| if (!@options[:use_param_tests]) || test[:args].nil? || test[:args].empty? @@ -432,7 +463,7 @@ def create_main(output, filename, tests, used_mocks) end 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("#ifndef _#{filename}") output.puts("#define _#{filename}\n\n") @@ -465,10 +496,13 @@ def create_h_file(output, filename, tests, testfile_includes, used_mocks) when '-cexception' options[:plugins] = [:cexception] true + when '-externcincludes' + options[:externcincludes] = true + true when /\.*\.ya?ml$/ options = UnityTestRunnerGenerator.grab_config(arg) true - when /--(\w+)=\"?(.*)\"?/ + when /--(\w+)="?(.*)"?/ options[Regexp.last_match(1).to_sym] = Regexp.last_match(2) true when /\.*\.(?:hpp|hh|H|h)$/ diff --git a/auto/parse_output.rb b/auto/parse_output.rb index d72c6e8b2..aa306e2c0 100644 --- a/auto/parse_output.rb +++ b/auto/parse_output.rb @@ -14,10 +14,14 @@ # - normal output (raw unity) # - fixture output (unity_fixture.h/.c) # - fixture output with verbose flag set ("-v") +# - time output flag set (UNITY_INCLUDE_EXEC_TIME define enabled with milliseconds output) # # To use this parser use the following command # ruby parseOutput.rb [options] [file] # options: -xml : produce a JUnit compatible XML file +# -suiteRequiredSuiteName +# : replace default test suite name to +# "RequiredSuiteName" (can be any name) # file: file to scan for results #============================================================ @@ -26,6 +30,7 @@ class ParseOutput def initialize # internal data @class_name_idx = 0 + @result_usual_idx = 3 @path_delim = nil # xml output related @@ -33,6 +38,9 @@ def initialize @array_list = false # current suite name and statistics + ## testsuite name + @real_test_suite_name = 'Unity' + ## classname for testcase @test_suite = nil @total_tests = 0 @test_passed = 0 @@ -45,6 +53,16 @@ def set_xml_output @xml_out = true end + # Set the flag to indicate if there will be an XML output file or not + def test_suite_name=(cli_arg) + @real_test_suite_name = cli_arg + puts "Real test suite name will be '#{@real_test_suite_name}'" + end + + def xml_encode_s(str) + str.encode(:xml => :attr) + end + # If write our output to XML def write_xml_output output = File.open('report.xml', 'w') @@ -57,28 +75,28 @@ def write_xml_output # Pushes the suite info as xml to the array list, which will be written later def push_xml_output_suite_info # Insert opening tag at front - heading = '' + heading = "" @array_list.insert(0, heading) # Push back the closing tag @array_list.push '' end # Pushes xml output data to the array list, which will be written later - def push_xml_output_passed(test_name) - @array_list.push ' ' + def push_xml_output_passed(test_name, execution_time = 0) + @array_list.push " " end # Pushes xml output data to the array list, which will be written later - def push_xml_output_failed(test_name, reason) - @array_list.push ' ' - @array_list.push ' ' + reason + '' + def push_xml_output_failed(test_name, reason, execution_time = 0) + @array_list.push " " + @array_list.push " #{reason}" @array_list.push ' ' end # Pushes xml output data to the array list, which will be written later - def push_xml_output_ignored(test_name, reason) - @array_list.push ' ' - @array_list.push ' ' + reason + '' + def push_xml_output_ignored(test_name, reason, execution_time = 0) + @array_list.push " " + @array_list.push " #{reason}" @array_list.push ' ' end @@ -126,7 +144,7 @@ def test_failed_unity_fixture(array) test_name = array[1] test_suite_verify(class_name) reason_array = array[2].split(':') - reason = reason_array[-1].lstrip.chomp + ' at line: ' + reason_array[-4] + reason = "#{reason_array[-1].lstrip.chomp} at line: #{reason_array[-4]}" printf "%-40s FAILED\n", test_name @@ -152,21 +170,31 @@ def test_ignored_unity_fixture(array) # Test was flagged as having passed so format the output def test_passed(array) + # ':' symbol will be valid in function args now + real_method_name = array[@result_usual_idx - 1..-2].join(':') + array = array[0..@result_usual_idx - 2] + [real_method_name] + [array[-1]] + last_item = array.length - 1 + test_time = get_test_time(array[last_item]) test_name = array[last_item - 1] test_suite_verify(array[@class_name_idx]) - printf "%-40s PASS\n", test_name + printf "%-40s PASS %10d ms\n", test_name, test_time return unless @xml_out - push_xml_output_passed(test_name) if @xml_out + push_xml_output_passed(test_name, test_time) if @xml_out end # Test was flagged as having failed so format the line def test_failed(array) + # ':' symbol will be valid in function args now + real_method_name = array[@result_usual_idx - 1..-3].join(':') + array = array[0..@result_usual_idx - 3] + [real_method_name] + array[-2..] + last_item = array.length - 1 + test_time = get_test_time(array[last_item]) test_name = array[last_item - 2] - reason = array[last_item].chomp.lstrip + ' at line: ' + array[last_item - 3] + reason = "#{array[last_item].chomp.lstrip} at line: #{array[last_item - 3]}" class_name = array[@class_name_idx] if test_name.start_with? 'TEST(' @@ -180,14 +208,19 @@ def test_failed(array) end test_suite_verify(class_name) - printf "%-40s FAILED\n", test_name + printf "%-40s FAILED %10d ms\n", test_name, test_time - push_xml_output_failed(test_name, reason) if @xml_out + push_xml_output_failed(test_name, reason, test_time) if @xml_out end # Test was flagged as being ignored so format the output def test_ignored(array) + # ':' symbol will be valid in function args now + real_method_name = array[@result_usual_idx - 1..-3].join(':') + array = array[0..@result_usual_idx - 3] + [real_method_name] + array[-2..] + last_item = array.length - 1 + test_time = get_test_time(array[last_item]) test_name = array[last_item - 2] reason = array[last_item].chomp.lstrip class_name = array[@class_name_idx] @@ -203,9 +236,18 @@ def test_ignored(array) end test_suite_verify(class_name) - printf "%-40s IGNORED\n", test_name + printf "%-40s IGNORED %10d ms\n", test_name, test_time - push_xml_output_ignored(test_name, reason) if @xml_out + push_xml_output_ignored(test_name, reason, test_time) if @xml_out + end + + # Test time will be in ms + def get_test_time(value_with_time) + test_time_array = value_with_time.scan(/\((-?\d+.?\d*) ms\)\s*$/).flatten.map do |arg_value_str| + arg_value_str.include?('.') ? arg_value_str.to_f : arg_value_str.to_i + end + + test_time_array.any? ? test_time_array[0] : 0 end # Adjusts the os specific members according to the current path style @@ -226,7 +268,7 @@ def detect_os_specifics(line) def process(file_name) @array_list = [] - puts 'Parsing file: ' + file_name + puts "Parsing file: #{file_name}" @test_passed = 0 @test_failed = 0 @@ -234,7 +276,8 @@ def process(file_name) puts '' puts '=================== RESULTS =====================' puts '' - File.open(file_name).each do |line| + # Apply binary encoding. Bad symbols will be unchanged + File.open(file_name, 'rb').each do |line| # Typical test lines look like these: # ---------------------------------------------------- # 1. normal output: @@ -288,15 +331,31 @@ def process(file_name) line_array.push('No reason given') test_ignored(line_array) @test_ignored += 1 + elsif line_array.size >= 4 + # We will check output from color compilation + if line_array[@result_usual_idx..].any? { |l| l.include? 'PASS' } + test_passed(line_array) + @test_passed += 1 + elsif line_array[@result_usual_idx..].any? { |l| l.include? 'FAIL' } + test_failed(line_array) + @test_failed += 1 + elsif line_array[@result_usual_idx..-2].any? { |l| l.include? 'IGNORE' } + test_ignored(line_array) + @test_ignored += 1 + elsif line_array[@result_usual_idx..].any? { |l| l.include? 'IGNORE' } + line_array.push("No reason given (#{get_test_time(line_array[@result_usual_idx..])} ms)") + test_ignored(line_array) + @test_ignored += 1 + end end @total_tests = @test_passed + @test_failed + @test_ignored end puts '' puts '=================== SUMMARY =====================' puts '' - puts 'Tests Passed : ' + @test_passed.to_s - puts 'Tests Failed : ' + @test_failed.to_s - puts 'Tests Ignored : ' + @test_ignored.to_s + puts "Tests Passed : #{@test_passed}" + puts "Tests Failed : #{@test_failed}" + puts "Tests Ignored : #{@test_ignored}" return unless @xml_out @@ -314,6 +373,8 @@ def process(file_name) ARGV.each do |arg| if arg == '-xml' parse_my_file.set_xml_output + elsif arg.start_with?('-suite') + parse_my_file.test_suite_name = arg.delete_prefix('-suite') else parse_my_file.process(arg) break diff --git a/auto/run_test.erb b/auto/run_test.erb index f91b56691..68b33730a 100644 --- a/auto/run_test.erb +++ b/auto/run_test.erb @@ -14,7 +14,7 @@ static void run_test(UnityTestFunction func, const char* name, UNITY_LINE_TYPE l if (TEST_PROTECT()) { <% if @options[:plugins].include?(:cexception) %> - CEXCEPTION_T e; + volatile CEXCEPTION_T e; Try { <%= @options[:setup_name] %>(); func(); diff --git a/auto/unity_to_junit.py b/auto/stylize_as_junit.py similarity index 60% rename from auto/unity_to_junit.py rename to auto/stylize_as_junit.py index 71dd56888..06c865964 100644 --- a/auto/unity_to_junit.py +++ b/auto/stylize_as_junit.py @@ -1,6 +1,15 @@ +#! python3 +# ========================================== +# Fork from Unity Project - A Test Framework for C +# Pull request on Gerrit in progress, the objective of this file is to be deleted when official Unity deliveries +# include that modification +# Copyright (c) 2015 Alexander Mueller / XelaRellum@web.de +# [Released under MIT License. Please refer to license.txt for details] +# ========================================== import sys import os from glob import glob +import argparse from pyparsing import * from junit_xml import TestSuite, TestCase @@ -14,6 +23,7 @@ def __init__(self): self.ignored = 0 self.targets = 0 self.root = None + self.output = None self.test_suites = dict() def run(self): @@ -37,15 +47,18 @@ def run(self): entry = entry_one | entry_two delimiter = Literal(':').suppress() - tc_result_line = Group(entry.setResultsName('tc_file_name') + delimiter + entry.setResultsName( - 'tc_line_nr') + delimiter + entry.setResultsName('tc_name') + delimiter + entry.setResultsName( - 'tc_status') + Optional( - delimiter + entry.setResultsName('tc_msg'))).setResultsName("tc_line") + # Format of a result line is `[file_name]:line:test_name:RESULT[:msg]` + tc_result_line = Group(ZeroOrMore(entry.setResultsName('tc_file_name')) + + delimiter + entry.setResultsName('tc_line_nr') + + delimiter + entry.setResultsName('tc_name') + + delimiter + entry.setResultsName('tc_status') + + Optional(delimiter + entry.setResultsName('tc_msg'))).setResultsName("tc_line") eol = LineEnd().suppress() sol = LineStart().suppress() blank_line = sol + eol + # Format of the summary line is `# Tests # Failures # Ignored` tc_summary_line = Group(Word(nums).setResultsName("num_of_tests") + "Tests" + Word(nums).setResultsName( "num_of_fail") + "Failures" + Word(nums).setResultsName("num_of_ignore") + "Ignored").setResultsName( "tc_summary") @@ -67,7 +80,10 @@ def run(self): tmp_tc_line = r['tc_line'] # get only the file name which will be used as the classname - file_name = tmp_tc_line['tc_file_name'].split('\\').pop().split('/').pop().rsplit('.', 1)[0] + if 'tc_file_name' in tmp_tc_line: + file_name = tmp_tc_line['tc_file_name'].split('\\').pop().split('/').pop().rsplit('.', 1)[0] + else: + file_name = result_file.strip("./") tmp_tc = TestCase(name=tmp_tc_line['tc_name'], classname=file_name) if 'tc_status' in tmp_tc_line: if str(tmp_tc_line['tc_status']) == 'IGNORE': @@ -96,7 +112,7 @@ def run(self): for suite_name in self.test_suites: ts.append(TestSuite(suite_name, self.test_suites[suite_name])) - with open('result.xml', 'w') as f: + with open(self.output, 'w') as f: TestSuite.to_file(f, ts, prettyprint='True', encoding='utf-8') return self.report @@ -107,40 +123,39 @@ def set_targets(self, target_array): def set_root_path(self, path): self.root = path - @staticmethod - def usage(err_msg=None): - print("\nERROR: ") - if err_msg: - print(err_msg) - print("\nUsage: unity_test_summary.py result_file_directory/ root_path/") - print(" result_file_directory - The location of your results files.") - print(" Defaults to current directory if not specified.") - print(" Should end in / if specified.") - print(" root_path - Helpful for producing more verbose output if using relative paths.") - sys.exit(1) + def set_output(self, output): + self.output = output if __name__ == '__main__': uts = UnityTestSummary() - try: - # look in the specified or current directory for result files - if len(sys.argv) > 1: - targets_dir = sys.argv[1] - else: - targets_dir = './' - targets = list(map(lambda x: x.replace('\\', '/'), glob(targets_dir + '*.test*'))) - if len(targets) == 0: - raise Exception("No *.testpass or *.testfail files found in '%s'" % targets_dir) - uts.set_targets(targets) - - # set the root path - if len(sys.argv) > 2: - root_path = sys.argv[2] - else: - root_path = os.path.split(__file__)[0] - uts.set_root_path(root_path) - - # run the summarizer - print(uts.run()) - except Exception as e: - UnityTestSummary.usage(e) + parser = argparse.ArgumentParser(description= + """Takes as input the collection of *.testpass and *.testfail result + files, and converts them to a JUnit formatted XML.""") + parser.add_argument('targets_dir', metavar='result_file_directory', + type=str, nargs='?', default='./', + help="""The location of your results files. + Defaults to current directory if not specified.""") + parser.add_argument('root_path', nargs='?', + default='os.path.split(__file__)[0]', + help="""Helpful for producing more verbose output if + using relative paths.""") + parser.add_argument('--output', '-o', type=str, default="result.xml", + help="""The name of the JUnit-formatted file (XML).""") + args = parser.parse_args() + + if args.targets_dir[-1] != '/': + args.targets_dir+='/' + targets = list(map(lambda x: x.replace('\\', '/'), glob(args.targets_dir + '*.test*'))) + if len(targets) == 0: + raise Exception("No *.testpass or *.testfail files found in '%s'" % args.targets_dir) + uts.set_targets(targets) + + # set the root path + uts.set_root_path(args.root_path) + + # set output + uts.set_output(args.output) + + # run the summarizer + print(uts.run()) diff --git a/auto/stylize_as_junit.rb b/auto/stylize_as_junit.rb index e01f7912a..e4b911ebe 100755 --- a/auto/stylize_as_junit.rb +++ b/auto/stylize_as_junit.rb @@ -99,7 +99,7 @@ def run test_file = if test_file_str.length < 2 result_file else - test_file_str[0] + ':' + test_file_str[1] + "#{test_file_str[0]}:#{test_file_str[1]}" end result_output[:source][:path] = File.dirname(test_file) result_output[:source][:file] = File.basename(test_file) diff --git a/auto/test_file_filter.rb b/auto/test_file_filter.rb index 5c3a79fc6..f4834a12b 100644 --- a/auto/test_file_filter.rb +++ b/auto/test_file_filter.rb @@ -4,7 +4,7 @@ # [Released under MIT License. Please refer to license.txt for details] # ========================================== -require'yaml' +require_relative 'yaml_helper' module RakefileHelpers class TestFileFilter @@ -12,9 +12,11 @@ def initialize(all_files = false) @all_files = all_files return unless @all_files - return unless File.exist?('test_file_filter.yml') - filters = YAML.load_file('test_file_filter.yml') + file = 'test_file_filter.yml' + return unless File.exist?(file) + + filters = YamlHelper.load_file(file) @all_files = filters[:all_files] @only_files = filters[:only_files] @exclude_files = filters[:exclude_files] diff --git a/auto/type_sanitizer.rb b/auto/type_sanitizer.rb index dafb8826e..3d1db09fb 100644 --- a/auto/type_sanitizer.rb +++ b/auto/type_sanitizer.rb @@ -1,6 +1,6 @@ module TypeSanitizer def self.sanitize_c_identifier(unsanitized) # convert filename to valid C identifier by replacing invalid chars with '_' - unsanitized.gsub(/[-\/\\\.\,\s]/, '_') + unsanitized.gsub(/[-\/\\.,\s]/, '_') end end diff --git a/auto/unity_test_summary.rb b/auto/unity_test_summary.rb index b3fe8a699..03d67a680 100644 --- a/auto/unity_test_summary.rb +++ b/auto/unity_test_summary.rb @@ -86,7 +86,11 @@ def usage(err_msg = nil) def get_details(_result_file, lines) results = { failures: [], ignores: [], successes: [] } lines.each do |line| - _src_file, _src_line, _test_name, status, _msg = line.split(/:/) + status_match = line.match(/^[^:]+:[^:]+:\w+(?:\([^)]*\))?:([^:]+):?/) + next unless status_match + + status = status_match.captures[0] + line_out = (@root && (@root != 0) ? "#{@root}#{line}" : line).gsub(/\//, '\\') case status when 'IGNORE' then results[:ignores] << line_out @@ -108,7 +112,7 @@ def parse_test_summary(summary) # parse out the command options opts, args = ARGV.partition { |v| v =~ /^--\w+/ } - opts.map! { |v| v[2..-1].to_sym } + opts.map! { |v| v[2..].to_sym } # create an instance to work with uts = UnityTestSummary.new(opts) @@ -124,7 +128,7 @@ def parse_test_summary(summary) uts.targets = results # set the root path - args[1] ||= Dir.pwd + '/' + args[1] ||= "#{Dir.pwd}/" uts.root = ARGV[1] # run the summarizer diff --git a/auto/yaml_helper.rb b/auto/yaml_helper.rb new file mode 100644 index 000000000..3296ba0ee --- /dev/null +++ b/auto/yaml_helper.rb @@ -0,0 +1,22 @@ +# ========================================== +# Unity Project - A Test Framework for C +# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams +# [Released under MIT License. Please refer to license.txt for details] +# ========================================== + +require 'yaml' + +module YamlHelper + def self.load(body) + if YAML.respond_to?(:unsafe_load) + YAML.unsafe_load(body) + else + YAML.load(body) + end + end + + def self.load_file(file) + body = File.read(file) + self.load(body) + end +end diff --git a/docs/MesonGeneratorRunner.md b/docs/MesonGeneratorRunner.md new file mode 100644 index 000000000..3b81e3782 --- /dev/null +++ b/docs/MesonGeneratorRunner.md @@ -0,0 +1,18 @@ +# Meson Generator - Test Runner + +One of the really nice things about using Unity with Ceedling is that Ceedling takes care of generating all of the test runners automatically. If you're not using Ceedling though, you'll need to do this yourself. + +The way this is done in Unity is via a Ruby script called `generate_test_runner.rb`. When given a test file such as `test_example.c`, the script will generate `test_example_Runner.c`, which provides the `main` method and some other useful plumbing. + +So that you don't have to run this by hand, a Meson generator is provided to generate the runner automatically for you. Generally with Meson, you would use Unity as a subproject and you'd want to access the generator from the parent. + +For example, to get the generator you can use: + + unity_proj = subproject('unity') + runner_gen = unity_proj.get_variable('gen_test_runner') + +Once you have the generator you need to pass it the absolute path of your test file. This seems to be a bug in how the paths work with subprojects in Meson. You can get the full path with `meson.source_root()`, so you could do: + + test_runner = meson.source_root() / 'test/test_example.c' + +You can then include `test_runner` as a normal dependency to your builds. Meson will create the test runner in a private directory for each build target. It's only meant to be used as part of the build, so if you need to refer to the runner after the build, you won't be able to use the generator. \ No newline at end of file diff --git a/docs/ThrowTheSwitchCodingStandard.md b/docs/ThrowTheSwitchCodingStandard.md index bf4c099bb..517b8fb6b 100644 --- a/docs/ThrowTheSwitchCodingStandard.md +++ b/docs/ThrowTheSwitchCodingStandard.md @@ -1,136 +1,116 @@ # ThrowTheSwitch.org Coding Standard -Hi. Welcome to the coding standard for ThrowTheSwitch.org. For the most part, -we try to follow these standards to unify our contributors' code into a cohesive -unit (puns intended). You might find places where these standards aren't -followed. We're not perfect. Please be polite where you notice these discrepancies -and we'll try to be polite when we notice yours. +Hi. +Welcome to the coding standard for ThrowTheSwitch.org. +For the most part, we try to follow these standards to unify our contributors' code into a cohesive unit (puns intended). +You might find places where these standards aren't followed. +We're not perfect. Please be polite where you notice these discrepancies and we'll try to be polite when we notice yours. ;) - ## Why Have A Coding Standard? -Being consistent makes code easier to understand. We've tried to keep -our standard simple because we also believe that we can only expect someone to -follow something that is understandable. Please do your best. - +Being consistent makes code easier to understand. +We've tried to keep our standard simple because we also believe that we can only expect someone to follow something that is understandable. +Please do your best. ## Our Philosophy -Before we get into details on syntax, let's take a moment to talk about our -vision for these tools. We're C developers and embedded software developers. -These tools are great to test any C code, but catering to embedded software has -made us more tolerant of compiler quirks. There are a LOT of quirky compilers -out there. By quirky I mean "doesn't follow standards because they feel like -they have a license to do as they wish." - -Our philosophy is "support every compiler we can". Most often, this means that -we aim for writing C code that is standards compliant (often C89... that seems -to be a sweet spot that is almost always compatible). But it also means these -tools are tolerant of things that aren't common. Some that aren't even -compliant. There are configuration options to override the size of standard -types. There are configuration options to force Unity to not use certain -standard library functions. A lot of Unity is configurable and we have worked -hard to make it not TOO ugly in the process. - -Similarly, our tools that parse C do their best. They aren't full C parsers -(yet) and, even if they were, they would still have to accept non-standard -additions like gcc extensions or specifying `@0x1000` to force a variable to -compile to a particular location. It's just what we do, because we like -everything to Just Work™. - -Speaking of having things Just Work™, that's our second philosophy. By that, we -mean that we do our best to have EVERY configuration option have a logical -default. We believe that if you're working with a simple compiler and target, -you shouldn't need to configure very much... we try to make the tools guess as -much as they can, but give the user the power to override it when it's wrong. +Before we get into details on syntax, let's take a moment to talk about our vision for these tools. +We're C developers and embedded software developers. +These tools are great to test any C code, but catering to embedded software made us more tolerant of compiler quirks. +There are a LOT of quirky compilers out there. +By quirky I mean "doesn't follow standards because they feel like they have a license to do as they wish." + +Our philosophy is "support every compiler we can". +Most often, this means that we aim for writing C code that is standards compliant (often C89... that seems to be a sweet spot that is almost always compatible). +But it also means these tools are tolerant of things that aren't common. +Some that aren't even compliant. +There are configuration options to override the size of standard types. +There are configuration options to force Unity to not use certain standard library functions. +A lot of Unity is configurable and we have worked hard to make it not TOO ugly in the process. +Similarly, our tools that parse C do their best. +They aren't full C parsers (yet) and, even if they were, they would still have to accept non-standard additions like gcc extensions or specifying `@0x1000` to force a variable to compile to a particular location. +It's just what we do, because we like everything to Just Work™. + +Speaking of having things Just Work™, that's our second philosophy. +By that, we mean that we do our best to have EVERY configuration option have a logical default. +We believe that if you're working with a simple compiler and target, you shouldn't need to configure very much... we try to make the tools guess as much as they can, but give the user the power to override it when it's wrong. ## Naming Things -Let's talk about naming things. Programming is all about naming things. We name -files, functions, variables, and so much more. While we're not always going to -find the best name for something, we actually put a bit of effort into -finding *What Something WANTS to be Called*™. +Let's talk about naming things. +Programming is all about naming things. +We name files, functions, variables, and so much more. +While we're not always going to find the best name for something, we actually put a bit of effort into finding *What Something WANTS to be Called*™. + +When naming things, we follow this hierarchy, the first being the most important to us (but we do all four when possible): -When naming things, we follow this hierarchy, the first being the -most important to us (but we do all four when possible): 1. Readable 2. Descriptive 3. Consistent 4. Memorable +### Readable -#### Readable +We want to read our code. +This means we like names and flow that are more naturally read. +We try to avoid double negatives. +We try to avoid cryptic abbreviations (sticking to ones we feel are common). -We want to read our code. This means we like names and flow that are more -naturally read. We try to avoid double negatives. We try to avoid cryptic -abbreviations (sticking to ones we feel are common). - - -#### Descriptive +### Descriptive We like descriptive names for things, especially functions and variables. -Finding the right name for something is an important endeavor. You might notice -from poking around our code that this often results in names that are a little -longer than the average. Guilty. We're okay with a bit more typing if it -means our code is easier to understand. - -There are two exceptions to this rule that we also stick to as religiously as -possible: - -First, while we realize hungarian notation (and similar systems for encoding -type information into variable names) is providing a more descriptive name, we -feel that (for the average developer) it takes away from readability and is to be avoided. +Finding the right name for something is an important endeavour. +You might notice from poking around our code that this often results in names that are a little longer than the average. +Guilty. +We're okay with a bit more typing if it means our code is easier to understand. -Second, loop counters and other local throw-away variables often have a purpose -which is obvious. There's no need, therefore, to get carried away with complex -naming. We find i, j, and k are better loop counters than loopCounterVar or -whatnot. We only break this rule when we see that more description could improve -understanding of an algorithm. +There are two exceptions to this rule that we also stick to as religiously as possible: +First, while we realize hungarian notation (and similar systems for encoding type information into variable names) is providing a more descriptive name, we feel that (for the average developer) it takes away from readability and is to be avoided. -#### Consistent +Second, loop counters and other local throw-away variables often have a purpose which is obvious. +There's no need, therefore, to get carried away with complex naming. +We find i, j, and k are better loop counters than loopCounterVar or whatnot. +We only break this rule when we see that more description could improve understanding of an algorithm. -We like consistency, but we're not really obsessed with it. We try to name our -configuration macros in a consistent fashion... you'll notice a repeated use of -UNITY_EXCLUDE_BLAH or UNITY_USES_BLAH macros. This helps users avoid having to -remember each macro's details. +### Consistent +We like consistency, but we're not really obsessed with it. +We try to name our configuration macros in a consistent fashion... you'll notice a repeated use of UNITY_EXCLUDE_BLAH or UNITY_USES_BLAH macros. +This helps users avoid having to remember each macro's details. -#### Memorable - -Where ever it doesn't violate the above principles, we try to apply memorable -names. Sometimes this means using something that is simply descriptive, but -often we strive for descriptive AND unique... we like quirky names that stand -out in our memory and are easier to search for. Take a look through the file -names in Ceedling and you'll get a good idea of what we are talking about here. -Why use preprocess when you can use preprocessinator? Or what better describes a -module in charge of invoking tasks during releases than release_invoker? Don't -get carried away. The names are still descriptive and fulfill the above -requirements, but they don't feel stale. +### Memorable +Where ever it doesn't violate the above principles, we try to apply memorable names. +Sometimes this means using something that is simply descriptive, but often we strive for descriptive AND unique... we like quirky names that stand out in our memory and are easier to search for. +Take a look through the file names in Ceedling and you'll get a good idea of what we are talking about here. +Why use preprocess when you can use preprocessinator? +Or what better describes a module in charge of invoking tasks during releases than release_invoker? +Don't get carried away. +The names are still descriptive and fulfil the above requirements, but they don't feel stale. ## C and C++ Details -We don't really want to add to the style battles out there. Tabs or spaces? -How many spaces? Where do the braces go? These are age-old questions that will -never be answered... or at least not answered in a way that will make everyone -happy. - -We've decided on our own style preferences. If you'd like to contribute to these -projects (and we hope that you do), then we ask if you do your best to follow -the same. It will only hurt a little. We promise. +We don't really want to add to the style battles out there. +Tabs or spaces? +How many spaces? +Where do the braces go? +These are age-old questions that will never be answered... or at least not answered in a way that will make everyone happy. +We've decided on our own style preferences. +If you'd like to contribute to these projects (and we hope that you do), then we ask if you do your best to follow the same. +It will only hurt a little. We promise. -#### Whitespace +### Whitespace in C/C++ -Our C-style is to use spaces and to use 4 of them per indent level. It's a nice -power-of-2 number that looks decent on a wide-screen. We have no more reason -than that. We break that rule when we have lines that wrap (macros or function -arguments or whatnot). When that happens, we like to indent further to line -things up in nice tidy columns. +Our C-style is to use spaces and to use 4 of them per indent level. +It's a nice power-of-2 number that looks decent on a wide-screen. +We have no more reason than that. +We break that rule when we have lines that wrap (macros or function arguments or whatnot). +When that happens, we like to indent further to line things up in nice tidy columns. ```C if (stuff_happened) @@ -139,8 +119,7 @@ things up in nice tidy columns. } ``` - -#### Case +### Case in C/C++ - Files - all lower case with underscores. - Variables - all lower case with underscores @@ -149,12 +128,12 @@ things up in nice tidy columns. - Functions - camel cased. Usually named ModuleName_FuncName - Constants and Globals - camel cased. +### Braces in C/C++ -#### Braces - -The left brace is on the next line after the declaration. The right brace is -directly below that. Everything in between in indented one level. If you're -catching an error and you have a one-line, go ahead and to it on the same line. +The left brace is on the next line after the declaration. +The right brace is directly below that. +Everything in between in indented one level. +If you're catching an error and you have a one-line, go ahead and to it on the same line. ```C while (blah) @@ -163,32 +142,32 @@ catching an error and you have a one-line, go ahead and to it on the same line. } ``` +### Comments in C/C++ -#### Comments - -Do you know what we hate? Old-school C block comments. BUT, we're using them -anyway. As we mentioned, our goal is to support every compiler we can, -especially embedded compilers. There are STILL C compilers out there that only -support old-school block comments. So that is what we're using. We apologize. We -think they are ugly too. - +Do you know what we hate? +Old-school C block comments. +BUT, we're using them anyway. +As we mentioned, our goal is to support every compiler we can, especially embedded compilers. +There are STILL C compilers out there that only support old-school block comments. +So that is what we're using. +We apologize. +We think they are ugly too. ## Ruby Details -Is there really such thing as a Ruby coding standard? Ruby is such a free form -language, it seems almost sacrilegious to suggest that people should comply to -one method! We'll keep it really brief! - +Is there really such thing as a Ruby coding standard? +Ruby is such a free form language, it seems almost sacrilegious to suggest that people should comply to one method! +We'll keep it really brief! -#### Whitespace +### Whitespace in Ruby -Our Ruby style is to use spaces and to use 2 of them per indent level. It's a -nice power-of-2 number that really grooves with Ruby's compact style. We have no -more reason than that. We break that rule when we have lines that wrap. When -that happens, we like to indent further to line things up in nice tidy columns. +Our Ruby style is to use spaces and to use 2 of them per indent level. +It's a nice power-of-2 number that really grooves with Ruby's compact style. +We have no more reason than that. +We break that rule when we have lines that wrap. +When that happens, we like to indent further to line things up in nice tidy columns. - -#### Case +### Case in Ruby - Files - all lower case with underscores. - Variables - all lower case with underscores @@ -196,11 +175,13 @@ that happens, we like to indent further to line things up in nice tidy columns. - Functions - all lower case with underscores - Constants - all upper case with underscores - ## Documentation -Egad. Really? We use mark down and we like pdf files because they can be made to -look nice while still being portable. Good enough? +Egad. +Really? +We use markdown and we like PDF files because they can be made to look nice while still being portable. +Good enough? +*Find The Latest of This And More at [ThrowTheSwitch.org][]* -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +[ThrowTheSwitch.org]: https://throwtheswitch.org \ No newline at end of file diff --git a/docs/UnityAssertionsReference.md b/docs/UnityAssertionsReference.md index 0957bcf6b..0a0e51b65 100644 --- a/docs/UnityAssertionsReference.md +++ b/docs/UnityAssertionsReference.md @@ -10,49 +10,46 @@ Upon boolean False, an assertion stops execution and reports the failure. and easily execute those assertions. - The structure of Unity allows you to easily separate test assertions from source code in, well, test code. -- Unity's assertions: -- Come in many, many flavors to handle different C types and assertion cases. -- Use context to provide detailed and helpful failure messages. -- Document types, expected values, and basic behavior in your source code for +- Unity’s assertions: + - Come in many, many flavors to handle different C types and assertion cases. + - Use context to provide detailed and helpful failure messages. + - Document types, expected values, and basic behavior in your source code for free. - -### Unity Is Several Things But Mainly It's Assertions +### Unity Is Several Things But Mainly It’s Assertions One way to think of Unity is simply as a rich collection of assertions you can use to establish whether your source code behaves the way you think it does. Unity provides a framework to easily organize and execute those assertions in test code separate from your source code. - -### What's an Assertion? +### What’s an Assertion? At their core, assertions are an establishment of truth - boolean truth. Was this thing equal to that thing? Does that code doohickey have such-and-such property -or not? You get the idea. Assertions are executable code (to appreciate the big -picture on this read up on the difference between -[link:Dynamic Verification and Static Analysis]). A failing assertion stops -execution and reports an error through some appropriate I/O channel (e.g. -stdout, GUI, file, blinky light). +or not? You get the idea. Assertions are executable code. Static analysis is a +valuable approach to improving code quality, but it is not executing your code +in the way an assertion can. A failing assertion stops execution and reports an +error through some appropriate I/O channel (e.g. stdout, GUI, output file, +blinky light). Fundamentally, for dynamic verification all you need is a single assertion -mechanism. In fact, that's what the [assert() macro in C's standard library](http://en.wikipedia.org/en/wiki/Assert.h) +mechanism. In fact, that’s what the [assert() macro][] in C’s standard library is for. So why not just use it? Well, we can do far better in the reporting -department. C's `assert()` is pretty dumb as-is and is particularly poor for +department. C’s `assert()` is pretty dumb as-is and is particularly poor for handling common data types like arrays, structs, etc. And, without some other -support, it's far too tempting to litter source code with C's `assert()`'s. It's +support, it’s far too tempting to litter source code with C’s `assert()`’s. It’s generally much cleaner, manageable, and more useful to separate test and source code in the way Unity facilitates. - -### Unity's Assertions: Helpful Messages _and_ Free Source Code Documentation +### Unity’s Assertions: Helpful Messages _and_ Free Source Code Documentation Asserting a simple truth condition is valuable, but using the context of the -assertion is even more valuable. For instance, if you know you're comparing bit +assertion is even more valuable. For instance, if you know you’re comparing bit flags and not just integers, then why not use that context to give explicit, readable, bit-level feedback when an assertion fails? -That's what Unity's collection of assertions do - capture context to give you +That’s what Unity’s collection of assertions do - capture context to give you helpful, meaningful assertion failure messages. In fact, the assertions themselves also serve as executable documentation about types and values in your source code. So long as your tests remain current with your source and all those @@ -60,34 +57,32 @@ tests pass, you have a detailed, up-to-date view of the intent and mechanisms in your source code. And due to a wondrous mystery, well-tested code usually tends to be well designed code. - ## Assertion Conventions and Configurations ### Naming and Parameter Conventions The convention of assertion parameters generally follows this order: -``` +```c TEST_ASSERT_X( {modifiers}, {expected}, actual, {size/count} ) ``` The very simplest assertion possible uses only a single `actual` parameter (e.g. a simple null check). - - `Actual` is the value being tested and unlike the other parameters in an - assertion construction is the only parameter present in all assertion variants. - - `Modifiers` are masks, ranges, bit flag specifiers, floating point deltas. - - `Expected` is your expected value (duh) to compare to an `actual` value; it's - marked as an optional parameter because some assertions only need a single - `actual` parameter (e.g. null check). - - `Size/count` refers to string lengths, number of array elements, etc. +- `Actual` is the value being tested and unlike the other parameters in an + assertion construction is the only parameter present in all assertion variants. +- `Modifiers` are masks, ranges, bit flag specifiers, floating point deltas. +- `Expected` is your expected value (duh) to compare to an `actual` value; it’s + marked as an optional parameter because some assertions only need a single + `actual` parameter (e.g. null check). +- `Size/count` refers to string lengths, number of array elements, etc. -Many of Unity's assertions are clear duplications in that the same data type +Many of Unity’s assertions are clear duplications in that the same data type is handled by several assertions. The differences among these are in how failure messages are presented. For instance, a `_HEX` variant of an assertion prints the expected and actual values of that assertion formatted as hexadecimal. - #### TEST_ASSERT_X_MESSAGE Variants _All_ assertions are complemented with a variant that includes a simple string @@ -100,74 +95,72 @@ the reference list below and add a string as the final parameter. _Example:_ -``` +```c TEST_ASSERT_X( {modifiers}, {expected}, actual, {size/count} ) ``` -becomes messageified like thus... +becomes messageified like thus… -``` +```c TEST_ASSERT_X_MESSAGE( {modifiers}, {expected}, actual, {size/count}, message ) ``` Notes: + - The `_MESSAGE` variants intentionally do not support `printf` style formatting - since many embedded projects don't support or avoid `printf` for various reasons. + since many embedded projects don’t support or avoid `printf` for various reasons. It is possible to use `sprintf` before the assertion to assemble a complex fail message, if necessary. - If you want to output a counter value within an assertion fail message (e.g. from a loop) , building up an array of results and then using one of the `_ARRAY` assertions (see below) might be a handy alternative to `sprintf`. - #### TEST_ASSERT_X_ARRAY Variants Unity provides a collection of assertions for arrays containing a variety of types. These are documented in the Array section below. These are almost on par -with the `_MESSAGE`variants of Unity's Asserts in that for pretty much any Unity +with the `_MESSAGE`variants of Unity’s Asserts in that for pretty much any Unity type assertion you can tack on `_ARRAY` and run assertions on an entire block of memory. -``` +```c TEST_ASSERT_EQUAL_TYPEX_ARRAY( expected, actual, {size/count} ) ``` - - `Expected` is an array itself. - - `Size/count` is one or two parameters necessary to establish the number of array - elements and perhaps the length of elements within the array. +- `Expected` is an array itself. +- `Size/count` is one or two parameters necessary to establish the number of array + elements and perhaps the length of elements within the array. Notes: - - The `_MESSAGE` variant convention still applies here to array assertions. The - `_MESSAGE` variants of the `_ARRAY` assertions have names ending with - `_ARRAY_MESSAGE`. - - Assertions for handling arrays of floating point values are grouped with float - and double assertions (see immediately following section). - +- The `_MESSAGE` variant convention still applies here to array assertions. The + `_MESSAGE` variants of the `_ARRAY` assertions have names ending with + `_ARRAY_MESSAGE`. +- Assertions for handling arrays of floating point values are grouped with float + and double assertions (see immediately following section). ### TEST_ASSERT_EACH_EQUAL_X Variants Unity provides a collection of assertions for arrays containing a variety of types which can be compared to a single value as well. These are documented in the Each Equal section below. these are almost on par with the `_MESSAGE` -variants of Unity's Asserts in that for pretty much any Unity type assertion you +variants of Unity’s Asserts in that for pretty much any Unity type assertion you can inject `_EACH_EQUAL` and run assertions on an entire block of memory. -``` +```c TEST_ASSERT_EACH_EQUAL_TYPEX( expected, actual, {size/count} ) ``` - - `Expected` is a single value to compare to. - - `Actual` is an array where each element will be compared to the expected value. - - `Size/count` is one of two parameters necessary to establish the number of array - elements and perhaps the length of elements within the array. +- `Expected` is a single value to compare to. +- `Actual` is an array where each element will be compared to the expected value. +- `Size/count` is one of two parameters necessary to establish the number of array + elements and perhaps the length of elements within the array. Notes: - - The `_MESSAGE` variant convention still applies here to Each Equal assertions. - - Assertions for handling Each Equal of floating point values are grouped with - float and double assertions (see immediately following section). - +- The `_MESSAGE` variant convention still applies here to Each Equal assertions. +- Assertions for handling Each Equal of floating point values are grouped with + float and double assertions (see immediately following section). ### Configuration @@ -179,7 +172,6 @@ or disabled in Unity code. This is useful for embedded targets with no floating point math support (i.e. Unity compiles free of errors for fixed point only platforms). See Unity documentation for specifics. - #### Maximum Data Type Width Is Configurable Not all targets support 64 bit wide types or even 32 bit wide types. Define the @@ -187,14 +179,13 @@ appropriate preprocessor symbols and Unity will omit all operations from compilation that exceed the maximum width of your target. See Unity documentation for specifics. - ## The Assertions in All Their Blessed Glory ### Basic Fail, Pass and Ignore -##### `TEST_FAIL()` +#### `TEST_FAIL()` -##### `TEST_FAIL_MESSAGE("message")` +#### `TEST_FAIL_MESSAGE("message")` This fella is most often used in special conditions where your test code is performing logic beyond a simple assertion. That is, in practice, `TEST_FAIL()` @@ -207,25 +198,25 @@ code then verifies as a final step. - Triggering an exception and verifying it (as in Try / Catch / Throw - see the [CException](https://github.com/ThrowTheSwitch/CException) project). -##### `TEST_PASS()` +#### `TEST_PASS()` -##### `TEST_PASS_MESSAGE("message")` +#### `TEST_PASS_MESSAGE("message")` This will abort the remainder of the test, but count the test as a pass. Under -normal circumstances, it is not necessary to include this macro in your tests... +normal circumstances, it is not necessary to include this macro in your tests… a lack of failure will automatically be counted as a `PASS`. It is occasionally useful for tests with `#ifdef`s and such. -##### `TEST_IGNORE()` +#### `TEST_IGNORE()` -##### `TEST_IGNORE_MESSAGE("message")` +#### `TEST_IGNORE_MESSAGE("message")` Marks a test case (i.e. function meant to contain test assertions) as ignored. Usually this is employed as a breadcrumb to come back and implement a test case. An ignored test case has effects if other assertions are in the enclosing test case (see Unity documentation for more). -##### `TEST_MESSAGE(message)` +#### `TEST_MESSAGE(message)` This can be useful for outputting `INFO` messages into the Unity output stream without actually ending the test. Like pass and fail messages, it will be output @@ -233,27 +224,27 @@ with the filename and line number. ### Boolean -##### `TEST_ASSERT (condition)` +#### `TEST_ASSERT (condition)` -##### `TEST_ASSERT_TRUE (condition)` +#### `TEST_ASSERT_TRUE (condition)` -##### `TEST_ASSERT_FALSE (condition)` +#### `TEST_ASSERT_FALSE (condition)` -##### `TEST_ASSERT_UNLESS (condition)` +#### `TEST_ASSERT_UNLESS (condition)` A simple wording variation on `TEST_ASSERT_FALSE`.The semantics of `TEST_ASSERT_UNLESS` aid readability in certain test constructions or conditional statements. -##### `TEST_ASSERT_NULL (pointer)` +#### `TEST_ASSERT_NULL (pointer)` -##### `TEST_ASSERT_NOT_NULL (pointer)` +#### `TEST_ASSERT_NOT_NULL (pointer)` Verify if a pointer is or is not NULL. -##### `TEST_ASSERT_EMPTY (pointer)` +#### `TEST_ASSERT_EMPTY (pointer)` -##### `TEST_ASSERT_NOT_EMPTY (pointer)` +#### `TEST_ASSERT_NOT_EMPTY (pointer)` Verify if the first element dereferenced from a pointer is or is not zero. This is particularly useful for checking for empty (or non-empty) null-terminated @@ -268,26 +259,25 @@ that would break compilation (see Unity documentation for more). Refer to Advanced Asserting later in this document for advice on dealing with other word sizes. -##### `TEST_ASSERT_EQUAL_INT (expected, actual)` - -##### `TEST_ASSERT_EQUAL_INT8 (expected, actual)` +#### `TEST_ASSERT_EQUAL_INT (expected, actual)` -##### `TEST_ASSERT_EQUAL_INT16 (expected, actual)` +#### `TEST_ASSERT_EQUAL_INT8 (expected, actual)` -##### `TEST_ASSERT_EQUAL_INT32 (expected, actual)` +#### `TEST_ASSERT_EQUAL_INT16 (expected, actual)` -##### `TEST_ASSERT_EQUAL_INT64 (expected, actual)` +#### `TEST_ASSERT_EQUAL_INT32 (expected, actual)` -##### `TEST_ASSERT_EQUAL_UINT (expected, actual)` +#### `TEST_ASSERT_EQUAL_INT64 (expected, actual)` -##### `TEST_ASSERT_EQUAL_UINT8 (expected, actual)` +#### `TEST_ASSERT_EQUAL_UINT (expected, actual)` -##### `TEST_ASSERT_EQUAL_UINT16 (expected, actual)` +#### `TEST_ASSERT_EQUAL_UINT8 (expected, actual)` -##### `TEST_ASSERT_EQUAL_UINT32 (expected, actual)` +#### `TEST_ASSERT_EQUAL_UINT16 (expected, actual)` -##### `TEST_ASSERT_EQUAL_UINT64 (expected, actual)` +#### `TEST_ASSERT_EQUAL_UINT32 (expected, actual)` +#### `TEST_ASSERT_EQUAL_UINT64 (expected, actual)` ### Unsigned Integers (of all sizes) in Hexadecimal @@ -295,16 +285,15 @@ All `_HEX` assertions are identical in function to unsigned integer assertions but produce failure messages with the `expected` and `actual` values formatted in hexadecimal. Unity output is big endian. -##### `TEST_ASSERT_EQUAL_HEX (expected, actual)` +#### `TEST_ASSERT_EQUAL_HEX (expected, actual)` -##### `TEST_ASSERT_EQUAL_HEX8 (expected, actual)` +#### `TEST_ASSERT_EQUAL_HEX8 (expected, actual)` -##### `TEST_ASSERT_EQUAL_HEX16 (expected, actual)` +#### `TEST_ASSERT_EQUAL_HEX16 (expected, actual)` -##### `TEST_ASSERT_EQUAL_HEX32 (expected, actual)` - -##### `TEST_ASSERT_EQUAL_HEX64 (expected, actual)` +#### `TEST_ASSERT_EQUAL_HEX32 (expected, actual)` +#### `TEST_ASSERT_EQUAL_HEX64 (expected, actual)` ### Characters @@ -312,36 +301,30 @@ While you can use the 8-bit integer assertions to compare `char`, another option to use this specialized assertion which will show printable characters as printables, otherwise showing the HEX escape code for the characters. -##### `TEST_ASSERT_EQUAL_CHAR (expected, actual)` - +#### `TEST_ASSERT_EQUAL_CHAR (expected, actual)` ### Masked and Bit-level Assertions Masked and bit-level assertions produce output formatted in hexadecimal. Unity output is big endian. - -##### `TEST_ASSERT_BITS (mask, expected, actual)` +#### `TEST_ASSERT_BITS (mask, expected, actual)` Only compares the masked (i.e. high) bits of `expected` and `actual` parameters. - -##### `TEST_ASSERT_BITS_HIGH (mask, actual)` +#### `TEST_ASSERT_BITS_HIGH (mask, actual)` Asserts the masked bits of the `actual` parameter are high. - -##### `TEST_ASSERT_BITS_LOW (mask, actual)` +#### `TEST_ASSERT_BITS_LOW (mask, actual)` Asserts the masked bits of the `actual` parameter are low. - -##### `TEST_ASSERT_BIT_HIGH (bit, actual)` +#### `TEST_ASSERT_BIT_HIGH (bit, actual)` Asserts the specified bit of the `actual` parameter is high. - -##### `TEST_ASSERT_BIT_LOW (bit, actual)` +#### `TEST_ASSERT_BIT_LOW (bit, actual)` Asserts the specified bit of the `actual` parameter is low. @@ -352,16 +335,15 @@ than `threshold` (exclusive). For example, if the threshold value is 0 for the greater than assertion will fail if it is 0 or less. There are assertions for all the various sizes of ints, as for the equality assertions. Some examples: -##### `TEST_ASSERT_GREATER_THAN_INT8 (threshold, actual)` +#### `TEST_ASSERT_GREATER_THAN_INT8 (threshold, actual)` -##### `TEST_ASSERT_GREATER_OR_EQUAL_INT16 (threshold, actual)` +#### `TEST_ASSERT_GREATER_OR_EQUAL_INT16 (threshold, actual)` -##### `TEST_ASSERT_LESS_THAN_INT32 (threshold, actual)` +#### `TEST_ASSERT_LESS_THAN_INT32 (threshold, actual)` -##### `TEST_ASSERT_LESS_OR_EQUAL_UINT (threshold, actual)` - -##### `TEST_ASSERT_NOT_EQUAL_UINT8 (threshold, actual)` +#### `TEST_ASSERT_LESS_OR_EQUAL_UINT (threshold, actual)` +#### `TEST_ASSERT_NOT_EQUAL_UINT8 (threshold, actual)` ### Integer Ranges (of all sizes) @@ -370,60 +352,57 @@ These assertions verify that the `expected` parameter is within +/- `delta` and the delta is 3 then the assertion will fail for any value outside the range of 7 - 13. -##### `TEST_ASSERT_INT_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_INT_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_INT8_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_INT8_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_INT16_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_INT16_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_INT32_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_INT32_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_INT64_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_INT64_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_UINT_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_UINT_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_UINT8_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_UINT8_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_UINT16_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_UINT16_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_UINT32_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_UINT32_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_UINT64_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_UINT64_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_HEX_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_HEX_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_HEX8_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_HEX8_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_HEX16_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_HEX16_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_HEX32_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_HEX32_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_HEX64_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_HEX64_WITHIN (delta, expected, actual)` -##### `TEST_ASSERT_CHAR_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_CHAR_WITHIN (delta, expected, actual)` ### Structs and Strings -##### `TEST_ASSERT_EQUAL_PTR (expected, actual)` +#### `TEST_ASSERT_EQUAL_PTR (expected, actual)` Asserts that the pointers point to the same memory location. +#### `TEST_ASSERT_EQUAL_STRING (expected, actual)` -##### `TEST_ASSERT_EQUAL_STRING (expected, actual)` - -Asserts that the null terminated (`'\0'`)strings are identical. If strings are +Asserts that the null terminated (`’\0’`)strings are identical. If strings are of different lengths or any portion of the strings before their terminators differ, the assertion fails. Two NULL strings (i.e. zero length) are considered equivalent. - -##### `TEST_ASSERT_EQUAL_MEMORY (expected, actual, len)` +#### `TEST_ASSERT_EQUAL_MEMORY (expected, actual, len)` Asserts that the contents of the memory specified by the `expected` and `actual` pointers is identical. The size of the memory blocks in bytes is specified by the `len` parameter. - ### Arrays `expected` and `actual` parameters are both arrays. `num_elements` specifies the @@ -438,43 +417,43 @@ For array of strings comparison behavior, see comments for Assertions fail upon the first element in the compared arrays found not to match. Failure messages specify the array index of the failed comparison. -##### `TEST_ASSERT_EQUAL_INT_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_INT_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_INT8_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_INT8_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_INT16_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_INT16_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_INT32_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_INT32_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_INT64_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_INT64_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_UINT_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_UINT_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_UINT8_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_UINT8_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_UINT16_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_UINT16_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_UINT32_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_UINT32_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_UINT64_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_UINT64_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_HEX_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_HEX_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_HEX8_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_HEX8_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_HEX16_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_HEX16_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_HEX32_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_HEX32_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_HEX64_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_HEX64_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_CHAR_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_CHAR_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_PTR_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_PTR_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_STRING_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_STRING_ARRAY (expected, actual, num_elements)` -##### `TEST_ASSERT_EQUAL_MEMORY_ARRAY (expected, actual, len, num_elements)` +#### `TEST_ASSERT_EQUAL_MEMORY_ARRAY (expected, actual, len, num_elements)` `len` is the memory in bytes to be compared at each array element. @@ -485,37 +464,37 @@ These assertions verify that the `expected` array parameter is within +/- `delta \[10, 12\] and the delta is 3 then the assertion will fail for any value outside the range of \[7 - 13, 9 - 15\]. -##### `TEST_ASSERT_INT_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_INT_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_INT8_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_INT8_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_INT16_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_INT16_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_INT32_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_INT32_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_INT64_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_INT64_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_UINT_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_UINT_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_UINT8_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_UINT8_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_UINT16_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_UINT16_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_UINT32_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_UINT32_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_UINT64_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_UINT64_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_HEX_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_HEX_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_HEX8_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_HEX8_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_HEX16_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_HEX16_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_HEX32_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_HEX32_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_HEX64_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_HEX64_ARRAY_WITHIN (delta, expected, actual, num_elements)` -##### `TEST_ASSERT_CHAR_ARRAY_WITHIN (delta, expected, actual, num_elements)` +#### `TEST_ASSERT_CHAR_ARRAY_WITHIN (delta, expected, actual, num_elements)` ### Each Equal (Arrays to Single Value) @@ -568,166 +547,216 @@ match. Failure messages specify the array index of the failed comparison. `len` is the memory in bytes to be compared at each array element. - ### Floating Point (If enabled) -##### `TEST_ASSERT_FLOAT_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_FLOAT_WITHIN (delta, expected, actual)` Asserts that the `actual` value is within +/- `delta` of the `expected` value. The nature of floating point representation is such that exact evaluations of equality are not guaranteed. +#### `TEST_ASSERT_FLOAT_NOT_WITHIN (delta, expected, actual)` + +Asserts that the `actual` value is NOT within +/- `delta` of the `expected` value. -##### `TEST_ASSERT_EQUAL_FLOAT (expected, actual)` +#### `TEST_ASSERT_EQUAL_FLOAT (expected, actual)` -Asserts that the ?actual?value is "close enough to be considered equal" to the +Asserts that the `actual` value is “close enough to be considered equal” to the `expected` value. If you are curious about the details, refer to the Advanced Asserting section for more details on this. Omitting a user-specified delta in a floating point assertion is both a shorthand convenience and a requirement of code generation conventions for CMock. +#### `TEST_ASSERT_NOT_EQUAL_FLOAT (expected, actual)` + +Asserts that the `actual` value is NOT “close enough to be considered equal” to the +`expected` value. -##### `TEST_ASSERT_EQUAL_FLOAT_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_FLOAT_ARRAY_WITHIN (delta, expected, actual, num_elements)` See Array assertion section for details. Note that individual array element -float comparisons are executed using T?EST_ASSERT_EQUAL_FLOAT?.That is, user +uses user-provided delta plus default comparison delta for checking +and is based on `TEST_ASSERT_FLOAT_WITHIN` comparison. + +#### `TEST_ASSERT_EQUAL_FLOAT_ARRAY (expected, actual, num_elements)` + +See Array assertion section for details. Note that individual array element +float comparisons are executed using `TEST_ASSERT_EQUAL_FLOAT`. That is, user specified delta comparison values requires a custom-implemented floating point array assertion. +#### `TEST_ASSERT_LESS_THAN_FLOAT (threshold, actual)` + +Asserts that the `actual` parameter is less than `threshold` (exclusive). +For example, if the threshold value is 1.0f, the assertion will fail if it is +greater than 1.0f. + +#### `TEST_ASSERT_GREATER_THAN_FLOAT (threshold, actual)` + +Asserts that the `actual` parameter is greater than `threshold` (exclusive). +For example, if the threshold value is 1.0f, the assertion will fail if it is +less than 1.0f. -##### `TEST_ASSERT_FLOAT_IS_INF (actual)` +#### `TEST_ASSERT_LESS_OR_EQUAL_FLOAT (threshold, actual)` + +Asserts that the `actual` parameter is less than or equal to `threshold`. +The rules for equality are the same as for `TEST_ASSERT_EQUAL_FLOAT`. + +#### `TEST_ASSERT_GREATER_OR_EQUAL_FLOAT (threshold, actual)` + +Asserts that the `actual` parameter is greater than `threshold`. +The rules for equality are the same as for `TEST_ASSERT_EQUAL_FLOAT`. + +#### `TEST_ASSERT_FLOAT_IS_INF (actual)` Asserts that `actual` parameter is equivalent to positive infinity floating point representation. - -##### `TEST_ASSERT_FLOAT_IS_NEG_INF (actual)` +#### `TEST_ASSERT_FLOAT_IS_NEG_INF (actual)` Asserts that `actual` parameter is equivalent to negative infinity floating point representation. - -##### `TEST_ASSERT_FLOAT_IS_NAN (actual)` +#### `TEST_ASSERT_FLOAT_IS_NAN (actual)` Asserts that `actual` parameter is a Not A Number floating point representation. +#### `TEST_ASSERT_FLOAT_IS_DETERMINATE (actual)` -##### `TEST_ASSERT_FLOAT_IS_DETERMINATE (actual)` - -Asserts that ?actual?parameter is a floating point representation usable for +Asserts that `actual` parameter is a floating point representation usable for mathematical operations. That is, the `actual` parameter is neither positive infinity nor negative infinity nor Not A Number floating point representations. - -##### `TEST_ASSERT_FLOAT_IS_NOT_INF (actual)` +#### `TEST_ASSERT_FLOAT_IS_NOT_INF (actual)` Asserts that `actual` parameter is a value other than positive infinity floating point representation. - -##### `TEST_ASSERT_FLOAT_IS_NOT_NEG_INF (actual)` +#### `TEST_ASSERT_FLOAT_IS_NOT_NEG_INF (actual)` Asserts that `actual` parameter is a value other than negative infinity floating point representation. - -##### `TEST_ASSERT_FLOAT_IS_NOT_NAN (actual)` +#### `TEST_ASSERT_FLOAT_IS_NOT_NAN (actual)` Asserts that `actual` parameter is a value other than Not A Number floating point representation. - -##### `TEST_ASSERT_FLOAT_IS_NOT_DETERMINATE (actual)` +#### `TEST_ASSERT_FLOAT_IS_NOT_DETERMINATE (actual)` Asserts that `actual` parameter is not usable for mathematical operations. That is, the `actual` parameter is either positive infinity or negative infinity or Not A Number floating point representations. - ### Double (If enabled) -##### `TEST_ASSERT_DOUBLE_WITHIN (delta, expected, actual)` +#### `TEST_ASSERT_DOUBLE_WITHIN (delta, expected, actual)` Asserts that the `actual` value is within +/- `delta` of the `expected` value. The nature of floating point representation is such that exact evaluations of equality are not guaranteed. +#### `TEST_ASSERT_DOUBLE_NOT_WITHIN (delta, expected, actual)` + +Asserts that the `actual` value is NOT within +/- `delta` of the `expected` value. -##### `TEST_ASSERT_EQUAL_DOUBLE (expected, actual)` +#### `TEST_ASSERT_EQUAL_DOUBLE (expected, actual)` -Asserts that the `actual` value is "close enough to be considered equal" to the +Asserts that the `actual` value is “close enough to be considered equal” to the `expected` value. If you are curious about the details, refer to the Advanced Asserting section for more details. Omitting a user-specified delta in a floating point assertion is both a shorthand convenience and a requirement of code generation conventions for CMock. +#### `TEST_ASSERT_NOT_EQUAL_DOUBLE (expected, actual)` + +Asserts that the `actual` value is NOT “close enough to be considered equal” to the +`expected` value. + +#### `TEST_ASSERT_DOUBLE_ARRAY_WITHIN (delta, expected, actual, num_elements)` + +See Array assertion section for details. Note that individual array element +uses user-provided delta plus default comparison delta for checking +and is based on `TEST_ASSERT_DOUBLE_WITHIN` comparison. -##### `TEST_ASSERT_EQUAL_DOUBLE_ARRAY (expected, actual, num_elements)` +#### `TEST_ASSERT_EQUAL_DOUBLE_ARRAY (expected, actual, num_elements)` See Array assertion section for details. Note that individual array element -double comparisons are executed using `TEST_ASSERT_EQUAL_DOUBLE`.That is, user +double comparisons are executed using `TEST_ASSERT_EQUAL_DOUBLE`. That is, user specified delta comparison values requires a custom implemented double array assertion. +#### `TEST_ASSERT_LESS_THAN_DOUBLE (threshold, actual)` -##### `TEST_ASSERT_DOUBLE_IS_INF (actual)` +Asserts that the `actual` parameter is less than `threshold` (exclusive). +For example, if the threshold value is 1.0, the assertion will fail if it is +greater than 1.0. + +#### `TEST_ASSERT_LESS_OR_EQUAL_DOUBLE (threshold, actual)` + +Asserts that the `actual` parameter is less than or equal to `threshold`. +The rules for equality are the same as for `TEST_ASSERT_EQUAL_DOUBLE`. + +#### `TEST_ASSERT_GREATER_THAN_DOUBLE (threshold, actual)` + +Asserts that the `actual` parameter is greater than `threshold` (exclusive). +For example, if the threshold value is 1.0, the assertion will fail if it is +less than 1.0. + +#### `TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE (threshold, actual)` + +Asserts that the `actual` parameter is greater than or equal to `threshold`. +The rules for equality are the same as for `TEST_ASSERT_EQUAL_DOUBLE`. + +#### `TEST_ASSERT_DOUBLE_IS_INF (actual)` Asserts that `actual` parameter is equivalent to positive infinity floating point representation. - -##### `TEST_ASSERT_DOUBLE_IS_NEG_INF (actual)` +#### `TEST_ASSERT_DOUBLE_IS_NEG_INF (actual)` Asserts that `actual` parameter is equivalent to negative infinity floating point representation. - -##### `TEST_ASSERT_DOUBLE_IS_NAN (actual)` +#### `TEST_ASSERT_DOUBLE_IS_NAN (actual)` Asserts that `actual` parameter is a Not A Number floating point representation. - -##### `TEST_ASSERT_DOUBLE_IS_DETERMINATE (actual)` +#### `TEST_ASSERT_DOUBLE_IS_DETERMINATE (actual)` Asserts that `actual` parameter is a floating point representation usable for -mathematical operations. That is, the ?actual?parameter is neither positive +mathematical operations. That is, the `actual` parameter is neither positive infinity nor negative infinity nor Not A Number floating point representations. - -##### `TEST_ASSERT_DOUBLE_IS_NOT_INF (actual)` +#### `TEST_ASSERT_DOUBLE_IS_NOT_INF (actual)` Asserts that `actual` parameter is a value other than positive infinity floating point representation. - -##### `TEST_ASSERT_DOUBLE_IS_NOT_NEG_INF (actual)` +#### `TEST_ASSERT_DOUBLE_IS_NOT_NEG_INF (actual)` Asserts that `actual` parameter is a value other than negative infinity floating point representation. - -##### `TEST_ASSERT_DOUBLE_IS_NOT_NAN (actual)` +#### `TEST_ASSERT_DOUBLE_IS_NOT_NAN (actual)` Asserts that `actual` parameter is a value other than Not A Number floating point representation. - -##### `TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE (actual)` +#### `TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE (actual)` Asserts that `actual` parameter is not usable for mathematical operations. That is, the `actual` parameter is either positive infinity or negative infinity or Not A Number floating point representations. - ## Advanced Asserting: Details On Tricky Assertions This section helps you understand how to deal with some of the trickier assertion situations you may run into. It will give you a glimpse into some of -the under-the-hood details of Unity's assertion mechanisms. If you're one of +the under-the-hood details of Unity’s assertion mechanisms. If you’re one of those people who likes to know what is going on in the background, read on. If not, feel free to ignore the rest of this document until you need it. - ### How do the EQUAL assertions work for FLOAT and DOUBLE? As you may know, directly checking for equality between a pair of floats or a @@ -739,9 +768,9 @@ mathematical operations might result in a representation of 8 x 2-2 that also evaluates to a value of 2. At some point repeated operations cause equality checks to fail. -So Unity doesn't do direct floating point comparisons for equality. Instead, it -checks if two floating point values are "really close." If you leave Unity -running with defaults, "really close" means "within a significant bit or two." +So Unity doesn’t do direct floating point comparisons for equality. Instead, it +checks if two floating point values are “really close.” If you leave Unity +running with defaults, “really close” means “within a significant bit or two.” Under the hood, `TEST_ASSERT_EQUAL_FLOAT` is really `TEST_ASSERT_FLOAT_WITHIN` with the `delta` parameter calculated on the fly. For single precision, delta is the expected value multiplied by 0.00001, producing a very small proportional @@ -750,29 +779,27 @@ range around the expected value. If you are expecting a value of 20,000.0 the delta is calculated to be 0.2. So any value between 19,999.8 and 20,000.2 will satisfy the equality check. This works out to be roughly a single bit of range for a single-precision number, and -that's just about as tight a tolerance as you can reasonably get from a floating +that’s just about as tight a tolerance as you can reasonably get from a floating point value. -So what happens when it's zero? Zero - even more than other floating point -values - can be represented many different ways. It doesn't matter if you have -0 x 20 or 0 x 263.It's still zero, right? Luckily, if you -subtract these values from each other, they will always produce a difference of -zero, which will still fall between 0 plus or minus a delta of 0. So it still -works! +So what happens when it’s zero? Zero - even more than other floating point +values - can be represented many different ways. It doesn’t matter if you have +0x20 or 0x263. It’s still zero, right? Luckily, if you subtract these +values from each other, they will always produce a difference of zero, which +will still fall between 0 plus or minus a delta of 0. So it still works! Double precision floating point numbers use a much smaller multiplier, again approximating a single bit of error. -If you don't like these ranges and you want to make your floating point equality +If you don’t like these ranges and you want to make your floating point equality assertions less strict, you can change these multipliers to whatever you like by defining UNITY_FLOAT_PRECISION and UNITY_DOUBLE_PRECISION. See Unity documentation for more. - ### How do we deal with targets with non-standard int sizes? -It's "fun" that C is a standard where something as fundamental as an integer -varies by target. According to the C standard, an `int` is to be the target's +It’s “fun” that C is a standard where something as fundamental as an integer +varies by target. According to the C standard, an `int` is to be the target’s natural register size, and it should be at least 16-bits and a multiple of a byte. It also guarantees an order of sizes: @@ -786,7 +813,7 @@ and this remains perfectly standard C. To make things even more interesting, there are compilers and targets out there that have a hard choice to make. What if their natural register size is 10-bits -or 12-bits? Clearly they can't fulfill _both_ the requirement to be at least +or 12-bits? Clearly they can’t fulfill _both_ the requirement to be at least 16-bits AND the requirement to match the natural register size. In these situations, they often choose the natural register size, leaving us with something like this: @@ -795,24 +822,24 @@ something like this: char (8 bit) <= short (12 bit) <= int (12 bit) <= long (16 bit) ``` -Um... yikes. It's obviously breaking a rule or two... but they had to break SOME +Um… yikes. It’s obviously breaking a rule or two… but they had to break SOME rules, so they made a choice. When the C99 standard rolled around, it introduced alternate standard-size types. It also introduced macros for pulling in MIN/MAX values for your integer types. -It's glorious! Unfortunately, many embedded compilers can't be relied upon to +It’s glorious! Unfortunately, many embedded compilers can’t be relied upon to use the C99 types (Sometimes because they have weird register sizes as described -above. Sometimes because they don't feel like it?). +above. Sometimes because they don’t feel like it?). A goal of Unity from the beginning was to support every combination of -microcontroller or microprocessor and C compiler. Over time, we've gotten really +microcontroller or microprocessor and C compiler. Over time, we’ve gotten really close to this. There are a few tricks that you should be aware of, though, if -you're going to do this effectively on some of these more idiosyncratic targets. +you’re going to do this effectively on some of these more idiosyncratic targets. -First, when setting up Unity for a new target, you're going to want to pay +First, when setting up Unity for a new target, you’re going to want to pay special attention to the macros for automatically detecting types (where available) or manually configuring them yourself. You can get information -on both of these in Unity's documentation. +on both of these in Unity’s documentation. What about the times where you suddenly need to deal with something odd, like a 24-bit `int`? The simplest solution is to use the next size up. If you have a @@ -820,12 +847,14 @@ What about the times where you suddenly need to deal with something odd, like a `int`, configure Unity to use 16 bits. There are two ways this is going to affect you: -1. When Unity displays errors for you, it's going to pad the upper unused bits -with zeros. -2. You're going to have to be careful of assertions that perform signed -operations, particularly `TEST_ASSERT_INT_WITHIN`.Such assertions might wrap -your `int` in the wrong place, and you could experience false failures. You can -always back down to a simple `TEST_ASSERT` and do the operations yourself. +1. When Unity displays errors for you, it’s going to pad the upper unused bits + with zeros. +2. You’re going to have to be careful of assertions that perform signed + operations, particularly `TEST_ASSERT_INT_WITHIN`. Such assertions might wrap + your `int` in the wrong place, and you could experience false failures. You can + always back down to a simple `TEST_ASSERT` and do the operations yourself. +*Find The Latest of This And More at [ThrowTheSwitch.org][]* -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +[assert() macro]: http://en.wikipedia.org/wiki/Assert.h +[ThrowTheSwitch.org]: https://throwtheswitch.org diff --git a/docs/UnityChangeLog.md b/docs/UnityChangeLog.md new file mode 100644 index 000000000..9c3bb7bf0 --- /dev/null +++ b/docs/UnityChangeLog.md @@ -0,0 +1,93 @@ +# Unity Test - Change Log + +## A Note + +This document captures significant features and fixes to the Unity project core source files +and scripts. More detail can be found in the history on Github. + +This project is now tracking changes in more detail. Previous releases get less detailed as +we move back in histroy. + +Prior to 2012, the project was hosted on SourceForge.net +Prior to 2008, the project was an internal project and not released to the public. + +## Log + +### Unity 2.6.0 () + +New Features: + + - Fill out missing variations of arrays, within, etc. + - Add `TEST_PRINTF()` + - Add `TEST_MATRIX()` and `TEST_RANGE()` options and documentation + - Add support for searching `TEST_SOURCE_FILE()` for determining test dependencies + - Add Unity BDD plugin + - Add `UNITY_INCLUDE_EXEC_TIME` option to report test times + - Allow user to override test abort underlying mechanism + +Significant Bugfixes: + + - More portable validation of NaN and Infinity. Added `UNITY_IS_NAN` and `UNITY_IS_INF` options + - Add `UNITY_PROGMEM` configuration option + - Fix overflow detection of hex values when using arrays + - Fix scripts broken by Ruby standard changes + +Other: + + - Avoid pointer comparison when one is null to avoid compiler warnings + - Significant improvements to documentation + - Updates to match latest Ruby style specification + - Meson, CMake, PlatformIO builds + +### Unity 2.5.2 (January 2021) + + - improvements to RUN_TEST macro and generated RUN_TEST + - Fix `UNITY_TEST_ASSERT_BIT(S)_HIGH` + - Cleaner handling of details tracking by CMock + +### Unity 2.5.1 (May 2020) + +Mostly a bugfix and stability release. +Bonus Features: + + - Optional TEST_PRINTF macro + - Improve self-testing procedures. + +### Unity 2.5.0 (October 2019) + +It's been a LONG time since the last release of Unity. Finally, here it is! +There are too many updates to list here, so some highlights: + + - more standards compliant (without giving up on supporting ALL compilers, no matter how quirky) + - many more specialized assertions for better test feedback + - more examples for integrating into your world + - many many bugfixes and tweaks + +### Unity 2.4.3 (November 2017) + + - Allow suiteSetUp() and suiteTearDown() to be povided as normal C functions + - Fix & Expand Greater Than / Less Than assertions for integers + - Built-in option to colorize test results + - Documentation updates + +### Unity 2.4.2 (September 2017) + + - Fixed bug in UNTY_TEST_ASSERT_EACH_EQUAL_* + - Added TEST_ASSERT_GREATER_THAN and TEST_ASSERT_LESS_THAN + - Updated Module Generator to stop changing names when no style given + - Cleanup to custom float printing for accuracy + - Cleanup incorrect line numbers are partial name matching + - Reduce warnings from using popular function names as variable names + +### Unity 2.4.1 (April 2017) + + - test runner generator can inject defines as well as headers + - added a built-in floating point print routine instead of relying on printf + - updated to new coding and naming standard + - updated documentation to be markdown instead of pdf + - fixed many many little bugs, most of which were supplied by the community (you people are awesome!) + - coding standard actually enforced in CI + +### Unity 2.4.0 (October, 2016) + + - port from SourceForge and numerous bugfixes diff --git a/docs/UnityConfigurationGuide.md b/docs/UnityConfigurationGuide.md index de691fdf2..0b735f7ae 100644 --- a/docs/UnityConfigurationGuide.md +++ b/docs/UnityConfigurationGuide.md @@ -2,133 +2,118 @@ ## C Standards, Compilers and Microcontrollers -The embedded software world contains its challenges. Compilers support different -revisions of the C Standard. They ignore requirements in places, sometimes to -make the language more usable in some special regard. Sometimes it's to simplify -their support. Sometimes it's due to specific quirks of the microcontroller they -are targeting. Simulators add another dimension to this menagerie. - -Unity is designed to run on almost anything that is targeted by a C compiler. It -would be awesome if this could be done with zero configuration. While there are -some targets that come close to this dream, it is sadly not universal. It is -likely that you are going to need at least a couple of the configuration options -described in this document. - -All of Unity's configuration options are `#defines`. Most of these are simple -definitions. A couple are macros with arguments. They live inside the -unity_internals.h header file. We don't necessarily recommend opening that file -unless you really need to. That file is proof that a cross-platform library is -challenging to build. From a more positive perspective, it is also proof that a -great deal of complexity can be centralized primarily to one place to -provide a more consistent and simple experience elsewhere. - +The embedded software world contains its challenges. +Compilers support different revisions of the C Standard. +They ignore requirements in places, sometimes to make the language more usable in some special regard. +Sometimes it's to simplify their support. +Sometimes it's due to specific quirks of the microcontroller they are targeting. +Simulators add another dimension to this menagerie. + +Unity is designed to run on almost anything that is targeted by a C compiler. +It would be awesome if this could be done with zero configuration. +While there are some targets that come close to this dream, it is sadly not universal. +It is likely that you are going to need at least a couple of the configuration options described in this document. + +All of Unity's configuration options are `#defines`. +Most of these are simple definitions. +A couple are macros with arguments. +They live inside the unity_internals.h header file. +We don't necessarily recommend opening that file unless you really need to. +That file is proof that a cross-platform library is challenging to build. +From a more positive perspective, it is also proof that a great deal of complexity can be centralized primarily to one place to provide a more consistent and simple experience elsewhere. ### Using These Options -It doesn't matter if you're using a target-specific compiler and a simulator or -a native compiler. In either case, you've got a couple choices for configuring -these options: - -1. Because these options are specified via C defines, you can pass most of these -options to your compiler through command line compiler flags. Even if you're -using an embedded target that forces you to use their overbearing IDE for all -configuration, there will be a place somewhere in your project to configure -defines for your compiler. -2. You can create a custom `unity_config.h` configuration file (present in your -toolchain's search paths). In this file, you will list definitions and macros -specific to your target. All you must do is define `UNITY_INCLUDE_CONFIG_H` and -Unity will rely on `unity_config.h` for any further definitions it may need. - -Unfortunately, it doesn't usually work well to just #define these things in the -test itself. These defines need to take effect where ever unity.h is included. -This would be test test, the test runner (if you're generating one), and from -unity.c when it's compiled. +It doesn't matter if you're using a target-specific compiler and a simulator or a native compiler. +In either case, you've got a couple choices for configuring these options: + +1. Because these options are specified via C defines, you can pass most of these options to your compiler through command line compiler flags. Even if you're using an embedded target that forces you to use their overbearing IDE for all configuration, there will be a place somewhere in your project to configure defines for your compiler. +2. You can create a custom `unity_config.h` configuration file (present in your toolchain's search paths). + In this file, you will list definitions and macros specific to your target. All you must do is define `UNITY_INCLUDE_CONFIG_H` and Unity will rely on `unity_config.h` for any further definitions it may need. + +Unfortunately, it doesn't usually work well to just #define these things in the test itself. +These defines need to take effect where ever unity.h is included. +This would be test test, the test runner (if you're generating one), and from unity.c when it's compiled. ## The Options ### Integer Types -If you've been a C developer for long, you probably already know that C's -concept of an integer varies from target to target. The C Standard has rules -about the `int` matching the register size of the target microprocessor. It has -rules about the `int` and how its size relates to other integer types. An `int` -on one target might be 16 bits while on another target it might be 64. There are -more specific types in compilers compliant with C99 or later, but that's -certainly not every compiler you are likely to encounter. Therefore, Unity has a -number of features for helping to adjust itself to match your required integer -sizes. It starts off by trying to do it automatically. - +If you've been a C developer for long, you probably already know that C's concept of an integer varies from target to target. +The C Standard has rules about the `int` matching the register size of the target microprocessor. +It has rules about the `int` and how its size relates to other integer types. +An `int` on one target might be 16 bits while on another target it might be 64. +There are more specific types in compilers compliant with C99 or later, but that's certainly not every compiler you are likely to encounter. +Therefore, Unity has a number of features for helping to adjust itself to match your required integer sizes. +It starts off by trying to do it automatically. -##### `UNITY_EXCLUDE_STDINT_H` +#### `UNITY_EXCLUDE_STDINT_H` The first thing that Unity does to guess your types is check `stdint.h`. -This file includes defines like `UINT_MAX` that Unity can use to -learn a lot about your system. It's possible you don't want it to do this -(um. why not?) or (more likely) it's possible that your system doesn't -support `stdint.h`. If that's the case, you're going to want to define this. -That way, Unity will know to skip the inclusion of this file and you won't -be left with a compiler error. +This file includes defines like `UINT_MAX` that Unity can use to learn a lot about your system. +It's possible you don't want it to do this (um. why not?) or (more likely) it's possible that your system doesn't support `stdint.h`. +If that's the case, you're going to want to define this. +That way, Unity will know to skip the inclusion of this file and you won't be left with a compiler error. _Example:_ + ```C #define UNITY_EXCLUDE_STDINT_H ``` +#### `UNITY_EXCLUDE_LIMITS_H` -##### `UNITY_EXCLUDE_LIMITS_H` - -The second attempt to guess your types is to check `limits.h`. Some compilers -that don't support `stdint.h` could include `limits.h` instead. If you don't -want Unity to check this file either, define this to make it skip the inclusion. +The second attempt to guess your types is to check `limits.h`. +Some compilers that don't support `stdint.h` could include `limits.h` instead. +If you don't want Unity to check this file either, define this to make it skip the inclusion. _Example:_ + ```C #define UNITY_EXCLUDE_LIMITS_H ``` -If you've disabled both of the automatic options above, you're going to have to -do the configuration yourself. Don't worry. Even this isn't too bad... there are -just a handful of defines that you are going to specify if you don't like the -defaults. +If you've disabled both of the automatic options above, you're going to have to do the configuration yourself. +Don't worry. +Even this isn't too bad... there are just a handful of defines that you are going to specify if you don't like the defaults. +#### `UNITY_INT_WIDTH` -##### `UNITY_INT_WIDTH` - -Define this to be the number of bits an `int` takes up on your system. The -default, if not autodetected, is 32 bits. +Define this to be the number of bits an `int` takes up on your system. +The default, if not autodetected, is 32 bits. _Example:_ + ```C #define UNITY_INT_WIDTH 16 ``` +#### `UNITY_LONG_WIDTH` -##### `UNITY_LONG_WIDTH` - -Define this to be the number of bits a `long` takes up on your system. The -default, if not autodetected, is 32 bits. This is used to figure out what kind -of 64-bit support your system can handle. Does it need to specify a `long` or a -`long long` to get a 64-bit value. On 16-bit systems, this option is going to be -ignored. +Define this to be the number of bits a `long` takes up on your system. +The default, if not autodetected, is 32 bits. +This is used to figure out what kind of 64-bit support your system can handle. +Does it need to specify a `long` or a `long long` to get a 64-bit value. +On 16-bit systems, this option is going to be ignored. _Example:_ + ```C #define UNITY_LONG_WIDTH 16 ``` +#### `UNITY_POINTER_WIDTH` -##### `UNITY_POINTER_WIDTH` +Define this to be the number of bits a pointer takes up on your system. +The default, if not autodetected, is 32-bits. +If you're getting ugly compiler warnings about casting from pointers, this is the one to look at. -Define this to be the number of bits a pointer takes up on your system. The -default, if not autodetected, is 32-bits. If you're getting ugly compiler -warnings about casting from pointers, this is the one to look at. - -_Hint:_ In order to support exotic processors (for example TI C55x with a pointer -width of 23-bit), choose the next power of two (in this case 32-bit). +_Hint:_ In order to support exotic processors (for example TI C55x with a pointer width of 23-bit), choose the next power of two (in this case 32-bit). _Supported values:_ 16, 32 and 64 _Example:_ + ```C // Choose on of these #defines to set your pointer width (if not autodetected) //#define UNITY_POINTER_WIDTH 16 @@ -136,140 +121,137 @@ _Example:_ #define UNITY_POINTER_WIDTH 64 // Set UNITY_POINTER_WIDTH to 64-bit ``` +#### `UNITY_COMPARE_PTRS_ON_ZERO_ARRAY` + +Define this to make all array assertions compare pointers instead of contents when a length of zero is specified. When not enabled, +defining a length of zero will always result in a failure and a message warning the user that they have tried to compare empty +arrays. -##### `UNITY_SUPPORT_64` +#### `UNITY_SUPPORT_64` -Unity will automatically include 64-bit support if it auto-detects it, or if -your `int`, `long`, or pointer widths are greater than 32-bits. Define this to -enable 64-bit support if none of the other options already did it for you. There -can be a significant size and speed impact to enabling 64-bit support on small -targets, so don't define it if you don't need it. +Unity will automatically include 64-bit support if it auto-detects it, or if your `int`, `long`, or pointer widths are greater than 32-bits. +Define this to enable 64-bit support if none of the other options already did it for you. +There can be a significant size and speed impact to enabling 64-bit support on small targets, so don't define it if you don't need it. _Example:_ + ```C #define UNITY_SUPPORT_64 ``` - ### Floating Point Types -In the embedded world, it's not uncommon for targets to have no support for -floating point operations at all or to have support that is limited to only -single precision. We are able to guess integer sizes on the fly because integers -are always available in at least one size. Floating point, on the other hand, is -sometimes not available at all. Trying to include `float.h` on these platforms -would result in an error. This leaves manual configuration as the only option. +In the embedded world, it's not uncommon for targets to have no support for floating point operations at all or to have support that is limited to only single precision. +We are able to guess integer sizes on the fly because integers are always available in at least one size. +Floating point, on the other hand, is sometimes not available at all. +Trying to include `float.h` on these platforms would result in an error. This leaves manual configuration as the only option. +#### `UNITY_INCLUDE_FLOAT` -##### `UNITY_INCLUDE_FLOAT` +#### `UNITY_EXCLUDE_FLOAT` -##### `UNITY_EXCLUDE_FLOAT` +#### `UNITY_INCLUDE_DOUBLE` -##### `UNITY_INCLUDE_DOUBLE` +#### `UNITY_EXCLUDE_DOUBLE` -##### `UNITY_EXCLUDE_DOUBLE` - -By default, Unity guesses that you will want single precision floating point -support, but not double precision. It's easy to change either of these using the -include and exclude options here. You may include neither, either, or both, as -suits your needs. For features that are enabled, the following floating point -options also become available. +By default, Unity guesses that you will want single precision floating point support, but not double precision. +It's easy to change either of these using the include and exclude options here. +You may include neither, either, or both, as suits your needs. +For features that are enabled, the following floating point options also become available. _Example:_ + ```C //what manner of strange processor is this? #define UNITY_EXCLUDE_FLOAT #define UNITY_INCLUDE_DOUBLE ``` +#### `UNITY_EXCLUDE_FLOAT_PRINT` -##### `UNITY_EXCLUDE_FLOAT_PRINT` - -Unity aims for as small of a footprint as possible and avoids most standard -library calls (some embedded platforms don’t have a standard library!). Because -of this, its routines for printing integer values are minimalist and hand-coded. +Unity aims for as small of a footprint as possible and avoids most standard library calls (some embedded platforms don’t have a standard library!). +Because of this, its routines for printing integer values are minimalist and hand-coded. Therefore, the display of floating point values during a failure are optional. -By default, Unity will print the actual results of floating point assertion -failure (e.g. ”Expected 4.56 Was 4.68”). To not include this extra support, you -can use this define to instead respond to a failed assertion with a message like -”Values Not Within Delta”. If you would like verbose failure messages for floating -point assertions, use these options to give more explicit failure messages. +By default, Unity will print the actual results of floating point assertion failure (e.g. ”Expected 4.56 Was 4.68”). +To not include this extra support, you can use this define to instead respond to a failed assertion with a message like ”Values Not Within Delta”. +If you would like verbose failure messages for floating point assertions, use these options to give more explicit failure messages. _Example:_ + ```C #define UNITY_EXCLUDE_FLOAT_PRINT ``` +#### `UNITY_FLOAT_TYPE` -##### `UNITY_FLOAT_TYPE` - -If enabled, Unity assumes you want your `FLOAT` asserts to compare standard C -floats. If your compiler supports a specialty floating point type, you can -always override this behavior by using this definition. +If enabled, Unity assumes you want your `FLOAT` asserts to compare standard C floats. +If your compiler supports a specialty floating point type, you can always override this behavior by using this definition. _Example:_ + ```C #define UNITY_FLOAT_TYPE float16_t ``` +#### `UNITY_DOUBLE_TYPE` -##### `UNITY_DOUBLE_TYPE` - -If enabled, Unity assumes you want your `DOUBLE` asserts to compare standard C -doubles. If you would like to change this, you can specify something else by -using this option. For example, defining `UNITY_DOUBLE_TYPE` to `long double` -could enable gargantuan floating point types on your 64-bit processor instead of -the standard `double`. +If enabled, Unity assumes you want your `DOUBLE` asserts to compare standard C doubles. +If you would like to change this, you can specify something else by using this option. +For example, defining `UNITY_DOUBLE_TYPE` to `long double` could enable gargantuan floating point types on your 64-bit processor instead of the standard `double`. _Example:_ + ```C #define UNITY_DOUBLE_TYPE long double ``` +#### `UNITY_FLOAT_PRECISION` -##### `UNITY_FLOAT_PRECISION` +#### `UNITY_DOUBLE_PRECISION` -##### `UNITY_DOUBLE_PRECISION` - -If you look up `UNITY_ASSERT_EQUAL_FLOAT` and `UNITY_ASSERT_EQUAL_DOUBLE` as -documented in the big daddy Unity Assertion Guide, you will learn that they are -not really asserting that two values are equal but rather that two values are -"close enough" to equal. "Close enough" is controlled by these precision -configuration options. If you are working with 32-bit floats and/or 64-bit -doubles (the normal on most processors), you should have no need to change these -options. They are both set to give you approximately 1 significant bit in either -direction. The float precision is 0.00001 while the double is 10-12. -For further details on how this works, see the appendix of the Unity Assertion -Guide. +If you look up `UNITY_ASSERT_EQUAL_FLOAT` and `UNITY_ASSERT_EQUAL_DOUBLE` as documented in the big daddy Unity Assertion Guide, you will learn that they are not really asserting that two values are equal but rather that two values are "close enough" to equal. +"Close enough" is controlled by these precision configuration options. +If you are working with 32-bit floats and/or 64-bit doubles (the normal on most processors), you should have no need to change these options. +They are both set to give you approximately 1 significant bit in either direction. +The float precision is 0.00001 while the double is 10-12. +For further details on how this works, see the appendix of the Unity Assertion Guide. _Example:_ + ```C #define UNITY_FLOAT_PRECISION 0.001f ``` +#### `UNITY_IS_NAN` and `UNITY_IS_INF` + +If your toolchain defines `isnan` and `isinf` in `math.h` as macros, nothing needs to be done. If your toolchain doesn't define these, Unity +will create these macros itself. You may override either or both of these defines to specify how you want to evaluate if a number is NaN or Infinity. + +_Example:_ + +```C +#define UNITY_IS_NAN(n) ((n != n) ? 1 : 0) +``` ### Miscellaneous -##### `UNITY_EXCLUDE_STDDEF_H` +#### `UNITY_EXCLUDE_STDDEF_H` -Unity uses the `NULL` macro, which defines the value of a null pointer constant, -defined in `stddef.h` by default. If you want to provide -your own macro for this, you should exclude the `stddef.h` header file by adding this -define to your configuration. +Unity uses the `NULL` macro, which defines the value of a null pointer constant, defined in `stddef.h` by default. +If you want to provide your own macro for this, you should exclude the `stddef.h` header file by adding this define to your configuration. _Example:_ + ```C #define UNITY_EXCLUDE_STDDEF_H ``` - #### `UNITY_INCLUDE_PRINT_FORMATTED` -Unity provides a simple (and very basic) printf-like string output implementation, -which is able to print a string modified by the following format string modifiers: +Unity provides a simple (and very basic) printf-like string output implementation, which is able to print a string modified by the following format string modifiers: - __%d__ - signed value (decimal) -- __%i__ - same as __%i__ +- __%i__ - same as __%d__ - __%u__ - unsigned value (decimal) - __%f__ - float/Double (if float support is activated) - __%g__ - same as __%f__ @@ -281,7 +263,17 @@ which is able to print a string modified by the following format string modifier - __%s__ - a string (e.g. "string") - __%%__ - The "%" symbol (escaped) +Length specifiers are also supported. If you are using long long types, make sure UNITY_SUPPORT_64 is true to ensure they are printed correctly. + +- __%ld__ - signed long value (decimal) +- __%lld__ - signed long long value (decimal) +- __%lu__ - unsigned long value (decimal) +- __%llu__ - unsigned long long value (decimal) +- __%lx__ - unsigned long value (hexadecimal) +- __%llx__ - unsigned long long value (hexadecimal) + _Example:_ + ```C #define UNITY_INCLUDE_PRINT_FORMATTED @@ -295,44 +287,38 @@ TEST_PRINTF("Pointer %p\n", &a); TEST_PRINTF("Character %c\n", 'F'); TEST_PRINTF("String %s\n", "My string"); TEST_PRINTF("Percent %%\n"); -TEST_PRINTF("Color Red \033[41mFAIL\033[00m\n"); +TEST_PRINTF("Unsigned long long %llu\n", 922337203685477580); +TEST_PRINTF("Color Red \033[41mFAIL\033[0m\n"); TEST_PRINTF("\n"); TEST_PRINTF("Multiple (%d) (%i) (%u) (%x)\n", -100, 0, 200, 0x12345); ``` - ### Toolset Customization -In addition to the options listed above, there are a number of other options -which will come in handy to customize Unity's behavior for your specific -toolchain. It is possible that you may not need to touch any of these... but -certain platforms, particularly those running in simulators, may need to jump -through extra hoops to run properly. These macros will help in those -situations. +In addition to the options listed above, there are a number of other options which will come in handy to customize Unity's behavior for your specific toolchain. +It is possible that you may not need to touch any of these... but certain platforms, particularly those running in simulators, may need to jump through extra hoops to run properly. +These macros will help in those situations. +#### `UNITY_OUTPUT_CHAR(a)` -##### `UNITY_OUTPUT_CHAR(a)` +#### `UNITY_OUTPUT_FLUSH()` -##### `UNITY_OUTPUT_FLUSH()` +#### `UNITY_OUTPUT_START()` -##### `UNITY_OUTPUT_START()` +#### `UNITY_OUTPUT_COMPLETE()` -##### `UNITY_OUTPUT_COMPLETE()` - -By default, Unity prints its results to `stdout` as it runs. This works -perfectly fine in most situations where you are using a native compiler for -testing. It works on some simulators as well so long as they have `stdout` -routed back to the command line. There are times, however, where the simulator -will lack support for dumping results or you will want to route results -elsewhere for other reasons. In these cases, you should define the -`UNITY_OUTPUT_CHAR` macro. This macro accepts a single character at a time (as -an `int`, since this is the parameter type of the standard C `putchar` function -most commonly used). You may replace this with whatever function call you like. +By default, Unity prints its results to `stdout` as it runs. +This works perfectly fine in most situations where you are using a native compiler for testing. +It works on some simulators as well so long as they have `stdout` routed back to the command line. +There are times, however, where the simulator will lack support for dumping results or you will want to route results elsewhere for other reasons. +In these cases, you should define the `UNITY_OUTPUT_CHAR` macro. +This macro accepts a single character at a time (as an `int`, since this is the parameter type of the standard C `putchar` function most commonly used). +You may replace this with whatever function call you like. _Example:_ -Say you are forced to run your test suite on an embedded processor with no -`stdout` option. You decide to route your test result output to a custom serial -`RS232_putc()` function you wrote like thus: +Say you are forced to run your test suite on an embedded processor with no `stdout` option. +You decide to route your test result output to a custom serial `RS232_putc()` function you wrote like thus: + ```C #include "RS232_header.h" ... @@ -343,67 +329,63 @@ Say you are forced to run your test suite on an embedded processor with no ``` _Note:_ -`UNITY_OUTPUT_FLUSH()` can be set to the standard out flush function simply by -specifying `UNITY_USE_FLUSH_STDOUT`. No other defines are required. - +`UNITY_OUTPUT_FLUSH()` can be set to the standard out flush function simply by specifying `UNITY_USE_FLUSH_STDOUT`. +No other defines are required. -##### `UNITY_OUTPUT_FOR_ECLIPSE` +#### `UNITY_OUTPUT_FOR_ECLIPSE` -##### `UNITY_OUTPUT_FOR_IAR_WORKBENCH` +#### `UNITY_OUTPUT_FOR_IAR_WORKBENCH` -##### `UNITY_OUTPUT_FOR_QT_CREATOR` +#### `UNITY_OUTPUT_FOR_QT_CREATOR` -When managing your own builds, it is often handy to have messages output in a format which is -recognized by your IDE. These are some standard formats which can be supported. If you're using -Ceedling to manage your builds, it is better to stick with the standard format (leaving these -all undefined) and allow Ceedling to use its own decorators. +When managing your own builds, it is often handy to have messages output in a format which is recognized by your IDE. +These are some standard formats which can be supported. +If you're using Ceedling to manage your builds, it is better to stick with the standard format (leaving these all undefined) and allow Ceedling to use its own decorators. +#### `UNITY_PTR_ATTRIBUTE` -##### `UNITY_PTR_ATTRIBUTE` - -Some compilers require a custom attribute to be assigned to pointers, like -`near` or `far`. In these cases, you can give Unity a safe default for these by -defining this option with the attribute you would like. +Some compilers require a custom attribute to be assigned to pointers, like `near` or `far`. +In these cases, you can give Unity a safe default for these by defining this option with the attribute you would like. _Example:_ + ```C #define UNITY_PTR_ATTRIBUTE __attribute__((far)) #define UNITY_PTR_ATTRIBUTE near ``` -##### `UNITY_PRINT_EOL` +#### `UNITY_PRINT_EOL` -By default, Unity outputs \n at the end of each line of output. This is easy -to parse by the scripts, by Ceedling, etc, but it might not be ideal for YOUR -system. Feel free to override this and to make it whatever you wish. +By default, Unity outputs \n at the end of each line of output. +This is easy to parse by the scripts, by Ceedling, etc, but it might not be ideal for YOUR system. +Feel free to override this and to make it whatever you wish. _Example:_ + ```C -#define UNITY_PRINT_EOL { UNITY_OUTPUT_CHAR('\r'); UNITY_OUTPUT_CHAR('\n') } +#define UNITY_PRINT_EOL { UNITY_OUTPUT_CHAR('\r'); UNITY_OUTPUT_CHAR('\n'); } ``` +#### `UNITY_EXCLUDE_DETAILS` -##### `UNITY_EXCLUDE_DETAILS` - -This is an option for if you absolutely must squeeze every byte of memory out of -your system. Unity stores a set of internal scratchpads which are used to pass -extra detail information around. It's used by systems like CMock in order to -report which function or argument flagged an error. If you're not using CMock and -you're not using these details for other things, then you can exclude them. +This is an option for if you absolutely must squeeze every byte of memory out of your system. +Unity stores a set of internal scratchpads which are used to pass extra detail information around. +It's used by systems like CMock in order to report which function or argument flagged an error. +If you're not using CMock and you're not using these details for other things, then you can exclude them. _Example:_ + ```C #define UNITY_EXCLUDE_DETAILS ``` -##### `UNITY_PRINT_TEST_CONTEXT` +#### `UNITY_PRINT_TEST_CONTEXT` -This option allows you to specify your own function to print additional context -as part of the error message when a test has failed. It can be useful if you -want to output some specific information about the state of the test at the point -of failure, and `UNITY_SET_DETAILS` isn't flexible enough for your needs. +This option allows you to specify your own function to print additional context as part of the error message when a test has failed. +It can be useful if you want to output some specific information about the state of the test at the point of failure, and `UNITY_SET_DETAILS` isn't flexible enough for your needs. _Example:_ + ```C #define UNITY_PRINT_TEST_CONTEXT PrintIterationCount @@ -415,82 +397,196 @@ void PrintIterationCount(void) } ``` -##### `UNITY_EXCLUDE_SETJMP` +#### `UNITY_EXCLUDE_SETJMP` -If your embedded system doesn't support the standard library setjmp, you can -exclude Unity's reliance on this by using this define. This dropped dependence -comes at a price, though. You will be unable to use custom helper functions for -your tests, and you will be unable to use tools like CMock. Very likely, if your -compiler doesn't support setjmp, you wouldn't have had the memory space for those -things anyway, though... so this option exists for those situations. +If your embedded system doesn't support the standard library setjmp, you can exclude Unity's reliance on this by using this define. +This dropped dependence comes at a price, though. +You will be unable to use custom helper functions for your tests, and you will be unable to use tools like CMock. +Very likely, if your compiler doesn't support setjmp, you wouldn't have had the memory space for those things anyway, though... so this option exists for those situations. _Example:_ + ```C #define UNITY_EXCLUDE_SETJMP ``` -##### `UNITY_OUTPUT_COLOR` +#### `UNITY_TEST_PROTECT` + +#### `UNITY_TEST_ABORT` + +Unity handles test failures via `setjmp`/`longjmp` pair by default. As mentioned above, you can disable this with `UNITY_EXCLUDE_SETJMP`. You can also customise what happens on every `TEST_PROTECT` and `TEST_ABORT` call. This can be accomplished by providing user-defined `UNITY_TEST_PROTECT` and `UNITY_TEST_ABORT` macros (and these may be defined independently). + +`UNITY_TEST_PROTECT` is used as an `if` statement expression, and has to evaluate to `true` on the first call (when saving stack environment with `setjmp`), and to `false` when it returns as a result of a `TEST_ABORT` (when restoring the stack environment with `longjmp`). + +Whenever an assert macro fails, `TEST_ABORT` is used to restore the stack environment previously set by `TEST_PROTECT`. This part may be overriden with `UNITY_TEST_ABORT`, e.g. if custom failure handling is needed. + +_Example 1:_ + +Calling `longjmp` on your target is possible, but has a platform-specific (or implementation-specific) set of prerequisites, e.g. privileged access level. You can extend the default behaviour of `TEST_PROTECT` and `TEST_ABORT` as: + +`unity_config.h`: + +```C +#include "my_custom_test_handlers.h" + +#define UNITY_TEST_PROTECT() custom_test_protect() +#define UNITY_TEST_ABORT() custom_test_abort() +``` + +`my_custom_test_handlers.c`: + +```C +int custom_test_protect(void) { + platform_specific_code(); + return setjmp(Unity.AbortFrame) == 0; +} + +UNITY_NORETURN void custom_test_abort(void) { + more_platform_specific_code(); + longjmp(Unity.AbortFrame, 1); +} +``` + +_Example 2:_ + +Unity is used to provide the assertion macros only, and an external test harness/runner is used for test orchestration/reporting. In this case you can easily plug your code by overriding `TEST_ABORT` as: + +`unity_config.h`: + +```C +#include "my_custom_test_handlers.h" + +#define UNITY_TEST_PROTECT() 1 +#define UNITY_TEST_ABORT() custom_test_abort() +``` + +`my_custom_test_handlers.c`: + +```C +void custom_test_abort(void) { + if (Unity.CurrentTestFailed == 1) { + custom_failed_test_handler(); + } else if (Unity.CurrentTestIgnored == 1) { + custom_ignored_test_handler(); + } +} +``` + +#### `UNITY_OUTPUT_COLOR` If you want to add color using ANSI escape codes you can use this define. _Example:_ + ```C #define UNITY_OUTPUT_COLOR ``` -##### `UNITY_SHORTHAND_AS_INT` -##### `UNITY_SHORTHAND_AS_MEM` -##### `UNITY_SHORTHAND_AS_RAW` -##### `UNITY_SHORTHAND_AS_NONE` - -These options give you control of the `TEST_ASSERT_EQUAL` and the -`TEST_ASSERT_NOT_EQUAL` shorthand assertions. Historically, Unity treated the -former as an alias for an integer comparison. It treated the latter as a direct -comparison using `!=`. This assymetry was confusing, but there was much -disagreement as to how best to treat this pair of assertions. These four options -will allow you to specify how Unity will treat these assertions. - - - AS INT - the values will be cast to integers and directly compared. Arguments - that don't cast easily to integers will cause compiler errors. - - AS MEM - the address of both values will be taken and the entire object's - memory footprint will be compared byte by byte. Directly placing - constant numbers like `456` as expected values will cause errors. - - AS_RAW - Unity assumes that you can compare the two values using `==` and `!=` - and will do so. No details are given about mismatches, because it - doesn't really know what type it's dealing with. - - AS_NONE - Unity will disallow the use of these shorthand macros altogether, - insisting that developers choose a more descriptive option. +#### `UNITY_INCLUDE_EXEC_TIME` + +Define this to measure and report execution time for each test in the suite. When enabled, Unity will do +it's best to automatically find a way to determine the time in milliseconds. On most Windows, macos, or +Linux environments, this is automatic. If not, you can give Unity more information. + +#### `UNITY_CLOCK_MS` + +If you're working on a system (embedded or otherwise) which has an accessible millisecond timer. You can +define `UNITY_CLOCK_MS` to be the name of the function which returns the millisecond timer. It will then +attempt to use that function for timing purposes. + +#### `UNITY_EXEC_TIME_START` + +Define this hook to start a millisecond timer if necessary. + +#### `UNITY_EXEC_TIME_STOP` + +Define this hook to stop a millisecond timer if necessary. + +#### `UNITY_PRINT_EXEC_TIME` + +Define this hook to print the current execution time. Used to report the milliseconds elapsed. + +#### `UNITY_TIME_TYPE` + +Finally, this can be set to the type which holds the millisecond timer. + +#### `UNITY_SHORTHAND_AS_INT` + +#### `UNITY_SHORTHAND_AS_MEM` + +#### `UNITY_SHORTHAND_AS_RAW` + +#### `UNITY_SHORTHAND_AS_NONE` + +These options give you control of the `TEST_ASSERT_EQUAL` and the `TEST_ASSERT_NOT_EQUAL` shorthand assertions. +Historically, Unity treated the former as an alias for an integer comparison. +It treated the latter as a direct comparison using `!=`. +This asymmetry was confusing, but there was much disagreement as to how best to treat this pair of assertions. +These four options will allow you to specify how Unity will treat these assertions. + +- AS INT - the values will be cast to integers and directly compared. + Arguments that don't cast easily to integers will cause compiler errors. +- AS MEM - the address of both values will be taken and the entire object's memory footprint will be compared byte by byte. + Directly placing constant numbers like `456` as expected values will cause errors. +- AS_RAW - Unity assumes that you can compare the two values using `==` and `!=` and will do so. + No details are given about mismatches, because it doesn't really know what type it's dealing with. +- AS_NONE - Unity will disallow the use of these shorthand macros altogether, insisting that developers choose a more descriptive option. #### `UNITY_SUPPORT_VARIADIC_MACROS` -This will force Unity to support variadic macros when using its own built-in -RUN_TEST macro. This will rarely be necessary. Most often, Unity will automatically -detect if the compiler supports variadic macros by checking to see if it's C99+ -compatible. In the event that the compiler supports variadic macros, but is primarily -C89 (ANSI), defining this option will allow you to use them. This option is also not -necessary when using Ceedling or the test runner generator script. +This will force Unity to support variadic macros when using its own built-in RUN_TEST macro. +This will rarely be necessary. Most often, Unity will automatically detect if the compiler supports variadic macros by checking to see if it's C99+ compatible. +In the event that the compiler supports variadic macros, but is primarily C89 (ANSI), defining this option will allow you to use them. +This option is also not necessary when using Ceedling or the test runner generator script. -## Getting Into The Guts +#### `UNITY_SUPPORT_TEST_CASES` -There will be cases where the options above aren't quite going to get everything -perfect. They are likely sufficient for any situation where you are compiling -and executing your tests with a native toolchain (e.g. clang on Mac). These -options may even get you through the majority of cases encountered in working -with a target simulator run from your local command line. But especially if you -must run your test suite on your target hardware, your Unity configuration will -require special help. This special help will usually reside in one of two -places: the `main()` function or the `RUN_TEST` macro. Let's look at how these -work. +Unity can automatically define all supported parameterized tests macros. +That feature is disabled by default. +To enable it, use the following example: +```C +#define UNITY_SUPPORT_TEST_CASES +``` -##### `main()` +You can manually provide required `TEST_CASE`, `TEST_RANGE` or `TEST_MATRIX` macro definitions +before including `unity.h`, and they won't be redefined. +If you provide one of the following macros, some of default definitions will not be +defined: +| User defines macro | Unity will _not_ define following macro | +|---|---| +| `UNITY_EXCLUDE_TEST_CASE` | `TEST_CASE` | +| `UNITY_EXCLUDE_TEST_RANGE` | `TEST_RANGE` | +| `UNITY_EXCLUDE_TEST_MATRIX` | `TEST_MATRIX` | +| `TEST_CASE` | `TEST_CASE` | +| `TEST_RANGE` | `TEST_RANGE` | +| `TEST_MATRIX` | `TEST_MATRIX` | + +`UNITY_EXCLUDE_TEST_*` defines is not processed by test runner generator script. +If you exclude one of them from definition, you should provide your own definition +for them or avoid using undefined `TEST_*` macro as a test generator. +Otherwise, compiler cannot build source code file with provided call. -Each test module is compiled and run on its own, separate from the other test -files in your project. Each test file, therefore, has a `main` function. This -`main` function will need to contain whatever code is necessary to initialize -your system to a workable state. This is particularly true for situations where -you must set up a memory map or initialize a communication channel for the -output of your test results. +_Note:_ +That feature requires variadic macro support by compiler. If required feature +is not detected, it will not be enabled, even though preprocessor macro is defined. + +## Getting Into The Guts + +There will be cases where the options above aren't quite going to get everything perfect. +They are likely sufficient for any situation where you are compiling and executing your tests with a native toolchain (e.g. clang on Mac). +These options may even get you through the majority of cases encountered in working with a target simulator run from your local command line. +But especially if you must run your test suite on your target hardware, your Unity configuration will +require special help. +This special help will usually reside in one of two places: the `main()` function or the `RUN_TEST` macro. +Let's look at how these work. + +### `main()` + +Each test module is compiled and run on its own, separate from the other test files in your project. +Each test file, therefore, has a `main` function. +This `main` function will need to contain whatever code is necessary to initialize your system to a workable state. +This is particularly true for situations where you must set up a memory map or initialize a communication channel for the output of your test results. A simple main function looks something like this: @@ -504,26 +600,22 @@ int main(void) { } ``` -You can see that our main function doesn't bother taking any arguments. For our -most barebones case, we'll never have arguments because we just run all the -tests each time. Instead, we start by calling `UNITY_BEGIN`. We run each test -(in whatever order we wish). Finally, we call `UNITY_END`, returning its return -value (which is the total number of failures). - -It should be easy to see that you can add code before any test cases are run or -after all the test cases have completed. This allows you to do any needed -system-wide setup or teardown that might be required for your special -circumstances. +You can see that our main function doesn't bother taking any arguments. +For our most barebones case, we'll never have arguments because we just run all the tests each time. +Instead, we start by calling `UNITY_BEGIN`. +We run each test (in whatever order we wish). +Finally, we call `UNITY_END`, returning its return value (which is the total number of failures). +It should be easy to see that you can add code before any test cases are run or after all the test cases have completed. +This allows you to do any needed system-wide setup or teardown that might be required for your special circumstances. -##### `RUN_TEST` +#### `RUN_TEST` -The `RUN_TEST` macro is called with each test case function. Its job is to -perform whatever setup and teardown is necessary for executing a single test -case function. This includes catching failures, calling the test module's -`setUp()` and `tearDown()` functions, and calling `UnityConcludeTest()`. If -using CMock or test coverage, there will be additional stubs in use here. A -simple minimalist RUN_TEST macro looks something like this: +The `RUN_TEST` macro is called with each test case function. +Its job is to perform whatever setup and teardown is necessary for executing a single test case function. +This includes catching failures, calling the test module's `setUp()` and `tearDown()` functions, and calling `UnityConcludeTest()`. +If using CMock or test coverage, there will be additional stubs in use here. +A simple minimalist RUN_TEST macro looks something like this: ```C #define RUN_TEST(testfunc) \ @@ -537,27 +629,26 @@ simple minimalist RUN_TEST macro looks something like this: UnityConcludeTest(); ``` -So that's quite a macro, huh? It gives you a glimpse of what kind of stuff Unity -has to deal with for every single test case. For each test case, we declare that -it is a new test. Then we run `setUp` and our test function. These are run -within a `TEST_PROTECT` block, the function of which is to handle failures that -occur during the test. Then, assuming our test is still running and hasn't been -ignored, we run `tearDown`. No matter what, our last step is to conclude this -test before moving on to the next. - -Let's say you need to add a call to `fsync` to force all of your output data to -flush to a file after each test. You could easily insert this after your -`UnityConcludeTest` call. Maybe you want to write an xml tag before and after -each result set. Again, you could do this by adding lines to this macro. Updates -to this macro are for the occasions when you need an action before or after -every single test case throughout your entire suite of tests. +So that's quite a macro, huh? +It gives you a glimpse of what kind of stuff Unity has to deal with for every single test case. +For each test case, we declare that it is a new test. +Then we run `setUp` and our test function. +These are run within a `TEST_PROTECT` block, the function of which is to handle failures that occur during the test. +Then, assuming our test is still running and hasn't been ignored, we run `tearDown`. +No matter what, our last step is to conclude this test before moving on to the next. +Let's say you need to add a call to `fsync` to force all of your output data to flush to a file after each test. +You could easily insert this after your `UnityConcludeTest` call. +Maybe you want to write an xml tag before and after each result set. +Again, you could do this by adding lines to this macro. +Updates to this macro are for the occasions when you need an action before or after every single test case throughout your entire suite of tests. ## Happy Porting -The defines and macros in this guide should help you port Unity to just about -any C target we can imagine. If you run into a snag or two, don't be afraid of -asking for help on the forums. We love a good challenge! +The defines and macros in this guide should help you port Unity to just about any C target we can imagine. +If you run into a snag or two, don't be afraid of asking for help on the forums. +We love a good challenge! +*Find The Latest of This And More at [ThrowTheSwitch.org][]* -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +[ThrowTheSwitch.org]: https://throwtheswitch.org diff --git a/docs/UnityGettingStartedGuide.md b/docs/UnityGettingStartedGuide.md index c054b3618..b951c60ce 100644 --- a/docs/UnityGettingStartedGuide.md +++ b/docs/UnityGettingStartedGuide.md @@ -2,123 +2,104 @@ ## Welcome -Congratulations. You're now the proud owner of your very own pile of bits! What -are you going to do with all these ones and zeros? This document should be able -to help you decide just that. +Congratulations. +You're now the proud owner of your very own pile of bits! +What are you going to do with all these ones and zeros? +This document should be able to help you decide just that. -Unity is a unit test framework. The goal has been to keep it small and -functional. The core Unity test framework is three files: a single C file and a -couple header files. These team up to provide functions and macros to make -testing easier. - -Unity was designed to be cross-platform. It works hard to stick with C standards -while still providing support for the many embedded C compilers that bend the -rules. Unity has been used with many compilers, including GCC, IAR, Clang, -Green Hills, Microchip, and MS Visual Studio. It's not much work to get it to -work with a new target. +Unity is a unit test framework. +The goal has been to keep it small and functional. +The core Unity test framework is three files: a single C file and a couple header files. +These team up to provide functions and macros to make testing easier. +Unity was designed to be cross-platform. +It works hard to stick with C standards while still providing support for the many embedded C compilers that bend the rules. +Unity has been used with many compilers, including GCC, IAR, Clang, Green Hills, Microchip, and MS Visual Studio. +It's not much work to get it to work with a new target. ### Overview of the Documents #### Unity Assertions reference -This document will guide you through all the assertion options provided by -Unity. This is going to be your unit testing bread and butter. You'll spend more -time with assertions than any other part of Unity. - +This document will guide you through all the assertion options provided by Unity. +This is going to be your unit testing bread and butter. +You'll spend more time with assertions than any other part of Unity. #### Unity Assertions Cheat Sheet -This document contains an abridged summary of the assertions described in the -previous document. It's perfect for printing and referencing while you -familiarize yourself with Unity's options. - +This document contains an abridged summary of the assertions described in the previous document. +It's perfect for printing and referencing while you familiarize yourself with Unity's options. #### Unity Configuration Guide -This document is the one to reference when you are going to use Unity with a new -target or compiler. It'll guide you through the configuration options and will -help you customize your testing experience to meet your needs. - +This document is the one to reference when you are going to use Unity with a new target or compiler. +It'll guide you through the configuration options and will help you customize your testing experience to meet your needs. #### Unity Helper Scripts -This document describes the helper scripts that are available for simplifying -your testing workflow. It describes the collection of optional Ruby scripts -included in the auto directory of your Unity installation. Neither Ruby nor -these scripts are necessary for using Unity. They are provided as a convenience -for those who wish to use them. - +This document describes the helper scripts that are available for simplifying your testing workflow. +It describes the collection of optional Ruby scripts included in the auto directory of your Unity installation. +Neither Ruby nor these scripts are necessary for using Unity. +They are provided as a convenience for those who wish to use them. #### Unity License -What's an open source project without a license file? This brief document -describes the terms you're agreeing to when you use this software. Basically, we -want it to be useful to you in whatever context you want to use it, but please -don't blame us if you run into problems. - +What's an open source project without a license file? +This brief document describes the terms you're agreeing to when you use this software. +Basically, we want it to be useful to you in whatever context you want to use it, but please don't blame us if you run into problems. ### Overview of the Folders -If you have obtained Unity through Github or something similar, you might be -surprised by just how much stuff you suddenly have staring you in the face. -Don't worry, Unity itself is very small. The rest of it is just there to make -your life easier. You can ignore it or use it at your convenience. Here's an -overview of everything in the project. - -- `src` - This is the code you care about! This folder contains a C file and two -header files. These three files _are_ Unity. -- `docs` - You're reading this document, so it's possible you have found your way -into this folder already. This is where all the handy documentation can be -found. -- `examples` - This contains a few examples of using Unity. -- `extras` - These are optional add ons to Unity that are not part of the core -project. If you've reached us through James Grenning's book, you're going to -want to look here. -- `test` - This is how Unity and its scripts are all tested. If you're just using -Unity, you'll likely never need to go in here. If you are the lucky team member -who gets to port Unity to a new toolchain, this is a good place to verify -everything is configured properly. -- `auto` - Here you will find helpful Ruby scripts for simplifying your test -workflow. They are purely optional and are not required to make use of Unity. +If you have obtained Unity through Github or something similar, you might be surprised by just how much stuff you suddenly have staring you in the face. +Don't worry, Unity itself is very small. +The rest of it is just there to make your life easier. +You can ignore it or use it at your convenience. +Here's an overview of everything in the project. +- `src` - This is the code you care about! This folder contains a C file and two header files. + These three files _are_ Unity. +- `docs` - You're reading this document, so it's possible you have found your way into this folder already. + This is where all the handy documentation can be found. +- `examples` - This contains a few examples of using Unity. +- `extras` - These are optional add ons to Unity that are not part of the core project. + If you've reached us through James Grenning's book, you're going to want to look here. +- `test` - This is how Unity and its scripts are all tested. + If you're just using Unity, you'll likely never need to go in here. + If you are the lucky team member who gets to port Unity to a new toolchain, this is a good place to verify everything is configured properly. +- `auto` - Here you will find helpful Ruby scripts for simplifying your test workflow. + They are purely optional and are not required to make use of Unity. ## How to Create A Test File -Test files are C files. Most often you will create a single test file for each C -module that you want to test. The test file should include unity.h and the -header for your C module to be tested. +Test files are C files. +Most often you will create a single test file for each C module that you want to test. +The test file should include unity.h and the header for your C module to be tested. -Next, a test file will include a `setUp()` and `tearDown()` function. The setUp -function can contain anything you would like to run before each test. The -tearDown function can contain anything you would like to run after each test. -Both functions accept no arguments and return nothing. You may leave either or -both of these blank if you have no need for them. +Next, a test file will include a `setUp()` and `tearDown()` function. +The setUp function can contain anything you would like to run before each test. +The tearDown function can contain anything you would like to run after each test. +Both functions accept no arguments and return nothing. +You may leave either or both of these blank if you have no need for them. -If you're using Ceedling or the test runner generator script, you may leave these off -completely. Not sure? Give it a try. If you compiler complains that it can't -find setUp or tearDown when it links, you'll know you need to at least include -an empty function for these. +If you're using Ceedling or the test runner generator script, you may leave these off completely. +Not sure? +Give it a try. +If your compiler complains that it can't find setUp or tearDown when it links, you'll know you need to at least include an empty function for these. -The majority of the file will be a series of test functions. Test functions -follow the convention of starting with the word "test_" or "spec_". You don't HAVE -to name them this way, but it makes it clear what functions are tests for other -developers. Also, the automated scripts that come with Unity or Ceedling will default -to looking for test functions to be prefixed this way. Test functions take no arguments -and return nothing. All test accounting is handled internally in Unity. +The majority of the file will be a series of test functions. +Test functions follow the convention of starting with the word "test_" or "spec_". +You don't HAVE to name them this way, but it makes it clear what functions are tests for other developers. +Also, the automated scripts that come with Unity or Ceedling will default to looking for test functions to be prefixed this way. +Test functions take no arguments and return nothing. All test accounting is handled internally in Unity. Finally, at the bottom of your test file, you will write a `main()` function. -This function will call `UNITY_BEGIN()`, then `RUN_TEST` for each test, and -finally `UNITY_END()`.This is what will actually trigger each of those test -functions to run, so it is important that each function gets its own `RUN_TEST` -call. - -Remembering to add each test to the main function can get to be tedious. If you -enjoy using helper scripts in your build process, you might consider making use -of our handy [generate_test_runner.rb](../auto/generate_test_runner.rb) script. -This will create the main function and all the calls for you, assuming that you -have followed the suggested naming conventions. In this case, there is no need -for you to include the main function in your test file at all. +This function will call `UNITY_BEGIN()`, then `RUN_TEST` for each test, and finally `UNITY_END()`. +This is what will actually trigger each of those test functions to run, so it is important that each function gets its own `RUN_TEST` call. + +Remembering to add each test to the main function can get to be tedious. +If you enjoy using helper scripts in your build process, you might consider making use of our handy [generate_test_runner.rb][] script. +This will create the main function and all the calls for you, assuming that you have followed the suggested naming conventions. +In this case, there is no need for you to include the main function in your test file at all. When you're done, your test file will look something like this: @@ -156,24 +137,29 @@ For that sort of thing, you're going to want to look at the configuration guide. This should be enough to get you going, though. ### Running Test Functions -When writing your own `main()` functions, for a test-runner. There are two ways -to execute the test. + +When writing your own `main()` functions, for a test-runner. +There are two ways to execute the test. The classic variant + ``` c RUN_TEST(func, linenum) ``` -or its simpler replacement that starts at the beginning of the function. + +Or its simpler replacement that starts at the beginning of the function. + ``` c RUN_TEST(func) ``` -These macros perform the necessary setup before the test is called and -handles cleanup and result tabulation afterwards. + +These macros perform the necessary setup before the test is called and handles clean-up and result tabulation afterwards. ### Ignoring Test Functions + There are times when a test is incomplete or not valid for some reason. -At these times, TEST_IGNORE can be called. Control will immediately be -returned to the caller of the test, and no failures will be returned. +At these times, TEST_IGNORE can be called. +Control will immediately be returned to the caller of the test, and no failures will be returned. This is useful when your test runners are automatically generated. ``` c @@ -182,25 +168,35 @@ TEST_IGNORE() Ignore this test and return immediately -``` c +```c TEST_IGNORE_MESSAGE (message) ``` -Ignore this test and return immediately. Output a message stating why the test was ignored. +Ignore this test and return immediately. +Output a message stating why the test was ignored. ### Aborting Tests -There are times when a test will contain an infinite loop on error conditions, or there may be reason to escape from the test early without executing the rest of the test. A pair of macros support this functionality in Unity. The first `TEST_PROTECT` sets up the feature, and handles emergency abort cases. `TEST_ABORT` can then be used at any time within the tests to return to the last `TEST_PROTECT` call. +There are times when a test will contain an infinite loop on error conditions, or there may be reason to escape from the test early without executing the rest of the test. +A pair of macros support this functionality in Unity. +The first `TEST_PROTECT` sets up the feature, and handles emergency abort cases. +`TEST_ABORT` can then be used at any time within the tests to return to the last `TEST_PROTECT` call. + +```c TEST_PROTECT() +``` Setup and Catch macro +```c TEST_ABORT() +``` Abort Test macro Example: +```c main() { if (TEST_PROTECT()) @@ -208,44 +204,39 @@ Example: MyTest(); } } +``` If MyTest calls `TEST_ABORT`, program control will immediately return to `TEST_PROTECT` with a return value of zero. - - ## How to Build and Run A Test File -This is the single biggest challenge to picking up a new unit testing framework, -at least in a language like C or C++. These languages are REALLY good at getting -you "close to the metal" (why is the phrase metal? Wouldn't it be more accurate -to say "close to the silicon"?). While this feature is usually a good thing, it -can make testing more challenging. +This is the single biggest challenge to picking up a new unit testing framework, at least in a language like C or C++. +These languages are REALLY good at getting you "close to the metal" (why is the phrase metal? Wouldn't it be more accurate to say "close to the silicon"?). +While this feature is usually a good thing, it can make testing more challenging. -You have two really good options for toolchains. Depending on where you're -coming from, it might surprise you that neither of these options is running the -unit tests on your hardware. +You have two really good options for toolchains. +Depending on where you're coming from, it might surprise you that neither of these options is running the unit tests on your hardware. There are many reasons for this, but here's a short version: + - On hardware, you have too many constraints (processing power, memory, etc), - On hardware, you don't have complete control over all registers, - On hardware, unit testing is more challenging, - Unit testing isn't System testing. Keep them separate. -Instead of running your tests on your actual hardware, most developers choose to -develop them as native applications (using gcc or MSVC for example) or as -applications running on a simulator. Either is a good option. Native apps have -the advantages of being faster and easier to set up. Simulator apps have the -advantage of working with the same compiler as your target application. The -options for configuring these are discussed in the configuration guide. +Instead of running your tests on your actual hardware, most developers choose to develop them as native applications (using gcc or MSVC for example) or as applications running on a simulator. +Either is a good option. +Native apps have the advantages of being faster and easier to set up. +Simulator apps have the advantage of working with the same compiler as your target application. +The options for configuring these are discussed in the configuration guide. -To get either to work, you might need to make a few changes to the file -containing your register set (discussed later). +To get either to work, you might need to make a few changes to the file containing your register set (discussed later). -In either case, a test is built by linking unity, the test file, and the C -file(s) being tested. These files create an executable which can be run as the -test set for that module. Then, this process is repeated for the next test file. -This flexibility of separating tests into individual executables allows us to -much more thoroughly unit test our system and it keeps all the test code out of -our final release! +In either case, a test is built by linking unity, the test file, and the C file(s) being tested. +These files create an executable which can be run as the test set for that module. +Then, this process is repeated for the next test file. +This flexibility of separating tests into individual executables allows us to much more thoroughly unit test our system and it keeps all the test code out of our final release! +*Find The Latest of This And More at [ThrowTheSwitch.org][]* -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +[generate_test_runner.rb]: ../auto/generate_test_runner.rb +[ThrowTheSwitch.org]: https://throwtheswitch.org diff --git a/docs/UnityHelperScriptsGuide.md b/docs/UnityHelperScriptsGuide.md index 46c9d74df..01db2752c 100644 --- a/docs/UnityHelperScriptsGuide.md +++ b/docs/UnityHelperScriptsGuide.md @@ -3,30 +3,25 @@ ## With a Little Help From Our Friends Sometimes what it takes to be a really efficient C programmer is a little non-C. -The Unity project includes a couple of Ruby scripts for making your life just a tad -easier. They are completely optional. If you choose to use them, you'll need a -copy of Ruby, of course. Just install whatever the latest version is, and it is -likely to work. You can find Ruby at [ruby-lang.org](https://ruby-labg.org/). - +The Unity project includes a couple of Ruby scripts for making your life just a tad easier. +They are completely optional. +If you choose to use them, you'll need a copy of Ruby, of course. +Just install whatever the latest version is, and it is likely to work. You can find Ruby at [ruby-lang.org][]. ### `generate_test_runner.rb` -Are you tired of creating your own `main` function in your test file? Do you -keep forgetting to add a `RUN_TEST` call when you add a new test case to your -suite? Do you want to use CMock or other fancy add-ons but don't want to figure -out how to create your own `RUN_TEST` macro? +Are you tired of creating your own `main` function in your test file? +Do you keep forgetting to add a `RUN_TEST` call when you add a new test case to your suite? +Do you want to use CMock or other fancy add-ons but don't want to figure out how to create your own `RUN_TEST` macro? Well then we have the perfect script for you! -The `generate_test_runner` script processes a given test file and automatically -creates a separate test runner file that includes ?main?to execute the test -cases within the scanned test file. All you do then is add the generated runner -to your list of files to be compiled and linked, and presto you're done! +The `generate_test_runner` script processes a given test file and automatically creates a separate test runner file that includes ?main?to execute the test cases within the scanned test file. +All you do then is add the generated runner to your list of files to be compiled and linked, and presto you're done! -This script searches your test file for void function signatures having a -function name beginning with "test" or "spec". It treats each of these -functions as a test case and builds up a test suite of them. For example, the -following includes three test cases: +This script searches your test file for void function signatures having a function name beginning with "test" or "spec". +It treats each of these functions as a test case and builds up a test suite of them. +For example, the following includes three test cases: ```C void testVerifyThatUnityIsAwesomeAndWillMakeYourLifeEasier(void) @@ -41,32 +36,30 @@ void spec_Function_should_DoWhatItIsSupposedToDo(void) { } ``` -You can run this script a couple of ways. The first is from the command line: +You can run this script a couple of ways. +The first is from the command line: ```Shell ruby generate_test_runner.rb TestFile.c NameOfRunner.c ``` -Alternatively, if you include only the test file parameter, the script will copy -the name of the test file and automatically append `_Runner` to the name of the -generated file. The example immediately below will create TestFile_Runner.c. +Alternatively, if you include only the test file parameter, the script will copy the name of the test file and automatically append `_Runner` to the name of the generated file. +The example immediately below will create TestFile_Runner.c. ```Shell ruby generate_test_runner.rb TestFile.c ``` -You can also add a [YAML](http://www.yaml.org/) file to configure extra options. -Conveniently, this YAML file is of the same format as that used by Unity and -CMock. So if you are using YAML files already, you can simply pass the very same -file into the generator script. +You can also add a [YAML][] file to configure extra options. +Conveniently, this YAML file is of the same format as that used by Unity and CMock. +So if you are using YAML files already, you can simply pass the very same file into the generator script. ```Shell ruby generate_test_runner.rb TestFile.c my_config.yml ``` -The contents of the YAML file `my_config.yml` could look something like the -example below. If you're wondering what some of these options do, you're going -to love the next section of this document. +The contents of the YAML file `my_config.yml` could look something like the example below. +If you're wondering what some of these options do, you're going to love the next section of this document. ```YAML :unity: @@ -74,23 +67,20 @@ to love the next section of this document. - stdio.h - microdefs.h :cexception: 1 - :suit_setup: "blah = malloc(1024);" + :suite_setup: "blah = malloc(1024);" :suite_teardown: "free(blah);" ``` -If you would like to force your generated test runner to include one or more -header files, you can just include those at the command line too. Just make sure -these are _after_ the YAML file, if you are using one: +If you would like to force your generated test runner to include one or more header files, you can just include those at the command line too. +Just make sure these are _after_ the YAML file, if you are using one: ```Shell ruby generate_test_runner.rb TestFile.c my_config.yml extras.h ``` -Another option, particularly if you are already using Ruby to orchestrate your -builds - or more likely the Ruby-based build tool Rake - is requiring this -script directly. Anything that you would have specified in a YAML file can be -passed to the script as part of a hash. Let's push the exact same requirement -set as we did above but this time through Ruby code directly: +Another option, particularly if you are already using Ruby to orchestrate your builds - or more likely the Ruby-based build tool Rake - is requiring this script directly. +Anything that you would have specified in a YAML file can be passed to the script as part of a hash. +Let's push the exact same requirement set as we did above but this time through Ruby code directly: ```Ruby require "generate_test_runner.rb" @@ -103,9 +93,8 @@ options = { UnityTestRunnerGenerator.new.run(testfile, runner_name, options) ``` -If you have multiple files to generate in a build script (such as a Rakefile), -you might want to instantiate a generator object with your options and call it -to generate each runner afterwards. Like thus: +If you have multiple files to generate in a build script (such as a Rakefile), you might want to instantiate a generator object with your options and call it to generate each runner afterwards. +Like thus: ```Ruby gen = UnityTestRunnerGenerator.new(options) @@ -114,70 +103,65 @@ test_files.each do |f| end ``` -#### Options accepted by generate_test_runner.rb: - -The following options are available when executing `generate_test_runner`. You -may pass these as a Ruby hash directly or specify them in a YAML file, both of -which are described above. In the `examples` directory, Example 3's Rakefile -demonstrates using a Ruby hash. +#### Options accepted by generate_test_runner.rb +The following options are available when executing `generate_test_runner`. +You may pass these as a Ruby hash directly or specify them in a YAML file, both of which are described above. +In the `examples` directory, Example 3's Rakefile demonstrates using a Ruby hash. ##### `:includes` -This option specifies an array of file names to be `#include`'d at the top of -your runner C file. You might use it to reference custom types or anything else -universally needed in your generated runners. +This option specifies an array of file names to be `#include`'d at the top of your runner C file. +You might use it to reference custom types or anything else universally needed in your generated runners. +##### `:defines` + +This option specifies an array of definitions to be `#define`'d at the top of your runner C file. +Each definition will be wrapped in an `#ifndef`. ##### `:suite_setup` Define this option with C code to be executed _before any_ test cases are run. -Alternatively, if your C compiler supports weak symbols, you can leave this -option unset and instead provide a `void suiteSetUp(void)` function in your test -suite. The linker will look for this symbol and fall back to a Unity-provided -stub if it is not found. +Alternatively, if your C compiler supports weak symbols, you can leave this option unset and instead provide a `void suiteSetUp(void)` function in your test suite. +The linker will look for this symbol and fall back to a Unity-provided stub if it is not found. +This option can also be specified at the command prompt as `--suite_setup=""` ##### `:suite_teardown` -Define this option with C code to be executed _after all_ test cases have -finished. An integer variable `num_failures` is available for diagnostics. -The code should end with a `return` statement; the value returned will become -the exit code of `main`. You can normally just return `num_failures`. +Define this option with C code to be executed _after all_ test cases have finished. +An integer variable `num_failures` is available for diagnostics. +The code should end with a `return` statement; the value returned will become the exit code of `main`. +You can normally just return `num_failures`. -Alternatively, if your C compiler supports weak symbols, you can leave this -option unset and instead provide a `int suiteTearDown(int num_failures)` -function in your test suite. The linker will look for this symbol and fall -back to a Unity-provided stub if it is not found. +Alternatively, if your C compiler supports weak symbols, you can leave this option unset and instead provide a `int suiteTearDown(int num_failures)` function in your test suite. +The linker will look for this symbol and fall back to a Unity-provided stub if it is not found. +This option can also be specified at the command prompt as `--suite_teardown=""` ##### `:enforce_strict_ordering` -This option should be defined if you have the strict order feature enabled in -CMock (see CMock documentation). This generates extra variables required for -everything to run smoothly. If you provide the same YAML to the generator as -used in CMock's configuration, you've already configured the generator properly. - +This option should be defined if you have the strict order feature enabled in CMock (see CMock documentation). +This generates extra variables required for everything to run smoothly. +If you provide the same YAML to the generator as used in CMock's configuration, you've already configured the generator properly. ##### `:externc` -This option should be defined if you are mixing C and CPP and want your test -runners to automatically include extern "C" support when they are generated. +This option should be defined if you are mixing C and CPP and want your test runners to automatically include extern "C" support when they are generated. + +This option can also be specified at the command prompt as `--externc` ##### `:mock_prefix` and `:mock_suffix` -Unity automatically generates calls to Init, Verify and Destroy for every file -included in the main test file that starts with the given mock prefix and ends -with the given mock suffix, file extension not included. By default, Unity -assumes a `Mock` prefix and no suffix. +Unity automatically generates calls to Init, Verify and Destroy for every file included in the main test file that starts with the given mock prefix and ends with the given mock suffix, file extension not included. +By default, Unity assumes a `Mock` prefix and no suffix. ##### `:plugins` -This option specifies an array of plugins to be used (of course, the array can -contain only a single plugin). This is your opportunity to enable support for -CException support, which will add a check for unhandled exceptions in each -test, reporting a failure if one is detected. To enable this feature using Ruby: +This option specifies an array of plugins to be used (of course, the array can contain only a single plugin). +This is your opportunity to enable support for CException support, which will add a check for unhandled exceptions in each test, reporting a failure if one is detected. +To enable this feature using Ruby: ```Ruby :plugins => [ :cexception ] @@ -190,57 +174,324 @@ Or as a yaml file: -:cexception ``` -If you are using CMock, it is very likely that you are already passing an array -of plugins to CMock. You can just use the same array here. This script will just -ignore the plugins that don't require additional support. +If you are using CMock, it is very likely that you are already passing an array of plugins to CMock. +You can just use the same array here. + +This script will just ignore the plugins that don't require additional support. + +This option can also be specified at the command prompt as `--cexception` ##### `:include_extensions` This option specifies the pattern for matching acceptable header file extensions. -By default it will accept hpp, hh, H, and h files. If you need a different combination -of files to search, update this from the default `'(?:hpp|hh|H|h)'`. +By default it will accept hpp, hh, H, and h files. +If you need a different combination of files to search, update this from the default `'(?:hpp|hh|H|h)'`. ##### `:source_extensions` This option specifies the pattern for matching acceptable source file extensions. -By default it will accept cpp, cc, C, c, and ino files. If you need a different combination -of files to search, update this from the default `'(?:cpp|cc|ino|C|c)'`. +By default it will accept cpp, cc, C, c, and ino files. +If you need a different combination of files to search, update this from the default `'(?:cpp|cc|ino|C|c)'`. + +##### `:use_param_tests` + +This option enables parameterized test usage. +That tests accepts arguments from `TEST_CASE` and `TEST_RANGE` macros, +that are located above current test definition. +By default, Unity assumes, that parameterized tests are disabled. + +Few usage examples can be found in `/test/tests/test_unity_parameterized.c` file. + +You should define `UNITY_SUPPORT_TEST_CASES` macro for tests success compiling, +if you enable current option. + +You can see list of supported macros list in the +[Parameterized tests provided macros](#parameterized-tests-provided-macros) +section that follows. + +This option can also be specified at the command prompt as `--use_param_tests=1` + +##### `:cmdline_args` + +When set to `true`, the generated test runner can accept a number of +options to modify how the test(s) are run. + +Ensure Unity is compiled with `UNITY_USE_COMMAND_LINE_ARGS` defined or else +the required functions will not exist. + +These are the available options: + +| Option | Description | +| --------- | ------------------------------------------------- | +| `-l` | List all tests and exit | +| `-f NAME` | Filter to run only tests whose name includes NAME | +| `-n NAME` | (deprecated) alias of -f | +| `-h` | show the Help menu that lists these options | +| `-q` | Quiet/decrease verbosity | +| `-v` | increase Verbosity | +| `-x NAME` | eXclude tests whose name includes NAME | + +##### `:setup_name` + +Override the default test `setUp` function name. + +This option can also be specified at the command prompt as `--setup_name=""` + +##### `:teardown_name` + +Override the default test `tearDown` function name. + +This option can also be specified at the command prompt as `--teardown_name=""` + +##### `:test_reset_name` + +Override the default test `resetTest` function name. + +This option can also be specified at the command prompt as `--test_reset_name=""` + +##### `:test_verify_name` + +Override the default test `verifyTest` function name. + +This option can also be specified at the command prompt as `--test_verify_name=""` + +##### `:main_name` + +Override the test's `main()` function name (from `main` to whatever is specified). +The sentinel value `:auto` will use the test's filename with the `.c` extension removed prefixed +with `main_` as the "main" function. + +To clarify, if `:main_name == :auto` and the test filename is "test_my_project.c", then the +generated function name will be `main_test_my_project(int argc, char** argv)`. + +This option can also be specified at the command prompt as `--main_name=""` + +##### `main_export_decl` + +Provide any `cdecl` for the `main()` test function. Is empty by default. + +##### `:omit_begin_end` + +If `true`, the `UnityBegin` and `UnityEnd` function will not be called for +Unity test state setup and cleanup. + +This option can also be specified at the command prompt as `--omit_begin_end` + +#### Parameterized tests provided macros + +Unity provides support for few param tests generators, that can be combined +with each other. You must define test function as usual C function with usual +C arguments, and test generator will pass what you tell as a list of arguments. + +Let's show how all of them works on the following test function definitions: + +```C +/* Place your test generators here, usually one generator per one or few lines */ +void test_demoParamFunction(int a, int b, int c) +{ + TEST_ASSERT_GREATER_THAN_INT(a + b, c); +} +``` + +##### `TEST_CASE` + +Test case is a basic generator, that can be used for param testing. +One call of that macro will generate only one call for test function. +It can be used with different args, such as numbers, enums, strings, +global variables, another preprocessor defines. +If we use replace comment before test function with the following code: + +```C +TEST_CASE(1, 2, 5) +TEST_CASE(10, 7, 20) +``` + +script will generate 2 test calls: + +```C +test_demoParamFunction(1, 2, 5); +test_demoParamFunction(10, 7, 20); +``` + +That calls will be wrapped with `setUp`, `tearDown` and other +usual Unity calls, as for independent unit tests. +The following output can be generated after test executable startup: + +```Log +tests/test_unity_parameterizedDemo.c:14:test_demoParamFunction(1, 2, 5):PASS +tests/test_unity_parameterizedDemo.c:14:test_demoParamFunction(10, 7, 20):PASS +``` + +##### `TEST_RANGE` + +Test range is an advanced generator. It single call can be converted to zero, +one or few `TEST_CASE` equivalent commands. + +That generator can be used for creating numeric ranges in decimal representation +only: integers & floating point numbers. It uses few formats for every parameter: + +1. `[start, stop, step]` is stop-inclusive format +2. `` is stop-exclusive formats + +Format providers 1 and 2 accept only three arguments: + +* `start` is start number +* `stop` is end number (can or cannot exists in result sequence for format 1, +will be always skipped for format 2) +* `step` is incrementing step: can be either positive or negative value. + +Let's use our `test_demoParamFunction` test for checking, what ranges +will be generated for our single `TEST_RANGE` row: + +```C +TEST_RANGE([3, 4, 1], [10, 5, -2], <30, 31, 1>) +``` + +Tests execution output will be similar to that text: + +```Log +tests/test_unity_parameterizedDemo.c:14:test_demoParamFunction(3, 10, 30):PASS +tests/test_unity_parameterizedDemo.c:14:test_demoParamFunction(3, 8, 30):PASS +tests/test_unity_parameterizedDemo.c:14:test_demoParamFunction(3, 6, 30):PASS +tests/test_unity_parameterizedDemo.c:14:test_demoParamFunction(4, 10, 30):PASS +tests/test_unity_parameterizedDemo.c:14:test_demoParamFunction(4, 8, 30):PASS +tests/test_unity_parameterizedDemo.c:14:test_demoParamFunction(4, 6, 30):PASS +``` + +As we can see: + +| Parameter | Format | Possible values | Total of values | Format number | +|---|---|---|---|---| +| `a` | `[3, 4, 1]` | `3`, `4` | 2 | Format 1 | +| `b` | `[10, 5, -2]` | `10`, `8`, `6` | 3 | Format 1, negative step, end number is not included | +| `c` | `<30, 31, 1>` | `30` | 1 | Format 2 | + +_Note_, that format 2 also supports negative step. + +We totally have 2 * 3 * 1 = 6 equal test cases, that can be written as following: + +```C +TEST_CASE(3, 10, 30) +TEST_CASE(3, 8, 30) +TEST_CASE(3, 6, 30) +TEST_CASE(4, 10, 30) +TEST_CASE(4, 8, 30) +TEST_CASE(4, 6, 30) +``` + +##### `TEST_MATRIX` + +Test matix is an advanced generator. It single call can be converted to zero, +one or few `TEST_CASE` equivalent commands. + +That generator will create tests for all cobinations of the provided list. Each argument has to be given as a list of one or more elements in the format `[, , ..., , ]`. + +All parameters supported by the `TEST_CASE` is supported as arguments: +- Numbers incl type specifiers e.g. `<1>`, `<1u>`, `<1l>`, `<2.3>`, or `<2.3f>` +- Strings incl string concatianion e.g. `<"string">`, or `<"partial" "string">` +- Chars e.g. `<'c'>` +- Enums e.g. `` +- Elements of arrays e.g. `` + +Let's use our `test_demoParamFunction` test for checking, what ranges +will be generated for our single `TEST_RANGE` row: + +```C +TEST_MATRIX([3, 4, 7], [10, 8, 2, 1],[30u, 20.0f]) +``` + +Tests execution output will be similar to that text: + +```Log +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(3, 10, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(3, 10, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(3, 8, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(3, 8, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(3, 2, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(3, 2, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(3, 1, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(3, 1, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(4, 10, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(4, 10, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(4, 8, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(4, 8, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(4, 2, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(4, 2, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(4, 1, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(4, 1, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(7, 10, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(7, 10, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(7, 8, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(7, 8, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(7, 2, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(7, 2, 20.0f):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(7, 1, 30u):PASS +tests/test_unity_parameterizedDemo.c:18:test_demoParamFunction(7, 1, 20.0f):PASS +``` + +As we can see: + +| Parameter | Format | Count of values | +|---|---|---| +| `a` | `[3, 4, 7]` | 2 | +| `b` | `[10, 8, 2, 1]` | 4 | +| `c` | `[30u, 20.0f]` | 2 | + +We totally have 2 * 4 * 2 = 16 equal test cases, that can be written as following: + +```C +TEST_CASE(3, 10, 30u) +TEST_CASE(3, 10, 20.0f) +TEST_CASE(3, 8, 30u) +TEST_CASE(3, 8, 20.0f) +TEST_CASE(3, 2, 30u) +TEST_CASE(3, 2, 20.0f) +TEST_CASE(3, 1, 30u) +TEST_CASE(3, 1, 20.0f) +TEST_CASE(4, 10, 30u) +TEST_CASE(4, 10, 20.0f) +TEST_CASE(4, 8, 30u) +TEST_CASE(4, 8, 20.0f) +TEST_CASE(4, 2, 30u) +TEST_CASE(4, 2, 20.0f) +TEST_CASE(4, 1, 30u) +TEST_CASE(4, 1, 20.0f) +TEST_CASE(7, 10, 30u) +TEST_CASE(7, 10, 20.0f) +TEST_CASE(7, 8, 30u) +TEST_CASE(7, 8, 20.0f) +TEST_CASE(7, 2, 30u) +TEST_CASE(7, 2, 20.0f) +TEST_CASE(7, 1, 30u) +TEST_CASE(7, 1, 20.0f) +``` ### `unity_test_summary.rb` -A Unity test file contains one or more test case functions. Each test case can -pass, fail, or be ignored. Each test file is run individually producing results -for its collection of test cases. A given project will almost certainly be -composed of multiple test files. Therefore, the suite of tests is comprised of -one or more test cases spread across one or more test files. This script -aggregates individual test file results to generate a summary of all executed -test cases. The output includes how many tests were run, how many were ignored, -and how many failed. In addition, the output includes a listing of which -specific tests were ignored and failed. A good example of the breadth and -details of these results can be found in the `examples` directory. Intentionally -ignored and failing tests in this project generate corresponding entries in the -summary report. - -If you're interested in other (prettier?) output formats, check into the -Ceedling build tool project (ceedling.sourceforge.net) that works with Unity and -CMock and supports xunit-style xml as well as other goodies. - -This script assumes the existence of files ending with the extensions -`.testpass` and `.testfail`.The contents of these files includes the test -results summary corresponding to each test file executed with the extension set -according to the presence or absence of failures for that test file. The script -searches a specified path for these files, opens each one it finds, parses the -results, and aggregates and prints a summary. Calling it from the command line -looks like this: +A Unity test file contains one or more test case functions. +Each test case can pass, fail, or be ignored. +Each test file is run individually producing results for its collection of test cases. +A given project will almost certainly be composed of multiple test files. +Therefore, the suite of tests is comprised of one or more test cases spread across one or more test files. +This script aggregates individual test file results to generate a summary of all executed test cases. +The output includes how many tests were run, how many were ignored, and how many failed. In addition, the output includes a listing of which specific tests were ignored and failed. +A good example of the breadth and details of these results can be found in the `examples` directory. +Intentionally ignored and failing tests in this project generate corresponding entries in the summary report. + +If you're interested in other (prettier?) output formats, check into the [Ceedling][] build tool project that works with Unity and CMock and supports xunit-style xml as well as other goodies. + +This script assumes the existence of files ending with the extensions `.testpass` and `.testfail`. +The contents of these files includes the test results summary corresponding to each test file executed with the extension set according to the presence or absence of failures for that test file. +The script searches a specified path for these files, opens each one it finds, parses the results, and aggregates and prints a summary. +Calling it from the command line looks like this: ```Shell ruby unity_test_summary.rb build/test/ ``` -You can optionally specify a root path as well. This is really helpful when you -are using relative paths in your tools' setup, but you want to pull the summary -into an IDE like Eclipse for clickable shortcuts. +You can optionally specify a root path as well. +This is really helpful when you are using relative paths in your tools' setup, but you want to pull the summary into an IDE like Eclipse for clickable shortcuts. ```Shell ruby unity_test_summary.rb build/test/ ~/projects/myproject/ @@ -274,5 +525,9 @@ OVERALL UNITY TEST SUMMARY How convenient is that? +*Find The Latest of This And More at [ThrowTheSwitch.org][]* -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +[ruby-lang.org]: https://ruby-lang.org/ +[YAML]: http://www.yaml.org/ +[Ceedling]: http://www.throwtheswitch.org/ceedling +[ThrowTheSwitch.org]: https://throwtheswitch.org diff --git a/docs/UnityKnownIssues.md b/docs/UnityKnownIssues.md new file mode 100644 index 000000000..344931973 --- /dev/null +++ b/docs/UnityKnownIssues.md @@ -0,0 +1,13 @@ +# Unity Test - Known Issues + +## A Note + +This project will do its best to keep track of significant bugs that might effect your usage of this +project and its supporting scripts. A more detailed and up-to-date list for cutting edge Unity can +be found on our Github repository. + +## Issues + + - No built-in validation of no-return functions + - Incomplete support for Printf-style formatting + - Incomplete support for VarArgs diff --git a/examples/example_1/meson.build b/examples/example_1/meson.build new file mode 100644 index 000000000..645eeb99c --- /dev/null +++ b/examples/example_1/meson.build @@ -0,0 +1,48 @@ +project('Unity example', 'c', + license: 'MIT', + default_options: [ + 'c_std=c99', + 'warning_level=3', + ], + meson_version: '>= 0.49.0' +) + +unity_subproject = subproject('unity') +unity_dependency = unity_subproject.get_variable('unity_dep') +unity_gen_runner = unity_subproject.get_variable('gen_test_runner') + +src1 = files([ + 'src' / 'ProductionCode.c', + 'test' / 'TestProductionCode.c', +]) + +src2 = files([ + 'src' / 'ProductionCode2.c', + 'test' / 'TestProductionCode2.c', +]) + +inc = include_directories('src') + +test1 = executable('test1', + sources: [ + src1, + unity_gen_runner.process('test' / 'TestProductionCode.c') + ], + include_directories: [ inc ], + dependencies: [ unity_dependency ], +) + +test('test1', test1, + should_fail: true) + +test2 = executable('test2', + sources: [ + src2, + unity_gen_runner.process('test' / 'TestProductionCode2.c') + ], + include_directories: [ inc ], + dependencies: [ unity_dependency ], +) + +test('test2', test2) + diff --git a/examples/example_1/readme.txt b/examples/example_1/readme.txt index dfed81502..ddddd369e 100644 --- a/examples/example_1/readme.txt +++ b/examples/example_1/readme.txt @@ -2,4 +2,11 @@ Example 1 ========= Close to the simplest possible example of Unity, using only basic features. -Run make to build & run the example tests. \ No newline at end of file + +Build and run with Make +--- +Just run `make`. + +Build and run with Meson +--- +Run `meson setup build` to create the build directory, and then `meson test -C build` to build and run the tests. diff --git a/examples/example_1/subprojects/unity.wrap b/examples/example_1/subprojects/unity.wrap new file mode 100644 index 000000000..6df241bdd --- /dev/null +++ b/examples/example_1/subprojects/unity.wrap @@ -0,0 +1,3 @@ +[wrap-git] +url = https://github.com/ThrowTheSwitch/Unity.git +revision = head diff --git a/examples/example_3/rakefile_helper.rb b/examples/example_3/rakefile_helper.rb index 64d20c95f..cbc4549f1 100644 --- a/examples/example_3/rakefile_helper.rb +++ b/examples/example_3/rakefile_helper.rb @@ -1,18 +1,23 @@ -require 'yaml' +# ========================================== +# Unity Project - A Test Framework for C +# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams +# [Released under MIT License. Please refer to license.txt for details] +# ========================================== + require 'fileutils' require_relative '../../auto/unity_test_summary' require_relative '../../auto/generate_test_runner' require_relative '../../auto/colour_reporter' - +require_relative '../../auto/yaml_helper' C_EXTENSION = '.c'.freeze def load_configuration(config_file) $cfg_file = config_file - $cfg = YAML.load(File.read($cfg_file)) + $cfg = YamlHelper.load_file($cfg_file) end 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 def configure_toolchain(config_file = DEFAULT_CONFIG_FILE) @@ -22,7 +27,7 @@ def configure_toolchain(config_file = DEFAULT_CONFIG_FILE) end def unit_test_files - path = $cfg['compiler']['unit_tests_path'] + 'Test*' + C_EXTENSION + path = "#{$cfg['compiler']['unit_tests_path']}Test*#{C_EXTENSION}" path.tr!('\\', '/') FileList.new(path) end @@ -37,7 +42,7 @@ def extract_headers(filename) includes = [] lines = File.readlines(filename) lines.each do |line| - m = line.match(/^\s*#include\s+\"\s*(.+\.[hH])\s*\"/) + m = line.match(/^\s*#include\s+"\s*(.+\.[hH])\s*"/) includes << m[1] unless m.nil? end includes @@ -52,12 +57,11 @@ def find_source_file(header, paths) end def tackit(strings) - result = if strings.is_a?(Array) - "\"#{strings.join}\"" - else - strings - end - result + if strings.is_a?(Array) + "\"#{strings.join}\"" + else + strings + end end def squash(prefix, items) @@ -75,7 +79,7 @@ def build_compiler_fields end options = squash('', $cfg['compiler']['options']) 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) { command: command, defines: defines, options: options, includes: includes } end @@ -100,18 +104,18 @@ def build_linker_fields '' else squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items']) - end.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR) + end.gsub(/\\ /, ' ').gsub(/\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR) { command: command, options: options, includes: includes } end def link_it(exe_name, obj_list) linker = build_linker_fields - cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " + - (obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj} " }).join + - $cfg['linker']['bin_files']['prefix'] + ' ' + - $cfg['linker']['bin_files']['destination'] + - exe_name + $cfg['linker']['bin_files']['extension'] + cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]}" + cmd_str += " #{(obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj}" }).join(' ')}" + cmd_str += " #{$cfg['linker']['bin_files']['prefix']} " + cmd_str += $cfg['linker']['bin_files']['destination'] + cmd_str += exe_name + $cfg['linker']['bin_files']['extension'] execute(cmd_str) end @@ -121,7 +125,7 @@ def build_simulator_fields command = if $cfg['simulator']['path'].nil? '' else - (tackit($cfg['simulator']['path']) + ' ') + "#{tackit($cfg['simulator']['path'])} " end pre_support = if $cfg['simulator']['pre_support'].nil? '' @@ -184,7 +188,7 @@ def run_tests(test_files) # Build the test runner (generate if configured to do so) test_base = File.basename(test, C_EXTENSION) - runner_name = test_base + '_Runner.c' + runner_name = "#{test_base}_Runner.c" if $cfg['compiler']['runner_path'].nil? runner_path = $cfg['compiler']['build_path'] + runner_name test_gen = UnityTestRunnerGenerator.new($cfg_file) diff --git a/examples/example_4/meson.build b/examples/example_4/meson.build index f06c3fe3a..b1c4e852b 100644 --- a/examples/example_4/meson.build +++ b/examples/example_4/meson.build @@ -4,9 +4,9 @@ # # license: MIT # -project('example-4', 'c') +project('example-4', 'c', meson_version: '>= 0.55.0') -unity_dep = dependency('unity', fallback : ['unity', 'unity_dep']) +unity_dep = dependency('unity') subdir('src') subdir('test') diff --git a/examples/example_4/subprojects/unity.wrap b/examples/example_4/subprojects/unity.wrap index f2e54c84d..8688475d5 100755 --- a/examples/example_4/subprojects/unity.wrap +++ b/examples/example_4/subprojects/unity.wrap @@ -1,4 +1,6 @@ [wrap-git] -directory = unity url = https://github.com/ThrowTheSwitch/Unity.git revision = head + +[provide] +unity = unity_dep diff --git a/examples/example_4/test/test_runners/meson.build b/examples/example_4/test/test_runners/meson.build index f2a43c1b5..1503c5f3e 100644 --- a/examples/example_4/test/test_runners/meson.build +++ b/examples/example_4/test/test_runners/meson.build @@ -5,9 +5,9 @@ # license: MIT # cases = [ - ['TestProductionCode_Runner.c', join_paths('..' ,'TestProductionCode.c' )], + ['TestProductionCode_Runner.c', join_paths('..' ,'TestProductionCode.c' )], ['TestProductionCode2_Runner.c', join_paths('..' ,'TestProductionCode2.c')] ] -test('Running: 01-test-case', executable('01-test-case', cases[0], dependencies: [ a_dep, unity_dep ])) -test('Running: 02-test-case', executable('02-test-case', cases[1], dependencies: [ b_dep, unity_dep ])) +test('01-test-case', executable('01-test-case', cases[0], dependencies: [ a_dep, unity_dep ])) +test('02-test-case', executable('02-test-case', cases[1], dependencies: [ b_dep, unity_dep ])) diff --git a/extras/bdd/readme.md b/extras/bdd/readme.md new file mode 100644 index 000000000..e70358850 --- /dev/null +++ b/extras/bdd/readme.md @@ -0,0 +1,40 @@ +# Unity Project - BDD Feature + +Unity's Behavior-Driven Development (BDD) test feature. It allows developers to structure and describe various phases (Given, When, Then) of a test scenario in a BDD-style format. + +## Introduction + +This project is based on the Unity framework originally created by Mike Karlesky, Mark VanderVoord, and Greg Williams in 2007. The project extends Unity by providing macros to define BDD structures with descriptive elements. Feature added by Michael Gene Brockus (Dreamer). + +## License + +This project is distributed under the MIT License. See the [license.txt](license.txt) file for more information. + +## Usage + +### BDD Macros + +The provided BDD macros allow you to structure your test scenarios in a descriptive manner. These macros are for descriptive purposes only and do not have functional behavior. + +- `GIVEN(description)`: Describes the "Given" phase of a test scenario. +- `WHEN(description)`: Describes the "When" phase of a test scenario. +- `THEN(description)`: Describes the "Then" phase of a test scenario. + +Example usage: + +```c +GIVEN("a valid input") { + // Test setup and context + // ... + + WHEN("the input is processed") { + // Perform the action + // ... + + THEN("the expected outcome occurs") { + // Assert the outcome + // ... + } + } +} +``` diff --git a/extras/bdd/src/unity_bdd.h b/extras/bdd/src/unity_bdd.h new file mode 100644 index 000000000..d91b3f137 --- /dev/null +++ b/extras/bdd/src/unity_bdd.h @@ -0,0 +1,44 @@ +/* Copyright (c) 2023 Michael Gene Brockus (Dreamer) and Contributed to Unity Project + * ========================================== + * Unity Project - A Test Framework for C + * Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams + * [Released under MIT License. Please refer to license.txt for details] + * ========================================== */ + +#ifndef UNITY_BDD_TEST_H_ +#define UNITY_BDD_TEST_H_ + +#ifdef __cplusplus +extern "C" +{ +#endif + +#include + +/** + * @brief Macros for defining a Behavior-Driven Development (BDD) structure with descriptions. + * + * These macros provide a way to structure and describe different phases (Given, When, Then) of a + * test scenario in a BDD-style format. However, they don't have functional behavior by themselves + * and are used for descriptive purposes. + */ +#define GIVEN(description) \ + if (0) { \ + printf("Given %s\n", description); \ + } else + +#define WHEN(description) \ + if (0) { \ + printf("When %s\n", description); \ + } else + +#define THEN(description) \ + if (0) { \ + printf("Then %s\n", description); \ + } else + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/extras/bdd/test/meson.build b/extras/bdd/test/meson.build new file mode 100644 index 000000000..fcdaffff4 --- /dev/null +++ b/extras/bdd/test/meson.build @@ -0,0 +1,9 @@ +project('BDD Tester', 'c') + +# Add Unity as a dependency +unity_dep = dependency('unity') + +# Define your source files +sources = files('test_bdd.c') + +executable('tester', sources, dependencies : unity_dep) diff --git a/extras/bdd/test/test_bdd.c b/extras/bdd/test/test_bdd.c new file mode 100644 index 000000000..4f415858e --- /dev/null +++ b/extras/bdd/test/test_bdd.c @@ -0,0 +1,128 @@ +/* ========================================== + * Unity Project - A Test Framework for C + * Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams + * [Released under MIT License. Please refer to license.txt for details] + * ========================================== */ + +#include "unity.h" +#include "unity_bdd.h" + +void test_bdd_logic_test(void) { + GIVEN("a valid statement is passed") + { + // Set up the context + bool givenExecuted = true; + + WHEN("a statement is true") + { + // Perform the login action + bool whenExecuted = true; + + THEN("we validate everything was worked") + { + // Check the expected outcome + bool thenExecuted = true; + + TEST_ASSERT_TRUE(givenExecuted); + TEST_ASSERT_TRUE(whenExecuted); + TEST_ASSERT_TRUE(thenExecuted); + } + } + } +} // end of case + +void test_bdd_user_account(void) { + GIVEN("a user's account with sufficient balance") + { + // Set up the context + float accountBalance = 500.0; + float withdrawalAmount = 200.0; + + WHEN("the user requests a withdrawal of $200") + { + // Perform the withdrawal action + if (accountBalance >= withdrawalAmount) + { + accountBalance -= withdrawalAmount; + } // end if + THEN("the withdrawal amount should be deducted from the account balance") + { + // Check the expected outcome + + // Simulate the scenario + float compareBalance = 500.0; + TEST_ASSERT_LESS_THAN_FLOAT(accountBalance, compareBalance); + } + } + } +} // end of case + +void test_bdd_empty_cart(void) { + GIVEN("a user with an empty shopping cart") + { + // Set up the context + int cartItemCount = 0; + + WHEN("the user adds a product to the cart") + { + // Perform the action of adding a product + + THEN("the cart item count should increase by 1") + { + // Check the expected outcome + cartItemCount++; + + TEST_ASSERT_EQUAL_INT(cartItemCount, 1); + } + } + } +} // end of case + +void test_bdd_valid_login(void) { + GIVEN("a registered user with valid credentials") + { + // Set up the context + const char* validUsername = "user123"; + const char* validPassword = "pass456"; + + WHEN("the user provides correct username and password") + { + // Perform the action of user login + const char* inputUsername = "user123"; + const char* inputPassword = "pass456"; + + THEN("the login should be successful") + { + // Check the expected outcome + // Simulate login validation + TEST_ASSERT_EQUAL_STRING(inputUsername, validUsername); + TEST_ASSERT_EQUAL_STRING(inputPassword, validPassword); + } + } + + WHEN("the user provides incorrect password") + { + // Perform the action of user login + const char* inputUsername = "user123"; + const char* inputPassword = "wrongpass"; + + THEN("the login should fail with an error message") + { + // Check the expected outcome + // Simulate login validation + TEST_ASSERT_EQUAL_STRING(inputUsername, validUsername); + // TEST_ASSERT_NOT_EQUAL_STRING(inputPassword, validPassword); + } + } + } +} // end of case + +int main(void) +{ + UnityBegin("test_bdd.c"); + RUN_TEST(test_bdd_logic_test); + RUN_TEST(test_bdd_user_account); + RUN_TEST(test_bdd_empty_cart); + RUN_TEST(test_bdd_valid_login); + return UnityEnd(); +} diff --git a/extras/fixture/readme.md b/extras/fixture/readme.md index 2e0c2f06b..e0c9e1b73 100644 --- a/extras/fixture/readme.md +++ b/extras/fixture/readme.md @@ -1,29 +1,26 @@ # Unity Fixtures -This Framework is an optional add-on to Unity. By including unity_framework.h in place of unity.h, -you may now work with Unity in a manner similar to CppUTest. This framework adds the concepts of -test groups and gives finer control of your tests over the command line. +This Framework is an optional add-on to Unity. +By including unity_fixture.h in place of unity.h, you may now work with Unity in a manner similar to CppUTest. +This framework adds the concepts of test groups and gives finer control of your tests over the command line. -This framework is primarily supplied for those working through James Grenning's book on Embedded -Test Driven Development, or those coming to Unity from CppUTest. We should note that using this -framework glosses over some of the features of Unity, and makes it more difficult -to integrate with other testing tools like Ceedling and CMock. +This framework is primarily supplied for those working through James Grenning's book on Embedded Test Driven Development, or those coming to Unity from CppUTest. +We should note that using this framework glosses over some of the features of Unity, and makes it more difficult to integrate with other testing tools like Ceedling and CMock. -# Dependency Notification +## Dependency Notification -Fixtures, by default, uses the Memory addon as well. This is to make it simple for those trying to -follow along with James' book. Using them together is completely optional. You may choose to use -Fixtures without Memory handling by defining `UNITY_FIXTURE_NO_EXTRAS`. It will then stop automatically -pulling in extras and leave you to do it as desired. +Fixtures, by default, uses the Memory addon as well. +This is to make it simple for those trying to follow along with James' book. +Using them together is completely optional. +You may choose to use Fixtures without Memory handling by defining `UNITY_FIXTURE_NO_EXTRAS`. +It will then stop automatically pulling in extras and leave you to do it as desired. -# Usage information +## Usage information -By default the test executables produced by Unity Fixtures run all tests once, but the behavior can -be configured with command-line flags. Run the test executable with the `--help` flag for more -information. +By default the test executables produced by Unity Fixtures run all tests once, but the behavior can be configured with command-line flags. +Run the test executable with the `--help` flag for more information. -It's possible to add a custom line at the end of the help message, typically to point to -project-specific or company-specific unit test documentation. Define `UNITY_CUSTOM_HELP_MSG` to -provide a custom message, e.g.: +It's possible to add a custom line at the end of the help message, typically to point to project-specific or company-specific unit test documentation. +Define `UNITY_CUSTOM_HELP_MSG` to provide a custom message, e.g.: #define UNITY_CUSTOM_HELP_MSG "If any test fails see https://example.com/troubleshooting" diff --git a/extras/fixture/src/meson.build b/extras/fixture/src/meson.build new file mode 100644 index 000000000..224911de6 --- /dev/null +++ b/extras/fixture/src/meson.build @@ -0,0 +1,10 @@ +unity_inc += include_directories('.') +unity_src += files('unity_fixture.c') + +if not meson.is_subproject() + install_headers( + 'unity_fixture.h', + 'unity_fixture_internals.h', + subdir: meson.project_name() + ) +endif diff --git a/extras/fixture/src/unity_fixture.h b/extras/fixture/src/unity_fixture.h index 4cc403ef0..657506628 100644 --- a/extras/fixture/src/unity_fixture.h +++ b/extras/fixture/src/unity_fixture.h @@ -9,13 +9,20 @@ #define UNITY_FIXTURE_H_ #include "unity.h" -#include "unity_internals.h" #include "unity_fixture_internals.h" #ifndef UNITY_FIXTURE_NO_EXTRAS #include "unity_memory.h" #endif +#ifdef __cplusplus +extern "C" +{ +#endif + +#include "unity_internals.h" + + int UnityMain(int argc, const char* argv[], void (*runAllTests)(void)); @@ -80,4 +87,8 @@ int UnityMain(int argc, const char* argv[], void (*runAllTests)(void)); #define DOUBLES_EQUAL(expected, actual, delta) TEST_ASSERT_DOUBLE_WITHIN((delta), (expected), (actual)) #endif +#ifdef __cplusplus +} +#endif + #endif /* UNITY_FIXTURE_H_ */ diff --git a/extras/memory/readme.md b/extras/memory/readme.md index 37769825c..ea8b9cf70 100644 --- a/extras/memory/readme.md +++ b/extras/memory/readme.md @@ -1,49 +1,42 @@ # Unity Memory -This Framework is an optional add-on to Unity. By including unity.h and then -unity_memory.h, you have the added ability to track malloc and free calls. This -addon requires that the stdlib functions be overridden by its own defines. These -defines will still malloc / realloc / free etc, but will also track the calls -in order to ensure that you don't have any memory leaks in your programs. +This Framework is an optional add-on to Unity. +By including unity.h and then unity_memory.h, you have the added ability to track malloc and free calls. +This addon requires that the stdlib functions be overridden by its own defines. +These defines will still malloc / realloc / free etc, but will also track the calls in order to ensure that you don't have any memory leaks in your programs. -Note that this is only useful in situations where a unit is in charge of both -the allocation and deallocation of memory. When it is not symmetric, unit testing -can report a number of false failures. A more advanced runtime tool is required to -track complete system memory handling. +Note that this is only useful in situations where a unit is in charge of both the allocation and deallocation of memory. +When it is not symmetric, unit testing can report a number of false failures. +A more advanced runtime tool is required to track complete system memory handling. -# Module API +## Module API -## `UnityMalloc_StartTest` and `UnityMalloc_EndTest` +### `UnityMalloc_StartTest` and `UnityMalloc_EndTest` -These must be called at the beginning and end of each test. For simplicity, they can -be added to `setUp` and `tearDown` in order to do their job. When using the test -runner generator scripts, these will be automatically added to the runner whenever -unity_memory.h is included. +These must be called at the beginning and end of each test. +For simplicity, they can be added to `setUp` and `tearDown` in order to do their job. +When using the test runner generator scripts, these will be automatically added to the runner whenever unity_memory.h is included. -## `UnityMalloc_MakeMallocFailAfterCount` +### `UnityMalloc_MakeMallocFailAfterCount` -This can be called from the tests themselves. Passing this function a number will -force the reference counter to start keeping track of malloc calls. During that test, -if the number of malloc calls exceeds the number given, malloc will immediately -start returning `NULL`. This allows you to test error conditions. Think of it as a -simplified mock. +This can be called from the tests themselves. +Passing this function a number will force the reference counter to start keeping track of malloc calls. +During that test, if the number of malloc calls exceeds the number given, malloc will immediately start returning `NULL`. +This allows you to test error conditions. +Think of it as a simplified mock. -# Configuration +## Configuration -## `UNITY_MALLOC` and `UNITY_FREE` +### `UNITY_MALLOC` and `UNITY_FREE` -By default, this module tries to use the real stdlib `malloc` and `free` internally. -If you would prefer it to use something else, like FreeRTOS's `pvPortMalloc` and -`pvPortFree`, then you can use these defines to make it so. +By default, this module tries to use the real stdlib `malloc` and `free` internally. +If you would prefer it to use something else, like FreeRTOS's `pvPortMalloc` and `pvPortFree`, then you can use these defines to make it so. -## `UNITY_EXCLUDE_STDLIB_MALLOC` +### `UNITY_EXCLUDE_STDLIB_MALLOC` -If you would like this library to ignore stdlib or other heap engines completely, and -manage the memory on its own, then define this. All memory will be handled internally -(and at likely lower overhead). Note that this is not a very featureful memory manager, -but is sufficient for most testing purposes. +If you would like this library to ignore stdlib or other heap engines completely, and manage the memory on its own, then define this. All memory will be handled internally (and at likely lower overhead). +Note that this is not a very featureful memory manager, but is sufficient for most testing purposes. -## `UNITY_INTERNAL_HEAP_SIZE_BYTES` +### `UNITY_INTERNAL_HEAP_SIZE_BYTES` -When using the built-in memory manager (see `UNITY_EXCLUDE_STDLIB_MALLOC`) this define -allows you to set the heap size this library will use to manage the memory. +When using the built-in memory manager (see `UNITY_EXCLUDE_STDLIB_MALLOC`) this define allows you to set the heap size this library will use to manage the memory. diff --git a/extras/memory/src/meson.build b/extras/memory/src/meson.build new file mode 100644 index 000000000..650ba32d9 --- /dev/null +++ b/extras/memory/src/meson.build @@ -0,0 +1,9 @@ +unity_inc += include_directories('.') +unity_src += files('unity_memory.c') + +if not meson.is_subproject() + install_headers( + 'unity_memory.h', + subdir: meson.project_name() + ) +endif diff --git a/library.json b/library.json new file mode 100644 index 000000000..914f5f687 --- /dev/null +++ b/library.json @@ -0,0 +1,18 @@ +{ + "name": "Unity", + "version": "2.6.0", + "keywords": "unit-testing, testing, tdd, testing-framework", + "description": "Simple Unit Testing for C", + "homepage": "http://www.throwtheswitch.org/unity", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/ThrowTheSwitch/Unity.git" + }, + "frameworks": "*", + "platforms": "*", + "headers": "unity.h", + "build": { + "extraScript": "platformio-build.py" + } +} diff --git a/meson.build b/meson.build index f5c5cfaa7..6585129c9 100644 --- a/meson.build +++ b/meson.build @@ -1,14 +1,80 @@ # -# build script written by : Michael Brockus. +# build script written by : Michael Gene Brockus. # github repo author: Mike Karlesky, Mark VanderVoord, Greg Williams. # # license: MIT # project('unity', 'c', - license: 'MIT', - meson_version: '>=0.53.0', - default_options: ['werror=true', 'c_std=c11'] + license: 'MIT', + + # Set project version to value extracted from unity.h header + version: run_command( + [ + 'auto/extract_version.py', + 'src/unity.h' + ], + check: true + ).stdout().strip(), + + meson_version: '>=0.47.0', + default_options: [ + 'werror=true', + 'c_std=c11' + ] ) +build_fixture = get_option('extension_fixture') +build_memory = get_option('extension_memory') +support_double = get_option('support_double') + +unity_args = [] +unity_src = [] +unity_inc = [] + subdir('src') -unity_dep = declare_dependency(link_with: unity_lib, include_directories: unity_dir) + +if build_fixture + # Building the fixture extension implies building the memory + # extension. + build_memory = true + subdir('extras/fixture/src') +endif + +if build_memory + subdir('extras/memory/src') +endif + +if support_double + unity_args += '-DUNITY_INCLUDE_DOUBLE' +endif + +unity_lib = static_library(meson.project_name(), + sources: unity_src, + c_args: unity_args, + include_directories: unity_inc, + install: not meson.is_subproject(), +) + +unity_dep = declare_dependency( + link_with: unity_lib, + include_directories: unity_inc +) + +# Generate pkg-config file. +if not meson.is_subproject() + pkg = import('pkgconfig') + pkg.generate( + name: meson.project_name(), + version: meson.project_version(), + libraries: [ unity_lib ], + description: 'C Unit testing framework.' + ) +endif + +# Create a generator that can be used by consumers of our build system to generate +# test runners. +gen_test_runner = generator( + find_program('auto/generate_test_runner.rb'), + output: '@BASENAME@_Runner.c', + arguments: ['@INPUT@', '@OUTPUT@'] +) diff --git a/meson_options.txt b/meson_options.txt new file mode 100644 index 000000000..8e66784b8 --- /dev/null +++ b/meson_options.txt @@ -0,0 +1,3 @@ +option('extension_fixture', type: 'boolean', value: 'false', description: 'Whether to enable the fixture extension.') +option('extension_memory', type: 'boolean', value: 'false', description: 'Whether to enable the memory extension.') +option('support_double', type: 'boolean', value: 'false', description: 'Whether to enable double precision floating point assertions.') diff --git a/platformio-build.py b/platformio-build.py new file mode 100644 index 000000000..66fea42fb --- /dev/null +++ b/platformio-build.py @@ -0,0 +1,17 @@ +import os + +Import("env") + +env.Append(CPPDEFINES=["UNITY_INCLUDE_CONFIG_H"]) + +# import "unity_config.h" folder to the library builder +try: + Import("projenv") + + projenv.Append(CPPDEFINES=["UNITY_INCLUDE_CONFIG_H"]) + for p in projenv["CPPPATH"]: + p = projenv.subst(p) + if os.path.isfile(os.path.join(p, "unity_config.h")): + env.Prepend(CPPPATH=[p]) +except: + pass diff --git a/src/meson.build b/src/meson.build index 1c7b426ff..5365227fc 100644 --- a/src/meson.build +++ b/src/meson.build @@ -1,11 +1,17 @@ # -# build script written by : Michael Brockus. +# build script written by : Michael Gene Brockus. # github repo author: Mike Karlesky, Mark VanderVoord, Greg Williams. # # license: MIT # -unity_dir = include_directories('.') -unity_lib = static_library(meson.project_name(), - files('unity.c'), - include_directories: unity_dir) +unity_inc += include_directories('.') +unity_src += files('unity.c') + +if not meson.is_subproject() + install_headers( + 'unity.h', + 'unity_internals.h', + subdir: meson.project_name() + ) +endif diff --git a/src/unity.c b/src/unity.c index be3528fad..b105fa279 100644 --- a/src/unity.c +++ b/src/unity.c @@ -5,12 +5,9 @@ ============================================================================ */ #include "unity.h" -#include -#ifdef AVR -#include -#else -#define PROGMEM +#ifndef UNITY_PROGMEM +#define UNITY_PROGMEM #endif /* If omitted from header, declare overrideable prototypes here so they're ready for use */ @@ -19,57 +16,57 @@ void UNITY_OUTPUT_CHAR(int); #endif /* Helpful macros for us to use here in Assert functions */ -#define UNITY_FAIL_AND_BAIL { Unity.CurrentTestFailed = 1; UNITY_OUTPUT_FLUSH(); TEST_ABORT(); } -#define UNITY_IGNORE_AND_BAIL { Unity.CurrentTestIgnored = 1; UNITY_OUTPUT_FLUSH(); TEST_ABORT(); } -#define RETURN_IF_FAIL_OR_IGNORE if (Unity.CurrentTestFailed || Unity.CurrentTestIgnored) TEST_ABORT() +#define UNITY_FAIL_AND_BAIL do { Unity.CurrentTestFailed = 1; UNITY_OUTPUT_FLUSH(); TEST_ABORT(); } while (0) +#define UNITY_IGNORE_AND_BAIL do { Unity.CurrentTestIgnored = 1; UNITY_OUTPUT_FLUSH(); TEST_ABORT(); } while (0) +#define RETURN_IF_FAIL_OR_IGNORE do { if (Unity.CurrentTestFailed || Unity.CurrentTestIgnored) { TEST_ABORT(); } } while (0) struct UNITY_STORAGE_T Unity; #ifdef UNITY_OUTPUT_COLOR -const char PROGMEM UnityStrOk[] = "\033[42mOK\033[00m"; -const char PROGMEM UnityStrPass[] = "\033[42mPASS\033[00m"; -const char PROGMEM UnityStrFail[] = "\033[41mFAIL\033[00m"; -const char PROGMEM UnityStrIgnore[] = "\033[43mIGNORE\033[00m"; +const char UNITY_PROGMEM UnityStrOk[] = "\033[42mOK\033[0m"; +const char UNITY_PROGMEM UnityStrPass[] = "\033[42mPASS\033[0m"; +const char UNITY_PROGMEM UnityStrFail[] = "\033[41mFAIL\033[0m"; +const char UNITY_PROGMEM UnityStrIgnore[] = "\033[43mIGNORE\033[0m"; #else -const char PROGMEM UnityStrOk[] = "OK"; -const char PROGMEM UnityStrPass[] = "PASS"; -const char PROGMEM UnityStrFail[] = "FAIL"; -const char PROGMEM UnityStrIgnore[] = "IGNORE"; +const char UNITY_PROGMEM UnityStrOk[] = "OK"; +const char UNITY_PROGMEM UnityStrPass[] = "PASS"; +const char UNITY_PROGMEM UnityStrFail[] = "FAIL"; +const char UNITY_PROGMEM UnityStrIgnore[] = "IGNORE"; #endif -static const char PROGMEM UnityStrNull[] = "NULL"; -static const char PROGMEM UnityStrSpacer[] = ". "; -static const char PROGMEM UnityStrExpected[] = " Expected "; -static const char PROGMEM UnityStrWas[] = " Was "; -static const char PROGMEM UnityStrGt[] = " to be greater than "; -static const char PROGMEM UnityStrLt[] = " to be less than "; -static const char PROGMEM UnityStrOrEqual[] = "or equal to "; -static const char PROGMEM UnityStrNotEqual[] = " to be not equal to "; -static const char PROGMEM UnityStrElement[] = " Element "; -static const char PROGMEM UnityStrByte[] = " Byte "; -static const char PROGMEM UnityStrMemory[] = " Memory Mismatch."; -static const char PROGMEM UnityStrDelta[] = " Values Not Within Delta "; -static const char PROGMEM UnityStrPointless[] = " You Asked Me To Compare Nothing, Which Was Pointless."; -static const char PROGMEM UnityStrNullPointerForExpected[] = " Expected pointer to be NULL"; -static const char PROGMEM UnityStrNullPointerForActual[] = " Actual pointer was NULL"; +static const char UNITY_PROGMEM UnityStrNull[] = "NULL"; +static const char UNITY_PROGMEM UnityStrSpacer[] = ". "; +static const char UNITY_PROGMEM UnityStrExpected[] = " Expected "; +static const char UNITY_PROGMEM UnityStrWas[] = " Was "; +static const char UNITY_PROGMEM UnityStrGt[] = " to be greater than "; +static const char UNITY_PROGMEM UnityStrLt[] = " to be less than "; +static const char UNITY_PROGMEM UnityStrOrEqual[] = "or equal to "; +static const char UNITY_PROGMEM UnityStrNotEqual[] = " to be not equal to "; +static const char UNITY_PROGMEM UnityStrElement[] = " Element "; +static const char UNITY_PROGMEM UnityStrByte[] = " Byte "; +static const char UNITY_PROGMEM UnityStrMemory[] = " Memory Mismatch."; +static const char UNITY_PROGMEM UnityStrDelta[] = " Values Not Within Delta "; +static const char UNITY_PROGMEM UnityStrPointless[] = " You Asked Me To Compare Nothing, Which Was Pointless."; +static const char UNITY_PROGMEM UnityStrNullPointerForExpected[] = " Expected pointer to be NULL"; +static const char UNITY_PROGMEM UnityStrNullPointerForActual[] = " Actual pointer was NULL"; #ifndef UNITY_EXCLUDE_FLOAT -static const char PROGMEM UnityStrNot[] = "Not "; -static const char PROGMEM UnityStrInf[] = "Infinity"; -static const char PROGMEM UnityStrNegInf[] = "Negative Infinity"; -static const char PROGMEM UnityStrNaN[] = "NaN"; -static const char PROGMEM UnityStrDet[] = "Determinate"; -static const char PROGMEM UnityStrInvalidFloatTrait[] = "Invalid Float Trait"; +static const char UNITY_PROGMEM UnityStrNot[] = "Not "; +static const char UNITY_PROGMEM UnityStrInf[] = "Infinity"; +static const char UNITY_PROGMEM UnityStrNegInf[] = "Negative Infinity"; +static const char UNITY_PROGMEM UnityStrNaN[] = "NaN"; +static const char UNITY_PROGMEM UnityStrDet[] = "Determinate"; +static const char UNITY_PROGMEM UnityStrInvalidFloatTrait[] = "Invalid Float Trait"; #endif -const char PROGMEM UnityStrErrShorthand[] = "Unity Shorthand Support Disabled"; -const char PROGMEM UnityStrErrFloat[] = "Unity Floating Point Disabled"; -const char PROGMEM UnityStrErrDouble[] = "Unity Double Precision Disabled"; -const char PROGMEM UnityStrErr64[] = "Unity 64-bit Support Disabled"; -static const char PROGMEM UnityStrBreaker[] = "-----------------------"; -static const char PROGMEM UnityStrResultsTests[] = " Tests "; -static const char PROGMEM UnityStrResultsFailures[] = " Failures "; -static const char PROGMEM UnityStrResultsIgnored[] = " Ignored "; +const char UNITY_PROGMEM UnityStrErrShorthand[] = "Unity Shorthand Support Disabled"; +const char UNITY_PROGMEM UnityStrErrFloat[] = "Unity Floating Point Disabled"; +const char UNITY_PROGMEM UnityStrErrDouble[] = "Unity Double Precision Disabled"; +const char UNITY_PROGMEM UnityStrErr64[] = "Unity 64-bit Support Disabled"; +static const char UNITY_PROGMEM UnityStrBreaker[] = "-----------------------"; +static const char UNITY_PROGMEM UnityStrResultsTests[] = " Tests "; +static const char UNITY_PROGMEM UnityStrResultsFailures[] = " Failures "; +static const char UNITY_PROGMEM UnityStrResultsIgnored[] = " Ignored "; #ifndef UNITY_EXCLUDE_DETAILS -static const char PROGMEM UnityStrDetail1Name[] = UNITY_DETAIL1_NAME " "; -static const char PROGMEM UnityStrDetail2Name[] = " " UNITY_DETAIL2_NAME " "; +static const char UNITY_PROGMEM UnityStrDetail1Name[] = UNITY_DETAIL1_NAME " "; +static const char UNITY_PROGMEM UnityStrDetail2Name[] = " " UNITY_DETAIL2_NAME " "; #endif /*----------------------------------------------- * Pretty Printers & Test Result Output Handlers @@ -359,20 +356,22 @@ void UnityPrintFloat(const UNITY_DOUBLE input_number) { UnityPrint("0"); } - else if (isnan(number)) + else if (UNITY_IS_NAN(number)) { UnityPrint("nan"); } - else if (isinf(number)) + else if (UNITY_IS_INF(number)) { UnityPrint("inf"); } else { - UNITY_INT32 n_int = 0, n; - int exponent = 0; - int decimals, digits; - char buf[16] = {0}; + UNITY_INT32 n_int = 0; + UNITY_INT32 n; + int exponent = 0; + int decimals; + int digits; + char buf[16] = {0}; /* * Scale up or down by powers of 10. To minimize rounding error, @@ -445,14 +444,19 @@ void UnityPrintFloat(const UNITY_DOUBLE input_number) /* build up buffer in reverse order */ digits = 0; - while ((n != 0) || (digits < (decimals + 1))) + while ((n != 0) || (digits <= decimals)) { buf[digits++] = (char)('0' + n % 10); n /= 10; } + + /* print out buffer (backwards) */ while (digits > 0) { - if (digits == decimals) { UNITY_OUTPUT_CHAR('.'); } + if (digits == decimals) + { + UNITY_OUTPUT_CHAR('.'); + } UNITY_OUTPUT_CHAR(buf[--digits]); } @@ -564,26 +568,26 @@ void UnityConcludeTest(void) /*-----------------------------------------------*/ static void UnityAddMsgIfSpecified(const char* msg) { - if (msg) - { - UnityPrint(UnityStrSpacer); - #ifdef UNITY_PRINT_TEST_CONTEXT - UNITY_PRINT_TEST_CONTEXT(); + UnityPrint(UnityStrSpacer); + UNITY_PRINT_TEST_CONTEXT(); #endif #ifndef UNITY_EXCLUDE_DETAILS - if (Unity.CurrentDetail1) + if (Unity.CurrentDetail1) + { + UnityPrint(UnityStrSpacer); + UnityPrint(UnityStrDetail1Name); + UnityPrint(Unity.CurrentDetail1); + if (Unity.CurrentDetail2) { - UnityPrint(UnityStrDetail1Name); - UnityPrint(Unity.CurrentDetail1); - if (Unity.CurrentDetail2) - { - UnityPrint(UnityStrDetail2Name); - UnityPrint(Unity.CurrentDetail2); - } - UnityPrint(UnityStrSpacer); + UnityPrint(UnityStrDetail2Name); + UnityPrint(Unity.CurrentDetail2); } + } #endif + if (msg) + { + UnityPrint(UnityStrSpacer); UnityPrint(msg); } } @@ -765,11 +769,12 @@ void UnityAssertGreaterOrLessOrEqualNumber(const UNITY_INT threshold, } #define UnityPrintPointlessAndBail() \ -{ \ +do { \ UnityTestResultsFailBegin(lineNumber); \ UnityPrint(UnityStrPointless); \ UnityAddMsgIfSpecified(msg); \ - UNITY_FAIL_AND_BAIL; } + UNITY_FAIL_AND_BAIL; \ +} while (0) /*-----------------------------------------------*/ void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected, @@ -788,7 +793,11 @@ void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected, if (num_elements == 0) { +#ifdef UNITY_COMPARE_PTRS_ON_ZERO_ARRAY + UNITY_TEST_ASSERT_EQUAL_PTR(expected, actual, lineNumber, msg); +#else UnityPrintPointlessAndBail(); +#endif } if (expected == actual) @@ -811,12 +820,22 @@ void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected, case 1: expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT8*)expected; actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT8*)actual; + if (style & (UNITY_DISPLAY_RANGE_UINT | UNITY_DISPLAY_RANGE_HEX)) + { + expect_val &= 0x000000FF; + actual_val &= 0x000000FF; + } increment = sizeof(UNITY_INT8); break; case 2: expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT16*)expected; actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT16*)actual; + if (style & (UNITY_DISPLAY_RANGE_UINT | UNITY_DISPLAY_RANGE_HEX)) + { + expect_val &= 0x0000FFFF; + actual_val &= 0x0000FFFF; + } increment = sizeof(UNITY_INT16); break; @@ -832,6 +851,13 @@ void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected, case 4: expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)expected; actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)actual; +#ifdef UNITY_SUPPORT_64 + if (style & (UNITY_DISPLAY_RANGE_UINT | UNITY_DISPLAY_RANGE_HEX)) + { + expect_val &= 0x00000000FFFFFFFF; + actual_val &= 0x00000000FFFFFFFF; + } +#endif increment = sizeof(UNITY_INT32); length = 4; break; @@ -869,26 +895,27 @@ void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected, #ifndef UNITY_EXCLUDE_FLOAT /* Wrap this define in a function with variable types as float or double */ #define UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff) \ - if (isinf(expected) && isinf(actual) && (((expected) < 0) == ((actual) < 0))) return 1; \ + if (UNITY_IS_INF(expected) && UNITY_IS_INF(actual) && (((expected) < 0) == ((actual) < 0))) return 1; \ if (UNITY_NAN_CHECK) return 1; \ (diff) = (actual) - (expected); \ if ((diff) < 0) (diff) = -(diff); \ if ((delta) < 0) (delta) = -(delta); \ - return !(isnan(diff) || isinf(diff) || ((diff) > (delta))) + return !(UNITY_IS_NAN(diff) || UNITY_IS_INF(diff) || ((diff) > (delta))) /* This first part of this condition will catch any NaN or Infinite values */ #ifndef UNITY_NAN_NOT_EQUAL_NAN - #define UNITY_NAN_CHECK isnan(expected) && isnan(actual) + #define UNITY_NAN_CHECK UNITY_IS_NAN(expected) && UNITY_IS_NAN(actual) #else #define UNITY_NAN_CHECK 0 #endif #ifndef UNITY_EXCLUDE_FLOAT_PRINT #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \ - { \ + do { \ UnityPrint(UnityStrExpected); \ UnityPrintFloat(expected); \ UnityPrint(UnityStrWas); \ - UnityPrintFloat(actual); } + UnityPrintFloat(actual); \ + } while (0) #else #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \ UnityPrint(UnityStrDelta) @@ -902,21 +929,39 @@ static int UnityFloatsWithin(UNITY_FLOAT delta, UNITY_FLOAT expected, UNITY_FLOA } /*-----------------------------------------------*/ -void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected, - UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual, - const UNITY_UINT32 num_elements, - const char* msg, - const UNITY_LINE_TYPE lineNumber, - const UNITY_FLAGS_T flags) +void UnityAssertWithinFloatArray(const UNITY_FLOAT delta, + UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected, + UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual, + const UNITY_UINT32 num_elements, + const char* msg, + const UNITY_LINE_TYPE lineNumber, + const UNITY_FLAGS_T flags) { UNITY_UINT32 elements = num_elements; UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_expected = expected; UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_actual = actual; + UNITY_FLOAT in_delta = delta; + UNITY_FLOAT current_element_delta = delta; RETURN_IF_FAIL_OR_IGNORE; if (elements == 0) { +#ifdef UNITY_COMPARE_PTRS_ON_ZERO_ARRAY + UNITY_TEST_ASSERT_EQUAL_PTR(expected, actual, lineNumber, msg); +#else + UnityPrintPointlessAndBail(); +#endif + } + + if (UNITY_IS_INF(in_delta)) + { + return; /* Arrays will be force equal with infinite delta */ + } + + if (UNITY_IS_NAN(in_delta)) + { + /* Delta must be correct number */ UnityPrintPointlessAndBail(); } @@ -930,9 +975,23 @@ void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected, UNITY_FAIL_AND_BAIL; } + /* fix delta sign if need */ + if (in_delta < 0) + { + in_delta = -in_delta; + } + while (elements--) { - if (!UnityFloatsWithin(*ptr_expected * UNITY_FLOAT_PRECISION, *ptr_expected, *ptr_actual)) + current_element_delta = *ptr_expected * UNITY_FLOAT_PRECISION; + + if (current_element_delta < 0) + { + /* fix delta sign for correct calculations */ + current_element_delta = -current_element_delta; + } + + if (!UnityFloatsWithin(in_delta + current_element_delta, *ptr_expected, *ptr_actual)) { UnityTestResultsFailBegin(lineNumber); UnityPrint(UnityStrElement); @@ -968,6 +1027,60 @@ void UnityAssertFloatsWithin(const UNITY_FLOAT delta, } } +/*-----------------------------------------------*/ +void UnityAssertFloatsNotWithin(const UNITY_FLOAT delta, + const UNITY_FLOAT expected, + const UNITY_FLOAT actual, + const char* msg, + const UNITY_LINE_TYPE lineNumber) +{ + RETURN_IF_FAIL_OR_IGNORE; + + if (UnityFloatsWithin(delta, expected, actual)) + { + UnityTestResultsFailBegin(lineNumber); + UnityPrint(UnityStrExpected); + UnityPrintFloat((UNITY_DOUBLE)expected); + UnityPrint(UnityStrNotEqual); + UnityPrintFloat((UNITY_DOUBLE)actual); + UnityAddMsgIfSpecified(msg); + UNITY_FAIL_AND_BAIL; + } +} + +/*-----------------------------------------------*/ +void UnityAssertGreaterOrLessFloat(const UNITY_FLOAT threshold, + const UNITY_FLOAT actual, + const UNITY_COMPARISON_T compare, + const char* msg, + const UNITY_LINE_TYPE lineNumber) +{ + int failed; + + RETURN_IF_FAIL_OR_IGNORE; + + failed = 0; + + /* Checking for "not success" rather than failure to get the right result for NaN */ + if (!(actual < threshold) && (compare & UNITY_SMALLER_THAN)) { failed = 1; } + if (!(actual > threshold) && (compare & UNITY_GREATER_THAN)) { failed = 1; } + + if ((compare & UNITY_EQUAL_TO) && UnityFloatsWithin(threshold * UNITY_FLOAT_PRECISION, threshold, actual)) { failed = 0; } + + if (failed) + { + UnityTestResultsFailBegin(lineNumber); + UnityPrint(UnityStrExpected); + UnityPrintFloat(actual); + if (compare & UNITY_GREATER_THAN) { UnityPrint(UnityStrGt); } + if (compare & UNITY_SMALLER_THAN) { UnityPrint(UnityStrLt); } + if (compare & UNITY_EQUAL_TO) { UnityPrint(UnityStrOrEqual); } + UnityPrintFloat(threshold); + UnityAddMsgIfSpecified(msg); + UNITY_FAIL_AND_BAIL; + } +} + /*-----------------------------------------------*/ void UnityAssertFloatSpecial(const UNITY_FLOAT actual, const char* msg, @@ -985,23 +1098,24 @@ void UnityAssertFloatSpecial(const UNITY_FLOAT actual, { case UNITY_FLOAT_IS_INF: case UNITY_FLOAT_IS_NOT_INF: - is_trait = isinf(actual) && (actual > 0); + is_trait = UNITY_IS_INF(actual) && (actual > 0); break; case UNITY_FLOAT_IS_NEG_INF: case UNITY_FLOAT_IS_NOT_NEG_INF: - is_trait = isinf(actual) && (actual < 0); + is_trait = UNITY_IS_INF(actual) && (actual < 0); break; case UNITY_FLOAT_IS_NAN: case UNITY_FLOAT_IS_NOT_NAN: - is_trait = isnan(actual) ? 1 : 0; + is_trait = UNITY_IS_NAN(actual) ? 1 : 0; break; case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */ case UNITY_FLOAT_IS_NOT_DET: - is_trait = !isinf(actual) && !isnan(actual); + is_trait = !UNITY_IS_INF(actual) && !UNITY_IS_NAN(actual); break; + case UNITY_FLOAT_INVALID_TRAIT: /* Supress warning */ default: /* including UNITY_FLOAT_INVALID_TRAIT */ trait_index = 0; trait_names[0] = UnityStrInvalidFloatTrait; @@ -1043,21 +1157,39 @@ static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_D } /*-----------------------------------------------*/ -void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected, - UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual, - const UNITY_UINT32 num_elements, - const char* msg, - const UNITY_LINE_TYPE lineNumber, - const UNITY_FLAGS_T flags) +void UnityAssertWithinDoubleArray(const UNITY_DOUBLE delta, + UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected, + UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual, + const UNITY_UINT32 num_elements, + const char* msg, + const UNITY_LINE_TYPE lineNumber, + const UNITY_FLAGS_T flags) { UNITY_UINT32 elements = num_elements; UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_expected = expected; UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_actual = actual; + UNITY_DOUBLE in_delta = delta; + UNITY_DOUBLE current_element_delta = delta; RETURN_IF_FAIL_OR_IGNORE; if (elements == 0) { +#ifdef UNITY_COMPARE_PTRS_ON_ZERO_ARRAY + UNITY_TEST_ASSERT_EQUAL_PTR(expected, actual, lineNumber, msg); +#else + UnityPrintPointlessAndBail(); +#endif + } + + if (UNITY_IS_INF(in_delta)) + { + return; /* Arrays will be force equal with infinite delta */ + } + + if (UNITY_IS_NAN(in_delta)) + { + /* Delta must be correct number */ UnityPrintPointlessAndBail(); } @@ -1071,9 +1203,23 @@ void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expecte UNITY_FAIL_AND_BAIL; } + /* fix delta sign if need */ + if (in_delta < 0) + { + in_delta = -in_delta; + } + while (elements--) { - if (!UnityDoublesWithin(*ptr_expected * UNITY_DOUBLE_PRECISION, *ptr_expected, *ptr_actual)) + current_element_delta = *ptr_expected * UNITY_DOUBLE_PRECISION; + + if (current_element_delta < 0) + { + /* fix delta sign for correct calculations */ + current_element_delta = -current_element_delta; + } + + if (!UnityDoublesWithin(in_delta + current_element_delta, *ptr_expected, *ptr_actual)) { UnityTestResultsFailBegin(lineNumber); UnityPrint(UnityStrElement); @@ -1108,6 +1254,60 @@ void UnityAssertDoublesWithin(const UNITY_DOUBLE delta, } } +/*-----------------------------------------------*/ +void UnityAssertDoublesNotWithin(const UNITY_DOUBLE delta, + const UNITY_DOUBLE expected, + const UNITY_DOUBLE actual, + const char* msg, + const UNITY_LINE_TYPE lineNumber) +{ + RETURN_IF_FAIL_OR_IGNORE; + + if (UnityDoublesWithin(delta, expected, actual)) + { + UnityTestResultsFailBegin(lineNumber); + UnityPrint(UnityStrExpected); + UnityPrintFloat((UNITY_DOUBLE)expected); + UnityPrint(UnityStrNotEqual); + UnityPrintFloat((UNITY_DOUBLE)actual); + UnityAddMsgIfSpecified(msg); + UNITY_FAIL_AND_BAIL; + } +} + +/*-----------------------------------------------*/ +void UnityAssertGreaterOrLessDouble(const UNITY_DOUBLE threshold, + const UNITY_DOUBLE actual, + const UNITY_COMPARISON_T compare, + const char* msg, + const UNITY_LINE_TYPE lineNumber) +{ + int failed; + + RETURN_IF_FAIL_OR_IGNORE; + + failed = 0; + + /* Checking for "not success" rather than failure to get the right result for NaN */ + if (!(actual < threshold) && (compare & UNITY_SMALLER_THAN)) { failed = 1; } + if (!(actual > threshold) && (compare & UNITY_GREATER_THAN)) { failed = 1; } + + if ((compare & UNITY_EQUAL_TO) && UnityDoublesWithin(threshold * UNITY_DOUBLE_PRECISION, threshold, actual)) { failed = 0; } + + if (failed) + { + UnityTestResultsFailBegin(lineNumber); + UnityPrint(UnityStrExpected); + UnityPrintFloat(actual); + if (compare & UNITY_GREATER_THAN) { UnityPrint(UnityStrGt); } + if (compare & UNITY_SMALLER_THAN) { UnityPrint(UnityStrLt); } + if (compare & UNITY_EQUAL_TO) { UnityPrint(UnityStrOrEqual); } + UnityPrintFloat(threshold); + UnityAddMsgIfSpecified(msg); + UNITY_FAIL_AND_BAIL; + } +} + /*-----------------------------------------------*/ void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual, const char* msg, @@ -1125,23 +1325,24 @@ void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual, { case UNITY_FLOAT_IS_INF: case UNITY_FLOAT_IS_NOT_INF: - is_trait = isinf(actual) && (actual > 0); + is_trait = UNITY_IS_INF(actual) && (actual > 0); break; case UNITY_FLOAT_IS_NEG_INF: case UNITY_FLOAT_IS_NOT_NEG_INF: - is_trait = isinf(actual) && (actual < 0); + is_trait = UNITY_IS_INF(actual) && (actual < 0); break; case UNITY_FLOAT_IS_NAN: case UNITY_FLOAT_IS_NOT_NAN: - is_trait = isnan(actual) ? 1 : 0; + is_trait = UNITY_IS_NAN(actual) ? 1 : 0; break; case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */ case UNITY_FLOAT_IS_NOT_DET: - is_trait = !isinf(actual) && !isnan(actual); + is_trait = !UNITY_IS_INF(actual) && !UNITY_IS_NAN(actual); break; + case UNITY_FLOAT_INVALID_TRAIT: /* Supress warning */ default: /* including UNITY_FLOAT_INVALID_TRAIT */ trait_index = 0; trait_names[0] = UnityStrInvalidFloatTrait; @@ -1239,7 +1440,11 @@ void UnityAssertNumbersArrayWithin(const UNITY_UINT delta, if (num_elements == 0) { +#ifdef UNITY_COMPARE_PTRS_ON_ZERO_ARRAY + UNITY_TEST_ASSERT_EQUAL_PTR(expected, actual, lineNumber, msg); +#else UnityPrintPointlessAndBail(); +#endif } if (expected == actual) @@ -1260,30 +1465,70 @@ void UnityAssertNumbersArrayWithin(const UNITY_UINT delta, switch (length) { case 1: - expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT8*)expected; - actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT8*)actual; - increment = sizeof(UNITY_INT8); + /* fixing problems with signed overflow on unsigned numbers */ + if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT) + { + expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT8*)expected; + actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT8*)actual; + increment = sizeof(UNITY_INT8); + } + else + { + expect_val = (UNITY_INT)*(UNITY_PTR_ATTRIBUTE const UNITY_UINT8*)expected; + actual_val = (UNITY_INT)*(UNITY_PTR_ATTRIBUTE const UNITY_UINT8*)actual; + increment = sizeof(UNITY_UINT8); + } break; case 2: - expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT16*)expected; - actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT16*)actual; - increment = sizeof(UNITY_INT16); + /* fixing problems with signed overflow on unsigned numbers */ + if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT) + { + expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT16*)expected; + actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT16*)actual; + increment = sizeof(UNITY_INT16); + } + else + { + expect_val = (UNITY_INT)*(UNITY_PTR_ATTRIBUTE const UNITY_UINT16*)expected; + actual_val = (UNITY_INT)*(UNITY_PTR_ATTRIBUTE const UNITY_UINT16*)actual; + increment = sizeof(UNITY_UINT16); + } break; #ifdef UNITY_SUPPORT_64 case 8: - expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected; - actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual; - increment = sizeof(UNITY_INT64); + /* fixing problems with signed overflow on unsigned numbers */ + if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT) + { + expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected; + actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual; + increment = sizeof(UNITY_INT64); + } + else + { + expect_val = (UNITY_INT)*(UNITY_PTR_ATTRIBUTE const UNITY_UINT64*)expected; + actual_val = (UNITY_INT)*(UNITY_PTR_ATTRIBUTE const UNITY_UINT64*)actual; + increment = sizeof(UNITY_UINT64); + } break; #endif default: /* default is length 4 bytes */ case 4: - expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)expected; - actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)actual; - increment = sizeof(UNITY_INT32); + /* fixing problems with signed overflow on unsigned numbers */ + if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT) + { + expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)expected; + actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)actual; + increment = sizeof(UNITY_INT32); + } + else + { + expect_val = (UNITY_INT)*(UNITY_PTR_ATTRIBUTE const UNITY_UINT32*)expected; + actual_val = (UNITY_INT)*(UNITY_PTR_ATTRIBUTE const UNITY_UINT32*)actual; + increment = sizeof(UNITY_UINT32); + } length = 4; break; } @@ -1364,8 +1609,8 @@ void UnityAssertEqualString(const char* expected, } } else - { /* handle case of one pointers being null (if both null, test should pass) */ - if (expected != actual) + { /* fail if either null but not if both */ + if (expected || actual) { Unity.CurrentTestFailed = 1; } @@ -1404,8 +1649,8 @@ void UnityAssertEqualStringLen(const char* expected, } } else - { /* handle case of one pointers being null (if both null, test should pass) */ - if (expected != actual) + { /* fail if either null but not if both */ + if (expected || actual) { Unity.CurrentTestFailed = 1; } @@ -1438,7 +1683,11 @@ void UnityAssertEqualStringArray(UNITY_INTERNAL_PTR expected, /* if no elements, it's an error */ if (num_elements == 0) { +#ifdef UNITY_COMPARE_PTRS_ON_ZERO_ARRAY + UNITY_TEST_ASSERT_EQUAL_PTR(expected, actual, lineNumber, msg); +#else UnityPrintPointlessAndBail(); +#endif } if ((const void*)expected == (const void*)actual) @@ -1515,7 +1764,15 @@ void UnityAssertEqualMemory(UNITY_INTERNAL_PTR expected, RETURN_IF_FAIL_OR_IGNORE; - if ((elements == 0) || (length == 0)) + if (elements == 0) + { +#ifdef UNITY_COMPARE_PTRS_ON_ZERO_ARRAY + UNITY_TEST_ASSERT_EQUAL_PTR(expected, actual, lineNumber, msg); +#else + UnityPrintPointlessAndBail(); +#endif + } + if (length == 0) { UnityPrintPointlessAndBail(); } @@ -1623,10 +1880,96 @@ UNITY_INTERNAL_PTR UnityDoubleToPtr(const double num) } #endif +#ifdef UNITY_INCLUDE_PRINT_FORMATTED + +/*----------------------------------------------- + * printf length modifier helpers + *-----------------------------------------------*/ + +enum UnityLengthModifier { + UNITY_LENGTH_MODIFIER_NONE, + UNITY_LENGTH_MODIFIER_LONG_LONG, + UNITY_LENGTH_MODIFIER_LONG, +}; + +#define UNITY_EXTRACT_ARG(NUMBER_T, NUMBER, LENGTH_MOD, VA, ARG_T) \ +do { \ + switch (LENGTH_MOD) \ + { \ + case UNITY_LENGTH_MODIFIER_LONG_LONG: \ + { \ + NUMBER = (NUMBER_T)va_arg(VA, long long ARG_T); \ + break; \ + } \ + case UNITY_LENGTH_MODIFIER_LONG: \ + { \ + NUMBER = (NUMBER_T)va_arg(VA, long ARG_T); \ + break; \ + } \ + case UNITY_LENGTH_MODIFIER_NONE: \ + default: \ + { \ + NUMBER = (NUMBER_T)va_arg(VA, ARG_T); \ + break; \ + } \ + } \ +} while (0) + +static enum UnityLengthModifier UnityLengthModifierGet(const char *pch, int *length) +{ + enum UnityLengthModifier length_mod; + switch (pch[0]) + { + case 'l': + { + if (pch[1] == 'l') + { + *length = 2; + length_mod = UNITY_LENGTH_MODIFIER_LONG_LONG; + } + else + { + *length = 1; + length_mod = UNITY_LENGTH_MODIFIER_LONG; + } + break; + } + case 'h': + { + // short and char are converted to int + length_mod = UNITY_LENGTH_MODIFIER_NONE; + if (pch[1] == 'h') + { + *length = 2; + } + else + { + *length = 1; + } + break; + } + case 'j': + case 'z': + case 't': + case 'L': + { + // Not supported, but should gobble up the length specifier anyway + length_mod = UNITY_LENGTH_MODIFIER_NONE; + *length = 1; + break; + } + default: + { + length_mod = UNITY_LENGTH_MODIFIER_NONE; + *length = 0; + } + } + return length_mod; +} + /*----------------------------------------------- * printf helper function *-----------------------------------------------*/ -#ifdef UNITY_INCLUDE_PRINT_FORMATTED static void UnityPrintFVA(const char* format, va_list va) { const char* pch = format; @@ -1641,12 +1984,17 @@ static void UnityPrintFVA(const char* format, va_list va) if (pch != NULL) { + int length_mod_size; + enum UnityLengthModifier length_mod = UnityLengthModifierGet(pch, &length_mod_size); + pch += length_mod_size; + switch (*pch) { case 'd': case 'i': { - const int number = va_arg(va, int); + UNITY_INT number; + UNITY_EXTRACT_ARG(UNITY_INT, number, length_mod, va, int); UnityPrintNumber((UNITY_INT)number); break; } @@ -1661,27 +2009,44 @@ static void UnityPrintFVA(const char* format, va_list va) #endif case 'u': { - const unsigned int number = va_arg(va, unsigned int); - UnityPrintNumberUnsigned((UNITY_UINT)number); + UNITY_UINT number; + UNITY_EXTRACT_ARG(UNITY_UINT, number, length_mod, va, unsigned int); + UnityPrintNumberUnsigned(number); break; } case 'b': { - const unsigned int number = va_arg(va, unsigned int); + UNITY_UINT number; + UNITY_EXTRACT_ARG(UNITY_UINT, number, length_mod, va, unsigned int); const UNITY_UINT mask = (UNITY_UINT)0 - (UNITY_UINT)1; UNITY_OUTPUT_CHAR('0'); UNITY_OUTPUT_CHAR('b'); - UnityPrintMask(mask, (UNITY_UINT)number); + UnityPrintMask(mask, number); break; } case 'x': case 'X': + { + UNITY_UINT number; + UNITY_EXTRACT_ARG(UNITY_UINT, number, length_mod, va, unsigned int); + UNITY_OUTPUT_CHAR('0'); + UNITY_OUTPUT_CHAR('x'); + UnityPrintNumberHex(number, UNITY_MAX_NIBBLES); + break; + } case 'p': { - const unsigned int number = va_arg(va, unsigned int); + UNITY_UINT number; + char nibbles_to_print = 8; + if (UNITY_POINTER_WIDTH == 64) + { + length_mod = UNITY_LENGTH_MODIFIER_LONG_LONG; + nibbles_to_print = 16; + } + UNITY_EXTRACT_ARG(UNITY_UINT, number, length_mod, va, unsigned int); UNITY_OUTPUT_CHAR('0'); UNITY_OUTPUT_CHAR('x'); - UnityPrintNumberHex((UNITY_UINT)number, 8); + UnityPrintNumberHex((UNITY_UINT)number, nibbles_to_print); break; } case 'c': @@ -1848,7 +2213,7 @@ void UnityDefaultTestRun(UnityTestFunction Func, const char* FuncName, const int /*-----------------------------------------------*/ void UnitySetTestFile(const char* filename) { - Unity.TestFile = filename; + Unity.TestFile = filename; } /*-----------------------------------------------*/ @@ -1964,6 +2329,18 @@ int UnityParseOptions(int argc, char** argv) UnityPrint("ERROR: Unknown Option "); UNITY_OUTPUT_CHAR(argv[i][1]); UNITY_PRINT_EOL(); + /* Now display help */ + /* FALLTHRU */ + case 'h': + UnityPrint("Options: "); UNITY_PRINT_EOL(); + UnityPrint("-l List all tests and exit"); UNITY_PRINT_EOL(); + UnityPrint("-f NAME Filter to run only tests whose name includes NAME"); UNITY_PRINT_EOL(); + UnityPrint("-n NAME (deprecated) alias of -f"); UNITY_PRINT_EOL(); + UnityPrint("-h show this Help menu"); UNITY_PRINT_EOL(); + UnityPrint("-q Quiet/decrease verbosity"); UNITY_PRINT_EOL(); + UnityPrint("-v increase Verbosity"); UNITY_PRINT_EOL(); + UnityPrint("-x NAME eXclude tests whose name includes NAME"); UNITY_PRINT_EOL(); + UNITY_OUTPUT_FLUSH(); return 1; } } diff --git a/src/unity.h b/src/unity.h index ab986c4b2..265e548d6 100644 --- a/src/unity.h +++ b/src/unity.h @@ -9,8 +9,8 @@ #define UNITY #define UNITY_VERSION_MAJOR 2 -#define UNITY_VERSION_MINOR 5 -#define UNITY_VERSION_BUILD 2 +#define UNITY_VERSION_MINOR 6 +#define UNITY_VERSION_BUILD 0 #define UNITY_VERSION ((UNITY_VERSION_MAJOR << 16) | (UNITY_VERSION_MINOR << 8) | UNITY_VERSION_BUILD) #ifdef __cplusplus @@ -89,7 +89,7 @@ void verifyTest(void); * - define UNITY_SUPPORT_TEST_CASES to include the TEST_CASE macro, though really it's mostly about the runner generator script * Parameterized Tests - * - you'll want to create a define of TEST_CASE(...) which basically evaluates to nothing + * - you'll want to create a define of TEST_CASE(...), TEST_RANGE(...) and/or TEST_MATRIX(...) which basically evaluates to nothing * Tests with Arguments * - you'll want to define UNITY_USE_COMMAND_LINE_ARGS if you have the test runner passing arguments to Unity @@ -105,17 +105,27 @@ void verifyTest(void); #define TEST_MESSAGE(message) UnityMessage((message), __LINE__) #define TEST_ONLY() #ifdef UNITY_INCLUDE_PRINT_FORMATTED -#define TEST_PRINTF(message, ...) UnityPrintF(__LINE__, (message), __VA_ARGS__) +#define TEST_PRINTF(message, ...) UnityPrintF(__LINE__, (message), ##__VA_ARGS__) #endif /* It is not necessary for you to call PASS. A PASS condition is assumed if nothing fails. * This method allows you to abort a test immediately with a PASS state, ignoring the remainder of the test. */ #define TEST_PASS() TEST_ABORT() -#define TEST_PASS_MESSAGE(message) do { UnityMessage((message), __LINE__); TEST_ABORT(); } while(0) +#define TEST_PASS_MESSAGE(message) do { UnityMessage((message), __LINE__); TEST_ABORT(); } while (0) -/* This macro does nothing, but it is useful for build tools (like Ceedling) to make use of this to figure out - * which files should be linked to in order to perform a test. Use it like TEST_FILE("sandwiches.c") */ -#define TEST_FILE(a) +/*------------------------------------------------------- + * Build Directives + *------------------------------------------------------- + + * These macros do nothing, but they are useful for additional build context. + * Tools (like Ceedling) can scan for these directives and make use of them for + * per-test-executable #include search paths and linking. */ + +/* Add source files to a test executable's compilation and linking. Ex: TEST_SOURCE_FILE("sandwiches.c") */ +#define TEST_SOURCE_FILE(a) + +/* Customize #include search paths for a test executable's compilation. Ex: TEST_INCLUDE_PATH("src/module_a/inc") */ +#define TEST_INCLUDE_PATH(a) /*------------------------------------------------------- * Test Asserts (simple) @@ -337,9 +347,16 @@ void verifyTest(void); /* Floating Point (If Enabled) */ #define TEST_ASSERT_FLOAT_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_FLOAT_WITHIN((delta), (expected), (actual), __LINE__, NULL) +#define TEST_ASSERT_FLOAT_NOT_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_FLOAT_NOT_WITHIN((delta), (expected), (actual), __LINE__, NULL) #define TEST_ASSERT_EQUAL_FLOAT(expected, actual) UNITY_TEST_ASSERT_EQUAL_FLOAT((expected), (actual), __LINE__, NULL) +#define TEST_ASSERT_NOT_EQUAL_FLOAT(expected, actual) UNITY_TEST_ASSERT_NOT_EQUAL_FLOAT((expected), (actual), __LINE__, NULL) +#define TEST_ASSERT_FLOAT_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_FLOAT_ARRAY_WITHIN((delta), (expected), (actual), (num_elements), __LINE__, NULL) #define TEST_ASSERT_EQUAL_FLOAT_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_FLOAT_ARRAY((expected), (actual), (num_elements), __LINE__, NULL) #define TEST_ASSERT_EACH_EQUAL_FLOAT(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_FLOAT((expected), (actual), (num_elements), __LINE__, NULL) +#define TEST_ASSERT_GREATER_THAN_FLOAT(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_FLOAT((threshold), (actual), __LINE__, NULL) +#define TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_FLOAT((threshold), (actual), __LINE__, NULL) +#define TEST_ASSERT_LESS_THAN_FLOAT(threshold, actual) UNITY_TEST_ASSERT_LESS_THAN_FLOAT((threshold), (actual), __LINE__, NULL) +#define TEST_ASSERT_LESS_OR_EQUAL_FLOAT(threshold, actual) UNITY_TEST_ASSERT_LESS_OR_EQUAL_FLOAT((threshold), (actual), __LINE__, NULL) #define TEST_ASSERT_FLOAT_IS_INF(actual) UNITY_TEST_ASSERT_FLOAT_IS_INF((actual), __LINE__, NULL) #define TEST_ASSERT_FLOAT_IS_NEG_INF(actual) UNITY_TEST_ASSERT_FLOAT_IS_NEG_INF((actual), __LINE__, NULL) #define TEST_ASSERT_FLOAT_IS_NAN(actual) UNITY_TEST_ASSERT_FLOAT_IS_NAN((actual), __LINE__, NULL) @@ -351,9 +368,16 @@ void verifyTest(void); /* Double (If Enabled) */ #define TEST_ASSERT_DOUBLE_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_DOUBLE_WITHIN((delta), (expected), (actual), __LINE__, NULL) +#define TEST_ASSERT_DOUBLE_NOT_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_DOUBLE_NOT_WITHIN((delta), (expected), (actual), __LINE__, NULL) #define TEST_ASSERT_EQUAL_DOUBLE(expected, actual) UNITY_TEST_ASSERT_EQUAL_DOUBLE((expected), (actual), __LINE__, NULL) +#define TEST_ASSERT_NOT_EQUAL_DOUBLE(expected, actual) UNITY_TEST_ASSERT_NOT_EQUAL_DOUBLE((expected), (actual), __LINE__, NULL) +#define TEST_ASSERT_DOUBLE_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_DOUBLE_ARRAY_WITHIN((delta), (expected), (actual), (num_elements), __LINE__, NULL) #define TEST_ASSERT_EQUAL_DOUBLE_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_DOUBLE_ARRAY((expected), (actual), (num_elements), __LINE__, NULL) #define TEST_ASSERT_EACH_EQUAL_DOUBLE(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_DOUBLE((expected), (actual), (num_elements), __LINE__, NULL) +#define TEST_ASSERT_GREATER_THAN_DOUBLE(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_DOUBLE((threshold), (actual), __LINE__, NULL) +#define TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE((threshold), (actual), __LINE__, NULL) +#define TEST_ASSERT_LESS_THAN_DOUBLE(threshold, actual) UNITY_TEST_ASSERT_LESS_THAN_DOUBLE((threshold), (actual), __LINE__, NULL) +#define TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(threshold, actual) UNITY_TEST_ASSERT_LESS_OR_EQUAL_DOUBLE((threshold), (actual), __LINE__, NULL) #define TEST_ASSERT_DOUBLE_IS_INF(actual) UNITY_TEST_ASSERT_DOUBLE_IS_INF((actual), __LINE__, NULL) #define TEST_ASSERT_DOUBLE_IS_NEG_INF(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NEG_INF((actual), __LINE__, NULL) #define TEST_ASSERT_DOUBLE_IS_NAN(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NAN((actual), __LINE__, NULL) @@ -607,8 +631,14 @@ void verifyTest(void); /* Floating Point (If Enabled) */ #define TEST_ASSERT_FLOAT_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_FLOAT_WITHIN((delta), (expected), (actual), __LINE__, (message)) #define TEST_ASSERT_EQUAL_FLOAT_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_FLOAT((expected), (actual), __LINE__, (message)) +#define TEST_ASSERT_NOT_EQUAL_FLOAT_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_NOT_EQUAL_FLOAT((expected), (actual), __LINE__, (message)) +#define TEST_ASSERT_FLOAT_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_FLOAT_ARRAY_WITHIN((delta), (expected), (actual), (num_elements), __LINE__, (message)) #define TEST_ASSERT_EQUAL_FLOAT_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_FLOAT_ARRAY((expected), (actual), (num_elements), __LINE__, (message)) #define TEST_ASSERT_EACH_EQUAL_FLOAT_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_FLOAT((expected), (actual), (num_elements), __LINE__, (message)) +#define TEST_ASSERT_GREATER_THAN_FLOAT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_FLOAT((threshold), (actual), __LINE__, (message)) +#define TEST_ASSERT_GREATER_OR_EQUAL_FLOAT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_FLOAT((threshold), (actual), __LINE__, (message)) +#define TEST_ASSERT_LESS_THAN_FLOAT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_LESS_THAN_FLOAT((threshold), (actual), __LINE__, (message)) +#define TEST_ASSERT_LESS_OR_EQUAL_FLOAT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_LESS_OR_EQUAL_FLOAT((threshold), (actual), __LINE__, (message)) #define TEST_ASSERT_FLOAT_IS_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_FLOAT_IS_INF((actual), __LINE__, (message)) #define TEST_ASSERT_FLOAT_IS_NEG_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_FLOAT_IS_NEG_INF((actual), __LINE__, (message)) #define TEST_ASSERT_FLOAT_IS_NAN_MESSAGE(actual, message) UNITY_TEST_ASSERT_FLOAT_IS_NAN((actual), __LINE__, (message)) @@ -621,8 +651,14 @@ void verifyTest(void); /* Double (If Enabled) */ #define TEST_ASSERT_DOUBLE_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_DOUBLE_WITHIN((delta), (expected), (actual), __LINE__, (message)) #define TEST_ASSERT_EQUAL_DOUBLE_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_DOUBLE((expected), (actual), __LINE__, (message)) +#define TEST_ASSERT_NOT_EQUAL_DOUBLE_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_NOT_EQUAL_DOUBLE((expected), (actual), __LINE__, (message)) +#define TEST_ASSERT_DOUBLE_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_DOUBLE_ARRAY_WITHIN((delta), (expected), (actual), (num_elements), __LINE__, (message)) #define TEST_ASSERT_EQUAL_DOUBLE_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_DOUBLE_ARRAY((expected), (actual), (num_elements), __LINE__, (message)) #define TEST_ASSERT_EACH_EQUAL_DOUBLE_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_DOUBLE((expected), (actual), (num_elements), __LINE__, (message)) +#define TEST_ASSERT_GREATER_THAN_DOUBLE_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_DOUBLE((threshold), (actual), __LINE__, (message)) +#define TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE((threshold), (actual), __LINE__, (message)) +#define TEST_ASSERT_LESS_THAN_DOUBLE_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_LESS_THAN_DOUBLE((threshold), (actual), __LINE__, (message)) +#define TEST_ASSERT_LESS_OR_EQUAL_DOUBLE_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_LESS_OR_EQUAL_DOUBLE((threshold), (actual), __LINE__, (message)) #define TEST_ASSERT_DOUBLE_IS_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_INF((actual), __LINE__, (message)) #define TEST_ASSERT_DOUBLE_IS_NEG_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NEG_INF((actual), __LINE__, (message)) #define TEST_ASSERT_DOUBLE_IS_NAN_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NAN((actual), __LINE__, (message)) diff --git a/src/unity_internals.h b/src/unity_internals.h index 79c305e9b..65938ff76 100644 --- a/src/unity_internals.h +++ b/src/unity_internals.h @@ -40,10 +40,44 @@ #include #endif -#if defined __GNUC__ -# define UNITY_FUNCTION_ATTR(a) __attribute__((a)) +#if defined(__GNUC__) || defined(__clang__) + #define UNITY_FUNCTION_ATTR(a) __attribute__((a)) #else -# define UNITY_FUNCTION_ATTR(a) /* ignore */ + #define UNITY_FUNCTION_ATTR(a) /* ignore */ +#endif + +#ifndef UNITY_NORETURN + #if defined(__cplusplus) + #if __cplusplus >= 201103L + #define UNITY_NORETURN [[ noreturn ]] + #endif + #elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L + #if defined(_WIN32) && defined(_MSC_VER) + /* We are using MSVC compiler on Windows platform. */ + /* Not all Windows SDKs supports , but compiler can support C11: */ + /* https://devblogs.microsoft.com/cppblog/c11-and-c17-standard-support-arriving-in-msvc/ */ + /* Not sure, that Mingw compilers has Windows SDK headers at all. */ + #include + #endif + + /* Using Windows SDK predefined macro for detecting supported SDK with MSVC compiler. */ + /* Mingw GCC should work without that fixes. */ + /* Based on: */ + /* https://docs.microsoft.com/en-us/cpp/porting/modifying-winver-and-win32-winnt?view=msvc-170 */ + /* NTDDI_WIN10_FE is equal to Windows 10 SDK 2104 */ + #if defined(_MSC_VER) && ((!defined(NTDDI_WIN10_FE)) || WDK_NTDDI_VERSION < NTDDI_WIN10_FE) + /* Based on tests and: */ + /* https://docs.microsoft.com/en-us/cpp/c-language/noreturn?view=msvc-170 */ + /* https://en.cppreference.com/w/c/language/_Noreturn */ + #define UNITY_NORETURN _Noreturn + #else /* Using newer Windows SDK or not MSVC compiler */ + #include + #define UNITY_NORETURN noreturn + #endif + #endif +#endif +#ifndef UNITY_NORETURN + #define UNITY_NORETURN UNITY_FUNCTION_ATTR(__noreturn__) #endif /*------------------------------------------------------- @@ -180,6 +214,8 @@ #define UNITY_INTERNAL_PTR UNITY_PTR_ATTRIBUTE const void* #endif +/* optionally define UNITY_COMPARE_PTRS_ON_ZERO_ARRAY */ + /*------------------------------------------------------- * Float Support *-------------------------------------------------------*/ @@ -205,16 +241,25 @@ #endif typedef UNITY_FLOAT_TYPE UNITY_FLOAT; -/* isinf & isnan macros should be provided by math.h */ -#ifndef isinf -/* The value of Inf - Inf is NaN */ -#define isinf(n) (isnan((n) - (n)) && !isnan(n)) -#endif - +/* isnan macro should be provided by math.h. Override if not macro */ +#ifndef UNITY_IS_NAN #ifndef isnan /* NaN is the only floating point value that does NOT equal itself. * Therefore if n != n, then it is NaN. */ -#define isnan(n) ((n != n) ? 1 : 0) +#define UNITY_IS_NAN(n) ((n != n) ? 1 : 0) +#else +#define UNITY_IS_NAN(n) isnan(n) +#endif +#endif + +/* isinf macro should be provided by math.h. Override if not macro */ +#ifndef UNITY_IS_INF +#ifndef isinf +/* The value of Inf - Inf is NaN */ +#define UNITY_IS_INF(n) (UNITY_IS_NAN((n) - (n)) && !UNITY_IS_NAN(n)) +#else +#define UNITY_IS_INF(n) isinf(n) +#endif #endif #endif @@ -273,10 +318,10 @@ typedef UNITY_FLOAT_TYPE UNITY_FLOAT; #ifdef UNITY_USE_FLUSH_STDOUT /* We want to use the stdout flush utility */ #include - #define UNITY_OUTPUT_FLUSH() (void)fflush(stdout) + #define UNITY_OUTPUT_FLUSH() (void)fflush(stdout) #else /* We've specified nothing, therefore flush should just be ignored */ - #define UNITY_OUTPUT_FLUSH() + #define UNITY_OUTPUT_FLUSH() (void)0 #endif #else /* If defined as something else, make sure we declare it here so it's ready for use */ @@ -288,11 +333,11 @@ typedef UNITY_FLOAT_TYPE UNITY_FLOAT; #ifndef UNITY_OUTPUT_FLUSH #define UNITY_FLUSH_CALL() #else -#define UNITY_FLUSH_CALL() UNITY_OUTPUT_FLUSH() +#define UNITY_FLUSH_CALL() UNITY_OUTPUT_FLUSH() #endif #ifndef UNITY_PRINT_EOL -#define UNITY_PRINT_EOL() UNITY_OUTPUT_CHAR('\n') +#define UNITY_PRINT_EOL() UNITY_OUTPUT_CHAR('\n') #endif #ifndef UNITY_OUTPUT_START @@ -333,7 +378,7 @@ typedef UNITY_FLOAT_TYPE UNITY_FLOAT; UnityPrintNumberUnsigned(execTimeMs); \ UnityPrint(" ms)"); \ } - #elif defined(__unix__) + #elif defined(__unix__) || defined(__APPLE__) #include #define UNITY_TIME_TYPE struct timespec #define UNITY_GET_TIME(t) clock_gettime(CLOCK_MONOTONIC, &t) @@ -351,19 +396,19 @@ typedef UNITY_FLOAT_TYPE UNITY_FLOAT; #endif #ifndef UNITY_EXEC_TIME_START -#define UNITY_EXEC_TIME_START() do{}while(0) +#define UNITY_EXEC_TIME_START() do { /* nothing*/ } while (0) #endif #ifndef UNITY_EXEC_TIME_STOP -#define UNITY_EXEC_TIME_STOP() do{}while(0) +#define UNITY_EXEC_TIME_STOP() do { /* nothing*/ } while (0) #endif #ifndef UNITY_TIME_TYPE -#define UNITY_TIME_TYPE UNITY_UINT +#define UNITY_TIME_TYPE UNITY_UINT #endif #ifndef UNITY_PRINT_EXEC_TIME -#define UNITY_PRINT_EXEC_TIME() do{}while(0) +#define UNITY_PRINT_EXEC_TIME() do { /* nothing*/ } while (0) #endif /*------------------------------------------------------- @@ -502,9 +547,9 @@ void UnityDefaultTestRun(UnityTestFunction Func, const char* FuncName, const int #define UNITY_SET_DETAIL(d1) #define UNITY_SET_DETAILS(d1,d2) #else -#define UNITY_CLR_DETAILS() { Unity.CurrentDetail1 = 0; Unity.CurrentDetail2 = 0; } -#define UNITY_SET_DETAIL(d1) { Unity.CurrentDetail1 = (d1); Unity.CurrentDetail2 = 0; } -#define UNITY_SET_DETAILS(d1,d2) { Unity.CurrentDetail1 = (d1); Unity.CurrentDetail2 = (d2); } +#define UNITY_CLR_DETAILS() do { Unity.CurrentDetail1 = 0; Unity.CurrentDetail2 = 0; } while (0) +#define UNITY_SET_DETAIL(d1) do { Unity.CurrentDetail1 = (d1); Unity.CurrentDetail2 = 0; } while (0) +#define UNITY_SET_DETAILS(d1,d2) do { Unity.CurrentDetail1 = (d1); Unity.CurrentDetail2 = (d2); } while (0) #ifndef UNITY_DETAIL1_NAME #define UNITY_DETAIL1_NAME "Function" @@ -618,8 +663,8 @@ void UnityAssertNumbersArrayWithin(const UNITY_UINT delta, const UNITY_FLAGS_T flags); #ifndef UNITY_EXCLUDE_SETJMP_H -void UnityFail(const char* message, const UNITY_LINE_TYPE line) UNITY_FUNCTION_ATTR(noreturn); -void UnityIgnore(const char* message, const UNITY_LINE_TYPE line) UNITY_FUNCTION_ATTR(noreturn); +UNITY_NORETURN void UnityFail(const char* message, const UNITY_LINE_TYPE line); +UNITY_NORETURN void UnityIgnore(const char* message, const UNITY_LINE_TYPE line); #else void UnityFail(const char* message, const UNITY_LINE_TYPE line); void UnityIgnore(const char* message, const UNITY_LINE_TYPE line); @@ -634,12 +679,25 @@ void UnityAssertFloatsWithin(const UNITY_FLOAT delta, const char* msg, const UNITY_LINE_TYPE lineNumber); -void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected, - UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual, - const UNITY_UINT32 num_elements, +void UnityAssertFloatsNotWithin(const UNITY_FLOAT delta, + const UNITY_FLOAT expected, + const UNITY_FLOAT actual, const char* msg, - const UNITY_LINE_TYPE lineNumber, - const UNITY_FLAGS_T flags); + const UNITY_LINE_TYPE lineNumber); + +void UnityAssertGreaterOrLessFloat(const UNITY_FLOAT threshold, + const UNITY_FLOAT actual, + const UNITY_COMPARISON_T compare, + const char* msg, + const UNITY_LINE_TYPE linenumber); + +void UnityAssertWithinFloatArray(const UNITY_FLOAT delta, + UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected, + UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual, + const UNITY_UINT32 num_elements, + const char* msg, + const UNITY_LINE_TYPE lineNumber, + const UNITY_FLAGS_T flags); void UnityAssertFloatSpecial(const UNITY_FLOAT actual, const char* msg, @@ -654,12 +712,25 @@ void UnityAssertDoublesWithin(const UNITY_DOUBLE delta, const char* msg, const UNITY_LINE_TYPE lineNumber); -void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected, - UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual, - const UNITY_UINT32 num_elements, +void UnityAssertDoublesNotWithin(const UNITY_DOUBLE delta, + const UNITY_DOUBLE expected, + const UNITY_DOUBLE actual, const char* msg, - const UNITY_LINE_TYPE lineNumber, - const UNITY_FLAGS_T flags); + const UNITY_LINE_TYPE lineNumber); + +void UnityAssertGreaterOrLessDouble(const UNITY_DOUBLE threshold, + const UNITY_DOUBLE actual, + const UNITY_COMPARISON_T compare, + const char* msg, + const UNITY_LINE_TYPE linenumber); + +void UnityAssertWithinDoubleArray(const UNITY_DOUBLE delta, + UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected, + UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual, + const UNITY_UINT32 num_elements, + const char* msg, + const UNITY_LINE_TYPE lineNumber, + const UNITY_FLAGS_T flags); void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual, const char* msg, @@ -697,27 +768,58 @@ extern const char UnityStrErrShorthand[]; * Test Running Macros *-------------------------------------------------------*/ +#ifdef UNITY_TEST_PROTECT +#define TEST_PROTECT() UNITY_TEST_PROTECT() +#else #ifndef UNITY_EXCLUDE_SETJMP_H #define TEST_PROTECT() (setjmp(Unity.AbortFrame) == 0) -#define TEST_ABORT() longjmp(Unity.AbortFrame, 1) #else #define TEST_PROTECT() 1 +#endif +#endif + +#ifdef UNITY_TEST_ABORT +#define TEST_ABORT() UNITY_TEST_ABORT() +#else +#ifndef UNITY_EXCLUDE_SETJMP_H +#define TEST_ABORT() longjmp(Unity.AbortFrame, 1) +#else #define TEST_ABORT() return #endif +#endif + +/* Automatically enable variadic macros support, if it not enabled before */ +#ifndef UNITY_SUPPORT_VARIADIC_MACROS + #ifdef __STDC_VERSION__ + #if __STDC_VERSION__ >= 199901L + #define UNITY_SUPPORT_VARIADIC_MACROS + #endif + #endif +#endif /* This tricky series of macros gives us an optional line argument to treat it as RUN_TEST(func, num=__LINE__) */ #ifndef RUN_TEST -#ifdef __STDC_VERSION__ -#if __STDC_VERSION__ >= 199901L -#define UNITY_SUPPORT_VARIADIC_MACROS -#endif -#endif #ifdef UNITY_SUPPORT_VARIADIC_MACROS #define RUN_TEST(...) RUN_TEST_AT_LINE(__VA_ARGS__, __LINE__, throwaway) #define RUN_TEST_AT_LINE(func, line, ...) UnityDefaultTestRun(func, #func, line) #endif #endif +/* Enable default macros for masking param tests test cases */ +#ifdef UNITY_SUPPORT_TEST_CASES + #ifdef UNITY_SUPPORT_VARIADIC_MACROS + #if !defined(TEST_CASE) && !defined(UNITY_EXCLUDE_TEST_CASE) + #define TEST_CASE(...) + #endif + #if !defined(TEST_RANGE) && !defined(UNITY_EXCLUDE_TEST_RANGE) + #define TEST_RANGE(...) + #endif + #if !defined(TEST_MATRIX) && !defined(UNITY_EXCLUDE_TEST_MATRIX) + #define TEST_MATRIX(...) + #endif + #endif +#endif + /* If we can't do the tricky version, we'll just have to require them to always include the line number */ #ifndef RUN_TEST #ifdef CMOCK @@ -772,7 +874,7 @@ int UnityTestMatches(void); * Test Asserts *-------------------------------------------------------*/ -#define UNITY_TEST_ASSERT(condition, line, message) do {if (condition) {} else {UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), (message));}} while(0) +#define UNITY_TEST_ASSERT(condition, line, message) do { if (condition) { /* nothing*/ } else { UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), (message)); } } while (0) #define UNITY_TEST_ASSERT_NULL(pointer, line, message) UNITY_TEST_ASSERT(((pointer) == NULL), (UNITY_LINE_TYPE)(line), (message)) #define UNITY_TEST_ASSERT_NOT_NULL(pointer, line, message) UNITY_TEST_ASSERT(((pointer) != NULL), (UNITY_LINE_TYPE)(line), (message)) #define UNITY_TEST_ASSERT_EMPTY(pointer, line, message) UNITY_TEST_ASSERT(((pointer[0]) == 0), (UNITY_LINE_TYPE)(line), (message)) @@ -875,7 +977,7 @@ int UnityTestMatches(void); #define UNITY_TEST_ASSERT_INT16_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertNumbersArrayWithin((UNITY_UINT16)(delta), (UNITY_INTERNAL_PTR)(expected), (UNITY_INTERNAL_PTR)(actual), ((UNITY_UINT32)(num_elements)), (message), (UNITY_LINE_TYPE)(line), UNITY_DISPLAY_STYLE_INT16, UNITY_ARRAY_TO_ARRAY) #define UNITY_TEST_ASSERT_INT32_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertNumbersArrayWithin((UNITY_UINT32)(delta), (UNITY_INTERNAL_PTR)(expected), (UNITY_INTERNAL_PTR)(actual), ((UNITY_UINT32)(num_elements)), (message), (UNITY_LINE_TYPE)(line), UNITY_DISPLAY_STYLE_INT32, UNITY_ARRAY_TO_ARRAY) #define UNITY_TEST_ASSERT_UINT_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertNumbersArrayWithin( (delta), (UNITY_INTERNAL_PTR)(expected), (UNITY_INTERNAL_PTR)(actual), ((UNITY_UINT32)(num_elements)), (message), (UNITY_LINE_TYPE)(line), UNITY_DISPLAY_STYLE_UINT, UNITY_ARRAY_TO_ARRAY) -#define UNITY_TEST_ASSERT_UINT8_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertNumbersArrayWithin( (UNITY_UINT16)(delta), (UNITY_INTERNAL_PTR)(expected), (UNITY_INTERNAL_PTR)(actual), ((UNITY_UINT32)(num_elements)), (message), (UNITY_LINE_TYPE)(line), UNITY_DISPLAY_STYLE_UINT8, UNITY_ARRAY_TO_ARRAY) +#define UNITY_TEST_ASSERT_UINT8_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertNumbersArrayWithin((UNITY_UINT8 )(delta), (UNITY_INTERNAL_PTR)(expected), (UNITY_INTERNAL_PTR)(actual), ((UNITY_UINT32)(num_elements)), (message), (UNITY_LINE_TYPE)(line), UNITY_DISPLAY_STYLE_UINT8, UNITY_ARRAY_TO_ARRAY) #define UNITY_TEST_ASSERT_UINT16_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertNumbersArrayWithin((UNITY_UINT16)(delta), (UNITY_INTERNAL_PTR)(expected), (UNITY_INTERNAL_PTR)(actual), ((UNITY_UINT32)(num_elements)), (message), (UNITY_LINE_TYPE)(line), UNITY_DISPLAY_STYLE_UINT16, UNITY_ARRAY_TO_ARRAY) #define UNITY_TEST_ASSERT_UINT32_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertNumbersArrayWithin((UNITY_UINT32)(delta), (UNITY_INTERNAL_PTR)(expected), (UNITY_INTERNAL_PTR)(actual), ((UNITY_UINT32)(num_elements)), (message), (UNITY_LINE_TYPE)(line), UNITY_DISPLAY_STYLE_UINT32, UNITY_ARRAY_TO_ARRAY) #define UNITY_TEST_ASSERT_HEX8_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertNumbersArrayWithin((UNITY_UINT8 )(delta), (UNITY_INTERNAL_PTR)(expected), (UNITY_INTERNAL_PTR)(actual), ((UNITY_UINT32)(num_elements)), (message), (UNITY_LINE_TYPE)(line), UNITY_DISPLAY_STYLE_HEX8, UNITY_ARRAY_TO_ARRAY) @@ -981,9 +1083,16 @@ int UnityTestMatches(void); #ifdef UNITY_EXCLUDE_FLOAT #define UNITY_TEST_ASSERT_FLOAT_WITHIN(delta, expected, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) +#define UNITY_TEST_ASSERT_FLOAT_NOT_WITHIN(delta, expected, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) #define UNITY_TEST_ASSERT_EQUAL_FLOAT(expected, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) +#define UNITY_TEST_ASSERT_NOT_EQUAL_FLOAT(expected, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) +#define UNITY_TEST_ASSERT_FLOAT_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) #define UNITY_TEST_ASSERT_EQUAL_FLOAT_ARRAY(expected, actual, num_elements, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) #define UNITY_TEST_ASSERT_EACH_EQUAL_FLOAT(expected, actual, num_elements, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) +#define UNITY_TEST_ASSERT_GREATER_THAN_FLOAT(threshold, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) +#define UNITY_TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(threshold, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) +#define UNITY_TEST_ASSERT_LESS_THAN_FLOAT(threshold, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) +#define UNITY_TEST_ASSERT_LESS_OR_EQUAL_FLOAT(threshold, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) #define UNITY_TEST_ASSERT_FLOAT_IS_INF(actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) #define UNITY_TEST_ASSERT_FLOAT_IS_NEG_INF(actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) #define UNITY_TEST_ASSERT_FLOAT_IS_NAN(actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) @@ -994,9 +1103,16 @@ int UnityTestMatches(void); #define UNITY_TEST_ASSERT_FLOAT_IS_NOT_DETERMINATE(actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrFloat) #else #define UNITY_TEST_ASSERT_FLOAT_WITHIN(delta, expected, actual, line, message) UnityAssertFloatsWithin((UNITY_FLOAT)(delta), (UNITY_FLOAT)(expected), (UNITY_FLOAT)(actual), (message), (UNITY_LINE_TYPE)(line)) +#define UNITY_TEST_ASSERT_FLOAT_NOT_WITHIN(delta, expected, actual, line, message) UnityAssertFloatsNotWithin((UNITY_FLOAT)(delta), (UNITY_FLOAT)(expected), (UNITY_FLOAT)(actual), (message), (UNITY_LINE_TYPE)(line)) #define UNITY_TEST_ASSERT_EQUAL_FLOAT(expected, actual, line, message) UNITY_TEST_ASSERT_FLOAT_WITHIN((UNITY_FLOAT)(expected) * (UNITY_FLOAT)UNITY_FLOAT_PRECISION, (UNITY_FLOAT)(expected), (UNITY_FLOAT)(actual), (UNITY_LINE_TYPE)(line), (message)) -#define UNITY_TEST_ASSERT_EQUAL_FLOAT_ARRAY(expected, actual, num_elements, line, message) UnityAssertEqualFloatArray((UNITY_FLOAT*)(expected), (UNITY_FLOAT*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_ARRAY) -#define UNITY_TEST_ASSERT_EACH_EQUAL_FLOAT(expected, actual, num_elements, line, message) UnityAssertEqualFloatArray(UnityFloatToPtr(expected), (UNITY_FLOAT*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_VAL) +#define UNITY_TEST_ASSERT_NOT_EQUAL_FLOAT(expected, actual, line, message) UNITY_TEST_ASSERT_FLOAT_NOT_WITHIN((UNITY_FLOAT)(expected) * (UNITY_FLOAT)UNITY_FLOAT_PRECISION, (UNITY_FLOAT)(expected), (UNITY_FLOAT)(actual), (UNITY_LINE_TYPE)(line), (message)) +#define UNITY_TEST_ASSERT_FLOAT_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertWithinFloatArray((UNITY_FLOAT)(delta), (const UNITY_FLOAT*)(expected), (const UNITY_FLOAT*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_ARRAY) +#define UNITY_TEST_ASSERT_EQUAL_FLOAT_ARRAY(expected, actual, num_elements, line, message) UnityAssertWithinFloatArray((UNITY_FLOAT)0, (const UNITY_FLOAT*)(expected), (const UNITY_FLOAT*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_ARRAY) +#define UNITY_TEST_ASSERT_EACH_EQUAL_FLOAT(expected, actual, num_elements, line, message) UnityAssertWithinFloatArray((UNITY_FLOAT)0, UnityFloatToPtr(expected), (const UNITY_FLOAT*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_VAL) +#define UNITY_TEST_ASSERT_GREATER_THAN_FLOAT(threshold, actual, line, message) UnityAssertGreaterOrLessFloat((UNITY_FLOAT)(threshold), (UNITY_FLOAT)(actual), UNITY_GREATER_THAN, (message), (UNITY_LINE_TYPE)(line)) +#define UNITY_TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(threshold, actual, line, message) UnityAssertGreaterOrLessFloat((UNITY_FLOAT)(threshold), (UNITY_FLOAT)(actual), UNITY_GREATER_OR_EQUAL, (message), (UNITY_LINE_TYPE)(line)) +#define UNITY_TEST_ASSERT_LESS_THAN_FLOAT(threshold, actual, line, message) UnityAssertGreaterOrLessFloat((UNITY_FLOAT)(threshold), (UNITY_FLOAT)(actual), UNITY_SMALLER_THAN, (message), (UNITY_LINE_TYPE)(line)) +#define UNITY_TEST_ASSERT_LESS_OR_EQUAL_FLOAT(threshold, actual, line, message) UnityAssertGreaterOrLessFloat((UNITY_FLOAT)(threshold), (UNITY_FLOAT)(actual), UNITY_SMALLER_OR_EQUAL, (message), (UNITY_LINE_TYPE)(line)) #define UNITY_TEST_ASSERT_FLOAT_IS_INF(actual, line, message) UnityAssertFloatSpecial((UNITY_FLOAT)(actual), (message), (UNITY_LINE_TYPE)(line), UNITY_FLOAT_IS_INF) #define UNITY_TEST_ASSERT_FLOAT_IS_NEG_INF(actual, line, message) UnityAssertFloatSpecial((UNITY_FLOAT)(actual), (message), (UNITY_LINE_TYPE)(line), UNITY_FLOAT_IS_NEG_INF) #define UNITY_TEST_ASSERT_FLOAT_IS_NAN(actual, line, message) UnityAssertFloatSpecial((UNITY_FLOAT)(actual), (message), (UNITY_LINE_TYPE)(line), UNITY_FLOAT_IS_NAN) @@ -1009,9 +1125,16 @@ int UnityTestMatches(void); #ifdef UNITY_EXCLUDE_DOUBLE #define UNITY_TEST_ASSERT_DOUBLE_WITHIN(delta, expected, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) +#define UNITY_TEST_ASSERT_DOUBLE_NOT_WITHIN(delta, expected, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) #define UNITY_TEST_ASSERT_EQUAL_DOUBLE(expected, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) +#define UNITY_TEST_ASSERT_NOT_EQUAL_DOUBLE(expected, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) +#define UNITY_TEST_ASSERT_DOUBLE_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) #define UNITY_TEST_ASSERT_EQUAL_DOUBLE_ARRAY(expected, actual, num_elements, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) #define UNITY_TEST_ASSERT_EACH_EQUAL_DOUBLE(expected, actual, num_elements, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) +#define UNITY_TEST_ASSERT_GREATER_THAN_DOUBLE(threshold, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) +#define UNITY_TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(threshold, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) +#define UNITY_TEST_ASSERT_LESS_THAN_DOUBLE(threshold, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) +#define UNITY_TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(threshold, actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) #define UNITY_TEST_ASSERT_DOUBLE_IS_INF(actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) #define UNITY_TEST_ASSERT_DOUBLE_IS_NEG_INF(actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) #define UNITY_TEST_ASSERT_DOUBLE_IS_NAN(actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) @@ -1022,9 +1145,16 @@ int UnityTestMatches(void); #define UNITY_TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE(actual, line, message) UNITY_TEST_FAIL((UNITY_LINE_TYPE)(line), UnityStrErrDouble) #else #define UNITY_TEST_ASSERT_DOUBLE_WITHIN(delta, expected, actual, line, message) UnityAssertDoublesWithin((UNITY_DOUBLE)(delta), (UNITY_DOUBLE)(expected), (UNITY_DOUBLE)(actual), (message), (UNITY_LINE_TYPE)(line)) +#define UNITY_TEST_ASSERT_DOUBLE_NOT_WITHIN(delta, expected, actual, line, message) UnityAssertDoublesNotWithin((UNITY_DOUBLE)(delta), (UNITY_DOUBLE)(expected), (UNITY_DOUBLE)(actual), (message), (UNITY_LINE_TYPE)(line)) #define UNITY_TEST_ASSERT_EQUAL_DOUBLE(expected, actual, line, message) UNITY_TEST_ASSERT_DOUBLE_WITHIN((UNITY_DOUBLE)(expected) * (UNITY_DOUBLE)UNITY_DOUBLE_PRECISION, (UNITY_DOUBLE)(expected), (UNITY_DOUBLE)(actual), (UNITY_LINE_TYPE)(line), (message)) -#define UNITY_TEST_ASSERT_EQUAL_DOUBLE_ARRAY(expected, actual, num_elements, line, message) UnityAssertEqualDoubleArray((UNITY_DOUBLE*)(expected), (UNITY_DOUBLE*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_ARRAY) -#define UNITY_TEST_ASSERT_EACH_EQUAL_DOUBLE(expected, actual, num_elements, line, message) UnityAssertEqualDoubleArray(UnityDoubleToPtr(expected), (UNITY_DOUBLE*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_VAL) +#define UNITY_TEST_ASSERT_NOT_EQUAL_DOUBLE(expected, actual, line, message) UNITY_TEST_ASSERT_DOUBLE_NOT_WITHIN((UNITY_DOUBLE)(expected) * (UNITY_DOUBLE)UNITY_DOUBLE_PRECISION, (UNITY_DOUBLE)(expected), (UNITY_DOUBLE)(actual), (UNITY_LINE_TYPE)(line), (message)) +#define UNITY_TEST_ASSERT_DOUBLE_ARRAY_WITHIN(delta, expected, actual, num_elements, line, message) UnityAssertWithinDoubleArray((UNITY_DOUBLE)(delta), (const UNITY_DOUBLE*)(expected), (const UNITY_DOUBLE*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_ARRAY) +#define UNITY_TEST_ASSERT_EQUAL_DOUBLE_ARRAY(expected, actual, num_elements, line, message) UnityAssertWithinDoubleArray((UNITY_DOUBLE)0, (const UNITY_DOUBLE*)(expected), (const UNITY_DOUBLE*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_ARRAY) +#define UNITY_TEST_ASSERT_EACH_EQUAL_DOUBLE(expected, actual, num_elements, line, message) UnityAssertWithinDoubleArray((UNITY_DOUBLE)0, UnityDoubleToPtr(expected), (const UNITY_DOUBLE*)(actual), (UNITY_UINT32)(num_elements), (message), (UNITY_LINE_TYPE)(line), UNITY_ARRAY_TO_VAL) +#define UNITY_TEST_ASSERT_GREATER_THAN_DOUBLE(threshold, actual, line, message) UnityAssertGreaterOrLessDouble((UNITY_DOUBLE)(threshold), (UNITY_DOUBLE)(actual), UNITY_GREATER_THAN, (message), (UNITY_LINE_TYPE)(line)) +#define UNITY_TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(threshold, actual, line, message) UnityAssertGreaterOrLessDouble((UNITY_DOUBLE)(threshold), (UNITY_DOUBLE)(actual), UNITY_GREATER_OR_EQUAL, (message), (UNITY_LINE_TYPE)(line)) +#define UNITY_TEST_ASSERT_LESS_THAN_DOUBLE(threshold, actual, line, message) UnityAssertGreaterOrLessDouble((UNITY_DOUBLE)(threshold), (UNITY_DOUBLE)(actual), UNITY_SMALLER_THAN, (message), (UNITY_LINE_TYPE)(line)) +#define UNITY_TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(threshold, actual, line, message) UnityAssertGreaterOrLessDouble((UNITY_DOUBLE)(threshold), (UNITY_DOUBLE)(actual), UNITY_SMALLER_OR_EQUAL, (message), (UNITY_LINE_TYPE)(line)) #define UNITY_TEST_ASSERT_DOUBLE_IS_INF(actual, line, message) UnityAssertDoubleSpecial((UNITY_DOUBLE)(actual), (message), (UNITY_LINE_TYPE)(line), UNITY_FLOAT_IS_INF) #define UNITY_TEST_ASSERT_DOUBLE_IS_NEG_INF(actual, line, message) UnityAssertDoubleSpecial((UNITY_DOUBLE)(actual), (message), (UNITY_LINE_TYPE)(line), UNITY_FLOAT_IS_NEG_INF) #define UNITY_TEST_ASSERT_DOUBLE_IS_NAN(actual, line, message) UnityAssertDoubleSpecial((UNITY_DOUBLE)(actual), (message), (UNITY_LINE_TYPE)(line), UNITY_FLOAT_IS_NAN) diff --git a/test/.rubocop.yml b/test/.rubocop.yml index 6c9542f52..a3b811bd1 100644 --- a/test/.rubocop.yml +++ b/test/.rubocop.yml @@ -3,7 +3,7 @@ #inherit_from: .rubocop_todo.yml AllCops: - TargetRubyVersion: 2.3 + TargetRubyVersion: 3.0 # These are areas where ThrowTheSwitch's coding style diverges from the Ruby standard Style/SpecialGlobalVars: @@ -28,6 +28,8 @@ Style/EvalWithLocation: Enabled: false Style/MixinUsage: Enabled: false +Style/OptionalBooleanParameter: + Enabled: false # These are also places we diverge... but we will likely comply down the road Style/IfUnlessModifier: @@ -36,10 +38,12 @@ Style/FormatStringToken: Enabled: false # This is disabled because it seems to get confused over nested hashes -Layout/AlignHash: +Layout/HashAlignment: Enabled: false EnforcedHashRocketStyle: table EnforcedColonStyle: table +Layout/LineLength: + Enabled: false # We purposefully use these insecure features because they're what makes Ruby awesome Security/Eval: @@ -64,8 +68,6 @@ Metrics/ClassLength: Enabled: false Metrics/CyclomaticComplexity: Enabled: false -Metrics/LineLength: - Enabled: false Metrics/MethodLength: Enabled: false Metrics/ModuleLength: diff --git a/test/rakefile_helper.rb b/test/rakefile_helper.rb index 86789445a..1a9fc3342 100644 --- a/test/rakefile_helper.rb +++ b/test/rakefile_helper.rb @@ -4,11 +4,11 @@ # [Released under MIT License. Please refer to license.txt for details] # ========================================== -require 'yaml' require 'fileutils' require_relative '../auto/unity_test_summary' require_relative '../auto/generate_test_runner' require_relative '../auto/colour_reporter' +require_relative '../auto/yaml_helper' module RakefileHelpers C_EXTENSION = '.c'.freeze @@ -16,7 +16,7 @@ def load_configuration(config_file) return if $configured $cfg_file = "targets/#{config_file}" unless config_file =~ /[\\|\/]/ - $cfg = YAML.load(File.read($cfg_file)) + $cfg = YamlHelper.load_file($cfg_file) $colour_output = false unless $cfg['colour'] $configured = true if config_file != DEFAULT_CONFIG_FILE end @@ -173,7 +173,7 @@ def run_astyle(style_what) def execute(command_string, ok_to_fail = false) report command_string if $verbose output = `#{command_string}`.chomp - report(output) if $verbose && !output.nil? && !output.empty? + report(output) if ($verbose && !output.nil? && !output.empty?) || (!$?.nil? && !$?.exitstatus.zero? && !ok_to_fail) raise "Command failed. (Returned #{$?.exitstatus})" if !$?.nil? && !$?.exitstatus.zero? && !ok_to_fail output end diff --git a/test/targets/clang_strict.yml b/test/targets/clang_strict.yml index 04d568064..f124e8fdd 100644 --- a/test/targets/clang_strict.yml +++ b/test/targets/clang_strict.yml @@ -69,3 +69,4 @@ colour: true - UNITY_INCLUDE_DOUBLE - UNITY_SUPPORT_TEST_CASES - UNITY_SUPPORT_64 + - UNITY_COMPARE_PTRS_ON_ZERO_ARRAY diff --git a/test/testdata/Defs.h b/test/testdata/Defs.h index b1dc83e9b..58678c124 100644 --- a/test/testdata/Defs.h +++ b/test/testdata/Defs.h @@ -4,5 +4,6 @@ #define EXTERN_DECL extern int CounterSuiteSetup; +extern int isArgumentOne(int i); #endif diff --git a/test/testdata/testRunnerGenerator.c b/test/testdata/testRunnerGenerator.c index b5dd97f5d..475e24357 100644 --- a/test/testdata/testRunnerGenerator.c +++ b/test/testdata/testRunnerGenerator.c @@ -19,9 +19,6 @@ suitetest- custom prefix for when we want to use custom suite setup/teardown */ -/* Support for Meta Test Rig */ -#define TEST_CASE(a) - /* Include Passthroughs for Linking Tests */ void putcharSpy(int c) { (void)putchar(c);} void flushSpy(void) {} @@ -167,6 +164,17 @@ void paratest_ShouldHandleParameterizedTestsThatFail(int Num) TEST_ASSERT_EQUAL_MESSAGE(3, Num, "This call should fail"); } +int isArgumentOne(int i) +{ + return i == 1; +} + +TEST_CASE(isArgumentOne) +void paratest_WorksWithFunctionPointers(int function(int)) +{ + TEST_ASSERT_TRUE_MESSAGE(function(1), "Function should return True"); +} + #ifdef USE_CEXCEPTION void extest_ShouldHandleCExceptionInTest(void) { diff --git a/test/testdata/testRunnerGeneratorSmall.c b/test/testdata/testRunnerGeneratorSmall.c index c8aaf747e..58bc65c0d 100644 --- a/test/testdata/testRunnerGeneratorSmall.c +++ b/test/testdata/testRunnerGeneratorSmall.c @@ -4,16 +4,13 @@ #include "unity.h" #include "Defs.h" -TEST_FILE("some_file.c") +TEST_SOURCE_FILE("some_file.c") /* Notes about prefixes: test - normal default prefix. these are "always run" tests for this procedure spec - normal default prefix. required to run default setup/teardown calls. */ -/* Support for Meta Test Rig */ -#define TEST_CASE(a) - /* Include Passthroughs for Linking Tests */ void putcharSpy(int c) { (void)putchar(c);} void flushSpy(void) {} @@ -67,4 +64,3 @@ void spec_ThisTestPassesWhenNormalTeardownRan(void) { TEST_ASSERT_EQUAL_MESSAGE(1, CounterTeardown, "Normal Teardown Wasn't Run"); } - diff --git a/test/testdata/testRunnerGeneratorWithMocks.c b/test/testdata/testRunnerGeneratorWithMocks.c index aaceda446..d48692ede 100644 --- a/test/testdata/testRunnerGeneratorWithMocks.c +++ b/test/testdata/testRunnerGeneratorWithMocks.c @@ -20,9 +20,6 @@ suitetest- custom prefix for when we want to use custom suite setup/teardown */ -/* Support for Meta Test Rig */ -#define TEST_CASE(a) - /* Include Passthroughs for Linking Tests */ void putcharSpy(int c) { (void)putchar(c);} void flushSpy(void) {} @@ -194,4 +191,3 @@ void test_ShouldCallMockInitAndVerifyFunctionsForEachTest(void) TEST_ASSERT_EQUAL_MESSAGE(Unity.NumberOfTests - 1, mockMock_Destroy_Counter, "Mock Destroy Should Be Called Once Per Test Completed"); TEST_ASSERT_EQUAL_MESSAGE(0, CMockMemFreeFinalCounter, "Mock MemFreeFinal Should Not Be Called Until End"); } - diff --git a/test/tests/test_generate_test_runner.rb b/test/tests/test_generate_test_runner.rb index 809b4494c..229b6abb9 100644 --- a/test/tests/test_generate_test_runner.rb +++ b/test/tests/test_generate_test_runner.rb @@ -151,6 +151,7 @@ 'paratest_ShouldHandleParameterizedTests\(5\)', 'paratest_ShouldHandleParameterizedTests2\(7\)', 'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid', + 'paratest_WorksWithFunctionPointers\(isArgumentOne\)', ], :to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ], :to_ignore => [ ], @@ -168,6 +169,7 @@ 'paratest_ShouldHandleParameterizedTests\(5\)', 'paratest_ShouldHandleParameterizedTests2\(7\)', 'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid', + 'paratest_WorksWithFunctionPointers\(isArgumentOne\)', ], :to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ], :to_ignore => [ ], @@ -188,6 +190,7 @@ 'paratest_ShouldHandleParameterizedTests\(5\)', 'paratest_ShouldHandleParameterizedTests2\(7\)', 'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid', + 'paratest_WorksWithFunctionPointers\(isArgumentOne\)', ], :to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ], :to_ignore => [ ], @@ -1108,7 +1111,8 @@ 'paratest_ShouldHandleParameterizedTests\(5\)', 'paratest_ShouldHandleParameterizedTests2\(7\)', 'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid', - 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' + 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)', + 'paratest_WorksWithFunctionPointers\(isArgumentOne\)', ], } }, @@ -1154,7 +1158,41 @@ :to_pass => [ ], :to_fail => [ ], :to_ignore => [ ], - :text => [ "ERROR: Unknown Option z" ], + :text => [ + "ERROR: Unknown Option z", + "Options:", + "-l List all tests and exit", + "-f NAME Filter to run only tests whose name includes NAME", + "-n NAME \\(deprecated\\) alias of -f", + "-h show this Help menu", + "-q Quiet/decrease verbosity", + "-v increase Verbosity", + "-x NAME eXclude tests whose name includes NAME", + ], + } + }, + + { :name => 'ArgsHelp', + :testfile => 'testdata/testRunnerGenerator.c', + :testdefines => ['TEST', 'UNITY_USE_COMMAND_LINE_ARGS'], + :options => { + :cmdline_args => true, + }, + :cmdline_args => "-h", + :expected => { + :to_pass => [ ], + :to_fail => [ ], + :to_ignore => [ ], + :text => [ + "Options:", + "-l List all tests and exit", + "-f NAME Filter to run only tests whose name includes NAME", + "-n NAME \\(deprecated\\) alias of -f", + "-h show this Help menu", + "-q Quiet/decrease verbosity", + "-v increase Verbosity", + "-x NAME eXclude tests whose name includes NAME", + ], } }, ] diff --git a/test/tests/test_unity_arrays.c b/test/tests/test_unity_arrays.c index ff90a6c42..2151eef98 100644 --- a/test/tests/test_unity_arrays.c +++ b/test/tests/test_unity_arrays.c @@ -61,7 +61,7 @@ void testInt64ArrayWithinDeltaAndMessage(void) #endif } -void tesUInt64ArrayNotWithinDelta(void) +void testInt64ArrayNotWithinDelta(void) { #ifndef UNITY_SUPPORT_64 TEST_IGNORE(); @@ -1133,6 +1133,18 @@ void testHEX64ArrayWithinDelta(void) #endif } +void testHEX64ArrayWithinDeltaShouldNotHaveSignIssues(void) +{ +#ifndef UNITY_SUPPORT_64 + TEST_IGNORE(); +#else + UNITY_UINT64 expected[] = {0x7FFFFFFFFFFFFFFF, 0x8000000000000000}; + UNITY_UINT64 actualBigDelta[] = {0x8000000000000000, 0x7FFFFFFFFFFFFFFF}; + + TEST_ASSERT_HEX64_ARRAY_WITHIN(1, expected, actualBigDelta, 2); +#endif +} + void testHEX64ArrayWithinDeltaAndMessage(void) { #ifndef UNITY_SUPPORT_64 @@ -1287,6 +1299,14 @@ void testHEX32ArrayWithinDelta(void) TEST_ASSERT_HEX32_ARRAY_WITHIN(110, expected, actualBigDelta, 3); } +void testHEX32ArrayWithinDeltaShouldNotHaveSignIssues(void) +{ + UNITY_UINT32 expected[] = {0x7FFFFFFF, 0x80000000}; + UNITY_UINT32 actualBigDelta[] = {0x80000000, 0x7FFFFFFF}; + + TEST_ASSERT_HEX32_ARRAY_WITHIN(1, expected, actualBigDelta, 2); +} + void testHEX32ArrayWithinDeltaAndMessage(void) { UNITY_UINT expected[] = {0xABCD1234, 0xABCD1122, 0xABCD1277}; @@ -1398,6 +1418,14 @@ void testHEX16ArrayWithinDelta(void) TEST_ASSERT_HEX16_ARRAY_WITHIN(110, expected, actualBigDelta, 3); } +void testHEX16ArrayWithinDeltaShouldNotHaveSignIssues(void) +{ + UNITY_UINT16 expected[] = {0x7FFF, 0x8000}; + UNITY_UINT16 actualBigDelta[] = {0x8000, 0x7FFF}; + + TEST_ASSERT_HEX16_ARRAY_WITHIN(1, expected, actualBigDelta, 2); +} + void testHEX16ArrayWithinDeltaAndMessage(void) { UNITY_UINT16 expected[] = {0x1234, 0x1122, 0x1277}; @@ -1528,6 +1556,14 @@ void testHEX8ArrayNotWithinDelta(void) VERIFY_FAILS_END } +void testHEX8ArrayWithinDeltaShouldNotHaveSignIssues(void) +{ + UNITY_UINT8 expected[] = {0x7F, 0x80}; + UNITY_UINT8 actualBigDelta[] = {0x80, 0x7F}; + + TEST_ASSERT_HEX8_ARRAY_WITHIN(1, expected, actualBigDelta, 2); +} + void testHEX8ArrayNotWithinDeltaAndMessage(void) { UNITY_UINT8 expected[] = {0x34, 0x22, 0x77}; @@ -2872,3 +2908,33 @@ void testNotEqualInt64Arrays(void) VERIFY_FAILS_END #endif } + +void testVerifyIntPassingPointerComparisonOnZeroLengthArray(void) +{ + int a[] = { 1 }; + +#ifndef UNITY_COMPARE_PTRS_ON_ZERO_ARRAY + EXPECT_ABORT_BEGIN + TEST_ASSERT_EQUAL_INT_ARRAY(a, a, 0); + VERIFY_FAILS_END +#else + + TEST_ASSERT_EQUAL_INT_ARRAY(a, a, 0); +#endif +} + +void testVerifyIntFailingPointerComparisonOnZeroLengthArray(void) +{ + int a[] = { 1 }; + int b[] = { 1 }; + +#ifndef UNITY_COMPARE_PTRS_ON_ZERO_ARRAY + EXPECT_ABORT_BEGIN + TEST_ASSERT_EQUAL_INT_ARRAY(a, b, 0); + VERIFY_FAILS_END +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_EQUAL_INT_ARRAY(a, b, 0); + VERIFY_FAILS_END +#endif +} diff --git a/test/tests/test_unity_core.c b/test/tests/test_unity_core.c index d324e8619..c6ac81287 100644 --- a/test/tests/test_unity_core.c +++ b/test/tests/test_unity_core.c @@ -296,9 +296,9 @@ void testFailureCountIncrementsAndIsReturnedAtEnd(void) Unity.CurrentTestFailed = 1; startPutcharSpy(); /* Suppress output */ startFlushSpy(); - TEST_ASSERT_EQUAL(0, getFlushSpyCalls()); UnityConcludeTest(); endPutcharSpy(); + TEST_ASSERT_EQUAL(0, getFlushSpyCalls()); TEST_ASSERT_EQUAL(savedFailures + 1, Unity.TestFailures); #if defined(UNITY_OUTPUT_FLUSH) && defined(UNITY_OUTPUT_FLUSH_HEADER_DECLARATION) TEST_ASSERT_EQUAL(1, getFlushSpyCalls()); diff --git a/test/tests/test_unity_doubles.c b/test/tests/test_unity_doubles.c index 1bdedbc33..0ad9494d6 100644 --- a/test/tests/test_unity_doubles.c +++ b/test/tests/test_unity_doubles.c @@ -42,6 +42,10 @@ void testDoublesWithinDelta(void) TEST_ASSERT_DOUBLE_WITHIN(1.0, 187245.0, 187246.0); TEST_ASSERT_DOUBLE_WITHIN(0.05, 9273.2549, 9273.2049); TEST_ASSERT_DOUBLE_WITHIN(0.007, -726.93725, -726.94424); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_DOUBLE_NOT_WITHIN(0.05, 9273.2549, 9273.2049); + VERIFY_FAILS_END #endif } @@ -50,6 +54,8 @@ void testDoublesNotWithinDelta(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_DOUBLE_NOT_WITHIN(0.05, 9273.2649, 9273.2049); + EXPECT_ABORT_BEGIN TEST_ASSERT_DOUBLE_WITHIN(0.05, 9273.2649, 9273.2049); VERIFY_FAILS_END @@ -66,6 +72,10 @@ void testDoublesEqual(void) TEST_ASSERT_EQUAL_DOUBLE(187241234567.5, 187241234567.6); TEST_ASSERT_EQUAL_DOUBLE(9273.2512345649, 9273.25123455699); TEST_ASSERT_EQUAL_DOUBLE(-726.12345693724, -726.1234569374); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_NOT_EQUAL_DOUBLE(-726.12345693724, -726.1234569374); + VERIFY_FAILS_END #endif } @@ -74,6 +84,8 @@ void testDoublesNotEqual(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(9273.9649, 9273.0049); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(9273.9649, 9273.0049); VERIFY_FAILS_END @@ -85,6 +97,8 @@ void testDoublesNotEqualNegative1(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(-9273.9649, -9273.0049); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(-9273.9649, -9273.0049); VERIFY_FAILS_END @@ -96,6 +110,8 @@ void testDoublesNotEqualNegative2(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(-9273.0049, -9273.9649); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(-9273.0049, -9273.9649); VERIFY_FAILS_END @@ -107,6 +123,8 @@ void testDoublesNotEqualActualNaN(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(85.963, 0.0 / d_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(85.963, 0.0 / d_zero); VERIFY_FAILS_END @@ -118,6 +136,8 @@ void testDoublesNotEqualExpectedNaN(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(0.0 / d_zero, 85.963); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(0.0 / d_zero, 85.963); VERIFY_FAILS_END @@ -130,6 +150,10 @@ void testDoublesEqualBothNaN(void) TEST_IGNORE(); #else TEST_ASSERT_EQUAL_DOUBLE(0.0 / d_zero, 0.0 / d_zero); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_NOT_EQUAL_DOUBLE(0.0 / d_zero, 0.0 / d_zero); + VERIFY_FAILS_END #endif } @@ -138,6 +162,8 @@ void testDoublesNotEqualInfNaN(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(1.0 / d_zero, 0.0 / d_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(1.0 / d_zero, 0.0 / d_zero); VERIFY_FAILS_END @@ -149,6 +175,8 @@ void testDoublesNotEqualNaNInf(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(0.0 / d_zero, 1.0 / d_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(0.0 / d_zero, 1.0 / d_zero); VERIFY_FAILS_END @@ -160,6 +188,8 @@ void testDoublesNotEqualActualInf(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(321.642, 1.0 / d_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(321.642, 1.0 / d_zero); VERIFY_FAILS_END @@ -171,6 +201,8 @@ void testDoublesNotEqualExpectedInf(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(1.0 / d_zero, 321.642); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(1.0 / d_zero, 321.642); VERIFY_FAILS_END @@ -183,6 +215,10 @@ void testDoublesEqualBothInf(void) TEST_IGNORE(); #else TEST_ASSERT_EQUAL_DOUBLE(1.0 / d_zero, 1.0 / d_zero); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_NOT_EQUAL_DOUBLE(1.0 / d_zero, 1.0 / d_zero); + VERIFY_FAILS_END #endif } @@ -191,12 +227,446 @@ void testDoublesNotEqualPlusMinusInf(void) #ifdef UNITY_EXCLUDE_DOUBLE TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_DOUBLE(1.0 / d_zero, -1.0 / d_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_DOUBLE(1.0 / d_zero, -1.0 / d_zero); VERIFY_FAILS_END #endif } +void testDoublesGreaterThan(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_THAN_DOUBLE(1.0, 2.0); + TEST_ASSERT_GREATER_THAN_DOUBLE(-1.0, 1.0); + TEST_ASSERT_GREATER_THAN_DOUBLE(-2.0, -1.0); +#endif +} + +void testDoublesGreaterThanInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_THAN_DOUBLE(1.0, 1.0 / d_zero); + TEST_ASSERT_GREATER_THAN_DOUBLE(-1.0 / d_zero, 1.0 / d_zero); + TEST_ASSERT_GREATER_THAN_DOUBLE(-1.0 / d_zero, 1.0); +#endif +} + +void testDoublesNotGreaterThan(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_DOUBLE(2.0, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterThanNanActual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_DOUBLE(1.0, 0.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterThanNanThreshold(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_DOUBLE(0.0 / d_zero, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterThanNanBoth(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_DOUBLE(0.0 / d_zero, 0.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterThanInfActual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_DOUBLE(1.0 / d_zero, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterThanNegInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_DOUBLE(1.0, -1.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterThanBothInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_DOUBLE(1.0 / d_zero, 1.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterThanBothNegInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_DOUBLE(-1.0 / d_zero, -1.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesGreaterOrEqual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(1.0, 2.0); + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(2.0, 2.0); + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(-1.0, 1.0); + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(-2.0, -1.0); + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(-2.0, -2.0); +#endif +} + +void testDoublesGreaterOrEqualInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(1.0, 1.0 / d_zero); + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(-1.0 / d_zero, 1.0 / d_zero); + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(-1.0 / d_zero, 1.0); +#endif +} + +void testDoublesNotGreaterOrEqual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(2.0, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterOrEqualNanActual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(1.0, 0.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterOrEqualNanThreshold(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(0.0 / d_zero, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesGreaterOrEqualNanBoth(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(0.0 / d_zero, 0.0 / d_zero); +#endif +} + +void testDoublesNotGreaterOrEqualInfActual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(1.0 / d_zero, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotGreaterOrEqualNegInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(1.0, -1.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesGreaterOrEqualBothInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(1.0 / d_zero, 1.0 / d_zero); +#endif +} + +void testDoublesGreaterOrEqualBothNegInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_DOUBLE(-1.0 / d_zero, -1.0 / d_zero); +#endif +} + +void testDoublesLessThan(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_THAN_DOUBLE(2.0, 1.0); + TEST_ASSERT_LESS_THAN_DOUBLE(1.0, -1.0); + TEST_ASSERT_LESS_THAN_DOUBLE(-1.0, -2.0); +#endif +} + +void testDoublesLessThanInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_THAN_DOUBLE(1.0 / d_zero, 1.0); + TEST_ASSERT_LESS_THAN_DOUBLE(1.0 / d_zero, -1.0 / d_zero); + TEST_ASSERT_LESS_THAN_DOUBLE(1.0, -1.0 / d_zero); +#endif +} + +void testDoublesNotLessThan(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_DOUBLE(1.0, 2.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessThanNanActual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_DOUBLE(1.0, 0.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessThanNanThreshold(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_DOUBLE(0.0 / d_zero, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessThanNanBoth(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_DOUBLE(0.0 / d_zero, 0.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessThanInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_DOUBLE(1.0, 1.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessThanNegInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_DOUBLE(-1.0 / d_zero, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessThanBothInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_DOUBLE(1.0 / d_zero, 1.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessThanBothNegInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_DOUBLE(-1.0 / d_zero, -1.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesLessOrEqual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(2.0, 1.0); + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(2.0, 2.0); + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(1.0, -1.0); + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(-1.0, -2.0); + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(-2.0, -2.0); +#endif +} + +void testDoublesLessOrEqualInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(1.0 / d_zero, 1.0); + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(1.0 / d_zero, -1.0 / d_zero); + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(1.0, -1.0 / d_zero); +#endif +} + +void testDoublesNotLessOrEqual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(1.0, 2.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessOrEqualNanActual(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(1.0, 0.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessOrEqualNanThreshold(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(0.0 / d_zero, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesLessOrEqualNanBoth(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(0.0 / d_zero, 0.0 / d_zero); +#endif +} + +void testDoublesNotLessOrEqualInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(1.0, 1.0 / d_zero); + VERIFY_FAILS_END +#endif +} + +void testDoublesNotLessOrEqualNegInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(-1.0 / d_zero, 1.0); + VERIFY_FAILS_END +#endif +} + +void testDoublesLessOrEqualBothInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(1.0 / d_zero, 1.0 / d_zero); +#endif +} + +void testDoublesLessOrEqualBothNegInf(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_DOUBLE(-1.0 / d_zero, -1.0 / d_zero); +#endif +} + void testDoubleIsPosInf1(void) { #ifdef UNITY_EXCLUDE_DOUBLE @@ -554,6 +1024,47 @@ void testNotEqualDoubleArraysLengthZero(void) #endif } +void testDoubleArraysWithin(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + double p0[] = {1.0, -8.0, 25.4, -0.123}; + double p1[] = {1.0, -8.0, 25.4, -0.123}; + double p2[] = {1.0, -8.0, 25.4, -0.2}; + double p3[] = {1.0, -23.0, 25.0, -0.26}; + double p4[] = {2.0, -9.0, 26.2, 0.26}; + double p5[] = {-1.0, -7.0, 29.0, 2.6}; + + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(1.0, p0, p0, 1); + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(1.0, p0, p0, 4); + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(1.0, p0, p1, 4); + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(1.0, p0, p2, 3); + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(1.0, p0, p3, 1); + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(1.0, p0, p4, 1); + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(1.0, p0, p4, 4); + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(2.0, p0, p5, 1); + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(2.0, p0, p5, 2); + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(1.0, NULL, NULL, 1); +#endif +} + +void testDoubleArraysWithinUnusualDelta(void) +{ +#ifdef UNITY_EXCLUDE_DOUBLE + TEST_IGNORE(); +#else + double p0[] = {-INFINITY, -8.0, 25.4, -0.123}; + double p1[] = {INFINITY, 10.1}; + + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(INFINITY, p0, p1, 2); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_DOUBLE_ARRAY_WITHIN(NAN, p0, p0, 4); + VERIFY_FAILS_END +#endif +} + void testEqualDoubleEachEqual(void) { #ifdef UNITY_EXCLUDE_DOUBLE diff --git a/test/tests/test_unity_floats.c b/test/tests/test_unity_floats.c index e89bec20e..9e92f96a5 100644 --- a/test/tests/test_unity_floats.c +++ b/test/tests/test_unity_floats.c @@ -42,6 +42,10 @@ void testFloatsWithinDelta(void) TEST_ASSERT_FLOAT_WITHIN(1.0f, 187245.0f, 187246.0f); TEST_ASSERT_FLOAT_WITHIN(0.05f, 9273.2549f, 9273.2049f); TEST_ASSERT_FLOAT_WITHIN(0.007f, -726.93724f, -726.94424f); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_FLOAT_NOT_WITHIN(0.05f, 9273.2549f, 9273.2049f); + VERIFY_FAILS_END #endif } @@ -50,6 +54,8 @@ void testFloatsNotWithinDelta(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_FLOAT_NOT_WITHIN(0.05f, 9273.2649f, 9273.2049f); + EXPECT_ABORT_BEGIN TEST_ASSERT_FLOAT_WITHIN(0.05f, 9273.2649f, 9273.2049f); VERIFY_FAILS_END @@ -65,6 +71,10 @@ void testFloatsEqual(void) TEST_ASSERT_EQUAL_FLOAT(18724.5f, 18724.6f); TEST_ASSERT_EQUAL_FLOAT(9273.2549f, 9273.2599f); TEST_ASSERT_EQUAL_FLOAT(-726.93724f, -726.9374f); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_NOT_EQUAL_FLOAT(-726.93724f, -726.9374f); + VERIFY_FAILS_END #endif } @@ -73,6 +83,8 @@ void testFloatsNotEqual(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(9273.9649f, 9273.0049f); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(9273.9649f, 9273.0049f); VERIFY_FAILS_END @@ -84,6 +96,8 @@ void testFloatsNotEqualNegative1(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(-9273.9649f, -9273.0049f); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(-9273.9649f, -9273.0049f); VERIFY_FAILS_END @@ -95,6 +109,8 @@ void testFloatsNotEqualNegative2(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(-9273.0049f, -9273.9649f); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(-9273.0049f, -9273.9649f); VERIFY_FAILS_END @@ -106,6 +122,8 @@ void testFloatsNotEqualActualNaN(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(85.963f, 0.0f / f_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(85.963f, 0.0f / f_zero); VERIFY_FAILS_END @@ -117,6 +135,8 @@ void testFloatsNotEqualExpectedNaN(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(0.0f / f_zero, 85.963f); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(0.0f / f_zero, 85.963f); VERIFY_FAILS_END @@ -129,6 +149,10 @@ void testFloatsEqualBothNaN(void) TEST_IGNORE(); #else TEST_ASSERT_EQUAL_FLOAT(0.0f / f_zero, 0.0f / f_zero); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_NOT_EQUAL_FLOAT(0.0f / f_zero, 0.0f / f_zero); + VERIFY_FAILS_END #endif } @@ -137,6 +161,8 @@ void testFloatsNotEqualInfNaN(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(1.0f / f_zero, 0.0f / f_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(1.0f / f_zero, 0.0f / f_zero); VERIFY_FAILS_END @@ -148,6 +174,8 @@ void testFloatsNotEqualNaNInf(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(0.0f / f_zero, 1.0f / f_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(0.0f / f_zero, 1.0f / f_zero); VERIFY_FAILS_END @@ -159,6 +187,8 @@ void testFloatsNotEqualActualInf(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(321.642f, 1.0f / f_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(321.642f, 1.0f / f_zero); VERIFY_FAILS_END @@ -170,6 +200,8 @@ void testFloatsNotEqualExpectedInf(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(1.0f / f_zero, 321.642f); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(1.0f / f_zero, 321.642f); VERIFY_FAILS_END @@ -182,6 +214,10 @@ void testFloatsEqualBothInf(void) TEST_IGNORE(); #else TEST_ASSERT_EQUAL_FLOAT(1.0f / f_zero, 1.0f / f_zero); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_NOT_EQUAL_FLOAT(1.0f / f_zero, 1.0f / f_zero); + VERIFY_FAILS_END #endif } @@ -190,12 +226,445 @@ void testFloatsNotEqualPlusMinusInf(void) #ifdef UNITY_EXCLUDE_FLOAT TEST_IGNORE(); #else + TEST_ASSERT_NOT_EQUAL_FLOAT(1.0f / f_zero, -1.0f / f_zero); + EXPECT_ABORT_BEGIN TEST_ASSERT_EQUAL_FLOAT(1.0f / f_zero, -1.0f / f_zero); VERIFY_FAILS_END #endif } +void testFloatsGreaterThan(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_THAN_FLOAT(1.0f, 2.0f); + TEST_ASSERT_GREATER_THAN_FLOAT(-1.0f, 1.0f); + TEST_ASSERT_GREATER_THAN_FLOAT(-2.0f, -1.0f); +#endif +} + +void testFloatsGreaterThanInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_THAN_FLOAT(1.0f, 1.0f / f_zero); + TEST_ASSERT_GREATER_THAN_FLOAT(-1.0f / f_zero, 1.0f / f_zero); + TEST_ASSERT_GREATER_THAN_FLOAT(-1.0f / f_zero, 1.0f); +#endif +} + +void testFloatsNotGreaterThan(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_FLOAT(2.0f, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterThanNanActual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_FLOAT(1.0f, 0.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterThanNanThreshold(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_FLOAT(0.0f / f_zero, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterThanNanBoth(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_FLOAT(0.0f / f_zero, 0.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterThanInfActual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_FLOAT(1.0f / f_zero, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterThanNegInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_FLOAT(1.0f, -1.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterThanBothInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_FLOAT(1.0f / f_zero, 1.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterThanBothNegInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_THAN_FLOAT(-1.0f / f_zero, -1.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsGreaterOrEqual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(1.0f, 2.0f); + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(2.0f, 2.0f); + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(-1.0f, 1.0f); + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(-2.0f, -1.0f); + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(-2.0f, -2.0f); +#endif +} + +void testFloatsGreaterOrEqualInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(1.0f, 1.0f / f_zero); + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(-1.0f / f_zero, 1.0f / f_zero); + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(-1.0f / f_zero, 1.0f); +#endif +} + +void testFloatsNotGreaterOrEqual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(2.0f, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterOrEqualNanActual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(1.0f, 0.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterOrEqualNanThreshold(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(0.0f / f_zero, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsGreaterOrEqualNanBoth(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(0.0f / f_zero, 0.0f / f_zero); +#endif +} + +void testFloatsNotGreaterOrEqualInfActual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(1.0f / f_zero, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotGreaterOrEqualNegInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(1.0f, -1.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsGreaterOrEqualBothInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(1.0f / f_zero, 1.0f / f_zero); +#endif +} + +void testFloatsGreaterOrEqualBothNegInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_GREATER_OR_EQUAL_FLOAT(-1.0f / f_zero, -1.0f / f_zero); +#endif +} + +void testFloatsLessThan(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_THAN_FLOAT(2.0f, 1.0f); + TEST_ASSERT_LESS_THAN_FLOAT(1.0f, -1.0f); + TEST_ASSERT_LESS_THAN_FLOAT(-1.0f, -2.0f); +#endif +} + +void testFloatsLessThanInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_THAN_FLOAT(1.0f / f_zero, 1.0f); + TEST_ASSERT_LESS_THAN_FLOAT(1.0f / f_zero, -1.0f / f_zero); + TEST_ASSERT_LESS_THAN_FLOAT(1.0f, -1.0f / f_zero); +#endif +} + +void testFloatsNotLessThan(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_FLOAT(1.0f, 2.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessThanNanActual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_FLOAT(1.0f, 0.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessThanNanThreshold(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_FLOAT(0.0f / f_zero, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessThanNanBoth(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_FLOAT(0.0f / f_zero, 0.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessThanInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_FLOAT(1.0f, 1.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessThanNegInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_FLOAT(-1.0f / f_zero, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessThanBothInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_FLOAT(1.0f / f_zero, 1.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessThanBothNegInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_THAN_FLOAT(-1.0f / f_zero, -1.0f / f_zero); + VERIFY_FAILS_END +#endif +} +void testFloatsLessOrEqual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(2.0f, 1.0f); + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(2.0f, 2.0f); + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(1.0f, -1.0f); + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(-1.0f, -2.0f); + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(-2.0f, -2.0f); +#endif +} + +void testFloatsLessOrEqualInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(1.0f / f_zero, 1.0f); + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(1.0f / f_zero, -1.0f / f_zero); + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(1.0f, -1.0f / f_zero); +#endif +} + +void testFloatsNotLessOrEqual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(1.0f, 2.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessOrEqualNanActual(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(1.0f, 0.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessOrEqualNanThreshold(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(0.0f / f_zero, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsLessOrEqualNanBoth(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(0.0f / f_zero, 0.0f / f_zero); +#endif +} + +void testFloatsNotLessOrEqualInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(1.0f, 1.0f / f_zero); + VERIFY_FAILS_END +#endif +} + +void testFloatsNotLessOrEqualNegInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + EXPECT_ABORT_BEGIN + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(-1.0f / f_zero, 1.0f); + VERIFY_FAILS_END +#endif +} + +void testFloatsLessOrEqualBothInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(1.0f / f_zero, 1.0f / f_zero); +#endif +} + +void testFloatsLessOrEqualBothNegInf(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + TEST_ASSERT_LESS_OR_EQUAL_FLOAT(-1.0f / f_zero, -1.0f / f_zero); +#endif +} + void testFloatIsPosInf1(void) { #ifdef UNITY_EXCLUDE_FLOAT @@ -553,6 +1022,47 @@ void testNotEqualFloatArraysLengthZero(void) #endif } +void testFloatArraysWithin(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + float p0[] = {1.0f, -8.0f, 25.4f, -0.123f}; + float p1[] = {1.0f, -8.0f, 25.4f, -0.123f}; + float p2[] = {1.0f, -8.0f, 25.4f, -0.2f}; + float p3[] = {1.0f, -23.0f, 25.0f, -0.26f}; + float p4[] = {2.0f, -9.0f, 26.2f, 0.26f}; + float p5[] = {-1.0f, -7.0f, 29.0f, 2.6f}; + + TEST_ASSERT_FLOAT_ARRAY_WITHIN(1.0f, p0, p0, 1); + TEST_ASSERT_FLOAT_ARRAY_WITHIN(1.0f, p0, p0, 4); + TEST_ASSERT_FLOAT_ARRAY_WITHIN(1.0f, p0, p1, 4); + TEST_ASSERT_FLOAT_ARRAY_WITHIN(1.0f, p0, p2, 3); + TEST_ASSERT_FLOAT_ARRAY_WITHIN(1.0f, p0, p3, 1); + TEST_ASSERT_FLOAT_ARRAY_WITHIN(1.0f, p0, p4, 1); + TEST_ASSERT_FLOAT_ARRAY_WITHIN(1.0f, p0, p4, 4); + TEST_ASSERT_FLOAT_ARRAY_WITHIN(2.0f, p0, p5, 1); + TEST_ASSERT_FLOAT_ARRAY_WITHIN(2.0f, p0, p5, 2); + TEST_ASSERT_FLOAT_ARRAY_WITHIN(1.0f, NULL, NULL, 1); +#endif +} + +void testFloatArraysWithinUnusualDelta(void) +{ +#ifdef UNITY_EXCLUDE_FLOAT + TEST_IGNORE(); +#else + float p0[] = {(float)-INFINITY, -8.0f, 25.4f, -0.123f}; + float p1[] = {(float)INFINITY, 10.1f}; + + TEST_ASSERT_FLOAT_ARRAY_WITHIN(INFINITY, p0, p1, 2); + + EXPECT_ABORT_BEGIN + TEST_ASSERT_FLOAT_ARRAY_WITHIN(NAN, p0, p0, 4); + VERIFY_FAILS_END +#endif +} + void testEqualFloatEachEqual(void) { #ifdef UNITY_EXCLUDE_FLOAT diff --git a/test/tests/test_unity_integers.c b/test/tests/test_unity_integers.c index 7bdfa1442..d615e5f0c 100644 --- a/test/tests/test_unity_integers.c +++ b/test/tests/test_unity_integers.c @@ -800,6 +800,11 @@ void testHEX32sWithinDelta(void) TEST_ASSERT_HEX32_WITHIN(5, 5000, 5005); } +void testHEX32sWithinDeltaShouldIgnoreSign(void) +{ + TEST_ASSERT_HEX32_WITHIN(1, 0x7FFFFFFF, 0x80000000); +} + void testHEX32sWithinDeltaAndCustomMessage(void) { TEST_ASSERT_HEX32_WITHIN_MESSAGE(1, 5000, 5001, "Custom Message."); @@ -842,6 +847,11 @@ void testHEX16sWithinDelta(void) TEST_ASSERT_HEX16_WITHIN(5, 5000, 5005); } +void testHEX16sWithinDeltaShouldIgnoreSign(void) +{ + TEST_ASSERT_HEX16_WITHIN(1, 0x7FFF, 0x8000); +} + void testHEX16sWithinDeltaAndCustomMessage(void) { TEST_ASSERT_HEX16_WITHIN_MESSAGE(1, 5000, 5001, "Custom Message."); @@ -880,6 +890,11 @@ void testHEX8sWithinDelta(void) TEST_ASSERT_HEX8_WITHIN(5, 1, 4); } +void testHEX8sWithinDeltaShouldIgnoreSign(void) +{ + TEST_ASSERT_HEX8_WITHIN(1, 0x7F, 0x80); +} + void testHEX8sWithinDeltaAndCustomMessage(void) { TEST_ASSERT_HEX8_WITHIN_MESSAGE(1, 254, 255, "Custom Message."); diff --git a/test/tests/test_unity_integers_64.c b/test/tests/test_unity_integers_64.c index e12566e83..6e83329ef 100644 --- a/test/tests/test_unity_integers_64.c +++ b/test/tests/test_unity_integers_64.c @@ -61,7 +61,7 @@ void testInt64ArrayWithinDeltaAndMessage(void) #endif } -void tesUInt64ArrayNotWithinDelta(void) +void testInt64ArrayNotWithinDelta(void) { #ifndef UNITY_SUPPORT_64 TEST_IGNORE(); @@ -652,6 +652,15 @@ void testHEX64sWithinDelta(void) #endif } +void testHEX32sWithinDeltaShouldIgnoreSign(void) +{ +#ifndef UNITY_SUPPORT_64 + TEST_IGNORE(); +#else + TEST_ASSERT_HEX64_WITHIN(1, 0x7FFFFFFFFFFFFFFF,0x8000000000000000); +#endif +} + void testHEX64sNotWithinDelta(void) { #ifndef UNITY_SUPPORT_64 diff --git a/test/tests/test_unity_parameterized.c b/test/tests/test_unity_parameterized.c index 3129817e9..aa9f9c16a 100644 --- a/test/tests/test_unity_parameterized.c +++ b/test/tests/test_unity_parameterized.c @@ -7,9 +7,7 @@ #include #include #include "unity.h" - -/* Support for Meta Test Rig */ -#define TEST_CASE(...) +#include "types_for_test.h" /* Include Passthroughs for Linking Tests */ void putcharSpy(int c) { (void)putchar(c);} @@ -48,11 +46,13 @@ static int SetToOneToFailInTearDown; static int SetToOneMeanWeAlreadyCheckedThisGuy; static unsigned NextExpectedStringIndex; static unsigned NextExpectedCharIndex; +static unsigned NextExpectedSpaceIndex; void suiteSetUp(void) { NextExpectedStringIndex = 0; NextExpectedCharIndex = 0; + NextExpectedSpaceIndex = 0; } void setUp(void) @@ -169,3 +169,140 @@ void test_CharsArePreserved(unsigned index, char c) NextExpectedCharIndex++; } + +TEST_RANGE([0, 10, 2]) +void test_SingleRange(unsigned value) +{ + TEST_ASSERT_EQUAL(0, value % 2); + TEST_ASSERT_LESS_OR_EQUAL(10, value); +} + +TEST_RANGE([1, 2, 1], [2, 1, -1]) +void test_TwoRanges(unsigned first, unsigned second) +{ + TEST_ASSERT_LESS_OR_EQUAL(4, first * second); +} + +TEST_RANGE(<0, 10, 2>) +void test_SingleExclusiveRange(unsigned value) +{ + TEST_ASSERT_EQUAL(0, value % 2); + TEST_ASSERT_LESS_THAN(10, value); +} + +TEST_RANGE([2, 4, 1], <1, 2, 1>) +void test_BothInclusiveAndExclusiveRange(unsigned first, unsigned second) +{ + TEST_ASSERT_LESS_THAN(first, second); +} + +TEST_CASE(0, + + 1) +TEST_CASE(1, + + 2 + + ) +TEST_RANGE([2, + 5 , + 1], [6, 6, 1]) +TEST_CASE( + + 6 , 7) +TEST_MATRIX([7, + 8 , + + 9, 10], + [ + 11] + + ) +void test_SpaceInTestCase(unsigned index, unsigned bigger) +{ + TEST_ASSERT_EQUAL_UINT32(NextExpectedSpaceIndex, index); + TEST_ASSERT_LESS_THAN(bigger, index); + + NextExpectedSpaceIndex++; +} + +TEST_MATRIX([1, 5, (2*2)+1, 4]) +void test_SingleMatix(unsigned value) +{ + TEST_ASSERT_LESS_OR_EQUAL(10, value); +} + +TEST_MATRIX([2, 5l, 4u+3, 4ul], [-2, 3]) +void test_TwoMatrices(unsigned first, signed second) +{ + static unsigned idx = 0; + static const unsigned expected[] = + { + // -2 3 + -4, 6, // 2 + -10, 15, // 5 + -14, 21, // 7 + -8, 12, // 4 + }; + TEST_ASSERT_EQUAL_INT(expected[idx++], first * second); +} + +TEST_MATRIX(["String1", "String,2", "Stri" "ng3", "String[4]", "String\"5\""], [-5, 12.5f]) +void test_StringsAndNumbersMatrices(const char* str, float number) +{ + static unsigned idx = 0; + static const char* expected[] = + { + "String1_-05.00", + "String1_+12.50", + "String,2_-05.00", + "String,2_+12.50", + "String3_-05.00", + "String3_+12.50", + "String[4]_-05.00", + "String[4]_+12.50", + "String\"5\"_-05.00", + "String\"5\"_+12.50", + }; + char buf[200] = {0}; + snprintf(buf, sizeof(buf), "%s_%+06.2f", str, number); + TEST_ASSERT_EQUAL_STRING(expected[idx++], buf); +} + +TEST_MATRIX( + [ENUM_A, ENUM_4, ENUM_C], + [test_arr[0], 7.8f, test_arr[2]], + ['a', 'f', '[', ']', '\'', '"'], +) +void test_EnumCharAndArrayMatrices(test_enum_t e, float n, char c) +{ + static unsigned enum_idx = 0; + static const test_enum_t exp_enum[3] = { + ENUM_A, ENUM_4, ENUM_C, + }; + + static unsigned float_idx = 0; + float exp_float[3] = {0}; + exp_float[0] = test_arr[0]; + exp_float[1] = 7.8f; + exp_float[2] = test_arr[2]; + + static unsigned char_idx = 0; + static const test_enum_t exp_char[] = { + 'a', 'f', '[', ']', '\'', '"' + }; + + TEST_ASSERT_EQUAL_INT(exp_enum[enum_idx], e); + TEST_ASSERT_EQUAL_FLOAT(exp_float[float_idx], n); + TEST_ASSERT_EQUAL_CHAR(exp_char[char_idx], c); + + char_idx = (char_idx + 1) % 6; + if (char_idx == 0.0f) + { + float_idx = (float_idx + 1) % 3; + if (float_idx == 0.0f) + { + enum_idx = (enum_idx + 1) % 3; + } + } +} diff --git a/test/tests/test_unity_parameterizedDemo.c b/test/tests/test_unity_parameterizedDemo.c new file mode 100644 index 000000000..83dfad668 --- /dev/null +++ b/test/tests/test_unity_parameterizedDemo.c @@ -0,0 +1,21 @@ +#include "unity.h" + +/* Support for Meta Test Rig */ +#ifndef TEST_CASE +#define TEST_CASE(...) +#endif +#ifndef TEST_RANGE +#define TEST_RANGE(...) +#endif +#ifndef TEST_MATRIX +#define TEST_MATRIX(...) +#endif + +TEST_CASE(1, 2, 5) +TEST_CASE(10, 7, 20) +TEST_RANGE([3, 4, 1], [10, 5, -2], <30, 31, 1>) +TEST_MATRIX([3, 4, 7], [10, 8, 2, 1],[30u, 20.0f]) +void test_demoParamFunction(int a, int b, int c) +{ + TEST_ASSERT_GREATER_THAN_INT(a + b, c); +} diff --git a/test/tests/types_for_test.h b/test/tests/types_for_test.h new file mode 100644 index 000000000..6da4e5154 --- /dev/null +++ b/test/tests/types_for_test.h @@ -0,0 +1,14 @@ +#pragma once + +typedef enum { + ENUM_A, + ENUM_2, + ENUM_C, + ENUM_4, +} test_enum_t; + +static const float test_arr[] = { + 1.2f, + 2.3f, + 3.4f, +};