ooni-probe-cli/internal/tutorial/experiment/torsf
Simone Basso 273b70bacc
refactor: interfaces and data types into the model package (#642)
## Checklist

- [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md)
- [x] reference issue for this pull request: https://github.com/ooni/probe/issues/1885
- [x] related ooni/spec pull request: N/A

Location of the issue tracker: https://github.com/ooni/probe

## Description

This PR contains a set of changes to move important interfaces and data types into the `./internal/model` package.

The criteria for including an interface or data type in here is roughly that the type should be important and used by several packages. We are especially interested to move more interfaces here to increase modularity.

An additional side effect is that, by reading this package, one should be able to understand more quickly how different parts of the codebase interact with each other.

This is what I want to move in `internal/model`:

- [x] most important interfaces from `internal/netxlite`
- [x] everything that was previously part of `internal/engine/model`
- [x] mocks from `internal/netxlite/mocks` should also be moved in here as a subpackage
2022-01-03 13:53:23 +01:00
..
chapter01 refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
chapter02 refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
chapter03 refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
chapter04 refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
README.md feat: tutorial on how to write the torsf experiment (#390) 2021-06-22 00:12:03 +02:00

Tutorial: rewriting the torsf experiment

This tutorial teaches you how to write a minimal implementation of the torsf experiment. We will do that in four steps.

In the first step we will write a main.go function that runs the existing torsf implementation.

In the second step we will modify the existing code to launch an empty experiment instead.

In the third step we will start to fill in the empty experiment to more closely simulate a real implementation of the torsf experiment.

In the fourth step 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.