https://github.com/ackeecz/ackee-ios-snapshots
Ackee extensions for snapshot testing
https://github.com/ackeecz/ackee-ios-snapshots
Last synced: 23 days ago
JSON representation
Ackee extensions for snapshot testing
- Host: GitHub
- URL: https://github.com/ackeecz/ackee-ios-snapshots
- Owner: AckeeCZ
- License: mit
- Created: 2024-08-20T11:38:40.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-25T09:24:02.000Z (about 1 month ago)
- Last Synced: 2025-10-10T15:32:05.752Z (23 days ago)
- Language: Swift
- Size: 218 KB
- Stars: 10
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ackee Snapshots
Set of extensions that we use to simplify out snapshot tests using [SnapshotTesting][snapshot-testing]
## Installation
As [SnapshotTesting][snapshot-testing] is only available through SPM, this is the only installation option for AckeeSnapshots too.
Just add it to your _Package.swift_ or your Xcode project.
## Usage
In your shared testing framework (we recommend using it and including it to all your test targets) define shared instance of [SnapshotTest](Sources/AckeeSnapshots/SnapshotTest.swift) object:
```swift
public let assertSnapshot = SnapshotTest(
devices: [
.iPhone8,
.iPhone13ProMax,
.iPadPro11,
.iPadPro12_9
],
record: false,
displayScale: 1,
contentSizes: [.extraExtraExtraLarge, .large, .small],
colorSchemes: [.light, .dark]
)
```
And in your test use assert method of your choice:
```swift
import AppTesting
import XCTest
func test_appearance() {
assertSnapshot.devices(SubjectView())
}
```
or using _SwiftTesting_
```swift
import AppTesting
import Testing
@Test
func appearance() {
assertSnapshot.devices(SubjectView())
}
```
## Examples
The `Tests/AckeeSnapshotsTests/AckeeSnapshotsTests.swift` file contains comprehensive examples demonstrating how to use AckeeSnapshots with different UI frameworks using SwiftTesting. The examples include:
- SwiftUI components and views with multiple devices
- UIKit views and view controllers
- Single device testing
- Dynamic type and accessibility testing
These tests serve as both validation for the library and practical examples of how to implement snapshot testing in your own projects using the modern SwiftTesting framework. You can run the tests to see the library in action and use them as a reference for your own implementation.
## Recommendations
As we use snapshot tests for quite a long time, we have developed several practices that we consider good:
### Use [Git LFS](https://git-lfs.com) for storing snapshots
At the beginning you will have a few snapshots so it will not matter, but think about the future.
If you really snapshot a lot, you might end up with hundreds of megabytes of images, that means that all developers
will have all snapshots stored locally at any time (unless you use a shallow clone, which is not very practical for development).
When using LFS all files are just pointers to the actual files and you can have only snapshots that are relevant for your current commit.
**Note:** This repository does not use Git LFS because the number of testing snapshots is low and is not expected to change significantly over time (though this assumption may not always hold true for app designs). Additionally, Git LFS can cause issues with Swift Package Manager (SPM) fetches, which is why we've opted to store snapshots directly in the repository.
### Think of what devices are relevant for you
Trying to cover all devices/font sizes that your app supports is probably a bad idea. The tests will take forever and will use a lot of space,
that increases pull/clone time and makes development a bit more complicated.
We usually use one iPhone with home button, one iPhone with home indicator and the same with iPads.
For dynamic type we stick with `large` that is default and one smaller and one larger size.
Color schemes are only to so we snapshot both of them it app supports dark mode.
This creates a reasonable set of snapshots that truly help us in development.
### Use lower display scale
Having real life snapshots is nice, but once you start snapshotting a 13-inch iPad, a single snapshot can easily have over 10 MB.
This way your repository or LFS storage will grow rapidly, we generally recommend using `displayScale: 1` for snapshots as they are pretty decent
to discover major problems in the app and use really low amount of disk space.
[snapshot-testing]: https://github.com/pointfreeco/swift-snapshot-testing/tree/main