gitlab.com/SiaPrime/SiaPrime@v1.4.1/modules/miner/splitsetheap_test.go

package miner

import (
	"math/rand"
	"testing"

	"gitlab.com/NebulousLabs/fastrand"
	"gitlab.com/SiaPrime/SiaPrime/types"
)

// TestMapHeapSimple test max-heap and min-heap versions of the MapHeap on the
// same sequence of pushes and pops. The pushes are done in increasing value of
// averageFee (the value by which elements are compared).
func TestMapHeapSimple(t *testing.T) {
	max := &mapHeap{
		selectID: make(map[splitSetID]*mapElement),
		data:     nil,
		size:     0,
		minHeap:  false,
	}
	min := &mapHeap{
		selectID: make(map[splitSetID]*mapElement),
		data:     nil,
		size:     0,
		minHeap:  true,
	}
	max.init()
	min.init()

	randSlice := fastrand.Perm(1000)
	for _, i := range randSlice {
		e1 := &mapElement{
			set: &splitSet{
				averageFee:   types.SiacoinPrecision.Mul64(uint64(i)),
				size:         uint64(10 * i),
				transactions: make([]types.Transaction, 0),
			},

			id:    splitSetID(i),
			index: 0,
		}
		e2 := &mapElement{
			set: &splitSet{
				averageFee:   types.SiacoinPrecision.Mul64(uint64(i)),
				size:         uint64(10 * i),
				transactions: make([]types.Transaction, 0),
			},

			id:    splitSetID(i),
			index: 0,
		}
		max.push(e1)
		min.push(e2)
	}

	for i := 0; i < 1000; i++ {
		maxPop := max.pop()
		minPop := min.pop()

		if int(maxPop.id) != 999-i {
			t.Error("Unexpected splitSetID in result from max-heap pop.")
		}
		if int(minPop.id) != i {
			t.Error("Unexpected splitSetID in result from min-heap pop.")
		}
		if maxPop.set.averageFee.Cmp(types.SiacoinPrecision.Mul64(uint64(999-i))) != 0 {
			t.Error("Unexpected currency value in result from max-heap pop.")
		}
		if minPop.set.averageFee.Cmp(types.SiacoinPrecision.Mul64(uint64(i))) != 0 {
			t.Error("Unexpected currency value in result from min-heap pop.")
		}
	}
}

// TestMapHeapSize tests that the size of MapHeaps changes accordingly with the
// sizes of elements added to it, and with those elements removed from it. Tests
// a max-heap and min-heap on the same sequence of pushes and pops.
func TestMapHeapSize(t *testing.T) {
	max := &mapHeap{
		selectID: make(map[splitSetID]*mapElement),
		data:     nil,
		size:     0,
		minHeap:  false,
	}
	min := &mapHeap{
		selectID: make(map[splitSetID]*mapElement),
		data:     nil,
		size:     0,
		minHeap:  true,
	}
	max.init()
	min.init()

	var expectedSize uint64

	randSlice := fastrand.Perm(1000)
	for _, i := range randSlice {
		e1 := &mapElement{
			set: &splitSet{
				averageFee:   types.SiacoinPrecision.Mul64(uint64(i)),
				size:         uint64(100 * i),
				transactions: make([]types.Transaction, 0),
			},

			id:    splitSetID(i),
			index: 0,
		}
		e2 := &mapElement{
			set: &splitSet{
				averageFee:   types.SiacoinPrecision.Mul64(uint64(i)),
				size:         uint64(100 * i),
				transactions: make([]types.Transaction, 0),
			},

			id:    splitSetID(i),
			index: 0,
		}
		max.push(e1)
		min.push(e2)
		expectedSize += e1.set.size
	}

	if max.size != expectedSize {
		t.Error("Max-heap size different than expected size.")
	}
	if min.size != expectedSize {
		t.Error("Min-heap size different than expected size.")
	}

	for i := 0; i < 1000; i++ {
		maxPop := max.pop()
		minPop := min.pop()

		if maxPop.set.size != uint64(100*(999-i)) {
			t.Error("Unexpected set size in result from max-heap pop.")
		}
		if minPop.set.size != uint64(100*i) {
			t.Error("Unexpected set size in result from min-heap pop.")
		}

	}
}

