Fix/install requirements

.gitignore

@@ -1 +1,64 @@
-*.pyc
+# Emacs temp files: 
+*~
+*.*~
+\#*\#
+.\#*
+
+# Python binary and object files:
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+__pycache__
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject]
+
+# PyCharm directory:
+.idea/*
+
+# config.tor_datadir directory:
+tmp/*
+
+# openssl certificates, keys, signing requests:
+*.crt
+*.csr
+*.key
+
+# logs and private files:
+*.log
+*.private
+
+# from "python setup.py install --record installed-files.txt": 
+installed-files.txt
+
+# client config:
+oonib.conf

.requirements.travis

@@ -0,0 +1,25 @@
+## we do not want to override the PI URI for TravisCI:
+#-i https://pypi.python.org/packages
+PyYAML>=3.10
+#https://pypi.python.org/packages/source/P/PyYAML/PyYAML-3.10.tar.gz#md5=74c94a383886519e9e7b3dd1ee540247#egg=PyYAML
+Twisted>=12.2.0
+#https://pypi.python.org/packages/source/T/Twisted/Twisted-13.0.0.tar.bz2#md5=68afff4e1efd3757d934e39f70c99f57#egg=Twisted
+cyclone>=1.1
+#https://pypi.python.org/packages/source/c/cyclone/cyclone-1.1.tar.gz#md5=477c5ef9cf8902e37105fe450c4d8c5d#egg=cyclone
+ipaddr>=2.1.10
+#https://ipaddr-py.googlecode.com/files/ipaddr-2.1.10.tar.gz#sha1=c608450b077b19773d4f1b5f1ef88b26f6650ce0#egg=ipaddr
+pygeoip>=0.2.6
+#https://pypi.python.org/packages/source/p/pygeoip/pygeoip-0.2.6.zip#md5=b3ac1bfcd535782bc59af78e722cf5c1#egg=pygeoip
+# Originally fetched from the hg repo on secdev.org:
+#   https://hg.secdev.org/scapy/archive/tip.zip#egg=scapy
+# This is a Tor Project mirror with valid SSL/TLS certs that is stable and fast:
+https://people.torproject.org/~ioerror/src/mirrors/ooniprobe/scapy-02-25-2013-tip.zip#egg=scapy
+transaction>=1.4.1
+#https://pypi.python.org/packages/source/t/transaction/transaction-1.4.1.zip#md5=8db2680bc0f999219861a67b8f335a88#egg=transaction
+storm>=0.19
+#https://pypi.python.org/packages/source/s/storm/storm-0.19.tar.gz#md5=61d1ee4cd2a08639ab917e43fa2c9265#egg=storm
+txtorcon>=0.7
+pyOpenSSL>=0.13
+zope.component>=4.0.0
+zope.event>=4.0.0
+zope.interface>=4.0.1

.travis.test.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+##############################################################################
+#
+# .travis.test.sh
+# -------------------
+# Run $2 for $1 seconds and then kill the process.
+#
+# :authors: Isis Agora Lovecruft, 0x2cdb8b35
+# :date: 21 April 2013
+# :version: 0.0.1
+##############################################################################
+
+set -vx --
+
+function killitwithfire () {
+    trap - ALRM
+    kill -ALRM $prog 2>/dev/null
+    kill -9 $! 2>/dev/null && exit 0
+}
+
+function waitforit () {
+    trap "killitwithfire" ALRM
+    sleep $1& wait
+    kill -ALRM $$
+}
+
+waitforit $1& prog=$! ; shift ;
+trap "killitwithfire" ALRM INT
+"$@"& wait $!
+RET=$?
+if [[ "$(ps -ef | awk -v pid=$prog '$2==pid{print}{}')" != "" ]]; then
+    kill -ALRM $prog
+    wait $prog
+fi
+exit $RET

.travis.yml

@@ -0,0 +1,41 @@
+language: python
+notifications:
+  irc:
+    channels:
+      - "irc.oftc.net#tor-bots"
+      - "irc.oftc.net#ooni"
+    on_success: always
+    on_failure: always
+  email:
+    recipients:
+      - isis@torproject.org
+      - aagbsn@torproject.org
+      - ioerror@torproject.org
+      - hellais@torproject.org
+    on_success: change
+    on_failure: always
+before_install:
+  - echo "deb http://deb.torproject.org/torproject.org wheezy main" | sudo tee -a /etc/apt/sources.list
+  - gpg --keyserver keys.gnupg.net --recv 886DDD89
+  - gpg --export A3C4F0F979CAA22CDBA8F512EE8CBC9E886DDD89 | sudo apt-key add -
+  - sudo apt-get update
+  - sudo apt-get install deb.torproject.org-keyring tor tor-geoipdb build-essential python-dev python-setuptools openssl
+python:
+  #- "3.3"
+  - "2.7"
+  - "2.6"
+install:
+  - pip install -r .requirements.travis --use-mirrors
+  - python setup.py install
+# command to run tests, e.g. python setup.py test
+script:
+  - cp oonib.conf.example oonib.conf
+  - openssl genrsa -des3 -passout pass:oonib -out private.key 4096
+  - openssl req -batch -passin pass:oonib -new -key private.key -out server.csr
+  - cp private.key private.key.org
+  - openssl rsa -passin pass:oonib -in private.key.org -out private.key
+  - openssl x509 -req -days 365 -in server.csr -signkey private.key -out certificate.crt
+  - test -f "private.key.org" && rm -f private.key.org
+  - test -f "server.csr" && rm -f server.csr
+  - chmod +x .travis.test.sh && ./.travis.test.sh 30 ./bin/oonib
+  - echo "Build successful."

HACKING

@@ -36,109 +36,15 @@ Code Structure
 - HACKING
   The document you are currently reading.
 
-- inputs/
-  Contains input files for tests.
-
 - oonib/
   Contains the OONI probe backend to be run on the ooni-net
 
-- ooni/
-  Contains the main ooni probe comand line client
-
-- ooni/config.py
-  Parts of the code related to parsing OONI
-  configuration files and making them accessible
-  to other components of the software.
-
-- ooni/inputunit.py
-  In here we have functions related to the creation of input
-  units. Input units are how the inputs to be fed to tests are
-  split up into.
-
-- ooni/nettest.py
-  In here is the NetTest API definition. This is how people
-  interested in writing ooniprobe tests will be specifying
-  them.
-
-- ooni/nodes.py
-  Mostly broken code for the remote dispatching of tests.
-
-- ooni/oonicli.py
-  In here we take care of running ooniprobe from the command
-  line interface
-
-- ooni/reporter.py
-  In here goes the logic for the creation of ooniprobe
-  reports.
-
-- ooni/runner.py
-  Handles running ooni.nettests as well as
-  ooni.plugoo.tests.OONITests.
-
-- ooni/otime.py
-  Generation of timestamps, time conversions and all the rest
-
-- ooni/kit/
-  In here go utilities that can be used by tests.
-
-- ooni/lib/
-  XXX this directory is to be removed.
-
-- ooni/utils/
-  In here go internal utilities that are useful to ooniprobe
-
-- ooni/utils/geodata.py
-  In here go functions related to the understanding of
-  geographical information of the probe
-
-- ooni/utils/hacks.py
-  When some software has issues and we need to fix it in a
-  hackish way, we put it in here. This one day will be empty.
-
-- ooni/utils/log.py
-  log realted functions.
-
-- ooni/utils/net.py
-  utilities for networking related operations
-
-- ooni/utils/onion.py
-  Utilities for working with Tor.
-  XXX this code should be removed and merged into txtorcon.
-
-- ooni/utils/txscapy.py
-  Tools for making scapy work well with twisted.
-
 - ooniprobe.conf
   The main OONI-probe configuration file. This can be used
   to configure your OONI CLI, tell it where it should report
   to, where the asset files are located, what should be used
   for control, etc.
 
-Test related conventions
-------------------------
-
-These are the conventions for tests that are written in ooniprobe. That is what
-goes inside of nettests/.
-
-Naming
-......
-
-All methods that are relevant to the test should be all lower case separated by
-underscore.
-
-All variables that are specific to your test should be all lower case separated
-by underscore.
-
-Simplicity
-..........
-
-Tests written in ooniprobe should be as short as possible and should contain as
-little code not related to the measurement as possible. It should be possible
-from reading the test to understand what it does without clutter.
-
-Everything that is not related directly to the test should go inside of the
-test template of which the test you are writing is a subclass of.
-
 
 Style guide
 -----------
@@ -288,5 +194,3 @@ methods. Even better if you write them also for non-public methods.
 Place docstrings under the def.
 
 For a better overview on how to write docstrings consult: PEP-257
-
-