{"id":806698,"url":"http://patchwork.ozlabs.org/api/1.0/patches/806698/?format=json","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/1.0/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":""},"msgid":"<20170828174707.20786-11-famz@redhat.com>","date":"2017-08-28T17:47:07","name":"[v4,10/10] tests: Add README for vm tests","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"7a4720ccb3a4ba78444932694231caad7f555201","submitter":{"id":24872,"url":"http://patchwork.ozlabs.org/api/1.0/people/24872/?format=json","name":"Fam Zheng","email":"famz@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170828174707.20786-11-famz@redhat.com/mbox/","series":[{"id":226,"url":"http://patchwork.ozlabs.org/api/1.0/series/226/?format=json","date":"2017-08-28T17:46:57","name":"tests: Add VM based build tests (for non-x86_64 and/or non-Linux)","version":4,"mbox":"http://patchwork.ozlabs.org/series/226/mbox/"}],"check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/806698/checks/","tags":{},"headers":{"Return-Path":"<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>","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=<UNKNOWN>)","ext-mx01.extmail.prod.ext.phx2.redhat.com;\n\tdmarc=none (p=none dis=none) header.from=redhat.com","ext-mx01.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 3xgzsr3dCRz9sNr\n\tfor <incoming@patchwork.ozlabs.org>;\n\tTue, 29 Aug 2017 03:54:08 +1000 (AEST)","from localhost ([::1]:40877 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>)\n\tid 1dmOEg-0002rZ-BA\n\tfor incoming@patchwork.ozlabs.org; Mon, 28 Aug 2017 13:54:06 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:33555)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from <famz@redhat.com>) id 1dmO9F-0007EY-Rz\n\tfor qemu-devel@nongnu.org; Mon, 28 Aug 2017 13:48:30 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from <famz@redhat.com>) id 1dmO9E-0002ik-Sm\n\tfor qemu-devel@nongnu.org; Mon, 28 Aug 2017 13:48:29 -0400","from mx1.redhat.com ([209.132.183.28]:48798)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from <famz@redhat.com>) id 1dmO9E-0002iM-Ie\n\tfor qemu-devel@nongnu.org; Mon, 28 Aug 2017 13:48:28 -0400","from smtp.corp.redhat.com\n\t(int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11])\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 7F8AE81DF1;\n\tMon, 28 Aug 2017 17:48:27 +0000 (UTC)","from lemon.redhat.com (ovpn-12-121.pek2.redhat.com [10.72.12.121])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id 24F177FA48;\n\tMon, 28 Aug 2017 17:48:22 +0000 (UTC)"],"DMARC-Filter":"OpenDMARC Filter v1.3.2 mx1.redhat.com 7F8AE81DF1","From":"Fam Zheng <famz@redhat.com>","To":"qemu-devel@nongnu.org","Date":"Tue, 29 Aug 2017 01:47:07 +0800","Message-Id":"<20170828174707.20786-11-famz@redhat.com>","In-Reply-To":"<20170828174707.20786-1-famz@redhat.com>","References":"<20170828174707.20786-1-famz@redhat.com>","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.11","X-Greylist":"Sender IP whitelisted, not delayed by milter-greylist-4.5.16\n\t(mx1.redhat.com [10.5.110.25]);\n\tMon, 28 Aug 2017 17:48:27 +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 v4 10/10] tests: Add README for vm tests","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.21","Precedence":"list","List-Id":"<qemu-devel.nongnu.org>","List-Unsubscribe":"<https://lists.nongnu.org/mailman/options/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>","List-Archive":"<http://lists.nongnu.org/archive/html/qemu-devel/>","List-Post":"<mailto:qemu-devel@nongnu.org>","List-Help":"<mailto:qemu-devel-request@nongnu.org?subject=help>","List-Subscribe":"<https://lists.nongnu.org/mailman/listinfo/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=subscribe>","Cc":"Peter Maydell <peter.maydell@linaro.org>, Fam Zheng <famz@redhat.com>,\n\tCleber Rosa <crosa@redhat.com>, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?=\n\t<f4bug@amsat.org>, Kamil Rytarowski <kamil@netbsd.org>,\n\tstefanha@redhat.com, \tpbonzini@redhat.com, =?utf-8?q?Alex_Benn=C3=A9e?=\n\t<alex.bennee@linaro.org>","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>"},"content":"Signed-off-by: Fam Zheng <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..66d53cff60\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 /tmp/netbsd.img uname -a\n+\n+    # To build QEMU in guest\n+    $ ./netbsd --debug --image /tmp/netbsd.img --build-qemu $QEMU_SRC\n+\n+    # To get to an interactive shell\n+    $ ./netbsd --interactive --image /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":["v4","10/10"]}