1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
|
###############################################################################
#
# The MIT License (MIT)
#
# Copyright (c) Crossbar.io Technologies GmbH
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
###############################################################################
# this module is available as the 'wamp' command-line tool or as
# 'python -m autobahn'
import os
import sys
import argparse
import json
from copy import copy
try:
from autobahn.twisted.component import Component
except ImportError:
print("The 'wamp' command-line tool requires Twisted.")
print(" pip install autobahn[twisted]")
sys.exit(1)
from twisted.internet.defer import Deferred, inlineCallbacks
from twisted.internet.task import react
from twisted.internet.protocol import ProcessProtocol
from autobahn.wamp.exception import ApplicationError
from autobahn.wamp.types import PublishOptions
from autobahn.wamp.types import SubscribeOptions
import txaio
txaio.use_twisted()
# XXX other ideas to get 'connection config':
# - if there .crossbar/ here, load that config and accept a --name or
# so to indicate which transport to use
# wamp [options] {call,publish,subscribe,register} wamp-uri [args] [kwargs]
#
# kwargs are spec'd with a 2-value-consuming --keyword option:
# --keyword name value
top = argparse.ArgumentParser(prog="wamp")
top.add_argument(
'--url',
action='store',
help='A WAMP URL to connect to, like ws://127.0.0.1:8080/ws or rs://localhost:1234',
required=True,
)
top.add_argument(
'--realm', '-r',
action='store',
help='The realm to join',
default='default',
)
top.add_argument(
'--private-key', '-k',
action='store',
help='Hex-encoded private key (via WAMP_PRIVATE_KEY if not provided here)',
default=os.environ.get('WAMP_PRIVATE_KEY', None),
)
top.add_argument(
'--authid',
action='store',
help='The authid to use, if authenticating',
default=None,
)
top.add_argument(
'--authrole',
action='store',
help='The role to use, if authenticating',
default=None,
)
top.add_argument(
'--max-failures', '-m',
action='store',
type=int,
help='Failures before giving up (0 forever)',
default=0,
)
sub = top.add_subparsers(
title="subcommands",
dest="subcommand_name",
)
call = sub.add_parser(
'call',
help='Do a WAMP call() and print any results',
)
call.add_argument(
'uri',
type=str,
help="A WAMP URI to call"
)
call.add_argument(
'call_args',
nargs='*',
help="All additional arguments are positional args",
)
call.add_argument(
'--keyword',
nargs=2,
action='append',
help="Specify a keyword argument to send: name value",
)
publish = sub.add_parser(
'publish',
help='Do a WAMP publish() with the given args, kwargs',
)
publish.add_argument(
'uri',
type=str,
help="A WAMP URI to publish"
)
publish.add_argument(
'publish_args',
nargs='*',
help="All additional arguments are positional args",
)
publish.add_argument(
'--keyword',
nargs=2,
action='append',
help="Specify a keyword argument to send: name value",
)
register = sub.add_parser(
'register',
help='Do a WAMP register() and run a command when called',
)
register.add_argument(
'uri',
type=str,
help="A WAMP URI to call"
)
register.add_argument(
'--times',
type=int,
default=0,
help="Listen for this number of events, then exit. Default: forever",
)
register.add_argument(
'command',
type=str,
nargs='*',
help=(
"Takes one or more args: the executable to call, and any positional "
"arguments. As well, the following environment variables are set: "
"WAMP_ARGS, WAMP_KWARGS and _JSON variants."
)
)
subscribe = sub.add_parser(
'subscribe',
help='Do a WAMP subscribe() and print one line of JSON per event',
)
subscribe.add_argument(
'uri',
type=str,
help="A WAMP URI to call"
)
subscribe.add_argument(
'--times',
type=int,
default=0,
help="Listen for this number of events, then exit. Default: forever",
)
subscribe.add_argument(
'--match',
type=str,
default='exact',
choices=['exact', 'prefix'],
help="Massed in the SubscribeOptions, how to match the URI",
)
def _create_component(options):
"""
Configure and return a Component instance according to the given
`options`
"""
if options.url.startswith('ws://'):
kind = 'websocket'
elif options.url.startswith('rs://'):
kind = 'rawsocket'
else:
raise ValueError(
"URL should start with ws:// or rs://"
)
authentication = dict()
if options.private_key:
if not options.authid:
raise ValueError(
"Require --authid and --authrole if --private-key (or WAMP_PRIVATE_KEY) is provided"
)
authentication["cryptosign"] = {
"authid": options.authid,
"authrole": options.authrole,
"privkey": options.private_key,
}
return Component(
transports=[{
"type": kind,
"url": options.url,
}],
authentication=authentication if authentication else None,
realm=options.realm,
)
@inlineCallbacks
def do_call(reactor, session, options):
call_args = list(options.call_args)
call_kwargs = dict()
if options.keyword is not None:
call_kwargs = {
k: v
for k, v in options.keyword
}
results = yield session.call(options.uri, *call_args, **call_kwargs)
print("result: {}".format(results))
@inlineCallbacks
def do_publish(reactor, session, options):
publish_args = list(options.publish_args)
publish_kwargs = {} if options.keyword is None else {
k: v
for k, v in options.keyword
}
yield session.publish(
options.uri,
*publish_args,
options=PublishOptions(acknowledge=True),
**publish_kwargs
)
@inlineCallbacks
def do_register(reactor, session, options):
"""
run a command-line upon an RPC call
"""
all_done = Deferred()
countdown = [options.times]
@inlineCallbacks
def called(*args, **kw):
print("called: args={}, kwargs={}".format(args, kw), file=sys.stderr)
env = copy(os.environ)
env['WAMP_ARGS'] = ' '.join(args)
env['WAMP_ARGS_JSON'] = json.dumps(args)
env['WAMP_KWARGS'] = ' '.join('{}={}'.format(k, v) for k, v in kw.items())
env['WAMP_KWARGS_JSON'] = json.dumps(kw)
exe = os.path.abspath(options.command[0])
args = options.command
done = Deferred()
class DumpOutput(ProcessProtocol):
def outReceived(self, data):
sys.stdout.write(data.decode('utf8'))
def errReceived(self, data):
sys.stderr.write(data.decode('utf8'))
def processExited(self, reason):
done.callback(reason.value.exitCode)
proto = DumpOutput()
reactor.spawnProcess(
proto, exe, args, env=env, path="."
)
code = yield done
if code != 0:
print("Failed with exit-code {}".format(code))
if countdown[0]:
countdown[0] -= 1
if countdown[0] <= 0:
reactor.callLater(0, all_done.callback, None)
yield session.register(called, options.uri)
yield all_done
@inlineCallbacks
def do_subscribe(reactor, session, options):
"""
print events (one line of JSON per event)
"""
all_done = Deferred()
countdown = [options.times]
@inlineCallbacks
def published(*args, **kw):
print(
json.dumps({
"args": args,
"kwargs": kw,
})
)
if countdown[0]:
countdown[0] -= 1
if countdown[0] <= 0:
reactor.callLater(0, all_done.callback, None)
yield session.subscribe(published, options.uri, options=SubscribeOptions(match=options.match))
yield all_done
def _main():
"""
This is a magic name for `python -m autobahn`, and specified as
our entry_point in setup.py
"""
react(_real_main)
@inlineCallbacks
def _real_main(reactor):
"""
Sanity check options, create a connection and run our subcommand
"""
options = top.parse_args()
component = _create_component(options)
if options.subcommand_name is None:
print("Must select a subcommand")
sys.exit(1)
if options.subcommand_name == "register":
exe = options.command[0]
if not os.path.isabs(exe):
print("Full path to the executable required. Found: {}".format(exe), file=sys.stderr)
sys.exit(1)
if not os.path.exists(exe):
print("Executable not found: {}".format(exe), file=sys.stderr)
sys.exit(1)
subcommands = {
"call": do_call,
"register": do_register,
"subscribe": do_subscribe,
"publish": do_publish,
}
command_fn = subcommands[options.subcommand_name]
exit_code = [0]
@component.on_join
@inlineCallbacks
def _(session, details):
print("connected: authrole={} authmethod={}".format(details.authrole, details.authmethod), file=sys.stderr)
try:
yield command_fn(reactor, session, options)
except ApplicationError as e:
print("\n{}: {}\n".format(e.error, ''.join(e.args)))
exit_code[0] = 5
yield session.leave()
failures = []
@component.on_connectfailure
def _(comp, fail):
print("connect failure: {}".format(fail))
failures.append(fail)
if options.max_failures > 0 and len(failures) > options.max_failures:
print("Too many failures ({}). Exiting".format(len(failures)))
reactor.stop()
yield component.start(reactor)
# sys.exit(exit_code[0])
if __name__ == "__main__":
_main()
|