1 files changed, 162 insertions, 0 deletions
diff --git a/junit4/src/main/java/com/google/testing/junit/testparameterinjector/TestParameterValuesProvider.java b/junit4/src/main/java/com/google/testing/junit/testparameterinjector/TestParameterValuesProvider.java
new file mode 100644
index 0000000..ccdb18b
--- /dev/null
+++ b/junit4/src/main/java/com/google/testing/junit/testparameterinjector/TestParameterValuesProvider.java
@@ -0,0 +1,162 @@
+/*
+ * Copyright 2024 Google Inc.
+ *
+ * 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 com.google.testing.junit.testparameterinjector;
+
+import static com.google.common.base.Preconditions.checkArgument;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.collect.ImmutableList;
+import java.lang.annotation.Annotation;
+import java.util.List;
+import java.util.NoSuchElementException;
+import javax.annotation.Nullable;
+
+/**
+ * Abstract class for custom providers of @TestParameter values.
+ *
+ * <p>This is a replacement for {@link TestParameter.TestParameterValuesProvider}, which will soon
+ * be deprecated. The difference with the former interface is that this class provides a {@code
+ * Context} instance when invoking {@link #provideValues}.
+ */
+public abstract class TestParameterValuesProvider
+    implements TestParameter.TestParameterValuesProvider {
+
+  protected abstract List<?> provideValues(Context context) throws Exception;
+
+  /**
+   * @deprecated This method should never be called as it will simply throw an {@link
+   *     UnsupportedOperationException}.
+   */
+  @Override
+  @Deprecated
+  public final List<?> provideValues() {
+    throw new UnsupportedOperationException(
+        "The TestParameterInjector framework should never call this method, and instead call"
+            + " #provideValues(Context)");
+  }
+
+  /**
+   * Wraps the given value in an object that allows you to give the parameter value a different
+   * name. The TestParameterInjector framework will recognize the returned {@link
+   * TestParameterValue} instances and unwrap them at injection time.
+   *
+   * <p>Usage: {@code value(file.content).withName(file.name)}.
+   */
+  @Override
+  public final TestParameterValue value(@Nullable Object wrappedValue) {
+    // Overriding this method as final because it is not supposed to be overwritten
+    return TestParameterValue.wrap(wrappedValue);
+  }
+
+  /**
+   * An immutable value class that contains extra information about the context of the parameter for
+   * which values are being provided.
+   */
+  public static final class Context {
+
+    private final GenericParameterContext delegate;
+
+    Context(GenericParameterContext delegate) {
+      this.delegate = delegate;
+    }
+
+    /**
+     * Returns the only annotation with the given type on the field or parameter that was annotated
+     * with @TestParameter.
+     *
+     * <p>For example, if the test code is as follows:
+     *
+     * <pre>
+     *   {@literal @}Test
+     *   public void myTest_success(
+     *       {@literal @}CustomAnnotation(123) {@literal @}TestParameter(valuesProvider=MyProvider.class) Foo foo) {
+     *     ...
+     *   }
+     * </pre>
+     *
+     * then {@code context.getOtherAnnotation(CustomAnnotation.class).value()} will equal 123.
+     *
+     * @throws NoSuchElementException if this there is no annotation with the given type
+     * @throws IllegalArgumentException if there are multiple annotations with the given type
+     * @throws IllegalArgumentException if the argument it TestParameter.class because it is already
+     *     handled by the TestParameterInjector framework.
+     */
+    public <A extends Annotation> A getOtherAnnotation(Class<A> annotationType) {
+      checkArgument(
+          !TestParameter.class.equals(annotationType),
+          "Getting the @TestParameter annotating the field or parameter is not allowed because"
+              + " it is already handled by the TestParameterInjector framework.");
+      return delegate.getAnnotation(annotationType);
+    }
+
+    /**
+     * Returns the only annotation with the given type on the field or parameter that was annotated
+     * with @TestParameter.
+     *
+     * <p>For example, if the test code is as follows:
+     *
+     * <pre>
+     *   {@literal @}Test
+     *   public void myTest_success(
+     *       {@literal @}CustomAnnotation(123)
+     *       {@literal @}CustomAnnotation(456)
+     *       {@literal @}TestParameter(valuesProvider=MyProvider.class)
+     *       Foo foo) {
+     *     ...
+     *   }
+     * </pre>
+     *
+     * then {@code context.getOtherAnnotations(CustomAnnotation.class)} will return the annotation
+     * with 123 and 456.
+     *
+     * <p>Returns an empty list if this there is no annotation with the given type.
+     *
+     * @throws IllegalArgumentException if the argument it TestParameter.class because it is already
+     *     handled by the TestParameterInjector framework.
+     */
+    public <A extends Annotation> ImmutableList<A> getOtherAnnotations(Class<A> annotationType) {
+      checkArgument(
+          !TestParameter.class.equals(annotationType),
+          "Getting the @TestParameter annotating the field or parameter is not allowed because"
+              + " it is already handled by the TestParameterInjector framework.");
+      return delegate.getAnnotations(annotationType);
+    }
+
+    /**
+     * The class that contains the test that is currently being run.
+     *
+     * <p>Having this can be useful when sharing providers between tests that have the same base
+     * class. In those cases, an abstract method can be called as follows:
+     *
+     * <pre>
+     *   ((MyBaseClass) context.testClass().newInstance()).myAbstractMethod()
+     * </pre>
+     */
+    public Class<?> testClass() {
+      return delegate.testClass();
+    }
+
+    /** A list of all annotations on the field or parameter. */
+    @VisibleForTesting
+    ImmutableList<Annotation> annotationsOnParameter() {
+      return delegate.annotationsOnParameter();
+    }
+
+    @Override
+    public String toString() {
+      return delegate.toString();
+    }
+  }
+}