├── .github ├── CODEOWNERS ├── pull_request_template.md ├── renovate.json └── workflows │ ├── cache-images.yaml │ └── pr.yaml ├── README.md ├── action.yaml └── LICENSE.md /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # The Anbox team owns all for now 2 | * @canonical/anbox 3 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | ## Done 2 | 3 | [Summary of work items] 4 | 5 | ## QA 6 | 7 | [Steps for testing the changes] 8 | 9 | ## JIRA / Launchpad bug 10 | 11 | Fixes # 12 | 13 | ## Documentation 14 | 15 | Does this impact the team's internal or public documentation? If yes, has the relevant documentation been updated? 16 | -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:recommended", 5 | "helpers:pinGitHubActionDigestsToSemver", 6 | ":disableDependencyDashboard", 7 | ":ignoreUnstable", 8 | "group:allNonMajor" 9 | ], 10 | "packageRules": [ 11 | { 12 | "groupName": "GitHub actions", 13 | "matchManagers": [ 14 | "github-actions" 15 | ], 16 | "matchUpdateTypes": [ 17 | "digest", 18 | "patch", 19 | "minor", 20 | "major" 21 | ] 22 | } 23 | ] 24 | } 25 | -------------------------------------------------------------------------------- /.github/workflows/cache-images.yaml: -------------------------------------------------------------------------------- 1 | name: Cache Anbox Cloud images 2 | 3 | on: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: '0 10 * * *' 7 | 8 | jobs: 9 | cache-images: 10 | name: Cache Anbox Cloud images 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 14 | - name: Attach to Ubuntu Pro 15 | run: | 16 | sudo pro attach ${{ secrets.UBUNTU_PRO_TOKEN }} 17 | sudo pro enable anbox-cloud --access-only 18 | - name: Download images 19 | run: | 20 | image_server_auth="bearer:$(sudo cat /var/lib/ubuntu-advantage/private/machine-token.json | jq -r '.resourceTokens[] | select(.type=="anbox-images").token')" 21 | image_server_url=https://"$image_server_auth"@images.anbox-cloud.io/stable 22 | 23 | mkdir images 24 | image_name=jammy:android13:amd64 25 | item_type=image 26 | image_path="$(curl -s "$image_server_url"/streams/v1/images.json | \ 27 | jq -r "last(.products.\"$image_name\".versions[] | select(.items.\"${item_type}\" != null)).items.\"${item_type}\".path")" 28 | image_url="$image_server_url"/"$image_path" 29 | curl -s "$image_url" -o images/android13.tar.xz 30 | - name: Cache all images 31 | uses: actions/cache/save@5a3ec84eff668545956fd18022155c47e93e2684 # v4 32 | with: 33 | path: images 34 | key: anbox-images-amd64 35 | -------------------------------------------------------------------------------- /.github/workflows/pr.yaml: -------------------------------------------------------------------------------- 1 | name: Test action 2 | on: [push, pull_request, workflow_dispatch] 3 | 4 | jobs: 5 | smoke: 6 | name: Minimal smoke tests for the action 7 | runs-on: ubuntu-24.04 8 | steps: 9 | - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 10 | - name: Setup Anbox Cloud 11 | uses: ./ 12 | with: 13 | channel: latest/edge 14 | lxd-channel: latest/stable 15 | storage-size: 32 16 | - name: Restore cached images 17 | uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # v4 18 | with: 19 | path: images 20 | key: anbox-images-amd64 21 | - name: Import cached images 22 | run: | 23 | amc image add jammy:android13:amd64 ./images/android13.tar.xz 24 | - name: Tune configuration 25 | run: | 26 | amc config set container.security_updates false 27 | - name: Create Android instance 28 | id: create-instance 29 | run: | 30 | set -x 31 | id="$(amc launch -r -s adb jammy:android13:amd64)" 32 | amc wait -c status=running "$id" 33 | echo "id=$id" >> "$GITHUB_OUTPUT" 34 | - name: Access Android over ADB 35 | run: | 36 | sudo apt install -y adb 37 | id=${{ steps.create-instance.outputs.id }} 38 | addr="$(amc show "$id" --format=json | jq -r .network.address)" 39 | adb connect "$addr":5559 40 | test "$(adb shell getprop ro.product.model)" = Anbox 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # anbox-cloud-github-action 2 | 3 | Github action to setup Anbox Cloud on a Github runner. It installs the 4 | Anbox Cloud Appliance snap package and provides a ready to use environment 5 | to spin up containerized or virtualized Android instances directly on the 6 | Github runner. 7 | 8 | See https://anbox-cloud.io/docs for more details 9 | 10 | ## Action inputs 11 | 12 | * `channel`: Channel in the snap store of the `anbox-cloud-appliance` snap to use. 13 | * `ubuntu-pro-token`: Token to attach the runner to Ubuntu Pro which is required to have 14 | access to the official images provided by Canonical. 15 | 16 | ## Example usage 17 | 18 | ```yaml 19 | name: Run integration tests 20 | on: push 21 | jobs: 22 | run-tests: 23 | runs-on: ubuntu-24.04 24 | steps: 25 | - name: Setup Anbox Cloud 26 | uses: canonical/anbox-cloud-github-action@main 27 | with: 28 | channel: 1.23/stable 29 | ubuntu-pro-token: ${{ secrets.UBUNTU_PRO_TOKEN }} 30 | - name: Create Android instance 31 | id: create-instance 32 | run: | 33 | set -x 34 | id="$(amc launch -r -s adb jammy:android13:amd64)" 35 | amc wait -c status=running "$id" 36 | echo "id=$id" >> "$GITHUB_OUTPUT" 37 | - name: Access Android over ADB 38 | run: | 39 | sudo apt install -y adb 40 | id=${{ steps.create-instance.outputs.id }} 41 | addr="$(amc show "$id" --format=json | jq -r .network.address)" 42 | adb connect "$addr":5559 43 | - name: Run tests 44 | run: | 45 | test "$(adb shell getprop ro.product.model)" = Anbox 46 | ... 47 | ``` 48 | 49 | ## Licensing 50 | 51 | The action is licensed under the terms of [the Apache-2.0 license](LICENSE.md). 52 | 53 | ## Further information 54 | 55 | If you find any issues with this workflow, [report a bug](https://bugs.launchpad.net/anbox-cloud). 56 | 57 | If you are interested in using Anbox Cloud, [contact us](https://anbox-cloud.io/contact-us). 58 | -------------------------------------------------------------------------------- /action.yaml: -------------------------------------------------------------------------------- 1 | name: Setup Anbox Cloud 2 | description: | 3 | Setup Anbox Cloud on a Github runner for running integration tests against 4 | containerized or virtualized Android instances. 5 | 6 | See https://anbox-cloud.io/docs for more details 7 | inputs: 8 | channel: 9 | default: latest/stable 10 | description: Snap channel of the anbox-cloud-appliance snap to use 11 | required: false 12 | type: string 13 | lxd-channel: 14 | default: 5.21/stable 15 | description: LXD channel to use 16 | required: false 17 | type: string 18 | storage-size: 19 | default: 30 20 | description: Size of the LXD storage pool in GiB 21 | required: false 22 | type: number 23 | ubuntu-pro-token: 24 | default: '' 25 | description: Ubuntu Pro token to setup access to official image server 26 | require: false 27 | type: string 28 | 29 | runs: 30 | using: composite 31 | steps: 32 | - name: Attach to Ubuntu Pro 33 | if: ${{ inputs.ubuntu-pro-token }} 34 | shell: bash 35 | run: | 36 | sudo pro attach ${{ inputs.ubuntu-pro-token }} 37 | sudo pro enable anbox-cloud --access-only 38 | - name: Setup LXD 39 | uses: canonical/setup-lxd@d14f946da89caa319fd083d39b1960f4978fb982 40 | with: 41 | channel: ${{ inputs.lxd-channel }} 42 | - name: Install necessary snap packages 43 | shell: bash 44 | run: | 45 | sudo snap install --channel=${{ inputs.channel }} anbox-cloud-appliance 46 | - name: Initialize Anbox Cloud 47 | shell: bash 48 | env: 49 | STORAGE_SIZE: ${{ inputs.storage-size }} 50 | run: | 51 | anbox-cloud-appliance prepare-node-script | sudo bash -ex 52 | 53 | # FIXME workaround an issue with latest kernel packages which don't 54 | # seem to update dependency information correctly 55 | sudo depmod -a 56 | 57 | uid="$(id -u)" 58 | addr="$(ip -4 -j route get 2.2.2.2 | jq -r '.[] | .prefsrc')" 59 | storage_size=$((STORAGE_SIZE * 1024 * 1024 * 1024)) 60 | cat << EOF | sudo anbox-cloud-appliance init --preseed 61 | network: 62 | # We set both listen and public address to the same local IP address 63 | # as otherwise the appliance will attempt to determine the public 64 | # address through the use of STUN. 65 | listen-address: $addr 66 | public-address: $addr 67 | lxd: 68 | storage-size: $storage_size 69 | storage-pool: anbox-cloud 70 | ams: 71 | api: 72 | allowed-uids: [0, $uid] 73 | EOF 74 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------