crosvm/e2e_tests/README.md

# Crosvm End to End Tests

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.

The e2e_tests can be executed by:

```sh
$ ./tools/run_tests --dut=vm -E 'rdeps(e2e_tests)'
```

## Running with locally built kernel/rootfs

If you want to make changes to the kernel or rootfs, you have to specify the environment variables
`CROSVM_CARGO_TEST_KERNEL_IMAGE` and `CROSVM_CARGO_TEST_ROOTFS_IMAGE` to point to the right files
and then run `cargo test`.

With use_local_build.sh script, e2e_tests can be executed with custom kernel/rootfs as follows:

```sh
$ cd /path/to/crosvm
$ cd e2e_tests
$ source guest_under_test/use_local_build.sh
$ cargo test
```

Unsetting the variables will bring back you to the original behavior.

```sh
unset CROSVM_CARGO_TEST_KERNEL_IMAGE
unset CROSVM_CARGO_TEST_ROOTFS_IMAGE
```

Note: The custom images cannot be used with `tools/run_tests`.

## Uploading prebuilts

Note: Only Googlers with access to the crosvm-testing cloud storage bin can upload prebuilts.

To upload the modified rootfs, you will have to uprev the `PREBUILT_VERSION` variable in:

- `./guest_under_test/PREBUILT_VERSION`

and [request a permission](http://go/crosvm/infra.md?cl=head#access-on-demand-to-upload-artifacts)
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.