Fix iOS build multiple platform and architecture (#213)

cynthiajoan · web-flow · commit 770accf9b51b · 2022-03-29T10:31:54.000-07:00
diff --git a/.github/workflows/ios.yml b/.github/workflows/ios.yml
@@ -28,6 +28,7 @@ jobs:
       LC_ALL: en_US.UTF-8
       LANG: en_US.UTF-8
       U3D_PASSWORD: ""
+      xcodeVersion: "12.4"
   
     steps:
       - name: Checkout Unity Repo
@@ -49,6 +50,9 @@ jobs:
         with:
           python-version: '3.7'
 
+      - name: setup Xcode version
+        run: sudo xcode-select -s /Applications/Xcode_${{ env.xcodeVersion }}.app/Contents/Developer
+
       - name: Install prerequisites
         shell: bash
         run: |
diff --git a/build_ios.sh b/build_ios.sh
@@ -16,7 +16,7 @@
 #
 # Builds and runs the tests, meant to be used on a bash environment.
 
-usage(){
+usage() {
     echo "Usage: $0 [options]
  options:
    -b, build path              default: ios_unity
@@ -30,15 +30,20 @@ usage(){
 
 set -e
 
-readonly SUPPORTED_PLATFORMS=(device) # simulator) only support device arch for now
-readonly SUPPORTED_ARCHITECTURES="arm64;armv7" #;x86_64;i386" only support device arch for now
-#readonly DEVICE_ARCHITECTURES="arm64;armv7" only support device arch for now
-#readonly SIMULATOR_ARCHITECTURES="arm64;x86_64;i386" only support device arch for now
+readonly SUPPORTED_PLATFORMS=(device simulator)
+readonly SUPPORTED_ARCHITECTURES=(arm64 armv7 x86_64 i386)
+readonly DEVICE_ARCHITECTURES=(arm64 armv7)
+readonly SIMULATOR_ARCHITECTURES=(arm64 x86_64 i386)
+readonly DEVICE_IOS_PLATFORM_LOCATION="iPhoneOS.platform"
+readonly SIMULATOR_IOS_PLATFORM_LOCATION="iPhoneSimulator.platform"
+readonly DEVICE_OSX_SYSROOT="iphoneos"
+readonly SIMULATOR_OSX_SYSROOT="iphonesimulator"
 
 # build default value
 buildpath="ios_unity"
 sourcepath="."
 platforms=("${SUPPORTED_PLATFORMS[@]}")
+architectures=("${SUPPORTED_ARCHITECTURES[@]}")
 cmake_extra=""
 
 # Enable utf8 output
@@ -48,57 +53,117 @@ export LANG=en_US.UTF-8
 IFS=',' # split options on ',' characters
 while getopts "hb:s:p:a:c:" opt; do
     case $opt in
-        h)
-            usage
-            exit 0
-            ;;
-        b)
-            buildpath=$OPTARG
-            ;;
-        s)
-            sourcepath=$OPTARG
-            if [[ ! -d "${sourcepath}" ]]; then
-                echo "Source path ${sourcepath} not found."
+    h)
+        usage
+        exit 0
+        ;;
+    b)
+        buildpath=$OPTARG
+        ;;
+    s)
+        sourcepath=$OPTARG
+        if [[ ! -d "${sourcepath}" ]]; then
+            echo "Source path ${sourcepath} not found."
+            exit 2
+        fi
+        ;;
+    p)
+        platforms=($OPTARG)
+        for platform in ${platforms[@]}; do
+            if [[ ! " ${SUPPORTED_PLATFORMS[@]} " =~ " ${platform} " ]]; then
+                echo "invalid platform: ${platform}"
+                echo "Supported platforms are: ${SUPPORTED_PLATFORMS[@]}"
                 exit 2
             fi
