Merge pull request #122232 from pohly/e2e-test-label-error

e2e framework: provide more guidance to developers
This commit is contained in:
Kubernetes Prow Robot 2023-12-14 07:27:21 +01:00 committed by GitHub
commit 00e4cba038
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -531,10 +531,17 @@ type label struct {
parts []string parts []string
// extra is an optional fully-formed extra label. // extra is an optional fully-formed extra label.
extra string extra string
// explanation gets set for each label to help developers
// who pass a label to a ginkgo function. They need to use
// the corresponding framework function instead.
explanation string
} }
func newLabel(parts ...string) label { func newLabel(parts ...string) label {
return label{parts: parts} return label{
parts: parts,
explanation: "If you see this as part of an 'Unknown Decorator' error from Ginkgo, then you need to replace the ginkgo.It/Context/Describe call with the corresponding framework.It/Context/Describe or (if available) f.It/Context/Describe.",
}
} }
// TagsEqual can be used to check whether two tags are the same. // TagsEqual can be used to check whether two tags are the same.