test(portallocator): refactor tests to use Ginkgo for better structure and readability

[adity1raut]

…e and readability

Ⅰ. Describe what this PR does

• test(portallocator): refactor tests to use Ginkgo for better structure and readability

Ⅱ. 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

[fluid-e2e-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign zwwhdls for approval by writing /assign @zwwhdls in a comment. For more information see:The Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gemini-code-assist]

Summary of Changes

Hello @adity1raut, I'm Gemini Code Assist¹! 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 significantly refactors the unit tests for the portallocator package. By migrating from the standard Go testing package to Ginkgo and Gomega, the tests now benefit from a more structured, behavior-driven development (BDD) style. This change enhances test readability, maintainability, and the clarity of test outcomes, ensuring more robust validation of port allocation logic.

Highlights

• Test Framework Migration: Refactored existing tests in port_allocator_test.go from standard Go testing to utilize the Ginkgo and Gomega testing frameworks, enhancing test structure and readability.
• New Test Suite: Introduced a new file, portallocator_suite_test.go, to define and run the Ginkgo test suite for the portallocator package.
• Assertion Style Update: Updated all test assertions to use Gomega's Expect syntax, providing more expressive and readable test outcomes.
• Bug Fix in Helper Function: Corrected a logical error in the between helper function to accurately check if a port falls within a specified range.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[fluid-e2e-bot]

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions 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]

Code Review

This pull request successfully refactors the port allocator tests to use the Ginkgo framework, which improves the structure and readability of the tests. A new test suite file has been added, and the existing tests have been migrated to the BDD style of Ginkgo. A bug in the between helper function was also corrected.

My review includes two main points:

1. A critical test case for the bitmap allocator, which verifies the re-allocation of released ports, was removed during the refactoring and has not been migrated. This reduces test coverage for an important scenario.
2. A test case for the random allocator's port release is present but contains no assertions, making it ineffective. Since the underlying release function is a no-op for this allocator type, the test should be removed.

Overall, the refactoring is a good improvement, but it's important to ensure no test coverage is lost in the process.

I am having trouble creating individual review comments. Click here to see my feedback.

pkg/ddc/base/portallocator/port_allocator_test.go (48-78)

The refactoring to Ginkgo has removed TestRuntimePortAllocator, which verified the crucial behavior of allocating, releasing, and then re-allocating ports for the bitmap allocator. This scenario is no longer covered in the new tests, resulting in a loss of test coverage. Please re-introduce this test case in the Ginkgo style to ensure this functionality remains tested.

For example, you could add a new Context to the RuntimePortAllocator Describe block:

Context("when allocating, releasing, and re-allocating ports", func() {
    It("should make released ports available for re-allocation", func() {
        pr := net.ParsePortRangeOrDie("20000-21000")
        err := SetupRuntimePortAllocator(nil, pr, "bitmap", dummy)
        Expect(err).NotTo(HaveOccurred())

        allocator, err := GetRuntimePortAllocator()
        Expect(err).NotTo(HaveOccurred())

        // dummy reserves 20001, 20002, 20003. First available should be 20004.
        allocatedPorts, err := allocator.GetAvailablePorts(3)
        Expect(err).NotTo(HaveOccurred())
        Expect(allocatedPorts).To(Equal([]int{20004, 20005, 20006}))

        // Release one reserved port and one newly allocated port
        toRelease := []int{20003, 20004}
        allocator.ReleaseReservedPorts(toRelease)

        // Now, 20003 and 20004 should be available again.
        // The bitmap allocator should offer them first in the next allocation.
        allocatedPorts, err = allocator.GetAvailablePorts(4)
        Expect(err).NotTo(HaveOccurred())
        Expect(allocatedPorts).To(Equal([]int{20003, 20004, 20007, 20008}))
    })
})

pkg/ddc/base/portallocator/port_allocator_test.go (102-105)

This test case for releasing ports on the RandomRuntimePortAllocator contains no assertions. Given that the Release method for the RandomAllocator is a no-op, this test provides no value and should be removed to avoid confusion.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.11%. Comparing base (7b2a096) to head (ca781ff).
⚠️ Report is 5 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5431      +/-   ##
==========================================
- Coverage   57.46%   56.11%   -1.35%     
==========================================
  Files         443      443              
  Lines       30735    30735              
==========================================
- Hits        17661    17248     -413     
- Misses      11460    11922     +462     
+ Partials     1614     1565      -49     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[adity1raut]

/cc @cheyang @RongGu