-            ;;
-        p)
-            platforms=($OPTARG)
-            for platform in ${platforms[@]}; do
-                if [[ ! " ${SUPPORTED_PLATFORMS[@]} " =~ " ${platform} " ]]; then
-                    echo "invalid platform: ${platform}"
-                    echo "Supported platforms are: ${SUPPORTED_PLATFORMS[@]}"
-                    exit 2
-                fi
-            done
-            ;;
-        a)
-            architectures=($OPTARG)
-            for arch in ${architectures[@]}; do
-                if [[ ! " ${SUPPORTED_ARCHITECTURES[@]} " =~ " ${arch} " ]]; then
-                    echo "invalid architecture: ${arch}"
-                    echo "Supported architectures are: ${SUPPORTED_ARCHITECTURES[@]}"
-                    exit 2
-                fi
-            done
-            ;;
-        c)
-            cmake_extra=$OPTARG
-            ;;
-        *)
-            echo "unknown parameter"
-            exit 2
-            ;;
+        done
+        ;;
+    a)
+        architectures=($OPTARG)
+        for arch in ${architectures[@]}; do
+            if [[ ! " ${SUPPORTED_ARCHITECTURES[@]} " =~ " ${arch} " ]]; then
+                echo "invalid architecture: ${arch}"
+                echo "Supported architectures are: ${SUPPORTED_ARCHITECTURES[@]}"
+                exit 2
+            fi
+        done
+        ;;
+    c)
+        cmake_extra=$OPTARG
+        ;;
+    *)
+        echo "unknown parameter"
+        exit 2
+        ;;
     esac
 done
 echo "*********************** Build Unity iOS SDK *******************************"
 echo "build path: ${buildpath}"
 echo "source path: ${sourcepath}"
 echo "build platforms: ${platforms[@]}"
+echo "architectures: ${architectures[@]}"
 echo "cmake extras: ${cmake_extra}"
 echo "***************************************************************************"
-sourcepath=$(cd ${sourcepath} && pwd)   #full path
-buildpath=$(mkdir -p ${buildpath} && cd ${buildpath} && pwd)    #full path
+sourcepath=$(cd ${sourcepath} && pwd)                        #full path
+buildpath=$(mkdir -p ${buildpath} && cd ${buildpath} && pwd) #full path
+
+ios_location=""
+osx_sysroot=""
+xcode_platforms=""
+cmake_archs=""
+# build necessary cmake args
+if [[ " ${platforms[@]} " =~ " device " ]]; then
+    echo "Build cmake args for device"
+    ios_location=${DEVICE_IOS_PLATFORM_LOCATION}
+    osx_sysroot=${DEVICE_OSX_SYSROOT}
+    xcode_platforms="-${DEVICE_OSX_SYSROOT}"
+    for arch in ${architectures[@]}; do
+        if [[ " ${DEVICE_ARCHITECTURES[@]} " =~ " ${arch} " ]]; then
+            if [ "$cmake_archs" == "" ]; then
+                cmake_archs=${arch}
+            else
+                cmake_archs="${cmake_archs};${arch}"
+            fi
+        fi
+    done
+fi
+
+if [[ " ${platforms[@]} " =~ " simulator " ]]; then
+    echo "Build cmake args for simulator"
+    if [ "$ios_location" == "" ]; then
+        ios_location=${SIMULATOR_IOS_PLATFORM_LOCATION}
+    else
+        ios_location="${ios_location};${SIMULATOR_IOS_PLATFORM_LOCATION}"
+    fi
+    if [ "$osx_sysroot" == "" ]; then
+        osx_sysroot=${SIMULATOR_OSX_SYSROOT}
+    else
+        osx_sysroot="${osx_sysroot};${SIMULATOR_OSX_SYSROOT}"
+    fi
+    if [ "$xcode_platforms" == "" ]; then
+        xcode_platforms="-${SIMULATOR_OSX_SYSROOT}"
+    else
+        xcode_platforms="${xcode_platforms};-${SIMULATOR_OSX_SYSROOT}"
+    fi
+    
+    for arch in ${architectures[@]}; do
+        if [[ " ${SIMULATOR_ARCHITECTURES[@]} " =~ " ${arch} " ]]; then
+            if [ "$cmake_archs" == "" ]; then
+                cmake_archs=${arch}
+            else
+                if [[ ! " ${DEVICE_ARCHITECTURES[@]} " =~ " ${arch} " ]]; then
+                    cmake_archs="${cmake_archs};${arch}"
+                fi
+            fi
+        fi
+    done
+fi
+
+echo "*********************** CMake Args *******************************"
+echo "ios_location: ${ios_location}"
+echo "osx_sysroot: ${osx_sysroot}"
+echo "xcode_platforms: ${xcode_platforms}"
+echo "cmake_archs: ${cmake_archs}"
+echo "***************************************************************************"
 
 # Stop display commands being run.
 set +x
