Build React Native iOS E2E IPA artifact

Assisted-By: devx/6c1e3ad5-96c8-4972-b087-da7ff7b195c3

Author: kieran-osgood-shopify

e2e/BITRISE.md

@@ -59,7 +59,12 @@ The non-secret E2E defaults are defined in `e2e/bitrise.yml` under `app.envs`. D
 | `E2E_BROWSERSTACK_TIMEOUT_SECONDS` | `1800` | BrowserStack build timeout. |
 | `E2E_BROWSERSTACK_POLL_SECONDS` | `30` | BrowserStack status polling interval. |
 | `E2E_IOS_EXPORT_METHOD` | `development` | Export method for the React Native iOS IPA. |
+| `E2E_IOS_BUNDLE_ID` | `com.shopify.checkoutkit.reactnativedemo` | Bundle identifier used for iOS archive and export signing. |
+| `E2E_IOS_DEVELOPMENT_TEAM` | `A7XGC83MZE` | Apple development team used for iOS archive signing. |
+| `E2E_IOS_CODE_SIGN_IDENTITY` | `Apple Development` | Code signing identity used for iOS archive and export signing. |
+| `E2E_IOS_PROVISIONING_PROFILE_SPECIFIER` | `bitrise-checkout-kit-e2e` | Provisioning profile specifier installed by Bitrise and passed to `xcodebuild`. |
 | `E2E_ANDROID_COMMAND_TIMEOUT_SECONDS` | `1800` | Per-command timeout for React Native Android artifact commands. |
+| `E2E_IOS_COMMAND_TIMEOUT_SECONDS` | `1800` | Per-command timeout for React Native iOS dependency, CocoaPods, archive, and export commands. |
 | `E2E_PACKAGE_COMMAND_TIMEOUT_SECONDS` | `300` | Per-command timeout for package-suite matrix and suite commands. |
 | `E2E_RUBY_INSTALL_TIMEOUT_SECONDS` | `1800` | Timeout for installing the exact repository Ruby version from `.ruby-version`. |
 
@@ -87,7 +92,11 @@ Configure the Bitrise app to run the `e2e` pipeline for pull requests once the s
 
 ## Code signing
 
-React Native iOS IPA generation is added in a later phase and will require Bitrise iOS code signing setup for the sample app.
+React Native iOS IPA generation uses Bitrise's certificate and profile installer before running `xcodebuild archive` and `xcodebuild -exportArchive`.
+
+The React Native iOS artifact workflow overrides the default Linux stack and runs on `osx-xcode-26.0.x-edge` with `g2.mac.4large`, because it requires Xcode and iOS signing. Its cache keys are prefixed with `rn-ios-macos-` so macOS caches cannot restore Linux-built dependencies.
+
+Upload the required signing certificate and provisioning profile for the React Native sample app to the Bitrise app before running the iOS artifact workflow. The default provisioning profile specifier is `bitrise-checkout-kit-e2e`; update `E2E_IOS_PROVISIONING_PROFILE_SPECIFIER` in `e2e/bitrise.yml` if the Bitrise-installed profile uses a different name.
 
 ## Caching
 

e2e/bitrise.yml

@@ -15,7 +15,12 @@ app:
     - E2E_BROWSERSTACK_TIMEOUT_SECONDS: "1800"
     - E2E_BROWSERSTACK_POLL_SECONDS: "30"
     - E2E_IOS_EXPORT_METHOD: development
+    - E2E_IOS_BUNDLE_ID: com.shopify.checkoutkit.reactnativedemo
+    - E2E_IOS_DEVELOPMENT_TEAM: A7XGC83MZE
+    - E2E_IOS_CODE_SIGN_IDENTITY: Apple Development
+    - E2E_IOS_PROVISIONING_PROFILE_SPECIFIER: bitrise-checkout-kit-e2e
     - E2E_ANDROID_COMMAND_TIMEOUT_SECONDS: "1800"
