tfdiags: Simple helper for creating "sourceless" diagnostics

While diagnostics are primarily designed for reporting problems in
configuration, they can also be used for errors and warnings about the
environment Terraform is running in, such as inability to reach a remote
service, etc.

Function Sourceless makes it easy to produce such diagnostics with the
customary summary/detail structure. When these diagnostics are rendered
they will have no source code snippet and will instead just include the
English-language content.
This commit is contained in:
Martin Atkins 2018-03-20 18:44:44 -07:00
parent 9bd47bf17c
commit 860a57d104
1 changed files with 13 additions and 0 deletions

13
tfdiags/sourceless.go Normal file
View File

@ -0,0 +1,13 @@
package tfdiags
// Sourceless creates and returns a diagnostic with no source location
// information. This is generally used for operational-type errors that are
// caused by or relate to the environment where Terraform is running rather
// than to the provided configuration.
func Sourceless(severity Severity, summary, detail string) Diagnostic {
return diagnosticBase{
severity: severity,
summary: summary,
detail: detail,
}
}