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

.github/workflows/CI-main.yml

@@ -121,3 +121,13 @@ 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-for-simulator.yml@main
+    with:
+      build-version: ${{ needs.resolve-values.outputs.version_name }}
+      build-number: ${{ needs.resolve-values.outputs.version_number }}
+      xcode-version: ${{ needs.resolve-values.outputs.xcode_version }}
+    secrets: inherit

.github/workflows/build-for-simulator.yml

@@ -4,16 +4,149 @@ on:
   workflow_dispatch:
     inputs:
       build-version:
-        description: "Unused"
+        description: "Version Name Override - e.g. '2024.8.1'"
+        type: string
+      build-number:
+        description: "Version Number Override - e.g. '1021'"
+        type: string
+      xcode-version:
+        description: "Xcode Version Override - e.g. '15.2'"
+        type: string
+  workflow_call:
+    inputs:
+      build-version:
+        description: "Version Name Override - e.g. '2024.8.1'"
+        type: string
+      build-number:
+        description: "Version Number Override - e.g. '1021'"
+        type: string
+      xcode-version:
+        description: "Xcode Version Override - e.g. '15.2'"
+        type: string
+env:
+  XCODE_VERSION: ${{ inputs.xcode-version }}
 
 jobs:
   build:
     name: Build
-    runs-on: macos-14
+    runs-on: macos-15
+    env:
+      MINT_PATH: .mint/lib
+      MINT_LINK_PATH: .mint/bin
 
     steps:
+      - name: Log inputs to job summary
+        run: |
+          echo "<details><summary>Build Workflow Inputs</summary>" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo '```json' >> $GITHUB_STEP_SUMMARY
+          echo '${{ toJson(inputs) }}' >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          echo "</details>" >> $GITHUB_STEP_SUMMARY
+
       - name: Check out repo
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
         with:
           fetch-depth: 0
           filter: tree:0
+
+      - name: Calculate version
+        if: ${{ inputs.build-number == '' || inputs.build-version == '' }}
+        uses: bitwarden/ios/.github/actions/dispatch-and-download@main
+        id: dispatch-version
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          owner: bitwarden
+          repo: ios
+          ref: main
+          workflow: _version.yml
+          workflow_inputs: '{"base_version_number": "${{ inputs.base_version_number }}", "version_name": "${{ inputs.build-version }}", "version_number": "${{ inputs.build-number }}", "patch_version": "${{ inputs.patch_version }}"}'
+
+      - name: Read version info
+        id: version_info
+        run: |
+          # test if dispatch-version was skipped. In that case, creates the same .json file expected by the Upload artifact step
+          if [ ! -f version-info/version_info.json ]; then
+            echo "::warning::version-version.json not found, was the previous step skipped? Creating a new file"
+            json='{
+              "version_number": "${{ inputs.build-number }}",
+              "version_name": "${{ inputs.build-version }}"
+            }'
+
+            # file will be used by the upload step
+            mkdir version-info
+            echo "$json" > version-info/version_info.json
+          else
+              echo "::notice::version-version.json found!"
+          fi
+
+          content=$(cat version-info/version_info.json)
+          echo "version_name=$(echo $content | jq -r .version_name)" >> $GITHUB_OUTPUT
+          echo "version_number=$(echo $content | jq -r .version_number)" >> $GITHUB_OUTPUT
+
+      - name: Upload version info artifact
+        if: ${{ inputs.upload_version_info }}
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+        with:
+          name: version-info
+          path: version-info/version_info.json
+
+      - name: Read default Xcode version
+        run: |
+          echo "DEFAULT_XCODE_VERSION=$(cat .xcode-version | tr -d '\n')" >> "$GITHUB_ENV"
+
+      - name: Set Xcode version
+        uses: maxim-lobanov/setup-xcode@60606e260d2fc5762a71e64e74b2174e8ea3c8bd # v1.6.0
+        with:
+          xcode-version: ${{ env.XCODE_VERSION || env.DEFAULT_XCODE_VERSION }}
+
+      - name: Cache Mint packages
+        id: mint-cache
+        uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2
+        with:
+          path: .mint
+          key: ${{ runner.os }}-mint-${{ hashFiles('**/Mintfile') }}
+          restore-keys: |
+            ${{ runner.os }}-mint-
+
+      - name: Configure Ruby
+        uses: ruby/setup-ruby@a2bbe5b1b236842c1cb7dd11e8e3b51e0a616acc # v1.202.0
+        with:
+          bundler-cache: true
+
+      - name: Install Mint
+        run: |
+          brew update
+          brew install mint
+
+      - name: Install Mint packages
+        if: steps.mint-cache.outputs.cache-hit != 'true'
+        run: |
+          mint bootstrap
+
+      - name: Update build version and number
+        run: |
+          yq -i '.settings.MARKETING_VERSION = "${{ steps.version_info.outputs.version_name }}"' 'project.yml'
+          yq -i '.settings.CURRENT_PROJECT_VERSION = "${{ steps.version_info.outputs.version_number }}"' 'project.yml'
+
+      - name: Update CI build info
+        run: |
+          ./Scripts/update_app_ci_build_info.sh ${{ github.run_id }} ${{ github.run_number }} ${{ github.run_attempt }} "Simulator Build"
+
+      - name: Build iOS app
+        run: |
+          ./Scripts/build-sim.sh
+
+      - name: Prepare APP files for upload to GitHub
+        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
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+        with:
+          name: Bitwarden iOS-Simulator ${{ 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

Scripts/build-sim.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+#
+# Builds the beta Bitwarden iOS app in Debug mode for the iOS Simulator, for ease of automated testing.
+#
+# Usage:
+#
+#   $ ./build-sim.sh
+
+set -euo pipefail
+
+BUILD_DIR="build"
+DERIVED_DATA_PATH="${BUILD_DIR}/DerivedData"
+
+echo "🧱 Building in $(pwd)"
+echo "🧱 Derived Data path ${DERIVED_DATA_PATH}"
+echo ""
+
+echo "🌱 Generating Xcode project"
+mint run xcodegen
+
+mkdir -p "${BUILD_DIR}"
+
+echo "🔨 Performing Xcode build"
+xcrun xcodebuild \
+  -project Bitwarden.xcodeproj \
+  -scheme Bitwarden \
+  -configuration Debug \
+  -destination "platform=iOS Simulator,OS=18.1,name=iPhone 16" \
+  -derivedDataPath "${DERIVED_DATA_PATH}" \
+  | xcbeautify --renderer github-actions
+
+echo "🎉 Build complete"

Scripts/build.sh

@@ -8,18 +8,17 @@
 
 set -euo pipefail
 
-bold=$(tput -T ansi bold)
-normal=$(tput -T ansi sgr0)
-
 BUILD_DIR="build"
 
 ARCHIVE_PATH="${BUILD_DIR}/Bitwarden.xcarchive"
 EXPORT_PATH="${BUILD_DIR}/Bitwarden"
 
 echo "🧱 Building in $(pwd)"
+echo "🧱 Archive path ${ARCHIVE_PATH}"
+echo "🧱 Export path ${EXPORT_PATH}"
 echo ""
 
-echo "🌱 Generating xcode project"
+echo "🌱 Generating Xcode project"
 mint run xcodegen
 
 mkdir -p "${BUILD_DIR}"