Update the Android development enviornment setup

1. Update `ANDROID_SDK_ROOT` to `ANDROID_HOME`. The former variable is
   deprecated. (see https://developer.android.com/tools/variables#envar)
2. Remove `ANDROID_NDK_HOME` environment variable. This should allow the
   build script to work out of the box for more folks.
3. Check that Java is on the `PATH` as opposed to just installing it.
   `asdf` and other runtime management tools are pretty popular, and all
   we care about is that the Java version is accessible.
4. Remove calls to `sudo`. Check to see if CocoaPods exists, if it
   doesn't install it using Homebrew which doesn't require `sudo`.
This commit is contained in:
Salvatore Testa 2023-11-12 13:47:17 -08:00
parent 7d1b789d38
commit 38d9610c6b
No known key found for this signature in database
8 changed files with 69 additions and 81 deletions

1
.gitignore vendored
View File

@ -234,6 +234,7 @@ cython_debug/
veilid-python/demo/.demokeys veilid-python/demo/.demokeys
.vscode/ .vscode/
.idea/
## Ignore emacs backup files ## Ignore emacs backup files
~* ~*

View File

@ -63,13 +63,12 @@ sdkmanager --install "cmake;3.22.1"
``` ```
Export environment variables and add the Android SDK platform-tools directory to Export environment variables and add the Android SDK platform-tools directory to
your path. your path. See [instructions here](https://developer.android.com/tools/variables).
```shell ```shell
cat << EOF >> ~/.profile cat << EOF >> ~/.profile
export ANDROID_SDK_ROOT=<path to sdk> export ANDROID_HOME=<path to sdk>
export ANDROID_NDK_HOME=$ANDROID_SDK_ROOT/ndk/25.1.8937393 export PATH=$PATH:$ANDROID_HOME/tools:$ANDROID_HOME/tools/bin:$ANDROID_HOME/platform-tools
export PATH=\$PATH:$ANDROID_SDK_ROOT/platform-tools
EOF EOF
``` ```
@ -119,13 +118,12 @@ to maintain your Android dependencies. Use the SDK Manager in the IDE to install
#### Setup command line environment #### Setup command line environment
Export environment variables and add the Android SDK platform-tools directory to Export environment variables and add the Android SDK platform-tools directory to
your path. your path. See [instructions here](https://developer.android.com/tools/variables).
```shell ```shell
cat << EOF >> ~/.zshenv cat << EOF >> ~/.zshenv
export ANDROID_SDK_ROOT=$HOME/Library/Android/sdk export ANDROID_HOME=$HOME/Library/Android/sdk
export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk/25.1.8937393 export PATH=$PATH:$ANDROID_HOME/tools:$ANDROID_HOME/tools/bin:$ANDROID_HOME/platform-tools
export PATH=\$PATH:$HOME/Library/Android/sdk/platform-tools
EOF EOF
``` ```

View File

@ -9,20 +9,20 @@ fi
if [ ! -z "$(command -v apt)" ]; then if [ ! -z "$(command -v apt)" ]; then
# Install APT dependencies # Install APT dependencies
sudo apt update -y sudo apt update -y
sudo apt install -y openjdk-11-jdk-headless iproute2 curl build-essential cmake libssl-dev openssl file git pkg-config libdbus-1-dev libdbus-glib-1-dev libgirepository1.0-dev libcairo2-dev checkinstall unzip llvm wabt python3-pip sudo apt install -y openjdk-17-jdk-headless iproute2 curl build-essential cmake libssl-dev openssl file git pkg-config libdbus-1-dev libdbus-glib-1-dev libgirepository1.0-dev libcairo2-dev checkinstall unzip llvm wabt python3-pip
elif [ ! -z "$(command -v dnf)" ]; then elif [ ! -z "$(command -v dnf)" ]; then
# DNF (formerly yum) # DNF (formerly yum)
sudo dnf update -y sudo dnf update -y
# libgirepository -> gobject-introspection # libgirepository -> gobject-introspection
# iproute2 -> iproute # iproute2 -> iproute
# openjdk-11-jdk-headless -> java-11-openjdk-headless # openjdk-17-jdk-headless -> java-11-openjdk-headless
# checkinstall does not appear to be a thing in Fedora 38 repos # checkinstall does not appear to be a thing in Fedora 38 repos
# #
# Seems like iproute and file might come preinstalled but I put # Seems like iproute and file might come preinstalled but I put
# them in anyway # them in anyway
# #
# Also Fedora doesn't come with pip # Also Fedora doesn't come with pip
sudo dnf install -y java-11-openjdk-headless iproute curl cmake openssl-devel openssl git file pkg-config dbus-devel dbus-glib gobject-introspection-devel cairo-devel unzip llvm wabt python3-pip gcc-c++ sudo dnf install -y java-17-openjdk-headless iproute curl cmake openssl-devel openssl git file pkg-config dbus-devel dbus-glib gobject-introspection-devel cairo-devel unzip llvm wabt python3-pip gcc-c++
# build-essentials # build-essentials
sudo dnf groupinstall -y 'Development Tools' sudo dnf groupinstall -y 'Development Tools'
fi fi
@ -50,8 +50,7 @@ rm -rf $HOME/Android/cmdline-tools $HOME/Android/cmdline-tools.zip
cat >> $HOME/.profile <<END cat >> $HOME/.profile <<END
source "\$HOME/.cargo/env" source "\$HOME/.cargo/env"
export PATH=\$PATH:\$HOME/Android/Sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64/bin:\$HOME/Android/Sdk/platform-tools:\$HOME/Android/Sdk/cmdline-tools/latest/bin export PATH=\$PATH:\$HOME/Android/Sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64/bin:\$HOME/Android/Sdk/platform-tools:\$HOME/Android/Sdk/cmdline-tools/latest/bin
export ANDROID_NDK_HOME=\$HOME/Android/Sdk/ndk/25.1.8937393 export ANDROID_HOME=\$HOME/Android/Sdk
export ANDROID_SDK_ROOT=\$HOME/Android/Sdk
END END
break ;; break ;;
[nN] ) echo Skipping Android SDK; [nN] ) echo Skipping Android SDK;

View File

@ -24,31 +24,24 @@ while true; do
case $response in case $response in
[yY] ) echo Checking android setup...; [yY] ) echo Checking android setup...;
# ensure ANDROID_SDK_ROOT is defined and exists # ensure ANDROID_HOME is defined and exists
if [ -d "$ANDROID_SDK_ROOT" ]; then if [ -d "$ANDROID_HOME" ]; then
echo '[X] $ANDROID_SDK_ROOT is defined and exists' echo '[X] $ANDROID_HOME is defined and exists'
else else
echo '$ANDROID_SDK_ROOT is not defined or does not exist' echo '$ANDROID_HOME is not defined or does not exist'
exit 1 exit 1
fi fi
# ensure Android Command Line Tools exist # ensure Android Command Line Tools exist
if [ -d "$ANDROID_SDK_ROOT/cmdline-tools/latest/bin" ]; then if [ -d "$ANDROID_HOME/cmdline-tools/latest/bin" ]; then
echo '[X] Android command line tools are installed' echo '[X] Android command line tools are installed'
else else
echo 'Android command line tools are not installed' echo 'Android command line tools are not installed'
exit 1 exit 1
fi fi
# ensure ANDROID_NDK_HOME is defined and exists
if [ -d "$ANDROID_NDK_HOME" ]; then
echo '[X] $ANDROID_NDK_HOME is defined and exists'
else
echo '$ANDROID_NDK_HOME is not defined or does not exist'
exit 1
fi
# ensure ndk is installed # ensure ndk is installed
ANDROID_NDK_HOME="$ANDROID_HOME/ndk/25.1.8937393"
if [ -f "$ANDROID_NDK_HOME/ndk-build" ]; then if [ -f "$ANDROID_NDK_HOME/ndk-build" ]; then
echo '[X] Android NDK is installed at the location $ANDROID_NDK_HOME' echo '[X] Android NDK is installed at the location $ANDROID_NDK_HOME'
else else
@ -57,7 +50,7 @@ while true; do
fi fi
# ensure cmake is installed # ensure cmake is installed
if [ -d "$ANDROID_SDK_ROOT/cmake" ]; then if [ -d "$ANDROID_HOME/cmake" ]; then
echo '[X] Android SDK CMake is installed' echo '[X] Android SDK CMake is installed'
else else
echo 'Android SDK CMake is not installed' echo 'Android SDK CMake is not installed'
@ -65,7 +58,7 @@ while true; do
fi fi
# ensure emulator is installed # ensure emulator is installed
if [ -d "$ANDROID_SDK_ROOT/emulator" ]; then if [ -d "$ANDROID_HOME/emulator" ]; then
echo '[X] Android SDK emulator is installed' echo '[X] Android SDK emulator is installed'
else else
echo 'Android SDK emulator is not installed' echo 'Android SDK emulator is not installed'

