fix: improve error handling for Prism Client #354
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nutanix-cn-prow-bot
bot
requested review from
thunderboltsid and
yannickstruyf3
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #354 +/- ##
=======================================
Coverage 13.62% 13.62%
=======================================
Files 4 4
Lines 1013 1013
=======================================
Hits 138 138
Misses 875 875 ☔ View full report in Codecov by Sentry. |
deepakm-ntnx
reviewed
Jan 3, 2024
deepakm-ntnx
reviewed
Jan 3, 2024
faiq
changed the title
deepakm-ntnx
reviewed
Jan 4, 2024
adiantum
requested changes
Jan 4, 2024
|
/ok-to-test |
|
@faiq can you also rebase this against the latest changes in main. |
faiq
force-pushed
the
faiq/client-error-handling
branch
from
ff401c1 to
cf34f59
Compare
|
/retest |
1 similar comment
|
/retest |
dkoshkin
reviewed
Jan 5, 2024
faiq
changed the title
jimmidyson
reviewed
Jan 8, 2024
faiq
force-pushed
the
faiq/client-error-handling
branch
from
cf8bea5 to
40872bd
Compare
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: faiq, thunderboltsid 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 |
thunderboltsid
approved these changes
Jan 8, 2024
|
/retest |
jimmidyson
approved these changes
Jan 8, 2024
thunderboltsid
merged commit 1f8716d
into
nutanix-cloud-native:main
8 of 10 checks passed
thunderboltsid
pushed a commit
that referenced
this pull request
Apr 24, 2024
* fix: use wrapper errors to clearly denote issues in client building * fix: adds a function to properly sanitize the address * fix: adds tests for ip address case given * fix: uses a defined type for port error * fix: clean up variable naming * fix: remove validation here to be moved into prism-client
thunderboltsid
pushed a commit
that referenced
this pull request
Apr 29, 2024
* fix: use wrapper errors to clearly denote issues in client building * fix: adds a function to properly sanitize the address * fix: adds tests for ip address case given * fix: uses a defined type for port error * fix: clean up variable naming * fix: remove validation here to be moved into prism-client
thunderboltsid
pushed a commit
that referenced
this pull request
May 2, 2024
* fix: use wrapper errors to clearly denote issues in client building * fix: adds a function to properly sanitize the address * fix: adds tests for ip address case given * fix: uses a defined type for port error * fix: clean up variable naming * fix: remove validation here to be moved into prism-client
thunderboltsid
added a commit
that referenced
this pull request
May 2, 2024
* fix: improve error handling for Prism Client (#354) * fix: use wrapper errors to clearly denote issues in client building * fix: adds a function to properly sanitize the address * fix: adds tests for ip address case given * fix: uses a defined type for port error * fix: clean up variable naming * fix: remove validation here to be moved into prism-client * refactor: task status file (#355) * test: add unit tests for pkg/client/state * refactor: use wait.Poll function waiting for task state * refactor: use consistent task status names * fixup! test: add unit tests for pkg/client/state * fix: revert to previous behaviod polling forever The ctx passed into WaitForTaskToSucceed is only used to cancel HTTP reqests and not to cancel the wait. * chore: add license headers * fix: better function name * refactor: client.go file helper methods (#360) * refactor: client.go file helper methods Refactored the existing methods and functions to be unit testable. Also made some methods that do not use the struct as generic functions. The changes were primarily an effort to add unit test coverage. * refactor: more testable read file function * test: new nutanixcluster types unit tests * test: additional test cases for errors * fixup! refactor: client.go file helper methods * fixup! refactor: client.go file helper methods * fixup! refactor: more testable read file function * fixup! refactor: client.go file helper methods * Switch Nutanix Client to using Session Auth (#398) This will ensure we make fewer basic auth requests to Prism Central IAM Services. --------- Co-authored-by: Faiq <faiq.raza@nutanix.com> Co-authored-by: Dimitri Koshkin <dimitri.koshkin@nutanix.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This adds some logic to properly format the prismCentral address string if a user provides an address with a scheme or port already included. It also adds error wrapping to clearly note where any issues might be coming from.
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes errors from bad user input
previously if a user provided an address such as `https://prismcentral.com" this would cause a failure like this
this code now strips out the scheme and port number from the address if it is provided.
How Has This Been Tested?:
I deployed this to a local kind cluster. Previously I was seeing errors such as
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration and test output
Special notes for your reviewer:
Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.
Release note: