[mirror_qemu.git] / tests / vm / basevm.py

#!/usr/bin/env python
#
# VM testing base class
#
# Copyright 2017 Red Hat Inc.
#
# Authors:
#  Fam Zheng <famz@redhat.com>
#
# This code is licensed under the GPL version 2 or later.  See
# the COPYING file in the top-level directory.
#

from __future__ import print_function
import os
import sys
import logging
import time
import datetime
sys.path.append(os.path.join(os.path.dirname(__file__), "..", "..", "scripts"))
from qemu import QEMUMachine
import subprocess
import hashlib
import optparse
import atexit
import tempfile
import shutil
import multiprocessing
import traceback

SSH_KEY = open(os.path.join(os.path.dirname(__file__),
               "..", "keys", "id_rsa")).read()
SSH_PUB_KEY = open(os.path.join(os.path.dirname(__file__),
                   "..", "keys", "id_rsa.pub")).read()

class BaseVM(object):
    GUEST_USER = "qemu"
    GUEST_PASS = "qemupass"
    ROOT_PASS = "qemupass"

    # The script to run in the guest that builds QEMU
    BUILD_SCRIPT = ""
    # The guest name, to be overridden by subclasses
    name = "#base"
    def __init__(self, debug=False, vcpus=None):
        self._guest = None
        self._tmpdir = os.path.realpath(tempfile.mkdtemp(prefix="vm-test-",
                                                         suffix=".tmp",
                                                         dir="."))
        atexit.register(shutil.rmtree, self._tmpdir)

        self._ssh_key_file = os.path.join(self._tmpdir, "id_rsa")
        open(self._ssh_key_file, "w").write(SSH_KEY)
        subprocess.check_call(["chmod", "600", self._ssh_key_file])

        self._ssh_pub_key_file = os.path.join(self._tmpdir, "id_rsa.pub")
        open(self._ssh_pub_key_file, "w").write(SSH_PUB_KEY)

        self.debug = debug
        self._stderr = sys.stderr
        self._devnull = open(os.devnull, "w")
        if self.debug:
            self._stdout = sys.stdout
        else:
            self._stdout = self._devnull
        self._args = [ \
            "-nodefaults", "-m", "2G",
            "-netdev", "user,id=vnet,hostfwd=:127.0.0.1:0-:22",
            "-device", "virtio-net-pci,netdev=vnet",
            "-vnc", "127.0.0.1:0,to=20",
            "-serial", "file:%s" % os.path.join(self._tmpdir, "serial.out")]
        if vcpus:
            self._args += ["-smp", str(vcpus)]
        if os.access("/dev/kvm", os.R_OK | os.W_OK):
            self._args += ["-cpu", "host"]
            self._args += ["-enable-kvm"]
        else:
            logging.info("KVM not available, not using -enable-kvm")
            self._args += ["-cpu", "max"]
        self._data_args = []

    def _download_with_cache(self, url, sha256sum=None):
        def check_sha256sum(fname):
            if not sha256sum:
                return True
            checksum = subprocess.check_output(["sha256sum", fname]).split()[0]
            return sha256sum == checksum

        cache_dir = os.path.expanduser("~/.cache/qemu-vm/download")
        if not os.path.exists(cache_dir):
            os.makedirs(cache_dir)
        fname = os.path.join(cache_dir, hashlib.sha1(url).hexdigest())
        if os.path.exists(fname) and check_sha256sum(fname):
            return fname
        logging.debug("Downloading %s to %s...", url, fname)
        subprocess.check_call(["wget", "-c", url, "-O", fname + ".download"],
                              stdout=self._stdout, stderr=self._stderr)
        os.rename(fname + ".download", fname)
        return fname

    def _ssh_do(self, user, cmd, check, interactive=False):
        ssh_cmd = ["ssh", "-q",
                   "-o", "StrictHostKeyChecking=no",
                   "-o", "UserKnownHostsFile=" + os.devnull,
                   "-o", "ConnectTimeout=1",
                   "-p", self.ssh_port, "-i", self._ssh_key_file]
        if interactive:
            ssh_cmd += ['-t']
        assert not isinstance(cmd, str)
        ssh_cmd += ["%s@127.0.0.1" % user] + list(cmd)
        logging.debug("ssh_cmd: %s", " ".join(ssh_cmd))
        r = subprocess.call(ssh_cmd)
        if check and r != 0:
            raise Exception("SSH command failed: %s" % cmd)
        return r

    def ssh(self, *cmd):
        return self._ssh_do(self.GUEST_USER, cmd, False)

    def ssh_interactive(self, *cmd):
        return self._ssh_do(self.GUEST_USER, cmd, False, True)

    def ssh_root(self, *cmd):
        return self._ssh_do("root", cmd, False)

    def ssh_check(self, *cmd):
        self._ssh_do(self.GUEST_USER, cmd, True)

    def ssh_root_check(self, *cmd):
        self._ssh_do("root", cmd, True)

    def build_image(self, img):
        raise NotImplementedError

    def add_source_dir(self, src_dir):
        name = "data-" + hashlib.sha1(src_dir).hexdigest()[:5]
        tarfile = os.path.join(self._tmpdir, name + ".tar")
        logging.debug("Creating archive %s for src_dir dir: %s", tarfile, src_dir)
        subprocess.check_call(["./scripts/archive-source.sh", tarfile],
                              cwd=src_dir, stdin=self._devnull,
                              stdout=self._stdout, stderr=self._stderr)
        self._data_args += ["-drive",
                            "file=%s,if=none,id=%s,cache=writeback,format=raw" % \
                                    (tarfile, name),
                            "-device",
                            "virtio-blk,drive=%s,serial=%s,bootindex=1" % (name, name)]

    def boot(self, img, extra_args=[]):
        args = self._args + [
            "-device", "VGA",
            "-drive", "file=%s,if=none,id=drive0,cache=writeback" % img,
            "-device", "virtio-blk,drive=drive0,bootindex=0"]
        args += self._data_args + extra_args
        logging.debug("QEMU args: %s", " ".join(args))
        qemu_bin = os.environ.get("QEMU", "qemu-system-x86_64")
        guest = QEMUMachine(binary=qemu_bin, args=args)
        try:
            guest.launch()
        except:
            logging.error("Failed to launch QEMU, command line:")
            logging.error(" ".join([qemu_bin] + args))
            logging.error("Log:")
            logging.error(guest.get_log())
            logging.error("QEMU version >= 2.10 is required")
            raise
        atexit.register(self.shutdown)
        self._guest = guest
        usernet_info = guest.qmp("human-monitor-command",
                                 command_line="info usernet")
        self.ssh_port = None
        for l in usernet_info["return"].splitlines():
            fields = l.split()
            if "TCP[HOST_FORWARD]" in fields and "22" in fields:
                self.ssh_port = l.split()[3]
        if not self.ssh_port:
            raise Exception("Cannot find ssh port from 'info usernet':\n%s" % \
                            usernet_info)

    def wait_ssh(self, seconds=120):
        starttime = datetime.datetime.now()
        guest_up = False
        while (datetime.datetime.now() - starttime).total_seconds() < seconds:
            if self.ssh("exit 0") == 0:
                guest_up = True
                break
            time.sleep(1)
        if not guest_up:
            raise Exception("Timeout while waiting for guest ssh")

    def shutdown(self):
        self._guest.shutdown()

    def wait(self):
        self._guest.wait()

    def qmp(self, *args, **kwargs):
        return self._guest.qmp(*args, **kwargs)

