From 26cbc8bd1342ae54d7894bc34ed11d9254288832 Mon Sep 17 00:00:00 2001 From: Simon Fels Date: Mon, 19 Aug 2024 13:14:50 +0200 Subject: [PATCH] feat: initial impementation of the action Sets up all basic infrastructure to get the action in place and in a usable state. --- .github/renovate.json | 11 ++ .github/workflows/cache-images.yaml | 34 +++++ .github/workflows/pr.yaml | 27 ++++ LICENSE.md | 201 ++++++++++++++++++++++++++++ README.md | 54 ++++++++ action.yaml | 37 +++++ 6 files changed, 364 insertions(+) create mode 100644 .github/renovate.json create mode 100644 .github/workflows/cache-images.yaml create mode 100644 .github/workflows/pr.yaml create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 action.yaml diff --git a/.github/renovate.json b/.github/renovate.json new file mode 100644 index 0000000..f0823ca --- /dev/null +++ b/.github/renovate.json @@ -0,0 +1,11 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:recommended", + ":disableDependencyDashboard", + "schedule:earlyMondays", + ":combinePatchMinorReleases", + ":ignoreUnstable", + "helpers:pinGitHubActionDigests" + ] +} \ No newline at end of file diff --git a/.github/workflows/cache-images.yaml b/.github/workflows/cache-images.yaml new file mode 100644 index 0000000..fa093d9 --- /dev/null +++ b/.github/workflows/cache-images.yaml @@ -0,0 +1,34 @@ +name: Cache Anbox Cloud images + +on: + workflow_dispatch: + schedule: + - cron: '0 10 * * *' + +jobs: + cache-images: + name: Cache Anbox Cloud images + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Attach to Ubuntu Pro + run: | + sudo pro attach ${{ secrets.UBUNTU_PRO_TOKEN }} + sudo pro enable anbox-cloud --access-only + - name: Download images + run: | + image_server_auth="bearer:$(sudo cat /var/lib/ubuntu-advantage/private/machine-token.json | jq -r '.resourceTokens[] | select(.type=="anbox-images").token')" + image_server_url=https://"$image_server_auth"@images.anbox-cloud.io/stable + + mkdir images + image_name=jammy:android13:amd64 + item_type=image + image_path="$(curl -s "$image_server_url"/streams/v1/images.json | \ + jq -r "last(.products.\"$image_name\".versions[] | select(.items.\"${item_type}\" != null)).items.\"${item_type}\".path")" + image_url="$image_server_url"/"$image_path" + curl -s "$image_url" -o images/android13.tar.xz + - name: Cache all images + uses: actions/cache/save@v4 + with: + path: images + key: anbox-images-amd64 diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml new file mode 100644 index 0000000..adadb74 --- /dev/null +++ b/.github/workflows/pr.yaml @@ -0,0 +1,27 @@ +name: Test action +on: [push, pull_request, workflow_dispatch] + +jobs: + smoke: + name: Minimal smoke tests for the action + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4 + - name: Setup Anbox Cloud + uses: ./ + - name: Restore cached images + uses: actions/cache/restore@v4 + with: + path: images + key: anbox-images-amd64 + - name: Import cached images + run: | + sudo mv images /root + sudo amc image add jammy:android13:amd64 /root/images/android13.tar.xz + - name: Create Android instance + run: | + id="$(amc launch -r -s adb --devmode jammy:android13:amd64)" + amc wait -c status=running "$id" + addr="$(amc show "$id" --format=json | jq .network.address)" + adb connect 192.168.96.3:5559 + test "$(adb shell getprop ro.product.model)" = Anbox \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..247f047 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# anbox-cloud-github-action + +Github action to setup Anbox Cloud on a Github runner. It installs the +Anbox Cloud Appiance snap package and provides a ready to use environment +to spin up containerized or virtualized Android instance directly on the +Github runner. + +See https://anbox-cloud.io/docs for more details + +## Action inputs + +* `snap-channel`: Channel in the snap store of the `anbox-cloud-appliance` snap to use. +* `ubuntu-pro-token`: Token to attach the runner to Ubuntu Pro which is required to have + access to the official images provided by Canonical. + +## Example usage + +```yaml +name: Run integration tests +on: pull_request +jobs: + run-tests: + runs-on: ubuntu-latest + steps: + - name: Setup Anbox Cloud + uses: canonical/anbox-cloud-github-action@main + with: + snap-channel: 1.23/stable + ubuntu-pro-token: ${{ secrets.UBUNTU_PRO_TOKEN }} + - name: Create Android instance + run: | + id="$(amc launch -r -s adb --devmode jammy:android13:amd64)" + amc wait -c status=running "$id" + addr="$(amc show "$id" --format=json | jq .network.address)" + adb connect 192.168.96.3:5559 + ... +``` + +# Licensing + +The action is licensed under the terms of [the Apache-2.0 license](LICENSE.md). + +## Contributing guidelines + +The following resources can help you get started: + +* [Report a bug](https://bugs.launchpad.net/anbox-cloud) + +## More information + +Explore more with the following resources: + +* [Anbox Cloud documentation](https://anbox-cloud.io/docs) +* [Contact us](https://anbox-cloud.io/contact-us) diff --git a/action.yaml b/action.yaml new file mode 100644 index 0000000..ae848d3 --- /dev/null +++ b/action.yaml @@ -0,0 +1,37 @@ +name: Setup Anbox Cloud +description: | + Setup Anbox Cloud on a Github runner for running integration tests against + containerized or virtualized Android instances. + + See https://anbox-cloud.io/docs for more details +inputs: + channel: + default: latest/stable + description: Snap channel of the anbox-cloud-appliance snap to use + required: false + type: string + ubuntu-pro-token: + default: '' + description: Ubuntu Pro token to setup access to official image server + require: false + type: string + +runs: + using: composite + steps: + - name: Attach to Ubuntu Pro + if: ${{ inputs.ubuntu-pro-token }} + shell: bash + run: | + sudo pro attach ${{ inputs.ubuntu-pro-token }} + sudo pro enable anbox-cloud --access-only + - name: Setup LXD + uses: canonical/setup-lxd@2aa6f7caf7d1484298a64192f7f63a6684e648a4 + - name: Install necessary snap packages + shell: bash + run: | + sudo snap install --channel=${{ inputs.channel }} anbox-cloud-appliance + - name: Initialize Anbox Cloud + shell: bash + run: | + sudo anbox-cloud-appliance init --auto