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

Improved test coverage for policy in pkg/detector #5409

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

NishantBansal2003
Copy link
Contributor

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

What this PR does / why we need it:
The test case coverage for pkg/detector/policy.go has been improved.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:
To verify the changes in the pkg/detector/ 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

Signed-off-by: Nishant Bansal <nishant.bansal.282003@gmail.com>
@karmada-bot karmada-bot added kind/feature Categorizes issue or PR as related to a new feature. kind/failing-test Categorizes issue or PR as related to a consistently or frequently failing test. labels Aug 20, 2024
@karmada-bot karmada-bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Aug 20, 2024
@codecov-commenter
Copy link

codecov-commenter commented Aug 20, 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 29.98%. Comparing base (d4bfbb5) to head (87da9a9).
Report is 2 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    #5409      +/-   ##
==========================================
+ Coverage   29.82%   29.98%   +0.15%     
==========================================
  Files         632      632              
  Lines       43936    43936              
==========================================
+ Hits        13104    13173      +69     
+ Misses      29874    29804      -70     
- Partials      958      959       +1     
Flag Coverage Δ
unittests 29.98% <ø> (+0.15%) ⬆️

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

Hey @XiShanYongYe-Chang, I didn't provide complete coverage as the PR was getting large and to make it easier for you to review. I will add more tests once these changes are reviewed.

@XiShanYongYe-Chang
Copy link
Member

Hey @XiShanYongYe-Chang, I didn't provide complete coverage as the PR was getting large and to make it easier for you to review. I will add more tests once these changes are reviewed.

Maybe you can split the pr and test it by file.

@NishantBansal2003
Copy link
Contributor Author

NishantBansal2003 commented Aug 21, 2024

Maybe you can split the pr and test it by file.

Yeah, What I meant previously is that I have provided complete tests for removeResourceMarksIfNotMatched, listPPDerivedRBs, listCPPDerivedRBs, listCPPDerivedCRBs, and excludeClusterPolicy in policy.go. I will add tests for the other functions once these changes are reviewed(in other pr).

@NishantBansal2003
Copy link
Contributor Author

Can you retest and review this PR.
cc: @XiShanYongYe-Chang

@XiShanYongYe-Chang
Copy link
Member

/retest
/assign

@NishantBansal2003
Copy link
Contributor Author

NishantBansal2003 commented Aug 21, 2024

Hey @XiShanYongYe-Chang, I was trying to write tests for -

func (d *ResourceDetector) getAndApplyClusterPolicy(object *unstructured.Unstructured, objectKey keys.ClusterWideKey,
but I ran into some errors. I think I need to understand more about ResourceDetector to fix the bugs. Could you point me to some resources where I can learn about ResourceDetector with examples?
Thanks!

@XiShanYongYe-Chang
Copy link
Member

but I ran into some errors. I think I need to understand more about ResourceDetector to fix the bugs. Could you point me to some resources where I can learn about ResourceDetector with examples?

This may involve code details. You can focus on the code of the detector.

@NishantBansal2003
Copy link
Contributor Author

Hey @XiShanYongYe-Chang, I added some tests for other functions like - cleanPPUnmatchedRBs, cleanCPPUnmatchedRBs, cleanUnmatchedCRBs, removeRBsMarks and removeCRBsMarks. Should I push them in this commit, or should I wait for this PR to be merged and open another PR after that?

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~
/lgtm
/approve

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 23, 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 23, 2024
@karmada-bot karmada-bot merged commit bcf68fa into karmada-io:master Aug 23, 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
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. 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