Index (snapshot-tests-core 1.11.0 API)

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

A

ACCODRDING_TO_PERSISTED_SNAPSHOT_FILE - de.skuzzle.test.snapshots.SnapshotTestOptions.DiffLineNumbers: Adds an offset according to the number of snapshot file header lines.
ACCORDING_TO_RAW_DATA - de.skuzzle.test.snapshots.SnapshotTestOptions.DiffLineNumbers: No offset will be added to line numbers.
actualResultFile() - Method in class de.skuzzle.test.snapshots.ContextFiles: Path to the file in which the latest actual result will be stored.
actualResultFile() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.8.0 - Use SnapshotTestResult.contextFiles() with ContextFiles.actualResultFile() instead.
addOffsetToReportedLinenumbers(Method) - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Whether to add an offset to the line numbers in rendered diffs so that the rendered line numbers match the physical lines in the snapshot file.
alwaysPersistActualResult() - Method in annotation type de.skuzzle.test.snapshots.SnapshotTestOptions: Whether to always persist the latest actual test result in a parallel file next to the .snapshot file.
alwaysPersistActualResult(Method) - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Determines whether to persist most recent actual test result in a separate file next to the snapshot.
alwaysPersistRawResult() - Method in annotation type de.skuzzle.test.snapshots.SnapshotTestOptions: When enabled, the framework will persist the raw actual result without snapshot header as a sibling file to the real .snapshot file with the extension .snapshot_raw.
alwaysPersistRawResult(Method) - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Determines whether to persist raw snapshot result in a separate file.
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.
assumptionFailed(String) - Method in interface de.skuzzle.test.snapshots.impl.TestFrameworkSupport: Creates a throwable that will mark the repsective test as skipped.
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.LegacyJUnit5SnapshotExtension
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

changeHeader(SnapshotFile.SnapshotHeader) - Method in class de.skuzzle.test.snapshots.SnapshotFile: Creates a new SnapshotFile instance with the given header and the same snapshot contents.
compare(TextDiff.Settings, String, String) - Static method in class de.skuzzle.test.snapshots.data.text.TextDiff
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.
contextFiles() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult: Returns a class that holds the paths to all generated files.
ContextFiles - Class in de.skuzzle.test.snapshots: Holds the paths to all files that might have been generated by a single snapshot assertion.
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.
CRLF - de.skuzzle.test.snapshots.SnapshotTestOptions.NormalizeLineEndings: All line endings will be converted to CRLF (\r\n).

D

