Merge #4112

4112: [Randmomness part 5] update math/rand usage in ledger r=tarakby a=tarakby

 ( result of splitting #4052 into several PRs)
  
  - prepare for Go1.20 update by removing deprecated `math/rand` functions `Seed` and `Read`.

Co-authored-by: Tarak Ben Youssef <[email protected]>
Co-authored-by: Tarak Ben Youssef <[email protected]>

Author: 3 people

ledger/common/bitutils/utils_test.go

@@ -1,6 +1,7 @@
 package bitutils
 
 import (
+	crand "crypto/rand"
 	"math/big"
 	"math/bits"
 	"math/rand"
@@ -9,6 +10,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestBitVectorAllocation(t *testing.T) {
@@ -38,7 +40,6 @@ func Test_PaddedByteSliceLength(t *testing.T) {
 func TestBitTools(t *testing.T) {
 	seed := time.Now().UnixNano()
 	t.Logf("rand seed is %d", seed)
-	rand.Seed(seed)
 	r := rand.NewSource(seed)
 
 	const maxBits = 131 * 8 // upper bound of indices to test
@@ -71,7 +72,8 @@ func TestBitTools(t *testing.T) {
 	t.Run("testing WriteBit", func(t *testing.T) {
 		b.SetInt64(0)
 		bytes := MakeBitVector(maxBits)
-		rand.Read(bytes) // fill bytes with random values to verify that writing to each individual bit works
+		_, err := crand.Read(bytes) // fill bytes with random values to verify that writing to each individual bit works
+		require.NoError(t, err)
 
 		// build a random big bit by bit
 		for idx := 0; idx < maxBits; idx++ {
@@ -91,7 +93,8 @@ func TestBitTools(t *testing.T) {
 	t.Run("testing ClearBit and SetBit", func(t *testing.T) {
 		b.SetInt64(0)
 		bytes := MakeBitVector(maxBits)
-		rand.Read(bytes) // fill bytes with random values to verify that writing to each individual bit works
+		_, err := crand.Read(bytes) // fill bytes with random values to verify that writing to each individual bit works
+		require.NoError(t, err)
 
 		// build a random big bit by bit
 		for idx := 0; idx < maxBits; idx++ {

ledger/common/hash/hash_test.go

@@ -1,24 +1,20 @@
 package hash_test
 
 import (
-	"math/rand"
+	"crypto/rand"
 	"testing"
-	"time"
 
 	"golang.org/x/crypto/sha3"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	cryhash "github.com/onflow/flow-go/crypto/hash"
 	"github.com/onflow/flow-go/ledger"
 	"github.com/onflow/flow-go/ledger/common/hash"
 )
 
 func TestHash(t *testing.T) {
-	r := time.Now().UnixNano()
-	rand.Seed(r)
-	t.Logf("math rand seed is %d", r)
-
 	t.Run("lengthSanity", func(t *testing.T) {
 		assert.Equal(t, 32, hash.HashLen)
 	})
@@ -28,8 +24,10 @@ func TestHash(t *testing.T) {
 
 		for i := 0; i < 5000; i++ {
 			value := make([]byte, i)
-			rand.Read(path[:])
-			rand.Read(value)
+			_, err := rand.Read(path[:])
+			require.NoError(t, err)
+			_, err = rand.Read(value)
+			require.NoError(t, err)
 			h := hash.HashLeaf(path, value)
 
 			hasher := sha3.New256()
@@ -44,8 +42,10 @@ func TestHash(t *testing.T) {
 		var h1, h2 hash.Hash
 
 		for i := 0; i < 5000; i++ {
-			rand.Read(h1[:])
-			rand.Read(h2[:])
+			_, err := rand.Read(h1[:])
+			require.NoError(t, err)
+			_, err = rand.Read(h2[:])
+			require.NoError(t, err)
 			h := hash.HashInterNode(h1, h2)
 
 			hasher := sha3.New256()
@@ -94,8 +94,8 @@ func Test_ComputeCompactValue(t *testing.T) {
 func BenchmarkHash(b *testing.B) {
 
 	var h1, h2 hash.Hash
-	rand.Read(h1[:])
-	rand.Read(h2[:])
+	_, _ = rand.Read(h1[:])
+	_, _ = rand.Read(h2[:])
 
 	// customized sha3 for ledger
 	b.Run("LedgerSha3", func(b *testing.B) {

ledger/common/testutils/testutils.go

@@ -1,6 +1,7 @@
 package testutils
 
 import (
+	crand "crypto/rand"
 	"encoding/binary"
 	"encoding/hex"
 	"fmt"
@@ -151,7 +152,10 @@ func RandomPaths(n int) []l.Path {
 	i := 0
 	for i < n {
 		var path l.Path
-		rand.Read(path[:])
+		_, err := crand.Read(path[:])
+		if err != nil {
+			panic("randomness failed")
+		}
 		// deduplicate
 		if _, found := alreadySelectPaths[path]; !found {
 			paths = append(paths, path)
@@ -166,11 +170,17 @@ func RandomPaths(n int) []l.Path {
 func RandomPayload(minByteSize int, maxByteSize int) *l.Payload {
 	keyByteSize := minByteSize + rand.Intn(maxByteSize-minByteSize)
 	keydata := make([]byte, keyByteSize)
-	rand.Read(keydata)
+	_, err := crand.Read(keydata)
+	if err != nil {
+		panic("randomness failed")
+	}
 	key := l.Key{KeyParts: []l.KeyPart{{Type: 0, Value: keydata}}}
 	valueByteSize := minByteSize + rand.Intn(maxByteSize-minByteSize)
 	valuedata := make([]byte, valueByteSize)
-	rand.Read(valuedata)
+	_, err = crand.Read(valuedata)
+	if err != nil {
+		panic("random generation failed")
+	}
 	value := l.Value(valuedata)
 	return l.NewPayload(key, value)
 }
@@ -196,7 +206,10 @@ func RandomValues(n int, minByteSize, maxByteSize int) []l.Value {
 			byteSize = minByteSize + rand.Intn(maxByteSize-minByteSize)
 		}
 		value := make([]byte, byteSize)
-		rand.Read(value)
+		_, err := rand.Read(value)
+		if err != nil {
+			panic("random generation failed")
+		}
 		values = append(values, value)
 	}
 	return values
@@ -218,7 +231,10 @@ func RandomUniqueKeys(n, m, minByteSize, maxByteSize int) []l.Key {
 				byteSize = minByteSize + rand.Intn(maxByteSize-minByteSize)
 			}
 			keyPartData := make([]byte, byteSize)
-			rand.Read(keyPartData)
+			_, err := crand.Read(keyPartData)
+			if err != nil {
+				panic("random generation failed")
+			}
 			keyParts = append(keyParts, l.NewKeyPart(uint16(j), keyPartData))
 		}
 		key := l.NewKey(keyParts)

ledger/complete/ledger_benchmark_test.go

@@ -2,7 +2,6 @@ package complete_test
 
 import (
 	"math"
-	"math/rand"
 	"testing"
 	"time"
 
@@ -40,8 +39,6 @@ func benchmarkStorage(steps int, b *testing.B) {
 		checkpointsToKeep  = 1
 	)
 
-	rand.Seed(time.Now().UnixNano())
-
 	dir := b.TempDir()
 
 	diskWal, err := wal.NewDiskWAL(zerolog.Nop(), nil, metrics.NewNoopCollector(), dir, steps+1, pathfinder.PathByteSize, wal.SegmentSize)
@@ -155,8 +152,6 @@ func BenchmarkTrieUpdate(b *testing.B) {
 		checkpointsToKeep  = 1
 	)
 
-	rand.Seed(1)
-
 	dir := b.TempDir()
 
 	diskWal, err := wal.NewDiskWAL(zerolog.Nop(), nil, metrics.NewNoopCollector(), dir, capacity, pathfinder.PathByteSize, wal.SegmentSize)
@@ -209,8 +204,6 @@ func BenchmarkTrieRead(b *testing.B) {
 		checkpointsToKeep  = 1
 	)
 
-	rand.Seed(1)
-
 	dir := b.TempDir()
 
 	diskWal, err := wal.NewDiskWAL(zerolog.Nop(), nil, metrics.NewNoopCollector(), dir, capacity, pathfinder.PathByteSize, wal.SegmentSize)
@@ -272,8 +265,6 @@ func BenchmarkLedgerGetOneValue(b *testing.B) {
 		checkpointsToKeep  = 1
 	)
 
-	rand.Seed(1)
-
 	dir := b.TempDir()
 
 	diskWal, err := wal.NewDiskWAL(zerolog.Nop(), nil, metrics.NewNoopCollector(), dir, capacity, pathfinder.PathByteSize, wal.SegmentSize)
@@ -352,8 +343,6 @@ func BenchmarkTrieProve(b *testing.B) {
 		checkpointsToKeep  = 1
 	)
 
-	rand.Seed(1)
-
 	dir := b.TempDir()
 
 	diskWal, err := wal.NewDiskWAL(zerolog.Nop(), nil, metrics.NewNoopCollector(), dir, capacity, pathfinder.PathByteSize, wal.SegmentSize)

ledger/complete/ledger_test.go

@@ -7,7 +7,6 @@ import (
 	"math"
 	"math/rand"
 	"testing"
-	"time"
 
 	"github.com/rs/zerolog"
 	"github.com/stretchr/testify/assert"
@@ -591,7 +590,6 @@ func TestLedgerFunctionality(t *testing.T) {
 		checkpointsToKeep  = 1
 	)
 
-	rand.Seed(time.Now().UnixNano())
 	// You can manually increase this for more coverage
 	experimentRep := 2
 	metricsCollector := &metrics.NoopCollector{}

ledger/complete/mtrie/flattener/encoding_test.go

@@ -2,6 +2,7 @@ package flattener_test
 
 import (
 	"bytes"
+	crand "crypto/rand"
 	"errors"
 	"fmt"
 	"math/rand"
@@ -160,7 +161,8 @@ func TestRandomLeafNodeEncodingDecoding(t *testing.T) {
 		height := rand.Intn(257)
 
 		var hashValue hash.Hash
-		rand.Read(hashValue[:])
+		_, err := crand.Read(hashValue[:])
+		require.NoError(t, err)
 
 		n := node.NewNode(height, nil, nil, paths[i], payloads[i], hashValue)
 

ledger/complete/mtrie/forest_test.go

@@ -783,7 +783,6 @@ func TestRandomUpdateReadProofValueSizes(t *testing.T) {
 	rep := 10
 	maxNumPathsPerStep := 10
 	seed := time.Now().UnixNano()
-	rand.Seed(seed)
 	t.Log(seed)
 
 	forest, err := NewForest(5, &metrics.NoopCollector{}, nil)

ledger/complete/mtrie/trie/trie_test.go

@@ -5,10 +5,8 @@ import (
 	"encoding/binary"
 	"encoding/hex"
 	"math"
-	"math/rand"
 	"sort"
 	"testing"
-	"time"
 
 	"github.com/stretchr/testify/require"
 	"gotest.tools/assert"
@@ -354,9 +352,7 @@ func deduplicateWrites(paths []ledger.Path, payloads []ledger.Payload) ([]ledger
 }
 
 func TestSplitByPath(t *testing.T) {
-	seed := time.Now().UnixNano()
-	t.Logf("rand seed is %d", seed)
-	rand.Seed(seed)
+	rand := unittest.GetPRG(t)
 
 	const pathsNumber = 100
 	const redundantPaths = 10
@@ -367,7 +363,8 @@ func TestSplitByPath(t *testing.T) {
 	paths := make([]ledger.Path, 0, pathsNumber)
 	for i := 0; i < pathsNumber-redundantPaths; i++ {
 		var p ledger.Path
-		rand.Read(p[:])
+		_, err := rand.Read(p[:])
+		require.NoError(t, err)
 		paths = append(paths, p)
 	}
 	for i := 0; i < redundantPaths; i++ {
@@ -490,6 +487,7 @@ func Test_DifferentiateEmptyVsLeaf(t *testing.T) {
 }
 
 func Test_Pruning(t *testing.T) {
+	rand := unittest.GetPRG(t)
 	emptyTrie := trie.NewEmptyMTrie()
 
 	path1 := testutils.PathByUint16(1 << 12)       // 000100...
@@ -655,7 +653,8 @@ func Test_Pruning(t *testing.T) {
 
 			for i := 0; i < numberOfUpdates; {
 				var path ledger.Path
-				rand.Read(path[:])
+				_, err := rand.Read(path[:])
+				require.NoError(t, err)
 				// deduplicate
 				if _, found := allPaths[path]; !found {
 					payload := testutils.RandomPayload(1, 100)

ledger/complete/mtrie/trieCache_test.go

@@ -6,7 +6,7 @@ package mtrie
 // test across boundry
 
 import (
-	"math/rand"
+	"crypto/rand"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -174,10 +174,16 @@ func TestConcurrentAccess(t *testing.T) {
 
 func randomMTrie() (*trie.MTrie, error) {
 	var randomPath ledger.Path
-	rand.Read(randomPath[:])
+	_, err := rand.Read(randomPath[:])
+	if err != nil {
+		return nil, err
+	}
 
 	var randomHashValue hash.Hash
-	rand.Read(randomHashValue[:])
+	_, err = rand.Read(randomHashValue[:])
+	if err != nil {
+		return nil, err
+	}
 
 	root := node.NewNode(256, nil, nil, randomPath, nil, randomHashValue)
 

ledger/complete/wal/checkpoint_v6_test.go

@@ -3,10 +3,10 @@ package wal
 import (
 	"bufio"
 	"bytes"
+	"crypto/rand"
 	"errors"
 	"fmt"
 	"io"
-	"math/rand"
 	"os"
 	"path"
 	"path/filepath"
@@ -87,7 +87,10 @@ func createSimpleTrie(t *testing.T) []*trie.MTrie {
 
 func randPathPayload() (ledger.Path, ledger.Payload) {
 	var path ledger.Path
-	rand.Read(path[:])
+	_, err := rand.Read(path[:])
+	if err != nil {
+		panic("randomness failed")
+	}
 	payload := testutils.RandomPayload(1, 100)
 	return path, *payload
 }
@@ -220,10 +223,16 @@ func TestEncodeSubTrie(t *testing.T) {
 
 func randomNode() *node.Node {
 	var randomPath ledger.Path
-	rand.Read(randomPath[:])
+	_, err := rand.Read(randomPath[:])
+	if err != nil {
+		panic("randomness failed")
+	}
 
 	var randomHashValue hash.Hash
-	rand.Read(randomHashValue[:])
+	_, err = rand.Read(randomHashValue[:])
+	if err != nil {
+		panic("randomness failed")
+	}
 
 	return node.NewNode(256, nil, nil, randomPath, nil, randomHashValue)
 }