def parse_args(vm_name):
    parser = optparse.OptionParser(
        description="VM test utility.  Exit codes: "
                    "0 = success, "
                    "1 = command line error, "
                    "2 = environment initialization failed, "
                    "3 = test command failed")
    parser.add_option("--debug", "-D", action="store_true",
                      help="enable debug output")
    parser.add_option("--image", "-i", default="%s.img" % vm_name,
                      help="image file name")
    parser.add_option("--force", "-f", action="store_true",
                      help="force build image even if image exists")
    parser.add_option("--jobs", type=int, default=multiprocessing.cpu_count() / 2,
                      help="number of virtual CPUs")
    parser.add_option("--build-image", "-b", action="store_true",
                      help="build image")
    parser.add_option("--build-qemu",
                      help="build QEMU from source in guest")
    parser.add_option("--interactive", "-I", action="store_true",
                      help="Interactively run command")
    parser.disable_interspersed_args()
    return parser.parse_args()

def main(vmcls):
    try:
        args, argv = parse_args(vmcls.name)
        if not argv and not args.build_qemu and not args.build_image:
            print("Nothing to do?")
            return 1
        logging.basicConfig(level=(logging.DEBUG if args.debug
                                   else logging.WARN))
        vm = vmcls(debug=args.debug, vcpus=args.jobs)
        if args.build_image:
            if os.path.exists(args.image) and not args.force:
                sys.stderr.writelines(["Image file exists: %s\n" % args.image,
                                      "Use --force option to overwrite\n"])
                return 1
            return vm.build_image(args.image)
        if args.build_qemu:
            vm.add_source_dir(args.build_qemu)
            cmd = [vm.BUILD_SCRIPT.format(
                   configure_opts = " ".join(argv),
                   jobs=args.jobs)]
        else:
            cmd = argv
        vm.boot(args.image + ",snapshot=on")
        vm.wait_ssh()
    except Exception as e:
        if isinstance(e, SystemExit) and e.code == 0:
            return 0
        sys.stderr.write("Failed to prepare guest environment\n")
        traceback.print_exc()
        return 2

    if args.interactive:
        if vm.ssh_interactive(*cmd) == 0:
            return 0
        vm.ssh_interactive()
        return 3
    else:
        if vm.ssh(*cmd) != 0:
            return 3
