[PM-9375] Build a debug-for-simulator version of the app for easier automated testing

.github/workflows/CI-main.yml

@@ -121,3 +121,16 @@ jobs:
       upload_version_info: false
       compiler-flags: "DEBUG_MENU"
     secrets: inherit
+
+  build-simulator:
+    name: Build Simulator App
+    needs: resolve-values
+    uses: bitwarden/ios/.github/workflows/build.yml@main
+    with:
+      build-variant: Simulator
+      build-version: ${{ needs.resolve-values.outputs.version_name }}
+      build-number: ${{ needs.resolve-values.outputs.version_number }}
+      xcode-version: ${{ needs.resolve-values.outputs.xcode_version }}
+      distribute: ${{ fromJSON(needs.resolve-values.outputs.distribute_to_testflight) }}
+      upload_version_info: false
+    secrets: inherit

.github/workflows/build.yml

@@ -11,6 +11,7 @@ on:
         options:
           - Beta
           - Production
+          - Simulator
       build-version:
         description: "Version Name Override - e.g. '2024.8.1'"
         type: string
@@ -133,9 +134,11 @@ jobs:
           name: version-info
           path: version-info/version_info.json
 
-      - name: Read default Xcode version
+      - name: Read default Xcode version and simulator configuration
         run: |
           echo "DEFAULT_XCODE_VERSION=$(cat .xcode-version | tr -d '\n')" >> "$GITHUB_ENV"
+          echo "DEFAULT_SIMULATOR_NAME=$(cat .test-simulator-device-name | tr -d '\n')" >> "$GITHUB_ENV"
+          echo "DEFAULT_SIMULATOR_VERSION=$(cat .test-simulator-ios-version | tr -d '\n')" >> "$GITHUB_ENV"
 
       - name: Set Xcode version
         uses: maxim-lobanov/setup-xcode@60606e260d2fc5762a71e64e74b2174e8ea3c8bd # v1.6.0
@@ -152,11 +155,13 @@ jobs:
             ${{ runner.os }}-mint-
 
       - name: Log in to Azure
+        if: env.BUILD_VARIANT != 'Simulator'
         uses: Azure/login@cb79c773a3cfa27f31f25eb3f677781210c9ce3d # v1.6.1
         with:
           creds: ${{ secrets.AZURE_KV_CI_SERVICE_PRINCIPAL }}
 
       - name: Retrieve secrets
+        if: env.BUILD_VARIANT != 'Simulator'
         uses: bitwarden/gh-actions/get-keyvault-secrets@main
         with:
           keyvault: "bitwarden-ci"
@@ -259,12 +264,14 @@ jobs:
           plutil -replace BUNDLE_ID -string com.8bit.bitwarden.beta.watchkitapp BitwardenWatchApp/$TARGET_FILE
 
       - name: Retrieve certificates
+        if: env.BUILD_VARIANT != 'Simulator'
         run: |
           mkdir -p $HOME/certificates
           az keyvault secret show --id https://bitwarden-ci.vault.azure.net/certificates/ios-distribution |
             jq -r .value | base64 -d > $HOME/certificates/ios-distribution.p12
 
       - name: Download Fastlane credentials
+        if: env.BUILD_VARIANT != 'Simulator'
         env:
           ACCOUNT_NAME: bitwardenci
           CONTAINER_NAME: mobile
@@ -275,6 +282,7 @@ jobs:
             --file $HOME/secrets/$FILE --output none
 
       - name: Configure Keychain Access
+        if: env.BUILD_VARIANT != 'Simulator'
         env:
           KEYCHAIN_PASSWORD: ${{ secrets.IOS_KEYCHAIN_PASSWORD }}
         run: |
@@ -288,6 +296,7 @@ jobs:
           security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k $KEYCHAIN_PASSWORD build.keychain
 
       - name: Configure provisioning profiles
+        if: env.BUILD_VARIANT != 'Simulator'
         run: |
           ./Scripts/configure_provisioning_profiles.sh ${{ env.BUILD_VARIANT }}
 
