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

operator/pkg: depend on aggregator.Interface instead of *aggregator.Clientset #5602

Merged

Conversation

mohamedawnallah
Copy link
Contributor

@mohamedawnallah mohamedawnallah commented Sep 25, 2024

Description

In this commit, we apply the Dependency Inversion Principle by depending on an interface instead of a concrete type. This improves flexibility and testability.

Motivation and Context

While testing the KarmadaResource API service operator package (#5596), I found it difficult to mock *aggregator.Clientset, complicating unit tests. By refactoring to depend on an interface, we improve flexibility and testability, allowing for the integration of a fake aggregator clientset since it implements that interface.

What type of PR is this?

/kind cleanup

Does this PR introduce a user-facing change?:

NONE

@karmada-bot karmada-bot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Sep 25, 2024
@karmada-bot karmada-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 25, 2024
@mohamedawnallah mohamedawnallah changed the title operator: depend on aggregator.Interface for Dependency Inversion operator/pkg: apply Dependency Inversion Principle by depending on aggregator.Interface instead of *aggregator.Clientset Sep 25, 2024
@codecov-commenter
Copy link

codecov-commenter commented Sep 25, 2024

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

Codecov Report

Attention: Patch coverage is 8.33333% with 11 lines in your changes missing coverage. Please review.

Project coverage is 35.19%. Comparing base (4c8bcd4) to head (6c490dc).
Report is 62 commits behind head on master.

Files with missing lines Patch % Lines
...rator/pkg/karmadaresource/apiservice/apiservice.go 0.00% 6 Missing ⚠️
operator/pkg/util/apiclient/idempotency.go 0.00% 2 Missing ⚠️
pkg/karmadactl/cmdinit/karmada/check.go 0.00% 1 Missing ⚠️
pkg/karmadactl/util/apiclient/apiclient.go 0.00% 1 Missing ⚠️
pkg/karmadactl/util/idempotency.go 0.00% 1 Missing ⚠️

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

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5602      +/-   ##
==========================================
+ Coverage   34.14%   35.19%   +1.05%     
==========================================
  Files         643      645       +2     
  Lines       44524    44869     +345     
==========================================
+ Hits        15203    15793     +590     
+ Misses      28165    27846     -319     
- Partials     1156     1230      +74     
Flag Coverage Δ
unittests 35.19% <8.33%> (+1.05%) ⬆️

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.

@mohamedawnallah mohamedawnallah changed the title operator/pkg: apply Dependency Inversion Principle by depending on aggregator.Interface instead of *aggregator.Clientset operator/pkg: depend on aggregator.Interface instead of *aggregator.Clientset Sep 26, 2024
Signed-off-by: Mohamed Awnallah <mohamedmohey2352@gmail.com>
@mohamedawnallah
Copy link
Contributor Author

Hi @XiShanYongYe-Chang,

Could we get this PR merged sooner? The unit test apiservice PR #5596, which depends on this, has been stale for a while. If anything is needed to move it forward, please let me know.

Thanks! 🙏

@XiShanYongYe-Chang
Copy link
Member

Thanks~
/assign

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 Oct 17, 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 Oct 17, 2024
@karmada-bot karmada-bot merged commit 29c97e9 into karmada-io:master Oct 17, 2024
12 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/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants