Skip to content

Commit 9e634e6

Browse files
erusso7erusso7
authored
Use Background context instead of TODO (kubernetes-sigs#92)
Use Background context instead of TODO Following the good practices of Golang, we should use context.Background() function in test files instead of context.TODO()
1 parent e3812c3 commit 9e634e6

File tree

6 files changed

+54
-55
lines changed

6 files changed

+54
-55
lines changed

‎controllers/module_reconciler_test.go

+10-10
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ var _ = Describe("ModuleReconciler", func() {
6666
},
6767
}
6868

69-
ctx := context.TODO()
69+
ctx := context.Background()
7070

7171
gomock.InOrder(
7272
clnt.EXPECT().Get(ctx, req.NamespacedName, gomock.Any()).DoAndReturn(
@@ -95,7 +95,7 @@ var _ = Describe("ModuleReconciler", func() {
9595
mockDC.EXPECT().GarbageCollect(ctx, dsByKernelVersion, sets.NewString()),
9696
)
9797

98-
res, err := mr.Reconcile(context.TODO(), req)
98+
res, err := mr.Reconcile(context.Background(), req)
9999
Expect(err).NotTo(HaveOccurred())
100100
Expect(res).To(Equal(reconcile.Result{}))
101101
})
@@ -120,7 +120,7 @@ var _ = Describe("ModuleReconciler", func() {
120120
},
121121
}
122122

123-
ctx := context.TODO()
123+
ctx := context.Background()
124124
gomock.InOrder(
125125
clnt.EXPECT().Get(ctx, req.NamespacedName, gomock.Any()).DoAndReturn(
126126
func(_ interface{}, _ interface{}, m *ootov1alpha1.Module) error {
@@ -148,7 +148,7 @@ var _ = Describe("ModuleReconciler", func() {
148148
mockDC.EXPECT().GarbageCollect(ctx, dsByKernelVersion, sets.NewString()),
149149
)
150150

151-
res, err := mr.Reconcile(context.TODO(), req)
151+
res, err := mr.Reconcile(context.Background(), req)
152152
Expect(err).NotTo(HaveOccurred())
153153
Expect(res).To(Equal(reconcile.Result{}))
154154
})
@@ -193,7 +193,7 @@ var _ = Describe("ModuleReconciler", func() {
193193
},
194194
}
195195

196-
ctx := context.TODO()
196+
ctx := context.Background()
197197

198198
gomock.InOrder(
199199
clnt.EXPECT().Get(ctx, req.NamespacedName, gomock.Any()).DoAndReturn(
@@ -232,11 +232,11 @@ var _ = Describe("ModuleReconciler", func() {
232232
mockKM.EXPECT().FindMappingForKernel(mappings, kernelVersion).Return(&mappings[0], nil),
233233
mockKM.EXPECT().PrepareKernelMapping(&mappings[0], &osConfig).Return(&mappings[0], nil),
234234
mockDC.EXPECT().ModuleDaemonSetsByKernelVersion(ctx, moduleName, namespace),
235-
mockDC.EXPECT().SetDriverContainerAsDesired(context.TODO(), &ds, imageName, gomock.AssignableToTypeOf(mod), kernelVersion),
235+
mockDC.EXPECT().SetDriverContainerAsDesired(context.Background(), &ds, imageName, gomock.AssignableToTypeOf(mod), kernelVersion),
236236
mockDC.EXPECT().GarbageCollect(ctx, nil, sets.NewString(kernelVersion)),
237237
)
238238

239-
res, err := mr.Reconcile(context.TODO(), req)
239+
res, err := mr.Reconcile(context.Background(), req)
240240
Expect(err).NotTo(HaveOccurred())
241241
Expect(res).To(Equal(reconcile.Result{}))
242242
})
@@ -295,7 +295,7 @@ var _ = Describe("ModuleReconciler", func() {
295295
},
296296
}
297297

298-
ctx := context.TODO()
298+
ctx := context.Background()
299299

300300
gomock.InOrder(
301301
clnt.EXPECT().Get(ctx, req.NamespacedName, gomock.Any()).DoAndReturn(
@@ -331,14 +331,14 @@ var _ = Describe("ModuleReconciler", func() {
331331
mockKM.EXPECT().FindMappingForKernel(mappings, kernelVersion).Return(&mappings[0], nil),
332332
mockKM.EXPECT().PrepareKernelMapping(&mappings[0], &osConfig).Return(&mappings[0], nil),
333333
mockDC.EXPECT().ModuleDaemonSetsByKernelVersion(ctx, moduleName, namespace).Return(dsByKernelVersion, nil),
334-
mockDC.EXPECT().SetDriverContainerAsDesired(context.TODO(), &ds, imageName, gomock.AssignableToTypeOf(mod), kernelVersion).Do(
334+
mockDC.EXPECT().SetDriverContainerAsDesired(context.Background(), &ds, imageName, gomock.AssignableToTypeOf(mod), kernelVersion).Do(
335335
func(ctx context.Context, d *appsv1.DaemonSet, _ string, _ ootov1alpha1.Module, _ string) {
336336
d.SetLabels(map[string]string{"test": "test"})
337337
}),
338338
mockDC.EXPECT().GarbageCollect(ctx, dsByKernelVersion, sets.NewString(kernelVersion)),
339339
)
340340

341-
res, err := mr.Reconcile(context.TODO(), req)
341+
res, err := mr.Reconcile(context.Background(), req)
342342
Expect(err).NotTo(HaveOccurred())
343343
Expect(res).To(Equal(reconcile.Result{}))
344344
})

‎controllers/node_kernel_reconciler_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var _ = Describe("NodeKernelReconciler", func() {
3131
)
3232

3333
It("should return an error if the node cannot be found anymore", func() {
34-
ctx := context.TODO()
34+
ctx := context.Background()
3535
clnt.EXPECT().Get(ctx, gomock.Any(), gomock.Any()).Return(errors.New("some error"))
3636

3737
nkr := NewNodeKernelReconciler(clnt, labelName, nil)
@@ -51,7 +51,7 @@ var _ = Describe("NodeKernelReconciler", func() {
5151
},
5252
}
5353

54-
ctx := context.TODO()
54+
ctx := context.Background()
5555
gomock.InOrder(
5656
clnt.EXPECT().Get(ctx, gomock.Any(), gomock.Any()).DoAndReturn(
5757
func(_ interface{}, _ interface{}, n *v1.Node) error {
@@ -84,7 +84,7 @@ var _ = Describe("NodeKernelReconciler", func() {
8484
},
8585
}
8686

87-
ctx := context.TODO()
87+
ctx := context.Background()
8888
gomock.InOrder(
8989
clnt.EXPECT().Get(ctx, gomock.Any(), gomock.Any()).DoAndReturn(
9090
func(_ interface{}, _ interface{}, n *v1.Node) error {

‎internal/build/job/manager_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ var _ = Describe("JobManager", func() {
6565
}
6666

6767
It("should return an error if there was an error getting the image", func() {
68-
ctx := context.TODO()
68+
ctx := context.Background()
6969
gomock.InOrder(
7070
helper.EXPECT().GetRelevantBuild(gomock.Any(), km).Return(km.Build),
7171
getter.EXPECT().ImageExists(ctx, imageName, po).Return(false, errors.New("random error")),
@@ -77,7 +77,7 @@ var _ = Describe("JobManager", func() {
7777
})
7878

7979
It("should return StatusCompleted if the image already exists", func() {
80-
ctx := context.TODO()
80+
ctx := context.Background()
8181

8282
gomock.InOrder(
8383
helper.EXPECT().GetRelevantBuild(gomock.Any(), km).Return(km.Build),
@@ -111,7 +111,7 @@ var _ = Describe("JobManager", func() {
111111
},
112112
Status: s,
113113
}
114-
ctx := context.TODO()
114+
ctx := context.Background()
115115
clnt.EXPECT().List(ctx, gomock.Any(), gomock.Any()).DoAndReturn(
116116
func(_ interface{}, list *batchv1.JobList, _ ...interface{}) error {
117117
list.Items = []batchv1.Job{j}
@@ -141,7 +141,7 @@ var _ = Describe("JobManager", func() {
141141
)
142142

143143
It("should return an error if there was an error creating the job", func() {
144-
ctx := context.TODO()
144+
ctx := context.Background()
145145

146146
gomock.InOrder(
147147
helper.EXPECT().GetRelevantBuild(mod, km).Return(km.Build),
@@ -160,7 +160,7 @@ var _ = Describe("JobManager", func() {
160160
})
161161

162162
It("should create the job if there was no error making it", func() {
163-
ctx := context.TODO()
163+
ctx := context.Background()
164164

165165
const jobName = "some-job"
166166

0 commit comments

Comments
 (0)