Migration guide

Fixture Monkey Migration Guide to Version 0.5.0 and Above

If you are using Fixture Monkey version 0.4.x or earlier, the following guide outlines the steps needed to migrate your existing codebase to version 0.5.0 or a later version.

Options

addAnnotatedArbitraryGenerator

public FixtureOptionsBuilder addAnnotatedArbitraryGenerator(Class<?> clazz, AnnotatedArbitraryGenerator<?> generator) 

public interface AnnotatedArbitraryGenerator<T> {
	Arbitrary<T> generate(AnnotationSource annotationSource);
}

Adding or altering new AnnotatedType used addAnnotatedArbitraryGenerator before 0.5

It is much complicated because there are two concerns, generating object, applying annotations.

0.5

There are two interfaces for generating object, applying annotations in 0.5

Option JavaTypeArbitraryGenerator supports generating default Java type.

Override methods for defining your custom default value.

public FixtureMonkeyBuilder javaTypeArbitraryGenerator(
    JavaTypeArbitraryGenerator javaTypeArbitraryGenerator
)

public interface JavaTypeArbitraryGenerator {
	default StringArbitrary strings() {
		return Arbitraries.strings();
	}
    ...
}

Option JavaArbitraryResolver supports applying annotations for default Java type.

Override methods for defining how applying your custom annotations.

public FixtureMonkeyBuilder javaArbitraryResolver(JavaArbitraryResolver javaArbitraryResolver)

public interface JavaArbitraryResolver {
	default Arbitrary<String> strings(StringArbitrary stringArbitrary, ArbitraryGeneratorContext context) {
		return stringArbitrary;
	}
    ...
}

Option JavaTimeTypeArbitraryGenerator supports generating default Java time/date type.

Override methods for defining your custom default value.

public FixtureMonkeyBuilder javaTimeTypeArbitraryGenerator(
		JavaTimeTypeArbitraryGenerator javaTimeTypeArbitraryGenerator
	)

public interface JavaTimeTypeArbitraryGenerator {
	default CalendarArbitrary calendars() {
		Instant now = Instant.now();
		Calendar min = Calendar.getInstance();
		min.setTimeInMillis(now.minus(365, ChronoUnit.DAYS).toEpochMilli());
		Calendar max = Calendar.getInstance();
		max.setTimeInMillis(now.plus(365, ChronoUnit.DAYS).toEpochMilli());
		return Dates.datesAsCalendar()
			.between(min, max);
	}
    ...
}

Option pushAssignableTypeArbitraryIntrospector supports generating all other types.

public FixtureMonkeyBuilder pushAssignableTypeArbitraryIntrospector(
		Class<?> type,
		ArbitraryIntrospector arbitraryIntrospector
) 

defaultGenerator

public FixtureMonkeyBuilder defaultGenerator(ArbitraryGenerator defaultCombiner)

Option defaultGenerator supports altering the way of instantiating before 0.5.

0.5

For same usage, using interface ArbitraryIntrospector instead of ArbitraryGenerator in 0.5. Option objectIntrospector supports same feature.

Option objectIntrospector decides the way of instantiating.

ex. ConstructorPropertiesArbitraryIntrospector, BeanArbitraryIntrospector

public FixtureMonkeyBuilder objectIntrospector(ArbitraryIntrospector objectIntrospector)

putGenerator

Option putGenerator supports generating types without applying annotations before 0.5.

public FixtureMonkeyBuilder putGenerator(Class<?> type, ArbitraryGenerator generator)

0.5

Option pushAssignableTypeArbitraryIntrospector is same option in 0.5.

public FixtureMonkeyBuilder pushAssignableTypeArbitraryIntrospector(
	Class<?> type,
	ArbitraryIntrospector arbitraryIntrospector
)

addInterfaceSupplier

public <T> FixtureMonkeyBuilder addInterfaceSupplier(Class<T> clazz, InterfaceSupplier<T> interfaceSupplier)

Option addIntrefaceSupplier supports generating interface.

0.5

Option pushAssignableTypeArbitraryIntrospector is same option in 0.5.

public FixtureMonkeyBuilder pushAssignableTypeArbitraryIntrospector(
	Class<?> type,
	ArbitraryIntrospector arbitraryIntrospector
)

null Option

nullableArbitraryEvaluator

public FixtureOptionsBuilder nullableArbitraryEvaluator(NullableArbitraryEvaluator nullableArbitraryEvaluator)

public interface NullableArbitraryEvaluator {
	default boolean isNullable(Field field) {
		return true;
	}
}

Option nullableArbitraryEvaluator is for some languages like Kotlin have some properties for determining nullable field.

class KotlinNullableArbitraryEvaluator : NullableArbitraryEvaluator {
    override fun isNullable(field: Field): Boolean {
        return field.kotlinProperty?.returnType?.isMarkedNullable ?: true
    }
}

nullInject

public FixtureOptionsBuilder nullInject(double nullInject)

Setting nullInject probabilities.

nullableContainer

public FixtureOptionsBuilder nullableContainer(boolean nullableContainer)

Determines if container type would be nullable or not.

defaultNotNull

public FixtureMonkeyBuilder defaultNotNull(boolean defaultNotNull)

Not nullInject even if marking as @Nullable. Only set as null when using setNull.

0.5

Interface NullInjectGenerator is used for all features about null in 0.5. Option defaultNullInjectGenerator supports altering default NullInjectGenerator.

You could set all of options mentioned above when instantiating DefaultNullInjectGenerator

public GenerateOptionsBuilder defaultNullInjectGenerator(NullInjectGenerator defaultNullInjectGenerator)

public final class DefaultNullInjectGenerator implements NullInjectGenerator {
	private final double defaultNullInject;
	private final boolean nullableContainer;
	private final boolean defaultNotNull;

	private final boolean nullableElement;
	private final Set<String> nullableAnnotationTypes;
	private final Set<String> notNullAnnotationTypes;
}

Overview

Type generation

Before 0.5

• Three type options AnnotatedType, Type, Interface
• Instantiating and applying use same interface

0.5

• Two type options Java type, other types
• Instantiating and applying use different interfaces

Null options

Before 0.5

• nullableArbitraryEvaluator, nullInject, nullableContainer, defaultNotNull

0.5

• defaultNullInjectGenerator

Plugin

public FixtureMonkeyBuilder plugin(Plugin plugin) {
		generateOptionsBuilder.plugin(plugin);
		return this;
}

public interface Plugin {
	void accept(GenerateOptionsBuilder optionsBuilder);
}

Interface Plugin is added for better use of third-party library.

Adding third-party dependency and adding option plugin.

Plugin overwrites same option, ordering is important.