Added support for snapshotting Swift UI scenes.

.github/workflows/main.yml

@@ -28,18 +28,19 @@ jobs:
     name: 'Tests'
     needs: [paths-filter]
     if: ${{ !inputs.skip-tests && github.event.pull_request.draft != true && needs.paths-filter.outputs.should-test != 'false' }}
-    uses: grigorye/ReusableWorkflows/.github/workflows/tests-generic.yml@v19
+    uses: grigorye/ReusableWorkflows/.github/workflows/tests-generic.yml@v20
     secrets: inherit
     with:
       runs-on: 'macos-12'
       unit-tests-scheme: 'TMBuddyTests'
       snapshot-tests-scheme: 'TMBuddySnapshots'
+      ui-snapshot-tests-scheme: 'TMBuddyUITestSnapshots'
 
   build-app:
     name: 'App'
     needs: [paths-filter]
     if: ${{ !inputs.skip-build-app && github.event.pull_request.draft != true && needs.paths-filter.outputs.should-build != 'false' }}
-    uses: grigorye/ReusableWorkflows/.github/workflows/build-app-generic.yml@v19
+    uses: grigorye/ReusableWorkflows/.github/workflows/build-app-generic.yml@v20
     with:
       macos-app-scheme: 'TMBuddy'
       build-configs: '[\"app-store\", \"developer-id\"]'

GHAShortcuts/ListSnapshots

@@ -0,0 +1,17 @@
+#! /bin/bash
+
+[ "${RUNNER_DEBUG:-}" == "1" ] && set -x
+
+set -euo pipefail
+
+case "$TESTS_SCHEME" in
+TMBuddySnapshots)
+    find Targets -path '**+Snapshots/**/*.png'
+    ;;
+TMBuddyUITestSnapshots)
+    find Targets -path '**+UITestSnapshots/**/*.png'
+    ;;
+*)
+    exit 1
+    ;;
+esac

README.md

@@ -43,13 +43,13 @@ See and manipulate Time Machine exclusions, right in Finder.
 
 2. Launch the app and follow the checklist, making sure all the red lights:
 
-   <img src="Targets/TMBuddy/Sources/Content/Standalone/MainWindow+Snapshots/macOS-13.3/test.AppStateSample-allGreen-false-tab-TMBuddySnapshots-ContentView-Tab-setup.@2x.png" alt="Checklist-Red.png" width=75% style="zoom:50%;" />
-   <img src="Targets/TMBuddy/Sources/Content/Standalone/MainWindow+Snapshots/macOS-13.3/test.AppStateSample-allGreen-false-tab-TMBuddySnapshots-ContentView-Tab-folders.@2x.png" alt="Checklist-Red.png" width=75% style="zoom:50%;" />
+   <img src="Targets/TMBuddyUITestSnapshots/MainWindow+UITestSnapshots/macOS-13.3/test.allRed_tab-setup.png" alt="Checklist-Red.png" width=75% style="zoom:50%;" />
+   <img src="Targets/TMBuddyUITestSnapshots/MainWindow+UITestSnapshots/macOS-13.3/test.allRed_tab-folders.png" alt="Checklist-Red.png" width=75% style="zoom:50%;" />
 
    turned green:
 
-   <img src="Targets/TMBuddy/Sources/Content/Standalone/MainWindow+Snapshots/macOS-13.3/test.AppStateSample-allGreen-true-tab-TMBuddySnapshots-ContentView-Tab-setup.@2x.png" alt="Checklist-Red.png" width=75% style="zoom:50%;" />
-   <img src="Targets/TMBuddy/Sources/Content/Standalone/MainWindow+Snapshots/macOS-13.3/test.AppStateSample-allGreen-true-tab-TMBuddySnapshots-ContentView-Tab-folders.@2x.png" alt="Checklist-Red.png" width=75% style="zoom:50%;" />
+   <img src="Targets/TMBuddyUITestSnapshots/MainWindow+UITestSnapshots/macOS-13.3/test.allGreen_tab-setup.png" alt="Checklist-Red.png" width=75% style="zoom:50%;" />
+   <img src="Targets/TMBuddyUITestSnapshots/MainWindow+UITestSnapshots/macOS-13.3/test.allGreen_tab-folders.png" alt="Checklist-Red.png" width=75% style="zoom:50%;" />
 
 When selecting folders for the application, typically you want to navigate to Computer and select all the disks for which you want to employ TMBuddy:
 

