https://github.com/sherlouk/swift-snapshot-testing-stitch

Combine SnapshotTesting images into a single asset
https://github.com/sherlouk/swift-snapshot-testing-stitch

ios snapshot-testing swift swift-package-manager

Last synced: about 1 month ago
JSON representation

Combine SnapshotTesting images into a single asset

• Host: GitHub
• URL: https://github.com/sherlouk/swift-snapshot-testing-stitch
• Owner: Sherlouk
• License: mit
• Created: 2021-06-26T17:57:18.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-23T18:17:39.000Z (about 1 year ago)
• Last Synced: 2025-05-03T17:43:45.375Z (about 1 month ago)
• Topics: ios, snapshot-testing, swift, swift-package-manager
• Language: Swift
• Homepage:
• Size: 336 KB
• Stars: 49
• Watchers: 1
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SnapshotTesting Stitch

[![Compatible with the latest Swift versions](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FSherlouk%2Fswift-snapshot-testing-stitch%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/Sherlouk/swift-snapshot-testing-stitch) [![Compatible with iOS](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FSherlouk%2Fswift-snapshot-testing-stitch%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/Sherlouk/swift-snapshot-testing-stitch) [![Contact @JamesSherlouk on Twitter](https://img.shields.io/badge/[email protected])](https://twitter.com/JamesSherlouk)

An extension to [SnapshotTesting](https://github.com/pointfreeco/swift-snapshot-testing) which allows you to create images combining the output of multiple snapshot strategies, assuming they all output to `UIImage`.

In essence, this allows you to have a single image which represents a single view in your application, shown in multiple different configurations. This might be useful, for example, where you want to visualize the same UIViewController on multiple devices or in light and dark mode.

Images may also have titles, allowing you to easily identify each configuration within the image.

![An image demonstrating an example output of the package. It shows seven views coloured in blue with red borders with titles above each of them naming each of the views.](Tests/SnapshotTestingStitchTests/__Snapshots__/SnapshotTestingStitch/test_withManyDevices.1.png)

## Usage

Once [installed](#installation), _no additional configuration is required_. You can import the `SnapshotTestingStitch` module, call `SnapshotTesting` following their usage guide and simply provide our `stitch` strategy as below.

```swift

import SnapshotTesting

import SnapshotTestingStitch

import XCTest

class MyViewControllerTests: XCTestCase {

  func testMyViewController() {

    let vc = MyViewController()

    assertSnapshot(matching: vc, as: .stitch(strategies: [

      .image(on: .iPhone8),

      .image(on: .iPhone8Plus),

    ]))

  }

}

```

### Titles

By default, if you simply provide an array of strategies then these will be untitled. If you instead provide a tuple

containing a string and the strategy then the string will be positioned as a title above the image in the snapshot.

```swift

assertSnapshot(matching: vc, as: .stitch(strategies: [

  ("iPhone 8", .image(on: .iPhone8)),

  ("iPhone 8 Plus", .image(on: .iPhone8Plus)),

]))

```

### Customization

An optional parameter of the `stitch` strategy is the "style". This value allows you to customize certain parts of the

rendered snapshot generated by the package.

This includes the spacing around the images, the colors used, and an optional border which can surround each image. The

border can be useful for clearly identifying the bounds of each image - especially if the image background is the same

as the snapshot background.

Opinionated defaults have already been provided for you. 

```swift

assertSnapshot(matching: vc, as: .stitch(strategies: [

  ("iPhone 8", .image(on: .iPhone8)),

  ("iPhone 8 Plus", .image(on: .iPhone8Plus)),

], style: .init(

  fontSize: 20,

  titleColor: .white,

  borderColor: .red,

  borderWidth: 5,

  itemSpacing: 32,

  framePadding: 32,

  titleSpacing: 32,

  backgroundColor: .black

)))

```

## Installation

### Xcode 11

> ⚠️ Warning: By default, Xcode will try to add the SnapshotTestingStitch package to your project's main application/framework target. Please ensure that SnapshotTestingStitch is added to a _test_ target instead, as documented in the last step, below.

 1. From the **File** menu, navigate through **Swift Packages** and select **Add Package Dependency…**.

 2. Enter package repository URL: `https://github.com/Sherlouk/swift-snapshot-testing-stitch`

 3. Confirm the version and let Xcode resolve the package

 4. On the final dialog, update SnapshotTestingStitch's **Add to Target** column to a test target that will contain snapshot tests (if you have more than one test target, you can later add SnapshotTestingStitch to them by manually linking the library in its build phase)

### Swift Package Manager

If you want to use SnapshotTestingStitch in any other project that uses [Swift Package Manager](https://swift.org/package-manager/), add the package as a dependency in `Package.swift`:

```swift

dependencies: [

  .package(name: "SnapshotTestingStitch", url: "https://github.com/Sherlouk/swift-snapshot-testing-stitch.git", from: "1.0.0"),

]

```

Next, add `SnapshotTestingStitch` as a dependency of your test target:

```swift

targets: [

  .target(

    name: "MyApp"

  ),

  

  .testTarget(

    name: "MyAppTests", 

    dependencies: [

      .target(name: "MyApp"),

      .product(name: "SnapshotTestingStitch", package: "SnapshotTestingStitch"),

    ]

  ),

]

```

### Other

We do not currently support distribution through CocoaPods or Carthage.

## License

This library is released under the MIT license. See [LICENSE](LICENSE) for details.