PureVPN provider revamp

.env.purevpn.example

@@ -0,0 +1,4 @@
+PUREVPN_USER=your-username
+PUREVPN_PASSWORD=your-password
+# Optional timezone for container logs
+TZ=UTC

.gitignore

@@ -1,2 +1,3 @@
 scratch.txt
+.env.purevpn
 .DS_Store

internal/configuration/settings/openvpnselection_test.go

@@ -0,0 +1,62 @@
+package settings
+
+import (
+	"testing"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_OpenVPNSelection_validate(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		selection OpenVPNSelection
+		provider  string
+		err       error
+	}{
+		"purevpn default selection is valid": {
+			selection: openVPNSelectionForValidation(providers.Purevpn),
+			provider:  providers.Purevpn,
+		},
+		"purevpn TCP without custom port is valid": {
+			selection: func() OpenVPNSelection {
+				s := openVPNSelectionForValidation(providers.Purevpn)
+				s.Protocol = constants.TCP
+				return s
+			}(),
+			provider: providers.Purevpn,
+		},
+		"purevpn custom port is rejected": {
+			selection: func() OpenVPNSelection {
+				s := openVPNSelectionForValidation(providers.Purevpn)
+				*s.CustomPort = 1194
+				return s
+			}(),
+			provider: providers.Purevpn,
+			err:      ErrOpenVPNCustomPortNotAllowed,
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			err := testCase.selection.validate(testCase.provider)
+			if testCase.err == nil {
+				require.NoError(t, err)
+				return
+			}
+			require.Error(t, err)
+			assert.ErrorIs(t, err, testCase.err)
+		})
+	}
+}
+
+func openVPNSelectionForValidation(provider string) OpenVPNSelection {
+	selection := OpenVPNSelection{}
+	selection.setDefaults(provider)
+	return selection
+}

internal/configuration/settings/serverselection.go

@@ -103,6 +103,10 @@ func (ss *ServerSelection) validate(vpnServiceProvider string,
 		*ss = nordvpnRetroRegion(*ss, filterChoices.Regions, filterChoices.Countries)
 	case providers.Surfshark:
 		*ss = surfsharkRetroRegion(*ss)
+	case providers.Purevpn:
+		// Keep parsing SERVER_REGIONS for retro-compatibility, but
+		// do not apply it to PureVPN filtering.
+		ss.Regions = nil
 	}
 
 	err = validateServerFilters(*ss, filterChoices, vpnServiceProvider, warner)

internal/models/server.go