Targets/OtherTesting/SnapshotTesting/NSWindow+SnapshotTesting.swift

@@ -0,0 +1,66 @@
+import AppKit
+import XCTest
+
+@MainActor
+extension XCTestCase {
+
+    func snapshotFlakyBorderWindow(
+        window: NSWindow,
+        named name: String,
+        record: Bool,
+        file: StaticString = #file,
+        testName: String = #function,
+        line: UInt = #line
+    ) {
+        snapshotFlakyBorderWindow(
+            windowNumber: window.windowNumber,
+            named: name,
+            record: record,
+            file: file,
+            testName: testName,
+            line: line
+        )
+    }
+
+    func snapshotFlakyBorderWindow(
+        windowNumber: Int,
+        listOptions: CGWindowListOption = [],
+        named name: String?,
+        record: Bool,
+        file: StaticString = #file,
+        testName: String = #function,
+        line: UInt = #line
+    ) {
+        let windowNumbers = NSWindow.windowNumbers(listOptions: listOptions, windowNumber: windowNumber)
+
+        assert(!windowNumbers.isEmpty)
+
+        let failures: [String] = windowNumbers.compactMap { windowNumber in
+            let window = NSApplication.shared.window(withWindowNumber: windowNumber)!
+
+            return try! verifySnapshot(
+                matching: NSWindow.snapshot(windowNumbers: [windowNumber], imageOptions: [.bestResolution, .boundsIgnoreFraming]),
+                as: .image(scaleFactor: window.backingScaleFactor),
+                named: name,
+                record: record,
+                file: file,
+                testName: testName + ".borderless",
+                line: line
+            )
+        }
+        if !failures.isEmpty {
+            XCTFail(failures.first!, file: file, line: line)
+        }
+
+        let window = NSApplication.shared.window(withWindowNumber: windowNumber)!
+        assertSnapshot(
+            matching: try NSWindow.snapshot(windowNumbers: windowNumbers, imageOptions: [.bestResolution]),
+            as: .image(scaleFactor: window.backingScaleFactor, ignoreDiffs: failures.isEmpty),
+            named: name,
+            record: record,
+            file: file,
+            testName: testName,
+            line: line
+        )
+    }
+}

Targets/OtherTesting/SnapshotTesting/Paths+SnapshotTesting.swift

@@ -0,0 +1,17 @@
+import Foundation
+
+func snapshotDirectory(forFile file: String) -> String {
+    let file = adjustForSrcRootRelocation(file: file)
+    let fileUrl = URL(fileURLWithPath: file, isDirectory: false)
+    let snapshotDirectoryUrl = fileUrl
+        .deletingPathExtension()
+        .appendingPathComponent(environmentSpecificRelativeSnapshotsPath())
+    return snapshotDirectoryUrl.path
+}
+
+func environmentSpecificRelativeSnapshotsPath() -> String {
+    let osVersion = ProcessInfo.processInfo.operatingSystemVersion
+    return [
+        "macOS-\(osVersion.majorVersion).\(osVersion.minorVersion)"
+    ].joined(separator: "/")
+}

Targets/OtherTesting/SnapshotTesting/Paths+SrcRootRelocation.swift

@@ -0,0 +1,41 @@
+import Foundation
+
+func adjustForSrcRootRelocation(file: String) -> String {
+    let oldSrcRoot = ProcessInfo().environment["OLD_SRCROOT"]
+    let newSrcRoot = ProcessInfo().environment["SRCROOT"]
+
+    guard let newSrcRoot, let oldSrcRoot else {
+        assert(oldSrcRoot == nil, "OLD_SRCROOT is set, but SRCROOT is not.")
+        return file
+    }
+
+    return adjust(file: file, forSrcRoot: oldSrcRoot, changedTo: newSrcRoot)
+}
+
+private func adjust(file: String, forSrcRoot oldSrcRoot: String, changedTo newSrcRoot: String) -> String {
+    // SRCROOT may be somewhere below the root of the actual tree: it's fine, as long as its relative location remains the same.
+
+    let oldBase = oldSrcRoot.commonPrefix(with: file)
+    let oldSuffix = oldSrcRoot[oldBase.endIndex...]
+    let newBase = newSrcRoot.dropLast(oldSuffix.count)
+
+    assert(file.hasPrefix(oldBase))
+
+    return file.replacingOccurrences(of: oldBase, with: newBase, options: .anchored)
+}
+
+import XCTest
+
+class Path_SrcRootRelocation_Tests: XCTestCase {
+
+    func testAdjustForChangedSrcRoot() {
+        XCTAssertEqual(
+            adjust(
+                file: "/Users/user-1/Foo/Bar/Baz/Source.swift",
+                forSrcRoot: "/Users/user-1/Foo/Bar/Project",
+                changedTo: "/Users/user-2/Foo/Bar/Project"
+            ),
+            "/Users/user-2/Foo/Bar/Baz/Source.swift"
+        )
+    }
+}

