Skip to content

Added ScreenshotTestHelpers #2682

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

Merged
jlpl15 merged 15 commits into from
Jan 13, 2026
Merged

Added ScreenshotTestHelpers #2682

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c9a774b
Added ScreenshotTestHelpers
jlpl15 Jan 6, 2026
5572459
Make snapshot names shorter
jlpl15 Jan 6, 2026
b0b1e66
Add unified screenshot helpers with loop shortcuts and intrinsic sizing
jlpl15 Jan 7, 2026
28b5e97
Test example
jlpl15 Jan 7, 2026
2520d22
fix lint
jlpl15 Jan 7, 2026
0183559
fix test
jlpl15 Jan 7, 2026
2a29112
Snapshot helpers: full-name format, failure context with XCTFail, and…
jlpl15 Jan 7, 2026
3bd34f1
Snapshot helpers: detailed names, proper failure context, correct sna…
jlpl15 Jan 8, 2026
7cf3b08
New snapshots
jlpl15 Jan 8, 2026
aa5b2ee
fix lint
jlpl15 Jan 8, 2026
70e5df3
fix lint again
jlpl15 Jan 8, 2026
b83c70f
Snapshot naming changes: shorter codes and legend added to the helper
jlpl15 Jan 12, 2026
c985900
Shortened device codes
jlpl15 Jan 12, 2026
ce6999f
delete old snapshots tests
jlpl15 Jan 13, 2026
f634f62
missing snapshot
jlpl15 Jan 13, 2026
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
0 ...trollerTests_testLoginToutView_pad_ja.png → ...ght_UICTContentSizeCategoryM_portrait.png
View file
Open in desktop
File renamed without changes
0 ...sts_testLoginToutView_phone4-7inch_en.png → ...izeCategoryAccessibilityXXXL_portrait.png
View file
Open in desktop
Copy link
Contributor

@ifosli ifosli Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still find these file names to be way too long to be practical, at least in my personal work flow. Maybe it's worth checking with the team what info they find necessary in a snapshot test? Personally, I don't think things like device type and size category are useful enough to be worth the extra words, but I'm okay with being outvoted.

Even without removing information, there's still some things you could do to make the name more streamlined. The full path of this one is ios-oss/Kickstarter-iOS/Features/LoginTout/Controller/__Snapshots__/testLoginToutView.LoginToutViewControllerTests_testLoginToutView_phone4-7inch_en_dark_UICTContentSizeCategoryAccessibilityXXXL_portrait.png. Notice how this includes the test name twice? I also think it'd be worth describing the content size category more concisely if we're going to include it at all - maybe as accessibilityXXL?

Copy link
Contributor Author

@jlpl15 jlpl15 Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can drop the file/test prefix from the named: value so the filename is just the config (device/lang/style/font/orientation), and let the test’s Snapshots/testLoginToutView/ folder provide the test context. I’ll also shorten the content-size labels—thinking a11yXXXL as a common shorthand for “accessibility” to keep names shorter, but I can spell out “accessibilityXXXL” if you prefer. With these tweaks, a filename would look like phone4_7inch_en_dark_a11yXXXL_portrait.png. If the team wants to trim further (e.g., drop style/font), I can do that too.

File renamed without changes
0 ...Tests_testLoginToutView_phone4inch_de.png → ...ght_UICTContentSizeCategoryM_portrait.png
View file
Open in desktop
File renamed without changes
0 ...sts_testLoginToutView_phone5-5inch_es.png → ...ght_UICTContentSizeCategoryM_portrait.png
View file
Open in desktop
File renamed without changes
0 ...sts_testLoginToutView_phone5-8inch_fr.png → ...izeCategoryAccessibilityXXXL_portrait.png
View file
Open in desktop
File renamed without changes
1 change: 1 addition & 0 deletions Kickstarter-iOS/TestHelpers/Combos.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,5 @@ internal func orthogonalCombos<A, B, C, D, E>(
)
}
}

