From b670aefb94a192e61639e8380b16c931eaba76ed Mon Sep 17 00:00:00 2001 From: AhmedGrati Date: Sun, 22 Jan 2023 22:03:52 +0100 Subject: [PATCH 1/2] Feat: Clean inifinite Goroutine Signed-off-by: AhmedGrati --- cmd/formatter/colors.go | 16 ++++++++++++++-- cmd/formatter/formatter_test.go | 6 ++++++ go.mod | 2 ++ go.sum | 2 ++ 4 files changed, 24 insertions(+), 2 deletions(-) diff --git a/cmd/formatter/colors.go b/cmd/formatter/colors.go index 79afb5354d..d7b8513833 100644 --- a/cmd/formatter/colors.go +++ b/cmd/formatter/colors.go @@ -92,6 +92,11 @@ func rainbowColor() colorFunc { } var loop = make(chan colorFunc) +var quitChan = make(chan bool) + +func cleanInfiniteGoroutine() { + quitChan <- true +} func init() { colors := map[string]colorFunc{} @@ -116,8 +121,15 @@ func init() { } for { - loop <- rainbow[i] - i = (i + 1) % len(rainbow) + select { + case <-quitChan: + return + default: + loop <- rainbow[i] + i = (i + 1) % len(rainbow) + } } }() + + defer cleanInfiniteGoroutine() } diff --git a/cmd/formatter/formatter_test.go b/cmd/formatter/formatter_test.go index 052226e656..677a0658f6 100644 --- a/cmd/formatter/formatter_test.go +++ b/cmd/formatter/formatter_test.go @@ -22,6 +22,7 @@ import ( "io" "testing" + "go.uber.org/goleak" "gotest.tools/v3/assert" ) @@ -71,3 +72,8 @@ func TestPrint(t *testing.T) { {"Name":"myName2","Status":"myStatus2"} `) } + +// Test the absence of unexpected goroutines. +func TestColorsGoroutinesLeak(t *testing.T) { + defer goleak.VerifyNone(t) +} diff --git a/go.mod b/go.mod index 47e1a9e0b2..de537124c3 100644 --- a/go.mod +++ b/go.mod @@ -150,6 +150,8 @@ require ( sigs.k8s.io/yaml v1.2.0 // indirect ) +require go.uber.org/goleak v1.1.12 + replace ( // Override for e2e tests github.com/cucumber/godog => github.com/laurazard/godog v0.0.0-20220922095256-4c4b17abdae7 diff --git a/go.sum b/go.sum index da0b87b2eb..b10e133826 100644 --- a/go.sum +++ b/go.sum @@ -770,6 +770,7 @@ golang.org/x/lint v0.0.0-20190909230951-414d861bb4ac/go.mod h1:6SW0HCj/g11FgYtHl golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/lint v0.0.0-20191125180803-fdd1cda4f05f/go.mod h1:5qLYkcX4OjUUV8bRuDixDT3tpyyb+LUpUlRWLxfhWrs= golang.org/x/lint v0.0.0-20200130185559-910be7a94367/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY= +golang.org/x/lint v0.0.0-20200302205851-738671d3881b h1:Wh+f8QHJXR411sJR8/vRBTZ7YapZaRvUcLFFJhusH0k= golang.org/x/lint v0.0.0-20200302205851-738671d3881b/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY= golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE= golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o= @@ -978,6 +979,7 @@ golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4f golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/tools v0.1.12 h1:VveCTK38A2rkS8ZqFY25HIDFscX5X9OoEhJd3quQmXU= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= From 3a21e1e31903304e4d11a717028bec21ba346a41 Mon Sep 17 00:00:00 2001 From: AhmedGrati Date: Mon, 23 Jan 2023 10:50:56 +0100 Subject: [PATCH 2/2] Fix Linting Issues Signed-off-by: AhmedGrati --- cmd/formatter/colors.go | 2 +- cmd/formatter/formatter_test.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/formatter/colors.go b/cmd/formatter/colors.go index d7b8513833..5dc336148c 100644 --- a/cmd/formatter/colors.go +++ b/cmd/formatter/colors.go @@ -99,6 +99,7 @@ func cleanInfiniteGoroutine() { } func init() { + defer cleanInfiniteGoroutine() colors := map[string]colorFunc{} for i, name := range names { colors[name] = makeColorFunc(strconv.Itoa(30 + i)) @@ -131,5 +132,4 @@ func init() { } }() - defer cleanInfiniteGoroutine() } diff --git a/cmd/formatter/formatter_test.go b/cmd/formatter/formatter_test.go index 677a0658f6..c672ade8ee 100644 --- a/cmd/formatter/formatter_test.go +++ b/cmd/formatter/formatter_test.go @@ -75,5 +75,5 @@ func TestPrint(t *testing.T) { // Test the absence of unexpected goroutines. func TestColorsGoroutinesLeak(t *testing.T) { - defer goleak.VerifyNone(t) + goleak.VerifyNone(t) }