File: l2tp_dynamic_test.go

package info (click to toggle)
golang-github-katalix-go-l2tp 0.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 632 kB
  • sloc: ansic: 127; sh: 10; makefile: 4
file content (362 lines) | stat: -rw-r--r-- 9,295 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
351
352
353
354
355
356
357
358
359
360
361
362
package l2tp

// More tunnel tests which require root permissions are implemented
// in l2tp_test.go in the TestRequiresRoot function.
//
// These tests are using the null dataplane and hence don't require root.

import (
	"fmt"
	"os"
	"sync"
	"testing"
	"time"

	"github.com/go-kit/kit/log"
	"github.com/go-kit/kit/log/level"
	"golang.org/x/sys/unix"
)

type eventCounters struct {
	tunnelUp, tunnelDown, sessionUp, sessionDown int
}

type testEventCounter struct {
	eventCounters
}

func (tec *testEventCounter) HandleEvent(event interface{}) {
	switch event.(type) {
	case *TunnelUpEvent:
		tec.tunnelUp++
	case *TunnelDownEvent:
		tec.tunnelDown++
	case *SessionUpEvent:
		tec.sessionUp++
	case *SessionDownEvent:
		tec.sessionDown++
	}
}

func (tec *testEventCounter) getEventCounts() eventCounters {
	return tec.eventCounters
}

type eventCounterCloser interface {
	EventHandler
	getEventCounts() eventCounters
	wait()
}

type testTunnelEventCounterCloser struct {
	testEventCounter
	wg sync.WaitGroup
}

func (tecc *testTunnelEventCounterCloser) HandleEvent(event interface{}) {
	tecc.testEventCounter.HandleEvent(event)
	if ev, ok := event.(*TunnelUpEvent); ok {
		t := ev.Tunnel
		tecc.wg.Add(1)
		go func() {
			t.Close()
			tecc.wg.Done()
		}()
	}
}

func (tecc *testTunnelEventCounterCloser) wait() {
	tecc.wg.Wait()
}

type testSessionEventCounterCloser struct {
	testEventCounter
	wg sync.WaitGroup
}

func (secc *testSessionEventCounterCloser) HandleEvent(event interface{}) {
	secc.testEventCounter.HandleEvent(event)
	if ev, ok := event.(*SessionUpEvent); ok {
		// Closing the tunnel should close the session, and will also cause the
		// test LNS instance to shut down
		t := ev.Tunnel
		secc.wg.Add(1)
		go func() {
			t.Close()
			secc.wg.Done()
		}()
	}
}

func (secc *testSessionEventCounterCloser) wait() {
	secc.wg.Wait()
}

type testLNS struct {
	logger             log.Logger
	tcfg               *TunnelConfig
	scfg               *SessionConfig
	xport              *transport
	tunnelEstablished  bool
	sessionEstablished bool
	isShutdown         bool
}

func newTestLNS(logger log.Logger, tcfg *TunnelConfig, scfg *SessionConfig) (*testLNS, error) {
	myLogger := log.With(logger, "tunnel_name", "testLNS")

	sal, sap, err := newUDPAddressPair(tcfg.Local, tcfg.Peer)
	if err != nil {
		return nil, fmt.Errorf("newUDPAddressPair(%v, %v): %v", tcfg.Local, tcfg.Peer, err)
	}

	cp, err := newL2tpControlPlane(sal, sap)
	if err != nil {
		return nil, fmt.Errorf("newL2tpControlPlane(%v, %v): %v", sal, sap, err)
	}

	err = cp.bind()
	if err != nil {
		return nil, fmt.Errorf("cp.bind(): %v", err)
	}

	xcfg := defaulttransportConfig()
	xcfg.Version = tcfg.Version
	xport, err := newTransport(myLogger, cp, xcfg)
	if err != nil {
		return nil, fmt.Errorf("newTransport(): %v", err)
	}

	lns := &testLNS{
		logger: myLogger,
		tcfg:   tcfg,
		scfg:   scfg,
		xport:  xport,
	}

	return lns, nil
}

