nextcloud-spreed-signaling/testutils_test.go

88 lines
2.2 KiB
Go
Raw Permalink Normal View History

2021-04-29 14:34:35 +02:00
/**
* 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 (
"bytes"
"io"
2021-04-29 14:34:35 +02:00
"os"
"os/signal"
2021-04-29 14:34:35 +02:00
"runtime/pprof"
"sync"
2021-04-29 14:34:35 +02:00
"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")
2021-04-29 14:34:35 +02:00
// Give time for things to settle before capturing the number of
// go routines
time.Sleep(500 * time.Millisecond)
before := profile.Count()
var prev bytes.Buffer
dumpGoroutines("Before:", &prev)
2021-04-29 14:34:35 +02:00
t.Run("leakcheck", f)
2021-04-29 14:34:35 +02:00
var after int
2021-04-29 14:34:35 +02:00
// 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 {
2021-04-29 14:34:35 +02:00
break
}
}
if after != before {
io.Copy(os.Stderr, &prev) // nolint
dumpGoroutines("After:", os.Stderr)
t.Fatalf("Number of Go routines has changed from %d to %d", before, after)
2021-04-29 14:34:35 +02:00
}
}
func dumpGoroutines(prefix string, w io.Writer) {
if prefix != "" {
io.WriteString(w, prefix+"\n") // nolint
}
profile := pprof.Lookup("goroutine")
profile.WriteTo(w, 2) // nolint
}