Add script that build iOS frameworks build

.github/workflows/ios.yml

@@ -0,0 +1,31 @@
+name: iOS Builds
+
+on: 
+ pull_request:
+ types: [opened, reopened, synchronize]
+
+jobs:
+ build:
+ name: ios-macos-latest
+ runs-on: macos-latest
+ strategy:
+ fail-fast: false
+
+ steps:
+ - uses: actions/checkout@v2
+ with:
+ submodules: true
+
+ - name: Setup python
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3.7
+ architecture: "x64"
+
+ - name: Install prerequisites
+ run: |
+ build_scripts/ios/install_prereqs.sh
+
+ - name: Build SDK
+ run: |
+ build_scripts/ios/build.sh -b ios_build -s .

build_scripts/ios/build.sh

@@ -1,37 +1,176 @@
-#!/bin/bash -ex
+#!/bin/bash
+#
+# Script to build iOS Frameworks
+# If built for all architectures (arm64 armv7 x86_64 i386),
+# it will build universal framework as well
+#
+# Usage: ./build.sh [options]
+# options:
+# -b, build path default: ios_build
+# -s, source path default: .
+# -a, framework architecture default: SUPPORTED_ARCHITECTURES
+# -t, CMake target default: SUPPORTED_TARGETS
+# -g, generate Makefiles default: true
+# -c, CMake build default: true
+# example: 
+# build_scripts/ios/build.sh -b ios_build -s . -a arm64,x86_64 -t firebase_admob,firebase_auth -c false
 
-buildpath=$1
-sourcepath=$2
-arch=$3
+set -e
 
-if [[ -z "${buildpath}" || -z "${sourcepath}" || -z "${arch}" ]]; then
- echo "Usage: $0 <build path> <source path> <arm64|x86_64>"
- exit 1
-fi
+readonly SUPPORTED_ARCHITECTURES=(arm64 armv7 x86_64 i386)
+readonly SUPPORTED_TARGETS=(firebase_admob firebase_analytics firebase_auth firebase_database firebase_dynamic_links firebase_firestore firebase_functions firebase_instance_id firebase_messaging firebase_remote_config firebase_storage)
 
-if [[ "${arch}" == "x86_64" ]]; then
- toolchain="cmake/toolchains/ios_simulator.cmake"
-elif [[ "${arch}" == "arm64" ]]; then
- toolchain="cmake/toolchains/ios.cmake"
-else
- echo "Invalid architecture: '${arch}'"
- exit 2
-fi
+# build default value
+buildpath="ios_build"
+sourcepath="."
+architectures=("${SUPPORTED_ARCHITECTURES[@]}")
+targets=("${SUPPORTED_TARGETS[@]}")
+generateMakefiles=true
+cmakeBuild=true
 
-if [[ ! -d "${sourcepath}" ]]; then
- echo "Source path '${sourcepath}' not found."
- exit 2
-fi
+# check options
+IFS=',' # split options on ',' characters
+while getopts ":b:s:a:t:g:c" opt; do
+ case $opt in
+ b)
+ buildpath=$OPTARG
+ ;;
+ s)
+ sourcepath=$OPTARG
+ if [[ ! -d "${sourcepath}" ]]; then
+ echo "Source path ${sourcepath} not found."
+ exit 2
+ fi
+ ;;
+ 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
+ ;;
+ t)
+ targets=($OPTARG)
+ for t in ${targets[@]}; do
+ if [[ ! " ${SUPPORTED_TARGETS[@]} " =~ " ${t} " ]]; then
+ echo "invalid target: ${t}"
+ echo "Supported targets are: ${SUPPORTED_TARGETS[@]}"
+ exit 2
+ fi
+ done
+ ;;
+ g)
+ if [[ $OPTARG == true ]]; then
+ generateMakefiles=true
+ else
+ generateMakefiles=false
+ fi
+ ;;
+ c)
+ if [[ $OPTARG == true ]]; then
+ cmakeBuild=true
+ else
+ cmakeBuild=false
+ fi
+ ;;
+ *)
+ echo "unknow parameter"
+ exit 2
+ ;;
+ esac
+done
+echo "build path: ${buildpath}"
+echo "source path: ${sourcepath}"
+echo "build architectures: ${architectures[@]}"
+echo "build targets: ${targets[@]}"
+echo "generate Makefiles: ${generateMakefiles}"
+echo "CMake Build: ${cmakeBuild}"
+sourcepath=$(cd ${sourcepath} && pwd) #full path
+buildpath=$(mkdir -p ${buildpath} && cd ${buildpath} && pwd) #full path
 
