common_test.go

package mint

import (
	"bytes"
	"encoding/hex"
	"fmt"
	"reflect"
	"runtime"
	"sort"
	"testing"
)

func unhex(h string) []byte {
	b, err := hex.DecodeString(h)
	if err != nil {
		panic(err)
	}
	return b
}

func assertTrue(t *testing.T, test bool, msg string) {
	t.Helper()
	prefix := string("")
	for i := 1; ; i++ {
		_, file, line, ok := runtime.Caller(i)
		if !ok {
			break
		}
		prefix = fmt.Sprintf("%v: %d\n", file, line) + prefix
	}
	if !test {
		t.Fatalf(prefix + msg)
	}
}

func assertError(t *testing.T, err error, msg string) {
	t.Helper()
	assertTrue(t, err != nil, msg)
}

func assertNotError(t *testing.T, err error, msg string) {
	t.Helper()
	if err != nil {
		msg += ": " + err.Error()
	}
	assertTrue(t, err == nil, msg)
}

func assertNil(t *testing.T, x interface{}, msg string) {
	t.Helper()
	assertTrue(t, x == nil, msg)
}

func assertNotNil(t *testing.T, x interface{}, msg string) {
	t.Helper()
	assertTrue(t, x != nil, msg)
}

func assertEquals(t *testing.T, a, b interface{}) {
	t.Helper()
	assertTrue(t, a == b, fmt.Sprintf("%+v != %+v", a, b))
}

func assertByteEquals(t *testing.T, a, b []byte) {
	t.Helper()
	assertTrue(t, bytes.Equal(a, b), fmt.Sprintf("%+v != %+v", hex.EncodeToString(a), hex.EncodeToString(b)))
}

func assertNotByteEquals(t *testing.T, a, b []byte) {
	t.Helper()
	assertTrue(t, !bytes.Equal(a, b), fmt.Sprintf("%+v == %+v", hex.EncodeToString(a), hex.EncodeToString(b)))
}

func assertCipherSuiteParamsEquals(t *testing.T, a, b CipherSuiteParams) {
	t.Helper()
	assertEquals(t, a.Suite, b.Suite)
	// Can't compare AEADFactory values
	assertEquals(t, a.Hash, b.Hash)
	assertEquals(t, len(a.KeyLengths), len(b.KeyLengths))
	for k, v := range a.KeyLengths {
		assertEquals(t, v, b.KeyLengths[k])
	}
}

func assertDeepEquals(t *testing.T, a, b interface{}) {
	t.Helper()
	assertTrue(t, reflect.DeepEqual(a, b), fmt.Sprintf("%+v != %+v", a, b))
}

func assertSameType(t *testing.T, a, b interface{}) {
	t.Helper()
	A := reflect.TypeOf(a)
	B := reflect.TypeOf(b)
	assertTrue(t, A == B, fmt.Sprintf("%s != %s", A.Name(), B.Name()))
}

// Utilities for parametrized tests
// Represents the configuration for a given test instance.
type testInstanceState map[string]string

// Helper function.
func runParametrizedInner(t *testing.T, name string, state testInstanceState, inparams map[string][]string, inparamList []string, f parametrizedTest) {

	paramName := inparamList[0]
	param := inparams[paramName]
	next := inparamList[1:]

	for _, paramVal := range param {
		state[paramName] = paramVal
		var n string
		if len(name) > 0 {
			n = name + "/"
		}
		n = n + paramName + "=" + paramVal

		if len(next) == 0 {
			t.Run(n, func(t *testing.T) {
				f(t, n, state)
			})
			continue
		}
		runParametrizedInner(t, n, state, inparams, next, f)
	}
}

// Nominally public API.
type testParameter struct {
	name string
	vals []string
}

type parametrizedTest func(t *testing.T, name string, p testInstanceState)

// This is the function you call.
func runParametrizedTest(t *testing.T, inparams map[string][]string, f parametrizedTest) {
	// Make a sorted list of the names, so we get a consistent order.
	il := make([]string, 0)
	for k := range inparams {
		il = append(il, k)
	}
	sort.Slice(il, func(i, j int) bool { return il[i] < il[j] })

	runParametrizedInner(t, "", make(map[string]string), inparams, il, f)
}