Skip to content

Commit b171664

Browse files
committed
Fix controller-runtime logging setup
The test suite uses the k8s client packages for fetching resources, which use logging utilities from controller-runtime. The suite should setup the logger for the client. To do that we need to include the dependency, and use it appropriately in the tests, otherwise we'll get issues like the following: [controller-runtime] log.SetLogger(...) was never called; logs will not be displayed.
1 parent 332f09e commit b171664

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+11797
-9
lines changed

e2e_test.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ import (
99
"testing"
1010
"time"
1111

12+
ctrlLog "sigs.k8s.io/controller-runtime/pkg/log"
13+
"sigs.k8s.io/controller-runtime/pkg/log/zap"
14+
1215
"github.com/ComplianceAsCode/ocp4e2e/config"
1316
"github.com/ComplianceAsCode/ocp4e2e/helpers"
1417
)
@@ -20,6 +23,11 @@ var (
2023

2124
// TestMain handles the setup and teardown for all tests.
2225
func TestMain(m *testing.M) {
26+
// Setup the controller-runtime logger, which is used in clients across
27+
// various tests. Do this here instead of in each test.
28+
logger := zap.New(zap.UseDevMode(true))
29+
ctrlLog.SetLogger(logger)
30+
2331
// Define flags
2432
config.DefineFlags()
2533

go.mod

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
module github.com/ComplianceAsCode/ocp4e2e
22

3-
go 1.23
3+
go 1.23.0
4+
5+
toolchain go1.23.10
46

57
require (
68
github.com/ComplianceAsCode/compliance-operator v1.7.0
@@ -11,14 +13,15 @@ require (
1113
k8s.io/apiextensions-apiserver v0.32.1
1214
k8s.io/apimachinery v0.32.3
1315
k8s.io/client-go v12.0.0+incompatible
14-
sigs.k8s.io/controller-runtime v0.20.2
16+
sigs.k8s.io/controller-runtime v0.20.4
1517
)
1618

1719
require (
1820
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
1921
github.com/emicklei/go-restful/v3 v3.12.1 // indirect
2022
github.com/evanphx/json-patch/v5 v5.9.11 // indirect
2123
github.com/go-logr/logr v1.4.2 // indirect
24+
github.com/go-logr/zapr v1.3.0 // indirect
2225
github.com/go-openapi/jsonpointer v0.21.0 // indirect
2326
github.com/go-openapi/jsonreference v0.21.0 // indirect
2427
github.com/go-openapi/swag v0.23.0 // indirect
@@ -37,6 +40,8 @@ require (
3740
github.com/onsi/ginkgo/v2 v2.22.1 // indirect
3841
github.com/openshift/api v0.0.0-20250320115527-3aa9dd5b9002 // indirect
3942
github.com/spf13/pflag v1.0.6 // indirect
43+
go.uber.org/multierr v1.11.0 // indirect
44+
go.uber.org/zap v1.27.0 // indirect
4045
golang.org/x/net v0.37.0 // indirect
4146
golang.org/x/oauth2 v0.28.0 // indirect
4247
golang.org/x/sys v0.31.0 // indirect

go.sum

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2708,6 +2708,8 @@ rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
27082708
sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.29.0/go.mod h1:z7+wmGM2dfIiLRfrC6jb5kV2Mq/sK1ZP303cxzkV5Y4=
27092709
sigs.k8s.io/controller-runtime v0.20.2 h1:/439OZVxoEc02psi1h4QO3bHzTgu49bb347Xp4gW1pc=
27102710
sigs.k8s.io/controller-runtime v0.20.2/go.mod h1:xg2XB0K5ShQzAgsoujxuKN4LNXR2LfwwHsPj7Iaw+XY=
2711+
sigs.k8s.io/controller-runtime v0.20.4 h1:X3c+Odnxz+iPTRobG4tp092+CvBU9UK0t/bRf+n0DGU=
2712+
sigs.k8s.io/controller-runtime v0.20.4/go.mod h1:xg2XB0K5ShQzAgsoujxuKN4LNXR2LfwwHsPj7Iaw+XY=
27112713
sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd/go.mod h1:B8JuhiUyNFVKdsE8h686QcCxMaH6HrOAZj4vswFpcB0=
27122714
sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 h1:gBQPwqORJ8d8/YNZWEjoZs7npUVDpVXUUOFfW6CgAqE=
27132715
sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8/go.mod h1:mdzfpAEoE6DHQEN0uh9ZbOCuHbLK5wOm7dK4ctXE9Tg=

vendor/github.com/go-logr/logr/slogr/slogr.go

Lines changed: 61 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vendor/github.com/go-logr/zapr/.gitignore

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vendor/github.com/go-logr/zapr/.golangci.yaml

Lines changed: 20 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vendor/github.com/go-logr/zapr/LICENSE

Lines changed: 201 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)