de.skuzzle.test.snapshots - package de.skuzzle.test.snapshots: The main public snapshot-testing API.
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.
DEFAULT_CONTEXT_LINES - Static variable in annotation type de.skuzzle.test.snapshots.SnapshotTestOptions: Default number of context lines that are displayed in diffs.
DEFAULT_DIFF_FORMAT - Static variable in annotation type de.skuzzle.test.snapshots.SnapshotTestOptions: Default setting for SnapshotTestOptions.diffFormat().
DEFAULT_NORMALIZE_LINE_ENDINGS - Static variable in annotation type de.skuzzle.test.snapshots.SnapshotTestOptions: Default setting for SnapshotTestOptions.normalizeLineEndings().
defaultConfigurationFor(Class<?>) - Static method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Creates a SnapshotConfiguration for the given test class.
defaultNaming() - Static method in interface de.skuzzle.test.snapshots.SnapshotNaming: The default naming strategy which simply concatenates method name + counter.
defaultSettings() - Static method in class de.skuzzle.test.snapshots.data.text.TextDiff.Settings
deleteFiles() - Method in class de.skuzzle.test.snapshots.ContextFiles: Deletes all the context files that are existing.
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: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.8.0 - Use SnapshotTestResult.contextFiles() with ContextFiles.deleteFiles() instead.
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.
determinedBy() - Method in annotation type de.skuzzle.test.snapshots.SnapshotDirectory: Specify the type of a class that implements SnapshotDirectoryStrategy.
determineSnapshotDirectory() - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Determines the directory into which the snapshot files for the currently executed test class are persisted.
determineSnapshotDirectory(Class<?>, SnapshotDirectory) - Method in interface de.skuzzle.test.snapshots.SnapshotDirectoryStrategy: Determine the directory into which snapshots will be persisted.
determineSnapshotName(Method, int) - Method in interface de.skuzzle.test.snapshots.SnapshotNaming: Determines the name of the snapshot being taken.
differencesDetected() - Method in class de.skuzzle.test.snapshots.data.text.TextDiff
diffFormat() - Method in annotation type de.skuzzle.test.snapshots.SnapshotTestOptions: Defines how the diffs within the assertion failure messages are rendered.
diffFormat(Method) - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Defines how diffs are rendered when structural comparison failed.
disabled() - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseAssertions: This is a terminal DSL operation which just advances the internal state of the injected Snapshot instance but which does not apply any comparisons.
DISABLED - de.skuzzle.test.snapshots.SnapshotTestResult.SnapshotStatus: No assertion has been performed and the snapshot file has not been created or updated.
disabledBecause(String) - Method in interface de.skuzzle.test.snapshots.SnapshotDsl.ChooseAssertions: This is a terminal DSL operation which just advances the internal state of the injected Snapshot instance but which does not apply any comparisons.
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: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.7.0 - This class is deprecated in favor of the EnableSnapshotTests class within the junit5 package. Note that the variant in the junit5 package already comes with all the deprecated methods removed and replaced with their respective alternatives. For details, inspect the deprecation notes on the attributes within this class.
EnableSnapshotTests - Annotation Type in de.skuzzle.test.snapshots.junit5: Enabling snapshot tests
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, for removal: This API element is subject to removal in a future version.
Since 1.1.0 - Use the ForceUpdateSnapshots annotation 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.
forConfiguration(SnapshotConfiguration, TestFrameworkSupport) - Static method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext
forFailedTest(ContextFiles, SnapshotFile, String, Throwable) - Static method in class de.skuzzle.test.snapshots.SnapshotTestResult
forTestClass(Class<?>, TestFrameworkSupport) - Static method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext: Deprecated.
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
GIT - de.skuzzle.test.snapshots.SnapshotTestOptions.NormalizeLineEndings: Line endings will be converted according to the local git's core.autocrlf and core.eol settings.

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.

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.
isDeleteOrphanedSnapshots() - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Whether to delete orphaned snapshot files during test execution.
isForceUpdateSnapshots(Method) - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Determines whether snapshots are to be forcefully updated during the execution of the given test method.
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).
isSnapshotTest(Class<?>, Method) - Method in interface de.skuzzle.test.snapshots.impl.TestFrameworkSupport: Tries to determine whether the given method is (still) a snapshot test.
isSoftAssertions() - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.7.0 - Soft assertion will no longer be supported with version 2.0

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.

L

legacyConfigurationFor(Class<?>) - Static method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.7.0 - Only introduced for backward compatibility.
LegacyJUnit5SnapshotExtension - Class in de.skuzzle.test.snapshots.junit5: This class is only public so it can be referenced by the entry point annotation.
LegacyJUnit5SnapshotExtension() - Constructor for class de.skuzzle.test.snapshots.junit5.LegacyJUnit5SnapshotExtension
LF - de.skuzzle.test.snapshots.SnapshotTestOptions.NormalizeLineEndings: All line endings will be converted to LF (\n).
lineNumberOffset() - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader: Returns the number of lines (including the blank separator line) that the header information are taking at the beginning of the snapshot file.

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.
NEVER - de.skuzzle.test.snapshots.SnapshotTestOptions.NormalizeLineEndings: Line endings will not be normalized.
normalizeLineEndings() - Method in annotation type de.skuzzle.test.snapshots.SnapshotTestOptions: Advises the framework to convert the line endings after snapshot serialization to the given value.
normalizeLineEndings(Method) - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: How to normalize line endings after default snapshot serialization.

