Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Publish documentation explaining how to write OONI tests #361

Closed
agrabeli opened this issue Feb 4, 2020 · 2 comments
Closed

Publish documentation explaining how to write OONI tests #361

agrabeli opened this issue Feb 4, 2020 · 2 comments
Assignees
@bassosimone
Labels
epic priority/medium

Comments

@agrabeli
Copy link
Member

agrabeli commented Feb 4, 2020

No description provided.

@hellais hellais added epic and removed effort/M labels Feb 11, 2020
@hellais
Copy link
Member

hellais commented Jun 23, 2021

We have first tutorial on how to write an OONI Probe test documented here: https://github.com/ooni/probe-cli/tree/master/internal/tutorial/experiment/torsf.

This will be expanded to include an example of writing the SNI filtering experiment as well.

Once that is done we can link to it from our website and promote it.

bassosimone added a commit to ooni/probe-cli that referenced this issue Sep 15, 2021
@bassosimone
doc: explain how to write ooni nettests
9518efd 
This is a preliminary commit and requires more work. I am going
to push this commit so others soon can start to review it.

This diff also contains a library of building blocks that is
instrumental to complete websteps. In fact, the tutorial I have
written here will eventually guide people to write their own
implementation of websteps.

I have not written any test for the new code so far. It is
also a stretch to call this new code. It is existing code that
has been written by me or @kelmenhorst that I have adapted
for the purpose of writing the tutorial.

The nice exercise of writing a tutorial is that you are more
easily frustrated if the code is difficult to use XD.

See ooni/ooni.org#361.

See ooni/probe#1733.
@bassosimone bassosimone mentioned this issue Sep 15, 2021
Closed
3 tasks
@bassosimone bassosimone mentioned this issue Sep 24, 2021
Closed
3 tasks
bassosimone added a commit to ooni/probe-cli that referenced this issue Sep 28, 2021
@bassosimone
doc: add tutorial on how to use netxlite
4885620 
The main tutorial will be the one at #506, but
it's useful to also document the primitives used by measurex.

So, here's the companion tutorial, which explains how to use the
features in netxlite to perform measurements.

This work is part of ooni/ooni.org#361.
@bassosimone bassosimone mentioned this issue Sep 28, 2021
Merged
3 tasks
bassosimone added a commit to ooni/probe-cli that referenced this issue Sep 28, 2021
@bassosimone
doc: add tutorial on how to use netxlite (#519)
9ef4d9d 
The main tutorial will be the one at #506, but
it's useful to also document the primitives used by measurex.

So, here's the companion tutorial, which explains how to use the
features in netxlite to perform measurements.

This work is part of ooni/ooni.org#361.
bassosimone added a commit to ooni/probe-cli that referenced this issue Sep 29, 2021
@bassosimone @hellais
doc(measurex): explain how to write experiments
a69edc3 
Part of ooni/ooni.org#361

Co-authored-by: Arturo Filastò <arturo@openobservatory.org>
@bassosimone bassosimone mentioned this issue Sep 29, 2021
Merged
3 tasks
bassosimone added a commit to ooni/probe-cli that referenced this issue Sep 29, 2021
@bassosimone @hellais
doc(measurex): explain how to write experiments (#529)
d45e58c 
Part of ooni/ooni.org#361

Co-authored-by: Arturo Filastò <arturo@openobservatory.org>
@hellais
Copy link
Member

hellais commented Oct 6, 2021

The second tutorial for writing OONI tests is now published. The index for all the tutorials is here: https://github.com/ooni/probe-cli/tree/master/internal/tutorial. It has also been linked from the get-involved section of our website.

@hellais hellais closed this as completed Oct 6, 2021
ainghazal pushed a commit to ainghazal/probe-cli that referenced this issue Mar 8, 2022
@bassosimone
doc: add tutorial on how to use netxlite (ooni#519)
07a0cf5 
The main tutorial will be the one at ooni#506, but
it's useful to also document the primitives used by measurex.

So, here's the companion tutorial, which explains how to use the
features in netxlite to perform measurements.

This work is part of ooni/ooni.org#361.
ainghazal pushed a commit to ainghazal/probe-cli that referenced this issue Mar 8, 2022
@bassosimone @hellais
doc(measurex): explain how to write experiments (ooni#529)
4d3e446 
Part of ooni/ooni.org#361

Co-authored-by: Arturo Filastò <arturo@openobservatory.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bassosimone bassosimone

Labels
epic priority/medium
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@bassosimone @hellais @agrabeli