com.github.writethemfirst.approvals

Class Approvals

java.lang.Object

com.github.writethemfirst.approvals.Approvals

public class Approvals
extends Object

Method Summary

Modifier and Type	Method and Description
static void	verify(Object output) Compares the actual output of your program (the function’s argument) and the content of the approved file matching with the test method.
static void	verify(Path output) Compares the actual output of your program (the function’s argument) and the content of the approved file matching with the test method.
static <I1> void	verifyAllCombinations(I1[] args1, Function1<I1,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static <I1,I2> void	verifyAllCombinations(I1[] args1, I2[] args2, Function2<I1,I2,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static <I1,I2,I3> void	verifyAllCombinations(I1[] args1, I2[] args2, I3[] args3, Function3<I1,I2,I3,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static <I1,I2,I3,I4> void	verifyAllCombinations(I1[] args1, I2[] args2, I3[] args3, I4[] args4, Function4<I1,I2,I3,I4,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static <I1,I2,I3,I4,I5> void	verifyAllCombinations(I1[] args1, I2[] args2, I3[] args3, I4[] args4, I5[] args5, Function5<I1,I2,I3,I4,I5,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static <I1> void	verifyAllCombinations(Iterable<I1> args1, Function1<I1,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static <I1,I2> void	verifyAllCombinations(Iterable<I1> args1, Iterable<I2> args2, Function2<I1,I2,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static <I1,I2,I3> void	verifyAllCombinations(Iterable<I1> args1, Iterable<I2> args2, Iterable<I3> args3, Function3<I1,I2,I3,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static <I1,I2,I3,I4> void	verifyAllCombinations(Iterable<I1> args1, Iterable<I2> args2, Iterable<I3> args3, Iterable<I4> args4, Function4<I1,I2,I3,I4,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static <I1,I2,I3,I4,I5> void	verifyAllCombinations(Iterable<I1> args1, Iterable<I2> args2, Iterable<I3> args3, Iterable<I4> args4, Iterable<I5> args5, Function5<I1,I2,I3,I4,I5,?> f) Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).
static void	verifyAllFiles(Path actualFolder) Compares the actual output of your program (files in the folder actualFolder) and the content of the approved “Master” folder matching with the test method.

Methods inherited from class java.lang.Object

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

Method Detail

verify

public static void verify(Object output)

Compares the actual output of your program (the function’s argument) and the content of the approved file matching with the test method.

It’ll use a temporary received file to store the output of your program. This file will be erased in case the results are matching. Otherwise, it will be kept for you to review it.

In case of differences found in the output, the Reporter linked to this Approvals instance will be called (Reporter#mismatch(Path, Path)).

Parameters:

output - Any object with a Object.toString() representation containing the output of your program. It will be compared to the associated approved file.

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verify

public static void verify(Path output)

Compares the actual output of your program (the function’s argument) and the content of the approved file matching with the test method.

It’ll use a temporary received folder to store a copy of the output of your program. This file will be erased in case the results are matching. Otherwise, it will be kept for you to review it.

In case of differences found in the output, the Reporter linked to this Approvals instance will be called (Reporter#mismatch(Path, Path)).

Parameters:

output - a Path containing the output of your program. It will be compared to the associated approved file.

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllFiles

public static void verifyAllFiles(Path actualFolder)

Compares the actual output of your program (files in the folder actualFolder) and the content of the approved “Master” folder matching with the test method.

It’ll use a temporary received folder to copy the actual files from your program. This folder and its files will be erased in case the results are matching. Otherwise, they will be kept for you to review it.

In case of differences found in the output, the Reporter linked to this Approvals instance will be called (Reporter#mismatch(Path, Path)) for each mismatched file.

Parameters:

actualFolder - the folder containing the output of your program. It will be compared to the associated approved folder

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1> void verifyAllCombinations(Iterable<I1> args1,
                                              Function1<I1,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1 specified in the Iterable. Then the results are stored, one line for each value, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1> void verifyAllCombinations(I1[] args1,
                                              Function1<I1,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1 specified in the array. Then the results are stored, one line for each value, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1,I2> void verifyAllCombinations(Iterable<I1> args1,
                                                 Iterable<I2> args2,
                                                 Function2<I1,I2,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1 and args2 specified in the Iterables. Then the results are stored, one line for each combination, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the first argument of f you want to verify

args2 - all values for the second argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1,I2> void verifyAllCombinations(I1[] args1,
                                                 I2[] args2,
                                                 Function2<I1,I2,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1 and args2 specified in the arrayss. Then the results are stored, one line for each combination, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the first argument of f you want to verify

args2 - all values for the second argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1,I2,I3> void verifyAllCombinations(Iterable<I1> args1,
                                                    Iterable<I2> args2,
                                                    Iterable<I3> args3,
                                                    Function3<I1,I2,I3,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1, args2 and args3 specified in the Iterables. Then the results are stored, one line for each combination, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the first argument of f you want to verify

args2 - all values for the second argument of f you want to verify

args3 - all values for the third argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1,I2,I3> void verifyAllCombinations(I1[] args1,
                                                    I2[] args2,
                                                    I3[] args3,
                                                    Function3<I1,I2,I3,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1, args2 and args3 specified in the arrays. Then the results are stored, one line for each combination, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the first argument of f you want to verify

args2 - all values for the second argument of f you want to verify

args3 - all values for the third argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1,I2,I3,I4> void verifyAllCombinations(Iterable<I1> args1,
                                                       Iterable<I2> args2,
                                                       Iterable<I3> args3,
                                                       Iterable<I4> args4,
                                                       Function4<I1,I2,I3,I4,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1, args2, args3 and args4 specified in the Iterables. Then the results are stored, one line for each combination, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the first argument of f you want to verify

args2 - all values for the second argument of f you want to verify

args3 - all values for the third argument of f you want to verify

args4 - all values for the fourth argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1,I2,I3,I4> void verifyAllCombinations(I1[] args1,
                                                       I2[] args2,
                                                       I3[] args3,
                                                       I4[] args4,
                                                       Function4<I1,I2,I3,I4,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1, args2, args3 and args4 specified in the arrays. Then the results are stored, one line for each combination, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the first argument of f you want to verify

args2 - all values for the second argument of f you want to verify

args3 - all values for the third argument of f you want to verify

args4 - all values for the fourth argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1,I2,I3,I4,I5> void verifyAllCombinations(Iterable<I1> args1,
                                                          Iterable<I2> args2,
                                                          Iterable<I3> args3,
                                                          Iterable<I4> args4,
                                                          Iterable<I5> args5,
                                                          Function5<I1,I2,I3,I4,I5,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1, args2, args3, args4 and args5 specified in the Iterables. Then the results are stored, one line for each combination, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the first argument of f you want to verify

args2 - all values for the second argument of f you want to verify

args3 - all values for the third argument of f you want to verify

args4 - all values for the fourth argument of f you want to verify

args5 - all values for the fifth argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed

verifyAllCombinations

public static <I1,I2,I3,I4,I5> void verifyAllCombinations(I1[] args1,
                                                          I2[] args2,
                                                          I3[] args3,
                                                          I4[] args4,
                                                          I5[] args5,
                                                          Function5<I1,I2,I3,I4,I5,?> f)

Compares the actual output of your program and the content of the approved file matching with the test method (see verify(Object) for details).

The lambda or method f is called for all values of args1, args2, args3, args4 and args5 specified in the arrays. Then the results are stored, one line for each combination, in a String, which is used as in the standard verify(Object) method.

Parameters:

args1 - all values for the first argument of f you want to verify

args2 - all values for the second argument of f you want to verify

args3 - all values for the third argument of f you want to verify

args4 - all values for the fourth argument of f you want to verify

args5 - all values for the fifth argument of f you want to verify

f - the lambda or method you want to test

Throws:

AssertionError - if the Reporter implementation relies on standard assertions provided by a framework like JUnit

RuntimeException - if the Reporter relies on executing an external command which failed