test(utils): migrate tests to ginkgo of pkg/utils/kubeclient/service_test.go#5580
Conversation
Summary of ChangesHello @adity1raut, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the testing infrastructure by migrating several unit tests to the Ginkgo testing framework. This change aims to improve the clarity, structure, and expressiveness of the test suite, making it easier to understand test behaviors and maintain them in the long run. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Hi @adity1raut. Thanks for your PR. I'm waiting for a fluid-cloudnative member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request successfully migrates tests for pkg/utils/kubeclient/service_test.go and pkg/webhook/plugins/requirenodewithfuse/require_node_with_fuse_test.go to the Ginkgo testing framework. No vulnerabilities were found in the code changes. The migration improves test structure and readability, with a suggestion to further enhance require_node_with_fuse_test.go by adopting a more idiomatic Ginkgo BDD style through breaking down large It blocks.
| var _ = Describe("RequireNodeWithFuse Plugin", func() { | ||
| Describe("getRequiredSchedulingTerm", func() { | ||
| It("should return correct NodeSelectorTerm with selector enabled and disabled", func() { | ||
| runtimeInfo, err := base.BuildRuntimeInfo("test", "fluid", "alluxio") | ||
| Expect(err).NotTo(HaveOccurred()) | ||
|
|
||
| // Global fuse with selector enable | ||
| runtimeInfo.SetFuseNodeSelector(map[string]string{"test1": "test1"}) | ||
| terms, err := getRequiredSchedulingTerm(runtimeInfo) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| expectTerms := corev1.NodeSelectorTerm{ | ||
| MatchExpressions: []corev1.NodeSelectorRequirement{ | ||
| { | ||
| Key: "test1", | ||
| Operator: corev1.NodeSelectorOpIn, | ||
| Values: []string{"test1"}, | ||
| }, | ||
| }, | ||
| } | ||
| Expect(terms).To(Equal(expectTerms)) | ||
|
|
||
| // Global fuse with selector disable | ||
| runtimeInfo.SetFuseNodeSelector(map[string]string{}) | ||
| terms, err = getRequiredSchedulingTerm(runtimeInfo) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| expectTerms = corev1.NodeSelectorTerm{MatchExpressions: []corev1.NodeSelectorRequirement{}} | ||
| Expect(terms).To(Equal(expectTerms)) | ||
|
|
||
| // runtimeInfo is nil | ||
| _, err = getRequiredSchedulingTerm(nil) | ||
| Expect(err).To(HaveOccurred()) | ||
| }) | ||
| }) | ||
|
|
||
| Describe("Mutate", func() { | ||
| var ( | ||
| cl client.Client | ||
| pod *corev1.Pod | ||
| ) | ||
|
|
||
| BeforeEach(func() { | ||
| cl = nil | ||
| pod = &corev1.Pod{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test", | ||
| Namespace: "test", | ||
| }, | ||
| } | ||
| }) | ||
|
|
||
| It("should create plugin and mutate pod correctly", func() { | ||
| plugin, err := NewPlugin(cl, "") | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(plugin.GetName()).To(Equal(Name)) | ||
|
|
||
| runtimeInfo, err := base.BuildRuntimeInfo("test", "fluid", "alluxio") | ||
| Expect(err).NotTo(HaveOccurred()) | ||
|
|
||
| shouldStop, err := plugin.Mutate(pod, map[string]base.RuntimeInfoInterface{"pvcName": runtimeInfo}) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(shouldStop).To(BeFalse()) | ||
|
|
||
| _, err = plugin.Mutate(pod, map[string]base.RuntimeInfoInterface{}) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
|
|
||
| _, err = plugin.Mutate(pod, map[string]base.RuntimeInfoInterface{"pvcName": nil}) | ||
| Expect(err).To(HaveOccurred()) | ||
| }) | ||
| }) | ||
| }) |
There was a problem hiding this comment.
The test structure can be improved to be more idiomatic with Ginkgo's BDD style. Currently, multiple test cases are combined into single It blocks. It would be better to use Context to describe different scenarios and have more focused It blocks for specific assertions. This will make the tests more readable and easier to maintain.
var _ = Describe("RequireNodeWithFuse Plugin", func() {
Describe("getRequiredSchedulingTerm", func() {
var runtimeInfo base.RuntimeInfoInterface
BeforeEach(func() {
var err error
runtimeInfo, err = base.BuildRuntimeInfo("test", "fluid", "alluxio")
Expect(err).NotTo(HaveOccurred())
})
Context("when fuse node selector is enabled", func() {
It("should return a NodeSelectorTerm with the selector", func() {
runtimeInfo.SetFuseNodeSelector(map[string]string{"test1": "test1"})
terms, err := getRequiredSchedulingTerm(runtimeInfo)
Expect(err).NotTo(HaveOccurred())
expectTerms := corev1.NodeSelectorTerm{
MatchExpressions: []corev1.NodeSelectorRequirement{
{
Key: "test1",
Operator: corev1.NodeSelectorOpIn,
Values: []string{"test1"},
},
},
}
Expect(terms).To(Equal(expectTerms))
})
})
Context("when fuse node selector is disabled", func() {
It("should return an empty NodeSelectorTerm", func() {
runtimeInfo.SetFuseNodeSelector(map[string]string{})
terms, err := getRequiredSchedulingTerm(runtimeInfo)
Expect(err).NotTo(HaveOccurred())
expectTerms := corev1.NodeSelectorTerm{MatchExpressions: []corev1.NodeSelectorRequirement{}}
Expect(terms).To(Equal(expectTerms))
})
})
Context("when runtimeInfo is nil", func() {
It("should return an error", func() {
_, err := getRequiredSchedulingTerm(nil)
Expect(err).To(HaveOccurred())
})
})
})
Describe("Mutate", func() {
var (
cl client.Client
pod *corev1.Pod
plugin api.MutatingHandler
)
BeforeEach(func() {
cl = nil
pod = &corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Namespace: "test",
},
}
var err error
plugin, err = NewPlugin(cl, "")
Expect(err).NotTo(HaveOccurred())
})
It("should have the correct name", func() {
Expect(plugin.GetName()).To(Equal(Name))
})
Context("when mutating with a valid runtimeInfo", func() {
It("should not return an error and should not stop", func() {
runtimeInfo, err := base.BuildRuntimeInfo("test", "fluid", "alluxio")
Expect(err).NotTo(HaveOccurred())
shouldStop, err := plugin.Mutate(pod, map[string]base.RuntimeInfoInterface{"pvcName": runtimeInfo})
Expect(err).NotTo(HaveOccurred())
Expect(shouldStop).To(BeFalse())
})
})
Context("when mutating with an empty runtimeInfo map", func() {
It("should not return an error", func() {
_, err := plugin.Mutate(pod, map[string]base.RuntimeInfoInterface{})
Expect(err).NotTo(HaveOccurred())
})
})
Context("when mutating with a nil runtimeInfo", func() {
It("should return an error", func() {
_, err := plugin.Mutate(pod, map[string]base.RuntimeInfoInterface{"pvcName": nil})
Expect(err).To(HaveOccurred())
})
})
})
})
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #5580 +/- ##
==========================================
+ Coverage 59.07% 59.22% +0.15%
==========================================
Files 444 444
Lines 30431 30431
==========================================
+ Hits 17978 18024 +46
+ Misses 10947 10912 -35
+ Partials 1506 1495 -11 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…test.go Signed-off-by: adity1raut <araut7798@gmail.com>
adity1raut
force-pushed
the
kubeclient_6
branch
from
f2ede4a to
c263f25
Compare
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: TrafalgarZZZ The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
2 participants
Ⅰ. Describe what this PR does
Ⅱ. Does this pull request fix one issue?
part of #5407
Ⅲ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.
Ⅳ. Describe how to verify it
Ⅴ. Special notes for reviews