test: Improve corrupted envelope UI test (#5549)

Simplify the UI test by writing the corrupted envelope and then starting
the SDK. This removes the need to relaunch the app, which is often
problematic in CI. Furthermore, this PR now lets the UI test fail with
an error message if the test can't write the corrupted envelope instead
of using fatalError. So when this fails, we know clearly what went
wrong.

Author: philipphofmann

TestSamples/SwiftUITestSample/SwiftUITestSample/SwiftUITestSampleApp.swift

@@ -1,21 +1,8 @@
 import Sentry
 import SwiftUI
 
-struct Options {
-    static var dsnHash: String?
-    static var cacheDirPath: String?
-}
-
 @main
 struct SwiftUITestSampleApp: App {
-    init() {
-        SentrySDK.start { options in
-            options.debug = true
-            options.dsn = "https://6cc9bae94def43cab8444a99e0031c28@o447951.ingest.sentry.io/5428557"
-            Options.dsnHash = options.parsedDsn?.getHash()
-            Options.cacheDirPath = options.cacheDirectoryPath
-        }
-    }
 
     var body: some Scene {
         WindowGroup {
@@ -25,38 +12,81 @@ struct SwiftUITestSampleApp: App {
 }
 
 struct ContentView: View {
+    @State private var errorMessage: String?
+    
     var body: some View {
         VStack {
             Text("Welcome!")
-            Button("Close SDK") {
-                SentrySDK.close()
+            Button("Start SDK") {
+                startSDK()
             }
             Button("Write Corrupted Envelope") {
-                guard let dsnHash = Options.dsnHash else {
-                    fatalError("dsnHash can not be nil!")
-                }
-
-                guard let cachePath = Options.cacheDirPath else {
-                    fatalError("cacheDirPath can not be nil!")
-                }
-
-                let envelopePath = "\(cachePath)/io.sentry/\(dsnHash)/envelopes/corrupted-envelope.json"
-                let corruptedEnvelopeData = Data("""
-                   {"event_id":"1990b5bc31904b7395fd07feb72daf1c","sdk":{"name":"sentry.cocoa","version":"8.33.0"}}
-                   {"type":"test","length":50}
-                   """.utf8)
-
                 do {
-                    try corruptedEnvelopeData.write(to: URL(fileURLWithPath: envelopePath))
-                    print("Corrupted envelope saved to: " + envelopePath)
+                    errorMessage = nil // Clear any previous error
+                    try writeCorruptedEnvelope()
+                } catch let error as WriteCorruptedEnvelopeError {
+                    errorMessage = error.description
                 } catch {
-                    fatalError("Error while writing corrupted envelope to: " + envelopePath)
+                    errorMessage = "Unknown error: \(error)"
                 }
             }
+
+            if let errorMessage = errorMessage {
+                Text("\(errorMessage)")
+                    .accessibilityIdentifier("errorMessage")
+            }
         }
     }
 }
 
+private var sentryOptions: Options = {
+    let options = Options()
+    options.dsn = "https://6cc9bae94def43cab8444a99e0031c28@o447951.ingest.sentry.io/5428557"
+    options.debug = true
+    return options
+}()
+
+private func startSDK() {
+    SentrySDK.start(options: sentryOptions)
+}
+
+enum WriteCorruptedEnvelopeError: Error {
+  case dsn
+  case write(String)
+}
+
+extension WriteCorruptedEnvelopeError: CustomStringConvertible {
+  var description: String {
+    switch self {
+      case .dsn:
+        return "DSN hash is not available"
+      case .write(let s):
+        return s
+   }
+  }
+}
+
+private func writeCorruptedEnvelope() throws {
+    guard let dsnHash = sentryOptions.parsedDsn?.getHash() else {
+        throw WriteCorruptedEnvelopeError.dsn
+    }
+
+    let envelopeFolder = "\(sentryOptions.cacheDirectoryPath)/io.sentry/\(dsnHash)/envelopes"
+    let envelopePath = "\(envelopeFolder)/corrupted-envelope.json"
+    let corruptedEnvelopeData = Data("""
+       {"event_id":"1990b5bc31904b7395fd07feb72daf1c","sdk":{"name":"sentry.cocoa","version":"8.33.0"}}
+       {"type":"test","length":50}
+       """.utf8)
+
+    do {
+        let fileManager = FileManager.default
+        try fileManager.createDirectory(atPath: envelopeFolder, withIntermediateDirectories: true)
+        try corruptedEnvelopeData.write(to: URL(fileURLWithPath: envelopePath), options: .atomic)
+    } catch {
+        throw WriteCorruptedEnvelopeError.write("Error while writing corrupted envelope to: \(envelopePath) error: \(error)")
+    }
+}
+
 struct ContentView_Previews: PreviewProvider {
     static var previews: some View {
         ContentView()

TestSamples/SwiftUITestSample/SwiftUITestSampleUITestsEnvelopeOnly/EnvelopeTests.swift

@@ -1,30 +1,20 @@
 import XCTest
 
 final class EnvelopeTest: XCTestCase {
-    let app = XCUIApplication()
-
-    override func setUpWithError() throws {
-        continueAfterFailure = false
-    }
 
     func testCorruptedEnvelope() throws {
-        launchApp()
-        
-        app.buttons["Write Corrupted Envelope"].tap()
-        // The close here ensures the next corrupted envelope
-        // will be present on the next app launch
-        app.buttons["Close SDK"].tap()
+        let app = XCUIApplication()
+
+        app.launch()
+
         app.buttons["Write Corrupted Envelope"].tap()
-        
-        app.terminate()
-        launchApp()
+        let errorMessageElement = app.staticTexts["errorMessage"]
+        if errorMessageElement.exists {
+            XCTFail("Writing corrupted envelope failed with \(errorMessageElement.label)")
+        }
+
+        app.buttons["Start SDK"].tap()
+
         XCTAssertTrue(app.staticTexts["Welcome!"].exists)
     }
-    
-    private func launchApp() {
-        app.activate()
-        // Wait for the app to be ready
-        sleep(2)
-        app.launch()
-    }
 }