ooni-probe-cli/internal/cmd/miniooni/README.md

# miniooni

This directory contains the source code of a simple CLI client that we
use for research as well as for running QA scripts. We designed this tool
to have a CLI similar to MK and OONI Probe v2.x to ease running Jafar
scripts that check whether these tools behave similarly. Perfect backwards
compatibility was not a design goal for miniooni. Rather, we aimed to
have as little conflict as possible, such that we can run side-by-side
QA checks.
chore: merge probe-engine into probe-cli (#201) This is how I did it: 1. `git clone https://github.com/ooni/probe-engine internal/engine` 2. ``` (cd internal/engine && git describe --tags) v0.23.0 ``` 3. `nvim go.mod` (merging `go.mod` with `internal/engine/go.mod` 4. `rm -rf internal/.git internal/engine/go.{mod,sum}` 5. `git add internal/engine` 6. `find . -type f -name \*.go -exec sed -i 's@/ooni/probe-engine@/ooni/probe-cli/v3/internal/engine@g' {} \;` 7. `go build ./...` (passes) 8. `go test -race ./...` (temporary failure on RiseupVPN) 9. `go mod tidy` 10. this commit message Once this piece of work is done, we can build a new version of `ooniprobe` that is using `internal/engine` directly. We need to do more work to ensure all the other functionality in `probe-engine` (e.g. making mobile packages) are still WAI. Part of https://github.com/ooni/probe/issues/1335 2021-02-02 12:05:47 +01:00			`# miniooni`

			`This directory contains the source code of a simple CLI client that we`
			`use for research as well as for running QA scripts. We designed this tool`
			`to have a CLI similar to MK and OONI Probe v2.x to ease running Jafar`
refactor: merge libminiooni into cmd/miniooni (#268) We used to have an external package called libminiooni so that third parties could use it. We wrote this such that we could support github.com/bassosimone/aladdin. That was actually a not-so-good idea because it added to the APIs we needed to maintain. Since the merge of engine into cli, such an API is not public anymore and aladdin has been deprecated and archived. Therefore, we can now cleanup the situation and merge libminiooni into miniooni again, thus making the codebase more local. This cleanup has been identified while working on https://github.com/ooni/probe/issues/1299. 2021-03-29 19:03:53 +02:00			`scripts that check whether these tools behave similarly. Perfect backwards`
			`compatibility was not a design goal for miniooni. Rather, we aimed to`
			`have as little conflict as possible, such that we can run side-by-side`
			`QA checks.`