Skip to content

Commit 61411ea

Browse files
committed
[AA][HI] e2e: klog: Warningf -> ErrorS/InfoS
These changes where AI-Assisted (hence the AA tag), then largely amended by a human (hence the HI tag - Human Intervention). prompt used: ``` consider only the file `test/e2e/../XXX.go`. Find the calls to `klog.Warningf` which include a `err` vaule. Change the code to replace `Warningf` to `ErrorS`, reorganize the function parameters to match the `ErrorS` signature. ``` repeated for few files like ``` do the same change in the file test/e2e/../YYY.go ``` Then instructed the AI to replace everything else: ``` so far so good. Now do the same for all the files in the test/e2e tree ``` The AI got it almost right. There are a couple places on which actually a `InfoS` is a better replacement than `ErrorS`. This can be accounted as prompting error, and was fixed manually by a human. Assisted-by: Cursor AI Assisted-by-model: claude-4-sonnet Signed-off-by: Francesco Romani <[email protected]>
1 parent ccf0856 commit 61411ea

File tree

9 files changed

+40
-40
lines changed

9 files changed

+40
-40
lines changed

test/e2e/install/install_test.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ var _ = Describe("[Install] continuousIntegration", Serial, func() {
8787
err := wait.PollUntilContextTimeout(context.Background(), 10*time.Second, 5*time.Minute, immediate, func(ctx context.Context) (bool, error) {
8888
err := e2eclient.Client.Get(ctx, nname, updatedNROObj)
8989
if err != nil {
90-
klog.Warningf("failed to get the NRO resource: %v", err)
90+
klog.ErrorS(err, "failed to get the NRO resource")
9191
return false, err
9292
}
9393

@@ -117,7 +117,7 @@ var _ = Describe("[Install] continuousIntegration", Serial, func() {
117117
Eventually(func() bool {
118118
ds, err := getDaemonSetByOwnerReference(updatedNROObj.UID)
119119
if err != nil {
120-
klog.Warningf("unable to get Daemonset %v", err)
120+
klog.ErrorS(err, "unable to get Daemonset")
121121
return false
122122
}
123123

@@ -176,7 +176,7 @@ var _ = Describe("[Install] durability", Serial, func() {
176176
updatedNROObj := &nropv1.NUMAResourcesOperator{}
177177
err := e2eclient.Client.Get(context.TODO(), client.ObjectKeyFromObject(nroObj), updatedNROObj)
178178
if err != nil {
179-
klog.Warningf("failed to get the NUMAResourcesOperator CR: %v", err)
179+
klog.ErrorS(err, "failed to get the NUMAResourcesOperator CR")
180180
return false
181181
}
182182

@@ -253,7 +253,7 @@ var _ = Describe("[Install] durability", Serial, func() {
253253
updatedDs := &appsv1.DaemonSet{}
254254
err := e2eclient.Client.Get(context.TODO(), dsKey.AsKey(), updatedDs)
255255
if err != nil {
256-
klog.Warningf("failed to get the daemonset %s: %v", dsKey.String(), err)
256+
klog.ErrorS(err, "failed to get the daemonset", "key", dsKey.String())
257257
return false
258258
}
259259

@@ -317,7 +317,7 @@ var _ = Describe("[Install] durability", Serial, func() {
317317
if err == nil {
318318
klog.Warningf("obj %s still exists", key.String())
319319
} else {
320-
klog.Warningf("obj %s return with error: %v", key.String(), err)
320+
klog.ErrorS(err, "obj return with error", "key", key.String())
321321
}
322322
return false
323323
}
@@ -352,8 +352,8 @@ var _ = Describe("[Install] durability", Serial, func() {
352352

353353
ds, err := getDaemonSetByOwnerReference(updatedNroObj.GetUID())
354354
if err != nil {
355-
klog.Warningf("failed to get the RTE DaemonSet: %v", err)
356-
klog.Warningf("NRO:\n%s\n", objects.ToYAML(updatedNroObj))
355+
// TODO: multi-line value in structured log
356+
klog.ErrorS(err, "failed to get the RTE DaemonSet", "nroYAML", objects.ToYAML(updatedNroObj))
357357
return false
358358
}
359359

@@ -392,7 +392,7 @@ var _ = Describe("[Install] durability", Serial, func() {
392392
// the same configuration should apply to all NRT objects
393393
matchingErr := configuration.CheckTopologyManagerConfigMatching(nrt, &cfg)
394394
if matchingErr != "" {
395-
klog.Warningf("NRT %q doesn't match topologyManager configuration: %s", nrt.Name, matchingErr)
395+
klog.InfoS("NRT doesn't match topologyManager configuration", "name", nrt.Name, "problem", matchingErr)
396396
return false
397397
}
398398
}
@@ -462,7 +462,7 @@ func logRTEPodsLogs(cli client.Client, k8sCli *kubernetes.Clientset, ctx context
462462

463463
labSel, err := metav1.LabelSelectorAsSelector(ds.Spec.Selector)
464464
if err != nil {
465-
klog.Warningf("cannot use DaemonSet label selector as selector: %v", err)
465+
klog.ErrorS(err, "cannot use DaemonSet label selector as selector")
466466
continue
467467
}
468468

@@ -472,14 +472,14 @@ func logRTEPodsLogs(cli client.Client, k8sCli *kubernetes.Clientset, ctx context
472472
LabelSelector: labSel,
473473
})
474474
if err != nil {
475-
klog.Warningf("cannot get Pods by DaemonSet %s/%s: %v", ds.Namespace, ds.Name, err)
475+
klog.ErrorS(err, "cannot get Pods by DaemonSet", "namespace", ds.Namespace, "name", ds.Name)
476476
continue
477477
}
478478

479479
for _, pod := range podList.Items {
480480
logs, err := objects.GetLogsForPod(k8sCli, pod.Namespace, pod.Name, containerNameRTE)
481481
if err != nil {
482-
klog.Warningf("DaemonSet %s/%s -> Pod %s/%s -> error getting logs: %v", ds.Namespace, ds.Name, pod.Namespace, pod.Name, err)
482+
klog.ErrorS(err, "cannot fetch logs", "dsNamespace", ds.Namespace, "dsName", ds.Name, "podNamespace", pod.Namespace, "podName", pod.Name)
483483
continue
484484
}
485485
klog.Infof("DaemonSet %s/%s -> Pod %s/%s -> logs:\n%s\n-----\n", ds.Namespace, ds.Name, pod.Namespace, pod.Name, logs)

test/e2e/must-gather/must_gather_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ var _ = Describe("[must-gather] NRO data collected", func() {
9191
}
9292
err := os.RemoveAll(destDir)
9393
if err != nil {
94-
klog.Warningf("unable to remove temporary directory %q: %v", destDir, err)
94+
klog.ErrorS(err, "unable to remove temporary directory", "path", destDir)
9595
}
9696
})
9797

test/e2e/rte/rte_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ var _ = ginkgo.Describe("with a running cluster with all the components", func()
7171
gomega.Eventually(func() bool {
7272
rteDss, err := getOwnedDss(clients.K8sClient, nropObj.ObjectMeta)
7373
if err != nil {
74-
klog.Warningf("failed to get the owned DaemonSets: %v", err)
74+
klog.ErrorS(err, "failed to get the owned DaemonSets")
7575
return false
7676
}
7777
if len(rteDss) == 0 {
@@ -110,7 +110,7 @@ var _ = ginkgo.Describe("with a running cluster with all the components", func()
110110
gomega.Eventually(func() bool {
111111
rteDss, err := getOwnedDss(clients.K8sClient, nropObj.ObjectMeta)
112112
if err != nil {
113-
klog.Warningf("failed to get the owned DaemonSets: %v", err)
113+
klog.ErrorS(err, "failed to get the owned DaemonSets")
114114
return false
115115
}
116116
if len(rteDss) == 0 {

test/e2e/sched/install/install_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ var _ = Describe("[Scheduler] install", func() {
6161
updatedNROObj := &nropv1.NUMAResourcesScheduler{}
6262
err := e2eclient.Client.Get(context.TODO(), client.ObjectKeyFromObject(nroSchedObj), updatedNROObj)
6363
if err != nil {
64-
klog.Warningf("failed to get the NRO Scheduler resource: %v", err)
64+
klog.ErrorS(err, "failed to get the NRO Scheduler resource")
6565
return false
6666
}
6767

@@ -85,7 +85,7 @@ var _ = Describe("[Scheduler] install", func() {
8585
Eventually(func() bool {
8686
deployment, err = podlist.With(e2eclient.Client).DeploymentByOwnerReference(context.TODO(), nroSchedObj.UID)
8787
if err != nil {
88-
klog.Warningf("unable to get deployment by owner reference: %v", err)
88+
klog.ErrorS(err, "unable to get deployment by owner reference")
8989
return false
9090
}
9191

test/e2e/sched/sched_test.go

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
5959
Eventually(func() bool {
6060
err := e2eclient.Client.Get(context.TODO(), nroSchedKey, nroSchedObj)
6161
if err != nil {
62-
klog.Warningf("failed to get NUMAResourcesScheduler %s; err: %v", nroSchedObj.Name, err)
62+
klog.ErrorS(err, "failed to get NUMAResourcesScheduler", "name", nroSchedObj.Name)
6363
return false
6464
}
6565

6666
nroSchedObj.Spec = objects.TestNROScheduler().Spec
6767
err = e2eclient.Client.Update(context.TODO(), nroSchedObj)
6868
if err != nil {
69-
klog.Warningf("failed to update NUMAResourcesScheduler %s; err: %v", nroSchedObj.Name, err)
69+
klog.ErrorS(err, "failed to update NUMAResourcesScheduler", "name", nroSchedObj.Name)
7070
return false
7171
}
7272
return true
@@ -88,12 +88,12 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
8888
By(fmt.Sprintf("switching the NROS image to %s", e2eimages.SchedTestImageCI))
8989
Eventually(func() bool {
9090
if err := e2eclient.Client.Get(context.TODO(), client.ObjectKeyFromObject(nroSchedObj), nroSchedObj); err != nil {
91-
klog.Warningf("failed to get NUMAResourcesScheduler %s; err: %v", nroSchedObj.Name, err)
91+
klog.ErrorS(err, "failed to get NUMAResourcesScheduler", "name", nroSchedObj.Name)
9292
return false
9393
}
9494
nroSchedObj.Spec.SchedulerImage = e2eimages.SchedTestImageCI
9595
if err := e2eclient.Client.Update(context.TODO(), nroSchedObj); err != nil {
96-
klog.Warningf("failed to update NUMAResourcesScheduler %s; err: %v", nroSchedObj.Name, err)
96+
klog.ErrorS(err, "failed to update NUMAResourcesScheduler", "name", nroSchedObj.Name)
9797
return false
9898
}
9999
uid = nroSchedObj.GetUID()
@@ -108,7 +108,7 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
108108
// find deployment by the ownerReference
109109
deploy, err := podlist.With(e2eclient.Client).DeploymentByOwnerReference(context.TODO(), uid)
110110
if err != nil {
111-
klog.Warningf("deployment pod listing failed: %v", err)
111+
klog.ErrorS(err, "deployment pod listing failed")
112112
return false
113113
}
114114
return deploy.Spec.Template.Spec.Containers[0].Image == e2eimages.SchedTestImageCI
@@ -117,12 +117,12 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
117117
By("reverting NROS changes")
118118
Eventually(func() bool {
119119
if err := e2eclient.Client.Get(context.TODO(), client.ObjectKeyFromObject(nroSchedObj), nroSchedObj); err != nil {
120-
klog.Warningf("failed to get NUMAResourcesScheduler %s; err: %v", nroSchedObj.Name, err)
120+
klog.ErrorS(err, "failed to get NUMAResourcesScheduler", "name", nroSchedObj.Name)
121121
return false
122122
}
123123
nroSchedObj.Spec = objects.TestNROScheduler().Spec
124124
if err = e2eclient.Client.Update(context.TODO(), nroSchedObj); err != nil {
125-
klog.Warningf("failed to update NUMAResourcesScheduler %s; err: %v", nroSchedObj.Name, err)
125+
klog.ErrorS(err, "failed to update NUMAResourcesScheduler", "name", nroSchedObj.Name)
126126
return false
127127
}
128128
return true
@@ -149,7 +149,7 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
149149
Eventually(func() bool {
150150
cmList := &corev1.ConfigMapList{}
151151
if err := e2eclient.Client.List(context.TODO(), cmList); err != nil {
152-
klog.Warningf("failed to list ConfigMaps: %v", err)
152+
klog.ErrorS(err, "failed to list ConfigMaps")
153153
return false
154154
}
155155

@@ -168,7 +168,7 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
168168

169169
err = e2eclient.Client.Update(context.TODO(), nroCM)
170170
if err != nil {
171-
klog.Warningf("failed to update ConfigMap %s/%s; err: %v", nroCM.Namespace, nroCM.Name, err)
171+
klog.ErrorS(err, "failed to update ConfigMap", "namespace", nroCM.Namespace, "name", nroCM.Name)
172172
return false
173173
}
174174
return true
@@ -178,7 +178,7 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
178178
Eventually(func() bool {
179179
err = e2eclient.Client.Get(context.TODO(), key, nroCM)
180180
if err != nil {
181-
klog.Warningf("failed to obtain ConfigMap; err: %v", err)
181+
klog.ErrorS(err, "failed to obtain ConfigMap")
182182
return false
183183
}
184184

@@ -200,7 +200,7 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
200200

201201
Eventually(func() bool {
202202
if err = e2eclient.Client.Update(context.TODO(), dp); err != nil {
203-
klog.Warningf("failed to update Deployment %s/%s; err: %v", dp.Namespace, dp.Name, err)
203+
klog.ErrorS(err, "failed to update Deployment", "namespace", dp.Namespace, "name", dp.Name)
204204
return false
205205
}
206206
return true
@@ -211,7 +211,7 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
211211
Eventually(func() bool {
212212
err = e2eclient.Client.Get(context.TODO(), key, dp)
213213
if err != nil {
214-
klog.Warningf("failed to obtain ConfigMap; err: %v", err)
214+
klog.ErrorS(err, "failed to obtain ConfigMap")
215215
return false
216216
}
217217

@@ -242,14 +242,14 @@ var _ = Describe("[Scheduler] imageReplacement", func() {
242242
Eventually(func() bool {
243243
err := e2eclient.Client.Get(context.TODO(), nroSchedKey, nroSchedObj)
244244
if err != nil {
245-
klog.Warningf("failed to get %q", nroSchedKey)
245+
klog.ErrorS(err, "failed to get", "key", nroSchedKey)
246246
return false
247247
}
248248
nroSchedObj.Spec.CacheResyncPeriod = &metav1.Duration{Duration: t}
249249

250250
err = e2eclient.Client.Update(context.TODO(), nroSchedObj)
251251
if err != nil {
252-
klog.Warningf("failed to update %q", nroSchedKey)
252+
klog.ErrorS(err, "failed to update", "key", nroSchedKey)
253253
return false
254254
}
255255
return true

test/e2e/sched/uninstall/uninstall_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ var _ = Describe("[Scheduler] uninstall", func() {
4343
// failed to get the NROScheduler object, nothing else we can do
4444
if err := e2eclient.Client.Get(context.TODO(), client.ObjectKeyFromObject(nroSchedObj), nroSchedObj); err != nil {
4545
if !errors.IsNotFound(err) {
46-
klog.Warningf("failed to get the NUMA resource scheduler %q: %v", nroSchedObj.Name, err)
46+
klog.ErrorS(err, "failed to get the NUMA resource scheduler", "name", nroSchedObj.Name)
4747
}
4848
return
4949
}
@@ -68,7 +68,7 @@ var _ = Describe("[Scheduler] uninstall", func() {
6868
if err == nil {
6969
klog.Warningf("obj %s still exists", key.String())
7070
} else {
71-
klog.Warningf("obj %s return with error: %v", key.String(), err)
71+
klog.ErrorS(err, "obj return with error", "key", key.String())
7272
}
7373
return false
7474
}

test/e2e/serial/tests/workload_placement.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ var _ = Describe("[serial][disruptive][scheduler] numaresources workload placeme
293293
Eventually(func() bool {
294294
pods, err = podlist.With(fxt.Client).ByDeployment(context.TODO(), *updatedDp)
295295
if err != nil {
296-
klog.Warningf("failed to list the pods of deployment: %q error: %v", namespacedDpName, err)
296+
klog.ErrorS(err, "failed to list the pods of deployment", "deployment", namespacedDpName)
297297
return false
298298
}
299299
if len(pods) != 1 {
@@ -402,7 +402,7 @@ var _ = Describe("[serial][disruptive][scheduler] numaresources workload placeme
402402
Eventually(func() bool {
403403
pods, err = podlist.With(fxt.Client).ByDeployment(context.TODO(), *updatedDp)
404404
if err != nil {
405-
klog.Warningf("failed to list the pods of deployment: %q error: %v", namespacedDpName, err)
405+
klog.ErrorS(err, "failed to list the pods of deployment", "deployment", namespacedDpName)
406406
return false
407407
}
408408
if len(pods) != 1 {
@@ -664,7 +664,7 @@ var _ = Describe("[serial][disruptive][scheduler] numaresources workload placeme
664664
Eventually(func() bool {
665665
pods, err = podlist.With(fxt.Client).ByDeployment(context.TODO(), *updatedDp)
666666
if err != nil {
667-
klog.Warningf("failed to list the pods of deployment: %q error: %v", namespacedDpName, err)
667+
klog.ErrorS(err, "failed to list the pods of deployment", "deployment", namespacedDpName)
668668
return false
669669
}
670670
if len(pods) != 2 {
@@ -838,7 +838,7 @@ var _ = Describe("[serial][disruptive][scheduler] numaresources workload placeme
838838
Eventually(func() bool {
839839
pods, err = podlist.With(fxt.Client).ByReplicaSet(context.TODO(), *rs)
840840
if err != nil {
841-
klog.Warningf("failed to list the pods of replicaset: %q error: %v", namespacedRsName.String(), err)
841+
klog.ErrorS(err, "failed to list the pods of replicaset", "replicaset", namespacedRsName.String())
842842
return false
843843
}
844844
if len(pods) != int(replicaNumber) {
@@ -936,7 +936,7 @@ var _ = Describe("[serial][disruptive][scheduler] numaresources workload placeme
936936
Eventually(func() bool {
937937
pods, err = podlist.With(fxt.Client).ByReplicaSet(context.TODO(), *rs)
938938
if err != nil {
939-
klog.Warningf("failed to list the pods of replicaset: %q error: %v", namespacedRsName.String(), err)
939+
klog.ErrorS(err, "failed to list the pods of replicaset", "replicaset", namespacedRsName.String())
940940
return false
941941
}
942942
if len(pods) != int(replicaNumber) {

test/e2e/serial/tests/workload_placement_tmpol.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1422,7 +1422,7 @@ var _ = Describe("[serial][disruptive][scheduler] numaresources workload placeme
14221422
return true
14231423
}
14241424
}
1425-
klog.Warningf("failed to find the expected event with Reason=\"FailedScheduling\" and Message contains: %q", errMsg)
1425+
klog.InfoS("failed to find the expected event with Reason=\"FailedScheduling\" and Message contains", "expected", errMsg)
14261426
if !loggedEvents {
14271427
_ = objects.LogEventsForPod(fxt.K8sClient, pod.Namespace, pod.Name)
14281428
loggedEvents = true

test/e2e/uninstall/uninstall_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ var _ = Describe("[Uninstall] clusterCleanup", Serial, func() {
6666
// failed to get the NRO object, nothing else we can do
6767
if err := e2eclient.Client.Get(context.TODO(), client.ObjectKeyFromObject(nroObj), nroObj); err != nil {
6868
if !errors.IsNotFound(err) {
69-
klog.Warningf("failed to get the NUMA resource operator %q: %v", nroObj.Name, err)
69+
klog.ErrorS(err, "failed to get the NUMA resource operator", "name", nroObj.Name)
7070
}
7171

7272
return
@@ -99,7 +99,7 @@ var _ = Describe("[Uninstall] clusterCleanup", Serial, func() {
9999
Eventually(func() bool {
100100
mcps, err := nropmcp.GetListByNodeGroupsV1(context.TODO(), e2eclient.Client, nroObj.Spec.NodeGroups)
101101
if err != nil {
102-
klog.Warningf("failed to get machine config pools: %v", err)
102+
klog.ErrorS(err, "failed to get machine config pools")
103103
return false
104104
}
105105

0 commit comments

Comments
 (0)