Changes

Page history
Apply conversion script to all *.md files. authored by Alexander Hansen Færøy's avatar Alexander Hansen Færøy
Hide whitespace changes
Inline Side-by-side
AutomationInventory.md
View page @ a1a4b621
...@@ -4,75 +4,78 @@ of all repository on git.torproject.org and have a quick look at each source ...@@ -4,75 +4,78 @@ of all repository on git.torproject.org and have a quick look at each source
tree to see if unit and integration tests were easily locatable. tree to see if unit and integration tests were easily locatable.
Columns marked with an 'X' do not necessarily mean full coverage, but that Columns marked with an 'X' do not necessarily mean full coverage, but that
there is at least a framework where new tests can be added. ''Unit'' means “unit tests”, ''Regr.'' means "regression tests", ''Integ.'' means “integration tests” and ''C.I.'' means “continuous integration” (tests/builds automatically run after each commit). there is at least a framework where new tests can be added. _Unit_ means “unit tests”, _Regr._ means "regression tests", _Integ._ means “integration tests” and _C.I._ means “continuous integration” (tests/builds automatically run after each commit).
|| '''Repository''' || '''Description''' || '''Unit''' || '''Regr.''' || '''Integ.''' || '''C.I.''' || '''Languages''' || '''Comments''' | **Repository** | **Description** | **Unit** | **Regr.** | **Integ.** | **C.I.** | **Languages** | **Comments**
|| arm.git || Command-line status monitor... || || || || || Python || || |----------------------------------|----------------------------------|----------|-----------|------------|----------|----------------|-------------
|| atlas.git || A web application to discover... || || || || || JavaScript (web) || || | arm.git | Command-line status monitor... | | | | | Python | |
|| brdgrd.git || Protects Tor bridges from... || || || || || C || Is brdgrd still useful? || | atlas.git | A web application to discover... | | | | | JavaScript (web) | |
|| bridgedb.git || The bridge distribution database || [https://gitweb.torproject.org/bridgedb.git/tree/refs/heads/develop:/lib/bridgedb/test X] || [https://gitweb.torproject.org/bridgedb.git/blob/HEAD:/lib/bridgedb/test/test_Tests.py This test suite] runs [https://gitweb.torproject.org/bridgedb.git/blob/HEAD:/lib/bridgedb/Tests.py the old unittests] twice, monkeypatching in the old code and the new code rsp., to guarantee compatible behaviour with unchanged code. || Fake bridge descriptors are generated with [https://gitweb.torproject.org/user/isis/leekspin.git Leekspin] for testing purposes. || [https://travis-ci.org/isislovecruft/bridgedb X] || Python || Missing Nagios checks for the reachability of the BridgeDB service on [https://bridges.torproject.org the production server]. || | brdgrd.git | Protects Tor bridges from... | | | | | C | Is brdgrd still useful? |
|| There is currently [https://bridges-test.torproject.org a staging instance] (only run while being actively tested) setup on the production server, however, because BridgeDB's [mailto:bridges@torproject.org email distributor] cannot have two instances running on the same server, there is a new dedicated server for the staging instances which needs to be finished being setup. || | bridgedb.git | The bridge distribution database | [X](https://gitweb.torproject.org/bridgedb.git/tree/refs/heads/develop:/lib/bridgedb/test) | [This test suite](https://gitweb.torproject.org/bridgedb.git/blob/HEAD:/lib/bridgedb/test/test_Tests.py) runs [the old unittests](https://gitweb.torproject.org/bridgedb.git/blob/HEAD:/lib/bridgedb/Tests.py) twice, monkeypatching in the old code and the new code rsp., to guarantee compatible behaviour with unchanged code. | Fake bridge descriptors are generated with [Leekspin](https://gitweb.torproject.org/user/isis/leekspin.git) for testing purposes. | [X](https://travis-ci.org/isislovecruft/bridgedb) | Python | Missing Nagios checks for the reachability of the BridgeDB service on [the production server](https://bridges.torproject.org). |
|| builders/gitian-builder.git || Tor's version of the gitian... || || || || || Ruby, Shell || || | There is currently [a staging instance](https://bridges-test.torproject.org) (only run while being actively tested) setup on the production server, however, because BridgeDB's [mailto:bridges@torproject.org email distributor] cannot have two instances running on the same server, there is a new dedicated server for the staging instances which needs to be finished being setup. |
|| builders/tor-browser-bundle.git || Build scripts for the Tor... || || || || || Shell || Should the build system itself be tested? Probably just the result… || | builders/gitian-builder.git | Tor's version of the gitian... | | | | | Ruby, Shell | |
|| chutney.git || The chutney tool for testing... || || || || || Python || || | builders/tor-browser-bundle.git | Build scripts for the Tor... | | | | | Shell | Should the build system itself be tested? Probably just the result… |
|| compass.git || Script and website to extract... || || || || || Python + webdev || Also missing a staging environment and Nagios checks || | chutney.git | The chutney tool for testing... | | | | | Python | |
|| flashproxy.git || Browser-based proxy || || || || || Py, JS, Go || Also missing a staging environment and Nagios checks for the facilitator (?) || | compass.git | Script and website to extract... | | | | | Python + webdev | Also missing a staging environment and Nagios checks |
|| gettor.git || Distributors for the Tor softw... || || || || || Python || Also missing a staging environment and Nagios checks || | flashproxy.git | Browser-based proxy | | | | | Py, JS, Go | Also missing a staging environment and Nagios checks for the facilitator (?) |
|| githax.git || Miscellaneous git support... || || || || || Shell, Perl, Py || || | gettor.git | Distributors for the Tor softw... | | | | | Python | Also missing a staging environment and Nagios checks |
|| metrics-db.git || Metrics data processor and... || || || || || Java || Staging? Nagios checks? || | githax.git | Miscellaneous git support... | | | | | Shell, Perl, Py | |
|| metrics-lib.git || A Java library that fetches... || X || || || || Java || ''phased out for Stem'' || | metrics-db.git | Metrics data processor and... | | | | | Java | Staging? Nagios checks? |
|| metrics-utils.git || Metrics utilities || || || || || Java, Python || Contains ExoneraTor and VisiTor. Repository should be split. ExanoraTor should have a staging environment and Nagios checks || | metrics-lib.git | A Java library that fetches... | X | | | | Java | _phased out for Stem_ |
|| metrics-web.git || Metrics website || || || || || Java + webdev || Staging? Nagios checks? || | metrics-utils.git | Metrics utilities | | | | | Java, Python | Contains ExoneraTor and VisiTor. Repository should be split. ExanoraTor should have a staging environment and Nagios checks |
|| onionoo.git || A web-based protocol to learn... || X || || || || Java || Staging? Nagios checks? || | metrics-web.git | Metrics website | | | | | Java + webdev | Staging? Nagios checks? |
|| ooni-probe.git || open observatory of network... || || || || X || Python || C.I done by Travis || | onionoo.git | A web-based protocol to learn... | X | | | | Java | Staging? Nagios checks? |
|| ooni/oonib.git || open observatory of network... || || || || X || Python || C.I done by Travis. Staging? Nagios checks? || | ooni-probe.git | open observatory of network... | | | | X | Python | C.I done by Travis |
|| pluggable-transports/bundle.git || Pluggable transports browser... || || || || || Makefile || || | ooni/oonib.git | open observatory of network... | | | | X | Python | C.I done by Travis. Staging? Nagios checks? |
|| pluggable-transports/obfsproxy.git || Python pluggable transport... || X || || X || X || Python || || | pluggable-transports/bundle.git | Pluggable transports browser... | | | | | Makefile | |
|| pluggable-transports/pyptlib.git || Python pluggable transport... || X || || || X || Python || || | pluggable-transports/obfsproxy.git | Python pluggable transport... | X | | X | X | Python | |
|| pyonionoo.git || A web-based protocol to learn... || || || || || Python || || | pluggable-transports/pyptlib.git | Python pluggable transport... | X | | | X | Python | |
|| stegotorus.git || Steganographic stealth proxy... || X || || X || || C++ || || | pyonionoo.git | A web-based protocol to learn... | | | | | Python | |
|| stem.git || Tor control library for Python || X || || X || X || Python || C.I. also doing integration test for tor control port code || | stegotorus.git | Steganographic stealth proxy... | X | | X | | C++ | |
|| tlsdate.git || Learn the current time from... || X || || || X || C || || | stem.git | Tor control library for Python | X | | X | X | Python | C.I. also doing integration test for tor control port code |
|| tor-browser.git || The Tor Browser || X || || X || || C++ || TBB patches are breaking some tests || | tlsdate.git | Learn the current time from... | X | | | X | C | |
|| tor-cloud.git || Tor images for the cloud || || || || || Shell || || | tor-browser.git | The Tor Browser | X | | X | | C++ | TBB patches are breaking some tests |
|| tor-launcher.git || tor-launcher component of TBB || || || || || JavaScript / XUL || Might not really be testable outside TBB || | tor-cloud.git | Tor images for the cloud | | | | | Shell | |
|| tor-ramdisk.git || Build system for x86/x86_64... || || || || || Shell || || | tor-launcher.git | tor-launcher component of TBB | | | | | JavaScript / XUL | Might not really be testable outside TBB |
|| tor.git || Tor's source code || X || || || X || C || C.I. for Linux, Windows, Linux with clang || | tor-ramdisk.git | Build system for x86/x86_64... | | | | | Shell | |
|| torbirdy.git || Torbutton for Thunderbird... || || || || || JavaScript / XUL || || | tor.git | Tor's source code | X | | | X | C | C.I. for Linux, Windows, Linux with clang |
|| torbrowser.git || Scripts to build the Tor Brows... || || || || || Shell || || | torbirdy.git | Torbutton for Thunderbird... | | | | | JavaScript / XUL | |
|| torbutton.git || Firefox extension for safe... || || || || || JavaScript / XUL || Might not really be tesable outside TBB || | torbrowser.git | Scripts to build the Tor Brows... | | | | | Shell | |
|| tordnsel.git || DNS exitlist checker || X || || || || Haskell || || | torbutton.git | Firefox extension for safe... | | | | | JavaScript / XUL | Might not really be tesable outside TBB |
|| torflow.git || Python tools for measuring... || X || || || || Python || Not all components have unit tests || | tordnsel.git | DNS exitlist checker | X | | | | Haskell | |
|| torouter.git || Torouter packaging utensils... || || || || || Shell, Makefile || || | torflow.git | Python tools for measuring... | X | | | | Python | Not all components have unit tests |
|| torperf.git || Tor performance evaluation... || || || || || Python, C || || | torouter.git | Torouter packaging utensils... | | | | | Shell, Makefile | |
|| torsocks.git || Wrapper to safely torify appli... || X || || || || C || || | torperf.git | Tor performance evaluation... | | | | | Python, C | |
|| translation-tools.git || tools to manage the translatio... || || || || || Shell || || | torsocks.git | Wrapper to safely torify appli... | X | | | | C | |
|| weather.git || Email alerts for Tor relay... || || || || || Python || Also missing a staging environment and Nagios checks || | translation-tools.git | tools to manage the translatio... | | | | | Shell | |
|| webstats.git || Code and website to sanitize... || || || || || Java || || | weather.git | Email alerts for Tor relay... | | | | | Python | Also missing a staging environment and Nagios checks |
| webstats.git | Code and website to sanitize... | | | | | Java | |
Not considered: Not considered:
|| '''Repository''' || '''Description''' || '''Reason''' || | **Repository** | **Description** | **Reason** |
|| doctor.git || service that periodically... || Java version being phased out for Python+Stem || |---------------------|------------------------------|---------------------------------------------|
|| https-everywhere.git || HTTPS Everywhere Firefox Addon || Not maintained by the Tor Project || | doctor.git | service that periodically... | Java version being phased out for Python+Stem |
|| jtor.git || Java implementation of the... || Not maintained by the Tor Project || | https-everywhere.git | HTTPS Everywhere Firefox Addon | Not maintained by the Tor Project |
|| metrics-tasks.git || Technical reports and code... || Almost all are one shot scripts || | jtor.git | Java implementation of the... | Not maintained by the Tor Project |
|| orbot.git || Orbot: Tor on Android || Not maintained by the Tor Project || | metrics-tasks.git | Technical reports and code... | Almost all are one shot scripts |
|| pytorctl.git || Tor control library for Python || Users should migrate to Stem || | orbot.git | Orbot: Tor on Android | Not maintained by the Tor Project |
| pytorctl.git | Tor control library for Python | Users should migrate to Stem |
Deprecated or abandoned projects: Deprecated or abandoned projects:
|| '''Repository''' || '''Description''' || | **Repository** | **Description** |
|| apaf.git || Anonymous Python Application... || |-----------------------------------------|----------------------------------|
|| jtorctl.git || Tor controller, written in... || | apaf.git | Anonymous Python Application... |
|| pluggable-transports/obfsproxy-legacy.git || The old (pre 2013) obfuscating... || | jtorctl.git | Tor controller, written in... |
|| puppetor.git || A controller for private networks || | pluggable-transports/obfsproxy-legacy.git | The old (pre 2013) obfuscating... |
|| thandy.git || Tor's secure updater || | puppetor.git | A controller for private networks |
|| torbel.git || Tor exit list exporter and... || | thandy.git | Tor's secure updater |
|| torstatus.git || Web tool to display informatio... || | torbel.git | Tor exit list exporter and... |
|| vidalia-plugins.git || Vidalia plugins || | torstatus.git | Web tool to display informatio... |
|| vidalia.git || Vidalia's source code || | vidalia-plugins.git | Vidalia plugins |
| vidalia.git | Vidalia's source code |
Misc. resources: Misc. resources:
* [https://gitweb.torproject.org/project/jenkins/jobs.git/blob/HEAD:/jobs.yaml Current Jenkins job] * [Current Jenkins job](https://gitweb.torproject.org/project/jenkins/jobs.git/blob/HEAD:/jobs.yaml)
* [https://gitweb.torproject.org/admin/tor-nagios.git/blob/refs/heads/master:/config/nagios-master.cfg Current Nagios checks] * [Current Nagios checks](https://gitweb.torproject.org/admin/tor-nagios.git/blob/refs/heads/master:/config/nagios-master.cfg)