pulumi/pkg/engine/errors.go

52 lines
2.0 KiB
Go

// Copyright 2016-2018, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package engine
import (
"errors"
"fmt"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/config"
)
//
// This file contains type definitions for errors that can arise in the engine that the CLI layer would
// like to provide high-quality diagnostics for. cmd/errors.go is aware of these events and will use them
// and the data within them to provide long-form diagnostics that are inappropriate to be done in the Error()
// implementation of these types.
//
// DecryptError is the type of errors that arise when the engine can't decrypt a configuration key.
// The most common reason why this happens is that this key is being decrypted in a stack that's not the same
// one that encrypted it.
type DecryptError struct {
Key config.Key // The configuration key whose value couldn't be decrypted
Err error // The error that occurred while decrypting
}
func (d DecryptError) Error() string {
return fmt.Sprintf("failed to decrypt configuration key '%s': %s", d.Key, d.Err)
}
// Returns a tuple in which the second element is true if and only if any error
// in the given error's tree is a DecryptError. In that case, the first element
// will be the first DecryptError in the tree. In the event that there is no such
// DecryptError, the first element will be nil.
func AsDecryptError(err error) (*DecryptError, bool) {
var de *DecryptError
ok := errors.As(err, &de)
return de, ok
}