Measurement Kit for Android

This repository contains Measurement Kit for Android. That is, it contains the Java native interface (JNI) code as well as its Java counterpart.

How to integrate a release in your Android project

Using gradle

Add the following line to app/build.gradle's dependencies:

 dependencies {
+  api "org.openobservatory.measurement_kit:android-libs:$version"

Where $version is the version you want to use (e.g. 0.4.3-aar-3).

This is the approach that we follow in the android-example app.

Manually verifying digital signature

Apparently, it's not easy to automatically verify packages signature when downloading packages from jcenter using gradle. If you want to verify dependencies, proceed as follows:

1. download the latest AAR and its digital signature from our jcenter-hosted repository

2. verify the digital signature using gpg --verify <asc-file>

3. create the libs directory and move the AAR inside it

4. to the toplevel build.gradle add:

 allprojects {
   repositories {
     jcenter()
+    flatDir {
+      dirs 'libs'
+    }
   }
 }

5. to app/build.gradle add:

 dependencies {
+  api "org.openobservatory.measurement_kit:android-libs:$version"

Where $version is the version you have downloaded (e.g. 0.4.3-aar-3).

Development and preparing releases

We currently only support building from macOS.

Installing dependencies

1. add our tap

brew tap measurement-kit/measurement-kit

2. install dependencies with brew

brew install android-measurement-kit android-sdk generic-assets jq

3. install Android-platform components

sdkmanager --install ndk 'build-tools;29.0.3' 'platforms;android-29'

Updating dependencies

Upgrade dependencies installed using brew:

brew upgrade

Upgrade the Android platform:

sdkmanager --update

Environment variables

export ANDROID_HOME=/usr/local/Caskroom/android-sdk/<version>

Makefile targets

The Makefile is very short and self explanatory. By reading it, you should be able to understand in what order the scripts in the ./script are called. Also the scripts are quite simple and easy to follow.

Updating vendored dependencies

Make sure that the vendored dependencies (./android-libs/src/main/cpp/vendor) are all updated to the latest stable version.

Preparing the repository

make configure

Doing local development

Assuming you have a running emulator, you can run all instrumented functional tests on such emulator using:

./gradlew connectedAndroidTest

You can run a specific functional test using:

./gradlew connectedAndroidTest \
 -Pandroid.testInstrumentationRunnerArguments.class=io.android.mk.androidTests.<ClassName>

You can see the logcat of these tests with:

$ANDROID_SDK/platform-tools/adb logcat -c  # clean the logcat
$ANDROID_SDK/platform-tools/adb logcat     # show new logs

Creating the distribution

make dist

This will re-run make configure for you and then proceed at building the AAR and the POM files for JCenter.

Publishing a new release

Once you have built the AAR and the POM files, you should upload them to JCenter.