+    - E2E_IOS_COMMAND_TIMEOUT_SECONDS: "1800"
     - E2E_PACKAGE_COMMAND_TIMEOUT_SECONDS: "300"
     - E2E_RUBY_INSTALL_TIMEOUT_SECONDS: "1800"
 
@@ -62,28 +67,121 @@ workflows:
                 $BITRISE_DEPLOY_DIR/e2e-matrix.json:E2E_MATRIX_JSON
 
   e2e-build-react-native-ios:
+    meta:
+      bitrise.io:
+        stack: osx-xcode-26.0.x-edge
+        machine_type_id: g2.mac.4large
     steps:
       - git-clone@8: {}
+      - certificate-and-profile-installer@1: {}
       - restore-cache@1:
           inputs:
             - key: |-
-                rn-ios-{{ checksum "platforms/react-native/pnpm-lock.yaml" }}-{{ checksum "platforms/react-native/sample/ios/Podfile.lock" }}
+                rn-ios-macos-{{ checksum "platforms/react-native/pnpm-lock.yaml" }}-{{ checksum "platforms/react-native/sample/ios/Podfile.lock" }}
       - script@1:
-          title: Create React Native iOS artifact placeholder
+          title: Build React Native iOS IPA artifact
           inputs:
             - content: |-
                 set -euo pipefail
+                source e2e/scripts/bitrise_ci_helpers
+                e2e_prepare_ruby
+                e2e_log "Enabling Corepack"
+                corepack enable
+                e2e_log "Checking storefront configuration secrets"
+                : "${STOREFRONT_DOMAIN:?STOREFRONT_DOMAIN is required. Check https://app.bitrise.io/app/f51f9054-053e-40f1-81e9-ae727567ae76/workflow_editor#!/secrets and enable Expose for pull requests.}"
+                : "${STOREFRONT_ACCESS_TOKEN:?STOREFRONT_ACCESS_TOKEN is required. Check https://app.bitrise.io/app/f51f9054-053e-40f1-81e9-ae727567ae76/workflow_editor#!/secrets and enable Expose for pull requests.}"
+                e2e_log "Configuring storefront environment"
+                ./scripts/setup_storefront_env --skip-optional-prompts
+                e2e_log "Installing React Native dependencies"
+                cd platforms/react-native
+                e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" pnpm install --frozen-lockfile
+                cd sample
+                e2e_log "Installing iOS Ruby dependencies"
+                e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" bundle install
+                cd ios
+                e2e_log "Installing CocoaPods dependencies"
+                e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" bundle exec pod install --deployment --repo-update
                 mkdir -p "$BITRISE_DEPLOY_DIR/e2e"
