[{"id":1770053,"web_url":"http://patchwork.ozlabs.org/comment/1770053/","msgid":"<878thcjou3.fsf@linaro.org>","list_archive_url":null,"date":"2017-09-18T10:14:28","subject":"Re: [Qemu-devel] [PATCH v8 05/13] tests: Add vm test lib","submitter":{"id":39532,"url":"http://patchwork.ozlabs.org/api/people/39532/","name":"Alex Bennée","email":"alex.bennee@linaro.org"},"content":"Fam Zheng writes:\n\n> This is the common code to implement a \"VM test\" to\n>\n> 1) Download and initialize a pre-defined VM that has necessary\n> dependencies to build QEMU and SSH access.\n>\n> 2) Archive $SRC_PATH to a .tar file.\n>\n> 3) Boot the VM, and pass the source tar file to the guest.\n>\n> 4) SSH into the VM, untar the source tarball, build from the source.\n>\n> Signed-off-by: Fam Zheng \n\nReviewed-by: Alex Bennée \n\n> ---\n> tests/vm/basevm.py | 256 +++++++++++++++++++++++++++++++++++++++++++++++++++++\n> 1 file changed, 256 insertions(+)\n> create mode 100755 tests/vm/basevm.py\n>\n> diff --git a/tests/vm/basevm.py b/tests/vm/basevm.py\n> new file mode 100755\n> index 0000000000..77d07b161d\n> --- /dev/null\n> +++ b/tests/vm/basevm.py\n> @@ -0,0 +1,256 @@\n> +#!/usr/bin/env python\n> +#\n> +# VM testing base class\n> +#\n> +# Copyright 2017 Red Hat Inc.\n> +#\n> +# Authors:\n> +# Fam Zheng \n> +#\n> +# This code is licensed under the GPL version 2 or later. See\n> +# the COPYING file in the top-level directory.\n> +#\n> +\n> +import os\n> +import sys\n> +import logging\n> +import time\n> +import datetime\n> +sys.path.append(os.path.join(os.path.dirname(__file__), \"..\", \"..\", \"scripts\"))\n> +from qemu import QEMUMachine\n> +import subprocess\n> +import hashlib\n> +import optparse\n> +import atexit\n> +import tempfile\n> +import shutil\n> +import multiprocessing\n> +import traceback\n> +\n> +SSH_KEY = open(os.path.join(os.path.dirname(__file__),\n> + \"..\", \"keys\", \"id_rsa\")).read()\n> +SSH_PUB_KEY = open(os.path.join(os.path.dirname(__file__),\n> + \"..\", \"keys\", \"id_rsa.pub\")).read()\n> +\n> +class BaseVM(object):\n> + GUEST_USER = \"qemu\"\n> + GUEST_PASS = \"qemupass\"\n> + ROOT_PASS = \"qemupass\"\n> +\n> + # The script to run in the guest that builds QEMU\n> + BUILD_SCRIPT = \"\"\n> + # The guest name, to be overridden by subclasses\n> + name = \"#base\"\n> + def __init__(self, debug=False, vcpus=None):\n> + self._guest = None\n> + self._tmpdir = tempfile.mkdtemp(prefix=\"vm-test-\", suffix=\".tmp\", dir=\".\")\n> + atexit.register(shutil.rmtree, self._tmpdir)\n> +\n> + self._ssh_key_file = os.path.join(self._tmpdir, \"id_rsa\")\n> + open(self._ssh_key_file, \"w\").write(SSH_KEY)\n> + subprocess.check_call([\"chmod\", \"600\", self._ssh_key_file])\n> +\n> + self._ssh_pub_key_file = os.path.join(self._tmpdir, \"id_rsa.pub\")\n> + open(self._ssh_pub_key_file, \"w\").write(SSH_PUB_KEY)\n> +\n> + self.debug = debug\n> + self._stderr = sys.stderr\n> + self._devnull = open(os.devnull, \"w\")\n> + if self.debug:\n> + self._stdout = sys.stdout\n> + else:\n> + self._stdout = self._devnull\n> + self._args = [ \\\n> + \"-nodefaults\", \"-m\", \"2G\",\n> + \"-cpu\", \"host\",\n> + \"-netdev\", \"user,id=vnet,hostfwd=:127.0.0.1:0-:22\",\n> + \"-device\", \"virtio-net-pci,netdev=vnet\",\n> + \"-vnc\", \"127.0.0.1:0,to=20\",\n> + \"-serial\", \"file:%s\" % os.path.join(self._tmpdir, \"serial.out\")]\n> + if vcpus:\n> + self._args += [\"-smp\", str(vcpus)]\n> + if os.access(\"/dev/kvm\", os.R_OK | os.W_OK):\n> + self._args += [\"-enable-kvm\"]\n> + else:\n> + logging.info(\"KVM not available, not using -enable-kvm\")\n> + self._data_args = []\n> +\n> + def _download_with_cache(self, url, sha256sum=None):\n> + def check_sha256sum(fname):\n> + if not sha256sum:\n> + return True\n> + checksum = subprocess.check_output([\"sha256sum\", fname]).split()[0]\n> + return sha256sum == checksum\n> +\n> + cache_dir = os.path.expanduser(\"~/.cache/qemu-vm/download\")\n> + if not os.path.exists(cache_dir):\n> + os.makedirs(cache_dir)\n> + fname = os.path.join(cache_dir, hashlib.sha1(url).hexdigest())\n> + if os.path.exists(fname) and check_sha256sum(fname):\n> + return fname\n> + logging.debug(\"Downloading %s to %s...\", url, fname)\n> + subprocess.check_call([\"wget\", \"-c\", url, \"-O\", fname + \".download\"],\n> + stdout=self._stdout, stderr=self._stderr)\n> + os.rename(fname + \".download\", fname)\n> + return fname\n> +\n> + def _ssh_do(self, user, cmd, check, interactive=False):\n> + ssh_cmd = [\"ssh\", \"-q\",\n> + \"-o\", \"StrictHostKeyChecking=no\",\n> + \"-o\", \"UserKnownHostsFile=\" + os.devnull,\n> + \"-o\", \"ConnectTimeout=1\",\n> + \"-p\", self.ssh_port, \"-i\", self._ssh_key_file]\n> + if interactive:\n> + ssh_cmd += ['-t']\n> + assert not isinstance(cmd, str)\n> + ssh_cmd += [\"%s@127.0.0.1\" % user] + list(cmd)\n> + logging.debug(\"ssh_cmd: %s\", \" \".join(ssh_cmd))\n> + r = subprocess.call(ssh_cmd,\n> + stdin=sys.stdin if interactive else self._devnull,\n> + stdout=sys.stdout if interactive else self._stdout,\n> + stderr=sys.stderr if interactive else self._stderr)\n> + if check and r != 0:\n> + raise Exception(\"SSH command failed: %s\" % cmd)\n> + return r\n> +\n> + def ssh(self, *cmd):\n> + return self._ssh_do(self.GUEST_USER, cmd, False)\n> +\n> + def ssh_interactive(self, *cmd):\n> + return self._ssh_do(self.GUEST_USER, cmd, False, True)\n> +\n> + def ssh_root(self, *cmd):\n> + return self._ssh_do(\"root\", cmd, False)\n> +\n> + def ssh_check(self, *cmd):\n> + self._ssh_do(self.GUEST_USER, cmd, True)\n> +\n> + def ssh_root_check(self, *cmd):\n> + self._ssh_do(\"root\", cmd, True)\n> +\n> + def build_image(self, img):\n> + raise NotImplementedError\n> +\n> + def add_source_dir(self, src_dir):\n> + name = \"data-\" + hashlib.sha1(src_dir).hexdigest()[:5]\n> + tarfile = os.path.join(self._tmpdir, name + \".tar\")\n> + logging.debug(\"Creating archive %s for src_dir dir: %s\", tarfile, src_dir)\n> + subprocess.check_call([\"./scripts/archive-source.sh\", tarfile],\n> + cwd=src_dir, stdin=self._devnull,\n> + stdout=self._stdout, stderr=self._stderr)\n> + self._data_args += [\"-drive\",\n> + \"file=%s,if=none,id=%s,cache=writeback,format=raw\" % \\\n> + (tarfile, name),\n> + \"-device\",\n> + \"virtio-blk,drive=%s,serial=%s,bootindex=1\" % (name, name)]\n> +\n> + def boot(self, img, extra_args=[]):\n> + args = self._args + [\n> + \"-device\", \"VGA\",\n> + \"-drive\", \"file=%s,if=none,id=drive0,cache=writeback\" % img,\n> + \"-device\", \"virtio-blk,drive=drive0,bootindex=0\"]\n> + args += self._data_args + extra_args\n> + logging.debug(\"QEMU args: %s\", \" \".join(args))\n> + qemu_bin = os.environ.get(\"QEMU\", \"qemu-system-x86_64\")\n> + guest = QEMUMachine(binary=qemu_bin, args=args)\n> + try:\n> + guest.launch()\n> + except:\n> + logging.error(\"Failed to launch QEMU, command line:\")\n> + logging.error(\" \".join([qemu_bin] + args))\n> + logging.error(\"Log:\")\n> + logging.error(guest.get_log())\n> + logging.error(\"QEMU version >= 2.10 is required\")\n> + raise\n> + atexit.register(self.shutdown)\n> + self._guest = guest\n> + usernet_info = guest.qmp(\"human-monitor-command\",\n> + command_line=\"info usernet\")\n> + self.ssh_port = None\n> + for l in usernet_info[\"return\"].splitlines():\n> + fields = l.split()\n> + if \"TCP[HOST_FORWARD]\" in fields and \"22\" in fields:\n> + self.ssh_port = l.split()[3]\n> + if not self.ssh_port:\n> + raise Exception(\"Cannot find ssh port from 'info usernet':\\n%s\" % \\\n> + usernet_info)\n> +\n> + def wait_ssh(self, seconds=120):\n> + starttime = datetime.datetime.now()\n> + guest_up = False\n> + while (datetime.datetime.now() - starttime).total_seconds() < seconds:\n> + if self.ssh(\"exit 0\") == 0:\n> + guest_up = True\n> + break\n> + time.sleep(1)\n> + if not guest_up:\n> + raise Exception(\"Timeout while waiting for guest ssh\")\n> +\n> + def shutdown(self):\n> + self._guest.shutdown()\n> +\n> + def wait(self):\n> + self._guest.wait()\n> +\n> + def qmp(self, *args, **kwargs):\n> + return self._guest.qmp(*args, **kwargs)\n> +\n> +def parse_args(vm_name):\n> + parser = optparse.OptionParser(description=\"\"\"\n> + VM test utility. Exit codes: 0 = success, 1 = command line error, 2 = environment initialization failed, 3 = test command failed\"\"\")\n> + parser.add_option(\"--debug\", \"-D\", action=\"store_true\",\n> + help=\"enable debug output\")\n> + parser.add_option(\"--image\", \"-i\", default=\"%s.img\" % vm_name,\n> + help=\"image file name\")\n> + parser.add_option(\"--force\", \"-f\", action=\"store_true\",\n> + help=\"force build image even if image exists\")\n> + parser.add_option(\"--jobs\", type=int, default=multiprocessing.cpu_count() / 2,\n> + help=\"number of virtual CPUs\")\n> + parser.add_option(\"--build-image\", \"-b\", action=\"store_true\",\n> + help=\"build image\")\n> + parser.add_option(\"--build-qemu\",\n> + help=\"build QEMU from source in guest\")\n> + parser.add_option(\"--interactive\", \"-I\", action=\"store_true\",\n> + help=\"Interactively run command\")\n> + parser.disable_interspersed_args()\n> + return parser.parse_args()\n> +\n> +def main(vmcls):\n> + try:\n> + args, argv = parse_args(vmcls.name)\n> + if not argv and not args.build_qemu and not args.build_image:\n> + print \"Nothing to do?\"\n> + return 1\n> + if args.debug:\n> + logging.getLogger().setLevel(logging.DEBUG)\n> + vm = vmcls(debug=args.debug, vcpus=args.jobs)\n> + if args.build_image:\n> + if os.path.exists(args.image) and not args.force:\n> + sys.stderr.writelines([\"Image file exists: %s\\n\" % args.image,\n> + \"Use --force option to overwrite\\n\"])\n> + return 1\n> + return vm.build_image(args.image)\n> + if args.build_qemu:\n> + vm.add_source_dir(args.build_qemu)\n> + cmd = [vm.BUILD_SCRIPT.format(\n> + configure_opts = \" \".join(argv),\n> + jobs=args.jobs)]\n> + else:\n> + cmd = argv\n> + vm.boot(args.image + \",snapshot=on\")\n> + vm.wait_ssh()\n> + except Exception as e:\n> + if isinstance(e, SystemExit) and e.code == 0:\n> + return 0\n> + sys.stderr.write(\"Failed to prepare guest environment\\n\")\n> + traceback.print_exc()\n> + return 2\n> +\n> + if args.interactive:\n> + if vm.ssh_interactive(*cmd) == 0:\n> + return 0\n> + vm.ssh_interactive()\n> + return 3\n> + else:\n> + if vm.ssh(*cmd) != 0:\n> + return 3\n\n\n--\nAlex Bennée","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=)","ozlabs.org;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=linaro.org header.i=@linaro.org\n\theader.b=\"b3Z1Igso\"; dkim-atps=neutral"],"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 3xwhhT0BJYz9ryr\n\tfor ;\n\tMon, 18 Sep 2017 20:15:05 +1000 (AEST)","from localhost ([::1]:35570 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t)\n\tid 1dtt4x-0003KD-2O\n\tfor incoming@patchwork.ozlabs.org; Mon, 18 Sep 2017 06:15:03 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:40903)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from ) id 1dtt4U-0003K0-Dh\n\tfor qemu-devel@nongnu.org; Mon, 18 Sep 2017 06:14:36 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from ) id 1dtt4R-0002pb-6G\n\tfor qemu-devel@nongnu.org; Mon, 18 Sep 2017 06:14:34 -0400","from mail-wm0-x229.google.com ([2a00:1450:400c:c09::229]:46156)\n\tby eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16)\n\t(Exim 4.71) (envelope-from )\n\tid 1dtt4Q-0002pF-TQ\n\tfor qemu-devel@nongnu.org; Mon, 18 Sep 2017 06:14:31 -0400","by mail-wm0-x229.google.com with SMTP id i189so1201254wmf.1\n\tfor ; Mon, 18 Sep 2017 03:14:30 -0700 (PDT)","from zen.linaro.local ([81.128.185.34])\n\tby smtp.gmail.com with ESMTPSA id\n\tf13sm5899286wre.66.2017.09.18.03.14.28\n\t(version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\n\tMon, 18 Sep 2017 03:14:28 -0700 (PDT)","from zen (localhost [127.0.0.1])\n\tby zen.linaro.local (Postfix) with ESMTPS id 3D8F53E0258;\n\tMon, 18 Sep 2017 11:14:28 +0100 (BST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google;\n\th=references:user-agent:from:to:cc:subject:in-reply-to:date\n\t:message-id:mime-version:content-transfer-encoding;\n\tbh=xMZ3bPygjvfNTYXnR4B1gC2iHnU5ql4Yt4ARwGWH29A=;\n\tb=b3Z1IgsoJVbyq3rIQhIRAc9UmgiS3lsKR72KA8OY61boN/1xz2PXBYsfXe/q7ZgJwB\n\tovHRzHEXgwP454CsEciB+Q5V/oJWSj+fkcvE6XWkoVLfL0pErBgtfoS3LiTH/rfKa5p4\n\tHMOUfFB0tz8YzsMc4IF55EbT1QF809IlbZRV8=","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:references:user-agent:from:to:cc:subject\n\t:in-reply-to:date:message-id:mime-version:content-transfer-encoding; \n\tbh=xMZ3bPygjvfNTYXnR4B1gC2iHnU5ql4Yt4ARwGWH29A=;\n\tb=Iqbmx0IxNPbh/sVp1a9jVgHSuu8Tg4Qs2t8fHYGml7PLgeSPJKNd6GzLjqDKLWZs39\n\tu/WjcE5OiPU/R9H/WOyh9HGCI1/+DPrqfEcJBfMQl+jsDlItvff+o3b8pwMQ84SO/dK9\n\tPMQIrVp/m/Fx+rkfvJT/EEf3JucJg4DdCiwIpTJCKRf2YNAJRWd91BsZpLBR/qMvAQG7\n\t833t4ZhtcuuPRFSjlyOIvdKWaDcJO+2Pl3nGMWTBCKyou4384A0CDe7ZswbKbz56Ivip\n\tF/5YyX1Z3lB0RIBvbSTrEX+RTfnjbKnS6VsbzeHRJM2iyg6/CzKFczoi5tb/GPbuSyhS\n\tdD3w==","X-Gm-Message-State":"AHPjjUjzk3Unm9fpppazyRuTqUu7pYHcaNEE+lShRVgVrwRlp1RSE7hO\n\tqLipVsbDIUmWfqO6","X-Google-Smtp-Source":"AOwi7QBTz/ZN1OohW+S910Zgx3lu0gjw4Ayjdv7eak8EmN1c8xt5UlJ9EtR//Kz+5DUPY26AS9KZSg==","X-Received":"by 10.28.20.137 with SMTP id 131mr4786640wmu.40.1505729669729;\n\tMon, 18 Sep 2017 03:14:29 -0700 (PDT)","References":"<20170918024402.3265-1-famz@redhat.com>\n\t<20170918024402.3265-6-famz@redhat.com>","User-agent":"mu4e 0.9.19; emacs 25.3.50.1","From":"Alex =?utf-8?q?Benn=C3=A9e?= ","To":"Fam Zheng ","In-reply-to":"<20170918024402.3265-6-famz@redhat.com>","Date":"Mon, 18 Sep 2017 11:14:28 +0100","Message-ID":"<878thcjou3.fsf@linaro.org>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Transfer-Encoding":"8bit","X-detected-operating-system":"by eggs.gnu.org: Genre and OS details not\n\trecognized.","X-Received-From":"2a00:1450:400c:c09::229","Subject":"Re: [Qemu-devel] [PATCH v8 05/13] tests: Add vm test lib","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 , qemu-devel@nongnu.org, Philippe\n\t=?utf-8?q?Mathieu-Daud=C3=A9?= ,\n\tKamil Rytarowski , stefanha@redhat.com, \n\tCleber Rosa , pbonzini@redhat.com","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t"}}]