test: cover WAL record and prune watermark decode paths

Author: ongyimeng

consensus/db/codec_test.go

@@ -3,6 +3,7 @@ package db_test
 import (
 	"testing"
 
+	consensusdb "github.com/NethermindEth/juno/consensus/db"
 	"github.com/NethermindEth/juno/consensus/starknet"
 	"github.com/NethermindEth/juno/consensus/types"
 	"github.com/NethermindEth/juno/consensus/types/wal"
@@ -70,6 +71,25 @@ func TestWALRecordsRoundTripThroughReopen(t *testing.T) {
 	assertLoadedEntries(t, walStore, entries)
 }
 
+func TestWALRecordDecodeRejectsMalformedPayloads(t *testing.T) {
+	start := wal.Start(types.Height(1))
+	valid, err := consensusdb.EncodeWALRecordPayload(&start)
+	require.NoError(t, err)
+
+	tests := map[string][]byte{
+		"empty":         {},
+		"unknown kind":  {0xFF},
+		"truncated":     valid[:len(valid)-1],
+		"trailing byte": append(append([]byte(nil), valid...), 0x00),
+	}
+
+	for name, payload := range tests {
+		t.Run(name, func(t *testing.T) {
+			require.Error(t, consensusdb.DecodeWALRecordPayload(payload))
+		})
+	}
+}
+
 func walAddress(v uint64) starknet.Address {
 	return felt.FromUint64[starknet.Address](v)
 }

consensus/db/export_test.go

@@ -2,12 +2,34 @@ package db
 
 import (
 	"github.com/NethermindEth/juno/consensus/starknet"
+	"github.com/NethermindEth/juno/consensus/types"
 )
 
+func LoadPruneWatermark(walDir string) (types.Height, error) {
+	return loadPruneWatermark(walDir)
+}
+
+func WritePruneWatermark(walDir string, height types.Height) error {
+	return writePruneWatermark(walDir, height)
+}
+
 // ForcePendingCleanup primes the store so the next prune flush triggers cleanup.
 func ForcePendingCleanup(
 	walStore TendermintWALStore[starknet.Value, starknet.Hash, starknet.Address],
 ) {
 	walStore.(*tendermintWALStore[starknet.Value, starknet.Hash, starknet.Address]).
 		pruneRecordsSinceCleanup = cleanupPruneRecordInterval - 1
 }
+
+func EncodeWALRecordPayload(entry starknet.WALEntry) ([]byte, error) {
+	envelope := walRecordEnvelope[starknet.Value, starknet.Hash, starknet.Address]{Kind: walRecordEntry}
+	if err := envelope.setEntry(entry); err != nil {
+		return nil, err
+	}
+	return appendWALRecordPayload(nil, envelope)
+}
+
+func DecodeWALRecordPayload(payload []byte) error {
+	_, err := decodeWALRecord[starknet.Value, starknet.Hash, starknet.Address](payload)
+	return err
+}

consensus/db/prune_watermark_test.go

@@ -0,0 +1,52 @@
+package db_test
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	consensusdb "github.com/NethermindEth/juno/consensus/db"
+	"github.com/NethermindEth/juno/consensus/types"
+	"github.com/stretchr/testify/require"
+)
+
+const testPruneWatermarkHeight = types.Height(1)
+
+func TestPruneWatermarkRoundTrips(t *testing.T) {
+	walDir := t.TempDir()
+
+	height, err := consensusdb.LoadPruneWatermark(walDir)
+	require.NoError(t, err)
+	require.Zero(t, height)
+
+	require.NoError(t, consensusdb.WritePruneWatermark(walDir, testPruneWatermarkHeight))
+	height, err = consensusdb.LoadPruneWatermark(walDir)
+	require.NoError(t, err)
+	require.Equal(t, testPruneWatermarkHeight, height)
+}
+
+func TestLoadPruneWatermarkRejectsCorruptFile(t *testing.T) {
+	walDir := t.TempDir()
+	require.NoError(t, consensusdb.WritePruneWatermark(walDir, testPruneWatermarkHeight))
+	validWatermark, err := os.ReadFile(filepath.Join(walDir, "prune-watermark"))
+	require.NoError(t, err)
+
+	wrongHeader := make([]byte, len(validWatermark))
+	copy(wrongHeader, "wrong-header")
+
+	tests := map[string][]byte{
+		"wrong size": []byte("short"),
+		"bad header": wrongHeader,
+	}
+
+	for name, contents := range tests {
+		t.Run(name, func(t *testing.T) {
+			walDir := t.TempDir()
+			path := filepath.Join(walDir, "prune-watermark")
+			require.NoError(t, os.WriteFile(path, contents, 0o644))
+
+			_, err := consensusdb.LoadPruneWatermark(walDir)
+			require.Error(t, err)
+		})
+	}
+}