O

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

P

pathAt(String) - Method in interface de.skuzzle.test.snapshots.ComparisonRuleBuilder: Specify the path for which to apply the custom comparison rule.

R

rawActualResultFile() - Method in class de.skuzzle.test.snapshots.ContextFiles: Path to the file in which the latest raw actual result will be stored (without the snapshot header).
rawActualResultFile() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.8.0 - Use SnapshotTestResult.contextFiles() with ContextFiles.snapshotFile() instead.
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.
renderDiffWithOffsetAndContextLines(int, int) - Method in class de.skuzzle.test.snapshots.data.text.TextDiff
renderLineNumbers() - Method in annotation type de.skuzzle.test.snapshots.SnapshotTestOptions: Controls whether an offset is added to the line numbers that are displayed when rendering diffs.

S

serialize(Object) - Method in interface de.skuzzle.test.snapshots.SnapshotSerializer: Creates a String representation of the provided object.
serializedActual() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult: Returns the serialized string value of the actual test input.
serializedSnapshot() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.7.0 - Use SnapshotTestResult.snapshotFile() instead.
snapshot() - Method in class de.skuzzle.test.snapshots.SnapshotFile: The serialized snapshot.
Snapshot - Interface in de.skuzzle.test.snapshots: Allows to do snapshot assertions.
SNAPSHOT_NAME - Static variable in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
SNAPSHOT_NUMBER - Static variable in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
snapshotConfiguration() - Method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext: Returns the SnapshotConfiguration.
SnapshotConfiguration - Interface in de.skuzzle.test.snapshots.impl: Supplies configuration options to the snapshot test execution.
snapshotDirectory() - Method in annotation type de.skuzzle.test.snapshots.EnableSnapshotTests: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.7.0 - Use SnapshotDirectory annotation instead.
SnapshotDirectory - Annotation Type in de.skuzzle.test.snapshots: Drop in replacement for EnableSnapshotTests.snapshotDirectory().
SnapshotDirectoryStrategy - Interface in de.skuzzle.test.snapshots: Strategy interface which can be used to determine a custom snapshot directory.
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: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.8.0 - Use the new top-level type Snapshot instead.
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() - Method in class de.skuzzle.test.snapshots.ContextFiles: The snapshot file.
snapshotFile() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult: The contents of the persisted snapshot file.
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.
SnapshotTestOptions - Annotation Type in de.skuzzle.test.snapshots: Allows to configure some behavior details of the snapshot testing engine.
SnapshotTestOptions.DiffFormat - Enum in de.skuzzle.test.snapshots: Format of the diffs rendered in our assertion failures.
SnapshotTestOptions.DiffLineNumbers - Enum in de.skuzzle.test.snapshots: Defines whether an offset is added to the line numbers when rendering diffs in assertion failure messages.
SnapshotTestOptions.NormalizeLineEndings - Enum in de.skuzzle.test.snapshots: Defines how and if line endings will be normalized after snapshot serialization.
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: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.7.0 - Soft assertions will no longer be supported from version 2.0 on. You could use AssertJ's SoftAssertions as a replacement.
SPLIT - de.skuzzle.test.snapshots.data.text.TextSnapshot.DiffFormat: Render diff in split view format, where the lines from the expected and actual result will be printed side by side.
SPLIT - de.skuzzle.test.snapshots.SnapshotTestOptions.DiffFormat
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.
SYSTEM - de.skuzzle.test.snapshots.SnapshotTestOptions.NormalizeLineEndings: All line endings will be converted to the system's default line separator.

T