@@ -302,6 +311,7 @@ jobs:
           echo 'app_identifier "com.8bit.bitwarden.beta"' > fastlane/Appfile
 
       - name: Update APNS entitlements
+        if: env.BUILD_VARIANT != 'Simulator'
         run: |
           plutil -replace aps-environment -string production Bitwarden/Application/Support/Bitwarden.entitlements
 
@@ -310,17 +320,26 @@ jobs:
         with:
           bundler-cache: true
 
-      - name: Install Fastlane, Mint
+      - name: Update homebrew
         run: |
           brew update
-          brew install fastlane mint
+
+      - name: Install Fastlane
+        if: env.BUILD_VARIANT != 'Simulator'
+        run: |
+          brew install fastlane
+
+      - name: Install Mint
+        run: |
+          brew install mint
 
       - name: Install Mint packages
         if: steps.mint-cache.outputs.cache-hit != 'true'
         run: |
           mint bootstrap
 
       - name: Select variant
+        if: env.BUILD_VARIANT != 'Simulator'
         run: |
           ./Scripts/select_variant.sh ${{ env.BUILD_VARIANT }} "${{ inputs.compiler-flags }}"
 
@@ -335,29 +354,49 @@ jobs:
 
       - name: Build iOS app
         run: |
-          ./Scripts/build.sh
+          ./Scripts/build.sh ${{ env.BUILD_VARIANT }} "platform=iOS Simulator,name=${{ env.SIMULATOR_NAME || env.DEFAULT_SIMULATOR_NAME }},OS=${{ env.SIMULATOR_VERSION || env.DEFAULT_SIMULATOR_VERSION }}"
+
+      - name: Prepare APP files for upload to GitHub
+        if: env.BUILD_VARIANT == 'Simulator'
+        run: |
+          find . -name "*.app"
+          mkdir -p export
+          cp -r build/DerivedData/Build/Products/Debug-iphonesimulator/Bitwarden.app export
+          cp -r build/DerivedData/Build/Products/Debug-watchsimulator/BitwardenWatchApp.app export
+
+      - name: Upload APP files
+        if: env.BUILD_VARIANT == 'Simulator'
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+        with:
+          name: Bitwarden iOS ${{ steps.version_info.outputs.version_name }} (${{ steps.version_info.outputs.version_number }}) ${{ env.BUILD_VARIANT }} ${{ env.XCODE_VERSION || env.DEFAULT_XCODE_VERSION }}
+          path: export
+          if-no-files-found: error
 
       - name: Prepare IPA & dSYM files for upload to GitHub
