Attaching app log to failed tests

Author: niklasberglund

ios/Configurations/UITests.xcconfig.template

@@ -12,7 +12,6 @@ PARTNER_API_TOKEN =
 // Mullvad accounts used by UI tests
 HAS_TIME_ACCOUNT_NUMBER[config=Debug] = 
 HAS_TIME_ACCOUNT_NUMBER[config=Staging] = 
-FIVE_WIREGUARD_KEYS_ACCOUNT_NUMBER = 
 
 // Ad serving domain used when testing ad blocking. Note that we are assuming there's an HTTP server running on the host.
 AD_SERVING_DOMAIN = vpnlist.to

ios/MullvadVPN.xcodeproj/project.pbxproj

@@ -616,6 +616,7 @@
 		850201DB2B503D7700EF8C96 /* RelayTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 850201DA2B503D7700EF8C96 /* RelayTests.swift */; };
 		850201DD2B503D8C00EF8C96 /* SelectLocationPage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 850201DC2B503D8C00EF8C96 /* SelectLocationPage.swift */; };
 		850201DF2B5040A500EF8C96 /* TunnelControlPage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 850201DE2B5040A500EF8C96 /* TunnelControlPage.swift */; };
+		85021CAE2BDBC4290098B400 /* AppLogsPage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 85021CAD2BDBC4290098B400 /* AppLogsPage.swift */; };
 		85139B2D2B84B4A700734217 /* OutOfTimePage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 85139B2C2B84B4A700734217 /* OutOfTimePage.swift */; };
 		852969282B4D9C1F007EAD4C /* AccountTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 852969272B4D9C1F007EAD4C /* AccountTests.swift */; };
 		852969332B4E9232007EAD4C /* Page.swift in Sources */ = {isa = PBXBuildFile; fileRef = 852969322B4E9232007EAD4C /* Page.swift */; };
@@ -1874,6 +1875,7 @@
 		850201DC2B503D8C00EF8C96 /* SelectLocationPage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SelectLocationPage.swift; sourceTree = "<group>"; };
 		850201DE2B5040A500EF8C96 /* TunnelControlPage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TunnelControlPage.swift; sourceTree = "<group>"; };
 		850201E22B51A93C00EF8C96 /* SettingsPage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SettingsPage.swift; sourceTree = "<group>"; };
+		85021CAD2BDBC4290098B400 /* AppLogsPage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppLogsPage.swift; sourceTree = "<group>"; };
 		85139B2C2B84B4A700734217 /* OutOfTimePage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OutOfTimePage.swift; sourceTree = "<group>"; };
 		8518F6372B60157E009EB113 /* LoggedInWithoutTimeUITestCase.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoggedInWithoutTimeUITestCase.swift; sourceTree = "<group>"; };
 		852969252B4D9C1F007EAD4C /* MullvadVPNUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = MullvadVPNUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -3664,6 +3666,7 @@
 				850201DE2B5040A500EF8C96 /* TunnelControlPage.swift */,
 				8542CE232B95F7B9006FCA14 /* VPNSettingsPage.swift */,
 				85FB5A0B2B6903990015DCED /* WelcomePage.swift */,
+				85021CAD2BDBC4290098B400 /* AppLogsPage.swift */,
 			);
 			path = Pages;
 			sourceTree = "<group>";
@@ -5649,6 +5652,7 @@
 				8529693C2B4F0257007EAD4C /* Alert.swift in Sources */,
 				850201DD2B503D8C00EF8C96 /* SelectLocationPage.swift in Sources */,
 				85D039982BA4711800940E7F /* SettingsMigrationTests.swift in Sources */,
+				85021CAE2BDBC4290098B400 /* AppLogsPage.swift in Sources */,
 				850201DB2B503D7700EF8C96 /* RelayTests.swift in Sources */,
 				85139B2D2B84B4A700734217 /* OutOfTimePage.swift in Sources */,
 				85A42B862BB1D627007BABF7 /* XCUIElement+Extensions.swift in Sources */,

ios/MullvadVPN/Classes/AccessbilityIdentifier.swift

