Render multidimensional arrays in comparisons and invocation matchers

Author: pshevche

spock-core/src/main/java/org/spockframework/util/RenderUtil.java

@@ -3,6 +3,7 @@
 import org.spockframework.runtime.GroovyRuntimeUtil;
 
 import java.util.*;
+import java.util.function.Function;
 
 import groovy.lang.Range;
 import org.codehaus.groovy.runtime.DefaultGroovyMethods;
@@ -52,7 +53,10 @@ public static String toStringOrDump(@Nullable Object value) {
       Wrapper wrapper = (Wrapper) value;
       return String.format("%s as %s", toStringOrDump(wrapper.unwrap()), wrapper.getType().getSimpleName());
     }
-    return dump(value);
+    if (value.getClass().isArray()) {
+      return dumpArrayString((Object[]) value, RenderUtil::toStringOrDump);
+    }
+    return DefaultGroovyMethods.dump(value);
   }
 
   public static String inspectOrDump(@Nullable Object value) {
@@ -63,28 +67,22 @@ public static String inspectOrDump(@Nullable Object value) {
       Wrapper wrapper = (Wrapper) value;
       return String.format("%s as %s", inspectOrDump(wrapper.unwrap()), wrapper.getType().getSimpleName());
     }
-    return dump(value);
-  }
-
-  private static String dump(@Nullable Object value) {
     if (value.getClass().isArray()) {
-      return dumpArrayString((Object[])value);
-    } else {
-      return DefaultGroovyMethods.dump(value);
+      return dumpArrayString((Object[]) value, RenderUtil::inspectOrDump);
     }
+    return DefaultGroovyMethods.dump(value);
   }
 
-
   /*
    * Adapted from org.codehaus.groovy.runtime.InvokerHelper.toArrayString(java.lang.Object[]) to use dump()
    */
-  private static String dumpArrayString(Object[] arguments) {
+  private static String dumpArrayString(Object[] arguments, Function<Object, String> argDumper) {
     StringBuilder argBuf = new StringBuilder("[");
     for (int i = 0; i < arguments.length; i++) {
       if (i > 0) {
         argBuf.append(", ");
       }
-      argBuf.append(DefaultGroovyMethods.dump(arguments[i]));
+      argBuf.append(argDumper.apply(arguments[i]));
     }
     argBuf.append("]");
     return argBuf.toString();

spock-specs/src/test/groovy/org/spockframework/smoke/condition/ArrayComparisonRendering.groovy

@@ -0,0 +1,93 @@
+package org.spockframework.smoke.condition
+
+import static org.spockframework.smoke.condition.ValueRendering.DefaultToString
+
+class ArrayComparisonRendering extends ConditionRenderingSpec {
+
+  def "primitive array value"() {
+    expect:
+    isRendered """
+x == null
+| |
+| false
+[1, 2]
+    """, {
+      def x = [1, 2] as int[]
+      assert x == null
+    }
+  }
+
+  def "object array value"() {
+    expect:
+    isRendered """
+x == null
+| |
+| false
+[one, two]
+    """, {
+      def x = ["one", "two"] as String[]
+      assert x == null
+    }
+  }
+
+  def "arrays of variables with default to string is dump()ed"() {
+    def a = new DefaultToString()
+    def b = new DefaultToString()
+    DefaultToString[] x = [a, b]
+    expect:
+    isRendered """
+x == null
+| |
+| false
+[${a.dump()}, ${b.dump()}]
+    """, {
+      assert x == null
+    }
+  }
+
+  def "primitive two-dimensional array value"() {
+    expect:
+    isRendered """
+x == y
+| |  |
+| |  [[1, 2], [1, 5]]
+| false
+[[1, 2], [2, 5]]
+    """, {
+      def x = [[1, 2], [2, 5]] as int[][]
+      def y = [[1, 2], [1, 5]] as int[][]
+      assert x == y
+    }
+  }
+
+  def "object two-dimensional array value"() {
+    expect:
+    isRendered """
+x == y
+| |  |
+| |  [[one, two], [one, five]]
+| false
+[[one, two], [two, five]]
+    """, {
+      def x = [["one", "two"], ["two", "five"]] as String[][]
+      def y = [["one", "two"], ["one", "five"]] as String[][]
+      assert x == y
+    }
+  }
+
+  def "multidimensional array value with higher cardinality"() {
+    expect:
+    isRendered """
+x == y
+| |  |
+| |  [[[1, 2], [1, 5]], [[1, 2], [1, 5]]]
+| false
+[[[1, 2], [2, 5]], [[1, 2], [2, 5]]]
+    """, {
+      def x = [[[1, 2], [2, 5]], [[1, 2], [2, 5]]] as int[][][]
+      def y = [[[1, 2], [1, 5]], [[1, 2], [1, 5]]] as int[][][]
+      assert x == y
+    }
+  }
+
+}

spock-specs/src/test/groovy/org/spockframework/smoke/condition/ValueRendering.groovy

@@ -93,32 +93,6 @@ null == x
     }
   }
 
