File: listener_test.go

package info (click to toggle)
golang-github-mdlayher-netx 0.0~git20230430.7e21880-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental, forky, sid, trixie
  • size: 156 kB
  • sloc: makefile: 3
file content (350 lines) | stat: -rw-r--r-- 8,195 bytes parent folder | download
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
package multinet_test

import (
	"context"
	"errors"
	"fmt"
	"io"
	"net"
	"net/http"
	"net/url"
	"path/filepath"
	"testing"
	"time"

	"github.com/google/go-cmp/cmp"
	"github.com/mdlayher/netx/multinet"
	"golang.org/x/net/nettest"
	"golang.org/x/sync/errgroup"
)

// TODO: copy over nettest.TestListener from vsock.

func TestListenerAddr(t *testing.T) {
	l := multinet.Listen(
		localListener("tcp4"),
		localListener("tcp6"),
		localListener("unix"),
	)
	defer l.Close()

	if diff := cmp.Diff("tcp,tcp,unix", l.Addr().Network()); diff != "" {
		t.Fatalf("unexpected networks (-want +got):\n%s", diff)
	}

	// Unpack each individual address from the slice to verify the fields
	// of the individual addresses.
	var (
		tcp4 *net.TCPAddr
		tcp6 *net.TCPAddr
		unix *net.UnixAddr
	)

	for i, a := range l.Addr().(multinet.Addr) {
		switch i {
		case 0:
			tcp4 = a.(*net.TCPAddr)
		case 1:
			tcp6 = a.(*net.TCPAddr)
		case 2:
			unix = a.(*net.UnixAddr)
		default:
			panic("l.Addr() returned too many addresses")
		}
	}

	// Port will be randomized, so just verify the correct localhost IP for
	// TCP addresses.
	if !tcp4.IP.Equal(net.IPv4(127, 0, 0, 1)) {
		t.Fatalf("unexpected IPv4 address: %s", tcp4.IP)
	}

	if !tcp6.IP.Equal(net.IPv6loopback) {
		t.Fatalf("unexpected IPv6 address: %s", tcp6.IP)
	}

	// The filename is randomized, so just look for a temporary directory prefix.
	// TODO: make work on non-UNIX.
	if filepath.Dir(unix.Name) != "/tmp" {
		t.Fatalf("unexpected UNIX address: %s", unix.Name)
	}

	// Finally, verify the String output in a deterministic way.
	tcp4.Port = 80
	tcp6.Port = 80
	unix.Name = "/tmp/foo"

	got := multinet.Addr{tcp4, tcp6, unix}.String()
	if diff := cmp.Diff("127.0.0.1:80,[::1]:80,/tmp/foo", got); diff != "" {
		t.Fatalf("unexpected string output (-want +got):\n%s", diff)
	}
}

func TestListenerHTTP(t *testing.T) {
	// Open several local listeners using different socket types so that we can
	// verify each works as expected for HTTP requests.
	var (
		tcp4 = localListener("tcp4")
		tcp6 = localListener("tcp6")
		unix = localListener("unix")
	)

	l := multinet.Listen(tcp4, tcp6, unix)

	srv := &http.Server{
		Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
			// Echo the client's remote address back to them.
			_, _ = io.WriteString(w, r.RemoteAddr)
		}),
	}

	// Serve HTTP on Listener until server is closed at the end of the test.
	var eg errgroup.Group
	eg.Go(func() error {
		if err := srv.Serve(l); err != nil && err != http.ErrServerClosed {
			return fmt.Errorf("failed to serve: %v", err)
		}

		return nil
	})

	defer func() {
		if err := srv.Close(); err != nil {
			t.Fatalf("failed to close server: %v", err)
		}

		if err := eg.Wait(); err != nil {
			t.Fatalf("failed to wait for server: %v", err)
		}
	}()

	// Given a certain listener address, perform an HTTP GET to the
	// multi-listener server and verify that the server handled our request
	// using the appropriate listener family.
	tests := []struct {
		name string
		l    net.Listener
		fn   func(t *testing.T, addr string)
	}{
		{
			name: "TCPv4",
			l:    tcp4,
			fn: func(t *testing.T, addr string) {
				ip := parseAddrIP(addr)
				if ip.To16() == nil || ip.To4() == nil {
					t.Fatalf("IP %q is not an IPv4 address", ip)
				}
			},
		},
		{
			name: "TCPv6",
			l:    tcp6,
			fn: func(t *testing.T, addr string) {
				ip := parseAddrIP(addr)
				if ip.To16() == nil || ip.To4() != nil {
					t.Fatalf("IP %q is not an IPv6 address", ip)
				}
			},
		},
		{
			name: "UNIX",
			l:    unix,
			fn: func(t *testing.T, addr string) {
				// UNIX socket addresses seem to be represented this way.
				if diff := cmp.Diff("@", addr); diff != "" {
					t.Fatalf("unexpected UNIX address (-want +got):\n%s", diff)
				}
			},
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			tt.fn(t, httpGet(t, tt.l.Addr()))
		})
	}
}

