blob: ccdb18b303adde0b89b56feb2c0198c34a31981f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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();
}
}
}
|
