[Misc] Add unit test code coverage of rolesyncer #1296
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @vie-serendipity, 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 significantly enhances the testability and unit test coverage of the rolesyncer component, particularly for the stateless role synchronization logic. It introduces dependency injection for hash computation and adds a new, extensive suite of unit tests to validate the Scale and Rollout functionalities, alongside a minor refinement to the rollout deletion strategy.
Highlights
- Testability Improvement: Introduced a
computeHashFuncfield to bothStatefulRoleSyncerandStatelessRoleSyncerstructs, allowing for dependency injection of the hash computation logic. This makes these components more testable by enabling the mocking ofctrlutil.ComputeHash. - Unit Test Coverage: Added a new comprehensive unit test file (
rolesyncer_test.go) specifically for theStatelessRoleSyncer. This includes detailed test cases for theScaleandRolloutmethods, covering various scenarios like scaling up/down, handling terminated pods, respectingmaxUnavailableandmaxSurgeconstraints, and different rollout states (outdated, updated, partially updated pods). - Rollout Logic Refinement: Made a minor but important change to the
StatelessRoleSyncer.Rolloutmethod's logic for deleting outdated pods. The updated logic now prioritizes the immediate deletion of non-ready outdated pods and only deletes ready outdated pods if thedeleteBudgetallows, ensuring proper adherence tomaxUnavailableconstraints during rollouts.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
vie-serendipity
force-pushed
the
test/rolesyncer
branch
from
2ef2bc3 to
fec1805
Compare
There was a problem hiding this comment.
Code Review
This pull request introduces unit tests for the stateless RoleSyncer, significantly improving code coverage. The introduction of dependency injection for the hash computation function is a great change that enables robust testing. Additionally, the PR includes a valuable bug fix in the StatelessRoleSyncer.Rollout logic for handling the deleteBudget.
| expectedChange: true, | ||
| expectedCreate: 0, | ||
| expectedDelete: 0, |
There was a problem hiding this comment.
The expectations for this test case appear contradictory. expectedChange is true, but both expectedCreate and expectedDelete are 0. If no pods are created or deleted, no change should occur, and expectedChange should be false. Please review the expectations for this test case.
pkg/controller/roleset/rolesyncer.go
Outdated
| // If the pod is not ready and outdated, we can always delete it. | ||
| if !podutil.IsPodReady(outdated[i]) { | ||
| toDelete = append(toDelete, outdated[i]) |
There was a problem hiding this comment.
This condition ensures that outdated and not ready pods are always deleted, which is crucial for maintaining the desired state. This is an important bug fix.
| // Verify the net change matches expectation | ||
| expectedNetChange := tt.expectedCreate - tt.expectedDelete | ||
| assert.Equal(t, expectedNetChange, netChange, | ||
| "Expected net change: %d, actual: %d (create: %d, delete: %d)", | ||
| expectedNetChange, netChange, tt.expectedCreate, tt.expectedDelete) |
There was a problem hiding this comment.
The current assertion only checks the net change in the number of pods, which can be misleading. Suggest adding assertions to verify the number of pods with the new hash after the rollout to confirm that new pods were created as expected.
| for i := 0; i < len(outdated); i++ { | ||
| if podutil.IsPodReady(outdated[i]) { | ||
| // If the pod is not ready and outdated, we can always delete it. | ||
| if !podutil.IsPodReady(outdated[i]) { | ||
| toDelete = append(toDelete, outdated[i]) | ||
| } else { | ||
| // skip ready pod if delete budget exhausted | ||
| if deleteBudget <= 0 { | ||
| break | ||
| continue | ||
| } | ||
| deleteBudget-- | ||
| toDelete = append(toDelete, outdated[i]) | ||
| } | ||
| toDelete = append(toDelete, outdated[i]) | ||
| } |
There was a problem hiding this comment.
Notice, the logic here has been modified. I believe pods that are outdated and not ready can be directly deleted. In the original logic, it would break if deleteBudget was less than or equal to 0.
There was a problem hiding this comment.
update: we had a discussion in #1297. since the pods are sorted and unready pods are handled first. break case only affects ready pods, that means the unready pods must be handled earlier.
|
@vie-serendipity Could you file a separate PR for the logic change (no need to append tests)? Let's merge that one and then rebase the change to this PR. |
|
#1297 has been merged and please rebase the master and update this one. thanks! @vie-serendipity |
vie-serendipity
force-pushed
the
test/rolesyncer
branch
from
fec1805 to
d2a8ef7
Compare
Signed-off-by: vie-serendipity <[email protected]>
vie-serendipity
force-pushed
the
test/rolesyncer
branch
from
d2a8ef7 to
0af5d7f
Compare
test: add ut for StatelessRoleSyncer Scale and Rollout Signed-off-by: vie-serendipity <[email protected]>
2 participants
Pull Request Description
[Please provide a clear and concise description of your changes here]
Increase the unit test coverage of rolesyncer, for now only stateless rolesyncer.
Minor change to stateless rolesyncer.
Related Issues
Resolves: #1263
Important: Before submitting, please complete the description above and review the checklist below.
Contribution Guidelines (Expand for Details)
We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:
Pull Request Title Format
Your PR title should start with one of these prefixes to indicate the nature of the change:
[Bug]: Corrections to existing functionality[CI]: Changes to build process or CI pipeline[Docs]: Updates or additions to documentation[API]: Modifications to aibrix's API or interface[CLI]: Changes or additions to the Command Line Interface[Misc]: For changes not covered above (use sparingly)Note: For changes spanning multiple categories, use multiple prefixes in order of importance.
Submission Checklist
By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.