func TestListenerCloseError(t *testing.T) {
	// Verify that an error from a single listener is propagated back to the
	// caller on Close, and that further calls return no error.
	var (
		errFoo = errors.New("some error")

		// The first listener returns the expected error and the second's value
		// should be ignored. Close should be called on both.
		el1 = &errListener{err: errFoo}
		el2 = &errListener{err: errors.New("another error")}
	)

	l := multinet.Listen(
		localListener("tcp"),
		el1,
		el2,
	)

	var errs []error
	for i := 0; i < 3; i++ {
		errs = append(errs, l.Close())
	}

	if diff := cmp.Diff([]error{errFoo, nil, nil}, errs, cmp.Comparer(compareErrors)); diff != "" {
		t.Fatalf("unexpected Close errors (-want +got):\n%s", diff)
	}

	if !el1.closed {
		t.Fatal("first errListener was not closed")
	}
	if !el2.closed {
		t.Fatal("second errListener was not closed")
	}
}

func TestListenerNoSetDeadline(t *testing.T) {
	// TCP listener supports deadlines, but errListener does not.
	l := multinet.Listen(localListener("tcp"), &errListener{})
	defer l.Close()

	if err := l.SetDeadline(time.Now()); err == nil {
		t.Fatal("expected an error, but none occurred")
	}
}

func TestListenNoListeners(t *testing.T) {
	// While a Listener constructed with no net.Listeners wouldn't be useful,
	// we should verify it doesn't panic or similar.
	l := multinet.Listen()

	if diff := cmp.Diff(multinet.Addr{}, l.Addr()); diff != "" {
		t.Fatalf("unexpected Addr (-want +got):\n%s", diff)
	}

	// Close before and after accept to verify sanity.
	doClose := func() {
		for i := 0; i < 3; i++ {
			if err := l.Close(); err != nil {
				t.Fatalf("failed to close listener: %v", err)
			}
		}
	}

	doClose()

	if c, err := l.Accept(); err == nil || c != nil {
		t.Fatalf("expected nil net.Conn (got: %#v) and non-nil error", c)
	}

	doClose()
}

func compareErrors(x, y error) bool {
	switch {
	case x == nil && y == nil:
		// Both nil.
		return true
	case x == nil || y == nil:
		// One or the other nil.
		return false
	default:
		// Verify by string contents.
		return x.Error() == y.Error()
	}
}

func localListener(network string) net.Listener {
	l, err := nettest.NewLocalListener(network)
	if err != nil {
		panicf("failed to create local listener: %v", err)
	}

	return l
}

func httpGet(t *testing.T, addr net.Addr) string {
	t.Helper()

	var (
		transport = &http.Transport{}
		reqAddr   string
	)

	switch addr.(type) {
	case *net.TCPAddr:
		// Send requests to the TCP address of the server.
		reqAddr = (&url.URL{
			Scheme: "http",
			Host:   addr.String(),
		}).String()
	case *net.UnixAddr:
		// Send requests over UNIX socket instead of TCP.
		transport.DialContext = func(_ context.Context, _, _ string) (net.Conn, error) {
			return net.Dial("unix", addr.String())
		}

		// It seems this just has to be set to something nonsensical since we
		// are overriding Dial with a known address anyway.
		reqAddr = "http://foo"
	default:
		panicf("unhandled type: %T", addr)
	}

	c := &http.Client{
		Timeout:   1 * time.Second,
		Transport: transport,
	}

	req, err := http.NewRequest(http.MethodGet, reqAddr, nil)
	if err != nil {
		t.Fatalf("failed to create HTTP request: %v", err)
	}

	res, err := c.Do(req)
	if err != nil {
		t.Fatalf("failed to perform HTTP request: %v", err)
	}
	defer res.Body.Close()

	if res.StatusCode != http.StatusOK {
		t.Fatalf("expected HTTP 200, but got HTTP %d", res.StatusCode)
	}

	b, err := io.ReadAll(io.LimitReader(res.Body, 1024))
	if err != nil {
		t.Fatalf("failed to read HTTP body: %v", err)
	}

	return string(b)
}

func parseAddrIP(s string) net.IP {
	// Assume s is a host:port string where host is always an IP.
	host, _, err := net.SplitHostPort(s)
	if err != nil {
		panicf("failed to split host/port: %v", err)
	}

	ip := net.ParseIP(host)
	if ip == nil {
		panicf("failed to parse IP address: %v", err)
	}

	return ip
}

func panicf(format string, a ...interface{}) {
	panic(fmt.Sprintf(format, a...))
}

type errListener struct {
	err    error
	closed bool
}

var _ net.Listener = &errListener{}

func (*errListener) Addr() net.Addr            { panic("unimplemented") }
func (*errListener) Accept() (net.Conn, error) { panic("unimplemented") }
func (l *errListener) Close() error {
	l.closed = true
	return l.err
}