Module de.skuzzle.test.snapshots.core

Package de.skuzzle.test.snapshots

Class SnapshotTestResult

java.lang.Object

de.skuzzle.test.snapshots.SnapshotTestResult

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

Result details of a single snapshot assertion.

Since:

0.0.2

Author:

Simon Taddiken

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
void	deleteSnapshot()	Deletes the snapshot file.
Optional<Throwable>	failure()	The exception with which the snapshot assertion failed if any.
static SnapshotTestResult	forFailedTest(Path targetFile, SnapshotFile snapshot, Throwable failure)
static SnapshotTestResult	of(Path targetFile, SnapshotTestResult.SnapshotStatus status, SnapshotFile snapshot)
SnapshotFile	serializedSnapshot()	The snapshot.
SnapshotTestResult.SnapshotStatus	status()	Whether snapshot has been created/updated or asserted.
Path	targetFile()	The snapshot file.

Methods inherited from class java.lang.Object

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

Method Detail

forFailedTest

public static SnapshotTestResult forFailedTest(Path targetFile,
                                               SnapshotFile snapshot,
                                               Throwable failure)

of

public static SnapshotTestResult of(Path targetFile,
                                    SnapshotTestResult.SnapshotStatus status,
                                    SnapshotFile snapshot)

targetFile

public Path targetFile()

The snapshot file.

Returns:

The snapshot file.

status

public SnapshotTestResult.SnapshotStatus status()

Whether snapshot has been created/updated or asserted.

Returns:

Whether snapshot has been created/updated or asserted.

serializedSnapshot

public SnapshotFile serializedSnapshot()

The snapshot.

Returns:

The serialized snapshot.

failure

public Optional<Throwable> failure()

The exception with which the snapshot assertion failed if any.

Returns:

The failure.

deleteSnapshot

public void deleteSnapshot()
                    throws IOException

Deletes the snapshot file.

Throws:

IOException - if an I/O error occurs