mirror of
https://github.com/JakeHillion/drgn.git
synced 2024-12-23 01:33:06 +00:00
8b264f8823
drgn was originally my side project, but for awhile now it's also been my work project. Update the copyright headers to reflect this, and add a copyright header to various files that were missing it. |
||
|---|---|---|
| .. | ||
| __init__.py | ||
| config | ||
| manage.py | ||
| onoatimehack.c | ||
| README.rst | ||
| resolver.py | ||
| vm.py | ||
drgn VM Testing =============== drgn has a significant amount of code (both core and in helpers) which is dependent on the Linux kernel version. This code is tested on multiple Linux kernel versions in a virtual machine. These tests can be run on all supported kernels with ``python3 setup.py test -K``. This requires QEMU and zstd to be installed. Tests can also be run on specific kernels with ``-k``. This takes a comma-separated list of kernels which are either a wildcard pattern (e.g., ``5.6.*``) that matches a kernel release hosted on Dropbox (see below) or a kernel build directory path starting with ``.`` or ``/``. Architecture ------------ The goal of vmtest is to run tests in the same userspace environment as the host, but with a different kernel. The host runs the virtual machine with `QEMU <https://www.qemu.org/>`_ (see the `vmtest.vm <vm.py>`_ module). The guest mounts the host's root filesystem as its own root filesystem via `VirtFS <https://www.linux-kvm.org/page/VirtFS>`_. It is mounted read-only for safety. To support modifications, the guest uses `OverlayFS <https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt>`_ to overlay a read-write tmpfs over the VirtFS root. The guest runs a `BusyBox <https://www.busybox.net/>`_ shell script as init which sets up the system and filesystem hierarchy, runs a command, and returns the exit status via `virtio-serial <https://fedoraproject.org/wiki/Features/VirtioSerial>`_. This infrastructure is all generic. The drgn-specific parts are: 1. The kernel builds. The `kernel configuration <config>`_ includes everything required to run drgn and the Linux kernel helper tests. These builds are hosted on `Dropbox <https://www.dropbox.com/sh/2mcf2xvg319qdaw/AAChpI5DJZX2VwlCgPFDdaZHa?dl=0>`_. They are managed via the Dropbox API by the `vmtest.manage <manage.py>`_ CLI and downloaded by the `vmtest.resolver <resolver.py>`_ module. 2. The test command itself. This is just some ``setup.py`` glue, a command to install vmlinux where drgn can find it, and the proper invocation of the Python `unittest command line interface <https://docs.python.org/3/library/unittest.html#test-discovery>`_. The ``vmtest.vm`` and ``vmtest.resolver`` modules also have CLIs for testing purposes. These are subject to change.