31e478b04e
* fix(pkg.go.dev): import a subpackage containing the assets We're trying to fix this issue that pkg.go.dev does not build. Thanks to @hellais for this very neat idea! Let's keep our fingers crossed and see whether it fixes! * feat: use embedded geoip databases Closes https://github.com/ooni/probe/issues/1372. Work done as part of https://github.com/ooni/probe/issues/1369. * fix(assetsx): add tests * feat: simplify and just vendor uncompressed DBs * remove tests that seems not necessary anymore * fix: run go mod tidy * Address https://github.com/ooni/probe-cli/pull/260/files#r605181364 * rewrite a test in a better way * fix: gently cleanup the legacy assetsdir Do not remove the whole directory with brute force. Just zap the files whose name we know. Then attempt to delete the legacy directory as well. If not empty, just fail. This is fine because it means the user has stored other files inside the directory. * fix: create .miniooni if missing
78 lines
3.0 KiB
Markdown
78 lines
3.0 KiB
Markdown
# OONI Probe Client Library and CLI
|
|
|
|
[](https://godoc.org/github.com/ooni/probe-cli) [](https://github.com/ooni/probe-cli/actions?query=workflow%3Ashorttests) [](https://github.com/ooni/probe-cli/actions?query=workflow%3Aalltests) [](https://coveralls.io/github/ooni/probe-cli?branch=master) [](https://goreportcard.com/report/github.com/ooni/probe-cli) [](https://github.com/ooni/probe-cli/actions?query=workflow%3Alinux-debian-packages) [](https://github.com/ooni/probe/labels/ooni%2Fprobe-cli)
|
|
|
|
The next generation OONI Probe: client library and Command Line Interface.
|
|
|
|
## User setup
|
|
|
|
Please, follow the instructions at [ooni.org/install/cli](https://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
|
|
|
|
Please, report issues with this codebase at [github.com/ooni/probe](
|
|
https://github.com/ooni/probe/issues/new?labels=ooni/probe-cli&assignee=bassosimone).
|
|
Please, make sure you tag such issues using the `ooni/probe-cli` label.
|
|
|
|
## Repository organization
|
|
|
|
Every top-level directory contains an explanatory README file.
|
|
|
|
## Development setup
|
|
|
|
Be sure you have golang >= 1.16 and a C compiler (when developing for Windows, you
|
|
need Mingw-w64 installed). You can build using:
|
|
|
|
```bash
|
|
go build -v ./cmd/ooniprobe
|
|
```
|
|
|
|
This will generate a binary called `ooniprobe` in the current directory.
|
|
|
|
## Android bindings
|
|
|
|
```bash
|
|
./build-android.bash
|
|
```
|
|
|
|
We automatically build Android bindings whenever commits are pushed to the
|
|
`mobile-staging` branch. Such builds could be integrated by using:
|
|
|
|
```Groovy
|
|
implementation "org.ooni:oonimkall:VERSION"
|
|
```
|
|
|
|
Where VERSION is like `2020.03.30-231914` corresponding to the
|
|
time when the build occurred.
|
|
|
|
## iOS bindings
|
|
|
|
```bash
|
|
./build-ios.bash
|
|
```
|
|
|
|
We automatically build iOS bindings whenever commits are pushed to the
|
|
`mobile-staging` branch. Such builds could be integrated by using:
|
|
|
|
```ruby
|
|
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
|
|
|
|
```bash
|
|
go get -u -v ./... && go mod tidy
|
|
```
|
|
|
|
## Releasing
|
|
|
|
Create an issue according to [the routine release template](
|
|
https://github.com/ooni/probe/blob/master/.github/ISSUE_TEMPLATE/routine-sprint-releases.md)
|
|
and perform any item inside the check-list.
|