Add WireGuard tests for iOS app

Author: niklasberglund

ios/Configurations/UITests.xcconfig.template

@@ -15,6 +15,9 @@ 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
+
+// A domain which should be reachable. Used to verify Internet connectivity. Must be running a server on port 80.
+SHOULD_BE_REACHABLE_DOMAIN = mullvad.net
 
 // Base URL for the firewall API, Note that // will be treated as a comment, therefor you need to insert a ${} between the slashes for example http:/${}/8.8.8.8
 FIREWALL_API_BASE_URL = http:/${}/8.8.8.8

ios/MullvadVPN.xcodeproj/project.pbxproj

@@ -603,6 +603,7 @@
 		8529693A2B4F0238007EAD4C /* TermsOfServicePage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 852969392B4F0238007EAD4C /* TermsOfServicePage.swift */; };
 		8529693C2B4F0257007EAD4C /* Alert.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8529693B2B4F0257007EAD4C /* Alert.swift */; };
 		8532E6872B8CCED600ACECD1 /* ProblemReportSubmittedPage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8532E6862B8CCED600ACECD1 /* ProblemReportSubmittedPage.swift */; };
+		8542CE242B95F7B9006FCA14 /* VPNSettingsPage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8542CE232B95F7B9006FCA14 /* VPNSettingsPage.swift */; };
 		85557B0E2B591B2600795FE1 /* FirewallAPIClient.swift in Sources */ = {isa = PBXBuildFile; fileRef = 85557B0D2B591B2600795FE1 /* FirewallAPIClient.swift */; };
 		85557B102B59215F00795FE1 /* FirewallRule.swift in Sources */ = {isa = PBXBuildFile; fileRef = 85557B0F2B59215F00795FE1 /* FirewallRule.swift */; };
 		85557B122B594FC900795FE1 /* ConnectivityTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 85557B112B594FC900795FE1 /* ConnectivityTests.swift */; };
@@ -1828,6 +1829,7 @@
 		852969392B4F0238007EAD4C /* TermsOfServicePage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TermsOfServicePage.swift; sourceTree = "<group>"; };
 		8529693B2B4F0257007EAD4C /* Alert.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Alert.swift; sourceTree = "<group>"; };
 		8532E6862B8CCED600ACECD1 /* ProblemReportSubmittedPage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProblemReportSubmittedPage.swift; sourceTree = "<group>"; };
+		8542CE232B95F7B9006FCA14 /* VPNSettingsPage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VPNSettingsPage.swift; sourceTree = "<group>"; };
 		85557B0D2B591B2600795FE1 /* FirewallAPIClient.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FirewallAPIClient.swift; sourceTree = "<group>"; };
 		85557B0F2B59215F00795FE1 /* FirewallRule.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FirewallRule.swift; sourceTree = "<group>"; };
 		85557B112B594FC900795FE1 /* ConnectivityTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConnectivityTests.swift; sourceTree = "<group>"; };
@@ -3536,6 +3538,7 @@
 				850201E22B51A93C00EF8C96 /* SettingsPage.swift */,
 				852969392B4F0238007EAD4C /* TermsOfServicePage.swift */,
 				850201DE2B5040A500EF8C96 /* TunnelControlPage.swift */,
+				8542CE232B95F7B9006FCA14 /* VPNSettingsPage.swift */,
 			);
 			path = Pages;
 			sourceTree = "<group>";
@@ -5500,6 +5503,7 @@
 				8529693A2B4F0238007EAD4C /* TermsOfServicePage.swift in Sources */,
 				8532E6872B8CCED600ACECD1 /* ProblemReportSubmittedPage.swift in Sources */,
 				850201DF2B5040A500EF8C96 /* TunnelControlPage.swift in Sources */,
+				8542CE242B95F7B9006FCA14 /* VPNSettingsPage.swift in Sources */,
 				85557B1E2B5FB8C700795FE1 /* HeaderBar.swift in Sources */,
 				85557B122B594FC900795FE1 /* ConnectivityTests.swift in Sources */,
 				852969332B4E9232007EAD4C /* Page.swift in Sources */,

ios/MullvadVPN/Classes/AccessbilityIdentifier.swift

