99b28c1d95
* refactor: start building an Android package Part of https://github.com/ooni/probe/issues/1335. This seems also a good moment to move some packages out of the engine, e.g., oonimkall. This package, for example, is a consumer of the engine, so it makes sense it's not _inside_ it. * fix: committed some stuff I didn't need to commit * fix: oonimkall needs to be public to build The side effect is that we will probably need to bump the major version number every time we change one of these APIs. (We can also of course choose to violate the basic guidelines of Go software, but I believe this is bad form.) I have no problem in bumping the major quite frequently and in any case this monorepo solution is convinving me more than continuing to keep a split between engine and cli. The need to embed assets to make the probe more reliable trumps the negative effects of having to ~frequently bump major because we expose a public API. * fix: let's not forget about libooniffi Honestly, I don't know what to do with this library. I added it to provide a drop in replacement for MK but I have no idea whether it's used and useful. I would not feel comfortable exposing it, unlike oonimkall, since we're not using it. It may be that the right thing to do here is just to delete the package and reduce the amount of code we're maintaining? * woops, we're still missing the publish android script * fix(publish-android.bash): add proper API key * ouch fix another place where the name changed |
||
|---|---|---|
| .. | ||
| .github | ||
| atomicx | ||
| cmd | ||
| experiment | ||
| geolocate | ||
| internal | ||
| legacy | ||
| libminiooni | ||
| model | ||
| netx | ||
| probeservices | ||
| QA | ||
| resources | ||
| runtimex | ||
| testdata | ||
| version | ||
| .gitignore | ||
| allexperiments.go | ||
| AUTHORS | ||
| build-ios.bash | ||
| CODE_OF_CONDUCT.md | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| DESIGN.md | ||
| experiment_integration_test.go | ||
| experiment_internal_test.go | ||
| experiment_test.go | ||
| experiment.go | ||
| experimentbuilder_test.go | ||
| experimentbuilder.go | ||
| inputloader_integration_test.go | ||
| inputloader_test.go | ||
| inputloader.go | ||
| inputprocessor_test.go | ||
| inputprocessor.go | ||
| kvstore_test.go | ||
| kvstore.go | ||
| LICENSE | ||
| publish-ios.bash | ||
| README.md | ||
| saver_test.go | ||
| saver.go | ||
| session_integration_test.go | ||
| session_internal_test.go | ||
| session.go | ||
| submitter_test.go | ||
| submitter.go | ||
| testjafar.bash | ||
| testusing.bash | ||
OONI probe measurement engine
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