[PATCH 2/3] QMPMonitor: Introduce the send() method and wrappers

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



This method directly sends data to the QMP monitor and returns its
response, without any kind of special treatment or sanity checking.

Two simple wrappers are also introduced: cmd_obj() and cmd_qmp(),
they provide some level of automation on building QMP commands.

All three methods are going to be used by the QMP test-suite.

NOTE: The methods send() and _get_command_output() are similar, but
      I'm out of ideas on how to properly refactor them.

Signed-off-by: Luiz Capitulino <lcapitulino@xxxxxxxxxx>
---
 client/tests/kvm/kvm_monitor.py |   60 +++++++++++++++++++++++++++++++++++++++
 1 files changed, 60 insertions(+), 0 deletions(-)

diff --git a/client/tests/kvm/kvm_monitor.py b/client/tests/kvm/kvm_monitor.py
index d77af31..63201b4 100644
--- a/client/tests/kvm/kvm_monitor.py
+++ b/client/tests/kvm/kvm_monitor.py
@@ -604,6 +604,66 @@ class QMPMonitor(Monitor):
         return self._greeting
 
 
+    def send(self, data, timeout=20):
+        """
+        Send data to the QMP monitor and return its response.
+
+        @param data: Data to send
+        @param timeout: Time duration to wait for response
+        @return: QMP success or error response as a dictionary
+        @raise MonitorLockError: Raised if the lock cannot be acquired
+        @raise MonitorSendError: Raised if the command cannot be sent
+        @raise MonitorProtocolError: Raised if no response is received
+        """
+        # XXX: This method is similar to _get_command_output(), we should
+        # refactor it
+        if not self._acquire_lock(20):
+            raise MonitorLockError("Could not acquire exclusive lock to send "
+                                   "QMP command '%s'" % cmd)
+        try:
+            self._read_objects()
+            self._socket.sendall(data)
+            end_time = time.time() + timeout
+            while time.time() < end_time:
+                for obj in self._read_objects():
+                    if isinstance(obj, dict):
+                        if "return" in obj or "error" in obj:
+                            return obj
+                time.sleep(0.1)
+            else:
+                 raise MonitorProtocolError("Received no response (data: %s)"
+                                            % str(data))
+        except socket.error:
+            raise MonitorSendError("Could not send data '%s'" % str(data))
+        finally:
+            self._lock.release()
+
+
+    def cmd_obj(self, cmd_obj, timeout=20):
+        """
+        Take a Python object, transforms it in JSON and send the resulting
+        string to the QMP monitor. Return the monitor's response.
+
+        @param cmd_obj: Python object to transform in JSON
+        @param timeout: Time duration to wait for response
+        @return: QMP success or error response as a dictionary
+        @note: raise same exceptions as send()
+        """
+        return self.send(json.dumps(cmd_obj) + "\n", timeout)
+
+    def cmd_qmp(self, command, arguments=None, id=None, timeout=20):
+        """
+        Build a QMP command from the passed arguments, return the monitor's
+        response.
+
+        @param command: QMP command name
+        @param arguments: Arguments in the form of a Python dictionary
+        @param id: QMP command id
+        @return: QMP success or error response as a dictionary
+        @note: raise same exceptions as send_cmd()
+        """
+        return self.cmd_obj(self._build_cmd(command, arguments, id), timeout)
+
     # Command wrappers
     # Note: all of the following functions raise exceptions in a similar manner
     # to cmd() and _get_command_output().
-- 
1.7.3.1.120.g38a18

--
To unsubscribe from this list: send the line "unsubscribe kvm" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [KVM ARM]     [KVM ia64]     [KVM ppc]     [Virtualization Tools]     [Spice Development]     [Libvirt]     [Libvirt Users]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite Questions]     [Linux Kernel]     [Linux SCSI]     [XFree86]
  Powered by Linux