X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/19b9ba9ab4fd61de4d06622f3ccf3214ae27b117..a85f23fa4fdb4118c5a36155103a1ba573b1340f:/lib/luxi.py diff --git a/lib/luxi.py b/lib/luxi.py index 669c3dd..bfebbc1 100644 --- a/lib/luxi.py +++ b/lib/luxi.py @@ -1,7 +1,7 @@ # # -# Copyright (C) 2006, 2007 Google Inc. +# Copyright (C) 2006, 2007, 2011 Google Inc. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -34,17 +34,20 @@ import collections import time import errno import logging +import warnings from ganeti import serializer from ganeti import constants from ganeti import errors from ganeti import utils +from ganeti import objects KEY_METHOD = "method" KEY_ARGS = "args" KEY_SUCCESS = "success" KEY_RESULT = "result" +KEY_VERSION = "version" REQ_SUBMIT_JOB = "SubmitJob" REQ_SUBMIT_MANY_JOBS = "SubmitManyJobs" @@ -52,9 +55,12 @@ REQ_WAIT_FOR_JOB_CHANGE = "WaitForJobChange" REQ_CANCEL_JOB = "CancelJob" REQ_ARCHIVE_JOB = "ArchiveJob" REQ_AUTOARCHIVE_JOBS = "AutoArchiveJobs" +REQ_QUERY = "Query" +REQ_QUERY_FIELDS = "QueryFields" REQ_QUERY_JOBS = "QueryJobs" REQ_QUERY_INSTANCES = "QueryInstances" REQ_QUERY_NODES = "QueryNodes" +REQ_QUERY_GROUPS = "QueryGroups" REQ_QUERY_EXPORTS = "QueryExports" REQ_QUERY_CONFIG_VALUES = "QueryConfigValues" REQ_QUERY_CLUSTER_INFO = "QueryClusterInfo" @@ -70,7 +76,7 @@ DEF_RWTO = 60 WFJC_TIMEOUT = (DEF_RWTO - 1) / 2 -class ProtocolError(errors.GenericError): +class ProtocolError(errors.LuxiError): """Denotes an error in the LUXI protocol.""" @@ -227,12 +233,12 @@ class Transport: while True: try: data = self.socket.recv(4096) + except socket.timeout, err: + raise TimeoutError("Receive timeout: %s" % str(err)) except socket.error, err: if err.args and err.args[0] == errno.EAGAIN: continue raise - except socket.timeout, err: - raise TimeoutError("Receive timeout: %s" % str(err)) break if not data: raise ConnectionClosedError("Connection closed while reading") @@ -272,15 +278,16 @@ def ParseRequest(msg): logging.error("LUXI request not a dict: %r", msg) raise ProtocolError("Invalid LUXI request (not a dict)") - method = request.get(KEY_METHOD, None) # pylint: disable-msg=E1103 - args = request.get(KEY_ARGS, None) # pylint: disable-msg=E1103 + method = request.get(KEY_METHOD, None) # pylint: disable=E1103 + args = request.get(KEY_ARGS, None) # pylint: disable=E1103 + version = request.get(KEY_VERSION, None) # pylint: disable=E1103 if method is None or args is None: logging.error("LUXI request missing method or arguments: %r", msg) raise ProtocolError(("Invalid LUXI request (no method or arguments" " in request): %r") % msg) - return (method, args) + return (method, args, version) def ParseResponse(msg): @@ -290,6 +297,8 @@ def ParseResponse(msg): # Parse the result try: data = serializer.LoadJson(msg) + except KeyboardInterrupt: + raise except Exception, err: raise ProtocolError("Error while deserializing response: %s" % str(err)) @@ -299,10 +308,11 @@ def ParseResponse(msg): KEY_RESULT in data): raise ProtocolError("Invalid response from server: %r" % data) - return (data[KEY_SUCCESS], data[KEY_RESULT]) + return (data[KEY_SUCCESS], data[KEY_RESULT], + data.get(KEY_VERSION, None)) # pylint: disable=E1103 -def FormatResponse(success, result): +def FormatResponse(success, result, version=None): """Formats a LUXI response message. """ @@ -311,12 +321,15 @@ def FormatResponse(success, result): KEY_RESULT: result, } + if version is not None: + response[KEY_VERSION] = version + logging.debug("LUXI response: %s", response) return serializer.DumpJson(response) -def FormatRequest(method, args): +def FormatRequest(method, args, version=None): """Formats a LUXI request message. """ @@ -326,22 +339,30 @@ def FormatRequest(method, args): KEY_ARGS: args, } + if version is not None: + request[KEY_VERSION] = version + # Serialize the request - return serializer.DumpJson(request, indent=False) + return serializer.DumpJson(request) -def CallLuxiMethod(transport_cb, method, args): +def CallLuxiMethod(transport_cb, method, args, version=None): """Send a LUXI request via a transport and return the response. """ assert callable(transport_cb) - request_msg = FormatRequest(method, args) + request_msg = FormatRequest(method, args, version=version) # Send request and wait for response response_msg = transport_cb(request_msg) - (success, result) = ParseResponse(response_msg) + (success, result, resp_version) = ParseResponse(response_msg) + + # Verify version if there was one in the response + if resp_version is not None and resp_version != version: + raise errors.LuxiError("LUXI version mismatch, client %s, response %s" % + (version, resp_version)) if success: return result @@ -396,7 +417,7 @@ class Client(object): old_transp = self.transport self.transport = None old_transp.Close() - except Exception: # pylint: disable-msg=W0703 + except Exception: # pylint: disable=W0703 pass def _SendMethodCall(self, data): @@ -408,17 +429,27 @@ class Client(object): self._CloseTransport() raise + def Close(self): + """Close the underlying connection. + + """ + self._CloseTransport() + def CallMethod(self, method, args): """Send a generic request and return the response. """ - return CallLuxiMethod(self._SendMethodCall, method, args) + if not isinstance(args, (list, tuple)): + raise errors.ProgrammerError("Invalid parameter passed to CallMethod:" + " expected list, got %s" % type(args)) + return CallLuxiMethod(self._SendMethodCall, method, args, + version=constants.LUXI_VERSION) def SetQueueDrainFlag(self, drain_flag): - return self.CallMethod(REQ_QUEUE_SET_DRAIN_FLAG, drain_flag) + return self.CallMethod(REQ_QUEUE_SET_DRAIN_FLAG, (drain_flag, )) def SetWatcherPause(self, until): - return self.CallMethod(REQ_SET_WATCHER_PAUSE, [until]) + return self.CallMethod(REQ_SET_WATCHER_PAUSE, (until, )) def SubmitJob(self, ops): ops_state = map(lambda op: op.__getstate__(), ops) @@ -431,10 +462,10 @@ class Client(object): return self.CallMethod(REQ_SUBMIT_MANY_JOBS, jobs_state) def CancelJob(self, job_id): - return self.CallMethod(REQ_CANCEL_JOB, job_id) + return self.CallMethod(REQ_CANCEL_JOB, (job_id, )) def ArchiveJob(self, job_id): - return self.CallMethod(REQ_ARCHIVE_JOB, job_id) + return self.CallMethod(REQ_ARCHIVE_JOB, (job_id, )) def AutoArchiveJobs(self, age): timeout = (DEF_RWTO - 1) / 2 @@ -471,6 +502,32 @@ class Client(object): break return result + def Query(self, what, fields, qfilter): + """Query for resources/items. + + @param what: One of L{constants.QR_VIA_LUXI} + @type fields: List of strings + @param fields: List of requested fields + @type qfilter: None or list + @param qfilter: Query filter + @rtype: L{objects.QueryResponse} + + """ + result = self.CallMethod(REQ_QUERY, (what, fields, qfilter)) + return objects.QueryResponse.FromDict(result) + + def QueryFields(self, what, fields): + """Query for available fields. + + @param what: One of L{constants.QR_VIA_LUXI} + @type fields: None or list of strings + @param fields: List of requested fields + @rtype: L{objects.QueryFieldsResponse} + + """ + result = self.CallMethod(REQ_QUERY_FIELDS, (what, fields)) + return objects.QueryFieldsResponse.FromDict(result) + def QueryJobs(self, job_ids, fields): return self.CallMethod(REQ_QUERY_JOBS, (job_ids, fields)) @@ -480,6 +537,9 @@ class Client(object): def QueryNodes(self, names, fields, use_locking): return self.CallMethod(REQ_QUERY_NODES, (names, fields, use_locking)) + def QueryGroups(self, names, fields, use_locking): + return self.CallMethod(REQ_QUERY_GROUPS, (names, fields, use_locking)) + def QueryExports(self, nodes, use_locking): return self.CallMethod(REQ_QUERY_EXPORTS, (nodes, use_locking)) @@ -487,10 +547,12 @@ class Client(object): return self.CallMethod(REQ_QUERY_CLUSTER_INFO, ()) def QueryConfigValues(self, fields): - return self.CallMethod(REQ_QUERY_CONFIG_VALUES, fields) + return self.CallMethod(REQ_QUERY_CONFIG_VALUES, (fields, )) def QueryTags(self, kind, name): return self.CallMethod(REQ_QUERY_TAGS, (kind, name)) def QueryLocks(self, fields, sync): + warnings.warn("This LUXI call is deprecated and will be removed, use" + " Query(\"%s\", ...) instead" % constants.QR_LOCK) return self.CallMethod(REQ_QUERY_LOCKS, (fields, sync))