diff --git a/src/main/java/org/jboss/netty/example/http/websocketx/autobahn/package-info.java b/src/main/java/org/jboss/netty/example/http/websocketx/autobahn/package-info.java index 873bb26d4e..35e0904652 100644 --- a/src/main/java/org/jboss/netty/example/http/websocketx/autobahn/package-info.java +++ b/src/main/java/org/jboss/netty/example/http/websocketx/autobahn/package-info.java @@ -17,45 +17,48 @@ /** * This package is intended for use with testing against the Python * AutoBahn test suite. + * + * Autobahn installation documentation can be found here. + * + *

How to run the tests on Ubuntu.

* - *

How to run the tests on Ubuntu

+ *

01. Install python (if not already installed). + * + *

02. Install Python Setup Tools if not already + * installed. sudo apt-get install python-setuptools + * + *

03. Add ppa:twisted-dev/ppa to your system's Software Sources * - *

01. Add ppa:twisted-dev/ppa to your system's Software Sources + *

04. Install Twisted: sudo apt-get install python-twisted * - *

02. Install Twisted V11: sudo apt-get install python-twisted + *

05. Install AutoBahn: sudo easy_install autobahntestsuite. Test using wstest --help. * - *

03. Intall Python Setup Tools: sudo apt-get install python-setuptools + *

06. Create a directory for test configuration and results: mkdir autobahn cd autobahn. * - *

04. Install AutoBahn: sudo easy_install Autobahn. If you already have Autobahn installed, you may need - * to upgrade it: sudo easy_install --upgrade Autobahn. Make suer v0.4.10 is installed. - * - *

05. Get AutoBahn testsuite source code: git clone git@github.com:tavendo/AutobahnPython.git - * - *

06. Go to AutoBahn directory: cd AutobahnPython - * - *

07. Checkout stable version: git checkout v0.4.10 - * - *

08. Go to test suite directory: cd testsuite/websockets - * - *

09. Edit fuzzing_clinet_spec.json and set the hybi specification version to 10 or 17 (RFC 6455). + *

07. Create fuzzing_clinet_spec.json in the above directory * - * { - * "options": {"failByDrop": false}, - * "servers": [{"agent": "Netty", "url": "ws://localhost:9000", "options": {"version": 17}}], - * "cases": ["*"], - * "exclude-cases": [], - * "exclude-agent-cases": {"FoobarServer*": ["4.*", "1.1.3"]} - * } + * { + * "options": {"failByDrop": false}, + * "outdir": "./reports/servers", + * + * "servers": [ + * {"agent": "Netty", + * "url": "ws://localhost:9000", + * "options": {"version": 18}} + * ], + * + * "cases": ["*"], + * "exclude-cases": [], + * "exclude-agent-cases": {} + * } * * - *

10. Run our AutobahnServer located in this package. If you are in Eclipse IDE, right click on + *

08. Run the AutobahnServer located in this package. If you are in Eclipse IDE, right click on * AutobahnServer.java and select Run As > Java Application. * - *

11. Run the Autobahn test python fuzzing_client.py. Note that the actual test case python code is - * located with the easy_install package (e.g. in /usr/local/lib/python2.7/dist-packages/ - * autobahn-0.4.10-py2.7.egg/autobahn/cases) and not in the checked out git repository. + *

09. Run the Autobahn test wstest -m fuzzingclient -s fuzzingclient.json. * - *

12. See the results in reports/servers/index.html + *

10. See the results in ./reports/servers/index.html */ package org.jboss.netty.example.http.websocketx.autobahn;