-                echo "Phase 2 placeholder for React Native iOS IPA" > "$BITRISE_DEPLOY_DIR/e2e/react-native-ios.ipa"
-                envman add --key E2E_REACT_NATIVE_IOS_APP_PATH --value "$BITRISE_DEPLOY_DIR/e2e/react-native-ios.ipa"
+                archive_path="$BITRISE_DEPLOY_DIR/e2e/CheckoutKitReactNativeDemo.xcarchive"
+                export_path="$BITRISE_DEPLOY_DIR/e2e/react-native-ios-export"
+                export_options="$BITRISE_DEPLOY_DIR/e2e/ExportOptions.plist"
+                export_method="${E2E_IOS_EXPORT_METHOD:-development}"
+                ios_bundle_id="${E2E_IOS_BUNDLE_ID:-com.shopify.checkoutkit.reactnativedemo}"
+                ios_development_team="${E2E_IOS_DEVELOPMENT_TEAM:-A7XGC83MZE}"
+                ios_code_sign_identity="${E2E_IOS_CODE_SIGN_IDENTITY:-Apple Development}"
+                ios_profile_specifier="${E2E_IOS_PROVISIONING_PROFILE_SPECIFIER:-bitrise-checkout-kit-e2e}"
+                cat > "$export_options" <<PLIST
+                <?xml version="1.0" encoding="UTF-8"?>
+                <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+                <plist version="1.0">
+                <dict>
+                  <key>method</key>
+                  <string>$export_method</string>
+                  <key>signingStyle</key>
+                  <string>manual</string>
+                  <key>teamID</key>
+                  <string>$ios_development_team</string>
+                  <key>signingCertificate</key>
+                  <string>$ios_code_sign_identity</string>
+                  <key>provisioningProfiles</key>
+                  <dict>
+                    <key>$ios_bundle_id</key>
+                    <string>$ios_profile_specifier</string>
+                  </dict>
+                  <key>stripSwiftSymbols</key>
+                  <true/>
+                  <key>compileBitcode</key>
+                  <false/>
+                </dict>
+                </plist>
+                PLIST
+                e2e_log "Archiving React Native iOS app"
+                if ! e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" xcodebuild archive \
+                  -workspace CheckoutKitReactNativeDemo.xcworkspace \
+                  -scheme CheckoutKitReactNativeDemo \
+                  -configuration Release \
+                  -sdk iphoneos \
+                  -destination generic/platform=iOS \
+                  -archivePath "$archive_path" \
+                  -skipPackagePluginValidation \
+                  "CODE_SIGN_STYLE=Manual" \
+                  "DEVELOPMENT_TEAM=$ios_development_team" \
+                  "CODE_SIGN_IDENTITY=$ios_code_sign_identity" \
+                  "PROVISIONING_PROFILE_SPECIFIER=$ios_profile_specifier"; then
+                  e2e_log "iOS archive failed"
+                  echo "Check Bitrise code signing assets for bundle id ${ios_bundle_id} and team ${ios_development_team}." >&2
+                  echo "Expected provisioning profile specifier: ${ios_profile_specifier}." >&2
+                  echo "Upload an Apple Development certificate and matching development provisioning profile at https://app.bitrise.io/app/f51f9054-053e-40f1-81e9-ae727567ae76/workflow_editor#!/code_signing." >&2
+                  echo "The e2e-build-react-native-ios workflow runs certificate-and-profile-installer before xcodebuild." >&2
+                  exit 1
+                fi
+                e2e_log "Exporting React Native iOS IPA"
+                if ! e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" xcodebuild -exportArchive \
+                  -archivePath "$archive_path" \
+                  -exportPath "$export_path" \
+                  -exportOptionsPlist "$export_options"; then
+                  e2e_log "iOS IPA export failed"
+                  echo "Check that the installed provisioning profile matches export method ${export_method}." >&2
+                  echo "Export options plist: ${export_options}" >&2
+                  exit 1
+                fi
+                ios_ipa="$(find "$export_path" -name "*.ipa" -print -quit)"
+                if [ -z "$ios_ipa" ] || [ ! -f "$ios_ipa" ]; then
+                  e2e_log "iOS IPA export did not create an IPA"
+                  find "$export_path" -maxdepth 3 -print >&2 || true
+                  exit 1
+                fi
+                e2e_log "Publishing iOS IPA path"
+                envman add --key E2E_REACT_NATIVE_IOS_APP_PATH --value "$ios_ipa"
       - deploy-to-bitrise-io@2:
+          is_always_run: false
           inputs:
             - pipeline_intermediate_files: |-
                 $E2E_REACT_NATIVE_IOS_APP_PATH:E2E_REACT_NATIVE_IOS_APP_PATH
       - save-cache@1:
           inputs:
             - key: |-
-                rn-ios-{{ checksum "platforms/react-native/pnpm-lock.yaml" }}-{{ checksum "platforms/react-native/sample/ios/Podfile.lock" }}
+                rn-ios-macos-{{ checksum "platforms/react-native/pnpm-lock.yaml" }}-{{ checksum "platforms/react-native/sample/ios/Podfile.lock" }}
             - paths: |-
                 platforms/react-native/node_modules
                 platforms/react-native/sample/ios/Pods

