[tor-commits] [ooni-probe/master] Update documentation and test decks to use shorthand for tests.
art at torproject.org
art at torproject.org
Sat Sep 28 20:14:37 UTC 2013
commit 86a7df4cef32f68e145e24ef815fe9793f88c9ae
Author: Arturo Filastò <art at fuffa.org>
Date: Wed Sep 11 18:15:06 2013 +0200
Update documentation and test decks to use shorthand for tests.
---
README.md | 2 +-
Vagrantfile | 2 +-
decks/basic.deck | 4 ++--
decks/before_i_commit.testdeck | 8 ++++----
decks/short_no_root.deck | 10 +++++-----
docs/source/index.rst | 16 ++++++++--------
docs/source/tests/dnsconsistency.rst | 4 ++--
docs/source/tests/http_requests.rst | 6 +++---
8 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/README.md b/README.md
index 0ffb096..53bff52 100644
--- a/README.md
+++ b/README.md
@@ -62,7 +62,7 @@ ooniprobe will be installed in `/ooni`.
3) You can run tests with:
```
-ooniprobe /usr/share/ooni/nettests/blocking/http_requests.py -f /ooni/inputs/input-pack/alexa-top-1k.txt
+ooniprobe blocking/http_requests -f /ooni/inputs/input-pack/alexa-top-1k.txt
```
## The easy way to prep your system for running ooniprobe
diff --git a/Vagrantfile b/Vagrantfile
index 9099960..76ce70c 100644
--- a/Vagrantfile
+++ b/Vagrantfile
@@ -36,7 +36,7 @@ echo "You may now visit http://localhost:8042/ to start running some ooniprobe t
echo ""
echo "Or if you are a bit more h4x0r you can ssh into the box and use the ooniprobe CLI"
echo "Login using 'vagrant ssh', and dont forget to run ooniprobe as root."
-echo "First run: 'sudo su; cd /usr/share/ooni; ./bin/ooniprobe -i decks/before_i_commit.testdeck'"
+echo "First run: 'sudo su; cd /usr/share/ooni; ooniprobe -i decks/before_i_commit.testdeck'"
SCRIPT
diff --git a/decks/basic.deck b/decks/basic.deck
index 84a8f9d..b2ede99 100644
--- a/decks/basic.deck
+++ b/decks/basic.deck
@@ -8,7 +8,7 @@
reportfile: null
resume: 0
subargs: [-f, 'httpo://amcq5ldf3vwg22ze.onion/input/37e60e13536f6afe47a830bfb6b371b5cf65da66d7ad65137344679b24fdccd1']
- test_file: data/nettests/blocking/http_requests.py
+ test_file: blocking/http_requests
testdeck: null
- options:
collector: null
@@ -20,5 +20,5 @@
reportfile: null
resume: 0
subargs: [-b, 'http://93.95.227.200']
- test_file: data/nettests/manipulation/http_header_field_manipulation.py
+ test_file: manipulation/http_header_field_manipulation
testdeck: null
diff --git a/decks/before_i_commit.testdeck b/decks/before_i_commit.testdeck
index 1159a0d..69ef16c 100644
--- a/decks/before_i_commit.testdeck
+++ b/decks/before_i_commit.testdeck
@@ -5,7 +5,7 @@
pcapfile: null
reportfile: reports/captive_portal_test.yamloo
subargs: []
- test_file: data/nettests/manipulation/captiveportal.py
+ test_file: manipulation/captiveportal
- options:
collector: null
help: 0
@@ -13,7 +13,7 @@
pcapfile: null
reportfile: reports/dns_tamper_test.yamloo
subargs: [-T, example_inputs/dns_tamper_test_resolvers.txt, -f, example_inputs/dns_tamper_file.txt]
- test_file: data/nettests/blocking/dnsconsistency.py
+ test_file: blocking/dnsconsistency
- options:
collector: null
help: 0
@@ -21,7 +21,7 @@
pcapfile: null
reportfile: reports/http_host.yamloo
subargs: [-b, 'http://93.95.227.200', -f, example_inputs/http_host_file.txt]
- test_file: data/nettests/manipulation/http_host.py
+ test_file: manipulation/http_host
- options:
collector: null
help: 0
@@ -29,4 +29,4 @@
pcapfile: null
reportfile: reports/header_field_manipulation.yamloo
subargs: [-b, 'http://93.95.227.200']
- test_file: data/nettests/manipulation/http_header_field_manipulation.py
+ test_file: manipulation/http_header_field_manipulation
diff --git a/decks/short_no_root.deck b/decks/short_no_root.deck
index fbc8f7b..ddd157a 100644
--- a/decks/short_no_root.deck
+++ b/decks/short_no_root.deck
@@ -8,7 +8,7 @@
reportfile: null
resume: 0
subargs: []
- test_file: data/nettests/manipulation/captiveportal.py
+ test_file: manipulation/captiveportal
testdeck: null
- options:
collector: null
@@ -20,7 +20,7 @@
reportfile: null
resume: 0
subargs: [-f, example_inputs/url_lists_file.txt]
- test_file: data/nettests/blocking/http_requests.py
+ test_file: blocking/http_requests
testdeck: null
- options:
collector: null
@@ -32,7 +32,7 @@
reportfile: null
resume: 0
subargs: [-f, example_inputs/tcpconnect_host_file.txt]
- test_file: data/nettests/blocking/tcpconnect.py
+ test_file: blocking/tcpconnect
testdeck: null
- options:
collector: null
@@ -44,7 +44,7 @@
reportfile: null
resume: 0
subargs: [-f, example_inputs/http_host_file.txt, -T, example_inputs/dns_tamper_test_resolvers.txt]
- test_file: data/nettests/blocking/dnsconsistency.py
+ test_file: blocking/dnsconsistency
testdeck: null
- options:
collector: null
@@ -56,5 +56,5 @@
reportfile: null
resume: 0
subargs: [-b, 'http://93.95.227.200']
- test_file: data/nettests/manipulation/http_header_field_manipulation.py
+ test_file: manipulation/http_header_field_manipulation
testdeck: null
diff --git a/docs/source/index.rst b/docs/source/index.rst
index b74799c..b6c9894 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -39,9 +39,9 @@ Core ooniprobe Tests
--------------------
The source for `Content blocking tests
-<https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/data/nettests/blocking>`_
+<https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/ooni/nettests/blocking>`_
and `Traffic Manipulation tests
-<https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/data/nettests/blocking>`_
+<https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/ooni/nettests/blocking>`_
can be found in the nettests/blocking and nettests/manipulation directories
respectively.
@@ -76,18 +76,18 @@ being experimented with.
You can find these in:
- * `data/nettests/experimental
- <https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/data/nettests/experimental>`_
+ * `ooni/nettests/experimental
+ <https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/ooni/nettests/experimental>`_
Tests that don't do a measurement but are useful for scanning can be found in:
- * `data/nettests/scanning
- <https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/data/nettests/scanning>`_
+ * `ooni/nettests/scanning
+ <https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/ooni/nettests/scanning>`_
Tests that involve running third party tools may be found in:
- * `data/nettests/third_party
- <https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/data/nettests/third_party>`_
+ * `ooni/nettests/third_party
+ <https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/ooni/nettests/third_party>`_
oonib
*****
diff --git a/docs/source/tests/dnsconsistency.rst b/docs/source/tests/dnsconsistency.rst
index 673661c..a667067 100644
--- a/docs/source/tests/dnsconsistency.rst
+++ b/docs/source/tests/dnsconsistency.rst
@@ -28,7 +28,7 @@ Youtube, etc.
How to run the test
===================
-`./bin/ooniprobe nettests/core/dnsconsistency.py [-t <test resolvers>|-T <test resolver file>-f <input file> -b IP:PORT`
+`ooniprobe blocking/dnsconsistency [-t <test resolvers>|-T <test resolver file>-f <input file> -b IP:PORT`
*test resolvers* is a single test resolver (IP address)
@@ -42,7 +42,7 @@ Sample report
=============
From running:
-`./bin/ooniprobe nettests/core/dnsconsistency.py -T test_inputs/dns_tamper_test_resolvers.txt -f test_inputs/http_host_file.txt`
+`ooniprobe blocking/dnsconsistency -T test_inputs/dns_tamper_test_resolvers.txt -f test_inputs/http_host_file.txt`
::
diff --git a/docs/source/tests/http_requests.rst b/docs/source/tests/http_requests.rst
index 6eb0d0a..6178072 100644
--- a/docs/source/tests/http_requests.rst
+++ b/docs/source/tests/http_requests.rst
@@ -32,17 +32,17 @@ How to run the test
To test a single site run:
-`./bin/ooniprobe nettests/blocking/http_requests.py -u http://<test_site>/`
+`ooniprobe blocking/http_requests -u http://<test_site>/`
To test a set of sites from a list containing sites to test run:
-`./bin/ooniprobe nettests/blocking/http_requests.py -f <input_file>`
+`ooniprobe blocking/http_requests -f <input_file>`
Sample report
=============
-`./bin/ooniprobe nettests/blocking/http_requests.py -f example_inputs/url_lists_file.txt`
+`ooniprobe blocking/http_requests -f example_inputs/url_lists_file.txt`
::
More information about the tor-commits
mailing list