Targets/OtherTesting/SnapshotTesting/Samples+SnapshotTesting.swift

@@ -93,7 +93,6 @@ extension Snapshotting {
     }
 }
 
-
 func suffixForScaleFactor(_ scaleFactor: CGFloat) -> String? {
     guard scaleFactor != 1.0 else {
         return nil
@@ -105,18 +104,3 @@ func suffixForScaleFactor(_ scaleFactor: CGFloat) -> String? {
         return "@\(scaleFactor)x"
     }
 }
-
-func snapshotDirectory(forFile file: String) -> String {
-    let fileUrl = URL(fileURLWithPath: file, isDirectory: false)
-    let snapshotDirectoryUrl = fileUrl
-        .deletingPathExtension()
-        .appendingPathComponent(environmentSpecificRelativeSnapshotsPath())
-    return snapshotDirectoryUrl.path
-}
-
-func environmentSpecificRelativeSnapshotsPath() -> String {
-    let osVersion = ProcessInfo.processInfo.operatingSystemVersion
-    return [
-        "macOS-\(osVersion.majorVersion).\(osVersion.minorVersion)"
-    ].joined(separator: "/")
-}

Targets/OtherTesting/SnapshotTesting/NSWindow+Snapshotting.swift → Targets/OtherTesting/Snapshotting/NSWindow+Snapshotting.swift

@@ -1,5 +1,4 @@
 import AppKit
-import XCTest
 
 /// Converts given window numbers into CFArray of CGWindowID's.
 func windowArray(_ windowNumbers: [Int]) -> CFArray {
@@ -48,70 +47,6 @@ enum WindowSnapshotError: Swift.Error {
     case timedOut(attempts: Int, timeout: TimeInterval)
 }
 
-@MainActor
-extension XCTestCase {
-
-    func snapshotFlakyBorderWindow(
-        window: NSWindow,
-        named name: String,
-        record: Bool,
-        file: StaticString = #file,
-        testName: String = #function,
-        line: UInt = #line
-    ) {
-        snapshotFlakyBorderWindow(
-            windowNumber: window.windowNumber,
-            named: name,
-            record: record,
-            file: file,
-            testName: testName,
-            line: line
-        )
-    }
-
-    func snapshotFlakyBorderWindow(
-        windowNumber: Int,
-        listOptions: CGWindowListOption = [],
-        named name: String?,
-        record: Bool,
-        file: StaticString = #file,
-        testName: String = #function,
-        line: UInt = #line
-    ) {
-        let windowNumbers = NSWindow.windowNumbers(listOptions: listOptions, windowNumber: windowNumber)
-
-        assert(!windowNumbers.isEmpty)
-
-        let failures: [String] = windowNumbers.compactMap { windowNumber in
-            let window = NSApplication.shared.window(withWindowNumber: windowNumber)!
-
-            return try! verifySnapshot(
-                matching: NSWindow.snapshot(windowNumbers: [windowNumber], imageOptions: [.bestResolution, .boundsIgnoreFraming]),
-                as: .image(scaleFactor: window.backingScaleFactor),
-                named: name,
-                record: record,
-                file: file,
-                testName: testName + ".borderless",
-                line: line
-            )
-        }
-        if !failures.isEmpty {
-            XCTFail(failures.first!, file: file, line: line)
-        }
-
-        let window = NSApplication.shared.window(withWindowNumber: windowNumber)!
-        assertSnapshot(
-            matching: try NSWindow.snapshot(windowNumbers: windowNumbers, imageOptions: [.bestResolution]),
-            as: .image(scaleFactor: window.backingScaleFactor, ignoreDiffs: failures.isEmpty),
-            named: name,
-            record: record,
-            file: file,
-            testName: testName,
-            line: line
-        )
-    }
-}
-
 extension NSWindow {
 
     static func windowNumbers(listOptions: CGWindowListOption = [], windowNumber: Int) -> [Int] {

Targets/OtherTesting/Snapshotting/NSWindow+SnapshottingFlakyBorder.swift

@@ -0,0 +1,32 @@
+import AppKit
+
+@MainActor
+func snapshotFlakyBorderWindow(window: NSWindow, snapshotBaseURL: URL) {
+    let borderlessSnapshotURL = snapshotBaseURL.appendingPathExtension("borderless.png")
+    let shadowSnapshotURL = snapshotBaseURL.appendingPathExtension("png")
+    defer {
+        try? FileManager.default.setAttributes([.modificationDate: Date()], ofItemAtPath: borderlessSnapshotURL.path)
+        try? FileManager.default.setAttributes([.modificationDate: Date()], ofItemAtPath: shadowSnapshotURL.path)
+    }
+    // Snapshot shadowless, and *bail out* unless it's changed.
+    do {
+        let snapshotURL = borderlessSnapshotURL
+        let snapshot = try! window.snapshot(options: [.bestResolution, .boundsIgnoreFraming])
+        let newBitmapRep = NSBitmapImageRep(data: snapshot.tiffRepresentation!)!.representation(using: .png, properties: [:])!
+        if let oldBitmapRep = try? Data(contentsOf: snapshotURL) {
+            guard oldBitmapRep != newBitmapRep else {
+                return // Avoid recording yet another (flaky) snapshot with shadow.
+            }
+        }
+        try! FileManager.default.createDirectory(at: snapshotURL.deletingLastPathComponent(), withIntermediateDirectories: true)
+        try! newBitmapRep.write(to: snapshotURL)
+    }
+
+    // Take another snapshot variant, now with shadow.
+    do {
+        let snapshotURL = shadowSnapshotURL
+        let snapshot = try! window.snapshot(options: [.bestResolution])
+        let newBitmapRep = NSBitmapImageRep(data: snapshot.tiffRepresentation!)!.representation(using: .png, properties: [:])!
+        try! newBitmapRep.write(to: snapshotURL)
+    }
+}

Targets/OtherTesting/Snapshotting/SwiftUI+SnapshottingUITestWindow.swift

@@ -0,0 +1,31 @@
+import SwiftUI
+import AppKit
+
+extension View {
+    func snapshottingUITestWindow() -> some View {
+        self
+            .background(SnapshottingView())
+    }
+}
+
+private struct SnapshottingView: NSViewRepresentable {
+
+    func makeNSView(context: Context) -> NSView {
+        let view = NSView()
+        DispatchQueue.main.asyncAfter(deadline: .now() + 0.5 /* allow window to become key one */) {
+            snapshot(window: view.window)
+        }
+        return view
+    }
+
+    func updateNSView(_ nsView: NSView, context: Context) {
+        snapshot(window: nsView.window)
+    }
+
+    @MainActor
+    func snapshot(window: NSWindow?) {
+        guard let window = window else { return }
+        let snapshotBaseURL = URL(fileURLWithPath: UserDefaults.standard.string(forKey: "snapshotBasePath")!)
+        snapshotFlakyBorderWindow(window: window, snapshotBaseURL: snapshotBaseURL)
+    }
+}

Targets/TMBuddy/Sources/AppGlobals/DisplayNames.swift

@@ -6,7 +6,7 @@ private let fileManager = FileManager.default
 
 @MainActor var appName: String {
 #if !GE_SNAPSHOT_TESTING
-    fileManager.displayName(atPath: Bundle.main.bundlePath)
+    Bundle.main.object(forInfoDictionaryKey: "CFBundleDisplayName") as? String ?? fileManager.displayName(atPath: Bundle.main.bundlePath)
 #else
     "TMBuddy"
 #endif

Targets/TMBuddy/Sources/Content/Standalone/AppState+Samples.swift

@@ -1,6 +1,6 @@
 import SwiftUI
 
-struct AppStateSample: CaseIterable {
+struct AppStateSample: CaseIterable, Codable {
     var allGreen: Bool
     var tab: ContentView.Tab
 
@@ -11,6 +11,13 @@ struct AppStateSample: CaseIterable {
             }
         }
     }
+
+    var sampleName: String {
+        [
+            allGreen ? "allGreen" : "allRed",
+            "tab-\(tab.rawValue)"
+        ].joined(separator: "_")
+    }
 }
 
 extension View {

Targets/TMBuddy/Sources/Content/Standalone/ContentView.swift

@@ -3,7 +3,7 @@ import Foundation
 
 struct ContentView: View {
 
-    enum Tab: String {
+    enum Tab: String, Codable {
         case setup
         case folders
         case legend