[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 18/38] tests: Add README for vm tests
From: |
Fam Zheng |
Subject: |
[Qemu-devel] [PULL 18/38] tests: Add README for vm tests |
Date: |
Fri, 8 Sep 2017 17:54:46 +0800 |
Signed-off-by: Fam Zheng <address@hidden>
Message-Id: <address@hidden>
---
tests/vm/README | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 63 insertions(+)
create mode 100644 tests/vm/README
diff --git a/tests/vm/README b/tests/vm/README
new file mode 100644
index 0000000000..7d2fe4ac8d
--- /dev/null
+++ b/tests/vm/README
@@ -0,0 +1,63 @@
+=== VM test suite to run build in guests ===
+
+== Intro ==
+
+This test suite contains scripts that bootstrap various guest images that have
+necessary packages to build QEMU. The basic usage is documented in Makefile
+help which is displayed with "make vm-test".
+
+== Quick start ==
+
+Run "make vm-test" to list available make targets.
+
+== Manual invocation ==
+
+Each guest script is an executable script with the same command line options.
+For example to work with the netbsd guest, use $QEMU_SRC/tests/vm/netbsd:
+
+ $ cd $QEMU_SRC/tests/vm
+
+ # To bootstrap the image
+ $ ./netbsd --build-image --image /var/tmp/netbsd.img
+ <...>
+
+ # To run an arbitrary command in guest (the output will not be echoed
unless
+ # --debug is added)
+ $ ./netbsd --debug --image /var/tmp/netbsd.img uname -a
+
+ # To build QEMU in guest
+ $ ./netbsd --debug --image /var/tmp/netbsd.img --build-qemu $QEMU_SRC
+
+ # To get to an interactive shell
+ $ ./netbsd --interactive --image /var/tmp/netbsd.img sh
+
+== Adding new guests ==
+
+Please look at existing guest scripts for how to add new guests.
+
+Most importantly, create a subclass of BaseVM and implement build_image()
+method and define BUILD_SCRIPT, then finally call basevm.main() from the
+script's main().
+
+ - Usually in build_image(), a template image is downloaded from a predefined
+ URL. BaseVM._download_with_cache() takes care of the cache and the
+ checksum, so consider using it.
+
+ - Once the image is downloaded, users, SSH server and QEMU build deps should
+ be set up:
+
+ * Root password set to BaseVM.ROOT_PASS
+ * User BaseVM.GUEST_USER is created, and password set to BaseVM.GUEST_PASS
+ * SSH service is enabled and started on boot, BaseVM.SSH_PUB_KEY is added
+ to authorized_keys of both root and the normal user
+ * DHCP client service is enabled and started on boot, so that it can
+ automatically configure the virtio-net-pci NIC and communicate with QEMU
+ user net (10.0.2.2)
+ * Necessary packages are installed to untar the source tarball and build
+ QEMU
+
+ - Write a proper BUILD_SCRIPT template, which should be a shell script that
+ untars a raw virtio-blk block device, which is the tarball data blob of the
+ QEMU source tree, then configure/build it. Running "make check" is also
+ recommended.
+
--
2.13.5
- [Qemu-devel] [PULL 07/38] tests/docker: Clean up paths, (continued)
- [Qemu-devel] [PULL 07/38] tests/docker: Clean up paths, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 09/38] qemu.py: Add "wait()" method, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 10/38] scripts: Add archive-source.sh, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 11/38] tests: Add vm test lib, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 12/38] tests: Add ubuntu.i386 image, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 13/38] tests: Add FreeBSD image, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 14/38] tests: Add NetBSD image, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 15/38] tests: Add OpenBSD image, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 16/38] Makefile: Add rules to run vm tests, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 17/38] MAINTAINERS: Add tests/vm entry, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 18/38] tests: Add README for vm tests,
Fam Zheng <=
- [Qemu-devel] [PULL 19/38] docker: Use archive-source.py, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 20/38] docker: Fix return code of build_qemu(), Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 21/38] docker: Add test_fail and prep_fail, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 22/38] docker: Use unconfined security profile, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 23/38] docker: Add nettle-devel to fedora image, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 24/38] docker: Add test-block, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 25/38] docker: Drop 'set -e' from run script, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 26/38] vl: Don't include vde header, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 27/38] buildsys: Move vde libs to per object, Fam Zheng, 2017/09/08
- [Qemu-devel] [PULL 28/38] buildsys: Move gtk/vte cflags/libs to per object, Fam Zheng, 2017/09/08