func (lns *testLNS) shutdown() {
	level.Debug(lns.logger).Log("message", "shutdown")
	lns.isShutdown = true
}

func (lns *testLNS) handleV2Msg(msg *v2ControlMessage, from unix.Sockaddr) error {
	level.Debug(lns.logger).Log(
		"message", "receive control message",
		"message_type", msg.getType())
	switch msg.getType() {
	// Tunnel messages
	case avpMsgTypeSccrq:
		ptid, err := findUint16Avp(msg.getAvps(), vendorIDIetf, avpTypeTunnelID)
		if err != nil {
			return fmt.Errorf("no Tunnel ID AVP in SCCRQ")
		}
		lns.xport.config.PeerControlConnID = ControlConnID(ptid)
		lns.tcfg.PeerTunnelID = ControlConnID(ptid)
		lns.xport.cp.connectTo(from)
		rsp, err := newV2Sccrp(lns.tcfg)
		if err != nil {
			return fmt.Errorf("failed to build SCCRP: %v", err)
		}
		return lns.xport.send(rsp)
	case avpMsgTypeScccn:
		lns.tunnelEstablished = true
		return nil
	case avpMsgTypeStopccn:
		// HACK: allow the transport to ack the stopccn.
		// By closing the transport the transport recvChan will be
		// closed, which will cause the run() function to return.
		time.Sleep(250 * time.Millisecond)
		lns.isShutdown = true
		return nil
	case avpMsgTypeHello:
		return nil

	// Session messages
	case avpMsgTypeIcrq:
		psid, err := findUint16Avp(msg.getAvps(), vendorIDIetf, avpTypeSessionID)
		if err != nil {
			return fmt.Errorf("no Session ID AVP in ICRQ")
		}
		lns.scfg.PeerSessionID = ControlConnID(psid)
		rsp, err := newV2Icrp(lns.tcfg.PeerTunnelID, lns.scfg)
		if err != nil {
			return fmt.Errorf("failed to build ICRP: %v", err)
		}
		return lns.xport.send(rsp)
	case avpMsgTypeIccn:
		lns.sessionEstablished = true
		return nil
	case avpMsgTypeCdn:
		return nil
	}
	return fmt.Errorf("message %v not handled", msg.getType())
}

func (lns *testLNS) run(timeout time.Duration) {
	deadline := time.NewTimer(timeout)
	for !lns.isShutdown {
		select {
		case <-deadline.C:
			lns.shutdown()
			return
		case m, ok := <-lns.xport.recvChan:
			if !ok {
				return
			}
			msg, ok := m.msg.(*v2ControlMessage)
			if !ok {
				panic("failed to cast received message as v2ControlMessage")
			}
			err := lns.handleV2Msg(msg, m.from)
			if err != nil {
				lns.shutdown()
				return
			}
		}
	}
	lns.xport.close()
}