Commit	Line	Data
ff2ebff0 FZ	1	#!/usr/bin/env python
	2	#
	3	# VM testing base class
	4	#
	5	# Copyright 2017 Red Hat Inc.
	6	#
	7	# Authors:
	8	# Fam Zheng <famz@redhat.com>
	9	#
	10	# This code is licensed under the GPL version 2 or later. See
	11	# the COPYING file in the top-level directory.
	12	#
	13
f03868bd	14	from __future__ import print_function
ff2ebff0 FZ	15	import os
	16	import sys
	17	import logging
	18	import time
	19	import datetime
	20	sys.path.append(os.path.join(os.path.dirname(__file__), "..", "..", "scripts"))
	21	from qemu import QEMUMachine
	22	import subprocess
	23	import hashlib
	24	import optparse
	25	import atexit
	26	import tempfile
	27	import shutil
	28	import multiprocessing
	29	import traceback
	30
	31	SSH_KEY = open(os.path.join(os.path.dirname(__file__),
	32	"..", "keys", "id_rsa")).read()
	33	SSH_PUB_KEY = open(os.path.join(os.path.dirname(__file__),
	34	"..", "keys", "id_rsa.pub")).read()
	35
	36	class BaseVM(object):
	37	GUEST_USER = "qemu"
	38	GUEST_PASS = "qemupass"
	39	ROOT_PASS = "qemupass"
	40
	41	# The script to run in the guest that builds QEMU
	42	BUILD_SCRIPT = ""
	43	# The guest name, to be overridden by subclasses
	44	name = "#base"
	45	def __init__(self, debug=False, vcpus=None):
	46	self._guest = None
	47	self._tmpdir = os.path.realpath(tempfile.mkdtemp(prefix="vm-test-",
	48	suffix=".tmp",
	49	dir="."))
	50	atexit.register(shutil.rmtree, self._tmpdir)
	51
	52	self._ssh_key_file = os.path.join(self._tmpdir, "id_rsa")
	53	open(self._ssh_key_file, "w").write(SSH_KEY)
	54	subprocess.check_call(["chmod", "600", self._ssh_key_file])
	55
	56	self._ssh_pub_key_file = os.path.join(self._tmpdir, "id_rsa.pub")
	57	open(self._ssh_pub_key_file, "w").write(SSH_PUB_KEY)
	58
	59	self.debug = debug
	60	self._stderr = sys.stderr
	61	self._devnull = open(os.devnull, "w")
	62	if self.debug:
	63	self._stdout = sys.stdout
	64	else:
	65	self._stdout = self._devnull
	66	self._args = [ \
	67	"-nodefaults", "-m", "2G",
ff2ebff0 FZ	68	"-netdev", "user,id=vnet,hostfwd=:127.0.0.1:0-:22",
	69	"-device", "virtio-net-pci,netdev=vnet",
	70	"-vnc", "127.0.0.1:0,to=20",
	71	"-serial", "file:%s" % os.path.join(self._tmpdir, "serial.out")]
	72	if vcpus:
	73	self._args += ["-smp", str(vcpus)]
	74	if os.access("/dev/kvm", os.R_OK \| os.W_OK):
