| # -*- coding: utf-8 -*- |
| # Copyright 2019 The Chromium OS Authors. All rights reserved. |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| """Unit tests for VM.""" |
| |
| from __future__ import print_function |
| |
| import mock |
| import os |
| import socket |
| import stat |
| |
| from chromite.cli.cros import cros_chrome_sdk |
| from chromite.lib import constants |
| from chromite.lib import cros_build_lib |
| from chromite.lib import cros_logging as logging |
| from chromite.lib import cros_test_lib |
| from chromite.lib import osutils |
| from chromite.lib import partial_mock |
| from chromite.lib import remote_access |
| from chromite.lib import vm |
| |
| |
| # pylint: disable=protected-access |
| class VMTester(cros_test_lib.RunCommandTempDirTestCase): |
| """Test vm.VM.""" |
| |
| def setUp(self): |
| """Common set up method for all tests.""" |
| opts = vm.VM.GetParser().parse_args([]) |
| self._vm = vm.VM(opts) |
| self._vm.board = 'amd64-generic' |
| self._vm.cache_dir = self.tempdir |
| self._vm.image_path = self.TempFilePath('chromiumos_qemu_image.bin') |
| osutils.Touch(self._vm.image_path) |
| |
| # Satisfy QEMU version check. |
| version_str = ('QEMU emulator version 2.6.0, Copyright (c) ' |
| '2003-2008 Fabrice Bellard') |
| self.rc.AddCmdResult(partial_mock.In('--version'), output=version_str) |
| |
| self.ssh_port = self._vm.ssh_port |
| |
| def TempFilePath(self, file_path): |
| return os.path.join(self.tempdir, file_path) |
| |
| def TempVMPath(self, kvm_file): |
| return self.TempFilePath(os.path.join('cros_vm_%d' % self.ssh_port, |
| kvm_file)) |
| |
| def FindPathInArgs(self, args, path): |
| """Checks the called commands to see if the path is present. |
| |
| Args: |
| args: List of called commands. |
| path: Path to check if present in the called commands. |
| |
| Returns: |
| Whether the path is found in the called commands. |
| """ |
| for call in args: |
| # A typical call looks like: |
| # call(['.../chroot/usr/bin/qemu-system-x86_64', '--version'], |
| # capture_output=True) |
| if any(path in a for a in call[0][0]): |
| return True |
| return False |
| |
| def testStart(self): |
| self._vm.Start() |
| self.assertCommandContains([self._vm.qemu_path]) |
| self.assertCommandContains(['-m', '8G', '-smp', '8', '-vga', 'virtio', |
| '-daemonize', '-usbdevice', 'tablet',]) |
| self.assertCommandContains([ |
| '-pidfile', self.TempVMPath('kvm.pid'), |
| '-chardev', 'pipe,id=control_pipe,path=%s' |
| % self.TempVMPath('kvm.monitor'), |
| '-serial', 'file:%s' % self.TempVMPath('kvm.monitor.serial'), |
| '-mon', 'chardev=control_pipe', |
| ]) |
| self.assertCommandContains([ |
| '-cpu', 'SandyBridge,-invpcid,-tsc-deadline,check', |
| ]) |
| self.assertCommandContains([ |
| '-device', 'virtio-net,netdev=eth0', |
| '-netdev', 'user,id=eth0,net=10.0.2.0/27,hostfwd=tcp:127.0.0.1:9222-:22' |
| ]) |
| self.assertCommandContains([ |
| '-device', 'virtio-scsi-pci,id=scsi', '-device', 'scsi-hd,drive=hd', |
| '-drive', 'if=none,id=hd,file=%s,cache=unsafe,format=raw' |
| % self.TempFilePath('chromiumos_qemu_image.bin'), |
| ]) |
| self.assertCommandContains(['-enable-kvm']) |
| |
| def testStop(self): |
| pid = '12345' |
| self.assertEqual(self._vm.pidfile, self.TempVMPath('kvm.pid')) |
| osutils.WriteFile(self._vm.pidfile, pid) |
| self._vm.Stop() |
| self.assertCommandContains(['kill', '-9', pid]) |
| |
| def testBuiltVMImagePath(self): |
| """Verify locally built VM image path is picked up by vm.VM.""" |
| self._vm.image_path = None |
| expected_vm_image_path = os.path.join(constants.SOURCE_ROOT, |
| 'src/build/images/%s/latest/' |
| 'chromiumos_qemu_image.bin' |
| % self._vm.board) |
| osutils.Touch(expected_vm_image_path, makedirs=True) |
| self._vm.Start() |
| self.assertTrue(self.FindPathInArgs(self.rc.call_args_list, |
| expected_vm_image_path)) |
| |
| def testSDKVMImagePath(self): |
| """Verify vm.VM picks up the downloaded VM in the SDK.""" |
| self._vm.image_path = None |
| cache_dir = cros_test_lib.FakeSDKCache( |
| self._vm.cache_dir).CreateCacheReference(self._vm.board, |
| constants.VM_IMAGE_TAR) |
| vm_cache_path = os.path.join(cache_dir, constants.VM_IMAGE_BIN) |
| osutils.Touch(vm_cache_path, makedirs=True) |
| self._vm.Start() |
| expected_vm_image_path = os.path.join( |
| self._vm.cache_dir, |
| 'chrome-sdk/tarballs/%s+12225.0.0+chromiumos_qemu_image.tar.xz/' |
| 'chromiumos_qemu_image.bin' % self._vm.board) |
| self.assertTrue(self.FindPathInArgs(self.rc.call_args_list, |
| expected_vm_image_path)) |
| |
| def testVMImageNotFound(self): |
| """Verify that VMError is raised when a fake board image cannot be found.""" |
| self._vm.image_path = None |
| self._vm.board = 'fake_board_name' |
| self.assertRaises(vm.VMError, self._vm.Start) |
| |
| def testVMImageDoesNotExist(self): |
| """Verify that VMError is raised when image path is not real.""" |
| self._vm.image_path = '/fake/path/to/the/vm/image' |
| self.assertRaises(vm.VMError, self._vm.Start) |
| |
| def testAppendBinFile(self): |
| """When image-path points to a directory, we should append the bin file.""" |
| self._vm.image_path = self.tempdir |
| self._vm.Start() |
| self.assertEqual(self._vm.image_path, |
| self.TempFilePath('chromiumos_qemu_image.bin')) |
| |
| def testChrootQemuPath(self): |
| """Verify that QEMU in the chroot is picked up by vm.VM.""" |
| if cros_build_lib.IsInsideChroot(): |
| self._vm._SetQemuPath() |
| self.assertTrue('usr/bin/qemu-system-x86_64' in self._vm.qemu_path) |
| |
| def testSDKQemuPath(self): |
| """Verify vm.VM picks up the downloaded QEMU in the SDK.""" |
| self._vm.qemu_path = None |
| qemu_dir_path = cros_chrome_sdk.SDKFetcher.QEMU_BIN_PATH |
| # Creates a fake SDK cache with the QEMU binary. |
| qemu_path = cros_test_lib.FakeSDKCache( |
| self._vm.cache_dir).CreateCacheReference(self._vm.board, qemu_dir_path) |
| qemu_path = os.path.join(qemu_path, |
| 'usr', 'bin', 'qemu-system-x86_64') |
| osutils.Touch(qemu_path, makedirs=True) |
| self._vm._SetQemuPath() |
| self.assertEqual(self._vm.qemu_path, qemu_path) |
| |
| @mock.patch('chromite.lib.vm.VM._CheckQemuMinVersion') |
| def testSystemQemuPath(self, check_min_version_mock): |
| """Verify that QEMU in the system is picked up by vm.VM.""" |
| # Skip the SDK Cache. |
| os.environ[cros_chrome_sdk.SDKFetcher.SDK_VERSION_ENV] = 'None' |
| |
| # Skip the Chroot. |
| self._vm.chroot_path = 'fake/path' |
| |
| # Checks the QEMU path in the system. |
| qemu_path = self.TempFilePath('qemu-system-x86_64') |
| osutils.Touch(qemu_path, mode=stat.S_IRWXU, makedirs=True) |
| qemu_dir = os.path.dirname(qemu_path) |
| |
| os.environ['PATH'] = qemu_dir |
| self._vm._SetQemuPath() |
| |
| # SetQemuPath() calls _CheckQemuMinVersion(). |
| # Checks that mock version has been called. |
| check_min_version_mock.assert_called() |
| |
| self.assertEqual(self._vm.qemu_path, qemu_path) |
| |
| def testInvalidQemuBiosPath(self): |
| """Verify that VMError is raised for nonexistent qemu bios path.""" |
| self._vm.qemu_bios_path = '/invalid/qemu/bios/path/' |
| self.assertRaises(vm.VMError, self._vm.Start) |
| |
| def testCreateQcow2Image(self): |
| """Tests that a qcow2 image is created with --copy-on-write.""" |
| self._vm.copy_on_write = True |
| initial_img_path = self._vm.image_path |
| self._vm.Start() |
| |
| self.assertCommandContains([ |
| self._vm.qemu_img_path, 'create', '-f', 'qcow2', '-o', |
| 'backing_file=%s' % initial_img_path, os.path.join(self._vm.vm_dir, |
| 'qcow2.img')]) |
| self.assertEquals(self._vm.image_path, |
| os.path.join(self._vm.vm_dir, 'qcow2.img')) |
| self.assertEquals(self._vm.image_format, 'qcow2') |
| |
| @mock.patch('os.path.isfile', return_value=False) |
| @mock.patch('chromite.lib.osutils.Which', return_value=None) |
| def testQemuNotFound(self, which_mock, is_file_mock): |
| """Verify that VMError is raised when qemu path cannot be set.""" |
| self.assertRaises(vm.VMError, self._vm._SetQemuPath) |
| which_mock.assert_called() |
| is_file_mock.assert_called() |
| |
| def testQemuImageNotFound(self): |
| """Veryify that VMError is raised for nonexistent qemu image path.""" |
| self._vm.copy_on_write = True |
| self._vm.qemu_img_path = '/invalid/qemu/img/path/' |
| self.assertRaises(vm.VMError, self._vm._SetQemuPath) |
| |
| def testRmVMDir(self): |
| """Verify that the vm directory is removed after calling RmVMDir.""" |
| self.assertExists(self._vm.vm_dir) |
| self._vm.Stop() |
| self.assertNotExists(self._vm.vm_dir) |
| |
| @mock.patch('chromite.lib.osutils.SafeMakedirs', return_value=False) |
| def testCreateVMDirError(self, make_dir_mock): |
| """Verify that an error is raised when vm_dir is not a valid directory.""" |
| self._vm.vm_dir = '/not/a/valid/dir' |
| self.assertRaises(AssertionError, self._vm._CreateVMDir) |
| make_dir_mock.assert_called() |
| |
| @mock.patch('chromite.lib.osutils.SafeMakedirs', return_value=False) |
| def testCreateVMDirLinkError(self, make_dir_mock): |
| """Verify that an error is raised when vm_dir is a symbolic link.""" |
| # Create the symlink. |
| symlink = self.TempFilePath('symlink') |
| os.symlink(self.TempFilePath('fakepath'), symlink) |
| self._vm.vm_dir = symlink |
| |
| self.assertRaises(AssertionError, self._vm._CreateVMDir) |
| make_dir_mock.assert_called() |
| |
| @mock.patch('chromite.lib.osutils.SafeMakedirs', return_value=False) |
| @mock.patch('os.getuid') |
| def testCreateVMDirStatError(self, getuid_mock, make_dir_mock): |
| """Verify an error is raised when user does not own the vm dir.""" |
| self.assertRaises(AssertionError, self._vm._CreateVMDir) |
| getuid_mock.assert_called() |
| make_dir_mock.assert_called() |
| |
| def testQemuVersionError(self): |
| """Verify that VMError is raised without an expected QEMU version number.""" |
| version_str = 'Fake Version String' |
| self.rc.AddCmdResult(partial_mock.In('--version'), output=version_str) |
| self.assertRaises(vm.VMError, self._vm._SetQemuPath) |
| |
| def testQemuVersion(self): |
| """Verify that the correct QEMU version is identified.""" |
| version_str = ('QEMU emulator version 2.8.0, Copyright (c) ' |
| '2003-2008 Fabrice Bellard') |
| self.rc.AddCmdResult(partial_mock.In('--version'), output=version_str) |
| self._vm._SetQemuPath() |
| self.assertEquals('2.8.0', self._vm.QemuVersion()) |
| self.assertCommandContains([self._vm.qemu_path, '--version']) |
| |
| def testCheckQemuError(self): |
| """Verify that VMError is raised when the QEMU version is too old.""" |
| version_str = ('QEMU emulator version 2.5.0, Copyright (c) ' |
| '2003-2008 Fabrice Bellard') |
| self.rc.AddCmdResult(partial_mock.In('--version'), output=version_str) |
| self.assertRaises(vm.VMError, self._vm._SetQemuPath) |
| |
| def testRunError(self): |
| """Verify that VMError is raised when no action is specified.""" |
| self._vm.start = False |
| self._vm.stop = False |
| self._vm.cmd = None |
| self.assertRaises(vm.VMError, self._vm.Run) |
| |
| def testIsRunningError(self): |
| """Verify that VMError is raised when VM is not running.""" |
| self._vm.cmd = ['fake_command', '--test_cmd'] |
| self.assertRaises(vm.VMError, self._vm.Run) |
| |
| @mock.patch('chromite.lib.vm.VM.IsRunning', return_value=True) |
| def testRunRemoteCmd(self, is_running_mock): |
| """Tests that the VM runs with a specific command.""" |
| self._vm.cmd = ['fake_command', '--test_cmd'] |
| self._vm.Run() |
| self.assertCommandContains([ |
| 'ssh', '-p', '9222', 'root@localhost', '--', |
| 'fake_command', '--test_cmd']) |
| is_running_mock.assert_called() |
| |
| def testGetVMPidDir(self): |
| """Verify that isRunning is False with a nonexistent directory.""" |
| self._vm.vm_dir = 'fake/directory' |
| self.assertFalse(self._vm.IsRunning()) |
| |
| def testGetVMPidFile(self): |
| """Verify that isRunning is False with a nonexistent pid file.""" |
| self._vm.pidfile = 'fake/pid/file' |
| self.assertFalse(self._vm.IsRunning()) |
| |
| def testPidString(self): |
| """Verify that isRunning is False if the pid is not an integer.""" |
| osutils.WriteFile(self._vm.pidfile, 'fake_pid') |
| self.assertFalse(self._vm.IsRunning()) |
| |
| def testGetVMPid(self): |
| """Verify that a proper pid number kills the VM process.""" |
| # Using this process's pid to fake the VM's pid. |
| pid = str(os.getpid()) |
| osutils.WriteFile(self._vm.pidfile, pid) |
| self.assertTrue(self._vm.IsRunning()) |
| self._vm.Stop() |
| self.assertCommandContains(['kill', '-9', pid]) |
| |
| def testBiosPath(self): |
| """Verify QEMU bios path.""" |
| self._vm.qemu_bios_path = self.TempFilePath('qemu/bios/path') |
| osutils.SafeMakedirs(self._vm.qemu_bios_path) |
| self._vm.Start() |
| self.assertCommandContains(['-L', self._vm.qemu_bios_path]) |
| |
| def testQemuHost(self): |
| """Verify QEMU host forwarding.""" |
| self._vm.ssh_port = 1028 |
| self._vm.qemu_hostfwd = ['tcp:127.0.0.1:1024-:22'] |
| self._vm.Start() |
| self.assertCommandContains( |
| ['-netdev', 'user,id=eth0,net=10.0.2.0/27,' |
| 'hostfwd=tcp:127.0.0.1:1028-:22,hostfwd=tcp:127.0.0.1:1024-:22']) |
| |
| def testQemuArgs(self): |
| """Verify QEMU arguments.""" |
| self._vm.qemu_args = ['-portrait', '-full-screen', '-no-reboot'] |
| self._vm.Start() |
| self.assertCommandContains(['-portrait', '-full-screen', '-no-reboot']) |
| |
| def testNoDisplay(self): |
| """Check the command call's arguments when there is no display.""" |
| self._vm.display = False |
| self._vm.Start() |
| self.assertCommandContains(['-display', 'none']) |
| |
| def testWaitForSSHPort(self): |
| """Verify VM correctly waits on the SSH port if it is busy.""" |
| # Assigning an unused port to the VM SSH Port. |
| self._vm.ssh_port = remote_access.GetUnusedPort() |
| sock = socket.socket() |
| sock.bind((remote_access.LOCALHOST_IP, self._vm.ssh_port)) |
| |
| # Look for retry messages in output. |
| with cros_test_lib.LoggingCapturer(log_level=logging.INFO) as logger: |
| self.assertRaises(vm.VMError, self._vm._WaitForSSHPort, sleep=0) |
| in_use_message = 'SSH port %d in use' % self._vm.ssh_port |
| self.assertTrue(logger.LogsMatch((in_use_message + '...\n') * 11 + |
| in_use_message + '\n')) |
| |
| # Verify the VM works correctly when the port is not in use. |
| # There should be no retries after the port is released. |
| # Another process could grab the unused port between closing it |
| # and calling _WaitForSSHPort but this is extremely unlikely. |
| sock.close() |
| with cros_test_lib.LoggingCapturer(log_level=logging.INFO) as logger: |
| self._vm._WaitForSSHPort() |
| self.assertEquals(logger.messages, '') |
| |
| @mock.patch('chromite.lib.remote_access.RemoteDevice.GetRunningPids', |
| return_value=[]) |
| def testWaitForProcsError(self, pid_mocker): |
| """Verify an error is raised when no chrome processes are running.""" |
| # Look for retry messages in output. |
| with cros_test_lib.LoggingCapturer(log_level=logging.INFO) as logger: |
| self.assertRaises(vm.VMError, self._vm._WaitForProcs, sleep=0) |
| |
| pid_message = 'chrome pids: []\n' |
| self.assertTrue(logger.LogsContain(pid_message * 6)) |
| self.assertTrue( |
| logger.LogsContain('_WaitForProcs failed: timed out while waiting' |
| ' for 8 chrome processes to start.\n')) |
| pid_mocker.assert_called() |
| |
| @mock.patch('chromite.lib.remote_access.RemoteDevice.GetRunningPids', |
| return_value=[756, 905, 1065, 1092, 1096, 1171, 1180, 1181]) |
| def testWaitForProcs(self, pid_mocker): |
| """Verify VM waits for chrome processes to launch.""" |
| # Check the log output for expected chrome pids. |
| with cros_test_lib.LoggingCapturer(log_level=logging.INFO) as logger: |
| self._vm._WaitForProcs(sleep=0) |
| self.assertEqual(logger.messages, 'chrome pids: ' |
| '[756, 905, 1065, 1092, 1096, 1171, 1180, 1181]\n') |
| pid_mocker.assert_called() |
| |
| @mock.patch('chromite.lib.vm.VM._WaitForProcs') |
| @mock.patch('chromite.lib.device.Device.WaitForBoot') |
| @mock.patch('chromite.lib.vm.VM.Start') |
| def testWaitForBoot(self, start_mock, boot_mock, procs_mock): |
| """Verify that we wait for the VM to boot up under different conditions.""" |
| # Testing with an existing VM directory and hardware emulation. |
| self._vm.vm_dir = self.TempFilePath('vm_dir') |
| osutils.SafeMakedirs(self._vm.vm_dir) |
| self._vm.enable_kvm = True |
| self._vm.WaitForBoot() |
| start_mock.assert_not_called() |
| boot_mock.assert_called() |
| procs_mock.assert_not_called() |
| |
| start_mock.reset_mock() |
| boot_mock.reset_mock() |
| procs_mock.reset_mock() |
| |
| # Testing with a non-existent VM directory and software emulation. |
| self._vm._RmVMDir() |
| self._vm.enable_kvm = False |
| self._vm.WaitForBoot() |
| start_mock.assert_called() |
| boot_mock.assert_called() |
| procs_mock.assert_called() |
