pointfreeco/swift-snapshot-testing
Swift Snapshot Testing
This is a snapshot testing framework for Swift that records and compares reference images or data representations to detect regressions in application state. It functions as a visual regression testing tool and a data snapshotting library, converting complex types into stable formats to verify internal state and object properties.
The framework utilizes a multi-format snapshot strategy, allowing values to be represented as images, strings, or data blobs. It includes a mechanism for defining custom snapshot strategies to convert specific data types into comparable formats based on custom logic.
The tool covers visual testing through device-agnostic view capture and image rendering across multiple configurations and orientations. It also provides textual state rendering for data consistency verification and supports asynchronous value snapshotting for states that depend on callbacks or background processes.
Failure messages can generate command-line strings to facilitate the use of external diff tools for visualizing differences.
Features
- Snapshot Testing - Records serialized data states to disk and compares them against future executions to detect regressions.
- Value Format Transformations - Converts complex data types into standard image or text formats for comparison against stored references.
- Snapshot Testing Frameworks - Provides a comprehensive library for recording and comparing reference images or text representations to detect regressions.
- Data Snapshotting for Testing - Provides a system for converting complex data types into stable formats to verify internal state and object properties.
- Image Rendering for Values - Converts application values or views into images to automatically verify visual appearance and layout through snapshot comparisons.
- Multi-Format Snapshot Strategies - Allows defining custom transformation logic to represent Swift values as images, strings, or data blobs.
- Visual - Detects regressions by comparing a current image or text representation against a stored reference snapshot.
- Simulator-Driven Rendering Tests - Renders user interface components across multiple device configurations and orientations using the active system simulator.
- Snapshot Strategy Mapping - Implements a flexible pipeline to transform specific Swift types into stable snapshot formats for regression testing.
- Snapshot Testing - Captures the serialized state of a data structure and compares it against future outputs to detect regressions.
- Swift UI Snapshot Testing - Verifies the state and appearance of views and controllers across different devices using snapshot representations.
- Visual Regression Testing - Automates the capture and comparison of screenshots to detect unintended UI changes.
- Asynchronous Snapshot Resolution - Provides the ability to wait for callbacks or delegate methods to finish before capturing a final state representation.
- Asynchronous State Snapshots - Captures snapshots of values that depend on callbacks or background processes to ensure final states are correct.
- Device-Agnostic View Capture - Provides a mechanism to render views and controllers across various devices and orientations from a single simulator to verify layout consistency.
- Internal State Verification - Records reference text or data dumps of complex objects to detect regressions in internal state or business logic.
- Asynchronous Value Snapshotting - Captures snapshots of values that require waiting for callbacks or delegate methods to complete.
- Custom Snapshot Strategies - Allows users to define custom logic to convert complex data types into images, strings, or data formats.
- Textual State Rendering - Converts a data type into a textual dump to verify the internal state and properties of an object.
- Testing and Automation - Delightful snapshot testing for Swift.
- Testing Frameworks - Snapshot testing library.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
