84c9110a24
Bumps [github.com/hashicorp/terraform-plugin-sdk/v2](https://github.com/hashicorp/terraform-plugin-sdk) from 2.24.1 to 2.26.0. - [Release notes](https://github.com/hashicorp/terraform-plugin-sdk/releases) - [Changelog](https://github.com/hashicorp/terraform-plugin-sdk/blob/main/CHANGELOG.md) - [Commits](https://github.com/hashicorp/terraform-plugin-sdk/compare/v2.24.1...v2.26.0) --- updated-dependencies: - dependency-name: github.com/hashicorp/terraform-plugin-sdk/v2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>
194 lines
5.5 KiB
Go
194 lines
5.5 KiB
Go
package tfdiags
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"sort"
|
|
)
|
|
|
|
// Diagnostics is a list of diagnostics. Diagnostics is intended to be used
|
|
// where a Go "error" might normally be used, allowing richer information
|
|
// to be conveyed (more context, support for warnings).
|
|
//
|
|
// A nil Diagnostics is a valid, empty diagnostics list, thus allowing
|
|
// heap allocation to be avoided in the common case where there are no
|
|
// diagnostics to report at all.
|
|
type Diagnostics []Diagnostic
|
|
|
|
// HasErrors returns true if any of the diagnostics in the list have
|
|
// a severity of Error.
|
|
func (diags Diagnostics) HasErrors() bool {
|
|
for _, diag := range diags {
|
|
if diag.Severity() == Error {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Err flattens a diagnostics list into a single Go error, or to nil
|
|
// if the diagnostics list does not include any error-level diagnostics.
|
|
//
|
|
// This can be used to smuggle diagnostics through an API that deals in
|
|
// native errors, but unfortunately it will lose naked warnings (warnings
|
|
// that aren't accompanied by at least one error) since such APIs have no
|
|
// mechanism through which to report these.
|
|
//
|
|
// return result, diags.Error()
|
|
func (diags Diagnostics) Err() error {
|
|
if !diags.HasErrors() {
|
|
return nil
|
|
}
|
|
return diagnosticsAsError{diags}
|
|
}
|
|
|
|
// ErrWithWarnings is similar to Err except that it will also return a non-nil
|
|
// error if the receiver contains only warnings.
|
|
//
|
|
// In the warnings-only situation, the result is guaranteed to be of dynamic
|
|
// type NonFatalError, allowing diagnostics-aware callers to type-assert
|
|
// and unwrap it, treating it as non-fatal.
|
|
//
|
|
// This should be used only in contexts where the caller is able to recognize
|
|
// and handle NonFatalError. For normal callers that expect a lack of errors
|
|
// to be signaled by nil, use just Diagnostics.Err.
|
|
func (diags Diagnostics) ErrWithWarnings() error {
|
|
if len(diags) == 0 {
|
|
return nil
|
|
}
|
|
if diags.HasErrors() {
|
|
return diags.Err()
|
|
}
|
|
return NonFatalError{diags}
|
|
}
|
|
|
|
// NonFatalErr is similar to Err except that it always returns either nil
|
|
// (if there are no diagnostics at all) or NonFatalError.
|
|
//
|
|
// This allows diagnostics to be returned over an error return channel while
|
|
// being explicit that the diagnostics should not halt processing.
|
|
//
|
|
// This should be used only in contexts where the caller is able to recognize
|
|
// and handle NonFatalError. For normal callers that expect a lack of errors
|
|
// to be signaled by nil, use just Diagnostics.Err.
|
|
func (diags Diagnostics) NonFatalErr() error {
|
|
if len(diags) == 0 {
|
|
return nil
|
|
}
|
|
return NonFatalError{diags}
|
|
}
|
|
|
|
type diagnosticsAsError struct {
|
|
Diagnostics
|
|
}
|
|
|
|
func (dae diagnosticsAsError) Error() string {
|
|
diags := dae.Diagnostics
|
|
switch {
|
|
case len(diags) == 0:
|
|
// should never happen, since we don't create this wrapper if
|
|
// there are no diagnostics in the list.
|
|
return "no errors"
|
|
case len(diags) == 1:
|
|
desc := diags[0].Description()
|
|
if desc.Detail == "" {
|
|
return desc.Summary
|
|
}
|
|
return fmt.Sprintf("%s: %s", desc.Summary, desc.Detail)
|
|
default:
|
|
var ret bytes.Buffer
|
|
fmt.Fprintf(&ret, "%d problems:\n", len(diags))
|
|
for _, diag := range dae.Diagnostics {
|
|
desc := diag.Description()
|
|
if desc.Detail == "" {
|
|
fmt.Fprintf(&ret, "\n- %s", desc.Summary)
|
|
} else {
|
|
fmt.Fprintf(&ret, "\n- %s: %s", desc.Summary, desc.Detail)
|
|
}
|
|
}
|
|
return ret.String()
|
|
}
|
|
}
|
|
|
|
// WrappedErrors is an implementation of errwrap.Wrapper so that an error-wrapped
|
|
// diagnostics object can be picked apart by errwrap-aware code.
|
|
func (dae diagnosticsAsError) WrappedErrors() []error {
|
|
var errs []error
|
|
for _, diag := range dae.Diagnostics {
|
|
if wrapper, isErr := diag.(nativeError); isErr {
|
|
errs = append(errs, wrapper.err)
|
|
}
|
|
}
|
|
return errs
|
|
}
|
|
|
|
// NonFatalError is a special error type, returned by
|
|
// Diagnostics.ErrWithWarnings and Diagnostics.NonFatalErr,
|
|
// that indicates that the wrapped diagnostics should be treated as non-fatal.
|
|
// Callers can conditionally type-assert an error to this type in order to
|
|
// detect the non-fatal scenario and handle it in a different way.
|
|
type NonFatalError struct {
|
|
Diagnostics
|
|
}
|
|
|
|
func (woe NonFatalError) Error() string {
|
|
diags := woe.Diagnostics
|
|
switch {
|
|
case len(diags) == 0:
|
|
// should never happen, since we don't create this wrapper if
|
|
// there are no diagnostics in the list.
|
|
return "no errors or warnings"
|
|
case len(diags) == 1:
|
|
desc := diags[0].Description()
|
|
if desc.Detail == "" {
|
|
return desc.Summary
|
|
}
|
|
return fmt.Sprintf("%s: %s", desc.Summary, desc.Detail)
|
|
default:
|
|
var ret bytes.Buffer
|
|
if diags.HasErrors() {
|
|
fmt.Fprintf(&ret, "%d problems:\n", len(diags))
|
|
} else {
|
|
fmt.Fprintf(&ret, "%d warnings:\n", len(diags))
|
|
}
|
|
for _, diag := range woe.Diagnostics {
|
|
desc := diag.Description()
|
|
if desc.Detail == "" {
|
|
fmt.Fprintf(&ret, "\n- %s", desc.Summary)
|
|
} else {
|
|
fmt.Fprintf(&ret, "\n- %s: %s", desc.Summary, desc.Detail)
|
|
}
|
|
}
|
|
return ret.String()
|
|
}
|
|
}
|
|
|
|
// sortDiagnostics is an implementation of sort.Interface
|
|
type sortDiagnostics []Diagnostic
|
|
|
|
var _ sort.Interface = sortDiagnostics(nil)
|
|
|
|
func (sd sortDiagnostics) Len() int {
|
|
return len(sd)
|
|
}
|
|
|
|
func (sd sortDiagnostics) Less(i, j int) bool {
|
|
iD, jD := sd[i], sd[j]
|
|
iSev, jSev := iD.Severity(), jD.Severity()
|
|
|
|
switch {
|
|
case iSev != jSev:
|
|
return iSev == Warning
|
|
default:
|
|
// The remaining properties do not have a defined ordering, so
|
|
// we'll leave it unspecified. Since we use sort.Stable in
|
|
// the caller of this, the ordering of remaining items will
|
|
// be preserved.
|
|
return false
|
|
}
|
|
}
|
|
|
|
func (sd sortDiagnostics) Swap(i, j int) {
|
|
sd[i], sd[j] = sd[j], sd[i]
|
|
}
|