Skip to content

building.md

Latest commit

 

History

History
156 lines (126 loc) · 9.33 KB

building.md

File metadata and controls

156 lines (126 loc) · 9.33 KB

Building Application Services

When working on Application Services, it's important to set up your environment for building the Rust code and the Android or iOS code needed by the application.

First time builds

Building for the first time is more complicated than a typical Rust project. To build for an end-to-end experience that enables you to test changes in client applications like Firefox for Android (Fenix) and Firefox iOS, there are a number of build systems required for all the dependencies. The initial setup is likely to take a number of hours to complete.

Building the Rust Components

Complete this section before moving to the android/iOS build instructions.

  1. Make sure you cloned the repository:
  $ git clone https://github.com/mozilla/application-services # (or use the ssh link)
  $ cd application-services
  $ git submodule update --init --recursive

  1. Install Rust: install via rustup

  2. Install your system dependencies:

    Linux

    1. Install the system dependencies required for building NSS

      1. Install gyp: apt install gyp (required for NSS)
      2. Install ninja-build: apt install ninja-build
      3. Install python3 (at least 3.6): apt install python3
      4. Install zlib: apt install zlib1g-dev
      5. Install perl (needed to build openssl): apt install perl
      6. Install patch (to build the libs): apt install patch

    2. Install the system dependencies required for SQLcipher

      1. Install tcl: apt install tclsh (required for SQLcipher)

    3. Install the system dependencies required for bindgen

      1. Install libclang: apt install libclang-dev

    MacOS

    1. Install Xcode: check the ci config for the correct version.
    2. Install Xcode tools: xcode-select --install
    3. Install homebrew via its installation instructions (it's what we use for ci).
    4. Install the system dependencies required for building NSS:
      1. Install ninja and python: brew install ninja python
      2. Make sure which python3 maps to the freshly installed homebrew python.
        1. If it isn't, add the following to your bash/zsh profile and source the profile before continuing: 
          alias python3=$(brew --prefix)/bin/python3
        2. Ensure python maps to the same Python version. You may have to create a symlink: 
          PYPATH=$(which python3); ln -s $PYPATH `dirname $PYPATH`/python
      3. Install gyp: 
        wget https://bootstrap.pypa.io/ez_setup.py -O - | python3 -
git clone https://chromium.googlesource.com/external/gyp.git ~/tools/gyp
cd ~/tools/gyp
pip install .
        1. Add ~/tools/gyp to your path: 
          export PATH="~/tools/gyp:$PATH"
        2. If you have additional questions, consult this guide.
      4. Make sure your homebrew python's bin folder is on your path by updating your bash/zsh profile with the following: 
        export PATH="$PATH:$(brew --prefix)/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/bin"

    Windows

    Install windows build tools

    Why Windows Subsystem for Linux (WSL)?

    It's currently tricky to get some of these builds working on Windows, primarily due to our use of SQLcipher. By using WSL it is possible to get builds working, but still have them published to your "native" local maven cache so it's available for use by a "native" Android Studio.

    1. Install WSL (recommended over native tooling)
    2. Install unzip: sudo apt install unzip
    3. Install python3: sudo apt install python3 Note: must be python 3.6 or later
    4. Install system build tools: sudo apt install build-essential
    5. Install zlib: sudo apt-get install zlib1g-dev
    6. Install tcl: sudo apt install tcl-dev

  3. Build the required NSS libraries.

  4. Check dependencies and environment variables by running: ./libs/verify-desktop-environment.sh

Note that this script might instruct you to set some environment variables, set those by adding them to your .zshrc or .bashrc so they are set by default on your terminal. If it does so instruct you, you must run the command again after setting them so the libraries are built.

  1. Run cargo test: cargo test

Once you have successfully run ./libs/verify-desktop-environment.sh and cargo test you can move to the Building for Fenix and Building for iOS sections below to setup your local environment for testing with our client applications.

Building for Fenix

The following instructions assume that you are building application-services for Fenix, and want to take advantage of the Fenix Auto-publication workflow for android-components and application-services.

  1. Install Android SDK, JAVA, NDK and set required env vars
    1. Bootstrap a Firefox for Android environment (not inside the Application Service repository).
    2. Download and install Android Studio.
    3. Configure Android Studio to use the bootstrapped SDK under Settings > Languages & Frameworks > Android SDK, set it to the SDK from mozbuild. Ex: ~/.mozbuild/android-sdk-linux or ~/.mozbuild/android-sdk-macos
    4. Download the required NDK and command-line tools under Settings > Languages & Frameworks > Android SDK > SDK Tools. Pick:
      1. NDK (Side by side) version 29.0.14206865 as configured
      2. Android SDK Command-line Tools (latest)
    5. Set environment variables based on the boostrapped code and the downloaded NDK. Add it to your rc file (either .zshrc or .bashrc depending on your shell) to make it permanent
      1. Set JAVA_HOME to point to the bootstraped JDK 17 installation directory. Ex: export JAVA_HOME=~/.mozbuild/jdk/jdk-17.0.18+8/
      2. Set ANDROID_HOME to the bootstraped Android SDK. Ex: export ANDROID_HOME=~/.mozbuild/android-sdk-linux
      3. Set NSS_STATIC to 1. Ex: export NSS_STATIC=1
      4. Set NSS_DIR to your local NSS folder. Ex: export NSS_DIR=~/Mozilla/application-services/libs/desktop/linux-x86-64/nss
      5. Set ANDROID_NDK_ROOT to the NDK you downloaded via Android Studio, Ex: export ANDROID_NDK_ROOT=~/.mozbuild/android-sdk-linux/ndk/29.0.14206865
  2. If you are on Windows using WSL - drop to the section below, Windows setup for Android (WSL) before proceeding.
  3. Check dependencies, environment variables
    1. Run ./libs/verify-android-environment.sh
    2. Follow instructions and rerun until it is successful.

Note: If you opened the application-services or Firefox repos in Android Studio, it likely added a local.properties or gradle-daemon-jvm.properties file that could override some of the environment variables above. If you experience build errors, correct or delete these values in the local.properties files.

Windows setup for Android (via WSL)

Note: For non-Ubuntu linux versions, it may be necessary to execute $ANDROID_HOME/tools/bin/sdkmanager "build-tools;26.0.2" "platform-tools" "platforms;android-26" "tools". See also this gist for additional information.

Configure Maven

Configure maven to use the native windows maven repository - then, when doing ./gradlew install from WSL, it ends up in the Windows maven repo. This means we can do a number of things with Android Studio in "native" windows and have then work correctly with stuff we built in WSL.

  1. Install maven: sudo apt install maven
  2. Confirm existence of (or create) a ~/.m2 folder
  3. In the ~/.m2 create a file called settings.xml
  4. Add the content below replacing {username} with your username:
    <settings>
      <localRepository>/mnt/c/Users/{username}/.m2/repository</localRepository>
    </settings>

Building for Firefox iOS

  1. Install xcpretty: gem install xcpretty

  2. Run ./libs/verify-ios-environment.sh to check your setup and environment variables.

    • Make any corrections recommended by the script and re-run.

  3. Run ./automation/build_ios_artifacts.sh to build all the binaries, UniFFi bindings, Glean metrics generation

    Note: The artifacts generated in the above steps can then be used in any consuming product

Locally building Firefox iOS against a local Application Services

Detailed steps to build Firefox iOS against a local application services can be found this document