com.github.writethemfirst.approvals

Class FolderApprover

java.lang.Object

com.github.writethemfirst.approvals.Approver

com.github.writethemfirst.approvals.FolderApprover

public class FolderApprover
extends Approver

Approves a folder. See verifyAllFiles(Path).

Constructor Summary

Constructors

Constructor and Description
FolderApprover() Standard FolderApprovals.

Method Summary

Modifier and Type	Method and Description
FolderApprover	reportTo(Reporter reporter) Specifies the reporter used to report mismatches.
FolderApprover	testing(java.lang.Class<?> testClass) Specifies the testClass to use as a folder name to store approved and received files.
void	verifyAllFiles(java.nio.file.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.
FolderApprover	writeTo(java.lang.String customFileName) Specifies the name to use for approved and received files.

Methods inherited from class com.github.writethemfirst.approvals.Approver

verify

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderApprover

public FolderApprover()

Standard FolderApprovals.

Method Detail

reportTo

public FolderApprover reportTo(Reporter reporter)

Specifies the reporter used to report mismatches.

Overrides:

reportTo in class Approver

Returns:

a copy of this FolderApprovals

writeTo

public FolderApprover writeTo(java.lang.String customFileName)

Specifies the name to use for approved and received files.

Overrides:

writeTo in class Approver

Returns:

a copy of this FolderApprovals

testing

public FolderApprover testing(java.lang.Class<?> testClass)

Specifies the testClass to use as a folder name to store approved and received files.

Overrides:

testing in class Approver

Returns:

a copy of this Approvals

verifyAllFiles

public void verifyAllFiles(java.nio.file.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:

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

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