org.apache.beam.sdk.testing

Class PAssert

java.lang.Object

org.apache.beam.sdk.testing.PAssert

public class PAssert
extends Object

An assertion on the contents of a PCollection incorporated into the pipeline. Such an assertion can be checked no matter what kind of PipelineRunner is used.

Note that the PAssert call must precede the call to Pipeline.run().

Examples of use:

 Pipeline p = TestPipeline.create();
 ...
 PCollection<String> output =
      input
      .apply(ParDo.of(new TestDoFn()));
 PAssert.that(output)
     .containsInAnyOrder("out1", "out2", "out3");
 ...
 PCollection<Integer> ints = ...
 PCollection<Integer> sum =
     ints
     .apply(Combine.globally(new SumInts()));
 PAssert.that(sum)
     .is(42);
 ...
 p.run();
 

JUnit and Hamcrest must be linked in by any code that uses PAssert.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PAssert.GroupThenAssert<T> A transform that applies an assertion-checking function over iterables of ActualT to the entirety of the contents of its input.
static class	PAssert.GroupThenAssertForSingleton<T> A transform that applies an assertion-checking function to a single iterable contained as the sole element of a PCollection.
static interface	PAssert.IterableAssert<T> Builder interface for assertions applicable to iterables and PCollection contents.
static class	PAssert.OneSideInputAssert<ActualT> An assertion checker that takes a single PCollectionView<ActualT> and an assertion over ActualT, and checks it within a Beam pipeline.
static interface	PAssert.SingletonAssert<T> Builder interface for assertions applicable to a single value.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAILURE_COUNTER
static String	SUCCESS_COUNTER

Method Summary

Modifier and Type	Method and Description
static <T> PAssert.IterableAssert<T>	that(PCollection<T> actual) Constructs an PAssert.IterableAssert for the elements of the provided PCollection.
static <K,V> PAssert.SingletonAssert<Map<K,V>>	thatMap(PCollection<KV<K,V>> actual) Constructs a PAssert.SingletonAssert for the value of the provided PCollection, which must have at most one value per key.
static <K,V> PAssert.SingletonAssert<Map<K,Iterable<V>>>	thatMultimap(PCollection<KV<K,V>> actual) Constructs a PAssert.SingletonAssert for the value of the provided PCollection.
static <T> PAssert.SingletonAssert<T>	thatSingleton(PCollection<T> actual) Constructs a PAssert.SingletonAssert for the value of the provided PCollection PCollection<T>, which must be a singleton.
static <T> PAssert.IterableAssert<T>	thatSingletonIterable(PCollection<? extends Iterable<T>> actual) Constructs an PAssert.IterableAssert for the value of the provided PCollection which must contain a single Iterable<T> value.

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS_COUNTER

public static final String SUCCESS_COUNTER

See Also:

Constant Field Values

FAILURE_COUNTER

public static final String FAILURE_COUNTER

See Also:

Constant Field Values

Method Detail

that

public static <T> PAssert.IterableAssert<T> that(PCollection<T> actual)

Constructs an PAssert.IterableAssert for the elements of the provided PCollection.

thatSingletonIterable

public static <T> PAssert.IterableAssert<T> thatSingletonIterable(PCollection<? extends Iterable<T>> actual)

Constructs an PAssert.IterableAssert for the value of the provided PCollection which must contain a single Iterable<T> value.

thatSingleton

public static <T> PAssert.SingletonAssert<T> thatSingleton(PCollection<T> actual)

Constructs a PAssert.SingletonAssert for the value of the provided PCollection PCollection<T>, which must be a singleton.

thatMultimap

public static <K,V> PAssert.SingletonAssert<Map<K,Iterable<V>>> thatMultimap(PCollection<KV<K,V>> actual)

Constructs a PAssert.SingletonAssert for the value of the provided PCollection.

Note that the actual value must be coded by a KvCoder, not just any Coder<K, V>.

thatMap

public static <K,V> PAssert.SingletonAssert<Map<K,V>> thatMap(PCollection<KV<K,V>> actual)

Constructs a PAssert.SingletonAssert for the value of the provided PCollection, which must have at most one value per key.

Note that the actual value must be coded by a KvCoder, not just any Coder<K, V>.