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

test: add mock client in UT for azurefile_dataplane_client.go #2350

Closed
wants to merge 1 commit into from

Conversation

Zhupku
Copy link
Contributor

@Zhupku Zhupku commented Jan 21, 2025

This pull request introduces a new ShareClientInterface to the azurefile package, refactors the existing code to use this interface, and adds mock implementations for testing. The main changes include defining the new interface, updating methods to use the interface, and modifying tests to use mock clients.

Introduction of ShareClientInterface:

  • Added ShareClientInterface with methods for GetProperties, Create, Delete, and SetProperties in pkg/azurefile/azurefile_dataplane_client.go.
  • Added newShareClient function to return an instance of ShareClientInterface.

Refactoring to use ShareClientInterface:

  • Updated CreateFileShare method to use newShareClient instead of directly calling f.Client.NewShareClient.
  • Updated DeleteFileShare method to use newShareClient.
  • Updated ResizeFileShare method to use newShareClient.
  • Updated GetFileShareQuota method to use newShareClient.

Testing improvements:

  • Added mock implementation of ShareClientInterface for unit tests in pkg/azurefile/azurefile_dataplane_client_test.go.
  • Modified tests to use the mock client and updated test cases for CreateFileShare, DeleteFileShare, ResizeFileShare, and GetFileShareQuota to check for successful operations instead of expecting errors. [1] [2] [3] [4]<!-- Thanks for sending a pull request! Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://git.k8s.io/community/contributors/guide#your-first-contribution and developer guide https://git.k8s.io/community/contributors/devel/development.md#development-guide
  2. Please label this pull request according to what type of issue you are addressing, especially if this is a release targeted pull request. For reference on required PR/issue labels, read here:
    https://git.k8s.io/community/contributors/devel/release.md#issue-kind-label
  3. Ensure you have added or ran the appropriate tests for your PR: https://git.k8s.io/community/contributors/devel/testing.md
  4. If you want faster PR reviews, read how: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
  5. Follow the instructions for writing a release note: https://git.k8s.io/community/contributors/guide/release-notes.md
  6. If the PR is unfinished, see how to mark it: https://git.k8s.io/community/contributors/guide/pull-requests.md#marking-unfinished-pull-requests
    -->

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Requirements:

Special notes for your reviewer:

Release note:

none

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 21, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Zhupku
Once this PR has been reviewed and has the lgtm label, please assign feiskyer for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jan 21, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @Zhupku. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 21, 2025
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 24, 2025
@Zhupku
Copy link
Contributor Author

Zhupku commented Jan 24, 2025

There is no mock function in storage dataplane sdk and currently no wrapper in cloud provider for dataplane sdk. In order to implement the mock for ut, it will badly affect the production code readability. We decide not to do so.

@Zhupku Zhupku closed this Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants