[Bug]:A potential goroutine leak in libnetwork/drivers/overlay/peerdb.go

[xuxiaofan1203]

Hello @olljanat, the libnetwork is useful, but I found a bug when I used it, I think we can fix it.
In the test file

libnetwork/drivers/overlay/overlay_test.go

Lines 134 to 144 in 3797618

	func TestOverlayType(t *testing.T) {
	dt := &driverTester{t: t}
	if err := Init(dt, nil); err != nil {
	t.Fatal(err)
	}
	if dt.d.Type() != testNetworkType {
	t.Fatalf("Expected Type() to return %q. Instead got %q", testNetworkType,
	dt.d.Type())
	}
	}

After the Init has executed and the ctx and cancel are created at

libnetwork/drivers/overlay/overlay.go

Lines 75 to 77 in 3797618

	ctx, cancel := context.WithCancel(context.Background())
	d.peerOpCancel = cancel
	go d.peerOpRoutine(ctx, d.peerOpCh)

There is no cancelFunc to awaken the ctx.Done() at

libnetwork/drivers/overlay/peerdb.go

Line 280 in 3797618

case <-ctx.Done():

So the goroutine will block, and you can use the goleak to reproduce the bug like this

func TestOverlayType(t *testing.T) {
	defer goleak.VerifyNone(t)
	dt := &driverTester{t: t}
	if err := Init(dt, nil); err != nil {
		t.Fatal(err)
	}

	if dt.d.Type() != testNetworkType {
		t.Fatalf("Expected Type() to return %q. Instead got %q", testNetworkType,
			dt.d.Type())
	}
}

And I think we can fix the bug by calling the cleanupDriver() after the init() gets executed.

[olljanat]

@xuxiaofan1203 please note what is wrote to readme:

Warning libnetwork was moved to https://github.com/moby/moby/tree/master/libnetwork

So double check if same issue still exists latest code int there and report it there if it does.
Also note that I'm not Moby maintainer but they are looking for that there in there.

[xuxiaofan1203]

@xuxiaofan1203 please note what is wrote to readme:

Warning libnetwork was moved to https://github.com/moby/moby/tree/master/libnetwork

So double check if same issue still exists latest code int there and report it there if it does. Also note that I'm not Moby maintainer but they are looking for that there in there.

Thank you for your reply and help, I will check again there. And I'm sorry to bother you.

[akerouanton]

As already noted by @olljanat, this repo is now defunct and not actively watched by maintainers. Also, it seems this goroutine leak only exists in an isolated test due to how it's written. So let me close this issue.