e2e/test/bitrise_pipeline_test.rb

@@ -107,6 +107,10 @@ def test_bitrise_config_defines_non_secret_e2e_defaults
     assert_equal "1800", values.fetch("E2E_BROWSERSTACK_TIMEOUT_SECONDS")
     assert_equal "30", values.fetch("E2E_BROWSERSTACK_POLL_SECONDS")
     assert_equal "development", values.fetch("E2E_IOS_EXPORT_METHOD")
+    assert_equal "com.shopify.checkoutkit.reactnativedemo", values.fetch("E2E_IOS_BUNDLE_ID")
+    assert_equal "A7XGC83MZE", values.fetch("E2E_IOS_DEVELOPMENT_TEAM")
+    assert_equal "Apple Development", values.fetch("E2E_IOS_CODE_SIGN_IDENTITY")
+    assert_equal "bitrise-checkout-kit-e2e", values.fetch("E2E_IOS_PROVISIONING_PROFILE_SPECIFIER")
     assert_equal "300", values.fetch("E2E_PACKAGE_COMMAND_TIMEOUT_SECONDS")
     assert_equal "1800", values.fetch("E2E_RUBY_INSTALL_TIMEOUT_SECONDS")
   end
@@ -161,6 +165,85 @@ def test_react_native_android_workflow_does_not_use_local_native_sdk_overrides
     refute_includes script, "--local"
   end
 