+        if: env.BUILD_VARIANT != 'Simulator'
         run: |
           mkdir -p export/dSYMs
           cp build/Bitwarden/Bitwarden.ipa export
           cp -rv build/Bitwarden.xcarchive/dSYMs/*.dSYM export/dSYMs
 
       - name: Upload IPA & dSYM files
+        if: env.BUILD_VARIANT != 'Simulator'
         uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
         with:
           name: Bitwarden iOS ${{ steps.version_info.outputs.version_name }} (${{ steps.version_info.outputs.version_number }}) ${{ env.BUILD_VARIANT }} ${{ env.XCODE_VERSION || env.DEFAULT_XCODE_VERSION }}
           path: export
           if-no-files-found: error
 
       - name: Set up private auth key
+        if: env.BUILD_VARIANT != 'Simulator'
         run: |
           mkdir ~/private_keys
           cat << EOF > ~/private_keys/AuthKey_J46C83CB96.p8
           ${{ secrets.APP_STORE_CONNECT_AUTH_KEY }}
           EOF
 
       - name: Validate app with App Store Connect
+        if: env.BUILD_VARIANT != 'Simulator'
         run: |
           xcrun altool --validate-app \
             --type ios \

Scripts/build.sh

@@ -1,43 +1,73 @@
 #!/usr/bin/env bash
 #
-# Builds the beta Bitwarden iOS app, and outputs an IPA file that can be uploaded to TestFlight.
+# Builds the Bitwarden iOS app.
+# If run in Simulator mode, produces an APP file for the iOS Simulator for ease of automated testing.
+# If run in Release or Beta mode, produces an IPA file that can be uploaded to Testflight.
 #
 # Usage:
 #
-#   $ ./build.sh
+#   $ ./build.sh [mode] [destination]
 
 set -euo pipefail
 
 bold=$(tput -T ansi bold)
 normal=$(tput -T ansi sgr0)
 
-BUILD_DIR="build"
+if [ $# -lt 1 ]; then
+  echo >&2 "Called without necessary arguments: ${bold}mode${normal}. ${bold}destination${normal}"
+  echo >&2 "For example: \`Scripts/build.sh Simulator \"platform=iOS Simulator,OS=18.1,name=iPhone 16 Pro\""
+  exit 1
+fi
+
+MODE=$1
+DESTINATION=$2
 
+BUILD_DIR="build"
+DERIVED_DATA_PATH="${BUILD_DIR}/DerivedData"
 ARCHIVE_PATH="${BUILD_DIR}/Bitwarden.xcarchive"
 EXPORT_PATH="${BUILD_DIR}/Bitwarden"
 
-echo "🧱 Building in $(pwd)"
+echo "🧱 Building in ${bold}$(pwd)${normal}"
+echo "🧱 Using build mode of ${bold}${MODE}${normal}."
+echo "🧱 Derived Data path ${bold}${DERIVED_DATA_PATH}${normal}"
+echo "🧱 Archive path ${bold}${ARCHIVE_PATH}${normal}"
+echo "🧱 Export path ${bold}${EXPORT_PATH}${normal}"
 echo ""
 
-echo "🌱 Generating xcode project"
+echo "🌱 Generating Xcode project"
 mint run xcodegen
+echo ""
 
 mkdir -p "${BUILD_DIR}"
 
-echo "🔨 Performing Xcode archive"
-xcrun xcodebuild archive \
-  -project Bitwarden.xcodeproj \
-  -scheme Bitwarden \
-  -configuration Release \
-  -archivePath "${ARCHIVE_PATH}" \
-  | xcbeautify --renderer github-actions
-echo ""
+if [[ "$MODE" == "Simulator" ]]; then
+  echo "🔨 Performing Xcode build"
+  xcrun xcodebuild \
+    -project Bitwarden.xcodeproj \
+    -scheme Bitwarden \
+    -configuration Debug \
+    -destination "${DESTINATION}" \
+    -derivedDataPath "${DERIVED_DATA_PATH}" \
+    | xcbeautify --renderer github-actions
+else
+  echo "📦 Performing Xcode archive"
+  xcrun xcodebuild archive \
+    -project Bitwarden.xcodeproj \
+    -scheme Bitwarden \
+    -configuration Release \
+    -derivedDataPath "${DERIVED_DATA_PATH}" \
+    -archivePath "${ARCHIVE_PATH}" \
+    | xcbeautify --renderer github-actions
+
+  echo "🚚 Performing Xcode archive export"
+  xcrun xcodebuild -exportArchive \
+    -archivePath "${ARCHIVE_PATH}" \
+    -derivedDataPath "${DERIVED_DATA_PATH}" \
+    -exportPath "${EXPORT_PATH}" \
+    -exportOptionsPlist "Configs/export_options.plist" \
+    | xcbeautify --renderer github-actions
 
-echo "📦 Performing Xcode archive export"
-xcrun xcodebuild -exportArchive \
-  -archivePath "${ARCHIVE_PATH}" \
-  -exportPath "${EXPORT_PATH}" \
-  -exportOptionsPlist "Configs/export_options.plist" \
-  | xcbeautify --renderer github-actions
+fi
 
+echo ""
 echo "🎉 Build complete"