From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:60422) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dsrY2-0003l4-Jp for qemu-devel@nongnu.org; Fri, 15 Sep 2017 10:24:51 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dsrXy-00073A-Ji for qemu-devel@nongnu.org; Fri, 15 Sep 2017 10:24:50 -0400 Received: from mail-wr0-x22d.google.com ([2a00:1450:400c:c0c::22d]:55729) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dsrXy-00072x-Bz for qemu-devel@nongnu.org; Fri, 15 Sep 2017 10:24:46 -0400 Received: by mail-wr0-x22d.google.com with SMTP id l39so1958135wrl.12 for ; Fri, 15 Sep 2017 07:24:46 -0700 (PDT) References: <20170913030119.3957-1-famz@redhat.com> <20170913030119.3957-13-famz@redhat.com> From: Alex =?utf-8?Q?Benn=C3=A9e?= In-reply-to: <20170913030119.3957-13-famz@redhat.com> Date: Fri, 15 Sep 2017 15:24:43 +0100 Message-ID: <87tw0482fo.fsf@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Subject: Re: [Qemu-devel] [PATCH v7 12/13] tests: Add README for vm tests List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Fam Zheng Cc: qemu-devel@nongnu.org, berrange@redhat.com, Philippe =?utf-8?Q?Mathieu?= =?utf-8?Q?-Daud=C3=A9?= , pbonzini@redhat.com, stefanha@redhat.com, Cleber Rosa , Peter Maydell , eblake@redhat.com, Kamil Rytarowski Fam Zheng writes: > Signed-off-by: Fam Zheng > --- > 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. Running make vm-build-netbsd I get several prompts for pass-phrase and password: Enter passphrase for key './vm-test-QdFtLJ.tmp/id_rsa': Password for qemu@: Enter passphrase for key './vm-test-QdFtLJ.tmp/id_rsa': Password for qemu@: ar: creating libfdt/libfdt.a Which seems odd considering the private key isn't protected by a passphrase and the build tools know what the password is. We should also mention the images are added to ${QEMU_SRC}/tests/vm/ > + > +== 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. > + -- Alex Bennée