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 ooni/probe#1335. Closes ooni/probe#2115.
ooni · Jan 16, 2023 · 815b6fa · 815b6fa
1 parent 92b657d
commit 815b6fa
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 55 deletions.
diff --git a/MOBILE/android/template.pom b/MOBILE/android/template.pom
@@ -1,39 +1,39 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-  <modelVersion>4.0.0</modelVersion>
-
-  <groupId>org.ooni</groupId>
-  <artifactId>oonimkall</artifactId>
-  <version>@VERSION@</version>
-  <packaging>aar</packaging>
-
-  <name>oonimkall</name>
-  <description>OONI Probe Library for Android</description>
-  <url>https://github.com/ooni/probe-cli</url>
-
-  <licenses>
-    <license>
-      <name>The 3-Clause BSD License</name>
-      <url>https://opensource.org/licenses/BSD-3-Clause</url>
-      <distribution>repo</distribution>
-    </license>
-  </licenses>
-
-  <scm>
-    <url>https://github.com/ooni/probe-engine</url>
-    <connection>https://github.com/ooni/probe-engine.git</connection>
-  </scm>
-
-  <developers>
-    <developer>
-      <name>Simone Basso</name>
-      <email>[email protected]</email>
-      <roles>
-        <role>Core developer</role>
-      </roles>
-      <timezone>Europe/Rome</timezone>
-    </developer>
-  </developers>
-
-</project>
+<?xml version="1.0" encoding="UTF-8"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>org.ooni</groupId>
+  <artifactId>oonimkall</artifactId>
+  <version>@VERSION@</version>
+  <packaging>aar</packaging>
+
+  <name>oonimkall</name>
+  <description>OONI Probe Library for Android</description>
+  <url>https://github.com/ooni/probe-cli</url>
+
+  <licenses>
+    <license>
+      <name>The 3-Clause BSD License</name>
+      <url>https://opensource.org/licenses/BSD-3-Clause</url>
+      <distribution>repo</distribution>
+    </license>
+  </licenses>
+
+  <scm>
+    <url>https://github.com/ooni/probe-cli</url>
+    <connection>https://github.com/ooni/probe-cli.git</connection>
+  </scm>
+
+  <developers>
+    <developer>
+      <name>Simone Basso</name>
+      <email>[email protected]</email>
+      <roles>
+        <role>Core developer</role>
+      </roles>
+      <timezone>Europe/Rome</timezone>
+    </developer>
+  </developers>
+
+</project>
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
-Original file line number
+Diff line change
@@ Expand Up @@
     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"
     ```
@@ Expand Down @@