Skip to content

Commit 90d8cf3

Browse files
jackfrancisjackfrancis
committed
use g.Expect when assertions are clearest
1 parent ef483b6 commit 90d8cf3

File tree

14 files changed

+91
-140
lines changed

14 files changed

+91
-140
lines changed

‎test/e2e/aks_public_ip_prefix.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ func AKSPublicIPPrefixSpec(ctx context.Context, inputGetter func() AKSPublicIPPr
7777
})
7878
Expect(err).NotTo(HaveOccurred())
7979
var publicIPPrefix network.PublicIPPrefix
80-
Eventually(func() error {
80+
Eventually(func(g Gomega) {
8181
publicIPPrefix, err = publicIPPrefixFuture.Result(publicIPPrefixClient)
82-
return err
82+
g.Expect(err).NotTo(HaveOccurred())
8383
}, input.WaitIntervals...).Should(Succeed(), "failed to create public IP prefix")
8484

8585
By("Creating node pool with 3 nodes")
@@ -130,15 +130,15 @@ func AKSPublicIPPrefixSpec(ctx context.Context, inputGetter func() AKSPublicIPPr
130130
err := mgmtClient.Delete(ctx, machinePool)
131131
Expect(err).NotTo(HaveOccurred())
132132

133-
Eventually(func() bool {
133+
Eventually(func(g Gomega) {
134134
err := mgmtClient.Get(ctx, client.ObjectKeyFromObject(machinePool), &expv1.MachinePool{})
135-
return apierrors.IsNotFound(err)
136-
}, input.WaitIntervals...).Should(BeTrue(), "Deleted MachinePool %s/%s still exists", machinePool.Namespace, machinePool.Name)
135+
g.Expect(apierrors.IsNotFound(err)).To(BeTrue())
136+
}, input.WaitIntervals...).Should(Succeed(), "Deleted MachinePool %s/%s still exists", machinePool.Namespace, machinePool.Name)
137137

138-
Eventually(func() bool {
138+
Eventually(func(g Gomega) {
139139
err := mgmtClient.Get(ctx, client.ObjectKeyFromObject(infraMachinePool), &infrav1.AzureManagedMachinePool{})
140-
return apierrors.IsNotFound(err)
141-
}, input.WaitIntervals...).Should(BeTrue(), "Deleted AzureManagedMachinePool %s/%s still exists", infraMachinePool.Namespace, infraMachinePool.Name)
140+
g.Expect(apierrors.IsNotFound(err)).To(BeTrue())
141+
}, input.WaitIntervals...).Should(Succeed(), "Deleted AzureManagedMachinePool %s/%s still exists", infraMachinePool.Namespace, infraMachinePool.Name)
142142
}()
143143

144144
By("Verifying the AzureManagedMachinePool converges to a failed ready status")

‎test/e2e/aks_upgrade.go‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ import (
2626
"github.com/Azure/go-autorest/autorest/azure/auth"
2727
. "github.com/onsi/ginkgo/v2"
2828
. "github.com/onsi/gomega"
29-
"github.com/pkg/errors"
3029
infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1beta1"
3130
azureutil "sigs.k8s.io/cluster-api-provider-azure/util/azure"
3231
clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
@@ -67,16 +66,13 @@ func AKSUpgradeSpec(ctx context.Context, inputGetter func() AKSUpgradeSpecInput)
6766
g.Expect(mgmtClient.Update(ctx, infraControlPlane)).To(Succeed())
6867
}, inputGetter().WaitForControlPlane...).Should(Succeed())
6968

70-
Eventually(func() (string, error) {
69+
Eventually(func(g Gomega) {
7170
aksCluster, err := managedClustersClient.Get(ctx, infraControlPlane.Spec.ResourceGroupName, infraControlPlane.Name)
72-
if err != nil {
73-
return "", err
74-
}
75-
if aksCluster.ManagedClusterProperties == nil || aksCluster.ManagedClusterProperties.KubernetesVersion == nil {
76-
return "", errors.New("Kubernetes version unknown")
77-
}
78-
return "v" + *aksCluster.KubernetesVersion, nil
79-
}, input.WaitForControlPlane...).Should(Equal(input.KubernetesVersionUpgradeTo))
71+
g.Expect(err).NotTo(HaveOccurred())
72+
g.Expect(aksCluster.ManagedClusterProperties).NotTo(BeNil())
73+
g.Expect(aksCluster.ManagedClusterProperties.KubernetesVersion).NotTo(BeNil())
74+
g.Expect("v" + *aksCluster.KubernetesVersion).To(Equal(input.KubernetesVersionUpgradeTo))
75+
}, input.WaitForControlPlane...).Should(Succeed())
8076

8177
By("Upgrading the machinepool instances")
8278
framework.UpgradeMachinePoolAndWait(ctx, framework.UpgradeMachinePoolAndWaitInput{

‎test/e2e/azure_failuredomains.go‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ func AzureFailureDomainsSpec(ctx context.Context, inputGetter func() AzureFailur
6262
By("Ensuring zones match CAPI failure domains")
6363

6464
// fetch updated cluster object to ensure Status.FailureDomains is up-to-date
65-
Eventually(func() error {
65+
Eventually(func(g Gomega) {
6666
err := input.BootstrapClusterProxy.GetClient().Get(ctx,
6767
apimachinerytypes.NamespacedName{
6868
Namespace: input.Namespace.Name,
@@ -71,13 +71,12 @@ func AzureFailureDomainsSpec(ctx context.Context, inputGetter func() AzureFailur
7171
if err != nil {
7272
LogWarning(err.Error())
7373
}
74-
return err
74+
g.Expect(err).NotTo(HaveOccurred())
75+
g.Expect(len(input.Cluster.Status.FailureDomains)).To(Equal(len(zones)))
76+
for _, z := range zones {
77+
g.Expect(input.Cluster.Status.FailureDomains[z]).NotTo(BeNil())
78+
}
7579
}, retryableOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
76-
Expect(err).NotTo(HaveOccurred())
77-
Expect(len(input.Cluster.Status.FailureDomains)).To(Equal(len(zones)))
78-
for _, z := range zones {
79-
Expect(input.Cluster.Status.FailureDomains[z]).NotTo(BeNil())
80-
}
8180

8281
// TODO: Find alternative when the number of zones is > 1 but doesn't equal to number of control plane machines.
8382
if len(input.Cluster.Status.FailureDomains) == 3 {

‎test/e2e/azure_gpu.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,12 @@ func getGPUOperatorPodLogs(ctx context.Context, clientset *kubernetes.Clientset)
124124
podsClient := clientset.CoreV1().Pods(corev1.NamespaceAll)
125125
var pods *corev1.PodList
126126
var err error
127-
Eventually(func() error {
127+
Eventually(func(g Gomega) {
128128
pods, err = podsClient.List(ctx, metav1.ListOptions{LabelSelector: "app.kubernetes.io/instance=gpu-operator"})
129129
if err != nil {
130130
LogWarning(err.Error())
131131
}
132-
return err
132+
g.Expect(err).NotTo(HaveOccurred())
133133
}, retryableOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
134134
b := strings.Builder{}
135135
for _, pod := range pods.Items {

‎test/e2e/azure_lb.go‎

Lines changed: 32 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ func AzureLBSpec(ctx context.Context, inputGetter func() AzureLBSpecInput) {
8282

8383
if input.Windows {
8484
var windowsVersion windows.OSVersion
85-
Eventually(func() error {
86-
version, err := node.GetWindowsVersion(ctx, clientset)
87-
windowsVersion = version
88-
return err
85+
Eventually(func(g Gomega) {
86+
var err error
87+
windowsVersion, err = node.GetWindowsVersion(ctx, clientset)
88+
g.Expect(err).NotTo(HaveOccurred())
8989
}, 300*time.Second, 5*time.Second).Should(Succeed())
9090
iisImage := windows.GetWindowsImage(windows.Httpd, windowsVersion)
9191
webDeployment.SetImage(deploymentName, iisImage)
@@ -121,13 +121,12 @@ func AzureLBSpec(ctx context.Context, inputGetter func() AzureLBSpecInput) {
121121

122122
ilbService := webDeployment.CreateServiceResourceSpec(ports, deploymentBuilder.InternalLoadbalancer, input.IPFamilies)
123123
Log("starting to create an internal Load Balancer service")
124-
Eventually(func() error {
124+
Eventually(func(g Gomega) {
125125
_, err := servicesClient.Create(ctx, ilbService, metav1.CreateOptions{})
126126
if err != nil {
127127
LogWarningf("failed creating service (%s):%s\n", ilbService.Name, err.Error())
128-
return err
129128
}
130-
return nil
129+
g.Expect(err).NotTo(HaveOccurred())
131130
}, retryableOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
132131
ilbSvcInput := WaitForServiceAvailableInput{
133132
Getter: servicesClientAdapter{client: servicesClient},
@@ -139,26 +138,24 @@ func AzureLBSpec(ctx context.Context, inputGetter func() AzureLBSpecInput) {
139138
By("connecting to the internal LB service from a curl pod")
140139

141140
var svc *corev1.Service
142-
Eventually(func() error {
141+
Eventually(func(g Gomega) {
143142
var err error
144143
svc, err = servicesClient.Get(ctx, ilbService.Name, metav1.GetOptions{})
145144
if err != nil {
146145
LogWarningf("failed getting service (%s):%s\n", ilbService.Name, err.Error())
147-
return err
148146
}
149-
return nil
147+
g.Expect(err).NotTo(HaveOccurred())
150148
}, retryableOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
151149
ilbIP := extractServiceIP(svc)
152150

153151
ilbJob := job.CreateCurlJobResourceSpec("curl-to-ilb-job", ilbIP)
154152
Log("starting to create a curl to ilb job")
155-
Eventually(func() error {
153+
Eventually(func(g Gomega) {
156154
_, err := jobsClient.Create(ctx, ilbJob, metav1.CreateOptions{})
157155
if err != nil {
158156
LogWarningf("failed creating job (%s):%s\n", ilbJob.Name, err.Error())
159-
return err
160157
}
161-
return nil
158+
g.Expect(err).NotTo(HaveOccurred())
162159
}, retryableOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
163160
ilbJobInput := WaitForJobCompleteInput{
164161
Getter: jobsClientAdapter{client: jobsClient},
@@ -170,40 +167,37 @@ func AzureLBSpec(ctx context.Context, inputGetter func() AzureLBSpecInput) {
170167
if !input.SkipCleanup {
171168
By("deleting the ilb test resources")
172169
Logf("starting to delete the ilb service: %s", ilbService.Name)
173-
Eventually(func() error {
170+
Eventually(func(g Gomega) {
174171
err := servicesClient.Delete(ctx, ilbService.Name, metav1.DeleteOptions{})
175172
if err != nil {
176173
LogWarningf("failed deleting service (%s):%s\n", ilbService.Name, err.Error())
177-
return err
178174
}
179-
return nil
175+
g.Expect(err).NotTo(HaveOccurred())
180176
}, retryableDeleteOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
181177
Logf("waiting for the ilb service to be deleted: %s", ilbService.Name)
182-
Eventually(func() bool {
178+
Eventually(func(g Gomega) {
183179
_, err := servicesClient.Get(ctx, ilbService.GetName(), metav1.GetOptions{})
184-
return apierrors.IsNotFound(err)
185-
}, deleteOperationTimeout, retryableOperationSleepBetweenRetries).Should(BeTrue())
180+
g.Expect(apierrors.IsNotFound(err)).To(BeTrue())
181+
}, deleteOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
186182
Logf("deleting the ilb job: %s", ilbJob.Name)
187-
Eventually(func() error {
183+
Eventually(func(g Gomega) {
188184
err := jobsClient.Delete(ctx, ilbJob.Name, metav1.DeleteOptions{})
189185
if err != nil {
190186
LogWarningf("failed deleting job (%s):%s\n", ilbJob.Name, err.Error())
191-
return err
192187
}
193-
return nil
188+
g.Expect(err).NotTo(HaveOccurred())
194189
}, deleteOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
195190
}
196191

197192
By("creating an external Load Balancer service")
198193
elbService := webDeployment.CreateServiceResourceSpec(ports, deploymentBuilder.ExternalLoadbalancer, input.IPFamilies)
199194
Log("starting to create an external Load Balancer service")
200-
Eventually(func() error {
195+
Eventually(func(g Gomega) {
201196
_, err := servicesClient.Create(ctx, elbService, metav1.CreateOptions{})
202197
if err != nil {
203198
LogWarningf("failed creating service (%s):%s\n", elbService.Name, err.Error())
204-
return err
205199
}
206-
return nil
200+
g.Expect(err).NotTo(HaveOccurred())
207201
}, retryableOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
208202
elbSvcInput := WaitForServiceAvailableInput{
209203
Getter: servicesClientAdapter{client: servicesClient},
@@ -213,26 +207,24 @@ func AzureLBSpec(ctx context.Context, inputGetter func() AzureLBSpecInput) {
213207
WaitForServiceAvailable(ctx, elbSvcInput, e2eConfig.GetIntervals(specName, "wait-service")...)
214208

215209
By("connecting to the external LB service from a curl pod")
216-
Eventually(func() error {
210+
Eventually(func(g Gomega) {
217211
var err error
218212
svc, err = servicesClient.Get(ctx, elbService.Name, metav1.GetOptions{})
219213
if err != nil {
220214
LogWarningf("failed getting service (%s):%s\n", elbService.Name, err.Error())
221-
return err
222215
}
223-
return nil
216+
g.Expect(err).NotTo(HaveOccurred())
224217
}, retryableOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
225218

226219
elbIP := extractServiceIP(svc)
227220
Log("starting to create curl-to-elb job")
228221
elbJob := job.CreateCurlJobResourceSpec("curl-to-elb-job"+util.RandomString(6), elbIP)
229-
Eventually(func() error {
222+
Eventually(func(g Gomega) {
230223
_, err := jobsClient.Create(ctx, elbJob, metav1.CreateOptions{})
231224
if err != nil {
232225
LogWarningf("failed creating job (%s):%s\n", elbJob.Name, err.Error())
233-
return err
234226
}
235-
return nil
227+
g.Expect(err).NotTo(HaveOccurred())
236228
}, retryableOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
237229
elbJobInput := WaitForJobCompleteInput{
238230
Getter: jobsClientAdapter{client: jobsClient},
@@ -261,36 +253,33 @@ func AzureLBSpec(ctx context.Context, inputGetter func() AzureLBSpecInput) {
261253
}
262254
By("deleting the test resources")
263255
Logf("starting to delete external LB service %s", elbService.Name)
264-
Eventually(func() error {
256+
Eventually(func(g Gomega) {
265257
err := servicesClient.Delete(ctx, elbService.Name, metav1.DeleteOptions{})
266258
if err != nil {
267259
LogWarningf("failed deleting service (%s):%s\n", elbService.Name, err.Error())
268-
return err
269260
}
270-
return nil
261+
g.Expect(err).NotTo(HaveOccurred())
271262
}, retryableDeleteOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
272263
Logf("waiting for the external LB service to be deleted: %s", elbService.Name)
273-
Eventually(func() bool {
264+
Eventually(func(g Gomega) {
274265
_, err := servicesClient.Get(ctx, elbService.GetName(), metav1.GetOptions{})
275-
return apierrors.IsNotFound(err)
276-
}, deleteOperationTimeout, retryableOperationSleepBetweenRetries).Should(BeTrue())
266+
g.Expect(apierrors.IsNotFound(err)).To(BeTrue())
267+
}, deleteOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
277268
Logf("starting to delete deployment %s", deployment.Name)
278-
Eventually(func() error {
269+
Eventually(func(g Gomega) {
279270
err := webDeployment.Client(clientset).Delete(ctx, deployment.Name, metav1.DeleteOptions{})
280271
if err != nil {
281272
LogWarningf("failed deleting deployment (%s):%s\n", deployment.Name, err.Error())
282-
return err
283273
}
284-
return nil
274+
g.Expect(err).NotTo(HaveOccurred())
285275
}, deleteOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
286276
Logf("starting to delete job %s", elbJob.Name)
287-
Eventually(func() error {
277+
Eventually(func(g Gomega) {
288278
err := jobsClient.Delete(ctx, elbJob.Name, metav1.DeleteOptions{})
289279
if err != nil {
290280
LogWarningf("failed deleting job (%s):%s\n", elbJob.Name, err.Error())
291-
return err
292281
}
293-
return nil
282+
g.Expect(err).NotTo(HaveOccurred())
294283
}, deleteOperationTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
295284
}
296285

‎test/e2e/azure_machinepool_drain.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,22 +169,22 @@ func testMachinePoolCordonAndDrain(ctx context.Context, mgmtClusterProxy, worklo
169169
func labelNodesWithMachinePoolName(ctx context.Context, workloadClient client.Client, mpName string, ampms []infrav1exp.AzureMachinePoolMachine) {
170170
for _, ampm := range ampms {
171171
n := &corev1.Node{}
172-
Eventually(func() error {
172+
Eventually(func(g Gomega) {
173173
err := workloadClient.Get(ctx, client.ObjectKey{
174174
Name: ampm.Status.NodeRef.Name,
175175
Namespace: ampm.Status.NodeRef.Namespace,
176176
}, n)
177177
if err != nil {
178178
LogWarning(err.Error())
179-
return err
180179
}
180+
g.Expect(err).NotTo(HaveOccurred())
181181
n.Labels[clusterv1.OwnerKindAnnotation] = "MachinePool"
182182
n.Labels[clusterv1.OwnerNameAnnotation] = mpName
183183
err = workloadClient.Update(ctx, n)
184184
if err != nil {
185185
LogWarning(err.Error())
186186
}
187-
return err
187+
g.Expect(err).NotTo(HaveOccurred())
188188
}, waitforResourceOperationTimeout, 3*time.Second).Should(Succeed())
189189
}
190190
}
@@ -212,15 +212,15 @@ func getOwnerMachinePool(ctx context.Context, c client.Client, obj metav1.Object
212212

213213
if ref.Kind == "MachinePool" && gv.Group == expv1.GroupVersion.Group {
214214
mp := &expv1.MachinePool{}
215-
Eventually(func() error {
215+
Eventually(func(g Gomega) {
216216
err := c.Get(ctx, client.ObjectKey{
217217
Name: ref.Name,
218218
Namespace: obj.Namespace,
219219
}, mp)
220220
if err != nil {
221221
LogWarning(err.Error())
222222
}
223-
return err
223+
g.Expect(err).NotTo(HaveOccurred())
224224
}, waitforResourceOperationTimeout, 3*time.Second).Should(Succeed())
225225
return mp, err
226226
}

‎test/e2e/helpers.go‎

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -958,30 +958,21 @@ func InstallHelmChart(ctx context.Context, clusterProxy framework.ClusterProxy,
958958
i.ReleaseName = releaseName
959959
i.Namespace = namespace
960960
i.CreateNamespace = true
961-
Eventually(func() error {
961+
Eventually(func(g Gomega) {
962962
cp, err := i.ChartPathOptions.LocateChart(chartName, helmCli.New())
963-
if err != nil {
964-
return err
965-
}
963+
g.Expect(err).NotTo(HaveOccurred())
966964
p := helmGetter.All(settings)
967965
if options == nil {
968966
options = &helmVals.Options{}
969967
}
970968
valueOpts := options
971969
vals, err := valueOpts.MergeValues(p)
972-
if err != nil {
973-
return err
974-
}
970+
g.Expect(err).NotTo(HaveOccurred())
975971
chartRequested, err := helmLoader.Load(cp)
976-
if err != nil {
977-
return err
978-
}
972+
g.Expect(err).NotTo(HaveOccurred())
979973
release, err := i.RunWithContext(ctx, chartRequested, vals)
980-
if err != nil {
981-
return err
982-
}
974+
g.Expect(err).NotTo(HaveOccurred())
983975
Logf(release.Info.Description)
984-
return nil
985976
}, helmInstallTimeout, retryableOperationSleepBetweenRetries).Should(Succeed())
986977
}
987978
}

0 commit comments

Comments
 (0)