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.

Sign up for GitHub

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

Jump to bottom

Add 100% unit test coverage for annotation and label in pkg/util #5302

Merged
merged 1 commit into from
Aug 8, 2024
Merged

Add 100% unit test coverage for annotation and label in pkg/util #5302

merged 1 commit into from
Aug 8, 2024

Conversation

NishantBansal2003
Copy link
Contributor

What type of PR is this?
/kind failing-test

What this PR does / why we need it:
The test case coverage for annotation.go has been increased from 73.9% to 100% and for label.go has been increased from 97.8% to 100% .

Which issue(s) this PR fixes:
Ref #5235

Special notes for your reviewer:
To verify the changes in the pkg/util directory run the following commands:

go test ./... -coverprofile=coverage.out
go tool cover -html=coverage.out -o coverage.html
open coverage.html

Does this PR introduce a user-facing change?:

NONE

@karmada-bot karmada-bot added the kind/failing-test Categorizes issue or PR as related to a consistently or frequently failing test. label Aug 5, 2024
@karmada-bot
Copy link
Collaborator

Welcome @NishantBansal2003! It looks like this is your first PR to karmada-io/karmada 🎉

@karmada-bot karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 5, 2024
@codecov-commenter
Copy link

codecov-commenter commented Aug 5, 2024 •
edited
Loading

⚠️ 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 28.44%. Comparing base (8b4e006) to head (5643f77).
Report is 18 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    #5302      +/-   ##
==========================================
+ Coverage   28.36%   28.44%   +0.08%     
==========================================
  Files         632      632              
  Lines       43774    43810      +36     
==========================================
+ Hits        12416    12463      +47     
+ Misses      30458    30446      -12     
- Partials      900      901       +1
Flag Coverage Δ
unittests 28.44% <ø> (+0.08%) ⬆️

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.

@NishantBansal2003
Copy link
Contributor Author

NishantBansal2003 commented Aug 5, 2024 •
edited
Loading

Hey @XiShanYongYe-Chang,
I have added test coverage to pkg/utils/annotation.go and pkg/utils/label.go to better familiarize myself with Karmada's codebase. I would appreciate it if you could review the changes. I am open to any suggestions or modifications you may have.
Thanks

@XiShanYongYe-Chang
Copy link
Member

Thanks @NishantBansal2003
/assign

XiShanYongYe-Chang
XiShanYongYe-Chang reviewed Aug 6, 2024
View reviewed changes
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.

Thanks

pkg/util/label_test.go Show resolved Hide resolved
pkg/util/annotation_test.go Outdated Show resolved Hide resolved
pkg/util/annotation_test.go Outdated Show resolved Hide resolved
pkg/util/annotation_test.go Outdated Show resolved Hide resolved
@NishantBansal2003 NishantBansal2003 force-pushed the add-unit-tests-util branch 2 times, most recently from 5c4fd70 to bae1842 Compare August 7, 2024 06:57
@NishantBansal2003
Copy link
Contributor Author

Hey @XiShanYongYe-Chang, I fixed the issues, PTAL...

XiShanYongYe-Chang
XiShanYongYe-Chang reviewed Aug 7, 2024
View reviewed changes
pkg/util/annotation_test.go
@@ -288,7 +288,7 @@ func TestRecordManagedAnnotations(t *testing.T) {
},
},
{
name: "object has has annotations",
Copy link
Member

Choose a reason for hiding this comment

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

Good catch.

pkg/util/label_test.go Outdated
Comment on lines 369 to 373
if tt.args.labelKey == "" {
RemoveLabels(tt.args.obj)
} else {
RemoveLabels(tt.args.obj, tt.args.labelKey)
}
Copy link
Member

Choose a reason for hiding this comment

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

You've given me a good reminder. I feel that the previous test method is not good. Maybe we can change labelKey to labelKeys, so that we can test labelKeys of different lengths.

Like this:

RemoveLabels(tt.args.obj, tt,args.labelKeys...)

XiShanYongYe-Chang
XiShanYongYe-Chang reviewed Aug 7, 2024
View reviewed changes
pkg/util/annotation_test.go Outdated
Comment on lines 678 to 682
if tt.args.key == "" {
RemoveAnnotations(tt.args.obj)
} else {
RemoveAnnotations(tt.args.obj, tt.args.key)
}
Copy link
Member

Choose a reason for hiding this comment

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

Same comment with #5302 (comment)

@NishantBansal2003
Copy link
Contributor Author

@XiShanYongYe-Chang PTAL...

XiShanYongYe-Chang
XiShanYongYe-Chang reviewed Aug 8, 2024
View reviewed changes
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.

Good job @NishantBansal2003
/lgtm
/approve

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 8, 2024
@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 Aug 8, 2024
@karmada-bot karmada-bot merged commit da74c2d into karmada-io:master Aug 8, 2024
12 checks passed
@RainbowMango RainbowMango added this to the v1.11 milestone Aug 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@XiShanYongYe-Chang XiShanYongYe-Chang XiShanYongYe-Chang left review comments

@whitewindmills whitewindmills Awaiting requested review from whitewindmills

Assignees

@XiShanYongYe-Chang XiShanYongYe-Chang

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/failing-test Categorizes issue or PR as related to a consistently or frequently failing test. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
v1.11
Development

Successfully merging this pull request may close these issues.
5 participants
@NishantBansal2003 @karmada-bot @codecov-commenter @XiShanYongYe-Chang @RainbowMango