@@ -13,29 +13,33 @@ import (
 type Server struct {
 	VPN string `json:"vpn,omitempty"`
 	// Surfshark: country is also used for multi-hop
-	Country     string       `json:"country,omitempty"`
-	Region      string       `json:"region,omitempty"`
-	City        string       `json:"city,omitempty"`
-	ISP         string       `json:"isp,omitempty"`
-	Categories  []string     `json:"categories,omitempty"`
-	Owned       bool         `json:"owned,omitempty"`
-	Number      uint16       `json:"number,omitempty"`
-	ServerName  string       `json:"server_name,omitempty"`
-	Hostname    string       `json:"hostname,omitempty"`
-	TCP         bool         `json:"tcp,omitempty"`
-	UDP         bool         `json:"udp,omitempty"`
-	OvpnX509    string       `json:"x509,omitempty"`
-	RetroLoc    string       `json:"retroloc,omitempty"` // TODO remove in v4
-	MultiHop    bool         `json:"multihop,omitempty"`
-	WgPubKey    string       `json:"wgpubkey,omitempty"`
-	Free        bool         `json:"free,omitempty"` // TODO v4 create a SubscriptionTier struct
-	Premium     bool         `json:"premium,omitempty"`
-	Stream      bool         `json:"stream,omitempty"` // TODO v4 create a Features struct
-	SecureCore  bool         `json:"secure_core,omitempty"`
-	Tor         bool         `json:"tor,omitempty"`
-	PortForward bool         `json:"port_forward,omitempty"`
-	Keep        bool         `json:"keep,omitempty"`
-	IPs         []netip.Addr `json:"ips,omitempty"`
+	Country          string       `json:"country,omitempty"`
+	Region           string       `json:"region,omitempty"`
+	City             string       `json:"city,omitempty"`
+	ISP              string       `json:"isp,omitempty"`
+	Categories       []string     `json:"categories,omitempty"`
+	Owned            bool         `json:"owned,omitempty"`
+	Number           uint16       `json:"number,omitempty"`
+	ServerName       string       `json:"server_name,omitempty"`
+	Hostname         string       `json:"hostname,omitempty"`
+	TCP              bool         `json:"tcp,omitempty"`
+	UDP              bool         `json:"udp,omitempty"`
+	TCPPorts         []uint16     `json:"tcp_ports,omitempty"`
+	UDPPorts         []uint16     `json:"udp_ports,omitempty"`
+	OvpnX509         string       `json:"x509,omitempty"`
+	RetroLoc         string       `json:"retroloc,omitempty"` // TODO remove in v4
+	MultiHop         bool         `json:"multihop,omitempty"`
+	WgPubKey         string       `json:"wgpubkey,omitempty"`
+	Free             bool         `json:"free,omitempty"` // TODO v4 create a SubscriptionTier struct
+	Premium          bool         `json:"premium,omitempty"`
+	Stream           bool         `json:"stream,omitempty"` // TODO v4 create a Features struct
+	SecureCore       bool         `json:"secure_core,omitempty"`
+	Tor              bool         `json:"tor,omitempty"`
+	PortForward      bool         `json:"port_forward,omitempty"`
+	QuantumResistant bool         `json:"quantum_resistant,omitempty"`
+	Obfuscated       bool         `json:"obfuscated,omitempty"`
+	Keep             bool         `json:"keep,omitempty"`
+	IPs              []netip.Addr `json:"ips,omitempty"`
 }
 
 var (

internal/models/server_test.go

@@ -43,52 +43,56 @@ func Test_Server_Equal(t *testing.T) {
 		},
 		"all fields equal": {
 			a: &Server{
-				VPN:         "vpn",
-				Country:     "country",
-				Region:      "region",
-				City:        "city",
-				ISP:         "isp",
-				Owned:       true,
-				Number:      1,
-				ServerName:  "server_name",
-				Hostname:    "hostname",
-				TCP:         true,
-				UDP:         true,
-				OvpnX509:    "x509",
-				RetroLoc:    "retroloc",
-				MultiHop:    true,
-				WgPubKey:    "wgpubkey",
-				Free:        true,
-				Stream:      true,
-				SecureCore:  true,
-				Tor:         true,
-				PortForward: true,
-				IPs:         []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4})},
-				Keep:        true,
+				VPN:              "vpn",
+				Country:          "country",
+				Region:           "region",
+				City:             "city",
+				ISP:              "isp",
+				Owned:            true,
+				Number:           1,
+				ServerName:       "server_name",
+				Hostname:         "hostname",
+				TCP:              true,
+				UDP:              true,
+				OvpnX509:         "x509",
+				RetroLoc:         "retroloc",
+				MultiHop:         true,
+				WgPubKey:         "wgpubkey",
+				Free:             true,
+				Stream:           true,
+				SecureCore:       true,
+				Tor:              true,
+				PortForward:      true,
+				QuantumResistant: true,
+				Obfuscated:       true,
+				IPs:              []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4})},
+				Keep:             true,
 			},
 			b: Server{
-				VPN:         "vpn",
-				Country:     "country",
-				Region:      "region",
-				City:        "city",
-				ISP:         "isp",
-				Owned:       true,
-				Number:      1,
-				ServerName:  "server_name",
-				Hostname:    "hostname",
-				TCP:         true,
-				UDP:         true,
-				OvpnX509:    "x509",
-				RetroLoc:    "retroloc",
-				MultiHop:    true,
-				WgPubKey:    "wgpubkey",
-				Free:        true,
-				Stream:      true,
-				SecureCore:  true,
-				Tor:         true,
-				PortForward: true,
-				IPs:         []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4})},
-				Keep:        true,
+				VPN:              "vpn",
+				Country:          "country",
+				Region:           "region",
+				City:             "city",
+				ISP:              "isp",
+				Owned:            true,
+				Number:           1,
+				ServerName:       "server_name",
+				Hostname:         "hostname",
+				TCP:              true,
+				UDP:              true,
+				OvpnX509:         "x509",
+				RetroLoc:         "retroloc",
+				MultiHop:         true,
+				WgPubKey:         "wgpubkey",
+				Free:             true,
+				Stream:           true,
+				SecureCore:       true,
+				Tor:              true,
+				PortForward:      true,
+				QuantumResistant: true,
+				Obfuscated:       true,
+				IPs:              []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4})},
+				Keep:             true,
 			},
 			equal: true,
 		},

internal/provider/providers.go

@@ -75,7 +75,7 @@ func NewProviders(storage Storage, timeNow func() time.Time,
 		providers.PrivateInternetAccess: privateinternetaccess.New(storage, randSource, timeNow, client),
 		providers.Privatevpn:            privatevpn.New(storage, randSource, unzipper, updaterWarner, parallelResolver),
 		providers.Protonvpn:             protonvpn.New(storage, randSource, client, updaterWarner, *credentials.ProtonEmail, *credentials.ProtonPassword),
-		providers.Purevpn:               purevpn.New(storage, randSource, ipFetcher, unzipper, updaterWarner, parallelResolver),
+		providers.Purevpn:               purevpn.New(storage, randSource, client, ipFetcher, unzipper, updaterWarner, parallelResolver),
 		providers.SlickVPN:              slickvpn.New(storage, randSource, client, updaterWarner, parallelResolver),
 		providers.Surfshark:             surfshark.New(storage, randSource, client, unzipper, updaterWarner, parallelResolver),
 		providers.Torguard:              torguard.New(storage, randSource, unzipper, updaterWarner, parallelResolver),

internal/provider/purevpn/connection.go

@@ -9,7 +9,7 @@ import (
 func (p *Provider) GetConnection(selection settings.ServerSelection, ipv6Supported bool) (
 	connection models.Connection, err error,
 ) {
-	defaults := utils.NewConnectionDefaults(80, 53, 0) //nolint:mnd
+	defaults := utils.NewConnectionDefaults(80, 15021, 0)
 	return utils.GetConnection(p.Name(),
 		p.storage, selection, defaults, ipv6Supported, p.randSource)
 }