werror_printer_test.go

package werror

import (
	"context"
	"testing"

	"github.com/stretchr/testify/assert"
)

const stackTraceString = ".*github.com/palantir/witchcraft-go-error.TestErrorFormatting\n" +
	".*/werror_printer_test.*\n" +
	"testing.tRunner\n" +
	".*src/testing/testing.go.*\n" +
	"runtime.goexit\n" +
	".*src/runtime.*"

func TestErrorFormatting(t *testing.T) {
	for _, currCase := range []struct {
		name                    string
		err                     error
		expectedRegex           string
		outputEveryCallingStack bool
	}{
		{
			name: "simple error",
			err:  ErrorWithContextParams(context.Background(), "simple_error"),
			expectedRegex: "" +
				"simple_error\n\n" +
				stackTraceString,
		},
		{
			name: "simple error with param",
			err:  ErrorWithContextParams(context.Background(), "simple_error", SafeParam("safeParamKey", "safeParamValue")),
			expectedRegex: "" +
				"simple_error safeParamKey:safeParamValue\n\n" +
				stackTraceString,
		},
		{
			name: "simple error with many params",
			err:  ErrorWithContextParams(context.Background(), "simple_error", SafeParam("safeParamKey", "safeParamValue"), SafeParam("safeParamKey2", "safeParamValue2")),
			expectedRegex: "" +
				"simple_error safeParamKey:safeParamValue, safeParamKey2:safeParamValue2\n\n" +
				stackTraceString,
		},
		{
			name: "simple wrapped error",
			err:  WrapWithContextParams(context.Background(), ErrorWithContextParams(context.Background(), "simple_error"), "simple_error_2"),
			expectedRegex: "" +
				"simple_error_2\n" +
				"simple_error\n\n" +
				stackTraceString,
		},
		{
			name: "simple wrapped error with forced stacks",
			err:  WrapWithContextParams(context.Background(), ErrorWithContextParams(context.Background(), "simple_error"), "simple_error_2"),
			expectedRegex: "" +
				"simple_error_2\n" +
				"simple_error\n\n" +
				stackTraceString +
				"\n" +
				stackTraceString,
			outputEveryCallingStack: true,
		},
		{
			name: "double wrapped error with params",
			err: WrapWithContextParams(context.Background(), WrapWithContextParams(context.Background(),
				ErrorWithContextParams(context.Background(), "inner0Message", SafeParam("inner0ParamKey", "inner0VParamValue"), SafeParam("inner0ParamKey1", "inner0VParamValue1"), SafeParam("inner0ParamKey2", "inner0VParamValue2")),
				"inner1Message", SafeParam("inner1ParamKey", "inner1ValueKey")), "inner2Message"),
			expectedRegex: "" +
				"inner2Message\n" +
				"inner1Message inner1ParamKey:inner1ValueKey\n" +
				"inner0Message inner0ParamKey:inner0VParamValue, inner0ParamKey1:inner0VParamValue1, inner0ParamKey2:inner0VParamValue2\n\n" +
				stackTraceString,
		},
		{
			name: "error with pointer params",
			err: ErrorWithContextParams(context.Background(), "simple_error",
				SafeParam("key1", &[]string{"value"}[0]),
				SafeParam("key2", &[]int{42}[0]),
				SafeParam("key3", (*string)(nil)),
			),
			expectedRegex: "" +
				"simple_error key1:value, key2:42, key3:<nil>\n\n" +
				stackTraceString,
		},
	} {
		t.Run(currCase.name, func(t *testing.T) {
			assert.Regexp(t, currCase.expectedRegex, GenerateErrorString(currCase.err, currCase.outputEveryCallingStack))
		})
	}
}