// TestMapHeapRemoveBySetID pushes a sequence of elements onto a max-heap and
// min-heap. Then it removes a random element using its splitSetID, and checks
// that it has been removed.
func TestMapHeapRemoveBySetID(t *testing.T) {
	max := &mapHeap{
		selectID: make(map[splitSetID]*mapElement),
		data:     nil,
		size:     0,
		minHeap:  false,
	}
	min := &mapHeap{
		selectID: make(map[splitSetID]*mapElement),
		data:     nil,
		size:     0,
		minHeap:  true,
	}
	max.init()
	min.init()

	for i := 0; i < 5000; i++ {
		e1 := &mapElement{
			set: &splitSet{
				averageFee:   types.SiacoinPrecision.Mul64(uint64(i)),
				size:         uint64(10 * i),
				transactions: make([]types.Transaction, 0),
			},

			id:    splitSetID(i),
			index: 0,
		}
		e2 := &mapElement{
			set: &splitSet{
				averageFee:   types.SiacoinPrecision.Mul64(uint64(i)),
				size:         uint64(10 * i),
				transactions: make([]types.Transaction, 0),
			},

			id:    splitSetID(i),
			index: 0,
		}
		max.push(e1)
		min.push(e2)
	}

	randID := splitSetID(rand.Intn(5000))
	firstToBeRemoved := max.selectID[randID]

	// Iterate over data in min heap and max heap to confirm the element to be
	// removed is actually there.
	inMaxHeap := false
	inMinHeap := false
	for _, v := range max.data {
		if v.id == firstToBeRemoved.id {
			inMaxHeap = true
			break
		}
	}
	for _, v := range min.data {
		if v.id == firstToBeRemoved.id {
			inMinHeap = true
			break
		}
	}

	if !inMinHeap || !inMaxHeap {
		t.Error("Element not found in heap(s) before being removed by splitSetID.")
	}
	if max.selectID[randID] == nil || min.selectID[randID] == nil {
		t.Error("Element not found in map(s) before being removed by splitSetID")
	}

	minSizeBefore := min.size
	maxSizeBefore := max.size
	minRemovedSetSize := min.selectID[randID].set.size
	maxRemovedSetSize := max.selectID[randID].set.size

	max.removeSetByID(randID)
	min.removeSetByID(randID)
	minSizeAfter := min.size
	maxSizeAfter := max.size
	if minSizeBefore-minRemovedSetSize != minSizeAfter {
		t.Error("unexpected difference in size after removing from min heap.")
	}
	if maxSizeBefore-maxRemovedSetSize != maxSizeAfter {
		t.Error("unexpected difference in size after removing from max heap.")
	}

	// Iterate over data in min heap and max heap to confirm the element to be
	// removed was actually removed
	removedFromMax := true
	removedFromMin := true
	for _, v := range max.data {
		if v.id == firstToBeRemoved.id {
			removedFromMax = false
			break
		}
	}
	for _, v := range min.data {
		if v.id == firstToBeRemoved.id {
			removedFromMin = false
			break
		}
	}
	if !removedFromMin {
		t.Error("Element found in  min heap(s) after being removed by splitSetID.")
	}
	if !removedFromMax {
		t.Error("Element found in  max heap(s) after being removed by splitSetID.")
	}
	_, inMinMap := min.selectID[randID]
	_, inMaxMap := max.selectID[randID]
	if inMinMap {
		t.Error("Element found in min map(s) after being removed by splitSetID")
	}
	if inMaxMap {
		t.Error("Element found in max map(s) after being removed by splitSetID")
	}
}

// TestMapHeapPeek test the Peek method. First, on an empty heap Peek should
// return false. Then it checks that Peek returns the same result as the next
// Pop.
func TestMapHeapPeek(t *testing.T) {
	max := &mapHeap{
		selectID: make(map[splitSetID]*mapElement),
		data:     nil,
		size:     0,
		minHeap:  false,
	}
	min := &mapHeap{
		selectID: make(map[splitSetID]*mapElement),
		data:     nil,
		size:     0,
		minHeap:  true,
	}
	max.init()
	min.init()

	minSizeBefore := min.size
	maxSizeBefore := max.size

	_, maxNotEmpty := max.peek()
	_, minNotEmpty := min.peek()
	minSizeAfter := min.size
	maxSizeAfter := max.size
	if maxNotEmpty {
		t.Error("Unexpected result from max.Peek(), heap not empty")
	}
	if minNotEmpty {
		t.Error("Unexpected result from max.Peek(), heap not empty")
	}
	if minSizeBefore != minSizeAfter || maxSizeBefore != maxSizeAfter {
		t.Error("expected heap size not to change from peek.")
	}

	for i := 0; i < 10; i++ {
		e1 := &mapElement{
			set: &splitSet{
				averageFee:   types.SiacoinPrecision.Mul64(uint64(i)),
				size:         uint64(10 * i),
				transactions: make([]types.Transaction, 0),
			},

			id:    splitSetID(i),
			index: 0,
		}
		e2 := &mapElement{
			set: &splitSet{
				averageFee:   types.SiacoinPrecision.Mul64(uint64(i)),
				size:         uint64(10 * i),
				transactions: make([]types.Transaction, 0),
			},

			id:    splitSetID(i),
			index: 0,
		}
		max.push(e1)
		min.push(e2)
	}

	for i := 0; i < 10; i++ {
		minSizeBefore := min.size
		maxSizeBefore := max.size

		maxPeek, maxNotEmpty := max.peek()
		minPeek, minNotEmpty := min.peek()
		minSizeAfter := min.size
		maxSizeAfter := max.size
		if minSizeBefore != minSizeAfter || maxSizeBefore != maxSizeAfter {
			t.Error("expected heap size not to change from peek.")
		}
		if !maxNotEmpty {
			t.Error("Unexpected result from max.Peek(), heap empty after pushes")
		}
		if !minNotEmpty {
			t.Error("Unexpected result from max.Peek(), heap empty after pushes")
		}

		maxPop := max.pop()
		minPop := min.pop()
		if int(maxPop.id) != int(maxPeek.id) {
			t.Error("Unexpected splitSetID in result from max-heap Peek.")
		}
		if int(minPop.id) != int(minPeek.id) {
			t.Error("Unexpected splitSetID in result from min-heap Peek.")
		}
		if maxPop.set.averageFee.Cmp(maxPeek.set.averageFee) != 0 {
			t.Error("Unexpected currency value in result from max-heap Peek.")
		}
		if minPop.set.averageFee.Cmp(minPeek.set.averageFee) != 0 {
			t.Error("Unexpected currency value in result from min-heap Peek.")
		}
	}
}