05c0f4a298
`ginkgo.GINKGO_PANIC` is not available and cannot be imported directly. Signed-off-by: Dave Chen <dave.chen@arm.com>
107 lines
2.9 KiB
Go
107 lines
2.9 KiB
Go
/*
|
|
Copyright 2017 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 ginkgowrapper wraps Ginkgo Fail and Skip functions to panic
|
|
// with structured data instead of a constant string.
|
|
package ginkgowrapper
|
|
|
|
import (
|
|
"bufio"
|
|
"bytes"
|
|
"regexp"
|
|
"runtime"
|
|
"runtime/debug"
|
|
"strings"
|
|
|
|
"github.com/onsi/ginkgo/v2"
|
|
)
|
|
|
|
// FailurePanic is the value that will be panicked from Fail.
|
|
type FailurePanic struct {
|
|
Message string // The failure message passed to Fail
|
|
Filename string // The filename that is the source of the failure
|
|
Line int // The line number of the filename that is the source of the failure
|
|
FullStackTrace string // A full stack trace starting at the source of the failure
|
|
}
|
|
|
|
const ginkgoFailurePanic = `
|
|
Your test failed.
|
|
Ginkgo panics to prevent subsequent assertions from running.
|
|
Normally Ginkgo rescues this panic so you shouldn't see it.
|
|
But, if you make an assertion in a goroutine, Ginkgo can't capture the panic.
|
|
To circumvent this, you should call
|
|
defer GinkgoRecover()
|
|
at the top of the goroutine that caused this panic.
|
|
`
|
|
|
|
// String makes FailurePanic look like the old Ginkgo panic when printed.
|
|
func (FailurePanic) String() string { return ginkgoFailurePanic }
|
|
|
|
// Fail wraps ginkgo.Fail so that it panics with more useful
|
|
// information about the failure. This function will panic with a
|
|
// FailurePanic.
|
|
func Fail(message string, callerSkip ...int) {
|
|
skip := 1
|
|
if len(callerSkip) > 0 {
|
|
skip += callerSkip[0]
|
|
}
|
|
|
|
_, file, line, _ := runtime.Caller(skip)
|
|
fp := FailurePanic{
|
|
Message: message,
|
|
Filename: file,
|
|
Line: line,
|
|
FullStackTrace: pruneStack(skip),
|
|
}
|
|
|
|
defer func() {
|
|
e := recover()
|
|
if e != nil {
|
|
panic(fp)
|
|
}
|
|
}()
|
|
|
|
ginkgo.Fail(message, skip)
|
|
}
|
|
|
|
// ginkgo adds a lot of test running infrastructure to the stack, so
|
|
// we filter those out
|
|
var stackSkipPattern = regexp.MustCompile(`onsi/ginkgo/v2`)
|
|
|
|
func pruneStack(skip int) string {
|
|
skip += 2 // one for pruneStack and one for debug.Stack
|
|
stack := debug.Stack()
|
|
scanner := bufio.NewScanner(bytes.NewBuffer(stack))
|
|
var prunedStack []string
|
|
|
|
// skip the top of the stack
|
|
for i := 0; i < 2*skip+1; i++ {
|
|
scanner.Scan()
|
|
}
|
|
|
|
for scanner.Scan() {
|
|
if stackSkipPattern.Match(scanner.Bytes()) {
|
|
scanner.Scan() // these come in pairs
|
|
} else {
|
|
prunedStack = append(prunedStack, scanner.Text())
|
|
scanner.Scan() // these come in pairs
|
|
prunedStack = append(prunedStack, scanner.Text())
|
|
}
|
|
}
|
|
|
|
return strings.Join(prunedStack, "\n")
|
|
}
|