commit 5eddf83fa5d9bc97f439bc0be7152aed1a204a55 Author: Arturo Filastò hellais@torproject.org Date: Tue May 29 01:35:22 2012 +0200
Update HACKING file to reflect directory structure changes --- HACKING | 36 +++++++++++++++++++++++------------- 1 files changed, 23 insertions(+), 13 deletions(-)
diff --git a/HACKING b/HACKING index ed8d5dc..821d524 100644 --- a/HACKING +++ b/HACKING @@ -36,45 +36,55 @@ Code Structure - HACKING The document you are currently reading.
-- assets/ +- oonib/ + Contains the OONI probe backend to be run on the ooni-net + +- oonid/ + Contains the OONI daemon that can be used to interrogated from the cli to + run tests. + +- ooni/ + Contains the main ooni probe comand line client + +- ooni/assets/ Where we store all the asset files that are used when running OONI tests.
-- config.py +- ooni/config.py Parts of the code related to parsing OONI configuration files and making them accessible to other components of the software.
-- logo.py +- ooni/logo.py File containing some funny ASCII art. Yes, we do enjoy ASCII art and are not afraid to admit it!
-- nodes.conf +- ooni/nodes.conf The configuration file for nodes. This contains the list of network and code execution nodes that can be used to run tests off of.
-- ooniprobe.py +- ooni/ooniprobe.py The main OONI-probe command line interface. This is responsible for parsing the command line arguments and passing the arguments to the underlying components.
-- ooni-probe.conf +- ooni/ooni-probe.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.
-- plugoo/__init__.py +- ooni/plugoo/__init__.py All the necessary "goo" for making OONI probe work. This means loading Assets, creating Reports, running Tests, interacting with Nodes.
-- plugoo/assets.py +- ooni/plugoo/assets.py This is a python object representation of the data that is located inside the asset directory.
-- plugoo/nodes.py +- ooni/plugoo/nodes.py The part of code responsible for interacting with OONI Nodes. Nodes can be Network or Code Execution. Network nodes are capable of receiving packets and fowarding them onto their @@ -83,19 +93,19 @@ Code Structure of work, they are therefore capable of receiving a set of tests that should be completed by a set of Network nodes or run locally.
-- plugoo/reports.py +- ooni/plugoo/reports.py Takes care of transforming the output of a test into a report. This may mean pushing the result data to a remote backend or simply writing a local file.
-- plugoo/tests.py +- ooni/plugoo/tests.py The main OONI probe test class. This provides all the necessary scaffold to write your own test based on the OONI paradigm.
-- tests/ +- ooni/oonitests/ Contains all the "offical" OONI tests that are shipped.
-- utils.py +- ooni/utils.py Helper functions that don't fit into any place, but are not big enough to be a dependency by themselves.