Improve error message when failing to deploy a bundle. #318
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
cderici
approved these changes
Sep 27, 2023
internal/juju/applications.go
Outdated
| if resolvedCharm.Error != nil { | ||
| return nil, resolvedCharm.Error | ||
| } | ||
| if resolvedCharm.Origin.Type == "bundle" { | ||
| return nil, jujuerrors.Errorf("%q is a bundle not a charm", input.CharmName) |
There was a problem hiding this comment.
the message might be a bit nicer imo, but it still gives the info, so feel free to merge as is
Suggested change
| return nil, jujuerrors.Errorf("%q is a bundle not a charm", input.CharmName) | |
| return nil, jujuerrors.Errorf("unable to deploy bundles in the terraform provider, expected a charm, given bundle : %q", input.CharmName) |
There was a problem hiding this comment.
I was debating, the full printed message to the user is
Unable to create application, got error: "charmed-kubernetes" is a bundle not a charm
User friendly error messages are appreciated by all, especially when it's easy to do. Update docs to be clear an application resource will not deploy bundles.
hmlanigan
force-pushed
the
bundle-friendly-error
branch
from
a80af78 to
2b649a0
Compare
cderici
approved these changes
Sep 27, 2023
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.
Description
User friendly error messages are appreciated by all, especially when it's easy to do.
Fixes: #280
Type of change
QA steps
Manual QA steps should be done to test this PR.