From 78cbed985f02b52ae8b2734026261f9fafa1a0a0 Mon Sep 17 00:00:00 2001
From: Olaoluwa Osuntokun <laolu32@gmail.com>
Date: Thu, 12 Dec 2024 16:55:03 +0100
Subject: [PATCH] contractcourt: add rapid derived fuzz test for HtlcAuxBlob
In this commit, we add a rapid derived fuzz test for the HtlcAuxBlob
test. This uses the rapid (randomized property testing) into Go's built
in fuzzer. This wrapper will use the fuzz stream, and pass that into
rapid where the stream is used to make structured test inputs which are
tested against the existing properties.
This can be done more widely in the codebase, we pick a simple example
to port first before tackling others.
---
contractcourt/taproot_briefcase_test.go | 30 ++++++++++++++++---------
1 file changed, 20 insertions(+), 10 deletions(-)
diff --git a/contractcourt/taproot_briefcase_test.go b/contractcourt/taproot_briefcase_test.go
index 441aebf1d7..80b504bd54 100644
--- a/contractcourt/taproot_briefcase_test.go
+++ b/contractcourt/taproot_briefcase_test.go
@@ -127,20 +127,30 @@ func TestTaprootBriefcase(t *testing.T) {
require.Equal(t, testCase, &decodedCase)
}
+// testHtlcAuxBlobProperties is a rapid property that verifies the encoding and
+// decoding of the HTLC aux blobs.
+func testHtlcAuxBlobProperties(t *rapid.T) {
+ htlcBlobs := rapid.Make[htlcAuxBlobs]().Draw(t, "htlcAuxBlobs")
+
+ var b bytes.Buffer
+ require.NoError(t, htlcBlobs.Encode(&b))
+
+ decodedBlobs := newAuxHtlcBlobs()
+ require.NoError(t, decodedBlobs.Decode(&b))
+
+ require.Equal(t, htlcBlobs, decodedBlobs)
+}
+
// TestHtlcAuxBlobEncodeDecode tests the encode/decode methods of the HTLC aux
// blobs.
func TestHtlcAuxBlobEncodeDecode(t *testing.T) {
t.Parallel()
- rapid.Check(t, func(t *rapid.T) {
- htlcBlobs := rapid.Make[htlcAuxBlobs]().Draw(t, "htlcAuxBlobs")
-
- var b bytes.Buffer
- require.NoError(t, htlcBlobs.Encode(&b))
-
- decodedBlobs := newAuxHtlcBlobs()
- require.NoError(t, decodedBlobs.Decode(&b))
+ rapid.Check(t, testHtlcAuxBlobProperties)
+}
- require.Equal(t, htlcBlobs, decodedBlobs)
- })
+// FuzzHtlcAuxBlobEncodeDecodeFuzz tests the encode/decode methods of the HTLC
+// aux blobs using the rapid derived fuzzer.
+func FuzzHtlcAuxBlobEncodeDecode(f *testing.F) {
+ f.Fuzz(rapid.MakeFuzz(testHtlcAuxBlobProperties))
}