6ef78fe661
Catch exceptions during RPC client initialization
to display meaningful error message.
Withouth this change, user gets stacktrace
when e.g. SPDK application is not running.
Before:
```
Traceback (most recent call last):
File "scripts/rpc/client.py", line 53, in __init__
raise socket.error("Unix socket '%s' does not exist" % addr)
OSError: Unix socket '/var/tmp/spdk.sock' does not exist
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "scripts/spdkcli.py", line 74, in <module>
main()
File "scripts/spdkcli.py", line 47, in main
with rpc.client.JSONRPCClient(args.socket) as client:
File "scripts/rpc/client.py", line 56, in __init__
"Error details: %s" % (addr, ex))
rpc.client.JSONRPCException: Error while connecting to /var/tmp/spdk.sock
Error details: Unix socket '/var/tmp/spdk.sock' does not exist
```
After:
```
Error while connecting to /var/tmp/spdk.sock
Error details: Unix socket '/var/tmp/spdk.sock' does not exist. SPDK not running?
```
Change-Id: I65862965b68acf3bd4709de598f04de49da27de2
Signed-off-by: Vitaliy Mysak <vitaliy.mysak@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/462020
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Karol Latecki <karol.latecki@intel.com>
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
81 lines
2.8 KiB
Python
Executable File
81 lines
2.8 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
import sys
|
|
import argparse
|
|
import configshell_fb
|
|
from os import getuid
|
|
from rpc.client import JSONRPCException
|
|
from configshell_fb import ConfigShell, shell, ExecutionError
|
|
from spdkcli import UIRoot
|
|
import rpc.client
|
|
from pyparsing import (alphanums, Optional, Suppress, Word, Regex,
|
|
removeQuotes, dblQuotedString, OneOrMore)
|
|
|
|
|
|
def add_quotes_to_shell(spdk_shell):
|
|
command = shell.locatedExpr(Word(alphanums + '_'))('command')
|
|
value = dblQuotedString.addParseAction(removeQuotes)
|
|
value_word = Word(alphanums + r';,=_\+/.<>()~@:-%[]')
|
|
keyword = Word(alphanums + r'_\-')
|
|
kparam = shell.locatedExpr(keyword + Suppress('=') +
|
|
Optional(value | value_word, default=''))('kparams*')
|
|
pparam = shell.locatedExpr(value | value_word)('pparams*')
|
|
parameters = OneOrMore(kparam | pparam)
|
|
bookmark = Regex(r'@([A-Za-z0-9:_.]|-)+')
|
|
pathstd = Regex(r'([A-Za-z0-9:_.\[\]]|-)*' + '/' + r'([A-Za-z0-9:_.\[\]/]|-)*') \
|
|
| '..' | '.'
|
|
path = shell.locatedExpr(bookmark | pathstd | '*')('path')
|
|
spdk_shell._parser = Optional(path) + Optional(command) + Optional(parameters)
|
|
|
|
|
|
def main():
|
|
"""
|
|
Start SPDK CLI
|
|
:return:
|
|
"""
|
|
spdk_shell = ConfigShell("~/.scripts")
|
|
spdk_shell.interactive = True
|
|
add_quotes_to_shell(spdk_shell)
|
|
|
|
parser = argparse.ArgumentParser(description="SPDK command line interface")
|
|
parser.add_argument("-s", dest="socket", help="RPC socket path", default="/var/tmp/spdk.sock")
|
|
parser.add_argument("-v", dest="verbose", help="Print request/response JSON for configuration calls",
|
|
default=False, action="store_true")
|
|
parser.add_argument("commands", metavar="command", type=str, nargs="*", default="",
|
|
help="commands to execute by SPDKCli as one-line command")
|
|
args = parser.parse_args()
|
|
|
|
try:
|
|
client = rpc.client.JSONRPCClient(args.socket)
|
|
except JSONRPCException as e:
|
|
spdk_shell.log.error("%s. SPDK not running?" % e)
|
|
sys.exit(1)
|
|
|
|
with client:
|
|
root_node = UIRoot(client, spdk_shell)
|
|
root_node.verbose = args.verbose
|
|
try:
|
|
root_node.refresh()
|
|
except BaseException:
|
|
pass
|
|
|
|
if len(args.commands) > 0:
|
|
try:
|
|
spdk_shell.interactive = False
|
|
spdk_shell.run_cmdline(" ".join(args.commands))
|
|
except Exception as e:
|
|
sys.stderr.write("%s\n" % e)
|
|
sys.exit(1)
|
|
sys.exit(0)
|
|
|
|
spdk_shell.con.display("SPDK CLI v0.1")
|
|
spdk_shell.con.display("")
|
|
while not spdk_shell._exit:
|
|
try:
|
|
spdk_shell.run_interactive()
|
|
except (JSONRPCException, ExecutionError) as e:
|
|
spdk_shell.log.error("%s" % e)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|