c/ooni-probe-cli
Watch
1
0
Fork
You've already forked ooni-probe-cli
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

feat: tutorial on how to write the torsf experiment (#390)

Browse source 
Original tracking issue for Sprint 41: https://github.com/ooni/probe/issues/1507

Follow-up work in Sprint 42 tracked by: https://github.com/ooni/probe/issues/1689
This commit is contained in:
Simone Basso 2021-06-22 00:12:03 +02:00 • committed by GitHub
commit 520398dd8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
41 changed files with 2113 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

20
internal/tutorial/experiment/torsf/README.md Normal file
View file

@ -0,0 +1,20 @@
# Tutorial: rewriting the torsf experiment
This tutorial teaches you how to write a minimal implementation of the
[torsf](https://github.com/ooni/spec/blob/master/nettests/ts-030-torsf.md)
experiment. We will do that in four steps.
In the [first step](chapter01/) we will write a `main.go`
function that runs the existing `torsf` implementation.
In the [second step](chapter02/) we will modify the existing
code to launch an empty experiment instead.
In the [third step](chapter03/) we will start to fill in
the empty experiment to more closely simulate a real implementation
of the `torsf` experiment.
In the [fourth step](chapter04/) we will replace the code
simulating a real `torsf` experiment with a minimal implementation
of such an experiment that uses other code in `ooni/probe-cli` to
attempt to bootstrap `tor` over Snowflake.