commit c6964f5fb8ddcc3cec5d3eeebb28a07bd9ab0c7b Author: Arturo Filastò arturo@filasto.net Date: Tue Mar 15 17:53:39 2016 +0100
Update user documentation for psiphon and lantern --- docs/source/tests/lantern.rst | 17 +++++++++-------- docs/source/tests/psiphon.rst | 17 ++++++++--------- 2 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/docs/source/tests/lantern.rst b/docs/source/tests/lantern.rst index 0903c3a..9f3af2f 100644 --- a/docs/source/tests/lantern.rst +++ b/docs/source/tests/lantern.rst @@ -17,22 +17,25 @@ Description ===========
This test launches Lantern in --headless mode, and parses output to determine -if it has bootstrapped. After bootstrap, it fetches the URL supplied by the ---url option using Lanterns http proxy interface listening on 127.0.0.1.8787. +if it has bootstrapped. After bootstrap, it fetches a URL using Lanterns HTTP +proxy interface listening on 127.0.0.1.8787 and checks to see if the response +body matches the expected result. +As a URL for testing we use http://www.google.com/humans.txt and look for the +string "Google is built by a large" in the response body.
The specific string used to determine bootstrap from Lantern output in version -"2.0.10" is "client (http) proxy at" from standard output. +"2.0.10" is "Successfully dialed via" from standard output.
How to run the test ===================
-`ooniprobe nettests/third_party/lantern.py -u http://<url>` +`ooniprobe nettests/third_party/lantern.py`
Sample report =============
From running: -`ooniprobe nettests/third_party/lantern.py -u http://www.google.com%60 +`ooniprobe nettests/third_party/lantern.py`
::
@@ -50,9 +53,7 @@ test_name: lantern_circumvention_tool_test test_version: 0.0.1 ... --- -body: "<HTML><HEAD><meta http-equiv="content-type" content="text/html;charset=utf-8"\ - >\n<TITLE>301 Moved</TITLE></HEAD><BODY>\n<H1>301 Moved</H1>\nThe document has moved\n\ - <A HREF="http://www.google.com/%5C%22%3Ehere</A>.\r\n</BODY></HTML>\r\n" +body: "Google is built by a large team of engineers, designers, researchers, robots, and others in many different sites across the globe. It is updated continuously, and built with more tools and technologies than we can shake a stick at. If you'd like to help us out, see google.com/careers." bootstrapped: true input: null lantern --headless: {exit_reason: process_done, stderr: '', stdout: ''} diff --git a/docs/source/tests/psiphon.rst b/docs/source/tests/psiphon.rst index b05f1f0..3934bcb 100644 --- a/docs/source/tests/psiphon.rst +++ b/docs/source/tests/psiphon.rst @@ -16,7 +16,12 @@ Details Description ===========
-This test first check that the Psiphon path exists, then launches Psiphon and parses output to determine if it has bootstrapped. After bootstrap, it fetches google.com (or other URL specified by the --url argument) using Psiphons SOCKS proxy listening on 127.0.0.1:1080 (or otherwise specified by the --socksproxy argument). +This test first check that the Psiphon path exists, then launches Psiphon and +parses output to determine if it has bootstrapped. After bootstrap, it fetches +`http://www.google.com/humans.txt%60 using Psiphons SOCKS +proxy listening on 127.0.0.1:1080 (or otherwise specified by the --socksproxy +argument). +It will then check to see if the response body contains the string: "Google is built by a large"
The specific string used to determine bootstrap from Psiphon output in version "0.0.1" is "Press Ctrl-C to terminate." from standard output. @@ -26,10 +31,6 @@ How to run the test
`ooniprobe third_party/psiphon`
-To test Psiphon with a different URL run: - -`ooniprobe third_party/psiphon -u http://<url>/` - To test Psiphon when it is installed in a different path other than the user home:
`ooniprobe third_party/psiphon -p <path to Psiphon repository>` @@ -49,7 +50,7 @@ To run Psiphon manually, it must be run inside of the proper directory: Sample report =============
-`ooniprobe third_party/psiphon -u http://google.com%60 +`ooniprobe third_party/psiphon`
::
@@ -87,9 +88,7 @@ Sample report tor: {is_tor: false} url: http://google.com response: - body: "<HTML><HEAD><meta http-equiv="content-type" content="text/html;charset=utf-8"\ - >\n<TITLE>301 Moved</TITLE></HEAD><BODY>\n<H1>301 Moved</H1>\nThe document has\ - \ moved\n<A HREF="http://www.google.com/%5C%22%3Ehere</A>.\r\n</BODY></HTML>\r\n" + body: "Google is built by a large team of engineers, designers, researchers, robots, and others in many different sites across the globe. It is updated continuously, and built with more tools and technologies than we can shake a stick at. If you'd like to help us out, see google.com/careers." code: 301 headers: - - Content-Length