View File

@ -13,16 +13,16 @@ while true; do
read -p "Did you install Android SDK? Y/N " response read -p "Did you install Android SDK? Y/N " response
case $response in case $response in
[yY] ) echo Checking android setup...; [yY] ) echo Checking android setup...;
# ensure ANDROID_SDK_ROOT is defined and exists # ensure ANDROID_HOME is defined and exists
if [ -d "$ANDROID_SDK_ROOT" ]; then if [ -d "$ANDROID_HOME" ]; then
echo '[X] $ANDROID_SDK_ROOT is defined and exists' echo '[X] $ANDROID_HOME is defined and exists'
else else
echo '$ANDROID_SDK_ROOT is not defined or does not exist' echo '$ANDROID_HOME is not defined or does not exist'
exit 1 exit 1
fi fi
# ensure Android Command Line Tools exist # ensure Android Command Line Tools exist
if [ -d "$ANDROID_SDK_ROOT/cmdline-tools/latest/bin" ]; then if [ -d "$ANDROID_HOME/cmdline-tools/latest/bin" ]; then
echo '[X] Android command line tools are installed' echo '[X] Android command line tools are installed'
else else
echo 'Android command line tools are not installed' echo 'Android command line tools are not installed'
@ -30,13 +30,14 @@ while true; do
fi fi
# ensure Android SDK packages are installed # ensure Android SDK packages are installed
$ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager build-tools\;33.0.1 ndk\;25.1.8937393 cmake\;3.22.1 platform-tools platforms\;android-33 $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager build-tools\;33.0.1 ndk\;25.1.8937393 cmake\;3.22.1 platform-tools platforms\;android-33
# ensure ANDROID_NDK_HOME is defined and exists # ensure ANDROID_NDK_HOME is defined and exists
ANDROID_NDK_HOME="$ANDROID_HOME/ndk/25.1.8937393"
if [ -d "$ANDROID_NDK_HOME" ]; then if [ -d "$ANDROID_NDK_HOME" ]; then
echo '[X] $ANDROID_NDK_HOME is defined and exists' echo '[X] Android NDK is defined and exists'
else else
echo '$ANDROID_NDK_HOME is not defined or does not exist' echo 'Android NDK is not defined or does not exist'
exit 1 exit 1
fi fi
@ -49,7 +50,7 @@ while true; do
fi fi
# ensure cmake is installed # ensure cmake is installed
if [ -d "$ANDROID_SDK_ROOT/cmake" ]; then if [ -d "$ANDROID_HOME/cmake" ]; then
echo '[X] Android SDK CMake is installed' echo '[X] Android SDK CMake is installed'
else else
echo 'Android SDK CMake is not installed' echo 'Android SDK CMake is not installed'
@ -57,7 +58,7 @@ while true; do
fi fi
# ensure emulator is installed # ensure emulator is installed
if [ -d "$ANDROID_SDK_ROOT/emulator" ]; then if [ -d "$ANDROID_HOME/emulator" ]; then
echo '[X] Android SDK emulator is installed' echo '[X] Android SDK emulator is installed'
else else
echo 'Android SDK emulator is not installed' echo 'Android SDK emulator is not installed'
@ -119,26 +120,31 @@ else
exit 1 exit 1
fi fi
# ensure Java 17 is the active version
JAVA_VERSION=$(java -version 2>&1 | head -n 1 | cut -d\" -f2)
if [ "$JAVA_VERSION" == "17" ]; then
echo '[X] Java 17 is available in the path'
else
echo 'Java 17 is not available in the path'
exit 1
fi
# ensure we have command line tools # ensure we have command line tools
xcode-select --install 2> /dev/null || true xcode-select --install 2> /dev/null || true
until [ -d /Library/Developer/CommandLineTools/usr/bin ]; do until [ -d /Library/Developer/CommandLineTools/usr/bin ]; do
sleep 5; sleep 5;
done done
# ensure packages are installed # install packages
if [ "$BREW_USER" == "" ]; then # if $BREW_USER is set, run brew as that user, otherwise run it regularly
if [ -d /opt/homebrew ]; then # this allows for developers who have brew installed as a different user to run this script
BREW_USER=`ls -lad /opt/homebrew/. | cut -d\ -f4` if [ -z "$BREW_USER" ]; then
echo "Must sudo to homebrew user \"$BREW_USER\" to install capnp package:" BREW_COMMAND="brew"
elif [ -d /usr/local/Homebrew ]; then else
BREW_USER=`ls -lad /usr/local/Homebrew/. | cut -d\ -f4` BREW_COMMAND="sudo -H -u $BREW_USER brew"
echo "Must sudo to homebrew user \"$BREW_USER\" to install capnp package:"
else
echo "Homebrew is not installed in the normal place. Trying as current user"
BREW_USER=`whoami`
fi
fi fi
sudo -H -u $BREW_USER brew install capnp cmake wabt llvm openjdk@17 jq
$BREW_COMMAND install capnp cmake wabt llvm jq
# install targets # install targets
rustup target add aarch64-apple-darwin aarch64-apple-ios aarch64-apple-ios-sim x86_64-apple-darwin x86_64-apple-ios wasm32-unknown-unknown aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android rustup target add aarch64-apple-darwin aarch64-apple-ios aarch64-apple-ios-sim x86_64-apple-darwin x86_64-apple-ios wasm32-unknown-unknown aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
@ -149,5 +155,9 @@ cargo install wasm-bindgen-cli wasm-pack cargo-edit
# install pip packages # install pip packages
pip3 install --upgrade bumpversion pip3 install --upgrade bumpversion
echo Installing cocoapods. This may take a while. if command -v pod &> /dev/null; then
sudo gem install cocoapods echo '[X] CocoaPods is available in the path'
else
echo 'CocoaPods is not available in the path, installing it now'
$BREW_COMMAND install cocoapods
fi

View File

@ -14,17 +14,17 @@ AVD_TAG="google_atd"
AVD_IMAGE="system-images;android-30;$AVD_TAG;$ANDROID_ABI" AVD_IMAGE="system-images;android-30;$AVD_TAG;$ANDROID_ABI"
AVD_DEVICE="Nexus 10" AVD_DEVICE="Nexus 10"
SDKMANAGER=$ANDROID_SDK_ROOT/tools/bin/sdkmanager SDKMANAGER=$ANDROID_HOME/tools/bin/sdkmanager
AVDMANAGER=$ANDROID_SDK_ROOT/tools/bin/avdmanager AVDMANAGER=$ANDROID_HOME/tools/bin/avdmanager
if ! command -v $SDKMANAGER; then if ! command -v $SDKMANAGER; then
SDKMANAGER=$ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager SDKMANAGER=$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager
AVDMANAGER=$ANDROID_SDK_ROOT/cmdline-tools/latest/bin/avdmanager AVDMANAGER=$ANDROID_HOME/cmdline-tools/latest/bin/avdmanager
if ! command -v $SDKMANAGER; then if ! command -v $SDKMANAGER; then
echo "Can't find 'sdkmanager' in the usual places." echo "Can't find 'sdkmanager' in the usual places."
exit exit
fi fi
fi fi
EMULATOR=$ANDROID_SDK_ROOT/emulator/emulator EMULATOR=$ANDROID_HOME/emulator/emulator
if ! command -v $EMULATOR; then if ! command -v $EMULATOR; then
echo "Can't find 'emulator' in the usual places." echo "Can't find 'emulator' in the usual places."
exit exit
@ -35,7 +35,7 @@ $SDKMANAGER --install "$AVD_IMAGE"
# Make AVD # Make AVD
echo "no" | $AVDMANAGER --verbose create avd --force --name "$AVD_NAME" --package "$AVD_IMAGE" --tag "$AVD_TAG" --abi "$ANDROID_ABI" --device "$AVD_DEVICE" echo "no" | $AVDMANAGER --verbose create avd --force --name "$AVD_NAME" --package "$AVD_IMAGE" --tag "$AVD_TAG" --abi "$ANDROID_ABI" --device "$AVD_DEVICE"
# Run emulator # Run emulator
$ANDROID_SDK_ROOT/emulator/emulator -avd testavd -no-snapshot -no-boot-anim -no-window & $ANDROID_HOME/emulator/emulator -avd testavd -no-snapshot -no-boot-anim -no-window &
( trap exit SIGINT ; read -r -d '' _ </dev/tty ) ## wait for Ctrl-C ( trap exit SIGINT ; read -r -d '' _ </dev/tty ) ## wait for Ctrl-C
kill %1 kill %1
wait wait

View File

@ -96,8 +96,8 @@ fn fix_android_emulator() {
let target_arch = env::var("CARGO_CFG_TARGET_ARCH").unwrap(); let target_arch = env::var("CARGO_CFG_TARGET_ARCH").unwrap();
if target_arch == "x86_64" && target_os == "android" { if target_arch == "x86_64" && target_os == "android" {
let missing_library = "clang_rt.builtins-x86_64-android"; let missing_library = "clang_rt.builtins-x86_64-android";
let android_ndk_home = env::var("ANDROID_NDK_HOME").expect("ANDROID_NDK_HOME not set"); let android_home = env::var("ANDROID_HOME").expect("ANDROID_HOME not set");
let lib_path = glob(&format!("{android_ndk_home}/**/lib{missing_library}.a")) let lib_path = glob(&format!("{android_home}/ndk/25.1.8937393/**/lib{missing_library}.a"))
.expect("failed to glob") .expect("failed to glob")
.next() .next()
.expect("Need libclang_rt.builtins-x86_64-android.a") .expect("Need libclang_rt.builtins-x86_64-android.a")

View File

@ -59,26 +59,13 @@ if [ "$OS" == "linux" ]; then
flutter config --enable-linux-desktop --enable-android flutter config --enable-linux-desktop --enable-android
elif [ "$OS" == "macos" ]; then elif [ "$OS" == "macos" ]; then
# check if cocoapods is installed, if its not, install it
# # ensure x86_64 homebrew is installed if command -v pod &> /dev/null; then
# if [ -f /usr/local/bin/brew ] &> /dev/null; then echo '[X] CocoaPods is available in the path'
# echo '[X] x86_64 homebrew is available' else
# else echo 'CocoaPods is not available in the path, installing it now'
# echo 'x86_64 homebrew is not available, run this:' brew install cocoapods
# echo 'arch -x86_64 zsh' fi
# echo '/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"'
# exit 1
# fi
# ensure packages are installed
# if [ "$BREW_USER" == "" ]; then
# BREW_USER=`ls -lad /usr/local/bin/. | cut -d\ -f4`
# echo "Must sudo to homebrew user \"$BREW_USER\" to install LLVM package:"
# fi
# sudo -H -u $BREW_USER arch -x86_64 /usr/local/bin/brew install llvm
echo "Must sudo to root to install CocoaPods gem:"
# sudo arch -x86_64 gem install ffi
sudo arch -x86_64 gem install cocoapods
if [ "$(uname -p)" == "arm" ]; then if [ "$(uname -p)" == "arm" ]; then
sudo softwareupdate --install-rosetta --agree-to-license sudo softwareupdate --install-rosetta --agree-to-license