Add CI and Fastlane automation for one-off and nightly TestFlight builds (#24443)

* Explicitly set .ipa output name when building for ASC

We'll use it to derive the path when uploading the ipa to TestFlight in
a dedicated lane.

* Add lane to upload Reader build to TestFlight

* Hack a version long and short to use for TestFlight upload testing

* Add dedicated pipeline to upload Reader to TestFlight

* Add trigger button to send Reader build to TestFlight

* Address RuboCop violations

* Only install gems in Reader upload script

No need to set up Swift packages or XCFrameworks.

* Set `VERSION_LONG` as `BUILDKITE_BUILD_NUMBER` default

* Specify supported device orientation for iPhone and iPad

Aims to address:

 [Application Loader Error Output]: [ContentDelivery.Uploader.6000033F8180] Validation failed (409) Invalid bundle. No orientations were specified in the com.automattic.reader bundle. To support iPad multitasking, specify the “UIInterfaceOrientationPortrait,UIInterfaceOrientationPortraitUpsideDown,UIInterfaceOrientationLandscapeLeft,UIInterfaceOrientationLandscapeRight” orientations for the UISupportedInterfaceOrientations Info.plist key. For details, visit: https://developer.apple.com/documentation/bundleresources/information_property_list/uisupportedinterfaceorientations. (ID: b7c3b053-0ea8-4267-83dc-1dee7ea62885)

See
https://buildkite.com/automattic/wordpress-ios/builds/27266/steps?sid=0196236d-400e-4be1-9cf8-399f2ca6b45c

* Make Reader upload depend on both build and block step

I was expecting the implicit dependency in the block to force the upload
to wait till the build finished, but that was not the case in
https://buildkite.com/automattic/wordpress-ios/builds/27273/steps?sid=019624d9-64df-4b64-89da-927be7ecb550

* Add required value for `NSMicrophoneUsageDescription` to Reader

Aims to address the App Store Connect upload issues:

> ITMS-90683: Missing purpose string in Info.plist - Your app’s code references one or more APIs that access sensitive user data, or the app has one or more entitlements that permit such access.
> The Info.plist file for the “Reader.app” bundle should contain a NSMicrophoneUsageDescription key with a user-facing purpose string explaining clearly and completely why your app needs the data.
> If you’re using external libraries or SDKs, they may reference APIs that require a purpose string.
> While your app might not use these APIs, a purpose string is still required.
> For details, visit: https://developer.apple.com/documentation/uikit/protecting_the_user_s_privacy/requesting_access_to_protected_resources.

* Add required value for `NSCameraUsageDescription` to Reader

Aims to address the App Store Connect upload issues:

> ITMS-90683: Missing purpose string in Info.plist - Your app’s code references one or more APIs that access sensitive user data, or the app has one or more entitlements that permit such access.
> The Info.plist file for the “Reader.app” bundle should contain a NSCameraUsageDescription key with a user-facing purpose string explaining clearly and completely why your app needs the data.
> If you’re using external libraries or SDKs, they may reference APIs that require a purpose string.
> While your app might not use these APIs, a purpose string is still required.
> For details, visit: https://developer.apple.com/documentation/uikit/protecting_the_user_s_privacy/requesting_access_to_protected_resources.

* Point Reachability to Automattic's fork

This addresses the App Store Connect upload issue:

> ITMS-90338: Non-public API usage - The app references non-public symbols in Frameworks/Keystone.framework/Keystone: _kReachabilityChangedNotification.
> If method names in your source code match the private Apple APIs listed above, altering your method names will help prevent this app from being flagged in future submissions.
> In addition, note that one or more of the above APIs may be located in a static library that was included with your app.
> If so, they must be removed.
> For further information, visit the Technical Support Information at http://developer.apple.com/support/technical/

* Prefix `bodyTextColor` and `titleTextColor` (unsed) with `wp`

This is to avoid a clash with Apple's private APIs in the dependency
setup with Keystone.

> ITMS-90338: Non-public API usage - The app references non-public selectors in Frameworks/Keystone.framework/Keystone: setBodyTextColor:, setTitleTextColor:.
> If method names in your source code match the private Apple APIs listed above, altering your method names will help prevent this app from being flagged in future submissions.
> In addition, note that one or more of the above APIs may be located in a static library that was included with your app.
> If so, they must be removed.
> For further information, visit the Technical Support Information at http://developer.apple.com/support/technical/

* Update Fastlane to latest version

* Add `ITSAppUsesNonExemptEncryption = NO` to Reader

* Disable distribution groups to attempt fixing TestFlight issue

See how this build fails
https://buildkite.com/automattic/wordpress-ios/builds/27323/steps?sid=01963655-580b-44c3-846f-ef84df40eb86

"Builds cannot be assigned to this internal group. - Cannot add internal group to a build."

However, on TestFlight itself the build is successfully part of the
group and distributed.

Author: mokagio

.buildkite/commands/release-upload-reader.sh

@@ -0,0 +1,16 @@
+#!/bin/bash -eu
+
+echo "--- :arrow_down: Downloading Artifacts"
+ARTIFACTS_DIR='Artifacts' # See fastlane/Fastfile BUILD_PRODUCTS_PATH
+STEP=build_asc_reader
+buildkite-agent artifact download "$ARTIFACTS_DIR/*.ipa" . --step $STEP
+buildkite-agent artifact download "$ARTIFACTS_DIR/*.zip" . --step $STEP
+
+echo "--- :rubygems: Setting up Gems"
+install_gems
+
+echo "--- :closed_lock_with_key: Installing Secrets"
+bundle exec fastlane run configure_apply
+
+echo "--- :testflight: Uploading to App Store Connect"
+bundle exec fastlane upload_to_app_store_connect_reader

.buildkite/pipeline.yml

@@ -6,17 +6,35 @@ env:
 
 # This is the default pipeline – it will build and test the app
 steps:
+  - group: ":eyeglasses: Reader Builds"
+    steps:
+      - label: ":eyeglasses: Reader ASC Demo Build"
+        key: build_asc_reader
+        command: .buildkite/commands/release-build-reader.sh
+        plugins: [$CI_TOOLKIT_PLUGIN]
+        artifact_paths:
+          - Artifacts/*.zip
+          - Artifacts/*.ipa
+        notify:
+          - github_commit_status:
+              context: "Reader ASC Demo Build"
 
-  - label: ":eyeglasses: Reader ASC Demo Build"
-    key: build_reader
-    command: ".buildkite/commands/release-build-reader.sh"
-    plugins: [$CI_TOOLKIT_PLUGIN]
-    artifact_paths:
-      - "Artifacts/*.zip"
-      - "Artifacts/*.ipa"
-    notify:
-      - github_commit_status:
-          context: "Reader ASC Demo Build"
+      - block: Distribute Reader via TestFlight
+        prompt: Distribute the Reader build via TestFlight?
+        key: testflight_triggered_reader
+        # Block steps have implicit dependency on the steps that come before them.
+        # See https://buildkite.com/docs/pipelines/trigger-step
+        #
+        # Make it depend on nothing so we don't have to wait for previous steps to finish before the deployment can start.
+        depends_on: ~
+
+      - label: ":eyeglasses: Reader one-off TestFlight Upload"
+        depends_on: [build_asc_reader, testflight_triggered_reader]
+        command: .buildkite/commands/release-upload-reader.sh
+        plugins: [$CI_TOOLKIT_PLUGIN]
+        notify:
+          - github_commit_status:
+              context: "Reader one-off TestFlight Upload"
 
   #################
   # Create Prototype Builds for WP and JP

.buildkite/reader-testflight.yml

@@ -0,0 +1,28 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
+---
+
+steps:
+  - label: ":eyeglasses: :xcode: Reader App Store Connect Build"
+    command: .buildkite/commands/release-build-reader.sh
+    key: reader_asc_build
+    plugins: [$CI_TOOLKIT_PLUGIN]
+    agents:
+      queue: mac
+    env:
+      IMAGE_ID: $IMAGE_ID
+    artifact_paths:
+      - Artifacts/*.zip
+      - Artifacts/*.ipa
+    notify:
+      - slack: "#build-and-ship"
+
+  - label: ":eyeglasses: :testflight: Reader App Store Connect Upload"
+    depends_on: reader_asc_build
+    command: .buildkite/commands/release-upload-reader.sh
+    plugins: [$CI_TOOLKIT_PLUGIN]
+    agents:
+      queue: mac
+    env:
+      IMAGE_ID: $IMAGE_ID
+    notify:
+      - slack: "#build-and-ship"

Gemfile.lock

@@ -24,7 +24,7 @@ GEM
     ast (2.4.3)
     atomos (0.1.3)
     aws-eventstream (1.3.2)
-    aws-partitions (1.1078.0)
+    aws-partitions (1.1086.0)
     aws-sdk-core (3.222.1)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.992.0)
@@ -125,7 +125,7 @@ GEM
     faraday_middleware (1.2.1)
       faraday (~> 1.0)
     fastimage (2.4.0)
-    fastlane (2.227.0)
+    fastlane (2.227.1)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.8, < 3.0.0)
       artifactory (~> 3.0)
@@ -165,7 +165,7 @@ GEM
       tty-spinner (>= 0.8.0, < 1.0.0)
       word_wrap (~> 1.0.0)
       xcodeproj (>= 1.13.0, < 2.0.0)
-      xcpretty (~> 0.4.0)
+      xcpretty (~> 0.4.1)
       xcpretty-travis-formatter (>= 0.0.3, < 2.0.0)
     fastlane-plugin-firebase_app_distribution (0.10.0)
       google-apis-firebaseappdistribution_v1 (~> 0.3.0)

Modules/Package.swift

@@ -42,7 +42,7 @@ let package = Package(
         .package(url: "https://github.com/scinfu/SwiftSoup", exact: "2.7.5"),
         .package(url: "https://github.com/squarefrog/UIDeviceIdentifier", from: "2.3.0"),
         .package(url: "https://github.com/SVProgressHUD/SVProgressHUD", from: "2.3.1"),
-        .package(url: "https://github.com/tonymillion/Reachability", from: "3.7.5"),
+        .package(url: "https://github.com/Automattic/Reachability", branch: "framework-support-via-spm"),
         .package(url: "https://github.com/weichsel/ZIPFoundation", from: "0.9.19"),
         .package(url: "https://github.com/wordpress-mobile/FSInteractiveMap", from: "0.3.0"),
         .package(url: "https://github.com/wordpress-mobile/MediaEditor-iOS", branch: "task/spm-support"),

Modules/Sources/WordPressShared/Reachability/Notification+Reachability.swift

@@ -5,7 +5,7 @@ public extension Notification {
 }
 
 public extension Notification.Name {
-    /// - warning: Using a different name that auto-imported `kReachabilityChangedNotification`.
+    /// - warning: Using a different name that auto-imported `kTMReachabilityChangedNotification` from the Reachability package.
     static var reachabilityUpdated: Notification.Name {
         return Notification.Name("\(Notification.reachabilityKey).updated")
     }

Modules/Sources/WordPressUI/FancyAlert/FancyAlertView.swift

@@ -62,7 +62,8 @@ open class FancyAlertView: UIView {
 
     /// TitleLabel: textColor
     ///
-    @objc public dynamic var titleTextColor: UIColor? {
+    /// Notice the "wp" prefix to avoid clashing with Apple's private API.
+    @objc public dynamic var wpTitleTextColor: UIColor? {
         get {
             return titleLabel.textColor
         }
@@ -73,7 +74,8 @@ open class FancyAlertView: UIView {
 
     /// BodyLabel: textColor
     ///
-    @objc public dynamic var bodyTextColor: UIColor? {
+    /// Notice the "wp" prefix to avoid clashing with Apple's private API.
+    @objc public dynamic var wpBodyTextColor: UIColor? {
         get {
             return bodyLabel.textColor
         }

WordPress.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -72,10 +72,10 @@ extension WPStyleGuide {
     private static func setupFancyAlertAppearance() {
         let appearance = FancyAlertView.appearance()
 
-        appearance.titleTextColor = UIAppColor.neutral(.shade70)
+        appearance.wpTitleTextColor = UIAppColor.neutral(.shade70)
         appearance.titleFont = WPStyleGuide.fontForTextStyle(.title2, fontWeight: .semibold)
 
-        appearance.bodyTextColor = UIAppColor.neutral(.shade70)
+        appearance.wpBodyTextColor = UIAppColor.neutral(.shade70)
         appearance.bodyFont = WPStyleGuide.fontForTextStyle(.body)
         appearance.bodyBackgroundColor = UIAppColor.neutral(.shade0)
 

WordPress/Classes/Extensions/Colors and Styles/WPStyleGuide+ApplicationStyles.swift

@@ -67,7 +67,7 @@ - (void)viewDidLoad
         self.title = self.blog.settings.name;
     }
 
-    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(reachabilityChanged:) name:kReachabilityChangedNotification object:ReachabilityUtils.internetReachability];
+    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(reachabilityChanged:) name:kTMReachabilityChangedNotification object:ReachabilityUtils.internetReachability];
 
     [self initStats];
 }