ooni-probe-cli/internal/engine
Simone Basso 6351d898d6
refactor: miniooni should be outside of the engine (#206)
* refactor: miniooni should be outside of the engine

This is part of https://github.com/ooni/probe/issues/1335. We also need
to think whether we wanna keep libminiooni and miniooni separated.

The previous use case for having a top-level libminiooni was that of
enabling others to integrate miniooni into other binaries.

This was usegul when studying internet censorship in Spain in May 2020.

I am wondering whether we should be keeping this complexity. I am not
sure about this and probably we should be killing it.

(In any case, reducing complexity is not the objective of this diff,
since I would like instead to move things around with minimal changes
and make sure we have a ~good repository organization here.)

* fix: import in libminiooni
2021-02-03 11:21:10 +01:00
..
.github refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
atomicx chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
cmd refactor: miniooni should be outside of the engine (#206) 2021-02-03 11:21:10 +01:00
experiment refactor: miniooni should be outside of the engine (#206) 2021-02-03 11:21:10 +01:00
geolocate refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
humanizex refactor: miniooni should be outside of the engine (#206) 2021-02-03 11:21:10 +01:00
internal refactor: miniooni should be outside of the engine (#206) 2021-02-03 11:21:10 +01:00
legacy refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
model chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
netx refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
probeservices chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
QA chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
resources fix: add missing files causing tests to fail (#202) 2021-02-02 14:18:22 +01:00
runtimex refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
testdata fix: add missing files causing tests to fail (#202) 2021-02-02 14:18:22 +01:00
version chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
.gitignore chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
allexperiments.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
AUTHORS chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
build-ios.bash chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
CODE_OF_CONDUCT.md chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
CODEOWNERS chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
CONTRIBUTING.md chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
DESIGN.md chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
experiment_integration_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
experiment_internal_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
experiment_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
experiment.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
experimentbuilder_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
experimentbuilder.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
inputloader_integration_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
inputloader_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
inputloader.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
inputprocessor_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
inputprocessor.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
kvstore_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
kvstore.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
LICENSE chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
publish-ios.bash chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
README.md chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
saver_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
saver.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
session_integration_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
session_internal_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
session.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
submitter_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
submitter.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
testjafar.bash chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
testusing.bash chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00

OONI probe measurement engine

GoDoc Short Tests Status All Tests Status Coverage Status Go Report Card

This repository contains OONI probe's measurement engine. That is, the piece of software that implements OONI nettests as well as all the required functionality to run such nettests.

We expect you to use the Go version indicated in go.mod.

Integrating ooni/probe-engine

We recommend pinning to a specific version of probe-engine:

go get -v github.com/ooni/probe-engine@VERSION

See also the workflows/using.yml test where we check that the latest commit can be imported by a third party.

We do not provide any API stability guarantee.

Building miniooni

miniooni is a small command line client used for research and quality assurance testing. Build using:

go build -v ./cmd/miniooni/

See also ./build-cli.bash for more advanced builds (e.g. to create statically linked and/or stripped binaries).

We don't provide any miniooni command line flags stability guarantee.

See

./miniooni --help

for more help.

Building Android bindings

./build-android.bash

We automatically build Android bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

implementation "org.ooni:oonimkall:VERSION"

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

Building iOS bindings

./build-ios.bash

We automatically build iOS bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

pod 'oonimkall', :podspec => 'https://dl.bintray.com/ooni/ios/oonimkall-VERSION.podspec'

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

Updating dependencies

go get -u -v ./... && go mod tidy