From d59381763041ba09ac2387793275477d2f86b387 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jon=20Hangh=C3=B8j=20Henneberg?= <jhh@universal-robots.com>
Date: Thu, 13 Jul 2023 22:35:53 +0200
Subject: [PATCH] Add TEST_MATIX option for parameterization

Added matrix option for parameterization that generates cases based on
the product of the given arguments.
---
 auto/generate_test_runner.rb | 49 +++++++++++++++++++++++-------------
 src/unity.h                  |  2 +-
 src/unity_internals.h        |  3 +++
 3 files changed, 35 insertions(+), 19 deletions(-)

diff --git a/auto/generate_test_runner.rb b/auto/generate_test_runner.rb
index ace5930..4fc83f6 100755
--- a/auto/generate_test_runner.rb
+++ b/auto/generate_test_runner.rb
@@ -132,8 +132,8 @@ class UnityTestRunnerGenerator
 
     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|TEST_RANGE)\s*\(.*?\)\s*)*)\s*void\s+((?:#{@options[:test_prefix]})\w*)\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)
@@ -143,25 +143,38 @@ class UnityTestRunnerGenerator
 
       if @options[:use_param_tests] && !arguments.empty?
         args = []
-        type_and_args = arguments.split(/TEST_(CASE|RANGE)/)
+        type_and_args = arguments.split(/TEST_(CASE|RANGE|MATRIX)/)
         for i in (1...type_and_args.length).step(2)
-          if type_and_args[i] == "CASE"
+          case type_and_args[i]
+          when "CASE"
             args << type_and_args[i + 1].sub(/^\s*\(\s*(.*?)\s*\)\s*$/m, '\1')
-            next
-          end
 
-          # 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(', ')
+          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
+
+          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
         end
       end
diff --git a/src/unity.h b/src/unity.h
index e321a1d..e4db314 100644
--- a/src/unity.h
+++ b/src/unity.h
@@ -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(...) and/or TEST_RANGE(...) 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
diff --git a/src/unity_internals.h b/src/unity_internals.h
index 98e298f..9f89eda 100644
--- a/src/unity_internals.h
+++ b/src/unity_internals.h
@@ -793,6 +793,9 @@ extern const char UnityStrErrShorthand[];
     #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