@@ -13,6 +13,8 @@ public enum AccessibilityIdentifier: String {
     case accountButton
     case agreeButton
     case alertOkButton
+    case appLogsDoneButton
+    case appLogsShareButton
     case applyButton
     case cancelButton
     case connectionPanelButton
@@ -74,6 +76,7 @@ public enum AccessibilityIdentifier: String {
     case addLocationsView
     case alertContainerView
     case alertTitle
+    case appLogsView
     case changeLogAlert
     case deviceManagementView
     case headerBarView
@@ -101,6 +104,7 @@ public enum AccessibilityIdentifier: String {
     case dnsSettingsEnterIPAddressTextField
     case loginTextField
     case selectLocationSearchTextField
+    case problemReportAppLogsTextView
     case problemReportEmailTextField
     case problemReportMessageTextView
     case deleteAccountTextField

ios/MullvadVPN/View controllers/ProblemReport/ProblemReportReviewViewController.swift

@@ -24,6 +24,8 @@ class ProblemReportReviewViewController: UIViewController {
     override func viewDidLoad() {
         super.viewDidLoad()
 
+        view.accessibilityIdentifier = .appLogsView
+
         navigationItem.title = NSLocalizedString(
             "NAVIGATION_TITLE",
             tableName: "ProblemReportReview",
@@ -37,6 +39,7 @@ class ProblemReportReviewViewController: UIViewController {
                 self?.dismiss(animated: true)
             })
         )
+        navigationItem.rightBarButtonItem?.accessibilityIdentifier = .appLogsDoneButton
 
         #if DEBUG
         navigationItem.leftBarButtonItem = UIBarButtonItem(
@@ -45,8 +48,10 @@ class ProblemReportReviewViewController: UIViewController {
                 self?.share()
             })
         )
+        navigationItem.leftBarButtonItem?.accessibilityIdentifier = .appLogsShareButton
         #endif
 
+        textView.accessibilityIdentifier = .problemReportAppLogsTextView
         textView.translatesAutoresizingMaskIntoConstraints = false
         textView.text = reportString
         textView.isEditable = false

ios/MullvadVPN/View controllers/ProblemReport/ProblemReportViewController+ViewManagement.swift

@@ -88,6 +88,7 @@ extension ProblemReportViewController {
 
     func makeViewLogsButton() -> AppButton {
         let button = AppButton(style: .default)
+        button.accessibilityIdentifier = .problemReportAppLogsButton
         button.translatesAutoresizingMaskIntoConstraints = false
         button.setTitle(Self.persistentViewModel.viewLogsButtonTitle, for: .normal)
         button.addTarget(self, action: #selector(handleViewLogsButtonTap), for: .touchUpInside)
@@ -96,7 +97,7 @@ extension ProblemReportViewController {
 
     func makeSendButton() -> AppButton {
         let button = AppButton(style: .success)
-        button.accessibilityIdentifier = AccessibilityIdentifier.problemReportSendButton
+        button.accessibilityIdentifier = .problemReportSendButton
         button.translatesAutoresizingMaskIntoConstraints = false
         button.setTitle(Self.persistentViewModel.sendLogsButtonTitle, for: .normal)
         button.addTarget(self, action: #selector(handleSendButtonTap), for: .touchUpInside)

ios/MullvadVPNUITests/AccountTests.swift

@@ -54,6 +54,7 @@ class AccountTests: LoggedOutUITestCase {
     }
 
     func testLogin() throws {
+        XCTFail("test")
         let hasTimeAccountNumber = getAccountWithTime()
 
         addTeardownBlock {

ios/MullvadVPNUITests/Pages/AppLogsPage.swift

@@ -0,0 +1,37 @@
+//
+//  AppLogsPage.swift
+//  MullvadVPNUITests
+//
+//  Created by Niklas Berglund on 2024-04-26.
+//  Copyright © 2024 Mullvad VPN AB. All rights reserved.
+//
+
+import XCTest
+
+class AppLogsPage: Page {
+    override init(_ app: XCUIApplication) {
+        super.init(app)
+
+        self.pageAccessibilityIdentifier = .appLogsView
+        waitForPageToBeShown()
+    }
+
+    @discardableResult func tapShareButton() -> Self {
+        app.buttons[AccessibilityIdentifier.appLogsShareButton].tap()
+        return self
+    }
+
+    @discardableResult func tapDoneButton() -> Self {
+        app.buttons[AccessibilityIdentifier.appLogsDoneButton].tap()
+        return self
+    }
+
+    func getAppLogText() -> String {
+        guard let logText = app.textViews[AccessibilityIdentifier.problemReportAppLogsTextView].value as? String else {
+            XCTFail("Failed to extract app log text")
+            return String()
+        }
+
+        return logText
+    }
+}

ios/MullvadVPNUITests/Pages/ProblemReportPage.swift

@@ -33,7 +33,7 @@ class ProblemReportPage: Page {
     }
 
     @discardableResult func tapViewAppLogsButton() -> Self {
-        app.otherElements[AccessibilityIdentifier.problemReportAppLogsButton]
+        app.buttons[AccessibilityIdentifier.problemReportAppLogsButton]
             .tap()
 
         return self

ios/MullvadVPNUITests/Test base classes/BaseUITestCase.swift

@@ -25,6 +25,7 @@ class BaseUITestCase: XCTestCase {
         .infoDictionary?["IOSDevicePinCode"] as! String
     // swiftlint:enable force_cast
 
+    /// Get an account number with time. If an account with time is specified in the configuration file that account will be used, else a temporary account will be created.
     func getAccountWithTime() -> String {
         if let configuredAccountWithTime = bundleHasTimeAccountNumber, !configuredAccountWithTime.isEmpty {
             return configuredAccountWithTime
@@ -36,12 +37,14 @@ class BaseUITestCase: XCTestCase {
         }
     }
 
+    /// Return account with time after done using it This is neccessary because if a temporary account was created we want to delete it.
     func returnAccountWithTime(accountNumber: String) {
         if bundleHasTimeAccountNumber?.isEmpty == true {
             PartnerAPIClient().deleteAccount(accountNumber: accountNumber)
         }
     }
 
+    /// Get an account number without time. If an account without time  is specified in the configuration file that account will be used, else a temporary account will be created.
     func getAccountWithoutTime() -> String {
         if let configuredAccountWithoutTime = bundleNoTimeAccountNumber, !configuredAccountWithoutTime.isEmpty {
             return configuredAccountWithoutTime
@@ -107,7 +110,29 @@ class BaseUITestCase: XCTestCase {
         app.terminate()
 
         if let testRun = self.testRun, testRun.failureCount > 0 {
-            // TODO: extract and store log
+            app.launch()
+
+            HeaderBar(app)
+                .tapSettingsButton()
+
+            SettingsPage(app)
+                .tapReportAProblemCell()
+
+            ProblemReportPage(app)
+                .tapViewAppLogsButton()
+
+            let logText = AppLogsPage(app)
+                .getAppLogText()
+
+            // Attach app log to result
+            let dateFormatter = DateFormatter()
+            dateFormatter.dateFormat = "yyyy-MM-dd_HH-mm-ss"
+            let dateString = dateFormatter.string(from: Date())
+            let attachment = XCTAttachment(string: logText)
+            attachment.name = "app-log-\(dateString).log"
+            add(attachment)
+
+            app.terminate()
         }
     }