Module de.skuzzle.test.snapshots.core

@API(status=STABLE)

Package de.skuzzle.test.snapshots

The main public snapshot-testing API.

See Also:

EnableSnapshotTests, SnapshotDsl.Snapshot

Interface Summary

Interface	Description
ComparisonRuleBuilder	Builder for customizing how snapshot files are compared against the actual test result.
ComparisonRuleBuilder.ChooseMatcher	Allows to choose the comparison for the value.
SnapshotDsl	DSL for defining snapshot tests.
SnapshotDsl.ChooseActual
SnapshotDsl.ChooseAssertions	DSL stage to choose how to perform the snapshot assertion.
SnapshotDsl.ChooseDataFormat	Allows to choose the structure into which the actual test result will be serialized.
SnapshotDsl.ChooseDirectory
SnapshotDsl.ChooseName
SnapshotDsl.ChooseStructure
SnapshotDsl.Snapshot	Allows to do snapshot assertions.
SnapshotNaming	Strategy interface for dynamically determining snapshot names.
SnapshotSerializer	Defines how an object is serialized into a persistable snapshot String.
StructuralAssertions	Allows to customize how structured data is compared in order to check whether a snapshot matches an actual test result.
StructuredDataProvider	Tagging interface for classes that can provide an instance of StructuredData.

Class Summary

Class	Description
SnapshotFile	A snapshot file is a plain text file containing a header and the actual serialized snapshot.
SnapshotFile.SnapshotHeader
SnapshotTestResult	Result details of a single snapshot assertion.
StructuredData	Combines a SnapshotSerializer and a StructuralAssertions instance.

Enum Summary

Enum	Description
SnapshotTestResult.SnapshotStatus	Information about the creation of a single snapshot file.

Exception Summary

Exception	Description
SnapshotException	This is a framework exception that can be thrown when implementing certain extension points.

Annotation Types Summary

Annotation Type	Description
DeleteOrphanedSnapshots	Deprecated. This annotation is NOT deprecated.
EnableSnapshotTests	Enables the snapshot-test capabilities.
ForceUpdateSnapshots	Deprecated. This annotation is NOT deprecated.