Skip to content

Building android userspace

Introduction

Tuxsuite already has the support for building android kernel builds. It has now extended support for building and testing android userspace on a real hardware as well using LAVA. Below is the required prerequisites and configuration that is needed to do android userspace build using Tuxsuite.

Prerequisites

  • Tuxsuite
  • build-definition.yaml ( single build)
  • plan (multiple build)

Build definition

Build-definition for building aosp is similar to what we already have for android kernel build except with some extra fields that needs to be set and passed in build-definition.yaml file.

  • lunch_target
  • build_type (user, userdebug, eng)
  • container: The container used by Docker to do the build.
  • name: (optional) Name of your choice.
  • sources:
    • android: Android repo source, its branch, manifest, build-config and its url to be provided under android field.
      • branch: (string)
      • manifest: (string)
      • url: (string)
      • build_config: (optional, string)
      • build_type: (string) user as default. can have values user, userdebug and eng.
      • bazel: (bool) false as default
      • lunch_target: (string)
      • group: (string) default as default
      • patchset_script: (string)
      • patchset_project: (string)

Sample Android userspace build definition example

artifacts: []
bblayers_conf: []
container: ubuntu-20.04
distro: null
environment: {}
envsetup: null
local_conf: []
machine: null
name: ""
sources:
  android:
    branch: main
    manifest: default.xml
    url: https://android.googlesource.com/platform/manifest
    lunch_target: db845c
    build_type: user
targets: null

{
  "artifacts": [],
  "bblayers_conf": [],
  "container": "ubuntu-20.04",
  "distro": null,
  "environment": {},
  "envsetup": null,
  "local_conf": [],
  "machine": null,
  "name": "",
  "sources": {
      "android": {
          "branch": "main",
          "manifest": "default.xml",
          "url": "https://android.googlesource.com/platform/manifest",
          "lunch_target": "db845c",
          "build_type": "user"
          }
    },
  "targets": null
}

Warning

Support for build definition files in JSON format is deprecated and will be removed in tuxsuite release v1.44.0 or not later than a release on 6th August, 2025. Please migrate to the YAML format. Build definition file artefacts in 'JSON' and 'YAML' format will be published prior to the deprecation. From >=v1.44.0 or the corresponding version after 6th August, 2025 only 'YAML' format build definition will be published."

Note

To build android userspace, field lunch_target should be passed in sources of build-definition file. It accepts the lunch target string. Also, the build_type should be passed which accepts values such as user, userdebug and eng as explained in https://source.android.com/docs/setup/build/building

Testing AOSP

To test an aosp image using real hardware, submit the request using the tuxsuite command line interface.

tuxsuite test submit --lab https://validation.linaro.org  --lava-test-plans-project lkft-android --device dragonboard-845c --parameters BUILD_REFERENCE_IMAGE_GZ_URL=https://storage.tuxsuite.com/public/demo/demo/oebuilds/2V0nEaGwAaJl0H127YvUm4wmovB/Image.gz --parameters TUXSUITE_BAKE_VENDOR_DOWNLOAD_URL=https://storage.tuxsuite.com/public/demo/demo/oebuilds/2V0nQ5Y1ikd82Z2dMMaYxQcHOW1/ --parameters LKFT_BUILD_CONFIG=lkft-d
b845c-aosp-master-mainline-gki --parameters IMAGE_SUPPORTED_VENDOR_BOOT=true

Above command will boot test dragonboard-845c device with provided general kernel image (BUILD_REFERENCE_IMAGE_GZ_URL) and vendor image (TUXSUITE_BAKE_VENDOR_DOWNLOAD_URL).

Note: Variables passed in --parameters option is referenced from lava-test-plan repository and from the respective lava test plan projects i.e lkft-android in this case.

Example plan

version: 1
name: dragonboard-845c build and boot test.
description: Demonstrate a build and boot test with dragonboard-845c via real hardware
jobs:
- name: android
  bake:
    - artifacts: []
      container: ubuntu-20.04
      name: ''
      sources:
        android:
          bazel: true
          branch: common-android-mainline
          build_config: "//common:db845c_dist"
          manifest: default.xml
          url: https://android.googlesource.com/kernel/manifest

  tests:
    - device: dragonboard-845c
      parameters: {BUILD_REFERENCE_IMAGE_GZ_URL: "https://storage.tuxsuite.com/public/linaro/lkft-android/oebuilds/2UUyDDQ9DLoebjDu1wTMZxkbb8G/Image.gz", TUXSUITE_BAKE_VENDOR_DOWNLOAD_URL: "$BUILD/", LKFT_BUILD_CONFIG: "lkft-db845c-aosp-master-mainline-gki", IMAGE_SUPPORTED_VENDOR_BOOT: True}

Note

Above plan has an android aosp build with a dependent test. We must have an already available general kernel image(gki) or vendor image URL to be passed in the plan file. Also if only download url is needed in a parameter, then it has to be passed as $BUILD/

Supported Tests

  • boot
  • CTS/VTS

The testcases found in ltp-testcases can be referred with its name and passed in --tests option in cli command for testing.