-mkdir -p "${buildpath}"
-cd "${buildpath}"
-if [[ -n $(ls) ]]; then
- echo "Error: build path '${buildpath}' not empty."
- exit 2
+# generate Makefiles for each architecture and target
+frameworkspath="frameworks/ios"
+if ${generateMakefiles}; then
+ for arch in ${architectures[@]}; do 
+ echo "generate Makefiles start"
+ mkdir -p ${buildpath}/ios_build_file/${arch} && cd ${buildpath}/ios_build_file/${arch}
+ if [[ "${arch}" == "arm64" || "${arch}" == "armv7" ]]; then
+ toolchain="cmake/toolchains/ios.cmake"
+ elif [[ "${arch}" == "x86_64" || "${arch}" == "i386" ]]; then
+ toolchain="cmake/toolchains/ios_simulator.cmake"
+ fi
+ cmake -DCMAKE_TOOLCHAIN_FILE=${sourcepath}/${toolchain} \
+ -DCMAKE_OSX_ARCHITECTURES=${arch} \
+ -DCMAKE_ARCHIVE_OUTPUT_DIRECTORY=${buildpath}/${frameworkspath}/${arch} \
+ ${sourcepath}
+ echo "generate Makefiles end"
+ done
 fi
-cd -
 
-set -ex
+# build framework for each architecture and target
+if ${cmakeBuild}; then
+ for arch in ${architectures[@]}; do 
+ {
+ cd ${buildpath}/ios_build_file/${arch}
+ echo "build ${arch} ${targets[@]} framework start"
+ cmake --build . --target ${targets[@]}
+ echo "build ${arch} ${targets[@]} framework end"
+
+ } &
+ done
+ wait
+ echo "${architectures[@]} frameworks build end"
+
+ # arrange the framework 
+ IFS=$'\n' # split $(ls) on \n characters
+ cd ${buildpath}/${frameworkspath}
+ for arch in ${architectures[@]}; do
+ # rename firebase_app to firebase
+ if [[ ! -d "${arch}/firebase.framework" ]]; then
+ cp -r ${arch}/firebase_app.framework ${arch}/firebase.framework
+ mv ${arch}/firebase.framework/firebase_app ${arch}/firebase.framework/firebase
+ rm ${arch}/firebase.framework/Info.plist
+ fi
 
-cmake -GXcode "-DCMAKE_TOOLCHAIN_FILE=$toolchain" -S "${sourcepath}" -B "${buildpath}"
-cmake --build "${buildpath}"
+ # delete useless Info.plist
+ for target in ${targets[@]}; do
+ if [[ -f "${arch}/${target}.framework/Info.plist" ]]; then
+ rm ${arch}/${target}.framework/Info.plist
+ fi
+ done
+
+ # delete non-framework dir
+ for dir in $(ls ${arch}); do
+ if [[ ! ${dir} =~ ".framework" ]]; then
+ rm -rf ${arch}/${dir}
+ fi
+ done
+ done
+ echo "${architectures[@]} frameworks ready to use"
+
+ # if we built for all architectures (arm64 armv7 x86_64 i386)
+ # build universal framework as well
+ if [[ ${#architectures[@]} < ${#SUPPORTED_ARCHITECTURES[@]} ]]; then
+ exit 0
+ fi
+
+ targets+=('firebase')
+ for target in ${targets[@]}; do
+ mkdir -p universal/${target}.framework
+ libsubpath="${target}.framework/${target}"
+ if [[ -f "${SUPPORTED_ARCHITECTURES[0]}/${libsubpath}" ]]; then
+ lipo -create "${SUPPORTED_ARCHITECTURES[0]}/${libsubpath}" \
+ "${SUPPORTED_ARCHITECTURES[1]}/${libsubpath}" \
+ "${SUPPORTED_ARCHITECTURES[2]}/${libsubpath}" \
+ "${SUPPORTED_ARCHITECTURES[3]}/${libsubpath}" \
+ -output "universal/${libsubpath}"
+ fi
+ done
+ if [[ ! -d "universal/firebase.framework/Headers" ]]; then
+ cp -R ${SUPPORTED_ARCHITECTURES[0]}/firebase.framework/Headers universal/firebase.framework
+ fi
+ echo "universal frameworks build end & ready to use"
+fi

cmake/toolchains/ios_simulator.cmake

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 set(CMAKE_OSX_SYSROOT iphonesimulator)
-set(CMAKE_OSX_ARCHITECTURES x86_64)
+set(CMAKE_OSX_ARCHITECTURES x86_64 CACHE STRING "")
 set(CMAKE_XCODE_EFFECTIVE_PLATFORMS "-iphonesimulator")
 set(CMAKE_XCODE_ATTRIBUTE_CODE_SIGNING_REQUIRED "NO")
 set(CMAKE_XCODE_ATTRIBUTE_ENABLE_BITCODE "YES")