Install on GitHub¶

For use within a GitHub Action workflow, a simple action named canonical/anbox-cloud-github-action is available. This action can be easily integrated into existing workflows and it will install and configure the Anbox Cloud Appliance for direct use on a GitHub runner.

Prerequisites¶

A repository on GitHub which can host GitHub Action workflows
The token for your Ubuntu Pro subscription

Create a new workflow¶

One example of where this GitHub Action could be helpful is when setting up a new workflow to run integration tests for an Android application. In this case, the action can be used as one of the first steps before the actual test is executed. The example workflow below implements the following steps:

Set up Anbox Cloud
Create a new Android 15 instance and configure it to allow external ADB access
Connect the instance to ADB running on the host of the runner
Perform a simple test to check the ro.product.model property for a specified value

The workflow runs only on push trigger because access to a repository secret is required, which should not be granted on pull requests for security reasons. See here for more details.

name: Run integration tests
on: push
jobs:
  run-tests:
    runs-on: ubuntu-latest
    steps:
    - name: Setup Anbox Cloud
      # For best security replace "main" with the latest git revision of the
      # repository from https://github.com/canonical/anbox-cloud-github-action
      uses: canonical/anbox-cloud-github-action@main
      with:
        channel: latest/stable
        ubuntu-pro-token: ${{ secrets.UBUNTU_PRO_TOKEN }}
    - name: Create Android instance
      id: create-instance
      env:
        ANDROID_VERSION: 15
        # If you want Android running in a VM instead of a system container
        USE_VM: false
      run: |
        arch=amd64
        if [ "$(uname -m)" = aarch64 ]; then
          arch=arm64
        fi

        args=()
        if [ "$USE_VM" = true ]; then
          args+=(--vm)
        fi

        image=jammy:android"$ANDROID_VERSION":"$arch"
        id="$(amc launch -r -s adb "${args[@]}" --name android0 "$image")"
        amc wait -c status=running "$id"
        echo "id=$id" >> "$GITHUB_OUTPUT"
    - name: Access Android over ADB
      run: |
        sudo apt install -y adb
        id=${{ steps.create-instance.outputs.id }}
        addr="$(amc show "$id" --format=json | jq -r .network.address)"
        adb connect "$addr":5559
    - name: Run tests
      run: |
        test "$(adb shell getprop ro.product.model)" = Anbox

Alternatively, you can also integrate the execution of actual integration tests in the test step. As the Android instance is connected over ADB, you can perform any operation as with any other connected Android device.