@@ -33,6 +33,8 @@ public enum AccessibilityIdentifier: String {
     case startUsingTheAppButton
     case problemReportAppLogsButton
     case problemReportSendButton
+    case relayStatusCollapseButton
+    case settingsDoneButton
 
     // Cells
     case preferencesCell
@@ -43,10 +45,15 @@ public enum AccessibilityIdentifier: String {
     case ipOverrideCell
     case relayFilterOwnershipCell
     case relayFilterProviderCell
+    case wireGuardPortsCell
+    case wireGuardObfuscationCell
+    case udpOverTCPPortCell
+    case quantumResistantTunnelCell
 
     // Labels
     case headerDeviceNameLabel
     case connectionStatusLabel
+    case connectionPanelDetailLabel
 
     // Views
     case accountView
@@ -58,14 +65,17 @@ public enum AccessibilityIdentifier: String {
     case selectLocationView
     case selectLocationTableView
     case settingsTableView
+    case vpnSettingsTableView
     case tunnelControlView
     case problemReportView
     case problemReportSubmittedView
+    case settingsContainerView
 
     // Other UI elements
     case connectionPanelInAddressRow
     case connectionPanelOutAddressRow
     case customSwitch
+    case customWireGuardPortTextField
     case dnsContentBlockersHeaderView
     case loginTextField
     case selectLocationSearchTextField

ios/MullvadVPN/Coordinators/ApplicationCoordinator.swift

@@ -767,6 +767,7 @@ final class ApplicationCoordinator: Coordinator, Presenting, RootContainerViewCo
         )
 
         let navigationController = CustomNavigationController()
+        navigationController.view.accessibilityIdentifier = .settingsContainerView
 
         let configurationTester = ProxyConfigurationTester(transportProvider: configuredTransportProvider)
 

ios/MullvadVPN/View controllers/Preferences/PreferencesCellFactory.swift

@@ -84,6 +84,7 @@ final class PreferencesCellFactory: CellFactoryProtocol {
                 comment: ""
             )
 
+            cell.textField.accessibilityIdentifier = .customWireGuardPortTextField
             cell.accessibilityIdentifier = item.accessibilityIdentifier
             cell.applySubCellStyling()
 

ios/MullvadVPN/View controllers/Preferences/PreferencesDataSource.swift

@@ -432,6 +432,7 @@ final class PreferencesDataSource: UITableViewDiffableDataSource<
             comment: ""
         )
 
+        header.accessibilityIdentifier = .wireGuardPortsCell
         header.titleLabel.text = title
         header.accessibilityCustomActionName = title
         header.infoButtonHandler = { [weak self] in
@@ -474,6 +475,7 @@ final class PreferencesDataSource: UITableViewDiffableDataSource<
             comment: ""
         )
 
+        header.accessibilityIdentifier = .wireGuardObfuscationCell
         header.titleLabel.text = title
         header.accessibilityCustomActionName = title
         header.didCollapseHandler = { [weak self] header in
@@ -502,6 +504,7 @@ final class PreferencesDataSource: UITableViewDiffableDataSource<
             comment: ""
         )
 
+        header.accessibilityIdentifier = .udpOverTCPPortCell
         header.titleLabel.text = title
         header.accessibilityCustomActionName = title
         header.didCollapseHandler = { [weak self] header in
@@ -531,6 +534,7 @@ final class PreferencesDataSource: UITableViewDiffableDataSource<
             comment: ""
         )
 
+        header.accessibilityIdentifier = .quantumResistantTunnelCell
         header.titleLabel.text = title
         header.accessibilityCustomActionName = title
         header.didCollapseHandler = { [weak self] header in

ios/MullvadVPN/View controllers/Preferences/PreferencesViewController.swift

@@ -32,6 +32,7 @@ class PreferencesViewController: UITableViewController, PreferencesDataSourceDel
     override func viewDidLoad() {
         super.viewDidLoad()
 
+        tableView.accessibilityIdentifier = .vpnSettingsTableView
         tableView.backgroundColor = .secondaryColor
         tableView.separatorColor = .secondaryColor
         tableView.rowHeight = UITableView.automaticDimension

ios/MullvadVPN/View controllers/Settings/SettingsViewController.swift

@@ -45,14 +45,17 @@ class SettingsViewController: UITableViewController, SettingsDataSourceDelegate
             value: "Settings",
             comment: ""
         )
-        navigationItem.rightBarButtonItem = UIBarButtonItem(
+
+        let doneButton = UIBarButtonItem(
             systemItem: .done,
             primaryAction: UIAction(handler: { [weak self] _ in
                 guard let self else { return }
 
                 delegate?.settingsViewControllerDidFinish(self)
             })
         )
+        doneButton.accessibilityIdentifier = .settingsDoneButton
+        navigationItem.rightBarButtonItem = doneButton
 
         tableView.accessibilityIdentifier = .settingsTableView
         tableView.backgroundColor = .secondaryColor

ios/MullvadVPN/View controllers/Tunnel/ConnectionPanelView.swift

@@ -29,6 +29,7 @@ class ConnectionPanelView: UIView {
 
     var connectedRelayName = "" {
         didSet {
+            collapseButton.accessibilityIdentifier = .relayStatusCollapseButton
             collapseButton.setTitle(connectedRelayName, for: .normal)
             collapseButton.accessibilityLabel = NSLocalizedString(
                 "RELAY_ACCESSIBILITY_LABEL",
@@ -185,6 +186,7 @@ class ConnectionPanelAddressRow: UIView {
 
     private let detailTextLabel: UILabel = {
         let detailTextLabel = UILabel()
+        detailTextLabel.accessibilityIdentifier = .connectionPanelDetailLabel
         detailTextLabel.font = .systemFont(ofSize: 17)
         detailTextLabel.textColor = .white
         detailTextLabel.translatesAutoresizingMaskIntoConstraints = false

ios/MullvadVPNUITests/Info.plist

@@ -20,6 +20,8 @@
 	<string>$(IOS_DEVICE_PIN_CODE)</string>
 	<key>NoTimeAccountNumber</key>
 	<string>$(NO_TIME_ACCOUNT_NUMBER)</string>
+	<key>ShouldBeReachableDomain</key>
+	<string>$(SHOULD_BE_REACHABLE_DOMAIN)</string>
 	<key>TestDeviceIdentifier</key>
 	<string>$(TEST_DEVICE_IDENTIFIER_UUID</string>
 </dict>

ios/MullvadVPNUITests/Networking/FirewallAPIClient.swift

@@ -34,6 +34,7 @@ class FirewallAPIClient {
             "label": sessionIdentifier,
             "from": firewallRule.fromIPAddress,
             "to": firewallRule.toIPAddress,
+            "protocols": firewallRule.protocolsAsStringArray(),
         ]
 
         var requestError: Error?
@@ -80,7 +81,6 @@ class FirewallAPIClient {
 
         var request = URLRequest(url: removeRulesURL)
         request.httpMethod = "DELETE"
-        request.setValue("application/json", forHTTPHeaderField: "Content-Type")
 
         var requestResponse: URLResponse?
         var requestError: Error?

ios/MullvadVPNUITests/Networking/FirewallRule.swift

@@ -30,14 +30,28 @@ struct FirewallRule {
         self.protocols = protocols
     }
 
+    public func protocolsAsStringArray() -> [String] {
+        return protocols.map { $0.rawValue }
+    }
+
     /// Make a firewall rule blocking API access for the current device under test
     public static func makeBlockAPIAccessFirewallRule() throws -> FirewallRule {
         let deviceIPAddress = try Networking.getIPAddress()
         let apiIPAddress = try MullvadAPIWrapper.getAPIIPAddress()
         return FirewallRule(
             fromIPAddress: deviceIPAddress,
             toIPAddress: apiIPAddress,
-            protocols: [NetworkingProtocol.TCP]
+            protocols: [.TCP]
+        )
+    }
+
+    public static func makeBlockUDPTrafficRule(toIPAddress: String) throws -> FirewallRule {
+        let deviceIPAddress = try Networking.getIPAddress()
+
+        return FirewallRule(
+            fromIPAddress: deviceIPAddress,
+            toIPAddress: toIPAddress,
+            protocols: [.UDP]
         )
     }
 }

ios/MullvadVPNUITests/Networking/Networking.swift

@@ -63,24 +63,24 @@ class Networking {
         throw NetworkingError.internalError(reason: "Failed to determine device's IP address")
     }
 
-    private static func getAdServingDomainURL() -> URL? {
-        guard let adServingDomain = Bundle(for: BaseUITestCase.self)
-            .infoDictionary?["AdServingDomain"] as? String,
-            let adServingDomainURL = URL(string: adServingDomain) else {
-            XCTFail("Ad serving domain not configured")
-            return nil
+    /// Get configured ad serving domain
+    private static func getAdServingDomain() throws -> String {
+        guard let adServingDomain = Bundle(for: Networking.self)
+            .infoDictionary?["AdServingDomain"] as? String else {
+            throw NetworkingError.notConfiguredError
         }
 
-        return adServingDomainURL
+        return adServingDomain
     }
 
-    private static func getAdServingDomain() throws -> String {
-        guard let adServingDomain = Bundle(for: BaseUITestCase.self)
-            .infoDictionary?["AdServingDomain"] as? String else {
+    /// Get configured domain to use for Internet connectivity checks
+    private static func getAlwaysReachableDomain() throws -> String {
+        guard let shouldBeReachableDomain = Bundle(for: Networking.self)
+            .infoDictionary?["ShouldBeReachableDomain"] as? String else {
             throw NetworkingError.notConfiguredError
         }
 
-        return adServingDomain
+        return shouldBeReachableDomain
     }
 
     /// Check whether host and port is reachable by attempting to connect a socket
@@ -134,6 +134,16 @@ class Networking {
         XCTAssertFalse(try canConnectSocket(host: apiIPAddress, port: apiPort))
     }
 
+    /// Verify that the device has Internet connectivity
+    public static func verifyCanAccessInternet() throws {
+        XCTAssertTrue(try canConnectSocket(host: getAlwaysReachableDomain(), port: "80"))
+    }
+
+    /// Verify that the device does not have Internet connectivity
+    public static func verifyCannotAccessInternet() throws {
+        XCTAssertFalse(try canConnectSocket(host: getAlwaysReachableDomain(), port: "80"))
+    }
+
     /// Verify that an ad serving domain is reachable by making sure a connection can be established on port 80
     public static func verifyCanReachAdServingDomain() throws {
         XCTAssertTrue(try Self.canConnectSocket(host: try Self.getAdServingDomain(), port: "80"))

ios/MullvadVPNUITests/Pages/Page.swift

@@ -31,6 +31,11 @@ class Page {
         return self
     }
 
+    @discardableResult func dismissKeyboard() -> Self {
+        self.enterText("\n")
+        return self
+    }
+
     /// Fast swipe down action to dismiss a modal view. Will swipe on the middle of the screen.
     @discardableResult func swipeDownToDismissModal() -> Self {
         app.swipeDown(velocity: .fast)

ios/MullvadVPNUITests/Pages/SelectLocationPage.swift

@@ -21,7 +21,7 @@ class SelectLocationPage: Page {
         return self
     }
 
-    @discardableResult func tapLocationCellExpandButton(withName name: String) -> Self {
+    @discardableResult func tapLocationCellExpandCollapseButton(withName name: String) -> Self {
         let table = app.tables[AccessibilityIdentifier.selectLocationTableView]
         let matchingCells = table.cells.containing(.any, identifier: name)
         let buttons = matchingCells.buttons

ios/MullvadVPNUITests/Pages/SettingsPage.swift

@@ -13,7 +13,15 @@ class SettingsPage: Page {
     @discardableResult override init(_ app: XCUIApplication) {
         super.init(app)
 
-        self.pageAccessibilityIdentifier = .settingsTableView
+        self.pageAccessibilityIdentifier = .settingsContainerView
+        waitForPageToBeShown()
+    }
+
+    @discardableResult func tapDoneButton() -> Self {
+        app.buttons[AccessibilityIdentifier.settingsDoneButton]
+            .tap()
+
+        return self
     }
 
     @discardableResult func tapVPNSettingsCell() -> Self {