com.redfin.fuzzy

Class Generator<T>

java.lang.Object

com.redfin.fuzzy.Generator<T>

Type Parameters:

T - the type of value produced by this generator.

All Implemented Interfaces:

Comparable<Generator<T>>

public class Generator<T>
extends Object
implements Comparable<Generator<T>>

The generator is a stand-in for an input value in a test case. It is composed of one or more cases that describe the types of value the generator represents. The fuzzy engine will ensure that your test is executed with each equivalency class supported by your generators.

 @Test
 public void myTest() {
     // Declare all generators at the beginning of your test, before you call .get() on any of them.
     Generator<String> inputString = Generator.of(Any.string());
     Generator<Integer> inputInt = Generator.of(Any.integer());

     String actual = subject.someMethod(inputString.get(), inputInt.get());

     // Each subsequent call to .get() will return the same value, so you can use them multiple times in your test.
     assertEquals(inputString.get() + " " + inputInt.get(), actual);
 }
 

Once you have declared the generators used by your test, you can obtain specific test values by calling the get() method. For a given iteration, each subsequent call to get will return exactly the same value, so it is not necessary to store the result in a separate variable. For example:

You must declare each generator used by your test before any of them are used (by calling get). This pattern ensures that fuzzy understands how many test permutations are necessary without the need for too much boilerplate code.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Generator.GeneratorBuilder

Method Summary

Modifier and Type	Method and Description
int	compareTo(Generator<T> o)
boolean	equals(Object obj)
T	get()
List<StackTraceElement>	getCreationSite()
String	getName()
int	hashCode()
static Generator.GeneratorBuilder	named(String name)
static <X> Generator<X>	of(Case<X>... cases)
static <X> Generator<X>	of(Subcase<X>... subcases)
static <X> Generator<X>	of(X... literals)
static <X> Generator<X>	ofCases(Case<X>... cases)

Methods inherited from class java.lang.Object

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

Method Detail

getName

public final String getName()

getCreationSite

public final List<StackTraceElement> getCreationSite()

get

public final T get()

named

public static Generator.GeneratorBuilder named(String name)

of

@SafeVarargs
public static <X> Generator<X> of(Case<X>... cases)

of

@SafeVarargs
public static <X> Generator<X> of(X... literals)

ofCases

@SafeVarargs
public static <X> Generator<X> ofCases(Case<X>... cases)

of

@SafeVarargs
public static <X> Generator<X> of(Subcase<X>... subcases)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public final int compareTo(Generator<T> o)

Specified by:

compareTo in interface Comparable<Generator<T>>