Skip to content

Commit 35e92e6

Browse files
L3n41cL3n41c
authored
[CONTINT-258] Leverage the testify assertion helpers in e2e tests (#20625)
1 parent 1b68efa commit 35e92e6

3 files changed

Lines changed: 78 additions & 98 deletions

File tree

‎test/new-e2e/tests/containers/base_test.go‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,9 @@ func (mc *myCollectT) Errorf(format string, args ...interface{}) {
8484
}
8585

8686
func (suite *baseSuite) testMetric(args *testMetricArgs) {
87-
suite.Run(fmt.Sprintf("%s{%s}", args.Filter.Name, strings.Join(args.Filter.Tags, ",")), func() {
87+
prettyMetricQuery := fmt.Sprintf("%s{%s}", args.Filter.Name, strings.Join(args.Filter.Tags, ","))
88+
89+
suite.Run(prettyMetricQuery, func() {
8890
var expectedTags []*regexp.Regexp
8991
if args.Expect.Tags != nil {
9092
expectedTags = lo.Map(*args.Expect.Tags, func(tag string, _ int) *regexp.Regexp { return regexp.MustCompile(tag) })
@@ -99,7 +101,7 @@ func (suite *baseSuite) testMetric(args *testMetricArgs) {
99101
})
100102

101103
if _, err := suite.datadogClient.PostEvent(&datadog.Event{
102-
Title: pointer.Ptr(fmt.Sprintf("testMetric %s{%s}", args.Filter.Name, strings.Join(args.Filter.Tags, ","))),
104+
Title: pointer.Ptr(fmt.Sprintf("testMetric %s", prettyMetricQuery)),
103105
Text: pointer.Ptr(fmt.Sprintf(`%%%%%%
104106
### Result
105107
@@ -127,63 +129,61 @@ func (suite *baseSuite) testMetric(args *testMetricArgs) {
127129

128130
defer func() {
129131
if suite.T().Failed() {
130-
sendEvent("error", fmt.Sprintf("Failed finding %s{%s} with proper tags", args.Filter.Name, strings.Join(args.Filter.Tags, ",")))
132+
sendEvent("error", fmt.Sprintf("Failed finding %s with proper tags", prettyMetricQuery))
131133
} else {
132134
sendEvent("success", "All good!")
133135
}
134136
}()
135137

136138
suite.EventuallyWithTf(func(collect *assert.CollectT) {
137-
myCollect := &myCollectT{
139+
c := &myCollectT{
138140
CollectT: collect,
139141
errors: []error{},
140142
}
141-
// To enforce the use of myCollect instead
143+
// To enforce the use of myCollectT instead
142144
collect = nil //nolint:ineffassign
143145

144146
defer func() {
145-
if len(myCollect.errors) == 0 {
147+
if len(c.errors) == 0 {
146148
sendEvent("success", "All good!")
147149
} else {
148-
sendEvent("warning", errors.Join(myCollect.errors...).Error())
150+
sendEvent("warning", errors.Join(c.errors...).Error())
149151
}
150152
}()
151153

152154
metrics, err := suite.Fakeintake.FilterMetrics(
153155
args.Filter.Name,
154156
fakeintake.WithTags[*aggregator.MetricSeries](args.Filter.Tags),
155157
)
156-
if err != nil {
157-
myCollect.Errorf("%w", err)
158+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
159+
if !assert.NoErrorf(c, err, "Failed to query fake intake") {
158160
return
159161
}
160-
if len(metrics) == 0 {
161-
myCollect.Errorf("No `%s{%s}` metrics yet", args.Filter.Name, strings.Join(args.Filter.Tags, ","))
162+
// Can be replaced by require.NoEmptyf(…) once https://github.com/stretchr/testify/pull/1481 is merged
163+
if !assert.NotEmptyf(c, metrics, "No `%s` metrics yet", prettyMetricQuery) {
162164
return
163165
}
164166

165167
// Check tags
166168
if expectedTags != nil {
167-
if err := assertTags(metrics[len(metrics)-1].GetTags(), expectedTags); err != nil {
168-
myCollect.Errorf("Tags mismatch on `%s`: %w", args.Filter.Name, err)
169-
}
169+
err := assertTags(metrics[len(metrics)-1].GetTags(), expectedTags)
170+
assert.NoErrorf(c, err, "Tags mismatch on `%s`", prettyMetricQuery)
170171
}
171172

172173
// Check value
173174
if args.Expect.Value != nil {
174-
if lo.CountBy(metrics[len(metrics)-1].GetPoints(), func(v *gogen.MetricPayload_MetricPoint) bool {
175+
assert.NotEmptyf(c, lo.Filter(metrics[len(metrics)-1].GetPoints(), func(v *gogen.MetricPayload_MetricPoint, _ int) bool {
175176
return v.GetValue() >= args.Expect.Value.Min &&
176177
v.GetValue() <= args.Expect.Value.Max
177-
}) == 0 {
178-
myCollect.Errorf(
179-
"No value of `%s{%s}` is in the range [%f;%f]",
180-
args.Filter.Name,
181-
strings.Join(args.Filter.Tags, ","),
182-
args.Expect.Value.Min,
183-
args.Expect.Value.Max,
184-
)
185-
}
178+
}), "No value of `%s` is in the range [%f;%f]: %v",
179+
prettyMetricQuery,
180+
args.Expect.Value.Min,
181+
args.Expect.Value.Max,
182+
lo.Map(metrics[len(metrics)-1].GetPoints(), func(v *gogen.MetricPayload_MetricPoint, _ int) float64 {
183+
return v.GetValue()
184+
}),
185+
)
186186
}
187-
}, 2*time.Minute, 10*time.Second, "Failed finding %s{%s} with proper tags", args.Filter.Name, strings.Join(args.Filter.Tags, ","))
187+
}, 2*time.Minute, 10*time.Second, "Failed finding `%s` with proper tags and value", prettyMetricQuery)
188188
})
189189
}

‎test/new-e2e/tests/containers/ecs_test.go‎

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ func (suite *ecsSuite) Test00UpAndRunning() {
9898
client := awsecs.NewFromConfig(cfg)
9999

100100
suite.Run("ECS tasks are ready", func() {
101-
suite.EventuallyWithTf(func(collect *assert.CollectT) {
101+
suite.EventuallyWithTf(func(c *assert.CollectT) {
102102
var initToken string
103103
for nextToken := &initToken; nextToken != nil; {
104104
if nextToken == &initToken {
@@ -110,8 +110,8 @@ func (suite *ecsSuite) Test00UpAndRunning() {
110110
MaxResults: pointer.Ptr(int32(10)), // Because `DescribeServices` takes at most 10 services in input
111111
NextToken: nextToken,
112112
})
113-
if err != nil {
114-
collect.Errorf("Failed to list ECS services: %w", err)
113+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
114+
if !assert.NoErrorf(c, err, "Failed to list ECS services") {
115115
return
116116
}
117117

@@ -121,15 +121,12 @@ func (suite *ecsSuite) Test00UpAndRunning() {
121121
Cluster: &suite.ecsClusterName,
122122
Services: servicesList.ServiceArns,
123123
})
124-
if err != nil {
125-
collect.Errorf("Failed to describe ECS services %v: %w", servicesList.ServiceArns, err)
124+
if !assert.NoErrorf(c, err, "Failed to describe ECS services %v", servicesList.ServiceArns) {
126125
continue
127126
}
128127

129128
for _, serviceDescription := range servicesDescription.Services {
130-
if serviceDescription.DesiredCount == 0 {
131-
collect.Errorf("ECS service %s has no task.", *serviceDescription.ServiceName)
132-
}
129+
assert.NotZerof(c, serviceDescription.DesiredCount, "ECS service %s has no task", *serviceDescription.ServiceName)
133130

134131
for nextToken := &initToken; nextToken != nil; {
135132
if nextToken == &initToken {
@@ -143,8 +140,7 @@ func (suite *ecsSuite) Test00UpAndRunning() {
143140
MaxResults: pointer.Ptr(int32(100)), // Because `DescribeTasks` takes at most 100 tasks in input
144141
NextToken: nextToken,
145142
})
146-
if err != nil {
147-
collect.Errorf("Failed to list ECS tasks for service %s: %w", *serviceDescription.ServiceName, err)
143+
if !assert.NoErrorf(c, err, "Failed to list ECS tasks for service %s", *serviceDescription.ServiceName) {
148144
break
149145
}
150146

@@ -154,20 +150,15 @@ func (suite *ecsSuite) Test00UpAndRunning() {
154150
Cluster: &suite.ecsClusterName,
155151
Tasks: tasksList.TaskArns,
156152
})
157-
if err != nil {
158-
collect.Errorf("Failed to describe ECS tasks %v: %w", tasksList.TaskArns, err)
153+
if !assert.NoErrorf(c, err, "Failed to describe ECS tasks %v", tasksList.TaskArns) {
159154
continue
160155
}
161156

162157
for _, taskDescription := range tasksDescription.Tasks {
163-
if *taskDescription.LastStatus != string(awsecstypes.DesiredStatusRunning) ||
164-
taskDescription.HealthStatus == awsecstypes.HealthStatusUnhealthy {
165-
collect.Errorf("Task %s of service %s is %s %s.",
166-
*taskDescription.TaskArn,
167-
*serviceDescription.ServiceName,
168-
*taskDescription.LastStatus,
169-
taskDescription.HealthStatus)
170-
}
158+
assert.Equalf(c, string(awsecstypes.DesiredStatusRunning), *taskDescription.LastStatus,
159+
"Task %s of service %s is not running", *taskDescription.TaskArn, *serviceDescription.ServiceName)
160+
assert.NotEqualf(c, awsecstypes.HealthStatusUnhealthy, taskDescription.HealthStatus,
161+
"Task %s of service %s is unhealthy", *taskDescription.TaskArn, *serviceDescription.ServiceName)
171162
}
172163
}
173164
}

‎test/new-e2e/tests/containers/k8s_test.go‎

Lines changed: 42 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -84,89 +84,75 @@ func (suite *k8sSuite) Test00UpAndRunning() {
8484
ctx := context.Background()
8585

8686
suite.Run("agent pods are ready and not restarting", func() {
87-
suite.EventuallyWithTf(func(collect *assert.CollectT) {
87+
suite.EventuallyWithTf(func(c *assert.CollectT) {
8888

8989
linuxNodes, err := suite.K8sClient.CoreV1().Nodes().List(ctx, metav1.ListOptions{
9090
LabelSelector: fields.OneTermEqualSelector("kubernetes.io/os", "linux").String(),
9191
})
92-
if err != nil {
93-
collect.Errorf("Failed to list Linux nodes: %w", err)
92+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
93+
if !assert.NoErrorf(c, err, "Failed to list Linux nodes") {
9494
return
9595
}
9696

9797
windowsNodes, err := suite.K8sClient.CoreV1().Nodes().List(ctx, metav1.ListOptions{
9898
LabelSelector: fields.OneTermEqualSelector("kubernetes.io/os", "windows").String(),
9999
})
100-
if err != nil {
101-
collect.Errorf("Failed to list Windows nodes: %w", err)
100+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
101+
if !assert.NoErrorf(c, err, "Failed to list Windows nodes") {
102102
return
103103
}
104104

105105
linuxPods, err := suite.K8sClient.CoreV1().Pods("datadog").List(ctx, metav1.ListOptions{
106106
LabelSelector: fields.OneTermEqualSelector("app", suite.AgentLinuxHelmInstallName+"-datadog").String(),
107107
})
108-
if err != nil {
109-
collect.Errorf("Failed to list Linux datadog agent pods: %w", err)
108+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
109+
if !assert.NoErrorf(c, err, "Failed to list Linux datadog agent pods") {
110110
return
111111
}
112112

113113
windowsPods, err := suite.K8sClient.CoreV1().Pods("datadog").List(ctx, metav1.ListOptions{
114114
LabelSelector: fields.OneTermEqualSelector("app", suite.AgentWindowsHelmInstallName+"-datadog").String(),
115115
})
116-
if err != nil {
117-
collect.Errorf("Failed to list Windows datadog agent pods: %w", err)
116+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
117+
if !assert.NoErrorf(c, err, "Failed to list Windows datadog agent pods") {
118118
return
119119
}
120120

121121
clusterAgentPods, err := suite.K8sClient.CoreV1().Pods("datadog").List(ctx, metav1.ListOptions{
122122
LabelSelector: fields.OneTermEqualSelector("app", suite.AgentLinuxHelmInstallName+"-datadog-cluster-agent").String(),
123123
})
124-
if err != nil {
125-
collect.Errorf("Failed to list datadog cluster agent pods: %w", err)
124+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
125+
if !assert.NoErrorf(c, err, "Failed to list datadog cluster agent pods") {
126126
return
127127
}
128128

129129
clusterChecksPods, err := suite.K8sClient.CoreV1().Pods("datadog").List(ctx, metav1.ListOptions{
130130
LabelSelector: fields.OneTermEqualSelector("app", suite.AgentLinuxHelmInstallName+"-datadog-clusterchecks").String(),
131131
})
132-
if err != nil {
133-
collect.Errorf("Failed to list datadog cluster checks runner pods: %w", err)
132+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
133+
if !assert.NoErrorf(c, err, "Failed to list datadog cluster checks runner pods") {
134134
return
135135
}
136136

137-
dogstatsdStandalonePods, err := suite.K8sClient.CoreV1().Pods("dogstatsd-standalone").List(ctx, metav1.ListOptions{
137+
dogstatsdPods, err := suite.K8sClient.CoreV1().Pods("dogstatsd-standalone").List(ctx, metav1.ListOptions{
138138
LabelSelector: fields.OneTermEqualSelector("app", "dogstatsd-standalone").String(),
139139
})
140-
if err != nil {
141-
collect.Errorf("Failed to list dogstatsd standalone pods: %w", err)
140+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
141+
if !assert.NoErrorf(c, err, "Failed to list dogstatsd standalone pods") {
142142
return
143143
}
144144

145-
if len(linuxPods.Items) != len(linuxNodes.Items) {
146-
collect.Errorf("There is only %d Linux datadog agent pods for %d Linux nodes.", len(linuxPods.Items), len(linuxNodes.Items))
147-
}
148-
if len(windowsPods.Items) != len(windowsNodes.Items) {
149-
collect.Errorf("There is only %d Windows datadog agent pods for %d Windows nodes.", len(windowsPods.Items), len(windowsNodes.Items))
150-
}
151-
if len(clusterAgentPods.Items) == 0 {
152-
collect.Errorf("There isn’t any cluster agent pod.")
153-
}
154-
if len(clusterChecksPods.Items) == 0 {
155-
collect.Errorf("There isn’t any cluster checks worker pod.")
156-
}
157-
if len(dogstatsdStandalonePods.Items) != len(linuxNodes.Items) {
158-
collect.Errorf("There is only %d dogstatsd standalone pods for %d Linux nodes.", len(dogstatsdStandalonePods.Items), len(linuxNodes.Items))
159-
}
145+
assert.Len(c, linuxPods.Items, len(linuxNodes.Items))
146+
assert.Len(c, windowsPods.Items, len(windowsNodes.Items))
147+
assert.NotEmpty(c, clusterAgentPods.Items)
148+
assert.NotEmpty(c, clusterChecksPods.Items)
149+
assert.Len(c, dogstatsdPods.Items, len(linuxNodes.Items))
160150

161-
for _, podList := range []*corev1.PodList{linuxPods, windowsPods, clusterAgentPods, clusterChecksPods} {
151+
for _, podList := range []*corev1.PodList{linuxPods, windowsPods, clusterAgentPods, clusterChecksPods, dogstatsdPods} {
162152
for _, pod := range podList.Items {
163153
for _, containerStatus := range append(pod.Status.InitContainerStatuses, pod.Status.ContainerStatuses...) {
164-
if !containerStatus.Ready {
165-
collect.Errorf("Container %s of pod %s isn’t ready.", containerStatus.Name, pod.Name)
166-
}
167-
if containerStatus.RestartCount > 0 {
168-
collect.Errorf("Container %s of pod %s has restarted %d times.", containerStatus.Name, pod.Name, containerStatus.RestartCount)
169-
}
154+
assert.Truef(c, containerStatus.Ready, "Container %s of pod %s isn’t ready", containerStatus.Name, pod.Name)
155+
assert.Zerof(c, containerStatus.RestartCount, "Container %s of pod %s has restarted", containerStatus.Name, pod.Name)
170156
}
171157
}
172158
}
@@ -209,7 +195,7 @@ func (suite *k8sSuite) Test00UpAndRunning() {
209195
if suite.NoError(err) && len(linuxPods.Items) >= 1 {
210196
stdout, stderr, err := suite.podExec("datadog", linuxPods.Items[0].Name, tt.container, []string{"agent", "version"})
211197
if suite.NoError(err) {
212-
suite.Equalf(stderr, "", "Standard error of `agent version` should be empty,")
198+
suite.Emptyf(stderr, "Standard error of `agent version` should be empty,")
213199
match := versionExtractor.FindStringSubmatch(stdout)
214200
if suite.Equalf(2, len(match), "'Commit' not found in the output of `agent version`.") {
215201
if len(GitCommit) == 10 && len(match[1]) == 7 {
@@ -289,6 +275,10 @@ func (suite *k8sSuite) TestNginx() {
289275
`^kube_deployment:nginx$`,
290276
`^kube_namespace:workload-nginx$`,
291277
},
278+
Value: &testMetricExpectValueArgs{
279+
Max: 5,
280+
Min: 1,
281+
},
292282
},
293283
})
294284

@@ -345,6 +335,10 @@ func (suite *k8sSuite) TestRedis() {
345335
`^kube_deployment:redis$`,
346336
`^kube_namespace:workload-redis$`,
347337
},
338+
Value: &testMetricExpectValueArgs{
339+
Max: 5,
340+
Min: 1,
341+
},
348342
},
349343
})
350344

@@ -638,21 +632,20 @@ func (suite *k8sSuite) testHPA(namespace, deployment string) {
638632
}
639633
}()
640634

641-
suite.EventuallyWithTf(func(collect *assert.CollectT) {
635+
suite.EventuallyWithTf(func(c *assert.CollectT) {
642636
metrics, err := suite.Fakeintake.FilterMetrics(
643637
"kubernetes_state.deployment.replicas_available",
644638
fakeintake.WithTags[*aggregator.MetricSeries]([]string{
645639
"kube_namespace:" + namespace,
646640
"kube_deployment:" + deployment,
647641
}),
648642
)
649-
if err != nil {
650-
collect.Errorf("%w", err)
643+
// Can be replaced by require.NoErrorf(…) once https://github.com/stretchr/testify/pull/1481 is merged
644+
if !assert.NoErrorf(c, err, "Failed to query fake intake") {
651645
return
652646
}
653-
if len(metrics) == 0 {
654-
collect.Errorf("No `kubernetes_state.deployment.replicas_available{kube_namespace:%s,kube_deployment:%s}` metrics yet", namespace, deployment)
655-
sendEvent("error", fmt.Sprintf("No `kubernetes_state.deployment.replicas_available{kube_namespace:%s,kube_deployment:%s}` metrics yet", namespace, deployment), nil)
647+
if !assert.NotEmptyf(c, metrics, "No `kubernetes_state.deployment.replicas_available{kube_namespace:%s,kube_deployment:%s}` metrics yet", namespace, deployment) {
648+
sendEvent("warning", fmt.Sprintf("No `kubernetes_state.deployment.replicas_available{kube_namespace:%s,kube_deployment:%s}` metrics yet", namespace, deployment), nil)
656649
return
657650
}
658651

@@ -669,13 +662,13 @@ func (suite *k8sSuite) testHPA(namespace, deployment string) {
669662
continue
670663
}
671664

672-
if point.Value > prevValue+0.5 {
665+
if !scaleUp && point.Value > prevValue+0.5 {
673666
scaleUp = true
674667
sendEvent("success", "Scale up detected.", pointer.Ptr(int(point.Timestamp)))
675668
if scaleDown {
676669
break out
677670
}
678-
} else if point.Value < prevValue-0.5 {
671+
} else if !scaleDown && point.Value < prevValue-0.5 {
679672
scaleDown = true
680673
sendEvent("success", "Scale down detected.", pointer.Ptr(int(point.Timestamp)))
681674
if scaleUp {
@@ -685,12 +678,8 @@ func (suite *k8sSuite) testHPA(namespace, deployment string) {
685678
prevValue = point.Value
686679
}
687680
}
688-
if !scaleUp {
689-
collect.Errorf("No scale up detected")
690-
}
691-
if !scaleDown {
692-
collect.Errorf("No scale down detected")
693-
}
681+
assert.Truef(c, scaleUp, "No scale up detected")
682+
assert.Truef(c, scaleDown, "No scale down detected")
694683
}, 20*time.Minute, 10*time.Second, "Failed to witness scale up and scale down of %s.%s", namespace, deployment)
695684
})
696685
}

0 commit comments

Comments
 (0)
⚡