test(common): migrate hostpid_test.go to Ginkgo/Gomega #5645
Conversation
Migrate pkg/common/hostpid_test.go from testing.T to Ginkgo v2 and Gomega for BDD-style testing. Changes: - Add common_suite_test.go for Ginkgo test suite setup - Convert TestHostPIDEnabled table-driven test to DescribeTable/Entry - Use explicit ginkgo/gomega imports to avoid naming conflicts Part of fluid-cloudnative#5407 Signed-off-by: SUBID DAS <itsmesubid@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello @devsubid, 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 updates the testing infrastructure within the 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 @devsubid. 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 the tests in pkg/common/hostpid_test.go to use the Ginkgo and Gomega testing frameworks, which is a good step towards adopting BDD-style testing. The new test suite setup is correct. I have provided one suggestion to further improve the idiomatic use of Ginkgo/Gomega by splitting the test table and using more specific matchers, which will enhance the readability and maintainability of the tests.
| var _ = ginkgo.Describe("HostPIDEnabled", func() { | ||
| ginkgo.DescribeTable("should correctly determine if HostPID is enabled", | ||
| func(annotations map[string]string, expected bool) { | ||
| gomega.Expect(HostPIDEnabled(annotations)).To(gomega.Equal(expected)) | ||
| }, | ||
| { | ||
| name: "not exist, return false", | ||
| args: args{ | ||
| annotations: map[string]string{}, | ||
| }, | ||
| want: false, | ||
| }, | ||
| { | ||
| name: "wrong value, return false", | ||
| args: args{ | ||
| annotations: map[string]string{ | ||
| RuntimeFuseHostPIDKey: "sss", | ||
| }, | ||
| }, | ||
| want: false, | ||
| }, | ||
| { | ||
| name: "exist, return true", | ||
| args: args{ | ||
| annotations: map[string]string{ | ||
| RuntimeFuseHostPIDKey: "true", | ||
| }, | ||
| }, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "exist True, return true", | ||
| args: args{ | ||
| annotations: map[string]string{ | ||
| RuntimeFuseHostPIDKey: "True", | ||
| }, | ||
| }, | ||
| want: true, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| if got := HostPIDEnabled(tt.args.annotations); got != tt.want { | ||
| t.Errorf("HostPIDEnabled() = %v, want %v", got, tt.want) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
| ginkgo.Entry("nil annotations return false", nil, false), | ||
| ginkgo.Entry("empty annotations return false", map[string]string{}, false), | ||
| ginkgo.Entry("wrong value returns false", | ||
| map[string]string{RuntimeFuseHostPIDKey: "sss"}, false), | ||
| ginkgo.Entry("'true' returns true", | ||
| map[string]string{RuntimeFuseHostPIDKey: "true"}, true), | ||
| ginkgo.Entry("'True' returns true", | ||
| map[string]string{RuntimeFuseHostPIDKey: "True"}, true), | ||
| ) | ||
| }) |
There was a problem hiding this comment.
While the current implementation is correct, we can make it more idiomatic and readable by leveraging more of Ginkgo's BDD-style features.
I suggest splitting the DescribeTable into two separate tables: one for cases that should return true and another for cases that should return false. This makes the test's intent clearer.
Additionally, using the more specific gomega.BeTrue() and gomega.BeFalse() matchers is preferred over gomega.Equal(true) and gomega.Equal(false) for boolean assertions as it leads to more descriptive failure messages.
| var _ = ginkgo.Describe("HostPIDEnabled", func() { | |
| ginkgo.DescribeTable("should correctly determine if HostPID is enabled", | |
| func(annotations map[string]string, expected bool) { | |
| gomega.Expect(HostPIDEnabled(annotations)).To(gomega.Equal(expected)) | |
| }, | |
| { | |
| name: "not exist, return false", | |
| args: args{ | |
| annotations: map[string]string{}, | |
| }, | |
| want: false, | |
| }, | |
| { | |
| name: "wrong value, return false", | |
| args: args{ | |
| annotations: map[string]string{ | |
| RuntimeFuseHostPIDKey: "sss", | |
| }, | |
| }, | |
| want: false, | |
| }, | |
| { | |
| name: "exist, return true", | |
| args: args{ | |
| annotations: map[string]string{ | |
| RuntimeFuseHostPIDKey: "true", | |
| }, | |
| }, | |
| want: true, | |
| }, | |
| { | |
| name: "exist True, return true", | |
| args: args{ | |
| annotations: map[string]string{ | |
| RuntimeFuseHostPIDKey: "True", | |
| }, | |
| }, | |
| want: true, | |
| }, | |
| } | |
| for _, tt := range tests { | |
| t.Run(tt.name, func(t *testing.T) { | |
| if got := HostPIDEnabled(tt.args.annotations); got != tt.want { | |
| t.Errorf("HostPIDEnabled() = %v, want %v", got, tt.want) | |
| } | |
| }) | |
| } | |
| } | |
| ginkgo.Entry("nil annotations return false", nil, false), | |
| ginkgo.Entry("empty annotations return false", map[string]string{}, false), | |
| ginkgo.Entry("wrong value returns false", | |
| map[string]string{RuntimeFuseHostPIDKey: "sss"}, false), | |
| ginkgo.Entry("'true' returns true", | |
| map[string]string{RuntimeFuseHostPIDKey: "true"}, true), | |
| ginkgo.Entry("'True' returns true", | |
| map[string]string{RuntimeFuseHostPIDKey: "True"}, true), | |
| ) | |
| }) | |
| var _ = ginkgo.Describe("HostPIDEnabled", func() { | |
| ginkgo.DescribeTable("should return false when HostPID is not enabled", | |
| func(annotations map[string]string) { | |
| gomega.Expect(HostPIDEnabled(annotations)).To(gomega.BeFalse()) | |
| }, | |
| ginkgo.Entry("with nil annotations", nil), | |
| ginkgo.Entry("with empty annotations", map[string]string{}), | |
| ginkgo.Entry("with an invalid value", map[string]string{RuntimeFuseHostPIDKey: "sss"}), | |
| ) | |
| ginkgo.DescribeTable("should return true when HostPID is enabled", | |
| func(annotations map[string]string) { | |
| gomega.Expect(HostPIDEnabled(annotations)).To(gomega.BeTrue()) | |
| }, | |
| ginkgo.Entry("with value 'true'", map[string]string{RuntimeFuseHostPIDKey: "true"}), | |
| ginkgo.Entry("with value 'True' (case-insensitive)", map[string]string{RuntimeFuseHostPIDKey: "True"}), | |
| ) | |
| }) |
1 participant
Ⅰ. Describe what this PR does
Migrates
pkg/common/hostpid_test.gofromtesting.Tto Ginkgo v2 and Gomega for BDD-style testing.Changes:
common_suite_test.gofor Ginkgo test suite setupTestHostPIDEnabledtable-driven test toDescribeTable/Entryginkgo./gomega.imports to avoid naming conflictsⅡ. 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.
No new test cases. This PR migrates existing tests:
Ⅳ. Describe how to verify it