targetFile() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult: Deprecated, for removal: This API element is subject to removal in a future version.
Since 1.8.0 - Use SnapshotTestResult.contextFiles() with ContextFiles.snapshotFile() instead.
TEST_CLASS - Static variable in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
TEST_METHOD - Static variable in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
testClass() - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: The class containing the currently executed test.
testFrameworkSupport() - Method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext: Returns the TestFrameworkSupport that encapsulates test framework specific behavior.
TestFrameworkSupport - Interface in de.skuzzle.test.snapshots.impl: Abstraction to provide test framework specific behavior to the snapshot-test core
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 TextSnapshot instance.
textDiff() - Method in error de.skuzzle.test.snapshots.data.text.TextDiffAssertionError
TextDiff - Class in de.skuzzle.test.snapshots.data.text: Creates a diff of 2 Strings.
TextDiff.Settings - Class in de.skuzzle.test.snapshots.data.text
TextDiffAssertionError - Error in de.skuzzle.test.snapshots.data.text: Internal exception that is used to communicate the TextDiff instance created by the TextDiffStructuralAssertions to the snapshot test.
textDiffContextLines() - Method in annotation type de.skuzzle.test.snapshots.SnapshotTestOptions: Defines the number of context lines that are printed around a comparison failure.
textDiffContextLines(Method) - Method in interface de.skuzzle.test.snapshots.impl.SnapshotConfiguration: Defines how many lines of context are rendered around a changed line-
TextSnapshot - Class in de.skuzzle.test.snapshots.data.text: Take snapshots using Object.toString().
TextSnapshot.DiffFormat - Enum in de.skuzzle.test.snapshots.data.text: Format in which diffs will be rendered within assertion failure messages.
toString() - Method in class de.skuzzle.test.snapshots.data.text.TextDiff
toString() - Method in class de.skuzzle.test.snapshots.impl.SnapshotTestContext
toString() - Method in class de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader
toString() - Method in class de.skuzzle.test.snapshots.SnapshotTestResult

U

UNIFIED - de.skuzzle.test.snapshots.data.text.TextSnapshot.DiffFormat: Render diffs in unified format, where changes are displayed line by line and lines from expected and actual results are printed interleaved.
UNIFIED - de.skuzzle.test.snapshots.SnapshotTestOptions.DiffFormat
UPDATED_FORCEFULLY - de.skuzzle.test.snapshots.SnapshotTestResult.SnapshotStatus: Persistent snapshot has been forcefully updated with the actual test result.

V

value() - Method in annotation type de.skuzzle.test.snapshots.SnapshotDirectory: Define the snapshot directory relative to src/test/resources.
valueOf(String) - Static method in enum de.skuzzle.test.snapshots.data.text.TextSnapshot.DiffFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.skuzzle.test.snapshots.SnapshotTestOptions.DiffFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.skuzzle.test.snapshots.SnapshotTestOptions.DiffLineNumbers: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.skuzzle.test.snapshots.SnapshotTestOptions.NormalizeLineEndings: Returns the enum constant of this type with the specified name.
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.data.text.TextSnapshot.DiffFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.skuzzle.test.snapshots.SnapshotTestOptions.DiffFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.skuzzle.test.snapshots.SnapshotTestOptions.DiffLineNumbers: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.skuzzle.test.snapshots.SnapshotTestOptions.NormalizeLineEndings: Returns an array containing the constants of this enum type, in the order they are declared.
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.TextDiff.Settings
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.
withDiffFormat(TextSnapshot.DiffFormat) - Method in class de.skuzzle.test.snapshots.data.text.TextSnapshot: Specify the format of how diffs are rendered within our assertion failure messages.
withDiffRenderer(DiffRenderer) - Method in class de.skuzzle.test.snapshots.data.text.TextDiff.Settings
withIgnoreWhitespaces(boolean) - Method in class de.skuzzle.test.snapshots.data.text.TextDiff.Settings
withIgnoreWhitespaces(boolean) - Method in class de.skuzzle.test.snapshots.data.text.TextSnapshot: Allows to customize the whitespace comparison behavior.
withInlineClosingChangeMarker(String) - Method in class de.skuzzle.test.snapshots.data.text.TextDiff.Settings
withInlineOpeningChangeMarker(String) - Method in class de.skuzzle.test.snapshots.data.text.TextDiff.Settings
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.

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