Package de.skuzzle.test.snapshots

Class SnapshotTestResult

java.lang.Object

de.skuzzle.test.snapshots.SnapshotTestResult

@API(status=EXPERIMENTAL)
public final class SnapshotTestResult
extends java.lang.Object

Result details of a single snapshot assertion. An instance of this class is returned by every DSL terminal operation.

Since:

0.0.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotTestResult.SnapshotStatus	Information about the creation of a single snapshot file.

Method Summary

Modifier and Type	Method	Description
java.nio.file.Path	actualResultFile()	Deprecated, for removal: This API element is subject to removal in a future version. Since 1.8.0 - Use contextFiles() with ContextFiles.actualResultFile() instead.
ContextFiles	contextFiles()	Returns a class that holds the paths to all generated files.
void	deleteSnapshot()	Deprecated, for removal: This API element is subject to removal in a future version. Since 1.8.0 - Use contextFiles() with ContextFiles.deleteFiles() instead.
java.util.Optional<java.lang.Throwable>	failure()	The exception with which the snapshot assertion failed if any.
static SnapshotTestResult	forFailedTest(ContextFiles contextFiles, SnapshotFile snapshotFile, java.lang.String serializedActual, java.lang.Throwable failure)
static SnapshotTestResult	of(ContextFiles contextFiles, SnapshotTestResult.SnapshotStatus status, SnapshotFile snapshotFile, java.lang.String serializedActual)
java.nio.file.Path	rawActualResultFile()	Deprecated, for removal: This API element is subject to removal in a future version. Since 1.8.0 - Use contextFiles() with ContextFiles.snapshotFile() instead.
java.lang.String	serializedActual()	Returns the serialized string value of the actual test input.
SnapshotFile	serializedSnapshot()	Deprecated, for removal: This API element is subject to removal in a future version. Since 1.7.0 - Use snapshotFile() instead.
SnapshotFile	snapshotFile()	The contents of the persisted snapshot file.
SnapshotTestResult.SnapshotStatus	status()	Whether snapshot has been created/updated or asserted.
java.nio.file.Path	targetFile()	Deprecated, for removal: This API element is subject to removal in a future version. Since 1.8.0 - Use contextFiles() with ContextFiles.snapshotFile() instead.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

forFailedTest

@API(status=INTERNAL)
public static SnapshotTestResult forFailedTest(ContextFiles contextFiles,
                                               SnapshotFile snapshotFile,
                                               java.lang.String serializedActual,
                                               java.lang.Throwable failure)

of

@API(status=INTERNAL)
public static SnapshotTestResult of(ContextFiles contextFiles,
                                    SnapshotTestResult.SnapshotStatus status,
                                    SnapshotFile snapshotFile,
                                    java.lang.String serializedActual)

contextFiles

@API(status=EXPERIMENTAL,
     since="1.8.0")
public ContextFiles contextFiles()

Returns a class that holds the paths to all generated files.

Returns:

The context files.

See Also:

SnapshotTestOptions.alwaysPersistActualResult(), SnapshotTestOptions.alwaysPersistRawResult()

targetFile

@Deprecated(since="1.8.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="1.8.0")
public java.nio.file.Path targetFile()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 1.8.0 - Use contextFiles() with ContextFiles.snapshotFile() instead.

The snapshot file. Note that it is possible that the file does not exist in case that status() is SnapshotTestResult.SnapshotStatus.DISABLED.

Returns:

The snapshot file.

See Also:

actualResultFile(), rawActualResultFile()

actualResultFile

@Deprecated(since="1.8.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="1.8.0")
public java.nio.file.Path actualResultFile()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 1.8.0 - Use contextFiles() with ContextFiles.actualResultFile() instead.

Path to the file in which the latest actual result will be stored. The file will only exist if the recent snapshot assertion was executed with SnapshotTestOptions.alwaysPersistActualResult() being true.

Returns:

The path to the file with the latest actual result file.

Since:

1.7.0

See Also:

targetFile(), rawActualResultFile(), SnapshotTestOptions.alwaysPersistActualResult()

rawActualResultFile

@Deprecated(since="1.8.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="1.8.0")
public java.nio.file.Path rawActualResultFile()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 1.8.0 - Use contextFiles() with ContextFiles.snapshotFile() instead.

Path to the file in which the latest raw actual result will be stored (without the snapshot header). The file will only exist if the recent snapshot assertion was executed with SnapshotTestOptions.alwaysPersistRawResult() being true.

Returns:

The path to the file with the latest raw actual result file.

Since:

1.7.0

See Also:

targetFile(), actualResultFile(), SnapshotTestOptions.alwaysPersistRawResult()

status

public SnapshotTestResult.SnapshotStatus status()

Whether snapshot has been created/updated or asserted.

Returns:

Whether snapshot has been created/updated or asserted.

serializedSnapshot

@Deprecated(since="1.7.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="1.7.0")
public SnapshotFile serializedSnapshot()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 1.7.0 - Use snapshotFile() instead.

The contents of the persisted snapshot file.

Returns:

The serialized snapshot.

snapshotFile

public SnapshotFile snapshotFile()

The contents of the persisted snapshot file. Note that the file's content and the value of serializedActual() can be different, even though the snapshot test did not fail. For example they could differ in whitespaces if whitespaces were ignored during comparison. Or they can differ in certain attributes if you used structure compare with custom comparison rules.

Returns:

The snapshot file.

serializedActual

@API(status=EXPERIMENTAL,
     since="1.7.0")
public java.lang.String serializedActual()

Returns the serialized string value of the actual test input. Note that this value can be different from the contents of snapshotFile() (see the method's documentation for details).

Note that this value can be a placeholder in case you passed a null value into SnapshotDsl.ChooseActual.assertThat(Object). Unless you called SnapshotDsl.ChooseAssertions.disabled(), passing a null value into a snapshot test would fail the test anyway.

Returns:

The serialized actual value.

Since:

1.7.0

failure

public java.util.Optional<java.lang.Throwable> failure()

The exception with which the snapshot assertion failed if any.

Returns:

The failure.

deleteSnapshot

@Deprecated(since="1.8.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="1.8.0")
public void deleteSnapshot()
                    throws java.io.IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 1.8.0 - Use contextFiles() with ContextFiles.deleteFiles() instead.

Deletes the snapshot file and all accompanying context files.

Throws:

java.io.IOException - if an I/O error occurs

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object