From 815b6faf185a07462ce20021245b0248f2fb2b4e Mon Sep 17 00:00:00 2001 From: Simone Basso Date: Mon, 16 Jan 2023 13:22:39 +0100 Subject: [PATCH] cleanup: finish moving packages away from engine (#1034) This diff includes some cleanups while we finish moving packages away from the internal/engine package. With this diff, we have finally finished merging probe-engine into probe-cli, a process initiated in February 2021. See https://github.com/ooni/probe/issues/1335. Closes https://github.com/ooni/probe/issues/2115. --- MOBILE/android/template.pom | 78 +++++++++---------- Readme.md | 7 +- internal/experiment/README.md | 2 +- internal/experiment/torsf/torsf.go | 2 +- internal/experiment/torsf/torsf_test.go | 2 +- internal/experiment/vanillator/vanillator.go | 2 +- .../experiment/vanillator/vanillator_test.go | 2 +- internal/model/location.go | 2 +- internal/tutorial/README.md | 3 +- .../experiment/torsf/chapter01/README.md | 2 +- pkg/oonimkall/doc.go | 2 +- 11 files changed, 49 insertions(+), 55 deletions(-) diff --git a/MOBILE/android/template.pom b/MOBILE/android/template.pom index bbf7f53130..a31164d72e 100644 --- a/MOBILE/android/template.pom +++ b/MOBILE/android/template.pom @@ -1,39 +1,39 @@ - - - 4.0.0 - - org.ooni - oonimkall - @VERSION@ - aar - - oonimkall - OONI Probe Library for Android - https://github.com/ooni/probe-cli - - - - The 3-Clause BSD License - https://opensource.org/licenses/BSD-3-Clause - repo - - - - - https://github.com/ooni/probe-engine - https://github.com/ooni/probe-engine.git - - - - - Simone Basso - simone@openobservatory.org - - Core developer - - Europe/Rome - - - - + + + 4.0.0 + + org.ooni + oonimkall + @VERSION@ + aar + + oonimkall + OONI Probe Library for Android + https://github.com/ooni/probe-cli + + + + The 3-Clause BSD License + https://opensource.org/licenses/BSD-3-Clause + repo + + + + + https://github.com/ooni/probe-cli + https://github.com/ooni/probe-cli.git + + + + + Simone Basso + simone@openobservatory.org + + Core developer + + Europe/Rome + + + + diff --git a/Readme.md b/Readme.md index 440a7708f5..3a44707dd4 100644 --- a/Readme.md +++ b/Readme.md @@ -16,12 +16,7 @@ This repository contains core OONI tools written in Go: - the OONI Probe engine (inside [internal](internal)). -Every top-level directory in this repository contains an explanatory README file. You -may also notice that some internal packages live under [internal/engine](internal/engine) -while most others are top-level. This is part of [a long-standing refactoring]( -https://github.com/ooni/probe/issues/2115) started when we merged -https://github.com/ooni/probe-engine into this repository. We'll slowly -ensure that all packages inside `engine` are moved out of it and inside `internal`. +Every top-level directory in this repository contains an explanatory README file. ## Semantic versioning policy diff --git a/internal/experiment/README.md b/internal/experiment/README.md index accde538b7..6fff199a53 100644 --- a/internal/experiment/README.md +++ b/internal/experiment/README.md @@ -1,4 +1,4 @@ -# Directory github.com/ooni/probe-cli/internal/engine/experiment +# Directory github.com/ooni/probe-cli/v3/internal/experiment This directory contains the implementation of all the supported experiments, one for each directory. The [OONI spec repository diff --git a/internal/experiment/torsf/torsf.go b/internal/experiment/torsf/torsf.go index 99ad54c108..fec59ed084 100644 --- a/internal/experiment/torsf/torsf.go +++ b/internal/experiment/torsf/torsf.go @@ -20,7 +20,7 @@ import ( ) // Implementation note: this file is written with easy diffing with respect -// to internal/engine/experiment/vanillator/vanillator.go in mind. +// to internal/experiment/vanillator/vanillator.go in mind. // // We may want to have a single implementation for both nettests in the future. diff --git a/internal/experiment/torsf/torsf_test.go b/internal/experiment/torsf/torsf_test.go index 4401b11533..8b9853ea75 100644 --- a/internal/experiment/torsf/torsf_test.go +++ b/internal/experiment/torsf/torsf_test.go @@ -16,7 +16,7 @@ import ( ) // Implementation note: this file is written with easy diffing with respect -// to internal/engine/experiment/vanillator/vanillator_test.go in mind. +// to internal/experiment/vanillator/vanillator_test.go in mind. // // We may want to have a single implementation for both nettests in the future. diff --git a/internal/experiment/vanillator/vanillator.go b/internal/experiment/vanillator/vanillator.go index 1b6d687770..104deeecdf 100644 --- a/internal/experiment/vanillator/vanillator.go +++ b/internal/experiment/vanillator/vanillator.go @@ -18,7 +18,7 @@ import ( ) // Implementation note: this file is written with easy diffing with respect -// to internal/engine/experiment/torsf/torsf.go in mind. +// to internal/experiment/torsf/torsf.go in mind. // // We may want to have a single implementation for both nettests in the future. diff --git a/internal/experiment/vanillator/vanillator_test.go b/internal/experiment/vanillator/vanillator_test.go index 87eee4376c..21ce6d92d5 100644 --- a/internal/experiment/vanillator/vanillator_test.go +++ b/internal/experiment/vanillator/vanillator_test.go @@ -15,7 +15,7 @@ import ( ) // Implementation note: this file is written with easy diffing with respect -// to internal/engine/experiment/torsf/torsf_test.go in mind. +// to internal/experiment/torsf/torsf_test.go in mind. // // We may want to have a single implementation for both nettests in the future. diff --git a/internal/model/location.go b/internal/model/location.go index 63e82190ab..36322f8abc 100644 --- a/internal/model/location.go +++ b/internal/model/location.go @@ -1,7 +1,7 @@ package model // LocationProvider is an interface that returns the current location. The -// github.com/ooni/probe-cli/v3/internal/engine/session.Session implements it. +// [engine.Session] struct implements this interface. type LocationProvider interface { ProbeASN() uint ProbeASNString() string diff --git a/internal/tutorial/README.md b/internal/tutorial/README.md index b0fb0c69d7..88a80f711b 100644 --- a/internal/tutorial/README.md +++ b/internal/tutorial/README.md @@ -13,8 +13,7 @@ explains to you how to write a simple experiment. After reading it, you will understand the interfaces between an experiment and the OONI core. What this tutorial does not teach you, though, is how to tell the OONI core about this experiment. To see how to do that, -you should check how we do that in [internal/engine/allexperiments.go]( -../engine/allexperiments.go). +you should check how we do that in [internal/registry](../registry). - [Using the measurex package to write network experiments](measurex): this tutorial explains to you how to use the `measurex` library to write networking diff --git a/internal/tutorial/experiment/torsf/chapter01/README.md b/internal/tutorial/experiment/torsf/chapter01/README.md index dce51cab1c..fe8f4b3821 100644 --- a/internal/tutorial/experiment/torsf/chapter01/README.md +++ b/internal/tutorial/experiment/torsf/chapter01/README.md @@ -55,7 +55,7 @@ The apex/log library is the logging library used by OONI Probe. The torsf package contains the implementation of the torsf experiment. ```Go - "github.com/ooni/probe-cli/v3/internal/engine/experiment/torsf" + "github.com/ooni/probe-cli/v3/internal/experiment/torsf" ``` diff --git a/pkg/oonimkall/doc.go b/pkg/oonimkall/doc.go index bf1302e58c..527367b83f 100644 --- a/pkg/oonimkall/doc.go +++ b/pkg/oonimkall/doc.go @@ -38,7 +38,7 @@ // See also https://github.com/ooni/probe-engine/pull/347 for the // design document describing the task API. // -// See also https://github.com/ooni/probe-cli/v3/internal/engine/blob/master/DESIGN.md, +// See also https://github.com/ooni/probe-engine/blob/master/DESIGN.md, // which explains why we implemented the oonimkall API. // // # Session API