@@ -107,17 +172,17 @@ set +x
 FIRST_FAILED_EXITCODE=0
 
 function check_exit_code {
- if [ "$1" -ne "0" ] && [ "$FIRST_FAILED_EXITCODE" -eq 0 ]; then
-  FIRST_FAILED_EXITCODE=$1
- fi
+    if [ "$1" -ne "0" ] && [ "$FIRST_FAILED_EXITCODE" -eq 0 ]; then
+        FIRST_FAILED_EXITCODE=$1
+    fi
 }
 
 CMAKE_OPTIONS="-DFIREBASE_UNITY_BUILD_TESTS=ON"
 CMAKE_OPTIONS="${CMAKE_OPTIONS} -DFIREBASE_CPP_BUILD_STUB_TESTS=ON" # enable a stub gtest target to get abseil-cpp working.
 
 if [ -d "../firebase-cpp-sdk" ]; then
-  REAL_PATH=`python -c "import os; print(os.path.realpath('../firebase-cpp-sdk'))"`
-  CMAKE_OPTIONS="${CMAKE_OPTIONS} -DFIREBASE_CPP_SDK_DIR=$REAL_PATH"
+    REAL_PATH=$(python -c "import os; print(os.path.realpath('../firebase-cpp-sdk'))")
+    CMAKE_OPTIONS="${CMAKE_OPTIONS} -DFIREBASE_CPP_SDK_DIR=$REAL_PATH"
 fi
 
 # Display commands being run.
@@ -128,25 +193,28 @@ mkdir -p "$buildpath"
 
 pushd "$buildpath"
 
-  # Configure cmake with option value
-  cmake $sourcepath \
+# Configure cmake with option value
+cmake $sourcepath \
     -DCMAKE_TOOLCHAIN_FILE=$sourcepath/cmake/unity_ios.cmake \
-    -DCMAKE_OSX_ARCHITECTURES=$SUPPORTED_ARCHITECTURES \
+    -DCMAKE_OSX_ARCHITECTURES=$cmake_archs \
+    -DCMAKE_OSX_SYSROOT=$osx_sysroot \
+    -DCMAKE_XCODE_EFFECTIVE_PLATFORMS=$xcode_platforms \
+    -DIOS_PLATFORM_LOCATION=$ios_location \
     -DUNITY_ROOT_DIR=${UNITY_ROOT_DIR} \
     $CMAKE_OPTIONS \
     $cmake_extra
-  check_exit_code $?
+check_exit_code $?
 
-  # Build the SDK
-  make
-  check_exit_code $?
+# Build the SDK
+make
+check_exit_code $?
 
-  # Package build output into zip
-  cpack .
-  check_exit_code $?
+# Package build output into zip
+cpack .
+check_exit_code $?
 
-  # Stop display commands being run.
-  set +x
+# Stop display commands being run.
+set +x
 
 popd
 
diff --git a/cmake/unity_ios.cmake b/cmake/unity_ios.cmake
@@ -12,27 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Locate gcc
-execute_process(COMMAND /usr/bin/xcrun -sdk iphoneos -find clang
-                OUTPUT_VARIABLE CMAKE_C_COMPILER
-                OUTPUT_STRIP_TRAILING_WHITESPACE)
-
-# Locate g++
-execute_process(COMMAND /usr/bin/xcrun -sdk iphoneos -find clang++
-                OUTPUT_VARIABLE CMAKE_CXX_COMPILER
-                OUTPUT_STRIP_TRAILING_WHITESPACE)
-
-# Set the CMAKE_OSX_SYSROOT to the latest SDK found
-execute_process(COMMAND /usr/bin/xcrun -sdk iphoneos --show-sdk-path
-                OUTPUT_VARIABLE CMAKE_OSX_SYSROOT
-                OUTPUT_STRIP_TRAILING_WHITESPACE)
-
 message(STATUS "gcc found at: ${CMAKE_C_COMPILER}")
 message(STATUS "g++ found at: ${CMAKE_CXX_COMPILER}")
 message(STATUS "Using iOS SDK: ${CMAKE_OSX_SYSROOT}")
 
-set(CMAKE_OSX_ARCHITECTURES "arm64" CACHE STRING "")
-set(CMAKE_XCODE_EFFECTIVE_PLATFORMS "-iphoneos")
+set(CMAKE_OSX_SYSROOT "iphoneos;iphonesimulator")
+set(CMAKE_OSX_ARCHITECTURES "arm64;armv7;x86_64;i386" CACHE STRING "")
+set(CMAKE_XCODE_EFFECTIVE_PLATFORMS "-iphoneos;-iphonesimulator")
+set(IOS_PLATFORM_LOCATION "iPhoneOS.platform;iPhoneSimulator.platform")
+
+set(CMAKE_IOS_INSTALL_UNIVERSAL_LIBS "YES")
+set(CMAKE_XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH "NO")
 set(CMAKE_XCODE_ATTRIBUTE_CODE_SIGNING_REQUIRED "NO")
 set(CMAKE_XCODE_ATTRIBUTE_ENABLE_BITCODE "YES")
 
