net.morimekta.providence.testing.util

Class MessageGenerator

java.lang.Object

org.junit.rules.TestWatcher

net.morimekta.providence.testing.util.MessageGenerator

All Implemented Interfaces:

org.junit.rules.TestRule

public class MessageGenerator
extends org.junit.rules.TestWatcher

Providence message serializer that can be used as a junit rule.

 class MyTest {
    {@literal @}Rule
     public MessageGenerator gen = new MessageGenerator()
             .dumpOnFailure()
             .addFactory(f -> f.getName().endsWith("uuid") ? () -> UUID.randomUUID().toString() : null);

    {@literal @}Test
     public testSomething() {
         gen.addFactory(f -> f.equals(MyMessage._Field.NAME) ? () -> "name" : null);
         MyMessage msg = gen.generate(MyMessage.kDescriptor);
         sut.doSomething(msg);

         assertThat(sut.state() is(SystemToTest.CORRECT));
     }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageGenerator.ValueSupplierFactory Factory for value suppliers.

Constructor Summary

Constructors

Constructor and Description
MessageGenerator() Make a simple default message generator.

Method Summary

Modifier and Type	Method and Description
MessageGenerator	addFactories(Collection<MessageGenerator.ValueSupplierFactory> factories) Add a collection of value supplier factories to the generator.
MessageGenerator	addFactories(MessageGenerator.ValueSupplierFactory... factories) Add value supplier factories to the generator.
MessageGenerator	addFactory(MessageGenerator.ValueSupplierFactory factory) Add a value supplier factory to the generator.
void	dumpGeneratedMessages() Dump all generated messages.
MessageGenerator	dumpOnFailure() Dump all generated messages on failure for this test only.
protected void	failed(Throwable e, org.junit.runner.Description description)
protected void	finished(org.junit.runner.Description description)
<M extends PMessage<M,F>,F extends PField> M	generate(PMessageDescriptor<M,F> descriptor) Generate a message with random content.
List<PMessage>	getGenerated() Get all generated messages.
Supplier<Object>	getValueSupplier(PDescriptor descriptor) Get the default value supplier for the given descriptor.
MessageGenerator	setFairy(org.jfairy.Fairy fairy) Set the feiry data generator being used.
MessageGenerator	setFillRate(double fillRate) Set the field fill rate in the range <0.0 ..
MessageGenerator	setMaxCollectionItems(int max) Set the max collection items for default generated collections.
MessageGenerator	setMessageReader(MessageReader reader) Set the message reader for the generator.
MessageGenerator	setMessageWriter(MessageWriter writer) Set the message writer in case of failure.
MessageGenerator	setOutputSerializer(Serializer defaultSerializer) Set default serializer to standard output.
MessageGenerator	setRandom(Random random) Set the random generator being used.
MessageGenerator	setResourceReader(String resource) Read messages from the given resource (pretty formatted).
MessageGenerator	setResourceReader(String resource, Serializer serializer) Read messages from the given resource.
protected void	starting(org.junit.runner.Description description)

Methods inherited from class org.junit.rules.TestWatcher

apply, skipped, skipped, succeeded

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageGenerator

public MessageGenerator()

Make a simple default message generator.

Method Detail

generate

public <M extends PMessage<M,F>,F extends PField> M generate(PMessageDescriptor<M,F> descriptor)

Generate a message with random content.

Type Parameters:

M - The message type.

F - The field type.

Parameters:

descriptor - Message descriptor to generate message from.

Returns:

The generated message.

getGenerated

public List<PMessage> getGenerated()

Get all generated messages. It will return the messages that was *requested* to be generated with all contained messages, not all messages generated all over the place.

Returns:

The list of generated messages.

dumpGeneratedMessages

public void dumpGeneratedMessages()
                           throws IOException

Dump all generated messages.

Throws:

IOException - If writing the messages failed.

setRandom

public MessageGenerator setRandom(Random random)

Set the random generator being used.

Parameters:

random - The random generator.

Returns:

The message generator.

setFairy

public MessageGenerator setFairy(org.jfairy.Fairy fairy)

Set the feiry data generator being used.

Parameters:

fairy - The fairy data generator.

Returns:

The message generator.

setFillRate

public MessageGenerator setFillRate(double fillRate)

Set the field fill rate in the range <0.0 .. 1.0].

Parameters:

fillRate - The new full rate.

Returns:

The message generator.

addFactory

public MessageGenerator addFactory(MessageGenerator.ValueSupplierFactory factory)

Add a value supplier factory to the generator.

Parameters:

factory - The factory.

Returns:

The message generator.

addFactories

public MessageGenerator addFactories(MessageGenerator.ValueSupplierFactory... factories)

Add value supplier factories to the generator.

Parameters:

factories - The factories.

Returns:

The message generator.

addFactories

public MessageGenerator addFactories(Collection<MessageGenerator.ValueSupplierFactory> factories)

Add a collection of value supplier factories to the generator.

Parameters:

factories - The factory.

Returns:

The message generator.

setMessageWriter

public MessageGenerator setMessageWriter(MessageWriter writer)

Set the message writer in case of failure.

Parameters:

writer - The message writer.

Returns:

The message generator.

setMessageReader

public MessageGenerator setMessageReader(MessageReader reader)

Set the message reader for the generator.

Parameters:

reader - The message reader. All messages will be read from this

Returns:

The message generator.

setResourceReader

public MessageGenerator setResourceReader(String resource)

Read messages from the given resource (pretty formatted).

Parameters:

resource - The resource path.

Returns:

The message generator.

setResourceReader

public MessageGenerator setResourceReader(String resource,
                                          Serializer serializer)

Read messages from the given resource.

Parameters:

resource - The resource path.

serializer - Serializer to use for reading resource.

Returns:

The message generator.

setOutputSerializer

public MessageGenerator setOutputSerializer(Serializer defaultSerializer)

Set default serializer to standard output. If test case not started and a writer is already set, this method fails. Not that this will remove any previously set message writer.

Parameters:

defaultSerializer - The new default serializer.

Returns:

The message generator.

setMaxCollectionItems

public MessageGenerator setMaxCollectionItems(int max)

Set the max collection items for default generated collections.

Parameters:

max - The max number of items.

Returns:

The message generator.

dumpOnFailure

public MessageGenerator dumpOnFailure()

Dump all generated messages on failure for this test only.

getValueSupplier

public Supplier<Object> getValueSupplier(PDescriptor descriptor)

Get the default value supplier for the given descriptor.

Parameters:

descriptor - The descriptor to make a supplier for.

Returns:

The value supplier.

starting

protected void starting(org.junit.runner.Description description)

Overrides:

starting in class org.junit.rules.TestWatcher

failed

protected void failed(Throwable e,
                      org.junit.runner.Description description)

Overrides:

failed in class org.junit.rules.TestWatcher

finished

protected void finished(org.junit.runner.Description description)

Overrides:

finished in class org.junit.rules.TestWatcher