RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-03-06 08:20:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

mgr: Add HandleCommandResult namedtuple

Browse Source 
Mostly a documentation improvement to make it obvious
what `handle_command` is supposed to return .

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
This commit is contained in:
Sebastian Wagner 2018-11-26 12:46:05 +01:00
parent 232a89069b
commit 4eadada5c6
2 changed files with 47 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/pybind/mgr/mgr_module.py
View File

@ -5,9 +5,9 @@ import logging
import six
import threading
try:
from collections.abc import defaultdict
from collections.abc import defaultdict, namedtuple
except ImportError:
from collections import defaultdict
from collections import defaultdict, namedtuple
import rados
PG_STATES = [
@ -106,6 +106,17 @@ class CommandResult(object):
return self.r, self.outb, self.outs
class HandleCommandResult(namedtuple('HandleCommandResult', ['retval', 'stdout', 'stderr'])):
def __new__(cls, retval=0, odata="", rs=""):
"""
Tuple containing the result of `handle_command()`
:param retval: return code. E.g. 0 or -errno.EINVAL
:param odata: data of this result.
:param rs: Typically used for error or status messages.
"""
return super(HandleCommandResult, cls).__new__(cls, retval, odata, rs)
class OSDMap(ceph_module.BasePyOSDMap):
def get_epoch(self):
return self._get_epoch()
@ -622,10 +633,12 @@ class MgrModule(ceph_module.BaseMgrModule):
output string. The output buffer is for data results,
the output string is for informative text.
:param string inbuf: content of any "-i <file>" supplied to ceph cli
:param dict cmd: from Ceph's cmdmap_t
:param inbuf: content of any "-i <file>" supplied to ceph cli
:type inbuf: str
:param cmd: from Ceph's cmdmap_t
:type cmd: dict
:return: 3-tuple of (int, str, str)
:return: HandleCommandResult or a 3-tuple of (int, str, str)
"""
# Should never get called if they didn't declare

62
src/pybind/mgr/orchestrator_cli/module.py
View File

@ -1,6 +1,6 @@
import errno
import time
from mgr_module import MgrModule
from mgr_module import MgrModule, HandleCommandResult
import orchestrator
@ -147,7 +147,7 @@ class OrchestratorCli(MgrModule):
d.id, d.type, d.size)
result += "\n"
return 0, result, ""
return HandleCommandResult(odata=result)
def _list_services(self, cmd):
hostname = cmd.get('host', None)
@ -158,7 +158,7 @@ class OrchestratorCli(MgrModule):
services = completion.result
if len(services) == 0:
return 0, "", "No services reported"
return HandleCommandResult(rs="No services reported")
else:
# Sort the list for display
services.sort(key = lambda s: (s.service_type, s.nodename, s.daemon_name))
@ -170,7 +170,7 @@ class OrchestratorCli(MgrModule):
s.nodename,
s.container_id))
return 0, "\n".join(lines), ""
return HandleCommandResult(odata="\n".join(lines))
def _service_status(self, cmd):
svc_type = cmd['svc_type']
@ -186,7 +186,7 @@ class OrchestratorCli(MgrModule):
service_list = completion.result
if len(service_list) == 0:
return 0, "", "No locations reported"
return HandleCommandResult(rs="No locations reported")
else:
lines = []
for l in service_list:
@ -196,7 +196,7 @@ class OrchestratorCli(MgrModule):
l.nodename,
l.container_id))
return 0, "\n".join(lines), ""
return HandleCommandResult(odata="\n".join(lines))
def _service_add(self, cmd):
svc_type = cmd['svc_type']
@ -205,7 +205,8 @@ class OrchestratorCli(MgrModule):
try:
node_name, block_device = device_spec.split(":")
except TypeError:
return -errno.EINVAL, "", "Invalid device spec, should be <node>:<device>"
return HandleCommandResult(-errno.EINVAL,
rs="Invalid device spec, should be <node>:<device>")
spec = orchestrator.OsdCreationSpec()
spec.node = node_name
@ -215,7 +216,7 @@ class OrchestratorCli(MgrModule):
completion = self._oremote("create_osds", spec)
self._wait([completion])
return 0, "", "Success."
return HandleCommandResult(rs="Success.")
elif svc_type == "mds":
fs_name = cmd['svc_arg']
@ -230,7 +231,7 @@ class OrchestratorCli(MgrModule):
)
self._wait([completion])
return 0, "", "Success."
return HandleCommandResult(rs="Success.")
elif svc_type == "rgw":
store_name = cmd['svc_arg']
@ -244,7 +245,7 @@ class OrchestratorCli(MgrModule):
)
self._wait([completion])
return 0, "", "Success."
return HandleCommandResult(rs="Success.")
else:
raise NotImplementedError(svc_type)
@ -263,7 +264,7 @@ class OrchestratorCli(MgrModule):
if module_name == "":
self.set_config("orchestrator", None)
return 0, "", ""
return HandleCommandResult()
for module in mgr_map['available_modules']:
if module['name'] != module_name:
@ -274,9 +275,8 @@ class OrchestratorCli(MgrModule):
enabled = module['name'] in mgr_map['modules']
if not enabled:
return -errno.EINVAL, "", "Module '{0}' is not enabled".format(
module_name
)
return HandleCommandResult(-errno.EINVAL,
rs="Module '{0}' is not enabled".format(module_name))
try:
is_orchestrator = self.remote(module_name,
@ -285,45 +285,41 @@ class OrchestratorCli(MgrModule):
is_orchestrator = False
if not is_orchestrator:
return -errno.EINVAL, "",\
"'{0}' is not an orchestrator module".format(
module_name)
return HandleCommandResult(-errno.EINVAL,
rs="'{0}' is not an orchestrator module".format(module_name))
self.set_config("orchestrator", module_name)
return 0, "", ""
return HandleCommandResult()
return -errno.ENOENT, "", "Module '{0}' not found".format(
module_name
)
return HandleCommandResult(-errno.EINVAL, rs="Module '{0}' not found".format(module_name))
def _status(self):
try:
avail, why = self._oremote("available")
except NoOrchestrator:
return 0, "No orchestrator configured (try " \
"`ceph orchestrator set backend`)", ""
return HandleCommandResult(odata="No orchestrator configured (try " \
"`ceph orchestrator set backend`)")
if avail is None:
# The module does not report its availability
return 0, "Backend: {0}".format(
self._select_orchestrator()), ""
return HandleCommandResult("Backend: {0}".format(self._select_orchestrator()))
else:
return 0, "Backend: {0}\nAvailable: {1}{2}".format(
self._select_orchestrator(),
avail,
" ({0})".format(why) if not avail else ""
), ""
return HandleCommandResult("Backend: {0}\nAvailable: {1}{2}".format(
self._select_orchestrator(),
avail,
" ({0})".format(why) if not avail else ""
))
def handle_command(self, inbuf, cmd):
try:
return self._handle_command(inbuf, cmd)
except NoOrchestrator:
return -errno.ENODEV, "", "No orchestrator configured"
return HandleCommandResult(-errno.ENODEV, rs="No orchestrator configured")
except ImportError as e:
return -errno.ENOENT, "", str(e)
return HandleCommandResult(-errno.ENOENT, rs=str(e))
except NotImplementedError:
return -errno.EINVAL, "", "Command not found"
return HandleCommandResult(-errno.EINVAL, rs="Command not found")
def _handle_command(self, _, cmd):
if cmd['prefix'] == "orchestrator device ls":