PIA-809: Update iOS application

.github/workflows/pull_request.yml

@@ -0,0 +1,46 @@
+name: pia_vpn_ios
+on:
+  pull_request:
+  workflow_dispatch:
+concurrency:
+  group: "${{ github.ref }}"
+  cancel-in-progress: true
+jobs:
+  build:
+    runs-on: macos-13
+    env:
+      TEST_RUNNER_PIA_TEST_USER: ${{ secrets.PIA_ACCOUNT_USERNAME}}
+      TEST_RUNNER_PIA_TEST_PASSWORD: ${{ secrets.PIA_ACCOUNT_PASSWORD }}
+
+    steps:
+    - name: Setup Git credentials
+      run: |
+        git config --global url."https://${{ secrets.ORG_GITHUB_USERNAME }}:${{ secrets.ORG_GITHUB_TOKEN }}@github.com/".insteadOf "[email protected]:"
+
+    - uses: actions/checkout@v3
+
+    - name: Select XCode version
+      run: sudo xcode-select -s /Applications/Xcode_15.0.app
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+
+    - name: Install Fastlane
+      run: gem install fastlane
+
+    - name: Set credentials in fastlane env
+      run: echo "TEST_RUNNER_PIA_TEST_USER=${{ secrets.PIA_ACCOUNT_USERNAME}}"\n"TEST_RUNNER_PIA_TEST_PASSWORD=${{ secrets.PIA_ACCOUNT_PASSWORD }}" > fastlane/.env
+
+    - name: Check fastlane env
+      run: cat fastlane/.env
+
+    - name: Run e2e tests with fastlane
+      run: bundle exec fastlane e2e_tests
+      continue-on-error: true
+
+    - name: Run tests
+      run: bundle exec fastlane tests
+
+

.github/workflows/testflight_deploy.yml

@@ -0,0 +1,51 @@
+name: testflight_deploy
+on:
+  push:
+    branches: 
+      - master
+
+  workflow_dispatch:
+concurrency:
+  group: "${{ github.ref }}"
+  cancel-in-progress: true
+jobs:
+  build:
+    runs-on: macos-13
+    env:
+      CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
+      KEYCHAIN_NAME: ${{ secrets.KEYCHAIN_NAME }}
+      KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }}
+      APP_STORE_CONNECT_KEY_ID: ${{ secrets.APP_STORE_CONNECT_KEY_ID }}
+      APP_STORE_CONNECT_ISSUER_ID: ${{ secrets.APP_STORE_CONNECT_ISSUER_ID }}
+      APP_STORE_CONNECT_KEY: ${{ secrets.APP_STORE_CONNECT_KEY }}
+
+    steps:
+    - name: Setup Git credentials
+      run: |
+        git config --global url."https://${{ secrets.ORG_GITHUB_USERNAME }}:${{ secrets.ORG_GITHUB_TOKEN }}@github.com/".insteadOf "[email protected]:"
+
+    - uses: actions/checkout@v3
+
+    - name: Select XCode version
+      run: sudo xcode-select -s /Applications/Xcode_15.0.app
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+
+    - name: Install Fastlane
+      run: gem install fastlane
+
+    - name: Decode Certificates
+      run: echo "${{ secrets.IOS_CERTIFICATE }}" | base64 --decode > ./fastlane/Certificate.p12
+
+    - name: Run tests
+      run: bundle exec fastlane tests
+
+    - name: Set up certificates and profiles
+      run: bundle exec fastlane get_profiles > /dev/null 2>&1
+
+    - name: Upload version to TestFlight
+      run: bundle exec fastlane testflight_build
+

Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "fastlane"

PIA VPN.xcodeproj/xcshareddata/xcschemes/PIA VPN dev.xcscheme

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
    LastUpgradeVersion = "0930"
-   version = "1.3">
+   version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"
       buildImplicitDependencies = "YES">
@@ -54,7 +54,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "NO">
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
@@ -64,6 +64,24 @@
             ReferencedContainer = "container:PIA VPN.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
+      <EnvironmentVariables>
+         <EnvironmentVariable
+            key = "PIA_TEST_USER"
+            value = "xxx"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "PIA_TEST_PASSWORD"
+            value = "xxx"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+      </EnvironmentVariables>
+      <TestPlans>
+         <TestPlanReference
+            reference = "container:PIA-VPN_E2E_Tests/PIA-VPN-e2e-simulator.xctestplan"
+            default = "YES">
+         </TestPlanReference>
+      </TestPlans>
       <Testables>
          <TestableReference
             skipped = "NO">
@@ -76,12 +94,13 @@
             </BuildableReference>
          </TestableReference>
          <TestableReference
-            skipped = "NO">
+            skipped = "NO"
+            parallelizable = "YES">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "7EB8D11227CCF4C20030B060"
-               BuildableName = "PIA VPN UITests.xctest"
-               BlueprintName = "PIA VPN UITests"
+               BlueprintIdentifier = "69B70AAF2ACBF51C0072A09D"
+               BuildableName = "PIA-VPN_E2E_Tests.xctest"
+               BlueprintName = "PIA-VPN_E2E_Tests"
                ReferencedContainer = "container:PIA VPN.xcodeproj">
             </BuildableReference>
          </TestableReference>

PIA VPN.xcodeproj/xcshareddata/xcschemes/PIA VPN.xcscheme

@@ -48,6 +48,20 @@
                ReferencedContainer = "container:PIA VPN.xcodeproj">
             </BuildableReference>
          </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "NO"
