A B C D E F G H J M N O R S T U V W
All Classes All Packages

A

afterAll(ExtensionContext) - Method in class de.skuzzle.test.snapshots.impl.SnapshotExtension

afterEach(ExtensionContext) - Method in class de.skuzzle.test.snapshots.impl.SnapshotExtension

as(SnapshotSerializer) - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseDataFormat

Specify the serialization format.

as(StructuredDataProvider) - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseDataFormat

Specify the serialization format and the way in which serialized objects are compared.

ASSERTED - de.skuzzle.test.snapshots.SnapshotTestResult.SnapshotStatus

Persistent snapshot has been compared against the actual test result.

assertEquals(String, String) - Method in interface de.skuzzle.test.snapshots.StructuralAssertions

Structurally compares two serialized objects.

assertThat(Object) - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseActual

Will create a serialized snapshot of the provided actual test result and store it on disk.

asText() - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseDataFormat

"Serializes" the actual test result using Object.toString() and compares the results using a generic string diff algorithm.

B

beforeAll(ExtensionContext) - Method in class de.skuzzle.test.snapshots.impl.SnapshotExtension

build() - Method in class de.skuzzle.test.snapshots.data.text.TextSnapshot

build() - Method in class de.skuzzle.test.snapshots.StructuredData

build() - Method in interface de.skuzzle.test.snapshots.StructuredDataProvider

Provides the StructuredData instance which defines the serialization format and the way in which serialized objects are compared.

C

CREATED_INITIALLY - de.skuzzle.test.snapshots.SnapshotTestResult.SnapshotStatus

Persistent snapshot file did not exist prior to executing this test.

D

de.skuzzle.test.snapshots - package de.skuzzle.test.snapshots

de.skuzzle.test.snapshots.core - module de.skuzzle.test.snapshots.core

de.skuzzle.test.snapshots.data.text - package de.skuzzle.test.snapshots.data.text

de.skuzzle.test.snapshots.directories - package de.skuzzle.test.snapshots.directories

de.skuzzle.test.snapshots.impl - package de.skuzzle.test.snapshots.impl

deleteSnapshot() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult

Deletes the snapshot file.

DirectoryResolver - Class in de.skuzzle.test.snapshots.directories

E

EnableSnapshotTests - Annotation Type in de.skuzzle.test.snapshots

Enables the snapshot-test capabilities.

equals(Object) - Method in class de.skuzzle.test.snapshots.SnapshotFile

equals(Object) - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

F

failure() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult

The exception with which the snapshot assertion failed if any.

forceUpdateSnapshots() - Method in annotation type de.skuzzle.test.snapshots.EnableSnapshotTests

Can be set to true temporarily in order to force to update the persisted snapshots with the current test results.

forFailedTest(Path, SnapshotFile, Throwable) - Static method in class de.skuzzle.test.snapshots.SnapshotTestResult

fromMap(Map<String, String>) - Static method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

fromSnapshotFile(Path) - Static method in class de.skuzzle.test.snapshots.SnapshotFile

G

get(String) - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

getInt(String) - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

getTestClass() - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

H

hashCode() - Method in class de.skuzzle.test.snapshots.SnapshotFile

hashCode() - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

header() - Method in class de.skuzzle.test.snapshots.SnapshotFile

Header information to this snapshot that are written by the framework.

J

justUpdateSnapshot() - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseAssertions

Deprecated.

This method is NOT deprecated. Deprecation serves only to mark this method in your IDE as it should only be used temporarily.

M

matchesAccordingTo(StructuralAssertions) - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseAssertions

Asserts that the serialized actual test result structurally matches the persisted snapshot.

matchesSnapshotStructure() - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseStructure

Asserts that the serialized actual test result structurally matches the persisted snapshot.

matchesSnapshotText() - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseAssertions

Asserts that the serialized actual test result matches the persisted snapshot using a generic String diff algorithm.

N

named(String) - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseName

Choose a name for the snapshot file.

O

of(SnapshotFile.SnapshotHeader, String) - Static method in class de.skuzzle.test.snapshots.SnapshotFile

of(Path, SnapshotTestResult.SnapshotStatus, SnapshotFile) - Static method in class de.skuzzle.test.snapshots.SnapshotTestResult

R

readFrom(BufferedReader) - Static method in class de.skuzzle.test.snapshots.SnapshotFile

readFrom(BufferedReader) - Static method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

resolve(String) - Static method in class de.skuzzle.test.snapshots.directories.DirectoryResolver

resolveParameter(ParameterContext, ExtensionContext) - Method in class de.skuzzle.test.snapshots.impl.SnapshotExtension

S

serialize(Object) - Method in interface de.skuzzle.test.snapshots.SnapshotSerializer

Creates a String representation of the provided object.