func TestDynamicClient(t *testing.T) {
	cases := []struct {
		name                            string
		localTunnelCfg, peerTunnelCfg   *TunnelConfig
		localSessionCfg, peerSessionCfg *SessionConfig
	}{
		{
			name: "L2TPv2 UDP AF_INET",
			localTunnelCfg: &TunnelConfig{
				Local:          "127.0.0.1:6000",
				Peer:           "localhost:5000",
				Version:        ProtocolVersion2,
				TunnelID:       4567,
				Encap:          EncapTypeUDP,
				StopCCNTimeout: 250 * time.Millisecond,
			},
			peerTunnelCfg: &TunnelConfig{
				Local:          "localhost:5000",
				Peer:           "127.0.0.1:6000",
				Version:        ProtocolVersion2,
				TunnelID:       4567,
				Encap:          EncapTypeUDP,
				StopCCNTimeout: 250 * time.Millisecond,
			},
		},
		{
			name: "L2TPv2 UDP AF_INET (alloc TID)",
			localTunnelCfg: &TunnelConfig{
				Local:          "127.0.0.1:6000",
				Peer:           "localhost:5000",
				Version:        ProtocolVersion2,
				Encap:          EncapTypeUDP,
				StopCCNTimeout: 250 * time.Millisecond,
			},
			peerTunnelCfg: &TunnelConfig{
				Local:          "localhost:5000",
				Peer:           "127.0.0.1:6000",
				Version:        ProtocolVersion2,
				TunnelID:       4567,
				Encap:          EncapTypeUDP,
				StopCCNTimeout: 250 * time.Millisecond,
			},
		},
		{
			name: "L2TPv2 UDP AF_INET (alloc TID, with session)",
			localTunnelCfg: &TunnelConfig{
				Local:          "127.0.0.1:6000",
				Peer:           "localhost:5000",
				Version:        ProtocolVersion2,
				Encap:          EncapTypeUDP,
				StopCCNTimeout: 250 * time.Millisecond,
			},
			localSessionCfg: &SessionConfig{
				Pseudowire: PseudowireTypePPP,
			},
			peerTunnelCfg: &TunnelConfig{
				Local:          "localhost:5000",
				Peer:           "127.0.0.1:6000",
				Version:        ProtocolVersion2,
				TunnelID:       4567,
				Encap:          EncapTypeUDP,
				StopCCNTimeout: 250 * time.Millisecond,
			},
			peerSessionCfg: &SessionConfig{
				Pseudowire: PseudowireTypePPP,
				SessionID:  5566,
			},
		},
	}
	for _, c := range cases {
		t.Run(c.name, func(t *testing.T) {
			logger := level.NewFilter(log.NewLogfmtLogger(os.Stderr), level.AllowDebug())

			// Create and run a test LNS instance
			lns, err := newTestLNS(logger, c.peerTunnelCfg, c.peerSessionCfg)
			if err != nil {
				t.Fatalf("newTestLNS: %v", err)
			}

			var lnsWg sync.WaitGroup
			lnsWg.Add(1)
			go func() {
				lns.run(3 * time.Second)
				lnsWg.Done()
			}()

			// Bring up the client tunnel.
			ctx, err := NewContext(nil, logger)
			if err != nil {
				t.Fatalf("NewContext(): %v", err)
			}

			// The event counter triggers shutdown when it sees a specific event.
			// For tests with just a tunnel, close on tunnel establishment.
			// For tests with a session, close on session establishment.
			var eventCounter eventCounterCloser
			if c.localSessionCfg != nil {
				eventCounter = &testSessionEventCounterCloser{}
			} else {
				eventCounter = &testTunnelEventCounterCloser{}
			}
			ctx.RegisterEventHandler(eventCounter)

			tunl, err := ctx.NewDynamicTunnel("t1", c.localTunnelCfg)
			if err != nil {
				t.Fatalf("NewDynamicTunnel(%q, %v): %v", "t1", c.localTunnelCfg, err)
			}

			// And optionally the client session
			if c.localSessionCfg != nil {
				_, err = tunl.NewSession("s1", c.peerSessionCfg)
				if err != nil {
					t.Fatalf("NewSession(%q, %v): %v", "s1", c.peerSessionCfg, err)
				}
			}

			lnsWg.Wait()
			ctx.Close()
			eventCounter.wait()

			// If we bought up tunnel and session we expect up/down events for both.
			// If we bought up just a tunnel, then we expect up/down events for the tunnel alone.
			var expectEvents eventCounters
			if c.localSessionCfg != nil {
				expectEvents = eventCounters{tunnelUp: 1, tunnelDown: 1, sessionUp: 1, sessionDown: 1}
			} else {
				expectEvents = eventCounters{tunnelUp: 1, tunnelDown: 1, sessionUp: 0, sessionDown: 0}
			}

			gotEvents := eventCounter.getEventCounts()
			if expectEvents != gotEvents {
				t.Errorf("event listener: expected %v event, got %v", expectEvents, gotEvents)
			}

			if lns.tunnelEstablished != true {
				t.Errorf("LNS didn't establish")
			}
		})
	}
}