com.hazelcast.jet.test

Class TestSupport

java.lang.Object

com.hazelcast.jet.test.TestSupport

public final class TestSupport
extends Object

Utilities to write unit tests.

Method Summary

Modifier and Type	Method and Description
static void	drainOutbox(Queue<Object> outboxBucket, List<Object> outputList) Move all items from the outbox to the outputList.
static Processor	processorFrom(DistributedSupplier<Processor> supplier) Gets single processor instance from processor supplier.
static Processor	processorFrom(ProcessorMetaSupplier supplier) Gets single processor instance from meta processor supplier.
static Processor	processorFrom(ProcessorSupplier supplier) Gets single processor instance from processor supplier.
static <T,U> void	testProcessor(DistributedSupplier<Processor> supplier, List<T> input, List<U> expectedOutput) Convenience for testProcessor(Processor, List, List, boolean) with progress assertion enabled.
static <T,U> void	testProcessor(DistributedSupplier<Processor> supplier, List<T> input, List<U> expectedOutput, boolean assertProgress) Convenience for testProcessor(Processor, List, List, boolean) extracting the processor instance from the supplier.
static <T,U> void	testProcessor(Processor processor, List<T> input, List<U> expectedOutput) Convenience for testProcessor(Processor, List, List, boolean) with progress assertion enabled.
static <T,U> void	testProcessor(Processor processor, List<T> input, List<U> expectedOutput, boolean assertProgress) A utility to test processors.
static <T,U> void	testProcessor(ProcessorMetaSupplier supplier, List<T> input, List<U> expectedOutput) Convenience for testProcessor(Processor, List, List, boolean) with progress assertion enabled.
static <T,U> void	testProcessor(ProcessorMetaSupplier supplier, List<T> input, List<U> expectedOutput, boolean assertProgress) Convenience for testProcessor(Processor, List, List, boolean) extracting the processor instance from the supplier.
static <T,U> void	testProcessor(ProcessorSupplier supplier, List<T> input, List<U> expectedOutput) Convenience for testProcessor(Processor, List, List, boolean) with progress assertion enabled.
static <T,U> void	testProcessor(ProcessorSupplier supplier, List<T> input, List<U> expectedOutput, boolean assertProgress) Convenience for testProcessor(Processor, List, List, boolean) extracting the processor instance from the supplier.

Methods inherited from class java.lang.Object

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

Method Detail

testProcessor

public static <T,U> void testProcessor(@Nonnull
                                       DistributedSupplier<Processor> supplier,
                                       @Nonnull
                                       List<T> input,
                                       @Nonnull
                                       List<U> expectedOutput)

Convenience for testProcessor(Processor, List, List, boolean) with progress assertion enabled.

testProcessor

public static <T,U> void testProcessor(@Nonnull
                                       ProcessorSupplier supplier,
                                       @Nonnull
                                       List<T> input,
                                       @Nonnull
                                       List<U> expectedOutput)

Convenience for testProcessor(Processor, List, List, boolean) with progress assertion enabled.

testProcessor

public static <T,U> void testProcessor(@Nonnull
                                       ProcessorMetaSupplier supplier,
                                       @Nonnull
                                       List<T> input,
                                       @Nonnull
                                       List<U> expectedOutput)

Convenience for testProcessor(Processor, List, List, boolean) with progress assertion enabled.

testProcessor

public static <T,U> void testProcessor(@Nonnull
                                       Processor processor,
                                       @Nonnull
                                       List<T> input,
                                       @Nonnull
                                       List<U> expectedOutput)

Convenience for testProcessor(Processor, List, List, boolean) with progress assertion enabled.

testProcessor

public static <T,U> void testProcessor(@Nonnull
                                       DistributedSupplier<Processor> supplier,
                                       @Nonnull
                                       List<T> input,
                                       @Nonnull
                                       List<U> expectedOutput,
                                       boolean assertProgress)

Convenience for testProcessor(Processor, List, List, boolean) extracting the processor instance from the supplier.

testProcessor

public static <T,U> void testProcessor(@Nonnull
                                       ProcessorSupplier supplier,
                                       @Nonnull
                                       List<T> input,
                                       @Nonnull
                                       List<U> expectedOutput,
                                       boolean assertProgress)

Convenience for testProcessor(Processor, List, List, boolean) extracting the processor instance from the supplier.

testProcessor

public static <T,U> void testProcessor(@Nonnull
                                       ProcessorMetaSupplier supplier,
                                       @Nonnull
                                       List<T> input,
                                       @Nonnull
                                       List<U> expectedOutput,
                                       boolean assertProgress)

Convenience for testProcessor(Processor, List, List, boolean) extracting the processor instance from the supplier.

testProcessor

public static <T,U> void testProcessor(@Nonnull
                                       Processor processor,
                                       @Nonnull
                                       List<T> input,
                                       @Nonnull
                                       List<U> expectedOutput,
                                       boolean assertProgress)

A utility to test processors. It will initialize the processor instance, pass input items to it and assert the outbox contents.

This method does the following:

• initializes the processor by calling Processor.init( com.hazelcast.jet.Outbox, com.hazelcast.jet.Processor.Context)
• calls Processor.process(0, inbox), the inbox contains all items from input parameter
• asserts the progress of the process() call: that something was taken from the inbox or put to the outbox
• calls Processor.complete() until it returns true
• asserts the progress of the complete() call if it returned false: something must have been put to the outbox.

Note that this method never calls Processor.tryProcess().

For cooperative processors a 1-capacity outbox will be provided, which will additionally be full in every other call to process(). This will test the edge case: the process() method is called even when the outbox is full to give the processor a chance to process inbox.

This class does not cover these cases:

• Testing of processors which distinguish input or output edges by ordinal
• Checking that the state of a stateful processor is empty at the end (you can do that yourself afterwards).

Example usage. This will test one of the jet-provided processors:

 TestSupport.testProcessor(
         Processors.map((String s) -> s.toUpperCase()),
         asList("foo", "bar"),
         asList("FOO", "BAR")
 );
 

Type Parameters:

T - input items type

U - output items type

Parameters:

processor - a processor instance to test

input - input to pass

expectedOutput - expected output

assertProgress - if false, progress will not be asserted after process() and complete() calls

See Also:

testProcessor(Processor, List, List, boolean)

drainOutbox

public static void drainOutbox(Queue<Object> outboxBucket,
                               List<Object> outputList)

Move all items from the outbox to the outputList.

Parameters:

outboxBucket - the queue from Outbox to drain

outputList - target list

processorFrom

public static Processor processorFrom(DistributedSupplier<Processor> supplier)

Gets single processor instance from processor supplier.

processorFrom

public static Processor processorFrom(ProcessorSupplier supplier)

Gets single processor instance from processor supplier.

processorFrom

public static Processor processorFrom(ProcessorMetaSupplier supplier)

Gets single processor instance from meta processor supplier.