Supply invocation index for @ParameterizedTest to test author (#3085)

Resolves #3085 by adding `ArgumentsAccessor.getInvocationIndex()`
junit-team · Nov 14, 2022 · 078661e · 078661e
1 parent 8617495
commit 078661e
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 49 deletions.
diff --git a/documentation/src/docs/asciidoc/release-notes/release-notes-5.10.0-M1.adoc b/documentation/src/docs/asciidoc/release-notes/release-notes-5.10.0-M1.adoc
@@ -42,7 +42,7 @@ repository on GitHub.
 
 ==== New Features and Improvements
 
-* ❓
+* New `ArgumentsAccessor.getInvocationIndex` method to supply index of a `@ParameterizedTest` invocation.
 
 
 [[release-notes-5.10.0-M1-junit-vintage]]

diff --git a/junit-jupiter-params/src/main/java/org/junit/jupiter/params/ParameterizedTestExtension.java b/junit-jupiter-params/src/main/java/org/junit/jupiter/params/ParameterizedTestExtension.java
@@ -92,7 +92,7 @@ public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContex
 				.map(arguments -> consumedArguments(arguments, methodContext))
 				.map(arguments -> {
 					invocationCount.incrementAndGet();
-					return createInvocationContext(formatter, methodContext, arguments);
+					return createInvocationContext(formatter, methodContext, arguments, invocationCount.intValue());
 				})
 				.onClose(() ->
 						Preconditions.condition(invocationCount.get() > 0,
@@ -122,8 +122,8 @@ private ExtensionContext.Store getStore(ExtensionContext context) {
 	}
 
 	private TestTemplateInvocationContext createInvocationContext(ParameterizedTestNameFormatter formatter,
-			ParameterizedTestMethodContext methodContext, Object[] arguments) {
-		return new ParameterizedTestInvocationContext(formatter, methodContext, arguments);
+			ParameterizedTestMethodContext methodContext, Object[] arguments, int invocationIndex) {
+		return new ParameterizedTestInvocationContext(formatter, methodContext, arguments, invocationIndex);
 	}
 
 	private ParameterizedTestNameFormatter createNameFormatter(ExtensionContext extensionContext, Method templateMethod,

diff --git a/...ter-params/src/main/java/org/junit/jupiter/params/ParameterizedTestInvocationContext.java b/...ter-params/src/main/java/org/junit/jupiter/params/ParameterizedTestInvocationContext.java
@@ -25,12 +25,14 @@ class ParameterizedTestInvocationContext implements TestTemplateInvocationContex
 	private final ParameterizedTestNameFormatter formatter;
 	private final ParameterizedTestMethodContext methodContext;
 	private final Object[] arguments;
+	private final int invocationIndex;
 
 	ParameterizedTestInvocationContext(ParameterizedTestNameFormatter formatter,
-			ParameterizedTestMethodContext methodContext, Object[] arguments) {
+			ParameterizedTestMethodContext methodContext, Object[] arguments, int invocationIndex) {
 		this.formatter = formatter;
 		this.methodContext = methodContext;
 		this.arguments = arguments;
+		this.invocationIndex = invocationIndex;
 	}
 
 	@Override
@@ -40,7 +42,8 @@ public String getDisplayName(int invocationIndex) {
 
 	@Override
 	public List<Extension> getAdditionalExtensions() {
-		return singletonList(new ParameterizedTestParameterResolver(this.methodContext, this.arguments));
+		return singletonList(
+			new ParameterizedTestParameterResolver(this.methodContext, this.arguments, this.invocationIndex));
 	}
 
 }
diff --git a/...jupiter-params/src/main/java/org/junit/jupiter/params/ParameterizedTestMethodContext.java b/...jupiter-params/src/main/java/org/junit/jupiter/params/ParameterizedTestMethodContext.java
@@ -161,8 +161,8 @@ int indexOfFirstAggregator() {
 	 * Resolve the parameter for the supplied context using the supplied
 	 * arguments.
 	 */
-	Object resolve(ParameterContext parameterContext, Object[] arguments) {
-		return getResolver(parameterContext).resolve(parameterContext, arguments);
+	Object resolve(ParameterContext parameterContext, Object[] arguments, int invocationIndex) {
+		return getResolver(parameterContext).resolve(parameterContext, arguments, invocationIndex);
 	}
 
 	private Resolver getResolver(ParameterContext parameterContext) {
@@ -213,9 +213,7 @@ Resolver createResolver(ParameterContext parameterContext) {
 	}
 
 	interface Resolver {
-
-		Object resolve(ParameterContext parameterContext, Object[] arguments);
-
+		Object resolve(ParameterContext parameterContext, Object[] arguments, int invocationIndex);
 	}
 
 	static class Converter implements Resolver {
@@ -229,7 +227,7 @@ static class Converter implements Resolver {
 		}
 
 		@Override
-		public Object resolve(ParameterContext parameterContext, Object[] arguments) {
+		public Object resolve(ParameterContext parameterContext, Object[] arguments, int invocationIndex) {
 			Object argument = arguments[parameterContext.getIndex()];
 			try {
 				return this.argumentConverter.convert(argument, parameterContext);
@@ -252,8 +250,8 @@ static class Aggregator implements Resolver {
 		}
 
 		@Override
-		public Object resolve(ParameterContext parameterContext, Object[] arguments) {
-			ArgumentsAccessor accessor = new DefaultArgumentsAccessor(arguments);
+		public Object resolve(ParameterContext parameterContext, Object[] arguments, int invocationIndex) {
+			ArgumentsAccessor accessor = new DefaultArgumentsAccessor(invocationIndex, arguments);
 			try {
 				return this.argumentsAggregator.aggregateArguments(accessor, parameterContext);
 			}

diff --git a/...ter-params/src/main/java/org/junit/jupiter/params/ParameterizedTestParameterResolver.java b/...ter-params/src/main/java/org/junit/jupiter/params/ParameterizedTestParameterResolver.java
@@ -34,10 +34,13 @@ class ParameterizedTestParameterResolver implements ParameterResolver, AfterTest
 
 	private final ParameterizedTestMethodContext methodContext;
 	private final Object[] arguments;
+	private final int invocationIndex;
 
-	ParameterizedTestParameterResolver(ParameterizedTestMethodContext methodContext, Object[] arguments) {
+	ParameterizedTestParameterResolver(ParameterizedTestMethodContext methodContext, Object[] arguments,
+			int invocationIndex) {
 		this.methodContext = methodContext;
 		this.arguments = arguments;
+		this.invocationIndex = invocationIndex;
 	}
 
 	@Override
@@ -69,7 +72,7 @@ public boolean supportsParameter(ParameterContext parameterContext, ExtensionCon
 	@Override
 	public Object resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
 			throws ParameterResolutionException {
-		return this.methodContext.resolve(parameterContext, extractPayloads(this.arguments));
+		return this.methodContext.resolve(parameterContext, extractPayloads(this.arguments), this.invocationIndex);
 	}
 
 	/**

diff --git a/...t-jupiter-params/src/main/java/org/junit/jupiter/params/aggregator/ArgumentsAccessor.java b/...t-jupiter-params/src/main/java/org/junit/jupiter/params/aggregator/ArgumentsAccessor.java
@@ -188,4 +188,8 @@ public interface ArgumentsAccessor {
 	 */
 	List<Object> toList();
 
+	/**
+	 * Get the index of the current test invocation.
+	 */
+	int getInvocationIndex();
 }
diff --git a/...er-params/src/main/java/org/junit/jupiter/params/aggregator/DefaultArgumentsAccessor.java b/...er-params/src/main/java/org/junit/jupiter/params/aggregator/DefaultArgumentsAccessor.java
@@ -36,10 +36,12 @@
 public class DefaultArgumentsAccessor implements ArgumentsAccessor {
 
 	private final Object[] arguments;
+	private final int invocationIndex;
 
-	public DefaultArgumentsAccessor(Object... arguments) {
+	public DefaultArgumentsAccessor(int invocationIndex, Object... arguments) {
 		Preconditions.notNull(arguments, "Arguments array must not be null");
 		this.arguments = arguments;
+		this.invocationIndex = invocationIndex;
 	}
 
 	@Override
@@ -126,4 +128,9 @@ public List<Object> toList() {
 		return Collections.unmodifiableList(Arrays.asList(this.arguments));
 	}
 
+	@Override
+	public int getInvocationIndex() {
+		return this.invocationIndex;
+	}
+
 }
diff --git a/...-params/src/test/java/org/junit/jupiter/params/aggregator/AggregatorIntegrationTests.java b/...-params/src/test/java/org/junit/jupiter/params/aggregator/AggregatorIntegrationTests.java
@@ -208,6 +208,17 @@ private EngineExecutionResults execute(DiscoverySelector... selectors) {
 		return EngineTestKit.execute("junit-jupiter", request().selectors(selectors).build());
 	}
 
+	@ParameterizedTest
+	@CsvSource({ "first", "second" })
+	void argumentsAccessorInvocationIndex(ArgumentsAccessor arguments) {
+		if ("first".equals(arguments.getString(0))) {
+			assertEquals(1, arguments.getInvocationIndex());
+		}
+		if ("second".equals(arguments.getString(0))) {
+			assertEquals(2, arguments.getInvocationIndex());
+		}
+	}
+
 	// -------------------------------------------------------------------------
 
 	public static class Person {

diff --git a/...rams/src/test/java/org/junit/jupiter/params/aggregator/DefaultArgumentsAccessorTests.java b/...rams/src/test/java/org/junit/jupiter/params/aggregator/DefaultArgumentsAccessorTests.java
@@ -31,113 +31,113 @@ class DefaultArgumentsAccessorTests {
 
 	@Test
 	void argumentsMustNotBeNull() {
-		assertThrows(PreconditionViolationException.class, () -> new DefaultArgumentsAccessor((Object[]) null));
+		assertThrows(PreconditionViolationException.class, () -> new DefaultArgumentsAccessor(1, (Object[]) null));
 	}
 
 	@Test
 	void indexMustNotBeNegative() {
-		ArgumentsAccessor arguments = new DefaultArgumentsAccessor(1, 2);
+		ArgumentsAccessor arguments = new DefaultArgumentsAccessor(1, 1, 2);
 		Exception exception = assertThrows(PreconditionViolationException.class, () -> arguments.get(-1));
 		assertThat(exception.getMessage()).containsSubsequence("index must be", ">= 0");
 	}
 
 	@Test
 	void indexMustBeSmallerThanLength() {
-		ArgumentsAccessor arguments = new DefaultArgumentsAccessor(1, 2);
+		ArgumentsAccessor arguments = new DefaultArgumentsAccessor(1, 1, 2);
 		Exception exception = assertThrows(PreconditionViolationException.class, () -> arguments.get(2));
 		assertThat(exception.getMessage()).containsSubsequence("index must be", "< 2");
 	}
 
 	@Test
 	void getNull() {
-		assertNull(new DefaultArgumentsAccessor(new Object[] { null }).get(0));
+		assertNull(new DefaultArgumentsAccessor(1, new Object[] { null }).get(0));
 	}
 
 	@Test
 	void getWithNullCastToWrapperType() {
-		assertNull(new DefaultArgumentsAccessor((Object[]) new Integer[] { null }).get(0, Integer.class));
+		assertNull(new DefaultArgumentsAccessor(1, (Object[]) new Integer[] { null }).get(0, Integer.class));
 	}
 
 	@Test
 	void get() {
-		assertEquals(1, new DefaultArgumentsAccessor(1).get(0));
+		assertEquals(1, new DefaultArgumentsAccessor(1, 1).get(0));
 	}
 
 	@Test
 	void getWithCast() {
-		assertEquals(Integer.valueOf(1), new DefaultArgumentsAccessor(1).get(0, Integer.class));
-		assertEquals(Character.valueOf('A'), new DefaultArgumentsAccessor('A').get(0, Character.class));
+		assertEquals(Integer.valueOf(1), new DefaultArgumentsAccessor(1, 1).get(0, Integer.class));
+		assertEquals(Character.valueOf('A'), new DefaultArgumentsAccessor(1, 'A').get(0, Character.class));
 	}
 
 	@Test
 	void getWithCastToPrimitiveType() {
 		Exception exception = assertThrows(ArgumentAccessException.class,
-			() -> new DefaultArgumentsAccessor(1).get(0, int.class));
+			() -> new DefaultArgumentsAccessor(1, 1).get(0, int.class));
 		assertThat(exception.getMessage()).isEqualTo(
 			"Argument at index [0] with value [1] and type [java.lang.Integer] could not be converted or cast to type [int].");
 
 		exception = assertThrows(ArgumentAccessException.class,
-			() -> new DefaultArgumentsAccessor(new Object[] { null }).get(0, int.class));
+			() -> new DefaultArgumentsAccessor(1, new Object[] { null }).get(0, int.class));
 		assertThat(exception.getMessage()).isEqualTo(
 			"Argument at index [0] with value [null] and type [null] could not be converted or cast to type [int].");
 	}
 
 	@Test
 	void getWithCastToIncompatibleType() {
 		Exception exception = assertThrows(ArgumentAccessException.class,
-			() -> new DefaultArgumentsAccessor(1).get(0, Character.class));
+			() -> new DefaultArgumentsAccessor(1, 1).get(0, Character.class));
 		assertThat(exception.getMessage()).isEqualTo(
 			"Argument at index [0] with value [1] and type [java.lang.Integer] could not be converted or cast to type [java.lang.Character].");
 	}
 
 	@Test
 	void getCharacter() {
-		assertEquals(Character.valueOf('A'), new DefaultArgumentsAccessor('A', 'B').getCharacter(0));
+		assertEquals(Character.valueOf('A'), new DefaultArgumentsAccessor(1, 'A', 'B').getCharacter(0));
 	}
 
 	@Test
 	void getBoolean() {
-		assertEquals(Boolean.TRUE, new DefaultArgumentsAccessor(true, false).getBoolean(0));
+		assertEquals(Boolean.TRUE, new DefaultArgumentsAccessor(1, true, false).getBoolean(0));
 	}
 
 	@Test
 	void getByte() {
-		assertEquals(Byte.valueOf((byte) 42), new DefaultArgumentsAccessor((byte) 42).getByte(0));
+		assertEquals(Byte.valueOf((byte) 42), new DefaultArgumentsAccessor(1, (byte) 42).getByte(0));
 	}
 
 	@Test
 	void getShort() {
-		assertEquals(Short.valueOf((short) 42), new DefaultArgumentsAccessor((short) 42).getShort(0));
+		assertEquals(Short.valueOf((short) 42), new DefaultArgumentsAccessor(1, (short) 42).getShort(0));
 	}
 
 	@Test
 	void getInteger() {
-		assertEquals(Integer.valueOf(42), new DefaultArgumentsAccessor(42).getInteger(0));
+		assertEquals(Integer.valueOf(42), new DefaultArgumentsAccessor(1, 42).getInteger(0));
 	}
 
 	@Test
 	void getLong() {
-		assertEquals(Long.valueOf(42L), new DefaultArgumentsAccessor(42L).getLong(0));
+		assertEquals(Long.valueOf(42L), new DefaultArgumentsAccessor(1, 42L).getLong(0));
 	}
 
 	@Test
 	void getFloat() {
-		assertEquals(Float.valueOf(42.0f), new DefaultArgumentsAccessor(42.0f).getFloat(0));
+		assertEquals(Float.valueOf(42.0f), new DefaultArgumentsAccessor(1, 42.0f).getFloat(0));
 	}
 
 	@Test
 	void getDouble() {
-		assertEquals(Double.valueOf(42.0), new DefaultArgumentsAccessor(42.0).getDouble(0));
+		assertEquals(Double.valueOf(42.0), new DefaultArgumentsAccessor(1, 42.0).getDouble(0));
 	}
 
 	@Test
 	void getString() {
-		assertEquals("foo", new DefaultArgumentsAccessor("foo", "bar").getString(0));
+		assertEquals("foo", new DefaultArgumentsAccessor(1, "foo", "bar").getString(0));
 	}
 
 	@Test
 	void toArray() {
-		var arguments = new DefaultArgumentsAccessor("foo", "bar");
+		var arguments = new DefaultArgumentsAccessor(1, "foo", "bar");
 		var copy = arguments.toArray();
 		assertArrayEquals(new String[] { "foo", "bar" }, copy);
 
@@ -148,7 +148,7 @@ void toArray() {
 
 	@Test
 	void toList() {
-		var arguments = new DefaultArgumentsAccessor("foo", "bar");
+		var arguments = new DefaultArgumentsAccessor(1, "foo", "bar");
 		var copy = arguments.toList();
 		assertIterableEquals(Arrays.asList("foo", "bar"), copy);
 
@@ -158,9 +158,9 @@ void toList() {
 
 	@Test
 	void size() {
-		assertEquals(0, new DefaultArgumentsAccessor().size());
-		assertEquals(1, new DefaultArgumentsAccessor(42).size());
-		assertEquals(5, new DefaultArgumentsAccessor('a', 'b', 'c', 'd', 'e').size());
+		assertEquals(0, new DefaultArgumentsAccessor(1).size());
+		assertEquals(1, new DefaultArgumentsAccessor(1, 42).size());
+		assertEquals(5, new DefaultArgumentsAccessor(1, 'a', 'b', 'c', 'd', 'e').size());
 	}
 
 }
diff --git a/...arams/src/test/kotlin/org/junit/jupiter/params/aggregator/ArgumentsAccessorKotlinTests.kt b/...arams/src/test/kotlin/org/junit/jupiter/params/aggregator/ArgumentsAccessorKotlinTests.kt
@@ -21,14 +21,14 @@ class ArgumentsAccessorKotlinTests {
 
     @Test
     fun `get() with reified type and index`() {
-        assertEquals(1, DefaultArgumentsAccessor(1).get<Int>(0))
-        assertEquals('A', DefaultArgumentsAccessor('A').get<Char>(0))
+        assertEquals(1, DefaultArgumentsAccessor(0, 1).get<Int>(0))
+        assertEquals('A', DefaultArgumentsAccessor(0, 'A').get<Char>(0))
     }
 
     @Test
     fun `get() with reified type and index for incompatible type`() {
         val exception = assertThrows<ArgumentAccessException> {
-            DefaultArgumentsAccessor(Integer.valueOf(1)).get<Char>(0)
+            DefaultArgumentsAccessor(0, Integer.valueOf(1)).get<Char>(0)
         }
 
         assertThat(exception).hasMessage(
@@ -38,13 +38,13 @@ class ArgumentsAccessorKotlinTests {
 
     @Test
     fun `get() with index`() {
-        assertEquals(1, DefaultArgumentsAccessor(1).get(0))
-        assertEquals('A', DefaultArgumentsAccessor('A').get(0))
+        assertEquals(1, DefaultArgumentsAccessor(0, 1).get(0))
+        assertEquals('A', DefaultArgumentsAccessor(0, 'A').get(0))
     }
 
     @Test
     fun `get() with index and class reference`() {
-        assertEquals(1, DefaultArgumentsAccessor(1).get(0, Integer::class.java))
-        assertEquals('A', DefaultArgumentsAccessor('A').get(0, Character::class.java))
+        assertEquals(1, DefaultArgumentsAccessor(0, 1).get(0, Integer::class.java))
+        assertEquals('A', DefaultArgumentsAccessor(0, 'A').get(0, Character::class.java))
     }
 }