Separate remote control of simulated device #90
Conversation
…ton into test_json_rpc
|
|
||
| def _get_zmq_req_socket(self): | ||
| context = zmq.Context() | ||
| return context.socket(zmq.REQ) |
There was a problem hiding this comment.
Couldn't this just be in __init__?
It seems to only be used here, and amounts to at most one more line in __init__.
There was a problem hiding this comment.
It used to be in init, but testing got easier with this additional method, for tests where it's needed, this method is patched to return a Mock.
There was a problem hiding this comment.
Uff... that makes me a bit uneasy. Understandable, of course... just the thought of pulling apart code that belong together for the sake of tests... feels dirty.
Not a big deal here though.
There was a problem hiding this comment.
It's the usual problem of testing things that involve networking, file access and so on...at least in my experience that is usually hard and/or inconvenient to do. In principle zmq.Context could be mocked here instead, I suppose the outcome would be similar.
|
|
||
| parser = argparse.ArgumentParser( | ||
| description='A client to manipulate the simulated device remotely through a separate channel. The simulation must be started with the --rpc-host option.') | ||
| parser.add_argument('-i', '--ip', default='127.0.0.1', help='IP-adress of the host plankton is running on.') |
There was a problem hiding this comment.
Oooops, thanks :) I'm blaming my native language processing firmware where one d is perfectly acceptable ;)
There was a problem hiding this comment.
Always the firmware's fault... ;)
| @@ -0,0 +1,224 @@ | |||
| #!/usr/bin/env python | |||
There was a problem hiding this comment.
Shouldn't need this unless this file is meant to be executed directly from the command line.
rpc_server.py and both unit test files also shouldn't need this, I think.
Only control.py does need it, otherwise strange things happen when you try to run it directly.
There was a problem hiding this comment.
Ah this must be a leftover from the olden days where these files lived directly in the top level directory and were scripts to execute directly. Or it got in with the license headers.
| Instead, it should be used as a base-class for dynamically created types | ||
| that mirror types on the server, like this: | ||
|
|
||
| proxy = type('SomeClassName', (ZMQJSONRPCObjectProxy, ), {})(socket, methods, prefix) |
There was a problem hiding this comment.
The socket here is a bit confusing... shouldn't it be connection?
|
Okay, this is what I propose for now: from control_client import ControlClient, remote_objects
client = ControlClient(host='...', port='...')
objects = remote_objects(client)
chopper = objects['chopper']For scripts that run once and do not wish to re-use the objects = remote_objects(ControlClient(host='...', port='...'))
chopper = objects['chopper']Objects can still be pulled out one by one from the client = ControlClient(host='...', port='...')
# top level object, this should always work
top_level_object = client.get_object()
# object further down the hierarchy, works only if server side actually exposes that
chopper = client.get_object('chopper')In principle the |
|
I'm going to update the readme once we agree on whether the client side is okay. |
| An exception type for exceptions related to the transport protocol, i.e. | ||
| malformed requests etc. | ||
| """ | ||
| pass |
There was a problem hiding this comment.
Nitpick / my fault: This pass could be removed (docstring already satisfies need for a statement)
There was a problem hiding this comment.
For these one-line changes which are obvious and don't need discussion, please feel free to just modify directly on the branch (I often do that via github directly).
|
Let me know if you can live with this solution for the time being. I don't really see the dict-interface working very well at the moment, maybe that can be solved at some later point. Given that this solution does what we need at the moment I'd rather continue with the other aspects of the re-design and draw this to an end. |
|
Looks perfectly fine to me. You're right, should move forward with some more bigger changes... we can work out details later if it becomes necessary. |
This fixes #39.
The simulated device can now be accessed through JSON-RPC 2.0 via ZMQ if enabled by the new
-rin the startup script. Exposure happens on the object level, so classes don't have to be modified in any way to use this functionality.On the client side, each exposed object is wrapped in a proxy that transforms access to properties, methods and plain attributes into JSON-RPC-requests. The proxy is more or less transparent and exceptions on the server side are re-raised on the client side if they are in
exceptions(Python 2) orbuiltins(Python 3).A new command line utility has been added, called
control.py.The new functionality is described in the readme.