pkg/search/controllers_test: address flaky test [WIP]

[mohamedawnallah]

Description

This PR introduces two key changes, which may address flaky test cases:

• Sets the default resync period for the shared informer to one second, instead of zero, ensuring that the informer checks for changes at regular intervals, reducing the chance of missing updates.
• Ensures that the shared informer is shut down after completion, guaranteeing that all goroutines have terminated, which helps avoid any lingering processes that could interfere with test execution.

What type of PR is this?

/kind flake

What this PR does / why we need it:

Which issue(s) this PR fixes:
There are flake tests regards some test cases in search controller as found in this PR #5864.

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

[karmada-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 huntsman-li for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

• pkg/search/OWNERS

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

[XiShanYongYe-Chang]

Thanks~ @mohamedawnallah How does it work?

[mohamedawnallah]

Thanks~ @mohamedawnallah How does it work?

@XiShanYongYe-Chang, I've updated the PR description how these changes may fix these flaky test cases. That said it may pass this time in CI, which isn't detrimental if the test cases are no longer flaky. I've run the test cases again locally 100 times, and all passed. One point I observed is that the shared informer sometimes doesn't receive changes, meaning the upserted cluster from the watch API in the fake client is not detected. As a result, the invoke handlers are not triggered, and the system waits in the queue for elements, leading to the timeout issue. I'm curious, though—are the unit tests in CI running in parallel?

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.26%. Comparing base (88c3e44) to head (dcb6ab7).
Report is 6 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5875      +/-   ##
==========================================
+ Coverage   46.20%   46.26%   +0.06%     
==========================================
  Files         663      663              
  Lines       54580    54621      +41     
==========================================
+ Hits        25218    25272      +54     
+ Misses      27739    27723      -16     
- Partials     1623     1626       +3     

Flag	Coverage Δ
unittests	46.26% <ø> (+0.06%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[mohamedawnallah]

@XiShanYongYe-Chang The unit tests passed this time in the CI. What do you think about the changes in this PR? We may also keep an eye on it since for every PR submitted to the repo the unit tests will be triggered?

[XiShanYongYe-Chang]

We may also keep an eye on it since for every PR submitted to the repo the unit tests will be triggered?

I'm leaning towards this, so that we can test a little more before we incorporate it.

[XiShanYongYe-Chang]

Hi @mohamedawnallah please remember to push this pr again from time to time every day.

[mohamedawnallah]

✅2️⃣ Unit tests passed on the second run—no flaky test cases: GitHub Actions Logs