Adding a test for a clean exit of guest VM shutdown.

Signed-off-by: Vimal Patel <vipatel@redhat.com>
Signed-off-by: Marian Krcmarik <mkrcmari@redhat.com>

Author: vi-patel

tests/rv_vmshutdown.py

@@ -0,0 +1,110 @@
+"""
+rv_vmshutdown.py - shutdown the guest and verify it is a clean exit.
+
+Requires: connected binaries remote-viewer, Xorg, gnome session
+
+"""
+import logging
+from virttest.virt_vm import VMDeadError
+from autotest.client.shared import error
+from virttest.aexpect import ShellCmdError
+from virttest import utils_spice
+from virttest import utils_misc
+from virttest import utils_net
+
+
+def run_rv_vmshutdown(test, params, env):
+    """
+    Tests clean exit after shutting down the VM.
+    Covers two cases:
+    (1)Shutdown from the command line of the guest.
+    (2)Shutdown from the qemu monitor.
+    
+    Verify after the shutdown:
+    (1)Verifying the guest is down
+    (2)Verify the spice connection to the guest is no longer established
+    (3)Verify the remote-viewer process is not running
+
+    @param test: QEMU test object.
+    @param params: Dictionary with the test parameters.
+    @param env: Dictionary with test environment.
+    """
+    
+    #Get the required variables
+    rv_binary = params.get("rv_binary", "remote-viewer")
+    host_ip = utils_net.get_host_ip_address(params)
+    shutdownfrom = params.get("shutdownfrom")
+    cmd_cli_shutdown = params.get("cmd_cli_shutdown")
+    cmd_qemu_shutdown = params.get("cmd_qemu_shutdown")
+    host_port = None
+
+    guest_vm = env.get_vm(params["guest_vm"])
+    guest_vm.verify_alive()
+    guest_session = guest_vm.wait_for_login(
+            timeout=int(params.get("login_timeout", 360)),
+                    username="root", password="123456")
+
+    client_vm = env.get_vm(params["client_vm"])
+    client_vm.verify_alive()
+    client_session = client_vm.wait_for_login(
+            timeout=int(params.get("login_timeout", 360)),
+                     username="root", password="123456")
+    
+    if guest_vm.get_spice_var("spice_ssl") == "yes":
+        host_port = guest_vm.get_spice_var("spice_tls_port")
+    else:
+        host_port = guest_vm.get_spice_var("spice_port")
+
+    #Determine if the test is to shutdown from cli or qemu monitor
+    if shutdownfrom == "cmd":
+        logging.info("Shutting down guest from command line:" +
+                     " %s\n" % cmd_cli_shutdown)
+        output = guest_session.cmd(cmd_cli_shutdown)
+        logging.debug("Guest is being shutdown: %s" % output)
+    elif shutdownfrom == "qemu_monitor":
+        logging.info("Shutting down guest from qemu monitor\n")
+        output = guest_vm.monitor.cmd(cmd_qemu_shutdown)
+        logging.debug("Output of %s: %s" % (cmd_qemu_shutdown, output))
+    else:
+        raise error.TestFail("shutdownfrom var not set, valid values are" +
+                             " cmd or qemu_monitor")
+
+    #wait for the guest vm to be shutoff
+    logging.info("Waiting for the guest VM to be shutoff")
+    utils_misc.wait_for(guest_vm.is_dead, 70, 30, 1, "waiting...")
+    logging.info("Guest VM is now shutoff")
+
+    #Verify there was a clean exit by
+    #(1)Verifying the guest is down
+    #(2)Verify the spice connection to the guest is no longer established
+    #(3)Verify the remote-viewer process is not running
+    try:
+        guest_vm.verify_alive()
+        raise error.TestFail("Guest VM is still alive, shutdown failed.")
+    except VMDeadError as exc:
+        if "VM is dead" in str(exc):
+            logging.info("Guest VM is verified to be shutdown")
+        else:
+            raise error.TestFail("Unexpected Error: %s" % exc.value())
+
+    try:
+        utils_spice.verify_established(client_vm, host_ip, host_port, rv_binary)
+        raise error.TestFail("Remote-Viewer connection to guest"
+                             "is still established.")
+    except utils_spice.RVConnectError:
+        logging.info("There is no remote-viewer connection as expected")
+    else:
+        raise error.TestFail("Unexpected error while trying to see if there"
+                             " was no spice connection to the guest")
+
+    #Verify the remote-viewer process is not running
+    logging.info("Checking to see if remote-viewer process is still running on"
+                 " client after VM has been shutdown")
+    try:
+        pidoutput = str(client_session.cmd("pgrep remote-viewer"))
+        raise error.TestFail("Remote-viewer is still running on the client.")
+    except ShellCmdError:
+        logging.info("Remote-viewer process is not running as expected.")
+    else:
+        raise error.TestFail("Unexpected error while trying to verify" +
+                             "remote-viewer process was not running.")