+            buildForRunning = "NO"
+            buildForProfiling = "NO"
+            buildForArchiving = "NO"
+            buildForAnalyzing = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "7EB8D11227CCF4C20030B060"
+               BuildableName = "PIA VPN UITests.xctest"
+               BlueprintName = "PIA VPN UITests"
+               ReferencedContainer = "container:PIA VPN.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
       </BuildActionEntries>
    </BuildAction>
    <TestAction

PIA VPN.xcodeproj/xcshareddata/xcschemes/PIA-VPN_E2E_Tests.xcscheme

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1430"
+   version = "2.2">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "NO"
+            buildForProfiling = "NO"
+            buildForArchiving = "NO"
+            buildForAnalyzing = "NO">
+            <AutocreatedTestPlanReference>
+            </AutocreatedTestPlanReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO"
+            parallelizable = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "69B70AAF2ACBF51C0072A09D"
+               BuildableName = "PIA-VPN_E2E_Tests.xctest"
+               BlueprintName = "PIA-VPN_E2E_Tests"
+               ReferencedContainer = "container:PIA VPN.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <EnvironmentVariables>
+         <EnvironmentVariable
+            key = "PIA_TEST_USER"
+            value = "xxx"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "PIA_TEST_PASSWORD"
+            value = "xxx"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+      </EnvironmentVariables>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

PIA VPN/AccessibilityId.swift

@@ -0,0 +1,48 @@
+
+import Foundation
+
+public struct AccessibilityId {
+  public struct VPNPermission {
+    public static let screen = "id.vpnPermission.screen"
+    public static let submit = "id.vpnPermission.ok.button"
+  }
+
+  public struct Dashboard {
+    public static let connectionButton = "id.dashboard.connection.button"
+  }
+
+}
+
+
+/// This is the same struct `Accessibility` from `PIALibrary`
+/// It has been copied over to the VPN ios client app to
+/// facilitate e2e testing.
+/// In the future, we will move the Welcome and Login ViewControllers and storyboards from `PIALibrary` into vpn ios
+/// And this duplication will not be necessary
+public struct PIALibraryAccessibility {
+    public struct Id {
+        public struct Welcome {
+            public static let environment = "id.welcome.environment"
+        }
+        public struct Login {
+            public static let submit = "id.login.submit"
+            public static let submitNew = "id.login.submit.new"
+            public static let username = "id.login.username"
+            public static let password = "id.login.submit"
+            public struct Error {
+                public static let banner = "id.login.error.banner"
+            }
+        }
+
+        public struct Dashboard {
+            public static let menu = "id.dashboard.menu"
+        }
+        public struct Menu {
+            public static let logout = "id.menu.logout"
+        }
+        public struct Dialog {
+            public static let destructive = "id.dialog.destructive.button"
+        }
+    }
+}
+

PIA VPN/AppDelegate.swift

@@ -42,6 +42,7 @@ class AppDelegate: NSObject, UIApplicationDelegate {
 
     var window: UIWindow?
     private var hotspotHelper: PIAHotspotHelper!
+    private (set) var liveActivityManager: PIAConnectionLiveActivityManagerType?
 
     deinit {
         NotificationCenter.default.removeObserver(self)
@@ -55,12 +56,27 @@ class AppDelegate: NSObject, UIApplicationDelegate {
         application.shortcutItems = []
         hotspotHelper = PIAHotspotHelper()
         _ = hotspotHelper.configureHotspotHelper()
-
+
+        instantiateLiveActivityManagerIfNeeded()
         return true
     }
+
+    private func instantiateLiveActivityManagerIfNeeded() {
+        if #available(iOS 16.2, *) {
+            // Only instantiates the LiveActivities if the Feature Flag for it is enabled
+            guard AppPreferences.shared.showDynamicIslandLiveActivity else {
+                liveActivityManager = nil
+                return
+            }
+
+            liveActivityManager = PIAConnectionLiveActivityManager.shared
+        }
+    }
 
     func applicationWillTerminate(_ application: UIApplication) {
         Bootstrapper.shared.dispose()
+
+        liveActivityManager?.endLiveActivities()
     }
 
     // MARK: Orientations
@@ -200,6 +216,9 @@ class AppDelegate: NSObject, UIApplicationDelegate {
         application.applicationIconBadgeNumber = 0
         // Remove the Non compliant Wifi local notification as the app is in foreground now
         Macros.removeLocalNotification(NotificationCategory.nonCompliantWifi)
+
+        instantiateLiveActivityManagerIfNeeded()
+
     }
 
     private func refreshShortcutItems(in application: UIApplication) {

PIA VPN/AppPreferences.swift

@@ -104,6 +104,7 @@ class AppPreferences {
         static let showNewInitialScreen = "showNewInitialScreen"
         static let showLeakProtection = "showLeakProtection"
         static let showLeakProtectionNotifications = "showLeakProtectionNotifications"
+        static let showDynamicIslandLiveActivity = "showDynamicIslandLiveActivity"
 
         // Survey
         static let userInteractedWithSurvey = "userInteractedWithSurvey"
@@ -537,6 +538,15 @@ class AppPreferences {
             defaults.set(newValue, forKey: Entries.showLeakProtectionNotifications)
         }
     }
+
+    var showDynamicIslandLiveActivity: Bool {
+        get {
+            return defaults.bool(forKey: Entries.showDynamicIslandLiveActivity)
+        }
+        set {
+            defaults.set(newValue, forKey: Entries.showDynamicIslandLiveActivity)
+        }
+    }
 
     var checksDipExpirationRequest: Bool {
         get {