mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-30 10:47:14 -06:00
05caff2ca3
This is part of a general effort to move all of Terraform's non-library package surface under internal in order to reinforce that these are for internal use within Terraform only. If you were previously importing packages under this prefix into an external codebase, you could pin to an earlier release tag as an interim solution until you've make a plan to achieve the same functionality some other way.
67 lines
1.9 KiB
Go
67 lines
1.9 KiB
Go
package moduletest
|
|
|
|
import (
|
|
"github.com/hashicorp/terraform/internal/tfdiags"
|
|
)
|
|
|
|
// Assertion is the description of a single test assertion, whether
|
|
// successful or unsuccessful.
|
|
type Assertion struct {
|
|
Outcome Status
|
|
|
|
// Description is a user-provided, human-readable description of what
|
|
// this assertion represents.
|
|
Description string
|
|
|
|
// Message is typically relevant only for TestFailed or TestError
|
|
// assertions, giving a human-readable description of the problem,
|
|
// formatted in the way our format package expects to receive paragraphs
|
|
// for terminal word wrapping.
|
|
Message string
|
|
|
|
// Diagnostics includes diagnostics specific to the current test assertion,
|
|
// if available.
|
|
Diagnostics tfdiags.Diagnostics
|
|
}
|
|
|
|
// Component represents a component being tested, each of which can have
|
|
// several associated test assertions.
|
|
type Component struct {
|
|
Assertions map[string]*Assertion
|
|
}
|
|
|
|
// Status is an enumeration of possible outcomes of a test assertion.
|
|
type Status rune
|
|
|
|
//go:generate go run golang.org/x/tools/cmd/stringer -type=Status assertion.go
|
|
|
|
const (
|
|
// Pending indicates that the test was registered (during planning)
|
|
// but didn't register an outcome during apply, perhaps due to being
|
|
// blocked by some other upstream failure.
|
|
Pending Status = '?'
|
|
|
|
// Passed indicates that the test condition succeeded.
|
|
Passed Status = 'P'
|
|
|
|
// Failed indicates that the test condition was valid but did not
|
|
// succeed.
|
|
Failed Status = 'F'
|
|
|
|
// Error indicates that the test condition was invalid or that the
|
|
// test report failed in some other way.
|
|
Error Status = 'E'
|
|
)
|
|
|
|
// SuiteCanPass returns true if a suite containing an assertion with this
|
|
// status could possibly succeed. The suite as a whole succeeds only if all
|
|
// of its assertions have statuses where SuiteCanPass returns true.
|
|
func (s Status) SuiteCanPass() bool {
|
|
switch s {
|
|
case Failed, Error:
|
|
return false
|
|
default:
|
|
return true
|
|
}
|
|
}
|