utils/ip_test.go at master · CodeLieutenant/utils · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
package utils_test

import (
	"net"
	"testing"

	"github.com/stretchr/testify/require"

	"github.com/CodeLieutenant/utils"
)

func TestGetLocalIP(t *testing.T) {
	t.Parallel()
	assert := require.New(t)
	addrs, err := net.InterfaceAddrs()
	assert.NoError(err)
	var ip string

	for _, address := range addrs {
		ipnet, ok := address.(*net.IPNet)

		// check the address type and if it is not a loopback the display it
		if ok && !ipnet.IP.IsLoopback() && ipnet.IP.To4() != nil {
			ip = ipnet.IP.String()
			break
		}
	}

	localIP := utils.GetLocalIP()

	assert.Equal(ip, localIP)

	// Testing the cached version
	localIP = utils.GetLocalIP()

	assert.Equal(ip, localIP)
}

func TestGetLocalIPs(t *testing.T) {
	t.Parallel()
	assert := require.New(t)
	addrs, err := net.InterfaceAddrs()
	assert.NoError(err)
	var ips []string

	for _, address := range addrs {
		ipnet, ok := address.(*net.IPNet)

		// check the address type and if it is not a loopback the display it
		if ok && !ipnet.IP.IsLoopback() && ipnet.IP.To4() != nil {
			ips = append(ips, ipnet.IP.String())
		}
	}

	localIps := utils.GetLocalIPs()

	assert.EqualValues(ips, localIps)

	// Testing the cached version
	localIps = utils.GetLocalIPs()

	assert.EqualValues(ips, localIps)
}

type mockPeekable struct {
	headers map[string][]byte
}

func (m *mockPeekable) Peek(key string) []byte {
	return m.headers[key]
}

func TestRealIP(t *testing.T) {
	t.Parallel()
	req := require.New(t)

	testCases := []struct {
		name           string
		headers        map[string][]byte
		expectedResult []byte
	}{
		{
			name: "X-Forwarded-For header with single IP",
			headers: map[string][]byte{
				utils.HeaderXForwardedFor: []byte("192.168.1.1"),
			},
			expectedResult: []byte("192.168.1.1"),
		},
		{
			name: "X-Forwarded-For header with multiple IPs",
			headers: map[string][]byte{
				utils.HeaderXForwardedFor: []byte("192.168.1.1,10.0.0.1,172.16.0.1"),
			},
			expectedResult: []byte("192.168.1.1"),
		},
		{
			name: "X-Real-IP header when X-Forwarded-For is empty",
			headers: map[string][]byte{
				utils.HeaderXRealIP: []byte("10.0.0.1"),
			},
			expectedResult: []byte("10.0.0.1"),
		},
		{
			name: "X-Forwarded-For takes precedence over X-Real-IP",
			headers: map[string][]byte{
				utils.HeaderXForwardedFor: []byte("192.168.1.1"),
				utils.HeaderXRealIP:       []byte("10.0.0.1"),
			},
			expectedResult: []byte("192.168.1.1"),
		},
		{
			name: "X-Forwarded-For with spaces around comma",
			headers: map[string][]byte{
				utils.HeaderXForwardedFor: []byte("192.168.1.1, 10.0.0.1"),
			},
			expectedResult: []byte("192.168.1.1"),
		},
		{
			name:           "No headers present",
			headers:        map[string][]byte{},
			expectedResult: nil,
		},
		{
			name: "Empty X-Forwarded-For and X-Real-IP",
			headers: map[string][]byte{
				utils.HeaderXForwardedFor: []byte(""),
				utils.HeaderXRealIP:       []byte(""),
			},
			expectedResult: nil,
		},
		{
			name: "Only X-Real-IP with empty X-Forwarded-For",
			headers: map[string][]byte{
				utils.HeaderXForwardedFor: []byte(""),
				utils.HeaderXRealIP:       []byte("172.16.0.1"),
			},
			expectedResult: []byte("172.16.0.1"),
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			mock := &mockPeekable{headers: tc.headers}
			result := utils.RealIP(mock)
			req.Equal(tc.expectedResult, result)
		})
	}
}