{"id":815996,"url":"http://patchwork.ozlabs.org/api/patches/815996/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170920032555.18911-13-famz@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20170920032555.18911-13-famz@redhat.com>","list_archive_url":null,"date":"2017-09-20T03:25:54","name":"[v10,12/13] tests: Add README for vm tests","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"3b4f6fd989a2240e1ad60ff2af2e8cc3b822fc2d","submitter":{"id":24872,"url":"http://patchwork.ozlabs.org/api/people/24872/?format=json","name":"Fam Zheng","email":"famz@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170920032555.18911-13-famz@redhat.com/mbox/","series":[{"id":4007,"url":"http://patchwork.ozlabs.org/api/series/4007/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=4007","date":"2017-09-20T03:25:42","name":"tests: Add VM based build tests (for non-x86_64 and/or non-Linux)","version":10,"mbox":"http://patchwork.ozlabs.org/series/4007/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/815996/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/815996/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":["ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=nongnu.org\n\t(client-ip=2001:4830:134:3::11; helo=lists.gnu.org;\n\tenvelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n\treceiver=)","ext-mx06.extmail.prod.ext.phx2.redhat.com;\n\tdmarc=none (p=none dis=none) header.from=redhat.com","ext-mx06.extmail.prod.ext.phx2.redhat.com;\n\tspf=fail smtp.mailfrom=famz@redhat.com"],"Received":["from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11])\n\t(using TLSv1 with cipher AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xxlm357pgz9s7h\n\tfor ;\n\tWed, 20 Sep 2017 13:36:51 +1000 (AEST)","from localhost ([::1]:46492 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t)\n\tid 1duVof-0007Xj-KW\n\tfor incoming@patchwork.ozlabs.org; Tue, 19 Sep 2017 23:36:49 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:44987)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from ) id 1duVfw-00017E-NX\n\tfor qemu-devel@nongnu.org; Tue, 19 Sep 2017 23:27:50 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from ) id 1duVfv-0006cL-7M\n\tfor qemu-devel@nongnu.org; Tue, 19 Sep 2017 23:27:48 -0400","from mx1.redhat.com ([209.132.183.28]:50064)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from ) id 1duVfu-0006a9-U3\n\tfor qemu-devel@nongnu.org; Tue, 19 Sep 2017 23:27:47 -0400","from smtp.corp.redhat.com\n\t(int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14])\n\t(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby mx1.redhat.com (Postfix) with ESMTPS id 0153C356D9;\n\tWed, 20 Sep 2017 03:27:46 +0000 (UTC)","from lemon.redhat.com (ovpn-12-90.pek2.redhat.com [10.72.12.90])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id 1C2D65D979;\n\tWed, 20 Sep 2017 03:27:38 +0000 (UTC)"],"DMARC-Filter":"OpenDMARC Filter v1.3.2 mx1.redhat.com 0153C356D9","From":"Fam Zheng ","To":"qemu-devel@nongnu.org","Date":"Wed, 20 Sep 2017 11:25:54 +0800","Message-Id":"<20170920032555.18911-13-famz@redhat.com>","In-Reply-To":"<20170920032555.18911-1-famz@redhat.com>","References":"<20170920032555.18911-1-famz@redhat.com>","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.14","X-Greylist":"Sender IP whitelisted, not delayed by milter-greylist-4.5.16\n\t(mx1.redhat.com [10.5.110.30]);\n\tWed, 20 Sep 2017 03:27:46 +0000 (UTC)","X-detected-operating-system":"by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]\n\t[fuzzy]","X-Received-From":"209.132.183.28","Subject":"[Qemu-devel] [PATCH v10 12/13] tests: Add README for vm tests","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.21","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Cc":"Peter Maydell , Fam Zheng ,\n\t=?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= ,\n\tKamil Rytarowski , pbonzini@redhat.com, \n\tstefanha@redhat.com, Cleber Rosa ,\n\t=?utf-8?q?Alex_Benn=C3=A9e?= ","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t"},"content":"Signed-off-by: Fam Zheng \n---\n tests/vm/README | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n 1 file changed, 89 insertions(+)\n create mode 100644 tests/vm/README","diff":"diff --git a/tests/vm/README b/tests/vm/README\nnew file mode 100644\nindex 0000000000..ae53dce6ee\n--- /dev/null\n+++ b/tests/vm/README\n@@ -0,0 +1,89 @@\n+=== VM test suite to run build in guests ===\n+\n+== Intro ==\n+\n+This test suite contains scripts that bootstrap various guest images that have\n+necessary packages to build QEMU. The basic usage is documented in Makefile\n+help which is displayed with \"make vm-test\".\n+\n+== Quick start ==\n+\n+Run \"make vm-test\" to list available make targets. Invoke a specific make\n+command to run build test in an image. For example, \"make vm-build-freebsd\"\n+will build the source tree in the FreeBSD image. The command can be executed\n+from either the source tree or the build dir; if the former, ./configure is not\n+needed. The command will then generate the test image in ./tests/vm/ under the\n+working directory.\n+\n+Note: images created by the scripts accept a well-known RSA key pair for SSH\n+access, so they SHOULD NOT be exposed to external interfaces if you are\n+concerned about attackers taking control of the guest and potentially\n+exploiting a QEMU security bug to compromise the host.\n+\n+== QEMU binary ==\n+\n+By default, qemu-system-x86_64 is searched in $PATH to run the guest. If there\n+isn't one, or if it is older than 2.10, the test won't work. In this case,\n+provide the QEMU binary in env var: QEMU=/path/to/qemu-2.10+.\n+\n+== Make jobs ==\n+\n+The \"-j$X\" option in the make command line is not propagated into the VM,\n+specify \"J=$X\" to control the make jobs in the guest.\n+\n+== Debugging ==\n+\n+Add \"DEBUG=1\" and/or \"V=1\" to the make command to allow interactive debugging\n+and verbose output. If this is not enough, see the next section.\n+\n+== Manual invocation ==\n+\n+Each guest script is an executable script with the same command line options.\n+For example to work with the netbsd guest, use $QEMU_SRC/tests/vm/netbsd:\n+\n+ $ cd $QEMU_SRC/tests/vm\n+\n+ # To bootstrap the image\n+ $ ./netbsd --build-image --image /var/tmp/netbsd.img\n+ <...>\n+\n+ # To run an arbitrary command in guest (the output will not be echoed unless\n+ # --debug is added)\n+ $ ./netbsd --debug --image /var/tmp/netbsd.img uname -a\n+\n+ # To build QEMU in guest\n+ $ ./netbsd --debug --image /var/tmp/netbsd.img --build-qemu $QEMU_SRC\n+\n+ # To get to an interactive shell\n+ $ ./netbsd --interactive --image /var/tmp/netbsd.img sh\n+\n+== Adding new guests ==\n+\n+Please look at existing guest scripts for how to add new guests.\n+\n+Most importantly, create a subclass of BaseVM and implement build_image()\n+method and define BUILD_SCRIPT, then finally call basevm.main() from the\n+script's main().\n+\n+ - Usually in build_image(), a template image is downloaded from a predefined\n+ URL. BaseVM._download_with_cache() takes care of the cache and the\n+ checksum, so consider using it.\n+\n+ - Once the image is downloaded, users, SSH server and QEMU build deps should\n+ be set up:\n+\n+ * Root password set to BaseVM.ROOT_PASS\n+ * User BaseVM.GUEST_USER is created, and password set to BaseVM.GUEST_PASS\n+ * SSH service is enabled and started on boot,\n+ $QEMU_SRC/tests/keys/id_rsa.pub is added to ssh's \"authorized_keys\" file\n+ of both root and the normal user\n+ * DHCP client service is enabled and started on boot, so that it can\n+ automatically configure the virtio-net-pci NIC and communicate with QEMU\n+ user net (10.0.2.2)\n+ * Necessary packages are installed to untar the source tarball and build\n+ QEMU\n+\n+ - Write a proper BUILD_SCRIPT template, which should be a shell script that\n+ untars a raw virtio-blk block device, which is the tarball data blob of the\n+ QEMU source tree, then configure/build it. Running \"make check\" is also\n+ recommended.\n","prefixes":["v10","12/13"]}