diff --git a/messaging/testapp/Assets/Firebase/Sample/Messaging/UIHandlerAutomated.cs b/messaging/testapp/Assets/Firebase/Sample/Messaging/UIHandlerAutomated.cs
@@ -54,9 +54,31 @@ protected override void Start() {
         MakeTest(TestGetTokenAsync),
         MakeTest(TestDeleteTokenAsync),
       };
+
+      string[] customTests = {
+        // Disable these tests on desktop, as desktop never receives a token, and so WaitForToken
+        // (called by all of these tests) stalls forever.
+#if (UNITY_IOS || UNITY_ANDROID)
+        "TestWaitForToken",
+#if !UNITY_IOS
+        // TODO(b/130674454) This test times out on iOS, disabling until fixed.
+        "TestSendPlaintextMessageToDevice",
+#endif // !UNITY_IOS
+        "TestSendJsonMessageToDevice",
+        "TestSendJsonMessageToSubscribedTopic",
+#else  // (UNITY_IOS || UNITY_ANDROID)
+        // Run a vacuous test. Should be removed if/when desktop platforms get a real test.
+        "TestDummy",
+#endif // (UNITY_IOS || UNITY_ANDROID)
+        // TODO(varconst): a more involved test to check that resubscribing works
+        "TestGetTokenAsync",
+        "TestDeleteTokenAsync",
+      };
+
       testRunner = AutomatedTestRunner.CreateTestRunner(
         testsToRun: tests,
-        logFunc: DebugLog
+        logFunc: DebugLog,
+        testNames: customTests
       );
 
       base.Start();
@@ -151,18 +173,18 @@ IEnumerator TestDummy(TaskCompletionSource<string> tcs) {
 
     // Test GetTokenAsync
     IEnumerator TestGetTokenAsync(TaskCompletionSource<string> tcs) {
-      yield return StartCoroutine(WaitForToken());
       FirebaseMessaging.GetTokenAsync().ContinueWithOnMainThread(task => {
         tcs.SetResult(task.Result);
+        DebugLog("GetToken:"+task.Result);
       });
-
+      yield break;
     }
     // Test DeleteTokenAsync
     IEnumerator TestDeleteTokenAsync(TaskCompletionSource<string> tcs) {
-      yield return StartCoroutine(WaitForToken());
       FirebaseMessaging.DeleteTokenAsync().ContinueWithOnMainThread(task => {
         tcs.SetResult("DeleteTokenAsync completed");
       });
+      yield break;
     }
 
     // Sends the given message to targetDevice in plaintext format and gives back the message id iff
diff --git a/scripts/gha/print_matrix_configuration.py b/scripts/gha/print_matrix_configuration.py
@@ -109,7 +109,7 @@
       "ndk": "https://dl.google.com/android/repository/android-ndk-r19-darwin-x86_64.zip"
     },
     _LINUX: {
-      "version": "2019.4.36f1",
+      "version": "2019.4.37f1",
       "packages": {"Default": ["Unity"], "Android": ["Android"], "iOS": ["Ios"], "Windows": ["Windows-mono"], "macOS": ["Mac-mono"], "Linux": None}
     }
   },
@@ -158,10 +158,10 @@
   "emulator_latest": {"platform": "Android", "type": "virtual", "image": "system-images;android-30;google_apis;x86_64"},
   "emulator_32bit": {"platform": "Android", "type": "virtual", "image": "system-images;android-30;google_apis;x86"},
   "ios_min": {"platform": "iOS", "type": "real", "model": "iphone8", "version": "11.4"},
-  "ios_target": {"platform": "iOS", "type": "real", "model": "iphone8plus", "version": "12.0"},
+  "ios_target": {"platform": "iOS", "type": "real", "model": "iphone8", "version": "14.7"},
   "ios_latest": {"platform": "iOS", "type": "real", "model": "iphone11", "version": "13.6"},
   "simulator_min": {"platform": "iOS", "type": "virtual", "name": "iPhone 6", "version": "11.4"},
-  "simulator_target": {"platform": "iOS", "type": "virtual", "name": "iPhone 8", "version": "12.0"},
+  "simulator_target": {"platform": "iOS", "type": "virtual", "name": "iPhone 8", "version": "14.5"},
   "simulator_latest": {"platform": "iOS", "type": "virtual", "name": "iPhone 11", "version": "14.4"},
 }
 