-  def "primitive array value"() {
-    expect:
-    isRendered """
-x == null
-| |
-| false
-[1, 2]
-    """, {
-      def x = [1, 2] as int[]
-      assert x == null
-    }
-  }
-
-  def "object array value"() {
-    expect:
-    isRendered """
-x == null
-| |
-| false
-[one, two]
-    """, {
-      def x = ["one", "two"] as String[]
-      assert x == null
-    }
-  }
-
   def "list value"() {
     expect:
     isRendered """
@@ -127,7 +101,7 @@ x == null
 | false
 [1, 2, 3]
     """, {
-      def x = [1,2,3]
+      def x = [1, 2, 3]
       assert x == null
     }
   }
@@ -277,21 +251,6 @@ ${x.dump()}
     }
   }
 
-  def "arrays of variables with default to string is dump()ed"() {
-    def a = new DefaultToString()
-    def b = new DefaultToString()
-    DefaultToString[] x = [a, b]
-    expect:
-    isRendered """
-x == null
-| |
-| false
-[${a.dump()}, ${b.dump()}]
-    """, {
-      assert x == null
-    }
-  }
-
   static class SingleLineToString {
     String toString() {
       "single line"
@@ -337,6 +296,7 @@ x == null
 
   enum EnumWithToString {
     VALUE;
+
     String toString() { "I'm a value" }
   }
 }

spock-specs/src/test/groovy/org/spockframework/smoke/mock/TooFewInvocations.groovy

@@ -16,15 +16,14 @@
 
 package org.spockframework.smoke.mock
 
+import org.hamcrest.CoreMatchers
 import org.spockframework.EmbeddedSpecification
 import org.spockframework.mock.TooFewInvocationsError
 
 import java.util.regex.Pattern
 
-import org.hamcrest.CoreMatchers
-
 class TooFewInvocations extends EmbeddedSpecification {
-  static Pattern EMPTY_LINE = Pattern.compile(/^ ++$/,Pattern.MULTILINE)
+  static Pattern EMPTY_LINE = Pattern.compile(/^ ++$/, Pattern.MULTILINE)
 
   def "shows unmatched invocations, ordered by similarity"() {
     when:
@@ -559,6 +558,7 @@ One or more arguments(s) didn't match:
     """.trim())
     exceptionMessage == expected
   }
+
   def "can describe code argument with verifyAll"() {
     when:
     runner.addClassImport(PersonWithFirstname)
@@ -1157,6 +1157,40 @@ then:
     exceptionMessage =~ /(?m)^\Q1 * list.add(<org.spockframework.smoke.mock.TooFewInvocations\E.Person@\w+ name=Foo age=18>\)$/
   }
 
+  def "correctly renders multidimensional arrays"() {
+    when:
+    runner.runFeatureBody("""
+def list = Mock(List)
+def arr = [[1, 2], [2, 5]] as int[][]
+
+when:
+list.add(arr)
+
+then:
+1 * list.add('bar')
+    """)
+
+    then:
+    TooFewInvocationsError e = thrown()
+    def exceptionMessage = normalize(e.message)
+    def expected = normalize("""
+Too few invocations for:
+
+1 * list.add('bar')   (0 invocations)
+
+Unmatched invocations (ordered by similarity):
+
+1 * list.add([[1, 2], [2, 5]])
+One or more arguments(s) didn't match:
+0: argument == expected
+   |        |  |
+   |        |  bar
+   |        false
+   [[1, 2], [2, 5]]
+    """.trim())
+    exceptionMessage == expected
+  }
+
   String normalize(String str) {
     EMPTY_LINE.matcher(str.normalize().trim()).replaceAll('')
   }
@@ -1165,15 +1199,15 @@ then:
     String name
     int age
 
-    String wife(String firstName, String surname, int age, String address){
+    String wife(String firstName, String surname, int age, String address) {
       return ''
     }
 
     String family(Map args) {
       return ''
     }
 
-    String named(Map args, String a, String b){
+    String named(Map args, String a, String b) {
       return ''
     }
   }