io.github.glytching.junit.extension.random

Class RandomBeansExtension

java.lang.Object

io.github.glytching.junit.extension.random.RandomBeansExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.ParameterResolver, org.junit.jupiter.api.extension.TestInstancePostProcessor

public class RandomBeansExtension
extends Object
implements org.junit.jupiter.api.extension.TestInstancePostProcessor, org.junit.jupiter.api.extension.ParameterResolver

The random beans extension provides a test with randomly generated objects, including:

• JDK types
• Custom types
• Collections
• Generic collections
• Partial population

Usage examples:

Injecting random values as fields:

 @ExtendWith(RandomBeansExtension.class)
 public class MyTest {

     @Random
     private String anyString;

     @Random(excluded = {"name", "value"})
     private List anyPartiallyPopulatedDomainObject;

     @Random(type = DomainObject.class)
     private List anyDomainObjects;

     @Test
     public void testUsingRandomString() {
         // use the injected anyString
         // ...
     }

     @Test
     public void testUsingRandomDomainObjects() {
         // use the injected anyDomainObjects
         // the anyDomainObjects will contain _N_ fully populated random instances of DomainObject
         // ...
     }

     @Test
     public void testUsingPartiallyPopulatedDomainObject() {
         // use the injected anyPartiallyPopulatedDomainObject
         // this object's "name" and "value" members will not be populated since this has been declared with
         //     excluded = {"name", "value"}
         // ...
     }
 }
 

Injecting random values as parameters:

 @ExtendWith(RandomBeansExtension.class)
 public class MyTest {

     @Test
     @ExtendWith(RandomBeansExtension.class)
     public void testUsingRandomString(@Random String anyString) {
         // use the provided anyString
         // ...
     }

     @Test
     @ExtendWith(RandomBeansExtension.class)
     public void testUsingRandomDomainObjects(@Random(type = DomainObject.class) List anyDomainObjects) {
         // use the injected anyDomainObjects
         // the anyDomainObjects will contain _N_ fully populated random instances of DomainObject
         // ...
     }

     @Test
     @ExtendWith(RandomBeansExtension.class)
     public void testUsingPartiallyPopulatedDomainObject(@Random(excluded = {"name", "value"}) List anyPartiallyPopulatedDomainObject) {
         // use the injected anyPartiallyPopulatedDomainObject
         // this object's "name" and "value" members will not be populated since this has been declared with
         //     excluded = {"name", "value"}
         // ...
     }
 }
 

Since:

1.0.0

See Also:

Random Beans

Constructor Summary

Constructors

Constructor and Description
RandomBeansExtension() Create the extension with a default EnhancedRandom.
RandomBeansExtension(io.github.benas.randombeans.api.EnhancedRandom enhancedRandom) Create the extension with the given EnhancedRandom.

Method Summary

Modifier and Type	Method and Description
void	postProcessTestInstance(Object testInstance, org.junit.jupiter.api.extension.ExtensionContext extensionContext) Inject random values into any fields which are annotated with Random.
Object	resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext) Provides a value for any parameter context which has passed the supportsParameter(ParameterContext, ExtensionContext) gate.
boolean	supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext) Does this extension support injection for parameters of the type described by the given parameterContext?

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomBeansExtension

public RandomBeansExtension()

Create the extension with a default EnhancedRandom.

See Also:

Enhanced Random Configuration Parameters

RandomBeansExtension

public RandomBeansExtension(io.github.benas.randombeans.api.EnhancedRandom enhancedRandom)

Create the extension with the given EnhancedRandom. This is used, instead of the zero-arg alternative, when the caller wants to override the default 'randomizer' configuration. This constructor will be called by using the RegisterExtension annotation.

Parameters:

enhancedRandom -

Since:

2.5.0

Method Detail

supportsParameter

public boolean supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                          throws org.junit.jupiter.api.extension.ParameterResolutionException

Does this extension support injection for parameters of the type described by the given parameterContext?

Specified by:

supportsParameter in interface org.junit.jupiter.api.extension.ParameterResolver

Parameters:

parameterContext - the context for the parameter for which an argument should be resolved

extensionContext - the extension context for the Executable about to be invoked

Returns:

true if the given parameterContext is annotated with Random, false otherwise

Throws:

org.junit.jupiter.api.extension.ParameterResolutionException

resolveParameter

public Object resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                               org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                        throws org.junit.jupiter.api.extension.ParameterResolutionException

Provides a value for any parameter context which has passed the supportsParameter(ParameterContext, ExtensionContext) gate.

Specified by:

resolveParameter in interface org.junit.jupiter.api.extension.ParameterResolver

Parameters:

parameterContext - the context for the parameter for which an argument should be resolved

extensionContext - the context in which the current test or container is being executed

Returns:

a randomly generated object

Throws:

org.junit.jupiter.api.extension.ParameterResolutionException

postProcessTestInstance

public void postProcessTestInstance(Object testInstance,
                                    org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                             throws Exception

Inject random values into any fields which are annotated with Random. This method doesn't populate static fields if they have values.

Specified by:

postProcessTestInstance in interface org.junit.jupiter.api.extension.TestInstancePostProcessor

Parameters:

testInstance - the instance to post-process

extensionContext - the current extension context

Throws:

Exception