Skip to content

Allow clients to disable auto-record feature (#530) #531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+11 −1
Closed

Allow clients to disable auto-record feature (#530) #531

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion Sources/SnapshotTesting/AssertSnapshot.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import XCTest
/// diffTool = "ksdiff"
public var diffTool: String? = nil

/// Whether or not to automatically record snapshots when an existing file is not found.
public var recordMissingSnapshots = true

/// Whether or not to record all new references.
public var isRecording = false

Expand Down Expand Up @@ -232,8 +235,15 @@ public func verifySnapshot<Value, Format>(
guard var diffable = optionalDiffable else {
return "Couldn't snapshot value"
}

guard !recording, fileManager.fileExists(atPath: snapshotFileUrl.path) else {
if !recording && !recordMissingSnapshots {
return """
No reference was found on disk, and `recordMissingSnapshots` is false.
Did not record snapshot.
"""
}

try snapshotting.diffing.toData(diffable).write(to: snapshotFileUrl)
return recording
? """
Expand Down