com.github.writethemfirst.approvals.files

Class ApprovalFiles

java.lang.Object

com.github.writethemfirst.approvals.files.ApprovalFiles

public class ApprovalFiles
extends java.lang.Object

ApprovalFiles

Approval Testing relies on 2 specific files for storing the execution results of the Program Under Tests and running comparisons over the output of the program.

Approvals-Java provides various features, including being able to approve single files, but also to validate the output of a program using an approved folder (which can then contain various subfolders and files).

This class allows to store references of the 2 particular entries to consider: the approved and received entries, which are used to store the reference data, and the temporary output of the program for comparison. The class manages both cases provided by the framework: single files, or complete folders.

This class not only will hold the references of the approved and received entries, but it’ll also provide all the necessary methods allowing to compare and validate the files or folders.

Field Summary

Fields

Modifier and Type	Field and Description
java.nio.file.Path	approved Path to an approved entry.
java.nio.file.Path	received Path to an received entry.

Method Summary

Modifier and Type	Method and Description
static ApprovalFiles	build(java.nio.file.Path folder, java.lang.String methodName, java.lang.String extension) Builds a pair of approval entries from the provided folder, method name, and extension.
boolean	equals(java.lang.Object o) Overriding equals to allow filtering of duplicates.
int	hashCode() Overriding hashCode to allow filtering of duplicates.
boolean	haveSameContent() If approved and received are regular files, this method will check if both files have the same content (by reading them and comparing the data afterwards).
java.util.stream.Stream<ApprovalFiles>	listChildrenApprovalFiles() If approved and received actually are folders (which can be the case while using the folder approval features), this method allows to list all the children approval files from those folders.

Methods inherited from class java.lang.Object

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

Field Detail

approved

public final java.nio.file.Path approved

Path to an approved entry.

This entry can contain:

• A single approved file in case of a simple approval, - An approved folder buildApprovalFilePath in case of a folder approval, - A reference to a simple file located in an approved folder, to be used for later comparison

received

public final java.nio.file.Path received

Path to an received entry.

This entry can contain:

• A single received file in case of a simple approval, - An received folder buildApprovalFilePath in case of a folder approval, - A reference to a simple file located in an received folder, to be used for later comparison

Method Detail

build

public static ApprovalFiles build(java.nio.file.Path folder,
                                  java.lang.String methodName,
                                  java.lang.String extension)

Builds a pair of approval entries from the provided folder, method name, and extension. The path for both approved and received files will be computed and used as approval files.

Parameters:

folder - The folder in which the approval files should be located

methodName - The name of the method calling the test. It is used to actually name the approval files

extension - The extension to use for the approval file (by default could be either approved or received)

Returns:

An ApprovalFiles object, containing the pair of generated approved and received entries

haveSameContent

public boolean haveSameContent()

If approved and received are regular files, this method will check if both files have the same content (by reading them and comparing the data afterwards).

If approved and received actually are folders, this method will simply return false.

Returns:

True if approved and received are regular files and have the same content

listChildrenApprovalFiles

public java.util.stream.Stream<ApprovalFiles> listChildrenApprovalFiles()

If approved and received actually are folders (which can be the case while using the folder approval features), this method allows to list all the children approval files from those folders.

It’ll basically read all the files from the approved folder, all the files from the received folder, associate the matching approved and received files for each of those, and of course filter the duplicates. This gives us a complete list of all approval files in the end.

In case that function is called when approved or received are not folders, it’ll simply return an empty stream.

Returns:

A Stream containing all the pairs of approval files for the approved and received folders.

equals

public boolean equals(java.lang.Object o)

Overriding equals to allow filtering of duplicates.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object we want to compare to the current instance

Returns:

true if both objects are considered equals

hashCode

public int hashCode()

Overriding hashCode to allow filtering of duplicates.

Overrides:

hashCode in class java.lang.Object

Returns:

A unique hashcode for the particular data holded in that object.