gor 0.1.1

Python library for GoReplay Middleware

GoReplay Middleware
========

Python library for `GoReplay Middleware <https://github.com/buger/goreplay>`_ , API is quite similar to `NodeJS library <https://github.com/buger/goreplay/tree/master/middleware>`_

.. image:: https://badge.fury.io/py/gormw.svg
:target: https://badge.fury.io/py/gormw
.. image:: https://travis-ci.org/amyangfei/GorMW.svg?branch=master
:target: https://travis-ci.org/amyangfei/GorMW

Installation
------------

To install GorMW, simply:

.. code-block:: bash

$ pip install gor

or from source:

.. code-block:: bash

python setup.py install

Getting Started
---------------

Initialize a TornadoGor based middleware and start it in the following way:

.. code-block:: python

from gor.middleware import TornadoGor
proxy = TornadoGor()
proxy.run()

Basic idea is that you write callbacks which respond to request, response, replay, or message events, which contains request meta information and actuall http paylod. Depending on your needs you may compare, override or filter incoming requests and responses.

You can respond to the incoming events using on function, by providing callbacks:

.. code-block:: python

def on_request(proxy, msg, **kwargs):
# do anything you want with msg
# msg is a GorMessage object
pass

proxy = TornadoGor()
proxy.on('request', on_request)
proxy.run()

You can provide request ID as additional argument to on function, which allow you to map related requests and responses. Below is example of middleware which checks that original and replayed response have same HTTP status code.

.. code-block:: python

# coding: utf-8
import sys
from gor.middleware import TornadoGor


def on_request(proxy, msg, **kwargs):
proxy.on('response', on_response, idx=msg.id, req=msg)

def on_response(proxy, msg, **kwargs):
proxy.on('replay', on_replay, idx=kwargs['req'].id, req=kwargs['req'], resp=msg)

def on_replay(proxy, msg, **kwargs):
replay_status = proxy.http_status(msg.http)
resp_status = proxy.http_status(kwargs['resp'].http)
if replay_status != resp_status:
sys.stderr.write('replay status [%s] diffs from response status [%s]\n' % (replay_status, resp_status))
else:
sys.stderr.write('replay status is same as response status\n')
sys.stderr.flush()

if __name__ == '__main__':
proxy = TornadoGor()
proxy.on('request', on_request)
proxy.run()