Improve default auth error message to suggest setting auth_type#1603
Open
renaudhartert-db wants to merge 1 commit intodatabricks:mainfrom
Open
Improve default auth error message to suggest setting auth_type#1603renaudhartert-db wants to merge 1 commit intodatabricks:mainfrom
renaudhartert-db wants to merge 1 commit intodatabricks:mainfrom
Conversation
When no credentials strategy succeeds, the error message now guides users to set auth_type for a more specific error instead of pointing them at the full authentication docs. This makes it easier to diagnose configuration issues. Fixes databricks#1064 Co-authored-by: Isaac Signed-off-by: Ubuntu <renaud.hartert@databricks.com>
renaudhartert-db
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
points users at the full authentication documentation page. This is unhelpful
because it does not tell users what is actually misconfigured.
auth_type, whichcauses the SDK to try a single strategy and return a specific error explaining
exactly what is missing (e.g. "missing host" or "missing token").
Test plan
config/auth_permutations_test.goto match the new error stringconfig/auth_default_test.gostill passes (it uses a substring match)go test ./config/...passesgo vet ./config/...passesgofmtreports no formatting issues