c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
519 Commits 6 Branches 0 Tags 8.8 MiB
Go 97.6%
Python 1.2%
Shell 0.9%
Makefile 0.3%
c264f61536
Go to file
Simone Basso c264f61536
feat(ooniprobe): introduce websites_max_runtime (#273) 
We cannot control anymore the maximum number of URLs using the API
because now we are using check-in, that has no such limit.

We could theoretically clamp the number of URLs to measure after
the call to check-in, and still honour the setting.

Yet, the right thing to do seems to introduce a max runtime variable
because that is what desktop and mobile do.

Thus, introduce code that warns the user about the change in the
settings, should they have set the URL limit to nonzero.

We are going to do a best effort conversion from the URL limit to
the maximum runtime for the rest of 2021.

Since then, we will silently ignore the URL limit.

This work is part of https://github.com/ooni/probe/issues/1299.
2021-03-30 11:16:12 +02:00
.github/workflows fix(android): remove pin to specific NDK version (#246) 2021-03-08 14:52:04 +01:00
CLI refactor: build miniooni from toplevel (#203) 2021-02-02 15:34:03 +01:00
cmd feat(ooniprobe): introduce websites_max_runtime (#273) 2021-03-30 11:16:12 +02:00
debian feat(ooniprobe): introduce websites_max_runtime (#273) 2021-03-30 11:16:12 +02:00
docs doc: ensure all top dirs have an explanatory README (#214) 2021-02-03 16:54:00 +01:00
E2E feat: use go1.16 and resources embedding (#235) 2021-03-02 12:08:24 +01:00
internal fix(miniooni): replace --limit with --max-runtime (#272) 2021-03-29 20:38:23 +02:00
MOBILE doc: ensure all top dirs have an explanatory README (#214) 2021-02-03 16:54:00 +01:00
pkg feat(session): expose CheckIn method (#266) 2021-03-29 15:04:41 +02:00
QA feat: use go1.16 and resources embedding (#235) 2021-03-02 12:08:24 +01:00
.gitignore refactor: move more commands to internal/cmd (#207) 2021-02-03 12:23:15 +01:00
build-android.bash fix(android): remove pin to specific NDK version (#246) 2021-03-08 14:52:04 +01:00
build-ios.bash feat: use go1.16 and resources embedding (#235) 2021-03-02 12:08:24 +01:00
build-miniooni.sh feat: use go1.16 and resources embedding (#235) 2021-03-02 12:08:24 +01:00
build.sh feat: use go1.16 and resources embedding (#235) 2021-03-02 12:08:24 +01:00
CODE_OF_CONDUCT.md doc: add code of conduct (#157) 2020-11-03 21:16:04 +01:00
CODEOWNERS chore: continue merging probe-engine into probe-cli (#211) 2021-02-03 14:42:51 +01:00
CONTRIBUTING.md doc: merge the engine and the cli readmes (#215) 2021-02-03 19:29:12 +01:00
go.mod engine/ooapi: autogenerated API with login and caching (#234) 2021-03-04 11:51:07 +01:00
go.sum engine/ooapi: autogenerated API with login and caching (#234) 2021-03-04 11:51:07 +01:00
LICENSE.md Add LICENSE.md 2018-07-11 18:06:27 +02:00
publish-android.bash refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
publish-ios.bash refactor: enable automatic iOS builds (#209) 2021-02-03 13:51:15 +01:00
Readme.md chore: set version to 3.7.0-alpha (#240) 2021-03-04 11:36:41 +01:00
smoketest.sh fix: import path should be github.com/ooni/probe-cli/v3 (#200) 2021-02-02 10:32:46 +01:00
testjafar.bash refactor: enable QA tests and jafar self test (#208) 2021-02-03 13:20:37 +01:00

Readme.md

OONI Probe Client Library and CLI

GoDoc Short Tests Status All Tests Status Coverage Status Go Report Card linux-debian-packages GitHub issues by-label

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

Please, report issues with this codebase at github.com/ooni/probe. 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 need to download assets first using:

go run ./internal/cmd/getresources

Then you can build using:

go build -v ./cmd/ooniprobe

This will generate a binary called ooniprobe in the current directory.

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.

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

Releasing

  1. update binary data as described above;

  2. update internal/version/version.go;

  3. make sure you have updated dependencies;

  4. run ./build.sh release and follow instructions.