{"id":811449,"url":"http://patchwork.ozlabs.org/api/patches/811449/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170908095506.13594-19-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":"<20170908095506.13594-19-famz@redhat.com>","list_archive_url":null,"date":"2017-09-08T09:54:46","name":"[PULL,18/38] tests: Add README for vm tests","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"098b5a306faee009d58cbb469bab6ab66b590594","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/20170908095506.13594-19-famz@redhat.com/mbox/","series":[{"id":2164,"url":"http://patchwork.ozlabs.org/api/series/2164/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=2164","date":"2017-09-08T09:54:28","name":"[PULL,01/38] docker: ensure NOUSER for travis images","version":1,"mbox":"http://patchwork.ozlabs.org/series/2164/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/811449/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/811449/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-mx02.extmail.prod.ext.phx2.redhat.com;\n\tdmarc=none (p=none dis=none) header.from=redhat.com","ext-mx02.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 3xpXsb2tZMz9s7C\n\tfor ;\n\tFri, 8 Sep 2017 20:01:39 +1000 (AEST)","from localhost ([::1]:44265 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t)\n\tid 1dqG6T-0004PA-BQ\n\tfor incoming@patchwork.ozlabs.org; Fri, 08 Sep 2017 06:01:37 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:41776)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from ) id 1dqG0t-00083L-0c\n\tfor qemu-devel@nongnu.org; Fri, 08 Sep 2017 05:55:55 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from ) id 1dqG0o-0004lA-Br\n\tfor qemu-devel@nongnu.org; Fri, 08 Sep 2017 05:55:51 -0400","from mx1.redhat.com ([209.132.183.28]:38638)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from ) id 1dqG0o-0004kN-2L\n\tfor qemu-devel@nongnu.org; Fri, 08 Sep 2017 05:55:46 -0400","from smtp.corp.redhat.com\n\t(int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12])\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 16333883C5;\n\tFri, 8 Sep 2017 09:55:45 +0000 (UTC)","from lemon.redhat.com (ovpn-12-98.pek2.redhat.com [10.72.12.98])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id CAD5960E3A;\n\tFri, 8 Sep 2017 09:55:43 +0000 (UTC)"],"DMARC-Filter":"OpenDMARC Filter v1.3.2 mx1.redhat.com 16333883C5","From":"Fam Zheng ","To":"qemu-devel@nongnu.org","Date":"Fri, 8 Sep 2017 17:54:46 +0800","Message-Id":"<20170908095506.13594-19-famz@redhat.com>","In-Reply-To":"<20170908095506.13594-1-famz@redhat.com>","References":"<20170908095506.13594-1-famz@redhat.com>","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.12","X-Greylist":"Sender IP whitelisted, not delayed by milter-greylist-4.5.16\n\t(mx1.redhat.com [10.5.110.26]);\n\tFri, 08 Sep 2017 09:55:45 +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] [PULL 18/38] 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 ","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t"},"content":"Signed-off-by: Fam Zheng \nMessage-Id: <20170905021201.25684-12-famz@redhat.com>\n---\n tests/vm/README | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n 1 file changed, 63 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..7d2fe4ac8d\n--- /dev/null\n+++ b/tests/vm/README\n@@ -0,0 +1,63 @@\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.\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, BaseVM.SSH_PUB_KEY is added\n+ to authorized_keys 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+\n","prefixes":["PULL","18/38"]}