58adb68b2c
* refactor: move tracex outside of engine/netx Consistently with https://github.com/ooni/probe/issues/2121 and https://github.com/ooni/probe/issues/2115, we can now move tracex outside of engine/netx. The main reason why this makes sense now is that the package is now changed significantly from the one that we imported from ooni/probe-engine. We have improved its implementation, which had not been touched significantly for quite some time, and converted it to unit testing. I will document tomorrow some extra work I'd like to do with this package but likely could not do $soon. * go fmt * regen tutorials |
||
|---|---|---|
| .. | ||
| experiment/torsf | ||
| generator | ||
| measurex | ||
| netxlite | ||
| README.md | ||
Tutorials: writing OONI nettests
This package contains a living tutorial explaining how to write OONI nettests. The code in here is based on existing nettests.
Because it's committed to the probe-cli repository and depends on real OONI code, it should always be up to date.
Index
-
Rewriting the torsf experiment: this tutorial explains to you how to write a simple experiment. After reading it, you will understand the interfaces between an experiment and the OONI core. What this tutorial does not teach you, though, is how to tell the OONI core about this experiment. To see how to do that, you should check how we do that in internal/engine/allexperiments.go.
-
Using the measurex package to write network experiments: this tutorial explains to you how to use the
measurexlibrary to write networking code that generates measurements using the OONI data format. You will learn how to perform DNS, TCP, TLS, QUIC, HTTP, HTTPS, and HTTP3 measurements. -
Low-level networking using netxlite: this tutorial introduces you to the
netxlitenetworking library. This is the underlying library used bymeasurexas well as by many other libraries inside OONI. You need to know about this library to contribute tomeasurexas well as to other parts of the OONI core that perform network operations.
Therefore, after reading these tutorials, you should have a better understanding of how an experiment interacts with the OONI core, as well as of which libraries you can use to write experiments.
Regenerating the tutorials
(cd ./internal/tutorial && go run ./generator)