okey-doke

An Approval Testing library for Java and JUnit - like Llewellyn Falco's but more Java'y.

A helping hand for many testing problems.

JUnit 4

The basic mode of operation is ApprovalsRuleTest to compare current thing with an approved version and fail with a diff if they aren't the same.

    @Rule public final ApprovalsRule approver = ApprovalsRule.usualRule();

    @Test
    public void doesnt_match_where_no_approved_result() throws IOException {
        whenApprovedIs(null);
        try {
            approver.assertApproved("banana");
            fail("should have thrown");
        } catch (AssertionError expected) {
        }
    }

    @Test
    public void matches_when_approved_result_matches() throws IOException {
        whenApprovedIs("banana");
        approver.assertApproved("banana");
    }

    @Test
    public void doesnt_match_when_approved_result_doesnt_match() throws IOException {
        whenApprovedIs("banana");
        try {
            approver.assertApproved("kumquat");
            fail("should have thrown");
        } catch (AssertionFailedError expected) {
            assertEquals("kumquat", expected.getActual().getValue());
            assertEquals("banana", expected.getExpected().getValue());
        }
    }

Next try LockDownTest for easy testing of legacy code.

    @ClassRule public static final TheoryApprovalsRule theoryRule = fileSystemRule("src/test/java");
    @Rule public final TheoryApprovalsRule.TheoryApprover approver = theoryRule.approver();

    @DataPoints public static final Fruit[] FRUITS = Fruit.values();
    @DataPoints public static final Animal[] ANIMALS = Animal.values();
    @DataPoints public static final int[] INTS = { -1, 0, 1, 2, 42 };

    @Theory
    public void legacyMethod_checked_reflectively(Fruit fruit, Animal animal, int  i) throws InvocationTargetException, NoSuchMethodException, IllegalAccessException {
        approver.lockDownReflectively(this, "legacyMethod", fruit.name(), animal.name(), i);
    }

    @Theory
    public void legacyMethod_checked_fluently(Fruit fruit, Animal animal, int  i) throws InvocationTargetException, NoSuchMethodException, IllegalAccessException {
        approver.lockDown(this).legacyMethod(fruit.name(), animal.name(), i);
    }

    public String legacyMethod(String fruitName, String animalName, int i) {
        return String.format("%s %s eating %ss", i, fruitName, animalName);
    }

    private static enum Fruit {
        apple, banana, kumquat
    }

    private static enum Animal {
        bear, cat, dog
    }

Then move on to

• TranscriptTest for producing approved files with interactions
• Konsent for producing Gerkin-like output from your tests that the customer can approve.

JUnit 5

Thanks to @jshiell we now have basic JUnit 5 support.

The basic mode of operation is

ApprovalsExtensionTest to compare current thing with an approved version and fail with a diff if they aren't the same.

@ExtendWith(ApprovalsExtension.class)
public class ApprovalsExtensionTest {


    @Test
    public void doesnt_match_where_no_approved_result(Approver approver) throws IOException {
        whenApprovedIs(null, approver);
        try {
            approver.assertApproved("banana");
            fail("should have thrown");
        } catch (AssertionError expected) {
        }
    }

    @Test
    public void matches_when_approved_result_matches(Approver approver) throws IOException {
        whenApprovedIs("banana", approver);
        approver.assertApproved("banana");
    }

    @Test
    public void doesnt_match_when_approved_result_doesnt_match(Approver approver) throws IOException {
        whenApprovedIs("banana", approver);
        try {
            approver.assertApproved("kumquat");
            fail("should have thrown");
        } catch (AssertionFailedError expected) {
            assertEquals("kumquat", expected.getActual().getValue());
            assertEquals("banana", expected.getExpected().getValue());
        }
    }

IntelliJ

Oh, and I should mention, there is an IntelliJ plugin (thanks @s4nchez) to help approve your output.