// swiftlint:enable large_tuple
42 changes: 34 additions & 8 deletions Kickstarter-iOS/TestHelpers/ScreenshotTestHelpers.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,10 @@ internal func assertSnapshot(
forController controller: UIViewController,
withType type: ScreenshotType,
perceptualPrecision: Float? = nil,
record _: Bool = false,
record: Bool = false,
file: StaticString = #file,
testName: String = #function,
line _: UInt = #line
line: UInt = #line
) {
let contentSizeTraits = UITraitCollection(
preferredContentSizeCategory: type.contentSizeCategory
Expand Down Expand Up @@ -149,19 +149,26 @@ internal func assertSnapshot(
return .image
}()

let directory = snapshotDirectory(for: file)

if let failure = verifySnapshot(
of: parent.view,
as: strategy,
named: name,
record: record,
snapshotDirectory: directory,
file: file,
testName: testName,
line: line
) {
XCTFail(
"""
Snapshot failed for \(name)
device=\(type.device.snapshotDescription), lang=\(type.language.rawValue), style=\(type.style.snapshotDescription), font=\(type.contentSizeCategory.rawValue), orientation=\(type.orientation.snapshotDescription)
device=\(type.device.snapshotDescription),
lang=\(type.language.rawValue),
style=\(type.style.snapshotDescription),
font=\(type.contentSizeCategory.rawValue),
orientation=\(type.orientation.snapshotDescription)
Copy link
Contributor

@ifosli ifosli Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Copy link
Contributor

@amy-at-kickstarter amy-at-kickstarter Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thanks for adding!

\(failure)
""",
file: file,
Expand All @@ -178,7 +185,7 @@ internal func assertSnapshot(
size: CGSize? = nil,
useIntrinsicSize: Bool = false,
perceptualPrecision: Float? = nil,
record _: Bool = false,
record: Bool = false,
file: StaticString = #file,
testName: String = #function,
line: UInt = #line
Expand Down Expand Up @@ -242,19 +249,26 @@ internal func assertSnapshot(
return .image
}()

let directory = snapshotDirectory(for: file)

if let failure = verifySnapshot(
of: parent.view,
as: strategy,
named: name,
record: record,
snapshotDirectory: directory,
file: file,
testName: testName,
line: line
) {
XCTFail(
"""
Snapshot failed for \(name)
device=\(type.device.snapshotDescription), lang=\(type.language.rawValue), style=\(type.style.snapshotDescription), font=\(type.contentSizeCategory.rawValue), orientation=\(type.orientation.snapshotDescription)
device=\(type.device.snapshotDescription),
lang=\(type.language.rawValue),
style=\(type.style.snapshotDescription),
font=\(type.contentSizeCategory.rawValue),
orientation=\(type.orientation.snapshotDescription)
\(failure)
""",
file: file,
Expand All @@ -271,7 +285,7 @@ internal func assertSnapshot<Content: View>(
size: CGSize? = nil,
useIntrinsicSize: Bool = false,
perceptualPrecision: Float? = nil,
record _: Bool = false,
record: Bool = false,
file: StaticString = #file,
testName: String = #function,
line: UInt = #line
Expand Down Expand Up @@ -366,11 +380,23 @@ private extension Orientation {
}
}

// MARK: - Private helpers
private extension UIUserInterfaceStyle {
var snapshotDescription: String {
switch self {
case .light: return "light"
case .dark: return "dark"
default: return "unspecified"
}
}
}

private func snapshotDirectory(for file: StaticString) -> String {
let fileURL = URL(fileURLWithPath: "\(file)")
return fileURL.deletingLastPathComponent().appendingPathComponent("__Snapshots__").path
}

private func withLanguage(_ language: Language, body: () -> Void) {
AppEnvironment.pushEnvironment(language: language)
body()
AppEnvironment.popEnvironment()
}