Skip to content

Commit ddef2b5

Browse files
authored
Use testhelper.NewLogger for tests (#3520)
### Summary of your changes Simplifies test files by removing direct invocations of the clog package. Benefits: 1. Centralized invocation 2. No manual naming needed 3. Test-related logging configuration can be changed at once across all tests Making a separate PR to help with #3514
1 parent c264549 commit ddef2b5

25 files changed

Lines changed: 85 additions & 88 deletions

internal/flavors/assetinventory/strategy_test.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ import (
2727
"github.com/stretchr/testify/require"
2828

2929
"github.com/elastic/cloudbeat/internal/config"
30-
"github.com/elastic/cloudbeat/internal/infra/clog"
3130
"github.com/elastic/cloudbeat/internal/inventory"
3231
"github.com/elastic/cloudbeat/internal/resources/utils/testhelper"
3332
)
@@ -138,7 +137,7 @@ func TestStrategyPicks(t *testing.T) {
138137
for _, tc := range testCases {
139138
t.Run(tc.name, func(t *testing.T) {
140139
s := strategy{
141-
logger: clog.NewLogger("strategy_test"),
140+
logger: testhelper.NewLogger(t),
142141
cfg: tc.cfg,
143142
}
144143
ctx, cancel := context.WithTimeout(t.Context(), 50*time.Millisecond)

internal/flavors/benchmark/aws_org_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ func Test_getAwsAccounts(t *testing.T) {
173173
IdentityProvider: nil,
174174
AccountProvider: tt.accountProvider,
175175
}
176-
log := clog.NewLogger("test")
176+
log := testhelper.NewLogger(t)
177177
got, err := a.getAwsAccounts(t.Context(), log, aws.Config{}, &tt.rootIdentity)
178178
if tt.wantErr != "" {
179179
require.ErrorContains(t, err, tt.wantErr)
@@ -262,7 +262,7 @@ func Test_pickManagementAccountRole(t *testing.T) {
262262
zapcore.DebugLevel,
263263
)
264264
})
265-
log = clog.NewLogger("test").WithOptions(replacement)
265+
log = testhelper.NewLogger(t).WithOptions(replacement)
266266
}
267267

268268
stsClient := &mockStsClient{}

internal/inventory/awsfetcher/fetcher_ec2_instance_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ import (
2424
"github.com/stretchr/testify/mock"
2525

2626
"github.com/elastic/cloudbeat/internal/dataprovider/providers/cloud"
27-
"github.com/elastic/cloudbeat/internal/infra/clog"
2827
"github.com/elastic/cloudbeat/internal/inventory"
2928
"github.com/elastic/cloudbeat/internal/inventory/testutil"
3029
ec2beat "github.com/elastic/cloudbeat/internal/resources/providers/awslib/ec2"
3130
"github.com/elastic/cloudbeat/internal/resources/utils/pointers"
31+
"github.com/elastic/cloudbeat/internal/resources/utils/testhelper"
3232
)
3333

3434
func TestEC2InstanceFetcher_Fetch(t *testing.T) {
@@ -138,7 +138,7 @@ func TestEC2InstanceFetcher_Fetch(t *testing.T) {
138138
),
139139
}
140140

141-
logger := clog.NewLogger("test_fetcher_ec2")
141+
logger := testhelper.NewLogger(t)
142142
provider := newMockEc2InstancesProvider(t)
143143
provider.EXPECT().DescribeInstances(mock.Anything).Return(in, nil)
144144

internal/inventory/awsfetcher/fetcher_elb_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ import (
2626
"github.com/stretchr/testify/mock"
2727

2828
"github.com/elastic/cloudbeat/internal/dataprovider/providers/cloud"
29-
"github.com/elastic/cloudbeat/internal/infra/clog"
3029
"github.com/elastic/cloudbeat/internal/inventory"
3130
"github.com/elastic/cloudbeat/internal/inventory/testutil"
3231
"github.com/elastic/cloudbeat/internal/resources/providers/awslib"
3332
"github.com/elastic/cloudbeat/internal/resources/providers/awslib/elb"
3433
elbv2 "github.com/elastic/cloudbeat/internal/resources/providers/awslib/elb_v2"
3534
"github.com/elastic/cloudbeat/internal/resources/utils/pointers"
35+
"github.com/elastic/cloudbeat/internal/resources/utils/testhelper"
3636
)
3737

3838
func TestELBv1Fetcher_Fetch(t *testing.T) {
@@ -81,7 +81,7 @@ func TestELBv1Fetcher_Fetch(t *testing.T) {
8181
),
8282
}
8383

84-
logger := clog.NewLogger("test_fetcher_elb_v1")
84+
logger := testhelper.NewLogger(t)
8585
providerv1 := newMockV1Provider(t)
8686
providerv1.EXPECT().DescribeAllLoadBalancers(mock.Anything).Return(in, nil)
8787
providerv2 := newMockV2Provider(t)
@@ -127,7 +127,7 @@ func TestELBv2Fetcher_Fetch(t *testing.T) {
127127
),
128128
}
129129

130-
logger := clog.NewLogger("test_fetcher_elb_v2")
130+
logger := testhelper.NewLogger(t)
131131
providerv1 := newMockV1Provider(t)
132132
providerv1.EXPECT().DescribeAllLoadBalancers(mock.Anything).Return(nil, nil)
133133
providerv2 := newMockV2Provider(t)

internal/inventory/awsfetcher/fetcher_iam_policy_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ import (
2525
"github.com/stretchr/testify/mock"
2626

2727
"github.com/elastic/cloudbeat/internal/dataprovider/providers/cloud"
28-
"github.com/elastic/cloudbeat/internal/infra/clog"
2928
"github.com/elastic/cloudbeat/internal/inventory"
3029
"github.com/elastic/cloudbeat/internal/inventory/testutil"
3130
"github.com/elastic/cloudbeat/internal/resources/providers/awslib"
3231
"github.com/elastic/cloudbeat/internal/resources/providers/awslib/iam"
3332
"github.com/elastic/cloudbeat/internal/resources/utils/pointers"
33+
"github.com/elastic/cloudbeat/internal/resources/utils/testhelper"
3434
)
3535

3636
func TestIAMPolicyFetcher_Fetch(t *testing.T) {
@@ -144,7 +144,7 @@ func TestIAMPolicyFetcher_Fetch(t *testing.T) {
144144
),
145145
}
146146

147-
logger := clog.NewLogger("test_fetcher_iam_role")
147+
logger := testhelper.NewLogger(t)
148148
provider := newMockIamPolicyProvider(t)
149149
provider.EXPECT().GetPolicies(mock.Anything).Return(in, nil)
150150

internal/inventory/awsfetcher/fetcher_iam_role_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ import (
2525
"github.com/stretchr/testify/mock"
2626

2727
"github.com/elastic/cloudbeat/internal/dataprovider/providers/cloud"
28-
"github.com/elastic/cloudbeat/internal/infra/clog"
2928
"github.com/elastic/cloudbeat/internal/inventory"
3029
"github.com/elastic/cloudbeat/internal/inventory/testutil"
3130
"github.com/elastic/cloudbeat/internal/resources/providers/awslib/iam"
3231
"github.com/elastic/cloudbeat/internal/resources/utils/pointers"
32+
"github.com/elastic/cloudbeat/internal/resources/utils/testhelper"
3333
)
3434

3535
func TestIAMRoleFetcher_Fetch(t *testing.T) {
@@ -109,7 +109,7 @@ func TestIAMRoleFetcher_Fetch(t *testing.T) {
109109
),
110110
}
111111

112-
logger := clog.NewLogger("test_fetcher_iam_role")
112+
logger := testhelper.NewLogger(t)
113113
provider := newMockIamRoleProvider(t)
114114
provider.EXPECT().ListRoles(mock.Anything).Return(in, nil)
115115

internal/inventory/awsfetcher/fetcher_iam_user_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ import (
2525
"github.com/stretchr/testify/mock"
2626

2727
"github.com/elastic/cloudbeat/internal/dataprovider/providers/cloud"
28-
"github.com/elastic/cloudbeat/internal/infra/clog"
2928
"github.com/elastic/cloudbeat/internal/inventory"
3029
"github.com/elastic/cloudbeat/internal/inventory/testutil"
3130
"github.com/elastic/cloudbeat/internal/resources/providers/awslib"
3231
"github.com/elastic/cloudbeat/internal/resources/providers/awslib/iam"
3332
"github.com/elastic/cloudbeat/internal/resources/utils/pointers"
33+
"github.com/elastic/cloudbeat/internal/resources/utils/testhelper"
3434
)
3535

3636
func TestIAMUserFetcher_Fetch(t *testing.T) {
@@ -123,7 +123,7 @@ func TestIAMUserFetcher_Fetch(t *testing.T) {
123123
),
124124
}
125125

126-
logger := clog.NewLogger("test_fetcher_iam_user")
126+
logger := testhelper.NewLogger(t)
127127
provider := newMockIamUserProvider(t)
128128
provider.EXPECT().GetUsers(mock.Anything).Return(in, nil)
129129

internal/inventory/awsfetcher/fetcher_lambda_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ import (
2424
"github.com/stretchr/testify/mock"
2525

2626
"github.com/elastic/cloudbeat/internal/dataprovider/providers/cloud"
27-
"github.com/elastic/cloudbeat/internal/infra/clog"
2827
"github.com/elastic/cloudbeat/internal/inventory"
2928
"github.com/elastic/cloudbeat/internal/inventory/testutil"
3029
"github.com/elastic/cloudbeat/internal/resources/providers/awslib"
3130
"github.com/elastic/cloudbeat/internal/resources/providers/awslib/lambda"
3231
"github.com/elastic/cloudbeat/internal/resources/utils/pointers"
32+
"github.com/elastic/cloudbeat/internal/resources/utils/testhelper"
3333
)
3434

3535
func TestLambdaFunction_Fetch(t *testing.T) {
@@ -67,7 +67,7 @@ func TestLambdaFunction_Fetch(t *testing.T) {
6767
),
6868
}
6969

70-
logger := clog.NewLogger("test_fetcher_lambda")
70+
logger := testhelper.NewLogger(t)
7171
provider := newMockLambdaProvider(t)
7272

7373
provider.On("ListEventSourceMappings", mock.Anything, mock.Anything).Return([]awslib.AwsResource{}, nil)

internal/inventory/awsfetcher/fetcher_rds_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ import (
2323
"github.com/stretchr/testify/mock"
2424

2525
"github.com/elastic/cloudbeat/internal/dataprovider/providers/cloud"
26-
"github.com/elastic/cloudbeat/internal/infra/clog"
2726
"github.com/elastic/cloudbeat/internal/inventory"
2827
"github.com/elastic/cloudbeat/internal/inventory/testutil"
2928
"github.com/elastic/cloudbeat/internal/resources/providers/awslib"
3029
"github.com/elastic/cloudbeat/internal/resources/providers/awslib/rds"
3130
"github.com/elastic/cloudbeat/internal/resources/utils/pointers"
31+
"github.com/elastic/cloudbeat/internal/resources/utils/testhelper"
3232
)
3333

3434
func TestRDSInstanceFetcher_Fetch(t *testing.T) {
@@ -110,7 +110,7 @@ func TestRDSInstanceFetcher_Fetch(t *testing.T) {
110110
),
111111
}
112112

113-
logger := clog.NewLogger("test_fetcher_rds_instance")
113+
logger := testhelper.NewLogger(t)
114114
provider := newMockRdsProvider(t)
115115
provider.EXPECT().DescribeDBInstances(mock.Anything).Return(in, nil)
116116

internal/inventory/awsfetcher/fetcher_s3_bucket_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ import (
2525
"github.com/stretchr/testify/mock"
2626

2727
"github.com/elastic/cloudbeat/internal/dataprovider/providers/cloud"
28-
"github.com/elastic/cloudbeat/internal/infra/clog"
2928
"github.com/elastic/cloudbeat/internal/inventory"
3029
"github.com/elastic/cloudbeat/internal/inventory/testutil"
3130
"github.com/elastic/cloudbeat/internal/resources/providers/awslib"
3231
"github.com/elastic/cloudbeat/internal/resources/providers/awslib/s3"
3332
"github.com/elastic/cloudbeat/internal/resources/utils/pointers"
33+
"github.com/elastic/cloudbeat/internal/resources/utils/testhelper"
3434
)
3535

3636
func TestS3BucketFetcher_Fetch(t *testing.T) {
@@ -130,7 +130,7 @@ func TestS3BucketFetcher_Fetch(t *testing.T) {
130130
),
131131
}
132132

133-
logger := clog.NewLogger("test_fetcher_s3_bucket")
133+
logger := testhelper.NewLogger(t)
134134
provider := newMockS3BucketProvider(t)
135135
provider.EXPECT().DescribeBuckets(mock.Anything).Return(in, nil)
136136

0 commit comments

Comments
 (0)