Opened 7 years ago

Closed 6 years ago

#6073 closed task (implemented)

Vocabulary for OONI

Reported by: hellais Owned by: hellais
Priority: Medium Milestone:
Component: Archived/Ooni Version:
Severity: Keywords: ooni_documentation, SponsorH201208, quickfix
Cc: ioerror, isis Actual Points:
Parent ID: #5869 Points:
Reviewer: Sponsor:

Description

We agreed on some common vocabulary to be used inside of OONI:

Test ID: The identification of the test (i.e. the Test Name)
OONI Deck: A set of tests (e.x. (BridgeT, Traceroute, httphost))
OONI Probe: A unique ID and a deck
OONI Package: Software that is distributed to the end machines
OONI File: The standalone file associated with a probing session.

Is there some other naming that we need to agree on?

Child Tickets

Change History (6)

comment:1 Changed 7 years ago by hellais

Component: - Select a componentOoni
Owner: set to hellais
Type: defecttask

comment:2 Changed 6 years ago by hellais

Status: newneeds_review

This has been implemented here:
https://gitweb.torproject.org/ooni-probe.git/commit/58a998b669e7b2eedfe7fb7cbf8c632b17f28ea7

Since the creation of this ticket the names have changed a bit and this is how things are currently called in the code.

I may have missed something and there may be some additions to be made or changes.

This should anyways be a working document and not something static.

The rendered result should soon appear here: http://ooni.readthedocs.org/en/latest/glossary.html

comment:3 Changed 6 years ago by ioerror

I feel that OONI file is a bit ambiguous - I would prefer 'yamlooni file' as it denotes what kind of file as well as the encoding.

Also, I think 'A unique ID ' is undefined and should be 'a randomly generated UUID' if nothing else.

comment:4 Changed 6 years ago by hellais

Keywords: ooni_documentation added

comment:5 Changed 6 years ago by isis

Normally, I'm all in favour of eccentricities, although perhaps, for compatibility's sake, we may just want to use the standard ".yaml".

hellais, do you know about yaml parsers that are already out there, and if so, do any of them expect a certain filename extension?

comment:6 Changed 6 years ago by hellais

Keywords: SponsorH201208 quickfix added
Resolution: implemented
Status: needs_reviewclosed
Note: See TracTickets for help on using tickets.