d44970a43f
* chore: update all workflows to use go1.17.2 See https://github.com/ooni/probe/issues/1815 * chore: update all dependencies See https://github.com/ooni/probe/issues/1815 * chore: run `go generate` See https://github.com/ooni/probe/issues/1815 * chore: update the user-agent Part of https://github.com/ooni/probe/issues/1815 * Set version to 3.12.0-alpha Part of https://github.com/ooni/probe/issues/1815 * fix: update to ooni/probe-assets@v0.5.0 This overcomes https://github.com/ooni/probe/issues/1836 in the CLI and, while there, let us also make maxminddb tests stricter. * fix(QA/Dockerfile): build using go1.17 See https://github.com/ooni/probe-cli/pull/547#issuecomment-947760839 * chore(mk): use go1.17.2 Part of https://github.com/ooni/probe/issues/1815 * fix(codeql): always run for master Otherwise we see a warning that there is no CodeQL information available for the base branch and this is sub-optimal. Part of https://github.com/ooni/probe/issues/1815 |
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| CLI | ||
| cmd | ||
| debian | ||
| docs | ||
| E2E | ||
| internal | ||
| MOBILE | ||
| pkg | ||
| QA | ||
| testdata | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| mk | ||
| PULL_REQUEST_TEMPLATE.md | ||
| Readme.md | ||
| testjafar.bash | ||
OONI Probe Client Library and CLI
-
Documentation:
-
go test -race -short ./...status:
-
go test -race ./...status:
-
Code coverage for
-shorttests:
-
Go Report Card:
-
Debian package builds:
-
Open issues:
The next generation OONI Probe: client library and Command Line Interface.
User setup
Please, follow the instructions at ooni.org/install/cli
to install ooniprobe. If we do not support your use case, please let us know. Once
ooniprobe is installed, try ooniprobe help to get interactive help.
Reporting issues
Report issues at github.com/ooni/probe.
Please, make sure you add the ooni/probe-cli label.
Repository organization
Every top-level directory contains an explanatory README file.
ooniprobe
Be sure you have golang >= 1.16 and a C compiler (Mingw-w64 for Windows). You can build using:
go build -v ./cmd/ooniprobe
This will generate a binary called ooniprobe in the current directory.
Android bindings
Make sure you have GNU make installed, then run:
./mk android
to build bindings for Android. (Add OONI_PSIPHON_TAGS="" if you
cannot clone private repositories in the https://github.com/ooni namespace.)
The generated bindings are (manually) pushed to the Maven Central package repository. The instructions explaining how to integrate these bindings are published along with the release notes.
iOS bindings
Make sure you have GNU make installed, then run:
./mk ios
to build bindings for iOS. (Add OONI_PSIPHON_TAGS="" if you
cannot clone private repositories in the https://github.com/ooni namespace.)
The generated bindings are (manually) added to GitHub releases. The instructions explaining how to integrate these bindings are published along with the release notes.
miniooni
Miniooni is the experimental OONI client used for research. Compile using:
go build -v ./internal/cmd/miniooni
This will generate a binary called miniooni in the current directory.
Specification
Every nettest (aka experiment) implemented in this repository has a companion spec in the ooni/spec repository.
Updating dependencies
go get -u -v ./... && go mod tidy
Releasing
Create an issue according to the routine release template and perform any item inside the check-list.
We build releases using ./mk, which requires GNU make. Try
the ./mk help|less command for detailed usage.