DATACMNS-1518 - Fixed detection of varargs overloads for SpEL expressions.

Before this commit we haven't properly resolved methods on a root object provided by an EvaluationContextExtension that was using varargs. With a vararg method, the number of parameters handed into the method is not necessary equal to the number of parameters. We previously simply skipped methods with a different number of arguments. We now try direct matches first but calculate valid varargs alternatives in case that initial lookup fails and try to match those alternatives.

This lookup is implemented in ….util.ParameterTypes now and used by ….spel.spi.Function. The latter now also handles the actual invocation of those methods properly by collecting the trailing arguments into an array.

src/test/java/org/springframework/data/repository/query/ExtensionAwareEvaluationContextProviderUnitTests.java

@@ -271,6 +271,14 @@ public class ExtensionAwareEvaluationContextProviderUnitTests {
 				.withMessageContaining("(java.lang.Integer)");
 	}
 
+	@Test // DATACMNS-1518
+	public void invokesMethodWithVarArgs() {
+
+		provider = createContextProviderWithOverloads();
+
+		assertThat(evaluateExpression("methodWithVarArgs('one', 'two')")).isEqualTo("varargs");
+	}
+
 	private static ExtensionAwareQueryMethodEvaluationContextProvider createContextProviderWithOverloads() {
 
 		return new ExtensionAwareQueryMethodEvaluationContextProvider(Collections.singletonList( //
@@ -429,5 +437,9 @@ public class ExtensionAwareEvaluationContextProviderUnitTests {
 		public String ambiguousOverloaded(Serializable o) {
 			return "serializable";
 		}
+
+		public String methodWithVarArgs(String... args) {
+			return "varargs";
+		}
 	}
 }

src/test/java/org/springframework/data/spel/spi/FunctionUnitTests.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2019 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.spel.spi;
+
+import static org.assertj.core.api.Assertions.*;
+
+import java.lang.reflect.Method;
+import java.util.Arrays;
+
+import org.junit.Test;
+import org.springframework.core.convert.TypeDescriptor;
+import org.springframework.util.ReflectionUtils;
+
+/**
+ * Unit tests for {@link Function}.
+ *
+ * @author Oliver Drotbohm
+ */
+public class FunctionUnitTests {
+
+	@Test // DATACMNS-1518
+	public void detectsVarArgsOverload() {
+
+		Method method = ReflectionUtils.findMethod(Sample.class, "someMethod", String[].class);
+
+		Function function = new Function(method, new Sample());
+
+		TypeDescriptor stringDescriptor = TypeDescriptor.valueOf(String.class);
+
+		assertThat(function.supports(Arrays.asList(stringDescriptor, stringDescriptor))).isTrue();
+	}
+
+	@Test // DATACMNS-1518
+	public void detectsObjectVarArgsOverload() {
+
+		Method method = ReflectionUtils.findMethod(Sample.class, "onePlusObjectVarargs", String.class, Object[].class);
+
+		Function function = new Function(method, new Sample());
+
+		TypeDescriptor stringDescriptor = TypeDescriptor.valueOf(String.class);
+
+		assertThat(function.supports(Arrays.asList(stringDescriptor, stringDescriptor))).isTrue();
+	}
+
+	class Sample {
+
+		String someMethod(String... args) {
+			return "result";
+		}
+
+		String onePlusObjectVarargs(String string, Object... args) {
+			return null;
+		}
+	}
+}

src/test/java/org/springframework/data/util/ParameterTypesUnitTests.java

@@ -0,0 +1,105 @@
+/*
+ * Copyright 2019 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.util;
+
+import static org.assertj.core.api.Assertions.*;
+
+import java.lang.reflect.Method;
+import java.util.List;
+
+import org.junit.Test;
+import org.springframework.util.ReflectionUtils;
+
+/**
+ * Unit test for {@link ParameterTypes}.
+ *
+ * @author Oliver Drotbohm
+ */
+public class ParameterTypesUnitTests {
+
+	@Test // DATACMNS-1518
+	public void detectsDirectMatch() {
+
+		Method method = ReflectionUtils.findMethod(Sample.class, "twoStrings", String.class, String.class);
+
+		ParameterTypes types = ParameterTypes.of(String.class, String.class);
+
+		assertThat(types.areValidFor(method)).isTrue();
+		assertThat(types.exactlyMatchParametersOf(method)).isTrue();
+	}
+
+	@Test // DATACMNS-1518
+	public void supportsSimpleVarArg() {
+
+		Method method = ReflectionUtils.findMethod(Sample.class, "stringPlusStringVarArg", String.class, String[].class);
+
+		ParameterTypes types = ParameterTypes.of(String.class, String.class);
+
+		assertThat(types.areValidFor(method)).isTrue();
+		assertThat(types.exactlyMatchParametersOf(method)).isFalse();
+	}
+
+	@Test // DATACMNS-1518
+	public void supportsTrailingObjectVarArg() {
+
+		Method method = ReflectionUtils.findMethod(Sample.class, "stringPlusObjectVarArg", String.class, Object[].class);
+
+		ParameterTypes types = ParameterTypes.of(String.class, String.class);
+
+		assertThat(types.areValidFor(method)).isTrue();
+		assertThat(types.exactlyMatchParametersOf(method)).isFalse();
+	}
+
+	@Test // DATACMNS-1518
+	public void supportsObjectVarArg() {
+
+		Method method = ReflectionUtils.findMethod(Sample.class, "objectVarArg", Object[].class);
+
+		ParameterTypes types = ParameterTypes.of(String.class, String.class);
+
+		assertThat(types.areValidFor(method)).isTrue();
+		assertThat(types.exactlyMatchParametersOf(method)).isFalse();
+
+	}
+
+	@Test // DATACMNS-1518
+	public void doesNotAddNonObjectVarArgsForParents() {
+
+		ParameterTypes types = ParameterTypes.of(String.class, String.class, Integer.class, Integer.class);
+
+		List<ParameterTypes> alternatives = types.getAllAlternatives();
+
+		assertThat(alternatives).hasSize(6);
+
+		assertThat(alternatives).anyMatch(it -> it.hasTypes(String.class, String.class, Integer.class, Integer[].class));
+		assertThat(alternatives).anyMatch(it -> it.hasTypes(String.class, String.class, Integer.class, Object[].class));
+		assertThat(alternatives).anyMatch(it -> it.hasTypes(String.class, String.class, Integer[].class));
+		assertThat(alternatives).anyMatch(it -> it.hasTypes(String.class, String.class, Object[].class));
+		assertThat(alternatives).anyMatch(it -> it.hasTypes(String.class, Object[].class));
+		assertThat(alternatives).anyMatch(it -> it.hasTypes(Object[].class));
+	}
+
+	interface Sample {
+
+		void twoStrings(String first, String second);
+
+		void stringPlusStringVarArg(String first, String... second);
+
+		void stringPlusObjectVarArg(String first, Object... second);
+
+		void objectVarArg(Object... args);
+	}
+}