nextcloud-spreed-signaling/testutils_test.go
Joachim Bauch 0020076f2b
Run function to test for goroutine leaks as subtest.
This makes sure the test has been completely teared down before the
goroutines are counted and thus should prevent flaky failed tests.
2023-01-17 14:51:02 +01:00

75 lines
2 KiB
Go

/**
* Standalone signaling server for the Nextcloud Spreed app.
* Copyright (C) 2021 struktur AG
*
* @author Joachim Bauch <bauch@struktur.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package signaling
import (
"os"
"os/signal"
"runtime/pprof"
"sync"
"testing"
"time"
)
var listenSignalOnce sync.Once
func ensureNoGoroutinesLeak(t *testing.T, f func(t *testing.T)) {
t.Helper()
// The signal package will start a goroutine the first time "signal.Notify"
// is called. Do so outside the function under test so the signal goroutine
// will not be shown as "leaking".
listenSignalOnce.Do(func() {
ch := make(chan os.Signal, 1)
signal.Notify(ch, os.Interrupt)
go func() {
for {
<-ch
}
}()
})
profile := pprof.Lookup("goroutine")
// Give time for things to settle before capturing the number of
// go routines
time.Sleep(500 * time.Millisecond)
before := profile.Count()
t.Run("leakcheck", f)
var after int
// Give time for things to settle before capturing the number of
// go routines
timeout := time.Now().Add(time.Second)
for time.Now().Before(timeout) {
after = profile.Count()
if after == before {
break
}
}
if after != before {
profile.WriteTo(os.Stderr, 2) // nolint
t.Fatalf("Number of Go routines has changed from %d to %d", before, after)
}
}