cleanup: only define ErrNoAvailableTestHelpers once (#1583)

This is an easy cleanup I identified while working on ooni/probe#2725. Closes ooni/probe#2725.
ooni · May 2, 2024 · 1056c98 · 1056c98
1 parent cc25204
commit 1056c98
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 20 deletions.
diff --git a/internal/experiment/hhfm/hhfm.go b/internal/experiment/hhfm/hhfm.go
@@ -81,9 +81,6 @@ func (m Measurer) ExperimentVersion() string {
 }
 
 var (
-	// ErrNoAvailableTestHelpers is emitted when there are no available test helpers.
-	ErrNoAvailableTestHelpers = errors.New("no available helpers")
-
 	// ErrInvalidHelperType is emitted when the helper type is invalid.
 	ErrInvalidHelperType = errors.New("invalid helper type")
 )
@@ -104,7 +101,7 @@ func (m Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error {
 	const helperName = "http-return-json-headers"
 	helpers, ok := sess.GetTestHelpersByName(helperName)
 	if !ok || len(helpers) < 1 {
-		return ErrNoAvailableTestHelpers
+		return model.ErrNoAvailableTestHelpers
 	}
 	helper := helpers[0]
 	if helper.Type != "legacy" {

diff --git a/internal/experiment/hhfm/hhfm_test.go b/internal/experiment/hhfm/hhfm_test.go
@@ -272,7 +272,7 @@ func TestNoHelpers(t *testing.T) {
 		Session:     sess,
 	}
 	err := measurer.Run(ctx, args)
-	if !errors.Is(err, hhfm.ErrNoAvailableTestHelpers) {
+	if !errors.Is(err, model.ErrNoAvailableTestHelpers) {
 		t.Fatal("not the error we expected")
 	}
 	tk := measurement.TestKeys.(*hhfm.TestKeys)
@@ -327,7 +327,7 @@ func TestNoActualHelpersInList(t *testing.T) {
 		Session:     sess,
 	}
 	err := measurer.Run(ctx, args)
-	if !errors.Is(err, hhfm.ErrNoAvailableTestHelpers) {
+	if !errors.Is(err, model.ErrNoAvailableTestHelpers) {
 		t.Fatal("not the error we expected")
 	}
 	tk := measurement.TestKeys.(*hhfm.TestKeys)

diff --git a/internal/experiment/hirl/hirl.go b/internal/experiment/hirl/hirl.go
@@ -68,9 +68,6 @@ func (m Measurer) ExperimentVersion() string {
 }
 
 var (
-	// ErrNoAvailableTestHelpers is emitted when there are no available test helpers.
-	ErrNoAvailableTestHelpers = errors.New("no available helpers")
-
 	// ErrInvalidHelperType is emitted when the helper type is invalid.
 	ErrInvalidHelperType = errors.New("invalid helper type")
 
@@ -91,7 +88,7 @@ func (m Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error {
 	const helperName = "tcp-echo"
 	helpers, ok := sess.GetTestHelpersByName(helperName)
 	if !ok || len(helpers) < 1 {
-		return ErrNoAvailableTestHelpers
+		return model.ErrNoAvailableTestHelpers
 	}
 	helper := helpers[0]
 	if helper.Type != "legacy" {

diff --git a/internal/experiment/hirl/hirl_test.go b/internal/experiment/hirl/hirl_test.go
@@ -302,7 +302,7 @@ func TestNoHelpers(t *testing.T) {
 		Session:     sess,
 	}
 	err := measurer.Run(ctx, args)
-	if !errors.Is(err, hirl.ErrNoAvailableTestHelpers) {
+	if !errors.Is(err, model.ErrNoAvailableTestHelpers) {
 		t.Fatal("not the error we expected")
 	}
 	tk := measurement.TestKeys.(*hirl.TestKeys)
@@ -340,7 +340,7 @@ func TestNoActualHelperInList(t *testing.T) {
 		Session:     sess,
 	}
 	err := measurer.Run(ctx, args)
-	if !errors.Is(err, hirl.ErrNoAvailableTestHelpers) {
+	if !errors.Is(err, model.ErrNoAvailableTestHelpers) {
 		t.Fatal("not the error we expected")
 	}
 	tk := measurement.TestKeys.(*hirl.TestKeys)

diff --git a/internal/experiment/webconnectivity/webconnectivity.go b/internal/experiment/webconnectivity/webconnectivity.go
@@ -94,9 +94,6 @@ func (m Measurer) ExperimentVersion() string {
 }
 
 var (
-	// ErrNoAvailableTestHelpers is emitted when there are no available test helpers.
-	ErrNoAvailableTestHelpers = errors.New("no available helpers")
-
 	// ErrNoInput indicates that no input was provided
 	ErrNoInput = errors.New("no input provided")
 
@@ -145,7 +142,7 @@ func (m Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error {
 	// 1. find test helper
 	testhelpers, _ := sess.GetTestHelpersByName("web-connectivity")
 	if len(testhelpers) < 1 {
-		return ErrNoAvailableTestHelpers
+		return model.ErrNoAvailableTestHelpers
 	}
 	// 2. perform the DNS lookup step
 	dnsBegin := time.Now()

diff --git a/internal/experiment/webconnectivity/webconnectivity_test.go b/internal/experiment/webconnectivity/webconnectivity_test.go
@@ -206,7 +206,7 @@ func TestMeasureWithNoAvailableTestHelpers(t *testing.T) {
 		Session:     sess,
 	}
 	err := measurer.Run(ctx, args)
-	if !errors.Is(err, webconnectivity.ErrNoAvailableTestHelpers) {
+	if !errors.Is(err, model.ErrNoAvailableTestHelpers) {
 		t.Fatal(err)
 	}
 	tk := measurement.TestKeys.(*webconnectivity.TestKeys)

diff --git a/internal/experiment/webconnectivitylte/measurer.go b/internal/experiment/webconnectivitylte/measurer.go
@@ -10,7 +10,6 @@ import (
 	"net/http/cookiejar"
 	"sync"
 
-	"github.com/ooni/probe-cli/v3/internal/experiment/webconnectivity"
 	"github.com/ooni/probe-cli/v3/internal/inputparser"
 	"github.com/ooni/probe-cli/v3/internal/model"
 	"github.com/ooni/probe-cli/v3/internal/webconnectivityalgo"
@@ -108,7 +107,7 @@ func (m *Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error {
 	testhelpers, _ := sess.GetTestHelpersByName("web-connectivity")
 	if len(testhelpers) < 1 {
 		sess.Logger().Warnf("continuing without a valid TH address")
-		tk.SetControlFailure(webconnectivity.ErrNoAvailableTestHelpers)
+		tk.SetControlFailure(model.ErrNoAvailableTestHelpers)
 	}
 
 	registerExtensions(measurement)

diff --git a/internal/webconnectivityalgo/calltesthelpers.go b/internal/webconnectivityalgo/calltesthelpers.go
@@ -13,7 +13,7 @@ import (
 // given request object, the given list of available test helpers, and the given session.
 //
 // If the list of test helpers is empty this function immediately returns nil, zero,
-// and the [ErrNoAvailableTestHelpers] error to the caller.
+// and the [model.ErrNoAvailableTestHelpers] error to the caller.
 //
 // In case of any other failure, this function returns nil, zero, and an error.
 //