Package com.google.testing.junit.testparameterinjector

Class TestParametersValuesProvider

java.lang.Object

com.google.testing.junit.testparameterinjector.TestParametersValuesProvider

All Implemented Interfaces:

TestParameters.TestParametersValuesProvider

public abstract class TestParametersValuesProvider
extends Object
implements TestParameters.TestParametersValuesProvider

Abstract class for custom providers of @TestParameters values.

This is a replacement for TestParameters.TestParametersValuesProvider, which is deprecated. The difference with the former interface is that this class provides a Context instance when invoking provideValues(com.google.testing.junit.testparameterinjector.TestParametersValuesProvider.Context).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TestParametersValuesProvider.Context	An immutable value class that contains extra information about the context of the parameter for which values are being provided.

Constructor Summary

Constructors

Constructor	Description
TestParametersValuesProvider()

Method Summary

Modifier and Type	Method	Description
final List<TestParameters.TestParametersValues>	provideValues()	Deprecated. This method should never be called as it will simply throw an UnsupportedOperationException.
protected abstract List<TestParameters.TestParametersValues>	provideValues(TestParametersValuesProvider.Context context)	Returns a list of TestParameters.TestParametersValues instances to be used as test parameters.
protected boolean	valuesListCanBeEmptyWhichMeansThatTheTestWillBeSkipped()	Deprecated. This method exists to gracefully migrate pre-v1.20 clients.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TestParametersValuesProvider

public TestParametersValuesProvider()

Method Details

provideValues

protected abstract List<TestParameters.TestParametersValues> provideValues(TestParametersValuesProvider.Context context)
                                                                    throws Exception

Returns a list of TestParameters.TestParametersValues instances to be used as test parameters. This method is invoked exactly once for each test method.

The returned list should not be empty unless valuesListCanBeEmptyWhichMeansThatTheTestWillBeSkipped() returns true.

Throws:

Exception

valuesListCanBeEmptyWhichMeansThatTheTestWillBeSkipped

@Deprecated
protected boolean valuesListCanBeEmptyWhichMeansThatTheTestWillBeSkipped()

Deprecated.

This method exists to gracefully migrate pre-v1.20 clients. Pre-v1.20, all TestParametersValuesProvider implementations were allowed to return empty lists.

If this method returns true, then it is ok for the provideValues(Context) to return an empty list.

Warning: This is generally discouraged because it means that the @Test method will never be executed. This can be justified for complex tests setups that depend on external input or a test class hierarchy, but in general this indicates a bug because a reader will assume the test is run when it is not.

provideValues

@Deprecated
public final List<TestParameters.TestParametersValues> provideValues()

Deprecated.

This method should never be called as it will simply throw an UnsupportedOperationException.

Specified by:

provideValues in interface TestParameters.TestParametersValuesProvider