serializedSnapshot() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult

The snapshot.

snapshot() - Method in class de.skuzzle.test.snapshots.SnapshotFile

The serialized snapshot.

SNAPSHOT_NAME - Static variable in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

SNAPSHOT_NUMBER - Static variable in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

snapshotDirectory() - Method in annotation type de.skuzzle.test.snapshots.EnableSnapshotTests

Define the snapshot directory relative to src/test/resources.

SnapshotDsl - Interface in de.skuzzle.test.snapshots

DSL for defining snapshot tests.

SnapshotDsl.ChooseActual - Interface in de.skuzzle.test.snapshots

SnapshotDsl.ChooseAssertions - Interface in de.skuzzle.test.snapshots

SnapshotDsl.ChooseDataFormat - Interface in de.skuzzle.test.snapshots

Allows to choose the structure into which the actual test result will be serialized.

SnapshotDsl.ChooseName - Interface in de.skuzzle.test.snapshots

SnapshotDsl.ChooseStructure - Interface in de.skuzzle.test.snapshots

SnapshotDsl.Snapshot - Interface in de.skuzzle.test.snapshots

Allows to do snapshot assertions.

SnapshotException - Exception in de.skuzzle.test.snapshots

SnapshotException() - Constructor for exception de.skuzzle.test.snapshots.SnapshotException

SnapshotException(String) - Constructor for exception de.skuzzle.test.snapshots.SnapshotException

SnapshotException(String, Throwable) - Constructor for exception de.skuzzle.test.snapshots.SnapshotException

SnapshotException(String, Throwable, boolean, boolean) - Constructor for exception de.skuzzle.test.snapshots.SnapshotException

SnapshotException(Throwable) - Constructor for exception de.skuzzle.test.snapshots.SnapshotException

SnapshotExtension - Class in de.skuzzle.test.snapshots.impl

This class is only public so it can be referenced by the entry point annotation.

SnapshotExtension() - Constructor for class de.skuzzle.test.snapshots.impl.SnapshotExtension

SnapshotFile - Class in de.skuzzle.test.snapshots

A snapshot file is a plain text file containing a header and the actual serialized snapshot.

SnapshotFile.SnapshotHeader - Class in de.skuzzle.test.snapshots

snapshotSerializer() - Method in class de.skuzzle.test.snapshots.StructuredData

SnapshotSerializer - Interface in de.skuzzle.test.snapshots

Defines how an object is serialized into a persistable snapshot String.

SnapshotTestResult - Class in de.skuzzle.test.snapshots

Result details of a single snapshot assertion.

SnapshotTestResult.SnapshotStatus - Enum in de.skuzzle.test.snapshots

Information about the creation of a single snapshot file.

softAssertions() - Method in annotation type de.skuzzle.test.snapshots.EnableSnapshotTests

When enabled, a test method using snapshot assertions will continue to execute, even if a snapshot assertion failed.

status() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult

Whether snapshot has been created/updated or asserted.

structuralAssertions() - Method in class de.skuzzle.test.snapshots.StructuredData

StructuralAssertions - Interface in de.skuzzle.test.snapshots

Allows to customize how structured data is compared in order to check whether a snapshot matches an actual test result.

StructuredData - Class in de.skuzzle.test.snapshots

Combines a SnapshotSerializer and a StructuralAssertions instance.

StructuredDataProvider - Interface in de.skuzzle.test.snapshots

Tagging interface for classes that can provide an instance of StructuredData.

supportsParameter(ParameterContext, ExtensionContext) - Method in class de.skuzzle.test.snapshots.impl.SnapshotExtension

T

targetFile() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult

The snapshot file.

TEST_CLASS - Static variable in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

TEST_METHOD - Static variable in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

text - Static variable in class de.skuzzle.test.snapshots.data.text.TextSnapshot

Take Snapshots using Object.toString() and compare the results using a generic String diff algorithm.

TextSnapshot - Class in de.skuzzle.test.snapshots.data.text

Take snapshots using Object.toString().

toString() - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

U

UPDATED_FORCEFULLY - de.skuzzle.test.snapshots.SnapshotTestResult.SnapshotStatus

Persistent snapshot has been forcefully updated with the actual test result.

V

valueOf(String) - Static method in enum de.skuzzle.test.snapshots.SnapshotTestResult.SnapshotStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum de.skuzzle.test.snapshots.SnapshotTestResult.SnapshotStatus

Returns an array containing the constants of this enum type, in the order they are declared.

W

with(SnapshotSerializer, StructuralAssertions) - Static method in class de.skuzzle.test.snapshots.StructuredData

writeTo(Path) - Method in class de.skuzzle.test.snapshots.SnapshotFile

A B C D E F G H J M N O R S T U V W
All Classes All Packages