mirrors/crosvm
1
0
Fork 0
mirror of https://chromium.googlesource.com/crosvm/crosvm synced 2024-11-29 11:08:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
crosvm/e2e_tests/README.md

43 lines
1.5 KiB
Markdown
Raw Normal View History

Rename integration_tests to e2e_tests Cargo already uses the term 'integration test' for tests living in the tests/ directory of a crate. To prevent confusion, rename our 'integration_tests' crate to 'e2e_tests'. BUG=None TEST=presubmit Change-Id: Icfa819eaed08be54ab0f36092f1ba367f3f1ce88 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4004977 Commit-Queue: Dennis Kempin <denniskempin@google.com> Reviewed-by: Zihan Chen <zihanchen@google.com>
2022-11-03 21:28:42 +00:00
# Crosvm End to End Tests
Framework for extended integration tests This CL expands the existing boot.rs test to not just boot a kernel but also provide a debian-based rootfs and a special init binary that is used to communicate between test code and the guest VM. The delegate binary listens for commands on /dev/ttyS1 and returns the stdout of the executed command. This allows the test code to setup pipes for the serial device to issue commands in the client and receive the command output, which provides a good foundation for tests of basic functionality without the need to pass test binary code into the guest. The integration tests will pull a prebuilt kernel and rootfs image from cloud storage unless local files are specified via ENV variables. The integration_tests/guest_under_test directory contains the files needed to build and upload those prebuilts. BUG=b:172926609 TEST=This is a test. Cq-Depend: chromium:2551073 Change-Id: Iffb88a146a13d1b6ed7250df1b487bd87a5599d0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2536831 Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Zach Reizner <zachr@chromium.org> Commit-Queue: Dennis Kempin <denniskempin@google.com> Auto-Submit: Dennis Kempin <denniskempin@google.com>
2020-11-10 17:34:56 +00:00
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
These tests run a crosvm VM on the host to verify end to end behavior. They use a prebuilt guest
kernel and rootfs, which is downloaded from google cloud storage.
Framework for extended integration tests This CL expands the existing boot.rs test to not just boot a kernel but also provide a debian-based rootfs and a special init binary that is used to communicate between test code and the guest VM. The delegate binary listens for commands on /dev/ttyS1 and returns the stdout of the executed command. This allows the test code to setup pipes for the serial device to issue commands in the client and receive the command output, which provides a good foundation for tests of basic functionality without the need to pass test binary code into the guest. The integration tests will pull a prebuilt kernel and rootfs image from cloud storage unless local files are specified via ENV variables. The integration_tests/guest_under_test directory contains the files needed to build and upload those prebuilts. BUG=b:172926609 TEST=This is a test. Cq-Depend: chromium:2551073 Change-Id: Iffb88a146a13d1b6ed7250df1b487bd87a5599d0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2536831 Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Zach Reizner <zachr@chromium.org> Commit-Queue: Dennis Kempin <denniskempin@google.com> Auto-Submit: Dennis Kempin <denniskempin@google.com>
2020-11-10 17:34:56 +00:00
e2e_tests: Remove redundant run script e2e_tests/run script was used as a convenience tool, and is superseded by tools/run_tests2. BUG=NONE TEST=tools/presubmit Change-Id: I52ea9d3718d005fd64506c6586624a07da66db85 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4705407 Commit-Queue: Ningyuan Wang <ningyuan@google.com> Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2023-07-21 10:51:00 +00:00
The e2e_tests can be executed by:
`$ ./tools/run_tests2 --dut=vm -E 'rdeps(e2e_tests)'`
Framework for extended integration tests This CL expands the existing boot.rs test to not just boot a kernel but also provide a debian-based rootfs and a special init binary that is used to communicate between test code and the guest VM. The delegate binary listens for commands on /dev/ttyS1 and returns the stdout of the executed command. This allows the test code to setup pipes for the serial device to issue commands in the client and receive the command output, which provides a good foundation for tests of basic functionality without the need to pass test binary code into the guest. The integration tests will pull a prebuilt kernel and rootfs image from cloud storage unless local files are specified via ENV variables. The integration_tests/guest_under_test directory contains the files needed to build and upload those prebuilts. BUG=b:172926609 TEST=This is a test. Cq-Depend: chromium:2551073 Change-Id: Iffb88a146a13d1b6ed7250df1b487bd87a5599d0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2536831 Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Zach Reizner <zachr@chromium.org> Commit-Queue: Dennis Kempin <denniskempin@google.com> Auto-Submit: Dennis Kempin <denniskempin@google.com>
2020-11-10 17:34:56 +00:00
## Running with locally built kernel/rootfs
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
If the test needs to run offline, or you want to make changes to the kernel or rootfs, you have to
specify the environment variables `CROSVM_CARGO_TEST_KERNEL_BINARY` and
`CROSVM_CARGO_TEST_ROOTFS_IMAGE` to point to the right files.
Framework for extended integration tests This CL expands the existing boot.rs test to not just boot a kernel but also provide a debian-based rootfs and a special init binary that is used to communicate between test code and the guest VM. The delegate binary listens for commands on /dev/ttyS1 and returns the stdout of the executed command. This allows the test code to setup pipes for the serial device to issue commands in the client and receive the command output, which provides a good foundation for tests of basic functionality without the need to pass test binary code into the guest. The integration tests will pull a prebuilt kernel and rootfs image from cloud storage unless local files are specified via ENV variables. The integration_tests/guest_under_test directory contains the files needed to build and upload those prebuilts. BUG=b:172926609 TEST=This is a test. Cq-Depend: chromium:2551073 Change-Id: Iffb88a146a13d1b6ed7250df1b487bd87a5599d0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2536831 Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Zach Reizner <zachr@chromium.org> Commit-Queue: Dennis Kempin <denniskempin@google.com> Auto-Submit: Dennis Kempin <denniskempin@google.com>
2020-11-10 17:34:56 +00:00
The use_local_build.sh script does this for you:
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
`$ source guest_under_test/use_local_build.sh`
Framework for extended integration tests This CL expands the existing boot.rs test to not just boot a kernel but also provide a debian-based rootfs and a special init binary that is used to communicate between test code and the guest VM. The delegate binary listens for commands on /dev/ttyS1 and returns the stdout of the executed command. This allows the test code to setup pipes for the serial device to issue commands in the client and receive the command output, which provides a good foundation for tests of basic functionality without the need to pass test binary code into the guest. The integration tests will pull a prebuilt kernel and rootfs image from cloud storage unless local files are specified via ENV variables. The integration_tests/guest_under_test directory contains the files needed to build and upload those prebuilts. BUG=b:172926609 TEST=This is a test. Cq-Depend: chromium:2551073 Change-Id: Iffb88a146a13d1b6ed7250df1b487bd87a5599d0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2536831 Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Zach Reizner <zachr@chromium.org> Commit-Queue: Dennis Kempin <denniskempin@google.com> Auto-Submit: Dennis Kempin <denniskempin@google.com>
2020-11-10 17:34:56 +00:00
## Uploading prebuilts
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
Note: Only Googlers with access to the crosvm-testing cloud storage bin can upload prebuilts.
Framework for extended integration tests This CL expands the existing boot.rs test to not just boot a kernel but also provide a debian-based rootfs and a special init binary that is used to communicate between test code and the guest VM. The delegate binary listens for commands on /dev/ttyS1 and returns the stdout of the executed command. This allows the test code to setup pipes for the serial device to issue commands in the client and receive the command output, which provides a good foundation for tests of basic functionality without the need to pass test binary code into the guest. The integration tests will pull a prebuilt kernel and rootfs image from cloud storage unless local files are specified via ENV variables. The integration_tests/guest_under_test directory contains the files needed to build and upload those prebuilts. BUG=b:172926609 TEST=This is a test. Cq-Depend: chromium:2551073 Change-Id: Iffb88a146a13d1b6ed7250df1b487bd87a5599d0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2536831 Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Zach Reizner <zachr@chromium.org> Commit-Queue: Dennis Kempin <denniskempin@google.com> Auto-Submit: Dennis Kempin <denniskempin@google.com>
2020-11-10 17:34:56 +00:00
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
To upload the modified rootfs, you will have to uprev the `PREBUILT_VERSION` variable in:
Framework for extended integration tests This CL expands the existing boot.rs test to not just boot a kernel but also provide a debian-based rootfs and a special init binary that is used to communicate between test code and the guest VM. The delegate binary listens for commands on /dev/ttyS1 and returns the stdout of the executed command. This allows the test code to setup pipes for the serial device to issue commands in the client and receive the command output, which provides a good foundation for tests of basic functionality without the need to pass test binary code into the guest. The integration tests will pull a prebuilt kernel and rootfs image from cloud storage unless local files are specified via ENV variables. The integration_tests/guest_under_test directory contains the files needed to build and upload those prebuilts. BUG=b:172926609 TEST=This is a test. Cq-Depend: chromium:2551073 Change-Id: Iffb88a146a13d1b6ed7250df1b487bd87a5599d0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2536831 Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Zach Reizner <zachr@chromium.org> Commit-Queue: Dennis Kempin <denniskempin@google.com> Auto-Submit: Dennis Kempin <denniskempin@google.com>
2020-11-10 17:34:56 +00:00
- `./guest_under_test/PREBUILT_VERSION`
e2e_tests: Add a tool to dev_container and guest rootfs Add a tool used in vsock tests to dev_container and guest rootfs BUG=b:254375643 TEST=`./tools/presubmit` with the new guest rootfs on the new dev_container Change-Id: I135e6d2d413bedffef0fd69edd4ab14080429e3a Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3974349 Reviewed-by: Dennis Kempin <denniskempin@google.com> Reviewed-by: Takaya Saeki <takayas@chromium.org> Commit-Queue: Ryuichiro Chiba <chibar@chromium.org> Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org>
2022-10-24 06:59:15 +00:00
and [request a permission](http://go/crosvm/infra.md?cl=head#access-on-demand-to-upload-artifacts)
e2e_tests: Document on qemu-user-static for upload_prebuilts.sh BUG=none TEST=read Change-Id: Id43b8c60c4f632b5f374da558b7cba0f600f361f Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4895764 Reviewed-by: Dennis Kempin <denniskempin@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
2023-09-27 02:02:41 +00:00
to become a member of the `crosvm-policy-uploader` group.
Then run the upload script to build and upload the new prebuilts.
```sh
# Install QEMU-user-static to build aarch64 images
$ sudo apt install binfmt-support qemu-user-static
# Register binfmt_misc entries
$ docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
# Build and upload the new artifacts
$ ./guest_under_test/upload_prebuilts.sh
```
**Never** try to modify an existing prebuilt as the new images may break tests in older versions.
Reference in a new issue Copy permalink