Converge on same naming convention for snapshots in the preview tests as in the UI tests.

ElementX.xcodeproj/xcshareddata/xcschemes/ElementX.xcscheme

@@ -4,8 +4,7 @@
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"
-      buildImplicitDependencies = "YES"
-      runPostActionsOnFailure = "NO">
+      buildImplicitDependencies = "YES">
       <BuildActionEntries>
          <BuildActionEntry
             buildForTesting = "YES"
@@ -30,12 +29,6 @@
       shouldUseLaunchSchemeArgsEnv = "YES"
       codeCoverageEnabled = "YES"
       onlyGenerateCoverageForSpecifiedTargets = "YES">
-      <TestPlans>
-         <TestPlanReference
-            default = "YES"
-            reference = "container:UnitTests/SupportingFiles/UnitTests.xctestplan">
-         </TestPlanReference>
-      </TestPlans>
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
@@ -45,10 +38,6 @@
             ReferencedContainer = "container:ElementX.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
-      <Testables>
-      </Testables>
-      <CommandLineArguments>
-      </CommandLineArguments>
       <CodeCoverageTargets>
          <BuildableReference
             BuildableIdentifier = "primary"
@@ -58,6 +47,12 @@
             ReferencedContainer = "container:ElementX.xcodeproj">
          </BuildableReference>
       </CodeCoverageTargets>
+      <TestPlans>
+         <TestPlanReference
+            reference = "container:UnitTests/SupportingFiles/UnitTests.xctestplan"
+            default = "YES">
+         </TestPlanReference>
+      </TestPlans>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Debug"
@@ -79,8 +74,6 @@
             ReferencedContainer = "container:ElementX.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
-      <CommandLineArguments>
-      </CommandLineArguments>
       <EnvironmentVariables>
          <EnvironmentVariable
             key = "HTTPS_PROXY"
@@ -115,8 +108,6 @@
             ReferencedContainer = "container:ElementX.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
-      <CommandLineArguments>
-      </CommandLineArguments>
    </ProfileAction>
    <AnalyzeAction
       buildConfiguration = "Debug">

ElementX.xcodeproj/xcshareddata/xcschemes/PreviewTests.xcscheme

@@ -4,8 +4,7 @@
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"
-      buildImplicitDependencies = "YES"
-      runPostActionsOnFailure = "NO">
+      buildImplicitDependencies = "YES">
       <BuildActionEntries>
          <BuildActionEntry
             buildForTesting = "YES"
@@ -30,12 +29,6 @@
       shouldUseLaunchSchemeArgsEnv = "YES"
       codeCoverageEnabled = "YES"
       onlyGenerateCoverageForSpecifiedTargets = "YES">
-      <TestPlans>
-         <TestPlanReference
-            default = "YES"
-            reference = "container:PreviewTests/SupportingFiles/PreviewTests.xctestplan">
-         </TestPlanReference>
-      </TestPlans>
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
@@ -45,10 +38,6 @@
             ReferencedContainer = "container:ElementX.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
-      <Testables>
-      </Testables>
-      <CommandLineArguments>
-      </CommandLineArguments>
       <CodeCoverageTargets>
          <BuildableReference
             BuildableIdentifier = "primary"
@@ -58,6 +47,12 @@
             ReferencedContainer = "container:ElementX.xcodeproj">
          </BuildableReference>
       </CodeCoverageTargets>
+      <TestPlans>
+         <TestPlanReference
+            reference = "container:PreviewTests/SupportingFiles/PreviewTests.xctestplan"
+            default = "YES">
+         </TestPlanReference>
+      </TestPlans>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Debug"
@@ -78,8 +73,6 @@
             ReferencedContainer = "container:ElementX.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
-      <CommandLineArguments>
-      </CommandLineArguments>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"
@@ -87,8 +80,6 @@
       savedToolIdentifier = ""
       useCustomWorkingDirectory = "NO"
       debugDocumentVersioning = "YES">
-      <CommandLineArguments>
-      </CommandLineArguments>
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"

ElementX/Sources/Screens/BugReportScreen/View/BugReportScreen.swift

@@ -137,7 +137,7 @@ struct BugReportScreen: View {
 
 // MARK: - Previews
 
-struct BugReport_Previews: PreviewProvider, TestablePreview {
+struct BugReportScreen_Previews: PreviewProvider, TestablePreview {
     static var previews: some View {
         NavigationStack {
             let clientProxy = ClientProxyMock(.init(userID: "@mock:client.com", roomSummaryProvider: RoomSummaryProviderMock(.init(state: .loaded(.mockRooms)))))
@@ -145,8 +145,8 @@ struct BugReport_Previews: PreviewProvider, TestablePreview {
                                                               clientProxy: clientProxy,
                                                               screenshot: nil,
                                                               isModallyPresented: false).context)
-                .previewDisplayName("Without Screenshot")
         }
+        .previewDisplayName("Without Screenshot")
         
         NavigationStack {
             let clientProxy = ClientProxyMock(.init(userID: "@mock:client.com", roomSummaryProvider: RoomSummaryProviderMock(.init(state: .loaded(.mockRooms)))))
@@ -154,7 +154,7 @@ struct BugReport_Previews: PreviewProvider, TestablePreview {
                                                               clientProxy: clientProxy,
                                                               screenshot: Asset.Images.appLogo.image,
                                                               isModallyPresented: false).context)
-                .previewDisplayName("With Screenshot")
         }
+        .previewDisplayName("With Screenshot")
     }
 }

PreviewTests/Sources/PreviewTests.swift

@@ -51,7 +51,7 @@ class PreviewTests: XCTestCase {
     
     // MARK: - Snapshots
 
-    func assertSnapshots(matching preview: _Preview, testName: String = #function) async throws {
+    func assertSnapshots(matching preview: _Preview, testName: String = #function, step: Int) async throws {
         let preferences = SnapshotPreferences()
         
         let preferenceReadingView = preview.content
@@ -68,6 +68,9 @@ class PreviewTests: XCTestCase {
             try await deferred.fulfill()
         }
         
+        var sanitizedSuiteName = String(testName.suffix(testName.count - "test".count).dropLast(2))
+        sanitizedSuiteName = sanitizedSuiteName.prefix(1).lowercased() + sanitizedSuiteName.dropFirst()
+        
         for deviceName in snapshotDevices {
             guard var device = PreviewDevice(rawValue: deviceName).snapshotDevice() else {
                 fatalError("Unknown device name: \(deviceName)")
@@ -76,11 +79,19 @@ class PreviewTests: XCTestCase {
             device.safeArea = .one
             // Ignore specific device display scale
             let traits = UITraitCollection(displayScale: 2.0)
+            
+            var testName = ""
+            if let displayName = preview.displayName {
+                testName = "\(displayName)-\(deviceName)-\(localeCode)"
+            } else {
+                testName = "\(deviceName)-\(localeCode)-\(step)"
+            }
+            
             if let failure = assertSnapshots(matching: preview.content,
-                                             name: preview.displayName,
+                                             name: testName,
                                              isScreen: preview.layout == .device,
                                              device: device,
-                                             testName: testName + deviceName + "-" + localeCode,
+                                             testName: sanitizedSuiteName,
                                              traits: traits,
                                              preferences: preferences) {
                 XCTFail(failure)