Merge branch 'sh-fix-test-stack-dumping-flakiness' into 'main'

Fix TestStackDumping test freezing

See merge request https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/5210

Merged-by: Stan Hu <[email protected]>
Approved-by: Axel von Bertoldi <[email protected]>

Author: stanhu

log/configuration.go

@@ -138,7 +138,7 @@ func (l *Config) enableGoroutinesDump() {
 
 	l.goroutinesDumpStopCh = make(chan bool)
 
-	watchForGoroutinesDump(l.logger, l.goroutinesDumpStopCh)
+	watchForGoroutinesDump(l.logger, l.goroutinesDumpStopCh, false)
 }
 
 func (l *Config) disableGoroutinesDump() {

log/dump_unix.go

@@ -11,7 +11,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-func watchForGoroutinesDump(logger *logrus.Logger, stopCh chan bool) (chan bool, chan bool) {
+func watchForGoroutinesDump(logger *logrus.Logger, stopCh chan bool, blocking bool) (chan bool, chan bool) {
 	dumpedCh := make(chan bool)
 	finishedCh := make(chan bool)
 
@@ -27,7 +27,7 @@ func watchForGoroutinesDump(logger *logrus.Logger, stopCh chan bool) (chan bool,
 				len := runtime.Stack(buf, true)
 				logger.Printf("=== received SIGUSR1 ===\n*** goroutine dump...\n%s\n*** end\n", buf[0:len])
 
-				nonBlockingSend(dumpedCh, true)
+				signalChannel(dumpedCh, true, blocking)
 			case <-stopCh:
 				close(finishedCh)
 				return
@@ -38,6 +38,14 @@ func watchForGoroutinesDump(logger *logrus.Logger, stopCh chan bool) (chan bool,
 	return dumpedCh, finishedCh
 }
 
+func signalChannel(ch chan bool, value bool, blocking bool) {
+	if blocking {
+		ch <- value
+	} else {
+		nonBlockingSend(ch, value)
+	}
+}
+
 func nonBlockingSend(ch chan bool, value bool) {
 	select {
 	case ch <- value:

log/dump_unix_test.go

@@ -19,7 +19,7 @@ func TestStackDumping(t *testing.T) {
 
 	stopCh := make(chan bool)
 
-	dumpedCh, finishedCh := watchForGoroutinesDump(logger, stopCh)
+	dumpedCh, finishedCh := watchForGoroutinesDump(logger, stopCh, true)
 	require.NotNil(t, dumpedCh)
 	require.NotNil(t, finishedCh)
 

log/dump_windows.go

@@ -4,6 +4,6 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-func watchForGoroutinesDump(logger *logrus.Logger, stopCh chan bool) (chan bool, chan bool) {
+func watchForGoroutinesDump(logger *logrus.Logger, stopCh chan bool, blocking bool) (chan bool, chan bool) {
 	return nil, nil
 }