[Tooling] Migrate Prototype Builds to Firebase App Distribution (#15323)

Author: AliSoftware

Gemfile

@@ -12,12 +12,12 @@ gem 'danger-dangermattic', '~> 1.2'
 gem 'dotenv'
 # 2.217.0 includes a fix for Xcode 15 test results parsing in CI
 gem 'fastlane', '~> 2.217'
-gem 'fastlane-plugin-appcenter', '~> 2.0'
+gem 'fastlane-plugin-firebase_app_distribution', '~> 0.10'
 gem 'fastlane-plugin-sentry', '~> 1.0'
 # This comment avoids typing to switch to a development version for testing.
 #
 # gem 'fastlane-plugin-wpmreleasetoolkit', git: '[email protected]:wordpress-mobile/release-toolkit', branch: ''
-gem 'fastlane-plugin-wpmreleasetoolkit', '~> 12.5'
+gem 'fastlane-plugin-wpmreleasetoolkit', '~> 13.0'
 gem 'rake', '~> 12.3'
 gem 'rubocop', '~> 1.65'
 gem 'rubocop-rake', '~> 0.6'

Gemfile.lock

@@ -210,10 +210,12 @@ GEM
       xcodeproj (>= 1.13.0, < 2.0.0)
       xcpretty (~> 0.4.0)
       xcpretty-travis-formatter (>= 0.0.3, < 2.0.0)
-    fastlane-plugin-appcenter (2.1.2)
+    fastlane-plugin-firebase_app_distribution (0.10.0)
+      google-apis-firebaseappdistribution_v1 (~> 0.3.0)
+      google-apis-firebaseappdistribution_v1alpha (~> 0.2.0)
     fastlane-plugin-sentry (1.25.1)
       os (~> 1.1, >= 1.1.4)
-    fastlane-plugin-wpmreleasetoolkit (12.5.0)
+    fastlane-plugin-wpmreleasetoolkit (13.0.0)
       activesupport (>= 6.1.7.1)
       buildkit (~> 1.5)
       chroma (= 0.2.0)
@@ -250,6 +252,10 @@ GEM
       representable (~> 3.0)
       retriable (>= 2.0, < 4.a)
       rexml
+    google-apis-firebaseappdistribution_v1 (0.3.0)
+      google-apis-core (>= 0.11.0, < 2.a)
+    google-apis-firebaseappdistribution_v1alpha (0.2.0)
+      google-apis-core (>= 0.11.0, < 2.a)
     google-apis-iamcredentials_v1 (0.17.0)
       google-apis-core (>= 0.11.0, < 2.a)
     google-apis-playcustomapp_v1 (0.13.0)
@@ -416,9 +422,9 @@ DEPENDENCIES
   danger-dangermattic (~> 1.2)
   dotenv
   fastlane (~> 2.217)
-  fastlane-plugin-appcenter (~> 2.0)
+  fastlane-plugin-firebase_app_distribution (~> 0.10)
   fastlane-plugin-sentry (~> 1.0)
-  fastlane-plugin-wpmreleasetoolkit (~> 12.5)
+  fastlane-plugin-wpmreleasetoolkit (~> 13.0)
   rake (~> 12.3)
   rmagick (~> 4.1)
   rubocop (~> 1.65)

fastlane/Fastfile

@@ -24,6 +24,11 @@ DERIVED_DATA_DIR = File.join(FASTLANE_DIR, 'DerivedData')
 SCREENSHOTS_DIR =  File.join(FASTLANE_DIR, 'screenshots')
 FASTLANE_METADATA_FOLDER = File.join(FASTLANE_DIR, 'metadata')
 WORKSPACE_PATH = File.join(PROJECT_ROOT_FOLDER, 'WooCommerce.xcworkspace')
+
+# Firebase App Distribution
+FIREBASE_APP_ID = '1:124902176124:ios:02259de1e7c42b291620f9'
+FIREBASE_TESTERS_GROUP = 'woocommerce-ios---prototype-builds'
+
 BUILDKITE_RELEASE_PIPELINE = 'release-builds.yml'
 IOS_LOCALES = %w[ar-SA de-DE en-US es-ES fr-FR he id it ja ko nl-NL pt-BR ru sv tr zh-Hans zh-Hant].freeze
 SIMULATOR_VERSION = '18.1' # For screenshots
@@ -51,7 +56,7 @@ MAIN_BUNDLE_IDENTIFIERS = [
 ].freeze
 
 ALPHA_VERSION_BUNDLE_IDENTIFIER = 'com.automattic.alpha.woocommerce'
-# Registered in our Enterprise account, for App Center / Prototype Builds
+# Registered in our Enterprise account, for Prototype Builds
 ALPHA_BUNDLE_IDENTIFIERS = MAIN_BUNDLE_IDENTIFIERS.map do |id|
   id.gsub(APP_STORE_VERSION_BUNDLE_IDENTIFIER, ALPHA_VERSION_BUNDLE_IDENTIFIER)
 end.freeze
@@ -738,13 +743,17 @@ platform :ios do
 
     build_for_prototype_build
 
-    appcenter_upload(
-      api_token: get_required_env('APPCENTER_API_TOKEN'),
-      owner_name: 'automattic',
-      owner_type: 'organization',
-      app_name: 'WooCommerce-Installable-Builds',
-      destinations: 'Collaborators',
-      notify_testers: false
+    release_notes = <<~NOTES
+      Pull Request: ##{pull_request_number || 'N/A'}
+      Branch: `#{ENV.fetch('BUILDKITE_BRANCH', 'N/A')}`
+      Commit: #{ENV.fetch('BUILDKITE_COMMIT', 'N/A')[0...7]}
+    NOTES
+
+    firebase_app_distribution(
+      app: FIREBASE_APP_ID,
+      service_credentials_json_data: get_required_env('FIREBASE_APP_DISTRIBUTION_ACCOUNT_KEY'),
+      release_notes: release_notes,
+      groups: FIREBASE_TESTERS_GROUP
     )
 
     sentry_upload_dsym(
@@ -754,21 +763,13 @@ platform :ios do
       dsym_path: './build/WooCommerce.app.dSYM.zip'
     )
 
-    # The build code used in the Enterprise build has a different format that the App Store one.
-    # We cannot use the standard build_code_current method but have to read it directly.
-    build_code = Xcodeproj::Config.new(File.new(PUBLIC_CONFIG_FILE)).to_hash[BUILD_CODE_KEY]
-    UI.message("Successfully built and uploaded prototype build `#{build_code}` to App Center.")
-
-    return if ENV['BUILDKITE_PULL_REQUEST'].nil?
+    next if pull_request_number.nil?
 
     # PR Comment
-    comment_body = prototype_build_details_comment(
-      app_display_name: 'WooCommerce iOS',
-      app_center_org_name: 'automattic'
-    )
+    comment_body = prototype_build_details_comment(app_display_name: 'WooCommerce iOS Prototype')
     comment_on_pr(
       project: GITHUB_REPO,
-      pr_number: Integer(ENV.fetch('BUILDKITE_PULL_REQUEST')),
+      pr_number: pull_request_number,
       reuse_identifier: 'prototype-build-link',
       body: comment_body
     )
@@ -778,19 +779,15 @@ platform :ios do
   lane :build_for_prototype_build do |fetch_code_signing: true|
     update_certs_and_profiles_enterprise if fetch_code_signing
 
-    # Get the current build version, and update it if needed
-    versions = Xcodeproj::Config.new(File.new(PUBLIC_CONFIG_FILE)).to_hash
-    build_number = generate_prototype_build_number
-    UI.message("Updating build version to #{build_number}")
-    versions[BUILD_CODE_KEY] = build_number
-    new_config = Xcodeproj::Config.new(versions)
-    new_config.save_as(Pathname.new(PUBLIC_CONFIG_FILE))
+    build_number = ENV.fetch('BUILDKITE_BUILD_NUMBER', '0')
+    pr_or_branch = pull_request_number&.then { |num| "PR ##{num}" } || ENV.fetch('BUILDKITE_BRANCH', nil)
 
     gym(
       scheme: 'WooCommerce Alpha',
       workspace: WORKSPACE_PATH,
       export_method: 'enterprise',
       clean: true,
+      xcargs: { BUILD_CODE_KEY => build_number, 'VERSION_SHORT' => pr_or_branch }.compact,
       output_directory: 'build',
       export_team_id: get_required_env('INT_EXPORT_TEAM_ID'),
       export_options: {
@@ -1329,25 +1326,6 @@ lane :test_without_building do |options|
   UI.user_error!("Tests failed with #{tests_result[:number_of_failures_excluding_retries]} failures.") if tests_result[:number_of_failures_excluding_retries].positive?
 end
 
-# -----------------------------------------------------------------------------------
-# Generates Prototype Build Version Numbers in a Buildkite-specific way
-# -----------------------------------------------------------------------------------
-def generate_prototype_build_number
-  if ENV.key?('BUILDKITE')
-    commit = ENV.fetch('BUILDKITE_COMMIT')[0, 7]
-    branch = ENV.fetch('BUILDKITE_BRANCH')
-    pr_num = ENV.fetch('BUILDKITE_PULL_REQUEST')
-
-    pr_num == 'false' ? "#{branch}-#{commit}" : "pr#{pr_num}-#{commit}"
-  else
-    repo = Git.open(PROJECT_ROOT_FOLDER)
-    commit = repo.current_branch
-    branch = repo.revparse('HEAD')[0, 7]
-
-    "#{branch}-#{commit}"
-  end
-end
-
 # -----------------------------------------------------------------------------------
 # Raises an error if Sentry is not installed
 # -----------------------------------------------------------------------------------
@@ -1495,13 +1473,6 @@ def prompt_user_for_app_store_connect_credentials
   ENV['FASTLANE_USER'] = CredentialsManager::AccountManager.new.user
 end
 
-def override_default_release_branch(version)
-  success = Fastlane::Helper::GitHelper.checkout_and_pull(release: version)
-  UI.user_error!("Release branch for version #{version} doesn't exist. Abort.") unless success
-
-  UI.message("Checked out branch `#{git_branch}` as requested by user.\n")
-end
-
 # https://buildkite.com/docs/test-analytics/ci-environments
 TEST_ANALYTICS_ENVIRONMENT = %w[
   BUILDKITE_ANALYTICS_TOKEN
@@ -1517,6 +1488,13 @@ TEST_ANALYTICS_ENVIRONMENT = %w[
 # -----------------------------------------------------------------------------------
 # Release Management Utils
 # -----------------------------------------------------------------------------------
+
+def pull_request_number
+  # Buildkite sets this env var to the PR number if on a PR, but to 'false' (and not nil) if not on a PR
+  pr_num = ENV.fetch('BUILDKITE_PULL_REQUEST', 'false')
+  pr_num == 'false' ? nil : Integer(pr_num)
+end
+
 def create_backmerge_pr
   version = release_version_current
 

fastlane/env/user.env.example

@@ -1,5 +1,4 @@
 GHHELPER_ACCESS=<GitHub access token>
 SENTRY_AUTH_TOKEN=<Sentry auth token>
 
-APPCENTER_API_TOKEN=<AppCenter API Token>
 CIRCLE_CI_AUTH_TOKEN=<CircleCI Auth Token>