Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added unit tests for status and cronfederatedhpa helper utilities #5768

Conversation

anujagrawal699
Copy link
Contributor

Description:
This PR introduces comprehensive unit tests for status and cronfederatedhpa helper utility functions in the pkg/util/helper. These additions aim to increase code reliability, maintainability, and test coverage of the helper utility package.

Additions:

  1. pkg/util/helper/cronfederatedhpa_test.go
  2. pkg/util/helper/status_test.go

Test Coverage:

  1. pkg/util/helper/cronfederatedhpa_test.go : 0% to 100%
  2. pkg/util/helper/status_test.go : 0% to 100%

What type of PR is this?
/kind feature

Which issue(s) this PR fixes:
Fixes a part of #5470

Does this PR introduce a user-facing change?:

NONE

@karmada-bot karmada-bot added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 1, 2024
@karmada-bot karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 1, 2024
@codecov-commenter
Copy link

codecov-commenter commented Nov 1, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 45.61%. Comparing base (057cf86) to head (310e4f9).
Report is 67 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    #5768      +/-   ##
==========================================
+ Coverage   42.31%   45.61%   +3.30%     
==========================================
  Files         655      658       +3     
  Lines       55756    53921    -1835     
==========================================
+ Hits        23591    24598    +1007     
+ Misses      30651    27724    -2927     
- Partials     1514     1599      +85     
Flag Coverage Δ
unittests 45.61% <ø> (+3.30%) ⬆️

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:

Copy link
Contributor

@zhzhuang-zju zhzhuang-zju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

others LGTM

pkg/util/helper/status_test.go Show resolved Hide resolved
@anujagrawal699 anujagrawal699 force-pushed the addedTests-pkg/helper/status.go-cronfederatedhpa.go branch from ef26be6 to 72e7400 Compare November 14, 2024 09:08
@karmada-bot karmada-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 14, 2024
pkg/util/helper/status_test.go Outdated Show resolved Hide resolved
pkg/util/helper/status_test.go Outdated Show resolved Hide resolved
pkg/util/helper/status_test.go Outdated Show resolved Hide resolved
pkg/util/helper/status_test.go Outdated Show resolved Hide resolved
@anujagrawal699 anujagrawal699 force-pushed the addedTests-pkg/helper/status.go-cronfederatedhpa.go branch from 72e7400 to eb6a37a Compare November 15, 2024 07:53
Copy link
Contributor

@zhzhuang-zju zhzhuang-zju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, others LGTM

Namespace: testObj.GetNamespace(),
}

if tt.expectedError == "" {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if tt.expectedError == "" {

Lines L322-L327 have already handled the case where expectedError is not empty, so there is no need to add a condition check for tt.expectedError == "".

Signed-off-by: Anuj Agrawal <[email protected]>

Added unit tests for status and cronfederatedhpa helper utilities

Signed-off-by: Anuj Agrawal <[email protected]>

Added unit tests for status and cronfederatedhpa helper utilities

Signed-off-by: Anuj Agrawal <[email protected]>

Added unit tests for status and cronfederatedhpa helper utilities

Signed-off-by: Anuj Agrawal <[email protected]>
@anujagrawal699 anujagrawal699 force-pushed the addedTests-pkg/helper/status.go-cronfederatedhpa.go branch from eb6a37a to 310e4f9 Compare November 16, 2024 07:07
@zhzhuang-zju
Copy link
Contributor

/lgtm
cc @XiShanYongYe-Chang

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 2, 2024
expected: 3,
},
{
name: "successful history limit is set to 5",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a code bad taste involved here. The number 3 is a devil's number in the test case, and if we can describe it in one word, we'll be more comfortable naming the test case. For example, we can change the name of the test case to successful history limit is set to bigger than xxx.

If you wish, you can resubmit a pr to modify it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that makes sense, 3 could be defined as a constant at the package level, which would make it easier to change the default value in the future if needed.

Copy link
Member

@XiShanYongYe-Chang XiShanYongYe-Chang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@karmada-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: XiShanYongYe-Chang

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 2, 2024
@karmada-bot karmada-bot merged commit 064ccf1 into karmada-io:master Dec 2, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants