Skip to content

🐛 Nit: trim unncessary if check in templates/controllers/controller-test.go #2838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 2, 2022
Merged

🐛 Nit: trim unncessary if check in templates/controllers/controller-test.go #2838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions .../golang/deploy-image/v1alpha1/scaffolds/internal/templates/controllers/controller-test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,19 +135,13 @@ var _ = Describe("{{ .Resource.Kind }} controller", func() {
}

err = k8sClient.Create(ctx, {{ lower .Resource.Kind }})
if err != nil {
Expect(err).To(Not(HaveOccurred()))
}
Expect(err).To(Not(HaveOccurred()))
}

By("Checking if the custom resource was successfully created")
Eventually(func() error {
found := &{{ .Resource.ImportAlias }}.{{ .Resource.Kind }}{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
Copy link
Contributor Author

@LittleWat LittleWat Aug 2, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the same as
https://github.com/openshift/operator-framework-olm/blob/956fa85d8d9ccee89b567384d61ad009048ea853/staging/operator-lifecycle-manager/pkg/controller/operators/openshift/clusteroperator_controller_test.go#L63

}, time.Minute, time.Second).Should(Succeed())

By("Reconciling the custom resource created")
Expand All @@ -164,11 +158,7 @@ var _ = Describe("{{ .Resource.Kind }} controller", func() {
By("Checking if Deployment was successfully created in the reconciliation")
Eventually(func() error {
found := &appsv1.Deployment{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
}, time.Minute, time.Second).Should(Succeed())
})
})
Expand Down
16 changes: 3 additions & 13 deletions testdata/project-v3-with-deploy-image/controllers/busybox_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,19 +85,13 @@ var _ = Describe("Busybox controller", func() {
}

err = k8sClient.Create(ctx, busybox)
if err != nil {
Expect(err).To(Not(HaveOccurred()))
}
Expect(err).To(Not(HaveOccurred()))
Copy link
Member

@camilamacedo86 camilamacedo86 Jul 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @LittleWat,

Thank you for the contribution 🥇.

But this change cannot be done in the samples. the samples are generated automatically when we run make generate, see: https://github.com/kubernetes-sigs/kubebuilder/blob/master/test/testdata/generate.sh

Therefore, this change needs to be done in the plugin implementation: https://github.com/kubernetes-sigs/kubebuilder/blob/master/pkg/plugins/golang/deploy-image/v1alpha1/scaffolds/internal/templates/controllers/controller-test.go#L138-L140

Could you please do that in the code implementation and run make generate to ensure that all samples will be updated according to, squash the commits and push it so we are able to get this one merged?

Copy link
Member

@camilamacedo86 camilamacedo86 Jul 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, please note that you need assign to the CLA. #2838 (comment)

Copy link
Contributor Author

@LittleWat LittleWat Aug 2, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@camilamacedo86 Thank you for the quick and detailed review! Oh, these test codes are generated, cool!

I edited the original template file and did make generate and committed!
I also signed!

}

By("Checking if the custom resource was successfully created")
Eventually(func() error {
found := &examplecomv1alpha1.Busybox{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
}, time.Minute, time.Second).Should(Succeed())

By("Reconciling the custom resource created")
Expand All @@ -114,11 +108,7 @@ var _ = Describe("Busybox controller", func() {
By("Checking if Deployment was successfully created in the reconciliation")
Eventually(func() error {
found := &appsv1.Deployment{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
}, time.Minute, time.Second).Should(Succeed())
})
})
Expand Down
16 changes: 3 additions & 13 deletions testdata/project-v3-with-deploy-image/controllers/memcached_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,19 +86,13 @@ var _ = Describe("Memcached controller", func() {
}

err = k8sClient.Create(ctx, memcached)
if err != nil {
Expect(err).To(Not(HaveOccurred()))
}
Expect(err).To(Not(HaveOccurred()))
}

By("Checking if the custom resource was successfully created")
Eventually(func() error {
found := &examplecomv1alpha1.Memcached{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
}, time.Minute, time.Second).Should(Succeed())

By("Reconciling the custom resource created")
Expand All @@ -115,11 +109,7 @@ var _ = Describe("Memcached controller", func() {
By("Checking if Deployment was successfully created in the reconciliation")
Eventually(func() error {
found := &appsv1.Deployment{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
}, time.Minute, time.Second).Should(Succeed())
})
})
Expand Down
16 changes: 3 additions & 13 deletions testdata/project-v4-with-deploy-image/controllers/busybox_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,19 +85,13 @@ var _ = Describe("Busybox controller", func() {
}

err = k8sClient.Create(ctx, busybox)
if err != nil {
Expect(err).To(Not(HaveOccurred()))
}
Expect(err).To(Not(HaveOccurred()))
}

By("Checking if the custom resource was successfully created")
Eventually(func() error {
found := &examplecomv1alpha1.Busybox{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
}, time.Minute, time.Second).Should(Succeed())

By("Reconciling the custom resource created")
Expand All @@ -114,11 +108,7 @@ var _ = Describe("Busybox controller", func() {
By("Checking if Deployment was successfully created in the reconciliation")
Eventually(func() error {
found := &appsv1.Deployment{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
}, time.Minute, time.Second).Should(Succeed())
})
})
Expand Down
16 changes: 3 additions & 13 deletions testdata/project-v4-with-deploy-image/controllers/memcached_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,19 +86,13 @@ var _ = Describe("Memcached controller", func() {
}

err = k8sClient.Create(ctx, memcached)
if err != nil {
Expect(err).To(Not(HaveOccurred()))
}
Expect(err).To(Not(HaveOccurred()))
}

By("Checking if the custom resource was successfully created")
Eventually(func() error {
found := &examplecomv1alpha1.Memcached{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
}, time.Minute, time.Second).Should(Succeed())

By("Reconciling the custom resource created")
Expand All @@ -115,11 +109,7 @@ var _ = Describe("Memcached controller", func() {
By("Checking if Deployment was successfully created in the reconciliation")
Eventually(func() error {
found := &appsv1.Deployment{}
err = k8sClient.Get(ctx, typeNamespaceName, found)
if err != nil {
return err
}
return nil
return k8sClient.Get(ctx, typeNamespaceName, found)
}, time.Minute, time.Second).Should(Succeed())
})
})
Expand Down