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

Improve code coverage #92

Merged
merged 12 commits into from
Feb 25, 2025
Merged

Improve code coverage #92

merged 12 commits into from
Feb 25, 2025

Conversation

lukeatdell
Copy link
Contributor

@lukeatdell lukeatdell commented Feb 18, 2025

Description

Refactoring the mock server to address data races around accessing the global struct of "Induced errors".

Unit tests executed by csi-powermax have a dependency on the mock PowerMax server in mock.go. This server handles requests made by csi-powermax code when executing its unit tests. In order to induce errors, there is a global set of boolean vars within the mock server that is set by csi-powermax unit test code, and also read by the running server, leading to data races.

To resolve this, functions that read or otherwise modify the global vars have been unexported, and associated exported functions with the same name and func signature will call these unexported funcs, making sure to acquire the lock first. If necessary, unexported funcs should only call other unexported funcs to avoid deadlock.

Increasing unit test coverage.

GitHub Issues

List the GitHub issues impacted by this PR:

GitHub Issue #
dell/csm#1747

Checklist:

  • Have you run format,vet & lint checks against your submission?
  • Have you made sure that the code compiles?
  • Did you run the unit & integration tests successfully?
  • Have you maintained at least 90% code coverage?
  • Have you commented your code, particularly in hard-to-understand areas
  • Have you done corresponding changes to the documentation
  • Did you run tests in a real Kubernetes cluster?
  • Have you maintained at least 90% code coverage?
  • Backward compatibility is not broken

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

lukeatdell and others added 9 commits February 10, 2025 17:24
- Reset() func refactored to not have nested mutex locking and unlocking, but still lock at func root.
- Added a func for safe variable injection by test code.
- making global client vars part of the client struct to avoid race conditions
- Exported functions should lock the mutex before calling unexported funcs.
- Unexported funcs should only call unexported funcs to avoid deadlock caused by trying to lock an already locked mutex in the same thread.
falfaroc
falfaroc previously approved these changes Feb 21, 2025
donatwork
donatwork previously approved these changes Feb 21, 2025
@lukeatdell lukeatdell merged commit b34eb3b into main Feb 25, 2025
6 checks passed
@lukeatdell lukeatdell deleted the usr/spark/ut-datarace-csi-powermax branch February 25, 2025 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants