lab.nexedi.com/kirr/go123@v0.0.0-20240207185015-8299741fa871/exc/error_test.go

// Copyright (C) 2015-2020  Nexedi SA and Contributors.
//                          Kirill Smelkov <kirr@nexedi.com>
//
// This program is free software: you can Use, Study, Modify and Redistribute
// it under the terms of the GNU General Public License version 3, or (at your
// option) any later version, as published by the Free Software Foundation.
//
// You can also Link and Combine this program with other software covered by
// the terms of any of the Free Software licenses or any of the Open Source
// Initiative approved licenses and Convey the resulting work. Corresponding
// source of such a combination shall include the source code for all other
// software used.
//
// This program is distributed WITHOUT ANY WARRANTY; without even the implied
// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//
// See COPYING file for full licensing terms.
// See https://www.nexedi.com/licensing for rationale and options.

package exc

import (
	"errors"
	"reflect"
	"runtime"
	"testing"

	"lab.nexedi.com/kirr/go123/my"
)

func do_raise1() {
	Raise(1)
}

func TestErrRaiseCatch(t *testing.T) {
	defer Catch(func(e *Error) {
		if !(e.arg == 1 && e.link == nil) {
			t.Fatalf("error caught but unexpected: %#v  ; want {1, nil}", e)
		}
	})
	do_raise1()
	t.Fatal("error not caught")
}

// verify err chain has .arg(s) as expected
func verifyErrChain(t *testing.T, e *Error, argv ...interface{}) {
	i := 0
	for ; e != nil; i, e = i+1, e.link {
		if i >= len(argv) {
			t.Fatal("too long error chain")
		}
		if e.arg != argv[i] {
			t.Fatalf("error caught but unexpected %vth arg: %v  ; want %v", i, e.arg, argv[i])
		}
	}
	if i < len(argv) {
		t.Fatal("too small error chain")
	}
}

func do_onunwind1(t *testing.T) {
	defer Onunwind(func(e *Error) *Error {
		t.Fatal("on unwind called without raise")
		return nil
	})
}

func do_onunwind2() {
	defer Onunwind(func(e *Error) *Error {
		return &Error{2, e}
	})
	do_raise1()
}

func TestErrOnUnwind(t *testing.T) {
	defer Catch(func(e *Error) {
		verifyErrChain(t, e, 2, 1)
	})
	do_onunwind1(t)
	do_onunwind2()
	t.Fatal("error not caught")
}

func do_context1(t *testing.T) {
	defer Context(func() interface{} {
		t.Fatal("on context called without raise")
		return nil
	})
}

func do_context2() {
	defer Context(func() interface{} {
		return 3
	})
	do_raise1()
}

func TestErrContext(t *testing.T) {
	defer Catch(func(e *Error) {
		verifyErrChain(t, e, 3, 1)
	})
	do_context1(t)
	do_context2()
	t.Fatal("error not caught")
}

func do_contextf1() {
	defer Contextf("must not be added")
	return // no exception
}

func do_contextf2() {
	defer Contextf("hello %d world", 123)
	do_raise1()
}

func TestErrContextf(t *testing.T) {
	defer Catch(func(e *Error) {
		verifyErrChain(t, e, "hello 123 world", 1)
	})
	do_contextf1()
	do_contextf2()
	t.Fatal("error not caught")
}

func do_raise11() {
	do_raise1()
}

func do_raise3if() {
	Raiseif(errors.New("3"))
}

func do_raise3if1() {
	do_raise3if()
}

func do_raise4f() {
	Raisef("%d", 4)
}

func do_raise4f1() {
	do_raise4f()
}

// get name of a function
func funcname(f interface{}) string {
	fentry := reflect.ValueOf(f).Pointer()
	ffunc := runtime.FuncForPC(fentry)
	return ffunc.Name()
}

func TestErrAddCallingContext(t *testing.T) {
	var tests = []struct { f func(); wanterrcontext string } {
		{do_raise11,	"do_raise11: do_raise1: 1"},
		{do_raise3if1,	"do_raise3if1: do_raise3if: 3"},
		{do_raise4f1,	"do_raise4f1: do_raise4f: 4"},
	}

	for _, tt := range tests {
		func() {
			myfunc := my.FuncName()
			defer Catch(func(e *Error) {
				e = Addcallingcontext(myfunc, e)
				msg := e.Error()
				if msg != tt.wanterrcontext {
					t.Fatalf("%v: err + calling context: %q  ; want %q", funcname(tt.f), msg, tt.wanterrcontext)
				}
			})
			tt.f()
			t.Fatalf("%v: error not caught", funcname(tt.f))
		}()
	}
}

func TestRunx(t *testing.T) {
	var tests = []struct { f func(); wanterr string } {
		{func() {},	""},
		{do_raise11,	"do_raise11: do_raise1: 1"},
	}

	for _, tt := range tests {
		err := Runx(tt.f)
		if err == nil {
			if tt.wanterr != "" {
				t.Errorf("runx(%v) -> nil  ; want %q error", funcname(tt.f), tt.wanterr)
			}
			continue
		}
		msg := err.Error()
		if msg != tt.wanterr {
			t.Errorf("runx(%v) -> %q  ; want %q", funcname(tt.f), msg, tt.wanterr)
		}
	}
}

func TestXRun(t *testing.T) {
	var tests = []struct { f func() error; wanterr string } {
		{func() error { return nil },			""},
		{func() error { return errors.New("abc") },	"X abc"},
	}

	for _, tt := range tests {
		errStr := ""
		func() {
			defer Catch(func(e *Error) {
				errStr = "X " + e.Error()
			})
			XRun(tt.f)
		}()

		if errStr != tt.wanterr {
			t.Errorf("xrun(%v) -> %q  ; want %q", funcname(tt.f), errStr, tt.wanterr)
		}
	}
}