terraform: improve provider config related error messages #27261
Conversation
config If there is no provider configuration present in the config at all, errors related to missing required arguments lack source information or even a reference to the provider in question. This PR adds more specific error messages in three of these situations: - ValidateProvider - ConfigureProvider: provider.PrepareProviderConfig - ConfigureProvider: ctx.ConfigureProvider To test the last case I added a ConfigureProviderFn to the MockContext.
Codecov Report
|
| Provider %q requires explicit configuration. Add a provider block to the root | ||
| module and configure the provider's required arguments as described in the | ||
| provider documentation. | ||
| ` |
There was a problem hiding this comment.
Writing this paragraph with embedded newlines has the unfortunate effect of causing odd line-wrapping in the diagnostic output. You can see this in the screenshot below: it wraps awkwardly between "root" and "module" when there's no need to:
There was a problem hiding this comment.
I already tried changing the newlines - including one long single line with no newlines - and it didn't improve the output, do you know how else I might improve this?
There was a problem hiding this comment.
Huh. Making the last paragraph a single line seemed to work for me:
diff --git a/terraform/node_provider.go b/terraform/node_provider.go
index 57245fafb..001408bf2 100644
--- a/terraform/node_provider.go
+++ b/terraform/node_provider.go
@@ -185,7 +185,4 @@ func (n *NodeApplyableProvider) ConfigureProvider(ctx EvalContext, provider prov
const providerConfigErr = `%s
-Provider %q requires explicit configuration. Add a provider block to the root
-module and configure the provider's required arguments as described in the
-provider documentation.
-`
+Provider %q requires explicit configuration. Add a provider block to the root module and configure the provider's required arguments as described in the provider documentation.`Result:
There was a problem hiding this comment.
I apologize, my error - I tried what I thought I already tried before and it now looks better. Sorry!
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked as resolved and limited conversation to collaborators
If there is no "provider" block present in the configuration at all,
errors related to missing required arguments lack source information or
even a reference to the provider in question. This PR adds more specific
error messages in three of these situations:
To test the last case I added a ConfigureProviderFn to the MockContext.
Closes #20121, #26707, #23087