Skip to content

Commit 0b5f0e0

Browse files
mmorel-35simar7
andauthored
fix: enable contextcheck and usetesting linters (#2562)
* fix: enable contextcheck and usetesting linters Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com> * fix unused-parameter issue Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com> --------- Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com> Co-authored-by: simar7 <1254783+simar7@users.noreply.github.com>
1 parent 4f36b3a commit 0b5f0e0

File tree

24 files changed

+181
-173
lines changed

24 files changed

+181
-173
lines changed

.golangci.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ linters:
55
default: none
66
enable:
77
- bodyclose
8+
- contextcheck
89
- depguard
910
- errorlint
1011
- goconst
@@ -16,11 +17,13 @@ linters:
1617
- ineffassign
1718
- misspell
1819
- perfsprint
20+
- revive
1921
- staticcheck
2022
- testifylint
2123
- unconvert
2224
- unused
2325
- usestdlibvars
26+
- usetesting
2427
settings:
2528
depguard:
2629
rules:
@@ -95,6 +98,16 @@ linters:
9598
errorf: true
9699
sprintf1: false
97100
strconcat: false
101+
revive:
102+
# https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md
103+
rules:
104+
- name: context-as-argument
105+
arguments:
106+
- allow-types-before: "*testing.T"
107+
- name: context-keys-type
108+
- name: unused-parameter
109+
arguments:
110+
- allow-regex: "^_"
98111
staticcheck:
99112
checks:
100113
- all

pkg/compliance/io.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ type cm struct {
3232

3333
// GenerateComplianceReport generate and public compliance report by spec
3434
func (w *cm) GenerateComplianceReport(ctx context.Context, spec v1alpha1.ReportSpec) error {
35-
trivyResults, err := misconfigReportToTrivyResults(w.client, ctx)
35+
trivyResults, err := misconfigReportToTrivyResults(ctx, w.client)
3636
if err != nil {
3737
return err
3838
}
@@ -95,7 +95,7 @@ func (w *cm) buildComplianceReport(spec v1alpha1.ReportSpec, complianceResults [
9595
}
9696

9797
// MisconfigReportToTrivyResults convert misconfig and infra assessment report Data to trivy results
98-
func misconfigReportToTrivyResults(cli client.Client, ctx context.Context) ([]ttypes.Results, error) {
98+
func misconfigReportToTrivyResults(ctx context.Context, cli client.Client) ([]ttypes.Results, error) {
9999
resultsArray := make([]ttypes.Results, 0)
100100
// collect configaudit report data
101101
caObjList := &v1alpha1.ConfigAuditReportList{}

pkg/compliance/io_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,9 +264,9 @@ func TestGenerateComplianceReport(t *testing.T) {
264264
WithStatusSubresource(tt.clusterComplianceReport).
265265
Build()
266266
mgr := NewMgr(c)
267-
err := mgr.GenerateComplianceReport(context.Background(), tt.clusterComplianceReport.Spec)
267+
err := mgr.GenerateComplianceReport(t.Context(), tt.clusterComplianceReport.Spec)
268268
require.NoError(t, err)
269-
ccr, err := getReport(context.Background(), c)
269+
ccr, err := getReport(t.Context(), c)
270270
require.NoError(t, err)
271271
if tt.reportType == "summary" {
272272
assert.True(t, reflect.DeepEqual(ccr.Status.SummaryReport, tt.wantStatus.SummaryReport))

pkg/configauditreport/io_test.go

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package configauditreport_test
22

33
import (
4-
"context"
54
"testing"
65

76
"github.com/stretchr/testify/assert"
@@ -26,7 +25,7 @@ func TestReadWriter(t *testing.T) {
2625
testClient := fake.NewClientBuilder().WithScheme(kubernetesScheme).Build()
2726
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
2827
readWriter := configauditreport.NewReadWriter(&resolver)
29-
err := readWriter.WriteReport(context.TODO(), v1alpha1.ConfigAuditReport{
28+
err := readWriter.WriteReport(t.Context(), v1alpha1.ConfigAuditReport{
3029
TypeMeta: metav1.TypeMeta{
3130
Kind: "ConfigAuditReport",
3231
APIVersion: "aquasecurity.github.io/v1alpha1",
@@ -50,7 +49,7 @@ func TestReadWriter(t *testing.T) {
5049
require.NoError(t, err)
5150

5251
var found v1alpha1.ConfigAuditReport
53-
err = testClient.Get(context.TODO(), types.NamespacedName{Namespace: "qa", Name: "deployment-app"}, &found)
52+
err = testClient.Get(t.Context(), types.NamespacedName{Namespace: "qa", Name: "deployment-app"}, &found)
5453
require.NoError(t, err)
5554

5655
assert.Equal(t, v1alpha1.ConfigAuditReport{
@@ -103,7 +102,7 @@ func TestReadWriter(t *testing.T) {
103102
}).Build()
104103
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
105104
readWriter := configauditreport.NewReadWriter(&resolver)
106-
err := readWriter.WriteReport(context.TODO(), v1alpha1.ConfigAuditReport{
105+
err := readWriter.WriteReport(t.Context(), v1alpha1.ConfigAuditReport{
107106
TypeMeta: metav1.TypeMeta{
108107
Kind: "ConfigAuditReport",
109108
APIVersion: "aquasecurity.github.io/v1alpha1",
@@ -128,7 +127,7 @@ func TestReadWriter(t *testing.T) {
128127
require.NoError(t, err)
129128

130129
var found v1alpha1.ConfigAuditReport
131-
err = testClient.Get(context.TODO(), types.NamespacedName{Namespace: "qa", Name: "deployment-app"}, &found)
130+
err = testClient.Get(t.Context(), types.NamespacedName{Namespace: "qa", Name: "deployment-app"}, &found)
132131
require.NoError(t, err)
133132

134133
assert.Equal(t, v1alpha1.ConfigAuditReport{
@@ -184,7 +183,7 @@ func TestReadWriter(t *testing.T) {
184183
}).Build()
185184
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
186185
readWriter := configauditreport.NewReadWriter(&resolver)
187-
found, err := readWriter.FindReportByOwner(context.TODO(), kube.ObjectRef{
186+
found, err := readWriter.FindReportByOwner(t.Context(), kube.ObjectRef{
188187
Kind: kube.KindDeployment,
189188
Name: "my-deploy",
190189
Namespace: "my-namespace",
@@ -240,7 +239,7 @@ func TestReadWriter(t *testing.T) {
240239
}).Build()
241240
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
242241
readWriter := configauditreport.NewReadWriter(&resolver)
243-
found, err := readWriter.FindReportByOwner(context.TODO(), kube.ObjectRef{
242+
found, err := readWriter.FindReportByOwner(t.Context(), kube.ObjectRef{
244243
Kind: kube.KindRole,
245244
Name: "system:controller:token-cleaner",
246245
Namespace: "kube-system",
@@ -268,7 +267,7 @@ func TestReadWriter(t *testing.T) {
268267
testClient := fake.NewClientBuilder().WithScheme(kubernetesScheme).Build()
269268
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
270269
readWriter := configauditreport.NewReadWriter(&resolver)
271-
err := readWriter.WriteClusterReport(context.TODO(), v1alpha1.ClusterConfigAuditReport{
270+
err := readWriter.WriteClusterReport(t.Context(), v1alpha1.ClusterConfigAuditReport{
272271
TypeMeta: metav1.TypeMeta{
273272
Kind: "ClusterConfigAuditReport",
274273
APIVersion: "aquasecurity.github.io/v1alpha1",
@@ -290,7 +289,7 @@ func TestReadWriter(t *testing.T) {
290289
require.NoError(t, err)
291290

292291
var found v1alpha1.ClusterConfigAuditReport
293-
err = testClient.Get(context.TODO(), types.NamespacedName{Name: "clusterrole-admin"}, &found)
292+
err = testClient.Get(t.Context(), types.NamespacedName{Name: "clusterrole-admin"}, &found)
294293
require.NoError(t, err)
295294

296295
assert.Equal(t, v1alpha1.ClusterConfigAuditReport{
@@ -342,7 +341,7 @@ func TestReadWriter(t *testing.T) {
342341
Build()
343342
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
344343
readWriter := configauditreport.NewReadWriter(&resolver)
345-
err := readWriter.WriteClusterReport(context.TODO(), v1alpha1.ClusterConfigAuditReport{
344+
err := readWriter.WriteClusterReport(t.Context(), v1alpha1.ClusterConfigAuditReport{
346345
TypeMeta: metav1.TypeMeta{
347346
Kind: "ClusterConfigAuditReport",
348347
APIVersion: "aquasecurity.github.io/v1alpha1",
@@ -365,7 +364,7 @@ func TestReadWriter(t *testing.T) {
365364
require.NoError(t, err)
366365

367366
var found v1alpha1.ClusterConfigAuditReport
368-
err = testClient.Get(context.TODO(), types.NamespacedName{Name: "clusterrole-admin"}, &found)
367+
err = testClient.Get(t.Context(), types.NamespacedName{Name: "clusterrole-admin"}, &found)
369368
require.NoError(t, err)
370369

371370
assert.Equal(t, v1alpha1.ClusterConfigAuditReport{
@@ -422,7 +421,7 @@ func TestReadWriter(t *testing.T) {
422421
Build()
423422
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
424423
readWriter := configauditreport.NewReadWriter(&resolver)
425-
found, err := readWriter.FindClusterReportByOwner(context.TODO(), kube.ObjectRef{
424+
found, err := readWriter.FindClusterReportByOwner(t.Context(), kube.ObjectRef{
426425
Kind: "ClusterRole",
427426
Name: "editor",
428427
})

pkg/exposedsecretreport/io_test.go

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package exposedsecretreport_test
22

33
import (
4-
"context"
54
"testing"
65

76
"github.com/stretchr/testify/assert"
@@ -24,7 +23,7 @@ func TestNewReadWriter(t *testing.T) {
2423
testClient := fake.NewClientBuilder().WithScheme(kubernetesScheme).Build()
2524
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
2625
readWriter := exposedsecretreport.NewReadWriter(&resolver)
27-
err := readWriter.Write(context.TODO(), []v1alpha1.ExposedSecretReport{
26+
err := readWriter.Write(t.Context(), []v1alpha1.ExposedSecretReport{
2827
{
2928
ObjectMeta: metav1.ObjectMeta{
3029
Name: "deployment-app1-container1",
@@ -54,7 +53,7 @@ func TestNewReadWriter(t *testing.T) {
5453
})
5554
require.NoError(t, err)
5655
var list v1alpha1.ExposedSecretReportList
57-
err = testClient.List(context.TODO(), &list)
56+
err = testClient.List(t.Context(), &list)
5857
require.NoError(t, err)
5958
reports := make(map[string]v1alpha1.ExposedSecretReport)
6059
for _, item := range list.Items {
@@ -132,7 +131,7 @@ func TestNewReadWriter(t *testing.T) {
132131
}).Build()
133132
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
134133
readWriter := exposedsecretreport.NewReadWriter(&resolver)
135-
err := readWriter.Write(context.TODO(), []v1alpha1.ExposedSecretReport{
134+
err := readWriter.Write(t.Context(), []v1alpha1.ExposedSecretReport{
136135
{
137136
TypeMeta: metav1.TypeMeta{
138137
APIVersion: "aquasecurity.github.io/v1alpha1",
@@ -167,7 +166,7 @@ func TestNewReadWriter(t *testing.T) {
167166
require.NoError(t, err)
168167

169168
var found v1alpha1.ExposedSecretReport
170-
err = testClient.Get(context.TODO(), types.NamespacedName{
169+
err = testClient.Get(t.Context(), types.NamespacedName{
171170
Namespace: "qa",
172171
Name: "deployment-app1-container1",
173172
}, &found)
@@ -191,7 +190,7 @@ func TestNewReadWriter(t *testing.T) {
191190
},
192191
}, found)
193192

194-
err = testClient.Get(context.TODO(), types.NamespacedName{
193+
err = testClient.Get(t.Context(), types.NamespacedName{
195194
Namespace: "qa",
196195
Name: "deployment-app1-container2",
197196
}, &found)
@@ -256,7 +255,7 @@ func TestNewReadWriter(t *testing.T) {
256255
}).Build()
257256
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
258257
readWriter := exposedsecretreport.NewReadWriter(&resolver)
259-
list, err := readWriter.FindByOwner(context.TODO(), kube.ObjectRef{
258+
list, err := readWriter.FindByOwner(t.Context(), kube.ObjectRef{
260259
Kind: kube.KindDeployment,
261260
Name: "my-deploy",
262261
Namespace: "my-namespace",

pkg/infraassessment/io_test.go

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package infraassessment_test
22

33
import (
4-
"context"
54
"testing"
65

76
"github.com/stretchr/testify/assert"
@@ -24,7 +23,7 @@ func TestReadWriter(t *testing.T) {
2423
testClient := fake.NewClientBuilder().WithScheme(kubernetesScheme).Build()
2524
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
2625
readWriter := infraassessment.NewReadWriter(&resolver)
27-
err := readWriter.WriteReport(context.TODO(), v1alpha1.InfraAssessmentReport{
26+
err := readWriter.WriteReport(t.Context(), v1alpha1.InfraAssessmentReport{
2827
TypeMeta: metav1.TypeMeta{
2928
Kind: "InfraAssessmentReport",
3029
APIVersion: "aquasecurity.github.io/v1alpha1",
@@ -48,7 +47,7 @@ func TestReadWriter(t *testing.T) {
4847
require.NoError(t, err)
4948

5049
var found v1alpha1.InfraAssessmentReport
51-
err = testClient.Get(context.TODO(), types.NamespacedName{Namespace: "qa", Name: "role-app"}, &found)
50+
err = testClient.Get(t.Context(), types.NamespacedName{Namespace: "qa", Name: "role-app"}, &found)
5251
require.NoError(t, err)
5352

5453
assert.Equal(t, v1alpha1.InfraAssessmentReport{
@@ -101,7 +100,7 @@ func TestReadWriter(t *testing.T) {
101100
}).Build()
102101
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
103102
readWriter := infraassessment.NewReadWriter(&resolver)
104-
err := readWriter.WriteReport(context.TODO(), v1alpha1.InfraAssessmentReport{
103+
err := readWriter.WriteReport(t.Context(), v1alpha1.InfraAssessmentReport{
105104
TypeMeta: metav1.TypeMeta{
106105
Kind: "InfraAssessmentReport",
107106
APIVersion: "aquasecurity.github.io/v1alpha1",
@@ -126,7 +125,7 @@ func TestReadWriter(t *testing.T) {
126125
require.NoError(t, err)
127126

128127
var found v1alpha1.InfraAssessmentReport
129-
err = testClient.Get(context.TODO(), types.NamespacedName{Namespace: "qa", Name: "role-app"}, &found)
128+
err = testClient.Get(t.Context(), types.NamespacedName{Namespace: "qa", Name: "role-app"}, &found)
130129
require.NoError(t, err)
131130

132131
assert.Equal(t, v1alpha1.InfraAssessmentReport{
@@ -182,7 +181,7 @@ func TestReadWriter(t *testing.T) {
182181
}).Build()
183182
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
184183
readWriter := infraassessment.NewReadWriter(&resolver)
185-
found, err := readWriter.FindReportByOwner(context.TODO(), kube.ObjectRef{
184+
found, err := readWriter.FindReportByOwner(t.Context(), kube.ObjectRef{
186185
Kind: kube.KindDeployment,
187186
Name: "role-my-deploy",
188187
Namespace: "my-namespace",
@@ -238,7 +237,7 @@ func TestReadWriter(t *testing.T) {
238237
}).Build()
239238
resolver := kube.NewObjectResolver(testClient, &kube.CompatibleObjectMapper{})
240239
readWriter := infraassessment.NewReadWriter(&resolver)
241-
found, err := readWriter.FindReportByOwner(context.TODO(), kube.ObjectRef{
240+
found, err := readWriter.FindReportByOwner(t.Context(), kube.ObjectRef{
242241
Kind: kube.KindRole,
243242
Name: "system:controller:token-cleaner",
244243
Namespace: "kube-system",

0 commit comments

Comments
 (0)