Add a websocket log replay utility.

Add a websocket log replay utility.

Using the utility, the log of websocket traffic from a Chrom(e|ium) session
can be used as the backend for a GUI session.

https://code.launchpad.net/~benji/juju-gui/websocket-log-replay/+merge/166073

(do not edit description out of merge proposal)

[benji, 2013-05-28 15:11:17]

Please take a look.

[gary.poster, 2013-05-28 19:51:27]

LGTM (nice tests!) with addressing following.

- please make a bin snippet, ideally supporting --help
- please add some docs
- as we discussed, the recording method does not work after a relatively small
number of websocket communications, at least in my up-to-date chrome.  we will
need a recorder which can produce a format that can simplify this script.  I'm
fine with landing this for now though.

Thank you!

Gary

https://codereview.appspot.com/9657046/diff/1/lib/websocket_replay.py
File lib/websocket_replay.py (right):

https://codereview.appspot.com/9657046/diff/1/lib/websocket_replay.py#newcode83
lib/websocket_replay.py:83: def print_with_color(color, *args, **kws):
fun :-)

https://codereview.appspot.com/9657046/diff/1/test/test_websocket_replay.py
File test/test_websocket_replay.py (right):

https://codereview.appspot.com/9657046/diff/1/test/test_websocket_replay.py#n...
test/test_websocket_replay.py:93: self.assertTrue(frames, iter(frames))
assertEqual

https://codereview.appspot.com/9657046/diff/1/test/test_websocket_replay.py#n...
test/test_websocket_replay.py:248: # The program will exit.
copy/paste error?

[benji, 2013-05-29 14:21:30]

I fixed the review issues Gary reported an re-proposed.

https://codereview.appspot.com/9657046/diff/1/lib/websocket_replay.py
File lib/websocket_replay.py (right):

https://codereview.appspot.com/9657046/diff/1/lib/websocket_replay.py#newcode107
lib/websocket_replay.py:107: print_with_color(GREEN,  'sent:', *args)
I fixed the extra whitespace on the above line.

https://codereview.appspot.com/9657046/diff/1/test/test_websocket_replay.py
File test/test_websocket_replay.py (right):

https://codereview.appspot.com/9657046/diff/1/test/test_websocket_replay.py#n...
test/test_websocket_replay.py:93: self.assertTrue(frames, iter(frames))
On 2013/05/28 19:51:27, gary.poster wrote:
> assertEqual

Done.

https://codereview.appspot.com/9657046/diff/1/test/test_websocket_replay.py#n...
test/test_websocket_replay.py:248: # The program will exit.
On 2013/05/28 19:51:27, gary.poster wrote:
> copy/paste error?

Done.

[benji, 2013-05-29 14:22:09]

Please take a look.

[teknico, 2013-05-29 15:53:34]

LGTM, very nice. Please fix a few typos and possibly add some more descriptions,
as noted below.

https://codereview.appspot.com/9657046/diff/7001/docs/recording-and-playing-b...
File docs/recording-and-playing-back-websocket-traffic.rst (right):

https://codereview.appspot.com/9657046/diff/7001/docs/recording-and-playing-b...
docs/recording-and-playing-back-websocket-traffic.rst:39: 
Please mention that a server will run in place of the usual one, and the client
will have to connect to it, on which port, and how it is all expected to work
from the user point of view.

https://codereview.appspot.com/9657046/diff/7001/lib/websocketreplay.py
File lib/websocketreplay.py (right):

https://codereview.appspot.com/9657046/diff/7001/lib/websocketreplay.py#newco...
lib/websocketreplay.py:17: 
Please add a docstring with a brief description of how this is implemented,
describing how the messages in the recording are replayed, and how they interact
with the messages coming from the client.

https://codereview.appspot.com/9657046/diff/7001/test/test_websocketreplay.py
File test/test_websocketreplay.py (right):

https://codereview.appspot.com/9657046/diff/7001/test/test_websocketreplay.py...
test/test_websocketreplay.py:149: # Each message recieved is logged.
s/recieve/receive/

https://codereview.appspot.com/9657046/diff/7001/test/test_websocketreplay.py...
test/test_websocketreplay.py:159: # Each message recieved is logged.
s/recieve/receive/

https://codereview.appspot.com/9657046/diff/7001/test/test_websocketreplay.py...
test/test_websocketreplay.py:189: # When the message recieved from the client
was expected, and there
s/recieved/received/

https://codereview.appspot.com/9657046/diff/7001/test/test_websocketreplay.py...
test/test_websocketreplay.py:203: def
test_expected_messages_read_from_log_ar_handled(self):
s/ar_handled/are_handled/

[benji, 2013-05-29 16:44:57]

On 2013/05/29 15:53:34, teknico wrote:
> LGTM, very nice. Please fix a few typos and possibly add some more
descriptions,
> as noted below.

I have made the suggested changes.  Thanks for the good review.

[benji, 2013-05-29 16:51:04]

*** Submitted:

Add a websocket log replay utility.

Using the utility, the log of websocket traffic from a Chrom(e|ium) session
can be used as the backend for a GUI session.

R=gary.poster, teknico
CC=
https://codereview.appspot.com/9657046