84990d53cf
When Ginkgo shows a BeforeEach/AfterEach/DeferCleanup, then it can only show the source code where the callback was registered because there is no description parameter. This can be improved by passing a custom CodeLocation. Because a description like "set up framework" might not be enough, the source code is still shown, too.
34 lines
1.1 KiB
Go
34 lines
1.1 KiB
Go
/*
|
|
Copyright 2022 The Kubernetes Authors.
|
|
|
|
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 framework
|
|
|
|
import (
|
|
"path"
|
|
|
|
"github.com/onsi/ginkgo/v2/types"
|
|
)
|
|
|
|
// AnnotatedLocation can be used to provide more informative source code
|
|
// locations by passing the result as additional parameter to a
|
|
// BeforeEach/AfterEach/DeferCleanup/It/etc.
|
|
func AnnotatedLocation(annotation string) types.CodeLocation {
|
|
codeLocation := types.NewCodeLocation(1)
|
|
codeLocation.FileName = path.Base(codeLocation.FileName)
|
|
codeLocation = types.NewCustomCodeLocation(annotation + " | " + codeLocation.String())
|
|
return codeLocation
|
|
}
|