A B C D E F G H I J M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- afterAll(ExtensionContext) - Method in class de.skuzzle.test.snapshots.junit5.JUnit5SnapshotExtension
- afterEach(ExtensionContext) - Method in class de.skuzzle.test.snapshots.junit5.JUnit5SnapshotExtension
- 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.junit5.JUnit5SnapshotExtension
- 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
StructuredDatainstance which defines the serialization format and the way in which serialized objects are compared.
C
- changeHeader(SnapshotFile.SnapshotHeader) - Method in class de.skuzzle.test.snapshots.SnapshotFile
-
Creates a new
SnapshotFileinstance with the given header and the same snapshot contents. - ComparisonRuleBuilder - Interface in de.skuzzle.test.snapshots
-
Builder for customizing how snapshot files are compared against the actual test result.
- ComparisonRuleBuilder.ChooseMatcher - Interface in de.skuzzle.test.snapshots
-
Allows to choose the comparison for the value.
- constant(String) - Static method in interface de.skuzzle.test.snapshots.SnapshotNaming
-
Creates a naming strategy which always returns the given constant string.
- CREATED_INITIALLY - de.skuzzle.test.snapshots.SnapshotTestResult.SnapshotStatus
-
Persistent snapshot file did not exist prior to executing this test.
- createSnapshotTestFor(Method) - Method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext
-
Creates a Snapshot object that can be injected into a test method as starting point of the snapshot DSL.
D
- de.skuzzle.test.snapshots - package de.skuzzle.test.snapshots
-
The main public snapshot-testing API.
- de.skuzzle.test.snapshots.core - module de.skuzzle.test.snapshots.core
- de.skuzzle.test.snapshots.data.text - package de.skuzzle.test.snapshots.data.text
-
Text comparison implementation.
- de.skuzzle.test.snapshots.impl - package de.skuzzle.test.snapshots.impl
-
Internal core implementation of snapshot-testing functionality.
- de.skuzzle.test.snapshots.junit5 - package de.skuzzle.test.snapshots.junit5
-
JUnit5 extension implementation for snapshot tests.
- defaultNaming() - Static method in interface de.skuzzle.test.snapshots.SnapshotNaming
-
The default naming strategy which simply concatenates method name + counter.
- DeleteOrphanedSnapshots - Annotation Type in de.skuzzle.test.snapshots
-
Deprecated.This annotation is NOT deprecated. Deprecation serves only to mark this annotation in your IDE as it should only ever be used temporarily.
- deleteSnapshot() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult
-
Deletes the snapshot file.
- detectOrCleanupOrphanedSnapshots() - Method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext
-
Uses the collected context information to detect and optionally also clean up orphaned snapshot files.
- determineSnapshotName(Method, int) - Method in interface de.skuzzle.test.snapshots.SnapshotNaming
-
Determines the name of the snapshot being taken.
- diffOf(String, String, int) - Static method in class de.skuzzle.test.snapshots.data.text.TextDiff
- disabled() - 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.
- DISABLED - de.skuzzle.test.snapshots.SnapshotTestResult.SnapshotStatus
-
No assertion has been performed and the snapshot file has not been created nor updated.
- DYNAMIC_DIRECTORY - Static variable in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
-
Stores per snapshot whether it had been taken with a dynamic directory.
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.
- finalizeSnapshotTest() - Method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext
-
Finalizes the current test by clearing this context and executing its remaining assertions.
- forceUpdateSnapshots() - Method in annotation type de.skuzzle.test.snapshots.EnableSnapshotTests
-
Deprecated.Since 1.1.0 - Use the
ForceUpdateSnapshotsannotation instead. - ForceUpdateSnapshots - Annotation Type in de.skuzzle.test.snapshots
-
Deprecated.This annotation is NOT deprecated. Deprecation serves only to mark this annotation in your IDE as it should only be used temporarily.
- forFailedTest(Path, SnapshotFile, Throwable) - Static method in class de.skuzzle.test.snapshots.SnapshotTestResult
- forTestClass(Class<?>) - Static method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext
- 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
- getBoolean(String, boolean) - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
-
Retrieves a boolean header value.
- getInt(String) - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
- getOrDefault(String, String) - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
H
- hasDifference() - Method in class de.skuzzle.test.snapshots.data.text.TextDiff
- 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.
I
- ignore() - Method in interface de.skuzzle.test.snapshots.ComparisonRuleBuilder.ChooseMatcher
-
Ignores values during comparison.
- in(Path) - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseDirectory
-
Allows to choose the directory into which the snapshot will be persisted.
- isSnapshotParameter(Class<?>) - Method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext
-
Determines whether the parameters with the given type are eligible for injecting the object that is created by
SnapshotTestContext.createSnapshotTestFor(Method).
J
- JUnit5SnapshotExtension - Class in de.skuzzle.test.snapshots.junit5
-
This class is only public so it can be referenced by the entry point annotation.
- JUnit5SnapshotExtension() - Constructor for class de.skuzzle.test.snapshots.junit5.JUnit5SnapshotExtension
- 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.
- mustMatch(Predicate<? super Object>) - Method in interface de.skuzzle.test.snapshots.ComparisonRuleBuilder.ChooseMatcher
-
The value must match the given predicate.
- mustMatch(Pattern) - Method in interface de.skuzzle.test.snapshots.ComparisonRuleBuilder.ChooseMatcher
-
String representation of the value must match the given regex.
N
- named(String) - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseName
-
Choose a name for the snapshot file.
- namedAccordingTo(SnapshotNaming) - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseName
-
Choose a name for the snapshot file according to the given strategy.
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
P
- pathAt(String) - Method in interface de.skuzzle.test.snapshots.ComparisonRuleBuilder
-
Specify the path for which to apply the custom comparison rule.
R
- readFrom(BufferedReader) - Static method in class de.skuzzle.test.snapshots.SnapshotFile
- readFrom(BufferedReader) - Static method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
- recordFailedOrSkippedTest(Method) - Method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext
-
Records a failed or skipped test within the currently executed test class.
- recordSnapshotTestResult(SnapshotTestResult) - Method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext
-
Records the results from all snapshot assertions within a single test method.
- resolveParameter(ParameterContext, ExtensionContext) - Method in class de.skuzzle.test.snapshots.junit5.JUnit5SnapshotExtension
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
-
DSL stage to choose how to perform the snapshot assertion.
- SnapshotDsl.ChooseDataFormat - Interface in de.skuzzle.test.snapshots
-
Allows to choose the structure into which the actual test result will be serialized.
- SnapshotDsl.ChooseDirectory - Interface in de.skuzzle.test.snapshots
- 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
-
This is a framework exception that can be thrown when implementing certain extension points.
- 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
- 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
- SnapshotNaming - Interface in de.skuzzle.test.snapshots
-
Strategy interface for dynamically determining snapshot names.
- 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.
- SnapshotTestContext - Class in de.skuzzle.test.snapshots.impl
-
Context object that pertains to the execution of a whole test class which is annotated with
EnableSnapshotTests. - 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
SnapshotSerializerand aStructuralAssertionsinstance. - 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.junit5.JUnit5SnapshotExtension
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
- testAborted(ExtensionContext, Throwable) - Method in class de.skuzzle.test.snapshots.junit5.JUnit5SnapshotExtension
- testDisabled(ExtensionContext, Optional<String>) - Method in class de.skuzzle.test.snapshots.junit5.JUnit5SnapshotExtension
- testFailed(ExtensionContext, Throwable) - Method in class de.skuzzle.test.snapshots.junit5.JUnit5SnapshotExtension
- 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. - text() - Static method in class de.skuzzle.test.snapshots.data.text.TextSnapshot
-
Creates a customizable
TextSnapshotinstance. - textDiff() - Method in error de.skuzzle.test.snapshots.data.text.TextDiffAssertionError
- TextDiff - Class in de.skuzzle.test.snapshots.data.text
-
Creates a unified diff of 2 Strings using the popular Neil Fraser diff_match_patch implementation under the hood.
- TextDiffAssertionError - Error in de.skuzzle.test.snapshots.data.text
-
Internal exception that is used to communicate the
TextDiffinstance created by theTextDiffStructuralAssertionsto the snapshot test. - TextSnapshot - Class in de.skuzzle.test.snapshots.data.text
-
Take snapshots using
Object.toString(). - toString() - Method in class de.skuzzle.test.snapshots.data.text.TextDiff
- toString() - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
- toString() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult
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
- withContextLines(int) - Method in class de.skuzzle.test.snapshots.data.text.TextSnapshot
-
Configures the amount of contextual lines that are printed around a detected change.
- withIgnoreWhitespaces(boolean) - Method in class de.skuzzle.test.snapshots.data.text.TextSnapshot
-
Allows to customize the whitespace comparison behavior.
- withParameters(Object, Object...) - Static method in interface de.skuzzle.test.snapshots.SnapshotNaming
-
Creates a naming strategy similar to the default naming strategy.
- writeTo(Path) - Method in class de.skuzzle.test.snapshots.SnapshotFile
-
Writes this object to the specified file, potentially overriding it if it already exists.
All Classes All Packages