dcf7ea4a	75	self._args += ["-cpu", "host"]
ff2ebff0 FZ	76	self._args += ["-enable-kvm"]
	77	else:
	78	logging.info("KVM not available, not using -enable-kvm")
dcf7ea4a	79	self._args += ["-cpu", "max"]
ff2ebff0 FZ	80	self._data_args = []
	81
	82	def _download_with_cache(self, url, sha256sum=None):
	83	def check_sha256sum(fname):
	84	if not sha256sum:
	85	return True
	86	checksum = subprocess.check_output(["sha256sum", fname]).split()[0]
	87	return sha256sum == checksum
	88
	89	cache_dir = os.path.expanduser("~/.cache/qemu-vm/download")
	90	if not os.path.exists(cache_dir):
	91	os.makedirs(cache_dir)
	92	fname = os.path.join(cache_dir, hashlib.sha1(url).hexdigest())
	93	if os.path.exists(fname) and check_sha256sum(fname):
	94	return fname
	95	logging.debug("Downloading %s to %s...", url, fname)
	96	subprocess.check_call(["wget", "-c", url, "-O", fname + ".download"],
	97	stdout=self._stdout, stderr=self._stderr)
	98	os.rename(fname + ".download", fname)
	99	return fname
	100
	101	def _ssh_do(self, user, cmd, check, interactive=False):
	102	ssh_cmd = ["ssh", "-q",
	103	"-o", "StrictHostKeyChecking=no",
	104	"-o", "UserKnownHostsFile=" + os.devnull,
	105	"-o", "ConnectTimeout=1",
	106	"-p", self.ssh_port, "-i", self._ssh_key_file]
	107	if interactive:
	108	ssh_cmd += ['-t']
	109	assert not isinstance(cmd, str)
	110	ssh_cmd += ["%s@127.0.0.1" % user] + list(cmd)
	111	logging.debug("ssh_cmd: %s", " ".join(ssh_cmd))
