boundary/internal/errors/option_test.go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1

package errors

import (
	"context"
	"testing"

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

// Test_getOpts provides unit tests for GetOpts and all the options
func Test_getOpts(t *testing.T) {
	t.Parallel()
	t.Run("WithMsg", func(t *testing.T) {
		assert := assert.New(t)
		// test default
		opts := GetOpts()
		testOpts := getDefaultOptions()
		testOpts.withErrMsg = ""
		assert.Equal(opts, testOpts)

		// try setting it
		opts = GetOpts(WithMsg("test msg"))
		testOpts.withErrMsg = "test msg"
		assert.Equal(opts, testOpts)

		opts = GetOpts(WithMsg("%s msg", "test"))
		testOpts.withErrMsg = "%s msg"
		testOpts.withErrMsgArgs = []any{"test"}
		assert.Equal(opts, testOpts)

		assert.Equal("#1 test msg: unknown: error #0", E(context.Background(), WithMsg("#%d %s msg", 1, "test")).Error())
	})
	t.Run("WithWrap", func(t *testing.T) {
		assert := assert.New(t)
		// test default
		opts := GetOpts()
		testOpts := getDefaultOptions()
		testOpts.withErrWrapped = nil
		assert.Equal(opts, testOpts)

		testErr := E(context.TODO(), WithCode(InvalidParameter), WithMsg("test error"))

		// try setting it
		opts = GetOpts(WithWrap(testErr))
		testOpts.withErrWrapped = testErr
		assert.Equal(opts, testOpts)
	})
	t.Run("WithOp", func(t *testing.T) {
		assert := assert.New(t)
		// test default
		opts := GetOpts()
		testOpts := getDefaultOptions()
		testOpts.withOp = ""
		assert.Equal(opts, testOpts)

		// try setting it
		opts = GetOpts(WithOp("alice.bob"))
		testOpts.withOp = "alice.bob"
		assert.Equal(opts, testOpts)
	})
	t.Run("WithCode", func(t *testing.T) {
		assert := assert.New(t)
		// test default
		opts := GetOpts()
		testOpts := getDefaultOptions()
		testOpts.withOp = ""
		assert.Equal(opts, testOpts)

		// try setting it
		opts = GetOpts(WithCode(NotUnique))
		testOpts.withCode = NotUnique
		assert.Equal(opts, testOpts)
	})
	t.Run("WithoutEvent", func(t *testing.T) {
		assert := assert.New(t)
		// test default
		opts := GetOpts()
		testOpts := getDefaultOptions()
		testOpts.withoutEvent = false
		assert.Equal(opts, testOpts)

		// try setting it
		opts = GetOpts(WithoutEvent())
		testOpts.withoutEvent = true
		assert.Equal(opts, testOpts)
	})
}