elvish/pkg/eval/exception_test.go
Qi Xiao 3845a2cf7f Expose stack traces in exceptions as opaque values.
Also document the correct way to compare the causes of exceptions.

This fixes #1632.
2023-02-26 23:52:26 +00:00

101 lines
2.4 KiB
Go

package eval_test
import (
"errors"
"reflect"
"runtime"
"testing"
"unsafe"
"src.elv.sh/pkg/diag"
. "src.elv.sh/pkg/eval"
. "src.elv.sh/pkg/eval/evaltest"
"src.elv.sh/pkg/eval/vals"
"src.elv.sh/pkg/persistent/hash"
"src.elv.sh/pkg/tt"
)
func TestReason(t *testing.T) {
err := errors.New("ordinary error")
tt.Test(t, tt.Fn("Reason", Reason), tt.Table{
Args(err).Rets(err),
Args(makeException(err)).Rets(err),
})
}
func TestException(t *testing.T) {
err := FailError{"error"}
exc := makeException(err)
vals.TestValue(t, exc).
Kind("exception").
Bool(false).
Hash(hash.Pointer(unsafe.Pointer(reflect.ValueOf(exc).Pointer()))).
Equal(exc).
NotEqual(makeException(errors.New("error"))).
AllKeys("reason", "stack-trace").
Index("reason", err).
IndexError("stack", vals.NoSuchKey("stack")).
Repr("[&reason=[&content=error &type=fail] &stack-trace=<...>]")
vals.TestValue(t, OK).
Kind("exception").
Bool(true).
Repr("$ok")
}
func makeException(cause error, entries ...*diag.Context) Exception {
return NewException(cause, makeStackTrace(entries...))
}
// Creates a new StackTrace, using the first entry as the head.
func makeStackTrace(entries ...*diag.Context) *StackTrace {
var s *StackTrace
for i := len(entries) - 1; i >= 0; i-- {
s = &StackTrace{Head: entries[i], Next: s}
}
return s
}
func TestFlow_Fields(t *testing.T) {
Test(t,
That("put ?(return)[reason][type name]").Puts("flow", "return"),
)
}
func TestExternalCmdExit_Fields(t *testing.T) {
badCmd := "false"
if runtime.GOOS == "windows" {
badCmd = "cmd /c exit 1"
}
Test(t,
That("put ?("+badCmd+")[reason][type exit-status]").
Puts("external-cmd/exited", "1"),
// TODO: Test killed and stopped commands
)
}
func TestPipelineError_Fields(t *testing.T) {
Test(t,
That("put ?(fail 1 | fail 2)[reason][type]").Puts("pipeline"),
That("count ?(fail 1 | fail 2)[reason][exceptions]").Puts(2),
That("put ?(fail 1 | fail 2)[reason][exceptions][0][reason][type]").
Puts("fail"),
)
}
func TestErrorMethods(t *testing.T) {
tt.Test(t, tt.Fn("Error", error.Error), tt.Table{
Args(makeException(errors.New("err"))).Rets("err"),
Args(MakePipelineError([]Exception{
makeException(errors.New("err1")),
makeException(errors.New("err2"))})).Rets("(err1 | err2)"),
Args(Return).Rets("return"),
Args(Break).Rets("break"),
Args(Continue).Rets("continue"),
Args(Flow(1000)).Rets("!(BAD FLOW: 1000)"),
})
}