726c9a3b	112	r = subprocess.call(ssh_cmd)
ff2ebff0 FZ	113	if check and r != 0:
	114	raise Exception("SSH command failed: %s" % cmd)
	115	return r
	116
	117	def ssh(self, *cmd):
	118	return self._ssh_do(self.GUEST_USER, cmd, False)
	119
	120	def ssh_interactive(self, *cmd):
	121	return self._ssh_do(self.GUEST_USER, cmd, False, True)
	122
	123	def ssh_root(self, *cmd):
	124	return self._ssh_do("root", cmd, False)
	125
	126	def ssh_check(self, *cmd):
	127	self._ssh_do(self.GUEST_USER, cmd, True)
	128
	129	def ssh_root_check(self, *cmd):
	130	self._ssh_do("root", cmd, True)
	131
	132	def build_image(self, img):
	133	raise NotImplementedError
	134
	135	def add_source_dir(self, src_dir):
	136	name = "data-" + hashlib.sha1(src_dir).hexdigest()[:5]
	137	tarfile = os.path.join(self._tmpdir, name + ".tar")
	138	logging.debug("Creating archive %s for src_dir dir: %s", tarfile, src_dir)
	139	subprocess.check_call(["./scripts/archive-source.sh", tarfile],
	140	cwd=src_dir, stdin=self._devnull,
	141	stdout=self._stdout, stderr=self._stderr)
	142	self._data_args += ["-drive",
	143	"file=%s,if=none,id=%s,cache=writeback,format=raw" % \
	144	(tarfile, name),
	145	"-device",
	146	"virtio-blk,drive=%s,serial=%s,bootindex=1" % (name, name)]
	147
	148	def boot(self, img, extra_args=[]):
	149	args = self._args + [
	150	"-device", "VGA",
	151	"-drive", "file=%s,if=none,id=drive0,cache=writeback" % img,
	152	"-device", "virtio-blk,drive=drive0,bootindex=0"]
	153	args += self._data_args + extra_args
	154	logging.debug("QEMU args: %s", " ".join(args))
	155	qemu_bin = os.environ.get("QEMU", "qemu-system-x86_64")
	156	guest = QEMUMachine(binary=qemu_bin, args=args)
	157	try:
	158	guest.launch()
	159	except:
	160	logging.error("Failed to launch QEMU, command line:")
	161	logging.error(" ".join([qemu_bin] + args))
	162	logging.error("Log:")
	163	logging.error(guest.get_log())
	164	logging.error("QEMU version >= 2.10 is required")
	165	raise
	166	atexit.register(self.shutdown)
	167	self._guest = guest
	168	usernet_info = guest.qmp("human-monitor-command",
	169	command_line="info usernet")
	170	self.ssh_port = None
	171	for l in usernet_info["return"].splitlines():
	172	fields = l.split()
	173	if "TCP[HOST_FORWARD]" in fields and "22" in fields:
	174	self.ssh_port = l.split()[3]
	175	if not self.ssh_port:
	176	raise Exception("Cannot find ssh port from 'info usernet':\n%s" % \
177	usernet_info)
178
179	def wait_ssh(self, seconds=120):
180	starttime = datetime.datetime.now()
181	guest_up = False
182	while (datetime.datetime.now() - starttime).total_seconds() < seconds:
183	if self.ssh("exit 0") == 0:
184	guest_up = True
185	break
186	time.sleep(1)
187	if not guest_up:
188	raise Exception("Timeout while waiting for guest ssh")
189
190	def shutdown(self):
191	self._guest.shutdown()
192
193	def wait(self):
194	self._guest.wait()
195
196	def qmp(self, args, *kwargs):
197	return self._guest.qmp(args, *kwargs)
198
199	def parse_args(vm_name):
200	parser = optparse.OptionParser(
201	description="VM test utility. Exit codes: "
202	"0 = success, "
203	"1 = command line error, "
204	"2 = environment initialization failed, "
205	"3 = test command failed")
206	parser.add_option("--debug", "-D", action="store_true",
207	help="enable debug output")
208	parser.add_option("--image", "-i", default="%s.img" % vm_name,
209	help="image file name")
210	parser.add_option("--force", "-f", action="store_true",
211	help="force build image even if image exists")
212	parser.add_option("--jobs", type=int, default=multiprocessing.cpu_count() / 2,
213	help="number of virtual CPUs")
214	parser.add_option("--build-image", "-b", action="store_true",
215	help="build image")
216	parser.add_option("--build-qemu",
217	help="build QEMU from source in guest")
218	parser.add_option("--interactive", "-I", action="store_true",
219	help="Interactively run command")
220	parser.disable_interspersed_args()
221	return parser.parse_args()
222
223	def main(vmcls):
224	try:
225	args, argv = parse_args(vmcls.name)
226	if not argv and not args.build_qemu and not args.build_image:
f03868bd	227	print("Nothing to do?")
ff2ebff0	228	return 1
fb3b4e6d EH	229	logging.basicConfig(level=(logging.DEBUG if args.debug
fb3b4e6d EH	230	else logging.WARN))
ff2ebff0 FZ	231	vm = vmcls(debug=args.debug, vcpus=args.jobs)
	232	if args.build_image:
	233	if os.path.exists(args.image) and not args.force:
	234	sys.stderr.writelines(["Image file exists: %s\n" % args.image,
	235	"Use --force option to overwrite\n"])
	236	return 1
	237	return vm.build_image(args.image)
	238	if args.build_qemu:
	239	vm.add_source_dir(args.build_qemu)
	240	cmd = [vm.BUILD_SCRIPT.format(
	241	configure_opts = " ".join(argv),
	242	jobs=args.jobs)]
	243	else:
	244	cmd = argv
	245	vm.boot(args.image + ",snapshot=on")
	246	vm.wait_ssh()
	247	except Exception as e:
	248	if isinstance(e, SystemExit) and e.code == 0:
	249	return 0
	250	sys.stderr.write("Failed to prepare guest environment\n")
	251	traceback.print_exc()
	252	return 2
	253
	254	if args.interactive:
	255	if vm.ssh_interactive(*cmd) == 0:
	256	return 0
	257	vm.ssh_interactive()
	258	return 3
	259	else:
	260	if vm.ssh(*cmd) != 0:
	261	return 3