github.com/avahowell/sia@v0.5.1-beta.0.20160524050156-83dcc3d37c94/types/target_test.go

package types

import (
	"math/big"
	"testing"

	"github.com/NebulousLabs/Sia/crypto"
)

// TestTargetAdd probes the Add function of the target type.
func TestTargetAdd(t *testing.T) {
	var target3, target5, target10 Target
	target3[crypto.HashSize-1] = 3
	target5[crypto.HashSize-1] = 5
	target10[crypto.HashSize-1] = 10

	expect5 := target10.AddDifficulties(target10)
	if expect5 != target5 {
		t.Error("Target.Add not working as expected")
	}
	expect3 := target10.AddDifficulties(target5)
	if expect3 != target3 {
		t.Error("Target.Add not working as expected")
	}
}

// TestTargetCmp probes the Cmp function of the target type.
func TestTargetCmp(t *testing.T) {
	var target1, target2 Target
	target1[crypto.HashSize-1] = 1
	target2[crypto.HashSize-1] = 2

	if target1.Cmp(target2) != -1 {
		t.Error("Target.Cmp not behaving as expected")
	}
	if target2.Cmp(target2) != 0 {
		t.Error("Target.Cmp not behaving as expected")
	}
	if target2.Cmp(target1) != 1 {
		t.Error("Target.Cmp not behaving as expected")
	}
}

// TestTargetDifficulty probes the Difficulty function of the target type.
func TestTargetDifficulty(t *testing.T) {
	var target1, target2, target3 Target
	target2[crypto.HashSize-1] = 1
	target3[crypto.HashSize-1] = 2

	expDifficulty1 := NewCurrency(RootDepth.Int())
	expDifficulty2 := NewCurrency(RootDepth.Int())
	expDifficulty3 := NewCurrency(RootDepth.Int()).Div(NewCurrency64(2))

	if difficulty := target1.Difficulty(); difficulty.Cmp(expDifficulty1) != 0 {
		t.Errorf("Expected difficulty %v, got %v", expDifficulty1, difficulty)
	}
	if difficulty := target2.Difficulty(); difficulty.Cmp(expDifficulty2) != 0 {
		t.Errorf("Expected difficulty %v, got %v", expDifficulty2, difficulty)
	}
	if difficulty := target3.Difficulty(); difficulty.Cmp(expDifficulty3) != 0 {
		t.Errorf("Expected difficulty %v, got %v", expDifficulty3, difficulty)
	}
}

// TestTargetInt probes the Int function of the target type.
func TestTargetInt(t *testing.T) {
	var target Target
	target[crypto.HashSize-1] = 1

	b := target.Int()
	if b.Cmp(big.NewInt(1)) != 0 {
		t.Error("Target.Int did not work correctly")
	}
}

// TestTargetIntToTarget probes the IntToTarget function of the target type.
func TestTargetIntToTarget(t *testing.T) {
	var target Target
	target[crypto.HashSize-1] = 5
	b := big.NewInt(5)
	if IntToTarget(b) != target {
		t.Error("IntToTarget not working as expected")
	}
}

// TestTargetInverse probes the Inverse function of the target type.
func TestTargetInverse(t *testing.T) {
	var target Target
	target[crypto.HashSize-1] = 2

	r := target.Inverse()
	if r.Num().Cmp(big.NewInt(1)) != 0 {
		t.Error("Target.Rat did not work as expected")
	}
	if r.Denom().Cmp(big.NewInt(2)) != 0 {
		t.Error("Target.Rat did not work as expected")
	}
}

// TestTargetMul probes the Mul function of the target type.
func TestTargetMul(t *testing.T) {
	var target2, target6, target10, target14, target20 Target
	target2[crypto.HashSize-1] = 2
	target6[crypto.HashSize-1] = 6
	target10[crypto.HashSize-1] = 10
	target14[crypto.HashSize-1] = 14
	target20[crypto.HashSize-1] = 20

	// Multiplying the difficulty of a target at '10' by 5 will yield a target
	// of '2'. Similar math follows for the remaining checks.
	expect2 := target10.MulDifficulty(big.NewRat(5, 1))
	if expect2 != target2 {
		t.Error(expect2)
		t.Error(target2)
		t.Error("Target.Mul did not work as expected")
	}
	expect6 := target10.MulDifficulty(big.NewRat(3, 2))
	if expect6 != target6 {
		t.Error("Target.Mul did not work as expected")
	}
	expect14 := target10.MulDifficulty(big.NewRat(7, 10))
	if expect14 != target14 {
		t.Error("Target.Mul did not work as expected")
	}
	expect20 := target10.MulDifficulty(big.NewRat(1, 2))
	if expect20 != target20 {
		t.Error("Target.Mul did not work as expected")
	}
}

// TestTargetRat probes the Rat function of the target type.
func TestTargetRat(t *testing.T) {
	var target Target
	target[crypto.HashSize-1] = 3

	r := target.Rat()
	if r.Num().Cmp(big.NewInt(3)) != 0 {
		t.Error("Target.Rat did not work as expected")
	}
	if r.Denom().Cmp(big.NewInt(1)) != 0 {
		t.Error("Target.Rat did not work as expected")
	}
}

// TestTargetOverflow checks that IntToTarget will return a maximum target if
// there is an overflow.
func TestTargetOverflow(t *testing.T) {
	largeInt := new(big.Int).Lsh(big.NewInt(1), 260)
	expectRoot := IntToTarget(largeInt)
	if expectRoot != RootDepth {
		t.Error("IntToTarget does not properly handle overflows")
	}
}

// TestTargetNegativeIntToTarget tries to create a negative target using
// IntToTarget.
func TestTargetNegativeIntToTarget(t *testing.T) {
	if testing.Short() {
		t.SkipNow()
	}

	// In debug mode, attempting to create a negative target should trigger a
	// panic.
	defer func() {
		r := recover()
		if r != ErrNegativeTarget {
			t.Error("no panic occurred when trying to create a negative target")
		}
	}()
	b := big.NewInt(-3)
	_ = IntToTarget(b)
}

// TestTargetNegativeRatToTarget tries to create a negative target using
// RatToTarget.
func TestTargetNegativeRatToTarget(t *testing.T) {
	if testing.Short() {
		t.SkipNow()
	}

	// In debug mode, attempting to create a negative target should trigger a
	// panic.
	defer func() {
		r := recover()
		if r != ErrNegativeTarget {
			t.Error("no panic occurred when trying to create a negative target")
		}
	}()
	r := big.NewRat(3, -5)
	_ = RatToTarget(r)
}