refactor(storage): new storage file structure

- new directory structure containing manifest.json and one json file per provider, by default. - the manifest.json file can specify a filepath for each vpn provider - each vpn provider json data file can contain the `"preferred": true` field to enforce it is used even if outdated, unless there is a version mismatch - `STORAGE_SERVERS_DIRECTORY_PATH` replaces `STORAGE_FILEPATH` (which is now a migration source only). It sets the directory where server manifest and per-provider JSON files are stored (default: `/gluetun/servers/`). - First-run migration: On startup, gluetun checks for the old /gluetun/servers.json file; if found and no new manifest exists, it automatically migrates all data to /gluetun/servers/ directory structure - Silent fallback: If legacy file isn't found, uses the new directory path normally - Legacy cleanup: After successful migration, attempts to remove the old fat JSON file (logs warning only if removal fails, e.g., read-only bind mounts)
2026-07-24 11:26:25 +02:00 · 2026-04-27 02:47:30 +00:00
parent 13503b0ae0
commit d9cc7dcffb
303 changed files with 304957 additions and 304344 deletions
@@ -0,0 +1,125 @@
+package models
+
+import (
+	"net/netip"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_Server_Equal(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		a     *Server
+		b     Server
+		equal bool
+	}{
+		"same IPs": {
+			a: &Server{
+				IPs: []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4})},
+			},
+			b: Server{
+				IPs: []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4})},
+			},
+			equal: true,
+		},
+		"same IP strings": {
+			a: &Server{
+				IPs: []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4})},
+			},
+			b: Server{
+				IPs: []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4})},
+			},
+			equal: true,
+		},
+		"different IPs": {
+			a: &Server{
+				IPs: []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4}), netip.AddrFrom4([4]byte{2, 3, 4, 5})},
+			},
+			b: Server{
+				IPs: []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 4}), netip.AddrFrom4([4]byte{1, 2, 3, 4})},
+			},
+		},
+		"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,
+			},
+			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,
+			},
+			equal: true,
+		},
+		"different field": {
+			a: &Server{
+				VPN: "vpn",
+			},
+			b: Server{
+				VPN: "other vpn",
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			ipsOfANotNil := testCase.a.IPs != nil
+			ipsOfBNotNil := testCase.b.IPs != nil
+
+			equal := testCase.a.Equal(testCase.b)
+
+			assert.Equal(t, testCase.equal, equal)
+
+			// Ensure IPs field is not modified
+			if ipsOfANotNil {
+				assert.NotNil(t, testCase.a)
+			}
+			if ipsOfBNotNil {
+				assert.NotNil(t, testCase.b)
+			}
+		})
+	}
+}