chore(settings): refactor settings processing (#756)

- Better settings tree structure logged using `qdm12/gotree` - Read settings from environment variables, then files, then secret files - Settings methods to default them, merge them and override them - `DNS_PLAINTEXT_ADDRESS` default changed to `127.0.0.1` to use DoT. Warning added if set to something else. - `HTTPPROXY_LISTENING_ADDRESS` instead of `HTTPPROXY_PORT` (with retro-compatibility)
2022-01-06 06:40:23 -05:00
parent 46738b2934
commit 7d824a5179
275 changed files with 7167 additions and 6328 deletions
--- a/internal/provider/surfshark/connection.go
+++ b/internal/provider/surfshark/connection.go
@@ -1,17 +1,17 @@
 package surfshark

 import (
-	"github.com/qdm12/gluetun/internal/configuration"
+	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/constants"
 	"github.com/qdm12/gluetun/internal/models"
 	"github.com/qdm12/gluetun/internal/provider/utils"
 )

-func (s *Surfshark) GetConnection(selection configuration.ServerSelection) (
+func (s *Surfshark) GetConnection(selection settings.ServerSelection) (
 	connection models.Connection, err error) {
 	protocol := constants.UDP
 	var port uint16 = 1194
-	if selection.OpenVPN.TCP {
+	if *selection.OpenVPN.TCP {
 		protocol = constants.TCP
 		port = 1443
 	}
--- a/internal/provider/surfshark/filter.go
+++ b/internal/provider/surfshark/filter.go
@@ -1,12 +1,12 @@
 package surfshark

 import (
-	"github.com/qdm12/gluetun/internal/configuration"
+	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/models"
 	"github.com/qdm12/gluetun/internal/provider/utils"
 )

-func (s *Surfshark) filterServers(selection configuration.ServerSelection) (
+func (s *Surfshark) filterServers(selection settings.ServerSelection) (
 	servers []models.SurfsharkServer, err error) {
 	for _, server := range s.servers {
 		switch {
@@ -16,7 +16,7 @@ func (s *Surfshark) filterServers(selection configuration.ServerSelection) (
 			utils.FilterByPossibilities(server.City, selection.Cities),
 			utils.FilterByPossibilities(server.Hostname, selection.Hostnames),
 			utils.FilterByProtocol(selection, server.TCP, server.UDP),
-			selection.MultiHopOnly && !server.MultiHop:
+			*selection.MultiHopOnly && !server.MultiHop:
 		default:
 			servers = append(servers, server)
 		}
--- a/internal/provider/surfshark/filter_test.go
+++ b/internal/provider/surfshark/filter_test.go
@@ -5,27 +5,27 @@ import (
 	"math/rand"
 	"testing"

-	"github.com/qdm12/gluetun/internal/configuration"
+	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/constants"
 	"github.com/qdm12/gluetun/internal/models"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )

+func boolPtr(b bool) *bool { return &b }
+
 func Test_Surfshark_filterServers(t *testing.T) {
 	t.Parallel()

 	testCases := map[string]struct {
 		servers   []models.SurfsharkServer
-		selection configuration.ServerSelection
+		selection settings.ServerSelection
 		filtered  []models.SurfsharkServer
 		err       error
 	}{
 		"no server available": {
-			selection: configuration.ServerSelection{
-				VPN: constants.OpenVPN,
-			},
-			err: errors.New("no server found: for VPN openvpn; protocol udp"),
+			selection: settings.ServerSelection{}.WithDefaults(constants.Surfshark),
+			err:       errors.New("no server found: for VPN openvpn; protocol udp"),
 		},
 		"no filter": {
 			servers: []models.SurfsharkServer{
@@ -33,6 +33,7 @@ func Test_Surfshark_filterServers(t *testing.T) {
 				{Hostname: "b", UDP: true},
 				{Hostname: "c", UDP: true},
 			},
+			selection: settings.ServerSelection{}.WithDefaults(constants.Surfshark),
 			filtered: []models.SurfsharkServer{
 				{Hostname: "a", UDP: true},
 				{Hostname: "b", UDP: true},
@@ -40,9 +41,9 @@ func Test_Surfshark_filterServers(t *testing.T) {
 			},
 		},
 		"filter by region": {
-			selection: configuration.ServerSelection{
+			selection: settings.ServerSelection{
 				Regions: []string{"b"},
-			},
+			}.WithDefaults(constants.Surfshark),
 			servers: []models.SurfsharkServer{
 				{Region: "a", UDP: true},
 				{Region: "b", UDP: true},
@@ -53,9 +54,9 @@ func Test_Surfshark_filterServers(t *testing.T) {
 			},
 		},
 		"filter by country": {
-			selection: configuration.ServerSelection{
+			selection: settings.ServerSelection{
 				Countries: []string{"b"},
-			},
+			}.WithDefaults(constants.Surfshark),
 			servers: []models.SurfsharkServer{
 				{Country: "a", UDP: true},
 				{Country: "b", UDP: true},
@@ -66,9 +67,9 @@ func Test_Surfshark_filterServers(t *testing.T) {
 			},
 		},
 		"filter by city": {
-			selection: configuration.ServerSelection{
+			selection: settings.ServerSelection{
 				Cities: []string{"b"},
-			},
+			}.WithDefaults(constants.Surfshark),
 			servers: []models.SurfsharkServer{
 				{City: "a", UDP: true},
 				{City: "b", UDP: true},
@@ -79,9 +80,9 @@ func Test_Surfshark_filterServers(t *testing.T) {
 			},
 		},
 		"filter by hostname": {
-			selection: configuration.ServerSelection{
+			selection: settings.ServerSelection{
 				Hostnames: []string{"b"},
-			},
+			}.WithDefaults(constants.Surfshark),
 			servers: []models.SurfsharkServer{
 				{Hostname: "a", UDP: true},
 				{Hostname: "b", UDP: true},
@@ -92,11 +93,11 @@ func Test_Surfshark_filterServers(t *testing.T) {
 			},
 		},
 		"filter by protocol": {
-			selection: configuration.ServerSelection{
-				OpenVPN: configuration.OpenVPNSelection{
-					TCP: true,
+			selection: settings.ServerSelection{
+				OpenVPN: settings.OpenVPNSelection{
+					TCP: boolPtr(true),
 				},
-			},
+			}.WithDefaults(constants.Surfshark),
 			servers: []models.SurfsharkServer{
 				{Hostname: "a", UDP: true},
 				{Hostname: "b", UDP: true, TCP: true},
@@ -107,9 +108,9 @@ func Test_Surfshark_filterServers(t *testing.T) {
 			},
 		},
 		"filter by multihop only": {
-			selection: configuration.ServerSelection{
-				MultiHopOnly: true,
-			},
+			selection: settings.ServerSelection{
+				MultiHopOnly: boolPtr(true),
+			}.WithDefaults(constants.Surfshark),
 			servers: []models.SurfsharkServer{
 				{Hostname: "a", UDP: true},
 				{Hostname: "b", MultiHop: true, UDP: true},
--- a/internal/provider/surfshark/openvpnconf.go
+++ b/internal/provider/surfshark/openvpnconf.go
@@ -3,25 +3,27 @@ package surfshark
 import (
 	"strconv"

-	"github.com/qdm12/gluetun/internal/configuration"
+	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/constants"
 	"github.com/qdm12/gluetun/internal/models"
 	"github.com/qdm12/gluetun/internal/provider/utils"
 )

 func (s *Surfshark) BuildConf(connection models.Connection,
-	settings configuration.OpenVPN) (lines []string, err error) {
+	settings settings.OpenVPN) (lines []string, err error) {
 	if len(settings.Ciphers) == 0 {
 		settings.Ciphers = []string{constants.AES256gcm}
 	}

-	if settings.Auth == "" {
-		settings.Auth = constants.SHA512
+	auth := *settings.Auth
+	if auth == "" {
+		auth = constants.SHA512
 	}

-	const defaultMSSFix = 1450
-	if settings.MSSFix == 0 {
-		settings.MSSFix = defaultMSSFix
+	mssFix := *settings.MSSFix
+	if mssFix == 0 {
+		const defaultMSSFix = 1450
+		mssFix = defaultMSSFix
 	}

 	lines = []string{
@@ -29,17 +31,17 @@ func (s *Surfshark) BuildConf(connection models.Connection,
 		"nobind",
 		"tls-exit",
 		"dev " + settings.Interface,
-		"verb " + strconv.Itoa(settings.Verbosity),
+		"verb " + strconv.Itoa(*settings.Verbosity),

 		// Surfshark specific
 		"tun-mtu-extra 32",
-		"mssfix " + strconv.Itoa(int(settings.MSSFix)),
+		"mssfix " + strconv.Itoa(int(mssFix)),
 		"ping 15",
 		"remote-cert-tls server",
 		"reneg-sec 0",
 		"key-direction 1",
 		"auth-user-pass " + constants.OpenVPNAuthConf,
-		"auth " + settings.Auth,
+		"auth " + auth,

 		// Added constant values
 		"auth-nocache",
@@ -59,13 +61,13 @@ func (s *Surfshark) BuildConf(connection models.Connection,
 		lines = append(lines, "explicit-exit-notify")
 	}

-	if !settings.Root {
+	if !*settings.Root {
 		lines = append(lines, "user "+settings.ProcUser)
 		lines = append(lines, "persist-tun")
 		lines = append(lines, "persist-key")
 	}

-	if !settings.IPv6 {
+	if !*settings.IPv6 {
 		lines = append(lines, `pull-filter ignore "route-ipv6"`)
 		lines = append(lines, `pull-filter ignore "ifconfig-ipv6"`)
 	}