Decouple non-test and test code

This commit moves tests to test package to improve decoupling.
onflow · Feb 7, 2025 · ae1d976 · ae1d976
1 parent b08becc
commit ae1d976
Show file tree

Hide file tree

Showing 16 changed files with 4,060 additions and 4,041 deletions.
diff --git a/array.go b/array.go
@@ -3300,6 +3300,10 @@ func (a *Array) getMutableElementIndexCount() int {
 	return len(a.mutableElementIndex)
 }
 
+func (a *Array) getMutableElementIndex() map[ValueID]uint64 {
+	return a.mutableElementIndex
+}
+
 // Storable returns array a as either:
 // - SlabIDStorable, or
 // - inlined data slab storable

diff --git a/array_bench_test.go b/array_bench_test.go
@@ -16,17 +16,19 @@
  * limitations under the License.
  */
 
-package atree
+package atree_test
 
 import (
 	"math/rand"
 	"testing"
 
 	"github.com/stretchr/testify/require"
+
+	"github.com/onflow/atree"
 )
 
-var noopValue Value
-var noopStorable Storable
+var noopValue atree.Value
+var noopStorable atree.Storable
 
 func BenchmarkArrayGet100x(b *testing.B) {
 	benchmarks := []struct {
@@ -186,13 +188,13 @@ func BenchmarkNewArrayFromBatchData(b *testing.B) {
 	}
 }
 
-func setupArray(b *testing.B, r *rand.Rand, storage *PersistentSlabStorage, initialArrayCount int) *Array {
+func setupArray(b *testing.B, r *rand.Rand, storage *atree.PersistentSlabStorage, initialArrayCount int) *atree.Array {
 
-	address := Address{1, 2, 3, 4, 5, 6, 7, 8}
+	address := atree.Address{1, 2, 3, 4, 5, 6, 7, 8}
 
 	typeInfo := testTypeInfo{42}
 
-	array, err := NewArray(storage, address, typeInfo)
+	array, err := atree.NewArray(storage, address, typeInfo)
 	require.NoError(b, err)
 
 	for i := 0; i < initialArrayCount; i++ {
@@ -208,7 +210,7 @@ func setupArray(b *testing.B, r *rand.Rand, storage *PersistentSlabStorage, init
 
 	storage.DropCache()
 
-	newArray, err := NewArrayWithRootID(storage, arrayID)
+	newArray, err := atree.NewArrayWithRootID(storage, arrayID)
 	require.NoError(b, err)
 
 	return newArray
@@ -224,7 +226,7 @@ func benchmarkArrayGet(b *testing.B, initialArrayCount, numberOfOps int) {
 
 	array := setupArray(b, r, storage, initialArrayCount)
 
-	var value Value
+	var value atree.Value
 
 	b.StartTimer()
 
@@ -293,7 +295,7 @@ func benchmarkArrayRemoveAll(b *testing.B, initialArrayCount int) {
 
 	storage := newTestPersistentStorage(b)
 
-	var storable Storable
+	var storable atree.Storable
 
 	for i := 0; i < b.N; i++ {
 
@@ -319,7 +321,7 @@ func benchmarkArrayPopIterate(b *testing.B, initialArrayCount int) {
 
 	storage := newTestPersistentStorage(b)
 
-	var storable Storable
+	var storable atree.Storable
 
 	for i := 0; i < b.N; i++ {
 
@@ -329,7 +331,7 @@ func benchmarkArrayPopIterate(b *testing.B, initialArrayCount int) {
 
 		b.StartTimer()
 
-		err := array.PopIterate(func(s Storable) {
+		err := array.PopIterate(func(s atree.Storable) {
 			storable = s
 		})
 		if err != nil {
@@ -353,9 +355,9 @@ func benchmarkNewArrayFromAppend(b *testing.B, initialArrayCount int) {
 	b.StartTimer()
 
 	for i := 0; i < b.N; i++ {
-		copied, _ := NewArray(storage, array.Address(), array.Type())
+		copied, _ := atree.NewArray(storage, array.Address(), array.Type())
 
-		_ = array.IterateReadOnly(func(value Value) (bool, error) {
+		_ = array.IterateReadOnly(func(value atree.Value) (bool, error) {
 			_ = copied.Append(value)
 			return true, nil
 		})
@@ -382,7 +384,7 @@ func benchmarkNewArrayFromBatchData(b *testing.B, initialArrayCount int) {
 		iter, err := array.ReadOnlyIterator()
 		require.NoError(b, err)
 
-		copied, _ := NewArrayFromBatchData(storage, array.Address(), array.Type(), func() (Value, error) {
+		copied, _ := atree.NewArrayFromBatchData(storage, array.Address(), array.Type(), func() (atree.Value, error) {
 			return iter.Next()
 		})
 

diff --git a/array_benchmark_test.go b/array_benchmark_test.go
@@ -16,14 +16,16 @@
  * limitations under the License.
  */
 
-package atree
+package atree_test
 
 import (
 	"math/rand"
 	"testing"
 	"time"
 
 	"github.com/stretchr/testify/require"
+
+	"github.com/onflow/atree"
 )
 
 // GENERAL COMMENT:
@@ -48,7 +50,7 @@ func BenchmarkXXLArray(b *testing.B) { benchmarkArray(b, 10_000_000, opCount) }
 func BenchmarkXXXLArray(b *testing.B) { benchmarkArray(b, 100_000_000, opCount) }
 
 // TODO add nested arrays as class 5
-func RandomValue(r *rand.Rand) Value {
+func RandomValue(r *rand.Rand) atree.Value {
 	switch r.Intn(4) {
 	case 0:
 		return Uint8Value(r.Intn(255))
@@ -70,11 +72,11 @@ func benchmarkArray(b *testing.B, initialArrayCount, numberOfElements int) {
 
 	storage := newTestPersistentStorage(b)
 
-	address := Address{1, 2, 3, 4, 5, 6, 7, 8}
+	address := atree.Address{1, 2, 3, 4, 5, 6, 7, 8}
 
 	typeInfo := testTypeInfo{42}
 
-	array, err := NewArray(storage, address, typeInfo)
+	array, err := atree.NewArray(storage, address, typeInfo)
 
 	require.NoError(b, err)
 
@@ -88,7 +90,7 @@ func benchmarkArray(b *testing.B, initialArrayCount, numberOfElements int) {
 	// setup
 	for i := 0; i < initialArrayCount; i++ {
 		v := RandomValue(r)
-		storable, err := v.Storable(storage, array.Address(), MaxInlineArrayElementSize())
+		storable, err := v.Storable(storage, array.Address(), atree.MaxInlineArrayElementSize())
 		require.NoError(b, err)
 		totalRawDataSize += storable.ByteSize()
 		err = array.Append(v)
@@ -102,12 +104,12 @@ func benchmarkArray(b *testing.B, initialArrayCount, numberOfElements int) {
 	// append
 	storage.DropCache()
 	start = time.Now()
-	array, err = NewArrayWithRootID(storage, arrayID)
+	array, err = atree.NewArrayWithRootID(storage, arrayID)
 	require.NoError(b, err)
 	for i := 0; i < numberOfElements; i++ {
 		v := RandomValue(r)
 
-		storable, err := v.Storable(storage, array.Address(), MaxInlineArrayElementSize())
+		storable, err := v.Storable(storage, array.Address(), atree.MaxInlineArrayElementSize())
 		require.NoError(b, err)
 
 		totalRawDataSize += storable.ByteSize()
@@ -121,7 +123,7 @@ func benchmarkArray(b *testing.B, initialArrayCount, numberOfElements int) {
 	// remove
 	storage.DropCache()
 	start = time.Now()
-	array, err = NewArrayWithRootID(storage, arrayID)
+	array, err = atree.NewArrayWithRootID(storage, arrayID)
 	require.NoError(b, err)
 
 	for i := 0; i < numberOfElements; i++ {
@@ -136,14 +138,14 @@ func benchmarkArray(b *testing.B, initialArrayCount, numberOfElements int) {
 	// insert
 	storage.DropCache()
 	start = time.Now()
-	array, err = NewArrayWithRootID(storage, arrayID)
+	array, err = atree.NewArrayWithRootID(storage, arrayID)
 	require.NoError(b, err)
 
 	for i := 0; i < numberOfElements; i++ {
 		ind := r.Intn(int(array.Count()))
 		v := RandomValue(r)
 
-		storable, err := v.Storable(storage, array.Address(), MaxInlineArrayElementSize())
+		storable, err := v.Storable(storage, array.Address(), atree.MaxInlineArrayElementSize())
 		require.NoError(b, err)
 
 		totalRawDataSize += storable.ByteSize()
@@ -157,7 +159,7 @@ func benchmarkArray(b *testing.B, initialArrayCount, numberOfElements int) {
 	// lookup
 	storage.DropCache()
 	start = time.Now()
-	array, err = NewArrayWithRootID(storage, arrayID)
+	array, err = atree.NewArrayWithRootID(storage, arrayID)
 	require.NoError(b, err)
 
 	for i := 0; i < numberOfElements; i++ {
@@ -168,12 +170,12 @@ func benchmarkArray(b *testing.B, initialArrayCount, numberOfElements int) {
 	require.NoError(b, storage.Commit())
 	totalLookupTime = time.Since(start)
 
-	baseStorage := GetBaseStorage(storage)
+	baseStorage := atree.GetBaseStorage(storage)
 
 	// random lookup
 	baseStorage.ResetReporter()
 	storage.DropCache()
-	array, err = NewArrayWithRootID(storage, arrayID)
+	array, err = atree.NewArrayWithRootID(storage, arrayID)
 	require.NoError(b, err)
 
 	ind := r.Intn(int(array.Count()))
@@ -203,11 +205,11 @@ func benchmarkLongTermImpactOnMemory(b *testing.B, initialArrayCount, numberOfOp
 
 	storage := newTestPersistentStorage(b)
 
-	address := Address{1, 2, 3, 4, 5, 6, 7, 8}
+	address := atree.Address{1, 2, 3, 4, 5, 6, 7, 8}
 
 	typeInfo := testTypeInfo{42}
 
-	array, err := NewArray(storage, address, typeInfo)
+	array, err := atree.NewArray(storage, address, typeInfo)
 
 	require.NoError(b, err)
 
@@ -217,7 +219,7 @@ func benchmarkLongTermImpactOnMemory(b *testing.B, initialArrayCount, numberOfOp
 	for i := 0; i < initialArrayCount; i++ {
 		v := RandomValue(r)
 
-		storable, err := v.Storable(storage, array.Address(), MaxInlineArrayElementSize())
+		storable, err := v.Storable(storage, array.Address(), atree.MaxInlineArrayElementSize())
 		require.NoError(b, err)
 
 		totalRawDataSize += storable.ByteSize()
@@ -239,7 +241,7 @@ func benchmarkLongTermImpactOnMemory(b *testing.B, initialArrayCount, numberOfOp
 		case 1: // insert
 			v := RandomValue(r)
 
-			storable, err := v.Storable(storage, array.Address(), MaxInlineArrayElementSize())
+			storable, err := v.Storable(storage, array.Address(), atree.MaxInlineArrayElementSize())
 			require.NoError(b, err)
 
 			totalRawDataSize += storable.ByteSize()
@@ -250,7 +252,7 @@ func benchmarkLongTermImpactOnMemory(b *testing.B, initialArrayCount, numberOfOp
 	}
 	require.NoError(b, storage.Commit())
 
-	baseStorage := GetBaseStorage(storage)
+	baseStorage := atree.GetBaseStorage(storage)
 
 	storageOverheadRatio := float64(baseStorage.Size()) / float64(totalRawDataSize)
 	b.ReportMetric(float64(baseStorage.SegmentsTouched()), "segments_touched")