diff options
Diffstat (limited to 'tests/vm')
| -rw-r--r-- | tests/vm/Makefile.include | 42 | ||||
| -rw-r--r-- | tests/vm/README | 89 | ||||
| -rwxr-xr-x | tests/vm/basevm.py | 262 | ||||
| -rwxr-xr-x | tests/vm/freebsd | 42 | ||||
| -rwxr-xr-x | tests/vm/netbsd | 42 | ||||
| -rwxr-xr-x | tests/vm/openbsd | 43 | ||||
| -rwxr-xr-x | tests/vm/ubuntu.i386 | 89 |
7 files changed, 609 insertions, 0 deletions
diff --git a/tests/vm/Makefile.include b/tests/vm/Makefile.include new file mode 100644 index 0000000000..5daa2a3b73 --- /dev/null +++ b/tests/vm/Makefile.include @@ -0,0 +1,42 @@ +# Makefile for VM tests + +.PHONY: vm-build-all + +IMAGES := ubuntu.i386 freebsd netbsd openbsd +IMAGE_FILES := $(patsubst %, tests/vm/%.img, $(IMAGES)) + +.PRECIOUS: $(IMAGE_FILES) + +vm-test: + @echo "vm-test: Test QEMU in preconfigured virtual machines" + @echo + @echo " vm-build-ubuntu.i386 - Build QEMU in ubuntu i386 VM" + @echo " vm-build-freebsd - Build QEMU in FreeBSD VM" + @echo " vm-build-netbsd - Build QEMU in NetBSD VM" + @echo " vm-build-openbsd - Build QEMU in OpenBSD VM" + +vm-build-all: $(addprefix vm-build-, $(IMAGES)) + +tests/vm/%.img: $(SRC_PATH)/tests/vm/% \ + $(SRC_PATH)/tests/vm/basevm.py \ + $(SRC_PATH)/tests/vm/Makefile.include + $(call quiet-command, \ + $< \ + $(if $(V)$(DEBUG), --debug) \ + --image "$@" \ + --force \ + --build-image $@, \ + " VM-IMAGE $*") + + +# Build in VM $(IMAGE) +vm-build-%: tests/vm/%.img + $(call quiet-command, \ + $(SRC_PATH)/tests/vm/$* \ + $(if $(V)$(DEBUG), --debug) \ + $(if $(DEBUG), --interactive) \ + $(if $(J),--jobs $(J)) \ + --image "$<" \ + --build-qemu $(SRC_PATH), \ + " VM-BUILD $*") + diff --git a/tests/vm/README b/tests/vm/README new file mode 100644 index 0000000000..ae53dce6ee --- /dev/null +++ b/tests/vm/README @@ -0,0 +1,89 @@ +=== VM test suite to run build in guests === + +== Intro == + +This test suite contains scripts that bootstrap various guest images that have +necessary packages to build QEMU. The basic usage is documented in Makefile +help which is displayed with "make vm-test". + +== Quick start == + +Run "make vm-test" to list available make targets. Invoke a specific make +command to run build test in an image. For example, "make vm-build-freebsd" +will build the source tree in the FreeBSD image. The command can be executed +from either the source tree or the build dir; if the former, ./configure is not +needed. The command will then generate the test image in ./tests/vm/ under the +working directory. + +Note: images created by the scripts accept a well-known RSA key pair for SSH +access, so they SHOULD NOT be exposed to external interfaces if you are +concerned about attackers taking control of the guest and potentially +exploiting a QEMU security bug to compromise the host. + +== QEMU binary == + +By default, qemu-system-x86_64 is searched in $PATH to run the guest. If there +isn't one, or if it is older than 2.10, the test won't work. In this case, +provide the QEMU binary in env var: QEMU=/path/to/qemu-2.10+. + +== Make jobs == + +The "-j$X" option in the make command line is not propagated into the VM, +specify "J=$X" to control the make jobs in the guest. + +== Debugging == + +Add "DEBUG=1" and/or "V=1" to the make command to allow interactive debugging +and verbose output. If this is not enough, see the next section. + +== Manual invocation == + +Each guest script is an executable script with the same command line options. +For example to work with the netbsd guest, use $QEMU_SRC/tests/vm/netbsd: + + $ cd $QEMU_SRC/tests/vm + + # To bootstrap the image + $ ./netbsd --build-image --image /var/tmp/netbsd.img + <...> + + # To run an arbitrary command in guest (the output will not be echoed unless + # --debug is added) + $ ./netbsd --debug --image /var/tmp/netbsd.img uname -a + + # To build QEMU in guest + $ ./netbsd --debug --image /var/tmp/netbsd.img --build-qemu $QEMU_SRC + + # To get to an interactive shell + $ ./netbsd --interactive --image /var/tmp/netbsd.img sh + +== Adding new guests == + +Please look at existing guest scripts for how to add new guests. + +Most importantly, create a subclass of BaseVM and implement build_image() +method and define BUILD_SCRIPT, then finally call basevm.main() from the +script's main(). + + - Usually in build_image(), a template image is downloaded from a predefined + URL. BaseVM._download_with_cache() takes care of the cache and the + checksum, so consider using it. + + - Once the image is downloaded, users, SSH server and QEMU build deps should + be set up: + + * Root password set to BaseVM.ROOT_PASS + * User BaseVM.GUEST_USER is created, and password set to BaseVM.GUEST_PASS + * SSH service is enabled and started on boot, + $QEMU_SRC/tests/keys/id_rsa.pub is added to ssh's "authorized_keys" file + of both root and the normal user + * DHCP client service is enabled and started on boot, so that it can + automatically configure the virtio-net-pci NIC and communicate with QEMU + user net (10.0.2.2) + * Necessary packages are installed to untar the source tarball and build + QEMU + + - Write a proper BUILD_SCRIPT template, which should be a shell script that + untars a raw virtio-blk block device, which is the tarball data blob of the + QEMU source tree, then configure/build it. Running "make check" is also + recommended. diff --git a/tests/vm/basevm.py b/tests/vm/basevm.py new file mode 100755 index 0000000000..3c863bc237 --- /dev/null +++ b/tests/vm/basevm.py @@ -0,0 +1,262 @@ +#!/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. +# + +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", + "-cpu", "host", + "-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 += ["-enable-kvm"] + else: + logging.info("KVM not available, not using -enable-kvm") + 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, + stdin=sys.stdin if interactive else self._devnull, + stdout=sys.stdout if interactive else self._stdout, + stderr=sys.stderr if interactive else self._stderr) + 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 + if args.debug: + logging.getLogger().setLevel(logging.DEBUG) + 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 diff --git a/tests/vm/freebsd b/tests/vm/freebsd new file mode 100755 index 0000000000..039dad8f69 --- /dev/null +++ b/tests/vm/freebsd @@ -0,0 +1,42 @@ +#!/usr/bin/env python +# +# FreeBSD VM image +# +# 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. +# + +import os +import sys +import subprocess +import basevm + +class FreeBSDVM(basevm.BaseVM): + name = "freebsd" + BUILD_SCRIPT = """ + set -e; + cd $(mktemp -d /var/tmp/qemu-test.XXXXXX); + tar -xf /dev/vtbd1; + ./configure {configure_opts}; + gmake -j{jobs}; + gmake check; + """ + + def build_image(self, img): + cimg = self._download_with_cache("http://download.patchew.org/freebsd-11.1-amd64.img.xz", + sha256sum='adcb771549b37bc63826c501f05121a206ed3d9f55f49145908f7e1432d65891') + img_tmp_xz = img + ".tmp.xz" + img_tmp = img + ".tmp" + subprocess.check_call(["cp", "-f", cimg, img_tmp_xz]) + subprocess.check_call(["xz", "-df", img_tmp_xz]) + if os.path.exists(img): + os.remove(img) + os.rename(img_tmp, img) + +if __name__ == "__main__": + sys.exit(basevm.main(FreeBSDVM)) diff --git a/tests/vm/netbsd b/tests/vm/netbsd new file mode 100755 index 0000000000..3972d8b45c --- /dev/null +++ b/tests/vm/netbsd @@ -0,0 +1,42 @@ +#!/usr/bin/env python +# +# NetBSD VM image +# +# 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. +# + +import os +import sys +import subprocess +import basevm + +class NetBSDVM(basevm.BaseVM): + name = "netbsd" + BUILD_SCRIPT = """ + set -e; + cd $(mktemp -d /var/tmp/qemu-test.XXXXXX); + tar -xf /dev/rld1a; + ./configure --python=python2.7 {configure_opts}; + gmake -j{jobs}; + gmake check; + """ + + def build_image(self, img): + cimg = self._download_with_cache("http://download.patchew.org/netbsd-7.1-amd64.img.xz", + sha256sum='b633d565b0eac3d02015cd0c81440bd8a7a8df8512615ac1ee05d318be015732') + img_tmp_xz = img + ".tmp.xz" + img_tmp = img + ".tmp" + subprocess.check_call(["cp", "-f", cimg, img_tmp_xz]) + subprocess.check_call(["xz", "-df", img_tmp_xz]) + if os.path.exists(img): + os.remove(img) + os.rename(img_tmp, img) + +if __name__ == "__main__": + sys.exit(basevm.main(NetBSDVM)) diff --git a/tests/vm/openbsd b/tests/vm/openbsd new file mode 100755 index 0000000000..6ae16d97fd --- /dev/null +++ b/tests/vm/openbsd @@ -0,0 +1,43 @@ +#!/usr/bin/env python +# +# OpenBSD VM image +# +# 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. +# + +import os +import sys +import subprocess +import basevm + +class OpenBSDVM(basevm.BaseVM): + name = "openbsd" + BUILD_SCRIPT = """ + set -e; + cd $(mktemp -d /var/tmp/qemu-test.XXXXXX); + tar -xf /dev/rsd1c; + ./configure --cc=x86_64-unknown-openbsd6.1-gcc-4.9.4 --python=python2.7 {configure_opts}; + gmake -j{jobs}; + # XXX: "gmake check" seems to always hang or fail + #gmake check; + """ + + def build_image(self, img): + cimg = self._download_with_cache("http://download.patchew.org/openbsd-6.1-amd64.img.xz", + sha256sum='8c6cedc483e602cfee5e04f0406c64eb99138495e8ca580bc0293bcf0640c1bf') + img_tmp_xz = img + ".tmp.xz" + img_tmp = img + ".tmp" + subprocess.check_call(["cp", "-f", cimg, img_tmp_xz]) + subprocess.check_call(["xz", "-df", img_tmp_xz]) + if os.path.exists(img): + os.remove(img) + os.rename(img_tmp, img) + +if __name__ == "__main__": + sys.exit(basevm.main(OpenBSDVM)) diff --git a/tests/vm/ubuntu.i386 b/tests/vm/ubuntu.i386 new file mode 100755 index 0000000000..fc319e0e6e --- /dev/null +++ b/tests/vm/ubuntu.i386 @@ -0,0 +1,89 @@ +#!/usr/bin/env python +# +# Ubuntu i386 image +# +# 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. +# + +import os +import sys +import subprocess +import basevm +import time + +class UbuntuX86VM(basevm.BaseVM): + name = "ubuntu.i386" + BUILD_SCRIPT = """ + set -e; + cd $(mktemp -d); + sudo chmod a+r /dev/vdb; + tar -xf /dev/vdb; + ./configure {configure_opts}; + make -j{jobs}; + make check; + """ + + def _gen_cloud_init_iso(self): + cidir = self._tmpdir + mdata = open(os.path.join(cidir, "meta-data"), "w") + mdata.writelines(["instance-id: ubuntu-vm-0\n", + "local-hostname: ubuntu-guest\n"]) + mdata.close() + udata = open(os.path.join(cidir, "user-data"), "w") + udata.writelines(["#cloud-config\n", + "chpasswd:\n", + " list: |\n", + " root:%s\n" % self.ROOT_PASS, + " %s:%s\n" % (self.GUEST_USER, self.GUEST_PASS), + " expire: False\n", + "users:\n", + " - name: %s\n" % self.GUEST_USER, + " sudo: ALL=(ALL) NOPASSWD:ALL\n", + " ssh-authorized-keys:\n", + " - %s\n" % basevm.SSH_PUB_KEY, + " - name: root\n", + " ssh-authorized-keys:\n", + " - %s\n" % basevm.SSH_PUB_KEY, + "locale: en_US.UTF-8\n"]) + udata.close() + subprocess.check_call(["genisoimage", "-output", "cloud-init.iso", + "-volid", "cidata", "-joliet", "-rock", + "user-data", "meta-data"], + cwd=cidir, + stdin=self._devnull, stdout=self._stdout, + stderr=self._stdout) + return os.path.join(cidir, "cloud-init.iso") + + def build_image(self, img): + cimg = self._download_with_cache("https://cloud-images.ubuntu.com/releases/16.04/release/ubuntu-16.04-server-cloudimg-i386-disk1.img") + img_tmp = img + ".tmp" + subprocess.check_call(["cp", "-f", cimg, img_tmp]) + subprocess.check_call(["qemu-img", "resize", img_tmp, "50G"]) + self.boot(img_tmp, extra_args = ["-cdrom", self._gen_cloud_init_iso()]) + self.wait_ssh() + self.ssh_root_check("touch /etc/cloud/cloud-init.disabled") + self.ssh_root_check("apt-get update") + self.ssh_root_check("apt-get install -y cloud-initramfs-growroot") + # Don't check the status in case the guest hang up too quickly + self.ssh_root("sync && reboot") + time.sleep(5) + self.wait_ssh() + # The previous update sometimes doesn't survive a reboot, so do it again + self.ssh_root_check("apt-get update") + self.ssh_root_check("apt-get build-dep -y qemu") + self.ssh_root_check("apt-get install -y libfdt-dev") + self.ssh_root("poweroff") + self.wait() + if os.path.exists(img): + os.remove(img) + os.rename(img_tmp, img) + return 0 + +if __name__ == "__main__": + sys.exit(basevm.main(UbuntuX86VM)) |