Maint: package local narrow Logger interfaces

internal/configuration/health.go

@@ -5,7 +5,6 @@ import (
 	"strings"
 
 	"github.com/qdm12/gluetun/internal/models"
-	"github.com/qdm12/golibs/logging"
 	"github.com/qdm12/golibs/params"
 )
 
@@ -36,8 +35,8 @@ func (settings *Health) lines() (lines []string) {
 }
 
 // Read is to be used for the healthcheck query mode.
-func (settings *Health) Read(env params.Interface, logger logging.Logger) (err error) {
-	reader := newReader(env, models.AllServers{}, logger) // note: no need for servers data
+func (settings *Health) Read(env params.Interface, warner Warner) (err error) {
+	reader := newReader(env, models.AllServers{}, warner) // note: no need for servers data
 	return settings.read(reader)
 }
 
@@ -46,7 +45,7 @@ func (settings *Health) read(r reader) (err error) {
 	settings.ServerAddress, warning, err = r.env.ListeningAddress(
 		"HEALTH_SERVER_ADDRESS", params.Default("127.0.0.1:9999"))
 	if warning != "" {
-		r.logger.Warn("environment variable HEALTH_SERVER_ADDRESS: " + warning)
+		r.warner.Warn("environment variable HEALTH_SERVER_ADDRESS: " + warning)
 	}
 	if err != nil {
 		return fmt.Errorf("environment variable HEALTH_SERVER_ADDRESS: %w", err)

internal/configuration/health_test.go

@@ -6,7 +6,6 @@ import (
 	"time"
 
 	"github.com/golang/mock/gomock"
-	"github.com/qdm12/golibs/logging/mock_logging"
 	"github.com/qdm12/golibs/params/mock_params"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -215,7 +214,7 @@ func Test_Health_read(t *testing.T) {
 			ctrl := gomock.NewController(t)
 
 			env := mock_params.NewMockInterface(ctrl)
-			logger := mock_logging.NewMockLogger(ctrl)
+			warner := NewMockWarner(ctrl)
 
 			if testCase.serverAddress.call {
 				value := testCase.serverAddress.s
@@ -224,7 +223,7 @@ func Test_Health_read(t *testing.T) {
 				env.EXPECT().ListeningAddress("HEALTH_SERVER_ADDRESS", gomock.Any()).
 					Return(value, warning, err)
 				if warning != "" {
-					logger.EXPECT().Warn("environment variable HEALTH_SERVER_ADDRESS: " + warning)
+					warner.EXPECT().Warn("environment variable HEALTH_SERVER_ADDRESS: " + warning)
 				}
 			}
 
@@ -253,7 +252,7 @@ func Test_Health_read(t *testing.T) {
 
 			r := reader{
 				env:    env,
-				logger: logger,
+				warner: warner,
 			}
 
 			var health Health

internal/configuration/httpproxy.go

@@ -78,7 +78,7 @@ func (settings *HTTPProxy) read(r reader) (err error) {
 	settings.Port, warning, err = r.env.ListeningPort("HTTPPROXY_PORT", params.Default("8888"),
 		params.RetroKeys([]string{"TINYPROXY_PORT", "PROXY_PORT"}, r.onRetroActive))
 	if len(warning) > 0 {
-		r.logger.Warn(warning)
+		r.warner.Warn(warning)
 	}
 	if err != nil {
 		return fmt.Errorf("environment variable HTTPPROXY_PORT (or TINYPROXY_PORT, PROXY_PORT): %w", err)

internal/configuration/reader.go

@@ -9,32 +9,37 @@ import (
 
 	"github.com/qdm12/gluetun/internal/models"
 	ovpnextract "github.com/qdm12/gluetun/internal/openvpn/extract"
-	"github.com/qdm12/golibs/logging"
 	"github.com/qdm12/golibs/params"
 	"github.com/qdm12/golibs/verification"
 )
 
+//go:generate mockgen -destination=warner_mock_test.go -package configuration . Warner
+
 type reader struct {
 	servers models.AllServers
 	env     params.Interface
-	logger  logging.Logger
+	warner  Warner
 	regex   verification.Regex
 	ovpnExt ovpnextract.Interface
 }
 
+type Warner interface {
+	Warn(s string)
+}
+
 func newReader(env params.Interface,
-	servers models.AllServers, logger logging.Logger) reader {
+	servers models.AllServers, warner Warner) reader {
 	return reader{
 		servers: servers,
 		env:     env,
-		logger:  logger,
+		warner:  warner,
 		regex:   verification.NewRegex(),
 		ovpnExt: ovpnextract.New(),
 	}
 }
 
 func (r *reader) onRetroActive(oldKey, newKey string) {
-	r.logger.Warn(
+	r.warner.Warn(
 		"You are using the old environment variable " + oldKey +
 			", please consider changing it to " + newKey)
 }

internal/configuration/server.go

@@ -40,7 +40,7 @@ func (settings *ControlServer) read(r reader) (err error) {
 	settings.Port, warning, err = r.env.ListeningPort(
 		"HTTP_CONTROL_SERVER_PORT", params.Default("8000"))
 	if len(warning) > 0 {
-		r.logger.Warn(warning)
+		r.warner.Warn(warning)
 	}
 	if err != nil {
 		return fmt.Errorf("environment variable HTTP_CONTROL_SERVER_PORT: %w", err)

internal/configuration/settings.go

@@ -6,7 +6,6 @@ import (
 	"strings"
 
 	"github.com/qdm12/gluetun/internal/models"
-	"github.com/qdm12/golibs/logging"
 	"github.com/qdm12/golibs/params"
 )
 
@@ -66,8 +65,8 @@ var (
 // Read obtains all configuration options for the program and returns an error as soon
 // as an error is encountered reading them.
 func (settings *Settings) Read(env params.Interface, servers models.AllServers,
-	logger logging.Logger) (err error) {
-	r := newReader(env, servers, logger)
+	warner Warner) (err error) {
+	r := newReader(env, servers, warner)
 
 	settings.VersionInformation, err = r.env.OnOff("VERSION_INFORMATION", params.Default("on"))
 	if err != nil {

internal/configuration/shadowsocks.go

@@ -62,7 +62,7 @@ func (settings *ShadowSocks) read(r reader) (err error) {
 
 	warning, err := settings.getAddress(r.env)
 	if warning != "" {
-		r.logger.Warn(warning)
+		r.warner.Warn(warning)
 	}
 	if err != nil {
 		return err

internal/configuration/warner_mock_test.go

@@ -0,0 +1,46 @@
+// Code generated by MockGen. DO NOT EDIT.
+// Source: github.com/qdm12/gluetun/internal/configuration (interfaces: Warner)
+
+// Package configuration is a generated GoMock package.
+package configuration
+
+import (
+	reflect "reflect"
+
+	gomock "github.com/golang/mock/gomock"
+)
+
+// MockWarner is a mock of Warner interface.
+type MockWarner struct {
+	ctrl     *gomock.Controller
+	recorder *MockWarnerMockRecorder
+}
+
+// MockWarnerMockRecorder is the mock recorder for MockWarner.
+type MockWarnerMockRecorder struct {
+	mock *MockWarner
+}
+
+// NewMockWarner creates a new mock instance.
+func NewMockWarner(ctrl *gomock.Controller) *MockWarner {
+	mock := &MockWarner{ctrl: ctrl}
+	mock.recorder = &MockWarnerMockRecorder{mock}
+	return mock
+}
+
+// EXPECT returns an object that allows the caller to indicate expected use.
+func (m *MockWarner) EXPECT() *MockWarnerMockRecorder {
+	return m.recorder
+}
+
+// Warn mocks base method.
+func (m *MockWarner) Warn(arg0 string) {
+	m.ctrl.T.Helper()
+	m.ctrl.Call(m, "Warn", arg0)
+}
+
+// Warn indicates an expected call of Warn.
+func (mr *MockWarnerMockRecorder) Warn(arg0 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Warn", reflect.TypeOf((*MockWarner)(nil).Warn), arg0)
+}