+  def test_react_native_ios_workflow_uses_macos_xcode_resources
+    workflow = load_bitrise_config.fetch("workflows").fetch("e2e-build-react-native-ios")
+    meta = workflow.fetch("meta").fetch("bitrise.io")
+
+    assert_equal "osx-xcode-26.0.x-edge", meta.fetch("stack")
+    assert_equal "g2.mac.4large", meta.fetch("machine_type_id")
+  end
+
+  def test_react_native_ios_workflow_builds_real_ipa_artifact
+    config = load_bitrise_config
+    script = workflow_script("e2e-build-react-native-ios")
+
+    assert_equal "1800", app_env_values.fetch("E2E_IOS_COMMAND_TIMEOUT_SECONDS")
+    assert_workflow_has_step(config, "e2e-build-react-native-ios", "certificate-and-profile-installer")
+    assert_includes script, "source e2e/scripts/bitrise_ci_helpers"
+    assert_includes script, "e2e_prepare_ruby"
+    assert_includes script, 'e2e_log "Checking storefront configuration secrets"'
+    assert_includes script, 'STOREFRONT_DOMAIN is required'
+    assert_includes script, 'STOREFRONT_ACCESS_TOKEN is required'
+    assert_includes script, 'workflow_editor#!/secrets'
+    assert_includes script, 'Expose for pull requests'
+    assert_includes script, 'e2e_log "Configuring storefront environment"'
+    assert_includes script, 'e2e_log "Installing React Native dependencies"'
+    assert_includes script, 'e2e_log "Installing iOS Ruby dependencies"'
+    assert_includes script, 'e2e_log "Installing CocoaPods dependencies"'
+    assert_includes script, 'ios_bundle_id="${E2E_IOS_BUNDLE_ID:-com.shopify.checkoutkit.reactnativedemo}"'
+    assert_includes script, 'ios_development_team="${E2E_IOS_DEVELOPMENT_TEAM:-A7XGC83MZE}"'
+    assert_includes script, 'ios_code_sign_identity="${E2E_IOS_CODE_SIGN_IDENTITY:-Apple Development}"'
+    assert_includes script, 'ios_profile_specifier="${E2E_IOS_PROVISIONING_PROFILE_SPECIFIER:-bitrise-checkout-kit-e2e}"'
+    assert_includes script, '<key>signingStyle</key>'
+    assert_includes script, '<string>manual</string>'
+    assert_includes script, '<key>teamID</key>'
+    assert_includes script, '<string>$ios_development_team</string>'
+    assert_includes script, '<key>provisioningProfiles</key>'
+    assert_includes script, '<key>$ios_bundle_id</key>'
+    assert_includes script, '<string>$ios_profile_specifier</string>'
+    assert_includes script, 'e2e_log "Archiving React Native iOS app"'
+    assert_includes script, 'CODE_SIGN_STYLE=Manual'
+    assert_includes script, 'DEVELOPMENT_TEAM=$ios_development_team'
+    assert_includes script, 'CODE_SIGN_IDENTITY=$ios_code_sign_identity'
+    assert_includes script, 'PROVISIONING_PROFILE_SPECIFIER=$ios_profile_specifier'
+    assert_includes script, 'e2e_log "iOS archive failed"'
+    assert_includes script, 'com.shopify.checkoutkit.reactnativedemo'
+    assert_includes script, 'A7XGC83MZE'
+    assert_includes script, 'workflow_editor#!/code_signing'
+    assert_includes script, 'certificate-and-profile-installer'
+    assert_includes script, 'e2e_log "Exporting React Native iOS IPA"'
+    assert_includes script, 'e2e_log "iOS IPA export failed"'
+    assert_includes script, 'find "$export_path"'
+    assert_includes script, 'e2e_log "Publishing iOS IPA path"'
+    assert_includes script, "corepack enable"
+    assert_includes script, "cd platforms/react-native"
+    assert_command_order script, "cd platforms/react-native", "pnpm install --frozen-lockfile"
+    assert_includes script, "pnpm install --frozen-lockfile"
+    assert_includes script, "./scripts/setup_storefront_env --skip-optional-prompts"
+    assert_includes script, 'e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" pnpm install --frozen-lockfile'
+    assert_includes script, 'e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" bundle install'
+    assert_includes script, 'e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" bundle exec pod install --deployment --repo-update'
+    assert_includes script, 'e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" xcodebuild archive'
+    assert_includes script, 'e2e_run_with_timeout "${E2E_IOS_COMMAND_TIMEOUT_SECONDS:-1800}" xcodebuild -exportArchive'
+    assert_includes script, "bundle exec pod install --deployment --repo-update"
+    assert_includes script, "xcodebuild archive"
+    assert_includes script, "-sdk iphoneos"
+    assert_includes script, "generic/platform=iOS"
+    assert_includes script, "xcodebuild -exportArchive"
+    assert_includes script, "E2E_REACT_NATIVE_IOS_APP_PATH"
+    refute_includes script, "Phase 2 placeholder for React Native iOS IPA"
+
+    deploy_step = workflow_step(config, "e2e-build-react-native-ios", "deploy-to-bitrise-io")
+    assert_equal false, deploy_step.fetch("is_always_run")
+  end
+
+  def test_react_native_ios_workflow_does_not_use_local_native_sdk_overrides
+    script = workflow_script("e2e-build-react-native-ios")
+
+    refute_includes script, "USE_LOCAL_SDK"
+    refute_includes script, "--local"
+  end
+
   def test_bitrise_setup_docs_exist
     assert File.exist?("e2e/BITRISE.md")
   end
@@ -204,11 +287,16 @@ def expected_workflows
     ]
   end
 
-  def assert_workflow_has_step(config, workflow, step_name)
+  def workflow_step(config, workflow, step_name)
     steps = config.fetch("workflows").fetch(workflow).fetch("steps")
-    step_names = steps.flat_map(&:keys)
+    step = steps.find { |candidate| candidate.keys.first.start_with?(step_name) }
 
-    assert step_names.any? { |name| name.start_with?(step_name) }, "expected #{workflow} to include #{step_name}"
+    assert step, "expected #{workflow} to include #{step_name}"
+    step.values.first
+  end
+
+  def assert_workflow_has_step(config, workflow, step_name)
+    workflow_step(config, workflow, step_name)
   end
 
   def assert_command_order(script, first_command, second_command)