contractcourt: switch to table based testCommitSweepResolverDelay

This improves readability since both instances of the test are very
similar.

contractcourt/commit_sweep_resolver_test.go

@@ -1,7 +1,6 @@
 package contractcourt
 
 import (
-	"reflect"
 	"testing"
 	"time"
 
@@ -169,12 +168,13 @@ func TestCommitSweepResolverNoDelay(t *testing.T) {
 	ctx.waitForResult()
 }
 
-// TestCommitSweepResolverDelay tests resolution of a direct commitment output
+// testCommitSweepResolverDelay tests resolution of a direct commitment output
-// that is encumbered by a time lock.
+// that is encumbered by a time lock. sweepErr indicates whether the local node
-func TestCommitSweepResolverDelay(t *testing.T) {
+// fails to sweep the output.
-	t.Parallel()
+func testCommitSweepResolverDelay(t *testing.T, sweepErr error) {
 	defer timeout(t)()
 
+	const sweepProcessInterval = 100 * time.Millisecond
 	amt := int64(100)
 	outpoint := wire.OutPoint{
 		Index: 5,
@@ -192,87 +192,9 @@ func TestCommitSweepResolverDelay(t *testing.T) {
 
 	ctx := newCommitSweepResolverTestContext(t, &res)
 
-	report := ctx.resolver.report()
+	// Setup whether we expect the sweeper to receive a sweep error in this
-	if !reflect.DeepEqual(report, &ContractReport{
+	// test case.
-		Outpoint:     outpoint,
+	ctx.sweeper.sweepErr = sweepErr
-		Type:         ReportOutputUnencumbered,
-		Amount:       btcutil.Amount(amt),
-		LimboBalance: btcutil.Amount(amt),
-	}) {
-		t.Fatal("unexpected resolver report")
-	}
-
-	ctx.resolve()
-
-	ctx.notifier.confChan <- &chainntnfs.TxConfirmation{
-		BlockHeight: testInitialBlockHeight - 1,
-	}
-
-	// Allow resolver to process confirmation.
-	time.Sleep(100 * time.Millisecond)
-
-	// Expect report to be updated.
-	report = ctx.resolver.report()
-	if report.MaturityHeight != testInitialBlockHeight+2 {
-		t.Fatal("report maturity height incorrect")
-	}
-
-	// Notify initial block height. The csv lock is still in effect, so we
-	// don't expect any sweep to happen yet.
-	ctx.notifyEpoch(testInitialBlockHeight)
-
-	select {
-	case <-ctx.sweeper.sweptInputs:
-		t.Fatal("no sweep expected")
-	case <-time.After(100 * time.Millisecond):
-	}
-
-	// A new block arrives. The commit tx confirmed at height -1 and the csv
-	// is 3, so a spend will be valid in the first block after height +1.
-	ctx.notifyEpoch(testInitialBlockHeight + 1)
-
-	<-ctx.sweeper.sweptInputs
-
-	ctx.waitForResult()
-
-	report = ctx.resolver.report()
-	if !reflect.DeepEqual(report, &ContractReport{
-		Outpoint:         outpoint,
-		Type:             ReportOutputUnencumbered,
-		Amount:           btcutil.Amount(amt),
-		RecoveredBalance: btcutil.Amount(amt),
-		MaturityHeight:   testInitialBlockHeight + 2,
-	}) {
-		t.Fatal("unexpected resolver report")
-	}
-}
-
-// TestCommitSweepResolverLocalBreach tests resolution when the local node
-// publishes a breached output (one that is swept by the remote party).
-func TestCommitSweepResolverLocalBreach(t *testing.T) {
-	t.Parallel()
-	defer timeout(t)()
-
-	amt := int64(100)
-	outpoint := wire.OutPoint{
-		Index: 5,
-	}
-	res := lnwallet.CommitOutputResolution{
-		SelfOutputSignDesc: input.SignDescriptor{
-			Output: &wire.TxOut{
-				Value: amt,
-			},
-			WitnessScript: []byte{0},
-		},
-		MaturityDelay: 3,
-		SelfOutPoint:  outpoint,
-	}
-
-	ctx := newCommitSweepResolverTestContext(t, &res)
-
-	// Setup the sweeper so that it returns an error of the output being
-	// already swept.
-	ctx.sweeper.sweepErr = sweep.ErrRemoteSpend
 
 	report := ctx.resolver.report()
 	expectedReport := ContractReport{
@@ -293,7 +215,7 @@ func TestCommitSweepResolverLocalBreach(t *testing.T) {
 	}
 
 	// Allow resolver to process confirmation.
-	time.Sleep(100 * time.Millisecond)
+	time.Sleep(sweepProcessInterval)
 
 	// Expect report to be updated.
 	report = ctx.resolver.report()
@@ -308,7 +230,7 @@ func TestCommitSweepResolverLocalBreach(t *testing.T) {
 	select {
 	case <-ctx.sweeper.sweptInputs:
 		t.Fatal("no sweep expected")
-	case <-time.After(100 * time.Millisecond):
+	case <-time.After(sweepProcessInterval):
 	}
 
 	// A new block arrives. The commit tx confirmed at height -1 and the csv
@@ -319,19 +241,52 @@ func TestCommitSweepResolverLocalBreach(t *testing.T) {
 
 	ctx.waitForResult()
 
+	// If this test case generates a sweep error, we don't expect to be
+	// able to recover anything. This might happen if the local commitment
+	// output was swept by a justice transaction by the remote party.
+	expectedRecoveredBalance := btcutil.Amount(amt)
+	if sweepErr != nil {
+		expectedRecoveredBalance = 0
+	}
+
 	report = ctx.resolver.report()
 	expectedReport = ContractReport{
-		Outpoint:       outpoint,
+		Outpoint:         outpoint,
-		Type:           ReportOutputUnencumbered,
+		Type:             ReportOutputUnencumbered,
-		Amount:         btcutil.Amount(amt),
+		Amount:           btcutil.Amount(amt),
-		MaturityHeight: testInitialBlockHeight + 2,
+		MaturityHeight:   testInitialBlockHeight + 2,
-
+		RecoveredBalance: expectedRecoveredBalance,
-		// RecoveredBalance is zero due to the output having been swept
-		// by the remote party.
-		RecoveredBalance: 0,
 	}
 	if *report != expectedReport {
 		t.Fatalf("unexpected resolver report. want=%v got=%v",
 			expectedReport, report)
 	}
+
+}
+
+// TestCommitSweepResolverDelay tests resolution of a direct commitment output
+// that is encumbered by a time lock.
+func TestCommitSweepResolverDelay(t *testing.T) {
+	t.Parallel()
+
+	testCases := []struct {
+		name     string
+		sweepErr error
+	}{{
+		name:     "success",
+		sweepErr: nil,
+	}, {
+		name:     "remote spend",
+		sweepErr: sweep.ErrRemoteSpend,
+	}}
+
+	for _, tc := range testCases {
+		tc := tc
+		ok := t.Run(tc.name, func(t *testing.T) {
+			testCommitSweepResolverDelay(t, tc.sweepErr)
+		})
+		if !ok {
+			break
+		}
+	}
 }