Added script to build iOS framework archive for distribution via CocoaPods

This commit is contained in:
Prianka Liz Kariat 2023-04-19 01:19:08 +05:30
parent ddbdb88415
commit 3553eac375

View File

@ -0,0 +1,149 @@
#!/usr/bin/env bash
# Copyright 2023 The MediaPipe Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Set the following variables as appropriate.
# * BAZEL: path to bazel. defaults to the first one available in PATH
# * FRAMEWORK_NAME: name of the iOS framework to be built. Currently the
# * accepted values are TensorFlowLiteTaskVision, TensorFlowLiteTaskText.
# * MPP_BUILD_VERSION: to specify the release version. defaults to 0.0.1-dev
# * IS_RELEASE_BUILD: set as true if this build should be a release build
# * ARCHIVE_FRAMEWORK: set as true if the framework should be archived
# * DEST_DIR: destination directory to which the framework will be copied
set -ex
if [[ "$(uname)" != "Darwin" ]]; then
echo "This build script only works on macOS."
exit 1
fi
BAZEL="${BAZEL:-$(which bazel)}"
MPP_BUILD_VERSION=${MPP_BUILD_VERSION:-0.0.1-dev}
MPP_ROOT_DIR=$(git rev-parse --show-toplevel)
MEDIAPIPE_DISABLE_GPU=1
if [[ ! -x "${BAZEL}" ]]; then
echo "bazel executable is not found."
exit 1
fi
if [ -z ${FRAMEWORK_NAME+x} ]; then
echo "Name of the iOS framework, which is to be built, must be set."
exit 1
fi
case $FRAMEWORK_NAME in
"MediaPipeTaskText")
;;
*)
echo "Wrong framework name. The following framework names are allowed: MediaPipeTaskText"
exit 1
;;
esac
if [[ -z "${DEST_DIR+x}" || "${DEST_DIR}" == ${MPP_ROOT_DIR}* ]]; then
echo "DEST_DIR variable must be set and not be under the repository root."
exit 1
fi
# This function takes one bazel target label as an argument, and prints
# the path of the first output file of the specified target.
function get_output_file_path {
local STARLARK_OUTPUT_TMPDIR="$(mktemp -d)"
local STARLARK_FILE="${STARLARK_OUTPUT_TMPDIR}/print_output_file.starlark"
cat > "${STARLARK_FILE}" << EOF
def format(target):
return target.files.to_list()[0].path
EOF
local OUTPUT_PATH=$(bazel cquery $1 --output=starlark --starlark:file="${STARLARK_FILE}" 2> /dev/null)
# Clean up the temporary directory for bazel cquery.
rm -rf "${STARLARK_OUTPUT_TMPDIR}"
echo ${OUTPUT_PATH}
}
# This function builds the iOS task .xcframework.
function build_ios_api_framework {
local TARGET_PREFIX="//mediapipe/tasks/ios"
FULL_FRAMEWORK_TARGET="${TARGET_PREFIX}:${FRAMEWORK_NAME}_framework"
FULL_GRAPH_LIBRARY_TARGET="${TARGET_PREFIX}:${FRAMEWORK_NAME}_GraphLibrary"
local FRAMEWORK_CQUERY_COMMAND="-c opt --config=darwin_arm64 --apple_generate_dsym=false \
--define=MEDIAPIPE_DISABLE_GPU=${MEDIAPIPE_DISABLE_GPU} ${FULL_FRAMEWORK_TARGET}"
"${BAZEL}" build ${FRAMEWORK_CQUERY_COMMAND}
local IOS_FRAMEWORK_PATH="$(get_output_file_path "${FRAMEWORK_CQUERY_COMMAND}")"
echo ${IOS_FRAMEWORK_PATH}
}
function create_framework_archive {
# Change to the Bazel iOS output directory.
pushd "${BAZEL_IOS_OUTDIR}"
# Create the temporary directory for the given framework.
local ARCHIVE_NAME="${FRAMEWORK_NAME}-${MPP_BUILD_VERSION}"
local MPP_TMPDIR="$(mktemp -d)"
# Copy the license file to MPP_TMPDIR
cp "LICENSE" ${MPP_TMPDIR}
local FRAMEWORKS_DIR="${MPP_TMPDIR}/frameworks"
# Unzip the iOS framework zip generated by bazel to MPP_TMPDIR
echo "$1"
unzip "$1" -d "${FRAMEWORKS_DIR}"
#----- (3) Move the framework to the destination -----
if [[ "${ARCHIVE_FRAMEWORK}" == true ]]; then
local TARGET_DIR="$(realpath "${FRAMEWORK_NAME}")"
# Create the framework archive directory.
local FRAMEWORK_ARCHIVE_DIR
if [[ "${IS_RELEASE_BUILD}" == true ]]; then
# Get the first 16 bytes of the sha256 checksum of the root directory.
local SHA256_CHECKSUM=$(find "${MPP_TMPDIR}" -type f -print0 | xargs -0 shasum -a 256 | sort | shasum -a 256 | cut -c1-16)
FRAMEWORK_ARCHIVE_DIR="${TARGET_DIR}/${MPP_BUILD_VERSION}/${SHA256_CHECKSUM}"
else
FRAMEWORK_ARCHIVE_DIR="${TARGET_DIR}/${MPP_BUILD_VERSION}"
fi
mkdir -p "${FRAMEWORK_ARCHIVE_DIR}"
# Zip up the framework and move to the archive directory.
pushd "${MPP_TMPDIR}"
local MPP_ARCHIVE_FILE="${ARCHIVE_NAME}.tar.gz"
tar -cvzf "${MPP_ARCHIVE_FILE}" .
mv "${MPP_ARCHIVE_FILE}" "${FRAMEWORK_ARCHIVE_DIR}"
popd
# Move the target directory to the Kokoro artifacts directory.
mv "${TARGET_DIR}" "$(realpath "${DEST_DIR}")"/
else
rsync -r "${MPP_TMPDIR}/" "$(realpath "${DEST_DIR}")/"
fi
# Clean up the temporary directory for the framework.
rm -rf "${MPP_TMPDIR}"
echo ${MPP_TMPDIR}
}
cd "${MPP_ROOT_DIR}"
IOS_API_FRAMEWORK_PATH="$(build_ios_api_framework)"
create_framework_archive "${IOS_API_FRAMEWORK_PATH}"