dcrd/internal/mining/error_test.go

// Copyright (c) 2020-2021 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.

package mining

import (
	"errors"
	"io"
	"testing"
)

// TestErrorKindStringer tests the stringized output for the ErrorKind type.
func TestErrorKindStringer(t *testing.T) {
	tests := []struct {
		in   ErrorKind
		want string
	}{
		{ErrNotEnoughVoters, "ErrNotEnoughVoters"},
		{ErrGetTopBlock, "ErrGetTopBlock"},
		{ErrGettingDifficulty, "ErrGettingDifficulty"},
		{ErrTransactionAppend, "ErrTransactionAppend"},
		{ErrTicketExhaustion, "ErrTicketExhaustion"},
		{ErrCheckConnectBlock, "ErrCheckConnectBlock"},
		{ErrFraudProofIndex, "ErrFraudProofIndex"},
		{ErrFetchTxStore, "ErrFetchTxStore"},
		{ErrCalcCommitmentRoot, "ErrCalcCommitmentRoot"},
		{ErrGetTicketInfo, "ErrGetTicketInfo"},
		{ErrSerializeHeader, "ErrSerializeHeader"},
	}

	for i, test := range tests {
		result := test.in.Error()
		if result != test.want {
			t.Errorf("#%d: got: %s want: %s", i, result, test.want)
			continue
		}
	}
}

// TestError tests the error output for the Error type.
func TestError(t *testing.T) {
	t.Parallel()

	tests := []struct {
		in   Error
		want string
	}{{
		Error{Description: "some error"},
		"some error",
	}, {
		Error{Description: "human-readable error"},
		"human-readable error",
	}}

	for i, test := range tests {
		result := test.in.Error()
		if result != test.want {
			t.Errorf("#%d: got: %s want: %s", i, result, test.want)
			continue
		}
	}
}

// TestErrorKindIsAs ensures both ErrorKind and Error can be identified as being
// a specific error kind via errors.Is and unwrapped via errors.As.
func TestErrorKindIsAs(t *testing.T) {
	tests := []struct {
		name      string
		err       error
		target    error
		wantMatch bool
		wantAs    ErrorKind
	}{{
		name:      "ErrNotEnoughVoters == ErrNotEnoughVoters",
		err:       ErrNotEnoughVoters,
		target:    ErrNotEnoughVoters,
		wantMatch: true,
		wantAs:    ErrNotEnoughVoters,
	}, {
		name:      "Error.ErrNotEnoughVoters == ErrNotEnoughVoters",
		err:       makeError(ErrNotEnoughVoters, ""),
		target:    ErrNotEnoughVoters,
		wantMatch: true,
		wantAs:    ErrNotEnoughVoters,
	}, {
		name:      "Error.ErrNotEnoughVoters == Error.ErrNotEnoughVoters",
		err:       makeError(ErrNotEnoughVoters, ""),
		target:    makeError(ErrNotEnoughVoters, ""),
		wantMatch: true,
		wantAs:    ErrNotEnoughVoters,
	}, {
		name:      "ErrNotEnoughVoters != ErrGetTopBlock",
		err:       ErrNotEnoughVoters,
		target:    ErrGetTopBlock,
		wantMatch: false,
		wantAs:    ErrNotEnoughVoters,
	}, {
		name:      "Error.ErrNotEnoughVoters != ErrGetTopBlock",
		err:       makeError(ErrNotEnoughVoters, ""),
		target:    ErrGetTopBlock,
		wantMatch: false,
		wantAs:    ErrNotEnoughVoters,
	}, {
		name:      "ErrNotEnoughVoters != Error.ErrGetTopBlock",
		err:       ErrNotEnoughVoters,
		target:    makeError(ErrGetTopBlock, ""),
		wantMatch: false,
		wantAs:    ErrNotEnoughVoters,
	}, {
		name:      "Error.ErrNotEnoughVoters != Error.ErrGetTopBlock",
		err:       makeError(ErrNotEnoughVoters, ""),
		target:    makeError(ErrGetTopBlock, ""),
		wantMatch: false,
		wantAs:    ErrNotEnoughVoters,
	}, {
		name:      "Error.ErrNotEnoughVoters != io.EOF",
		err:       makeError(ErrNotEnoughVoters, ""),
		target:    io.EOF,
		wantMatch: false,
		wantAs:    ErrNotEnoughVoters,
	}}

	for _, test := range tests {
		// Ensure the error matches or not depending on the expected result.
		result := errors.Is(test.err, test.target)
		if result != test.wantMatch {
			t.Errorf("%s: incorrect error identification -- got %v, want %v",
				test.name, result, test.wantMatch)
			continue
		}

		// Ensure the underlying error kind can be unwrapped and is the
		// expected kind.
		var kind ErrorKind
		if !errors.As(test.err, &kind) {
			t.Errorf("%s: unable to unwrap to error kind", test.name)
			continue
		}
		if kind != test.wantAs {
			t.Errorf("%s: unexpected unwrapped error kind -- got %v, want %v",
				test.name, kind, test.wantAs)
			continue
		}
	}
}