Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(SPV-1169) testabilities for record transaction outline #761

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+327 −115
Open

feat(SPV-1169) testabilities for record transaction outline #761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
88b46e0
feat(SPV-1169): testabilities for record transaction outline
chris-4chain Nov 8, 2024
7581865
chore(SPV-1169): ErrorAssert
chris-4chain Nov 14, 2024
b4bf7a3
chore(SPV-1169): addressing Wojtek's comments
chris-4chain Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 101 additions & 88 deletions engine/transaction/record/record_outline_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,14 @@ import (

"github.com/bitcoin-sv/go-sdk/script"
"github.com/bitcoin-sv/spv-wallet/engine/database"
"github.com/bitcoin-sv/spv-wallet/engine/tester"
"github.com/bitcoin-sv/spv-wallet/engine/tester/fixtures"
"github.com/bitcoin-sv/spv-wallet/engine/transaction"
txerrors "github.com/bitcoin-sv/spv-wallet/engine/transaction/errors"
"github.com/bitcoin-sv/spv-wallet/engine/transaction/outlines"
"github.com/bitcoin-sv/spv-wallet/engine/transaction/record"
"github.com/bitcoin-sv/spv-wallet/engine/transaction/record/testabilities"
"github.com/bitcoin-sv/spv-wallet/models/bsv"
"github.com/bitcoin-sv/spv-wallet/models/transaction/bucket"
"github.com/pkg/errors"
"github.com/stretchr/testify/require"
)

const (
Expand All @@ -37,27 +36,31 @@ func givenTxWithOpReturnWithoutOPFalse(t *testing.T) fixtures.GivenTXSpec {
)
}

func givenStandardOpReturnOutline(t *testing.T) *outlines.Transaction {
return &outlines.Transaction{
BEEF: givenTXWithOpReturn(t).BEEF(),
Annotations: transaction.Annotations{
Outputs: transaction.OutputsAnnotations{
0: &transaction.OutputAnnotation{
Bucket: bucket.Data,
},
},
},
}
}

func TestRecordOutlineOpReturn(t *testing.T) {
tests := map[string]struct {
repo *mockRepository
storedUTXOs []bsv.Outpoint
outline *outlines.Transaction
expectTxID string
expectOutputs []database.Output
expectData []database.Data
}{
"RecordTransactionOutline for op_return": {
repo: newMockRepository().withUTXO(givenTXWithOpReturn(t).InputUTXO(0)),
outline: &outlines.Transaction{
BEEF: givenTXWithOpReturn(t).BEEF(),
Annotations: transaction.Annotations{
Outputs: transaction.OutputsAnnotations{
0: &transaction.OutputAnnotation{
Bucket: bucket.Data,
},
},
},
},
expectTxID: givenTXWithOpReturn(t).ID(),
storedUTXOs: []bsv.Outpoint{givenTXWithOpReturn(t).InputUTXO(0)},
outline: givenStandardOpReturnOutline(t),
expectTxID: givenTXWithOpReturn(t).ID(),
expectOutputs: []database.Output{
{
TxID: givenTXWithOpReturn(t).InputUTXO(0).TxID,
Expand All @@ -79,7 +82,7 @@ func TestRecordOutlineOpReturn(t *testing.T) {
},
},
"RecordTransactionOutline for op_return without leading OP_FALSE": {
repo: newMockRepository().withUTXO(givenTxWithOpReturnWithoutOPFalse(t).InputUTXO(0)),
storedUTXOs: []bsv.Outpoint{givenTxWithOpReturnWithoutOPFalse(t).InputUTXO(0)},
outline: &outlines.Transaction{
BEEF: givenTxWithOpReturnWithoutOPFalse(t).BEEF(),
Annotations: transaction.Annotations{
Expand Down Expand Up @@ -112,18 +115,9 @@ func TestRecordOutlineOpReturn(t *testing.T) {
},
},
"RecordTransactionOutline for op_return with untracked utxo as inputs": {
repo: newMockRepository(),
outline: &outlines.Transaction{
BEEF: givenTXWithOpReturn(t).BEEF(),
Annotations: transaction.Annotations{
Outputs: transaction.OutputsAnnotations{
0: &transaction.OutputAnnotation{
Bucket: bucket.Data,
},
},
},
},
expectTxID: givenTXWithOpReturn(t).ID(),
storedUTXOs: []bsv.Outpoint{},
outline: givenStandardOpReturnOutline(t),
expectTxID: givenTXWithOpReturn(t).ID(),
expectOutputs: []database.Output{{
TxID: givenTXWithOpReturn(t).ID(),
Vout: 0,
Expand All @@ -140,25 +134,20 @@ func TestRecordOutlineOpReturn(t *testing.T) {
for name, test := range tests {
t.Run(name, func(t *testing.T) {
// given:
broadcaster := newMockBroadcaster()
repo := test.repo
service := record.NewService(tester.Logger(t), repo, broadcaster)
given, then := testabilities.New(t)
service := given.WithStoredUTXO(test.storedUTXOs...).NewRecordService()

// when:
err := service.RecordTransactionOutline(context.Background(), test.outline)

// then:
require.NoError(t, err)
then.WithNoError(err).
Broadcasted(test.expectTxID).
StoredAsBroadcasted(test.expectTxID)

require.Contains(t, broadcaster.broadcastedTxs, test.expectTxID)

require.Contains(t, repo.transactions, test.expectTxID)
txEntry := repo.transactions[test.expectTxID]
require.Equal(t, test.expectTxID, repo.transactions[test.expectTxID].ID)
require.Equal(t, database.TxStatusBroadcasted, txEntry.TxStatus)

require.Subset(t, repo.getAllOutputs(), test.expectOutputs)
require.Subset(t, repo.getAllData(), test.expectData)
then.
StoredOutputs(test.expectOutputs).
StoredData(test.expectData)
})
}
}
Expand All @@ -185,30 +174,26 @@ func TestRecordOutlineOpReturnErrorCases(t *testing.T) {
WithP2PKHOutput(1)

tests := map[string]struct {
repo *mockRepository
outline *outlines.Transaction
broadcaster *mockBroadcaster
expectErr error
storedOutputs []database.Output
outline *outlines.Transaction
expectErr error
}{
"RecordTransactionOutline for not signed transaction": {
broadcaster: newMockBroadcaster(),
repo: newMockRepository(),
storedOutputs: []database.Output{},
outline: &outlines.Transaction{
BEEF: givenUnsignedTX.BEEF(),
},
expectErr: txerrors.ErrTxValidation,
},
"RecordTransactionOutline for not a BEEF hex": {
broadcaster: newMockBroadcaster(),
repo: newMockRepository(),
storedOutputs: []database.Output{},
outline: &outlines.Transaction{
BEEF: notABeefHex,
},
expectErr: txerrors.ErrTxValidation,
},
"RecordTransactionOutline for invalid OP_ZERO after OP_RETURN": {
broadcaster: newMockBroadcaster(),
repo: newMockRepository(),
storedOutputs: []database.Output{},
outline: &outlines.Transaction{
BEEF: givenTxWithOpZeroAfterOpReturn.BEEF(),
Annotations: transaction.Annotations{
Expand All @@ -222,20 +207,18 @@ func TestRecordOutlineOpReturnErrorCases(t *testing.T) {
expectErr: txerrors.ErrOnlyPushDataAllowed,
},
"Tx with already spent utxo": {
broadcaster: newMockBroadcaster(),
repo: newMockRepository().withOutput(database.Output{
storedOutputs: []database.Output{{
TxID: givenTXWithOpReturn(t).InputUTXO(0).TxID,
Vout: givenTXWithOpReturn(t).InputUTXO(0).Vout,
SpendingTX: ptr("05aa91319c773db18071310ecd5ddc15d3aa4242b55705a13a66f7fefe2b80a1"),
}),
}},
outline: &outlines.Transaction{
BEEF: givenTXWithOpReturn(t).BEEF(),
},
expectErr: txerrors.ErrUTXOSpent,
},
"Vout out of range in annotation": {
broadcaster: newMockBroadcaster(),
repo: newMockRepository(),
storedOutputs: []database.Output{},
outline: &outlines.Transaction{
BEEF: givenTXWithOpReturn(t).BEEF(),
Annotations: transaction.Annotations{
Expand All @@ -249,8 +232,7 @@ func TestRecordOutlineOpReturnErrorCases(t *testing.T) {
expectErr: txerrors.ErrAnnotationIndexOutOfRange,
},
"Vout as negative value in annotation": {
broadcaster: newMockBroadcaster(),
repo: newMockRepository(),
storedOutputs: []database.Output{},
outline: &outlines.Transaction{
BEEF: givenTXWithOpReturn(t).BEEF(),
Annotations: transaction.Annotations{
Expand All @@ -264,8 +246,7 @@ func TestRecordOutlineOpReturnErrorCases(t *testing.T) {
expectErr: txerrors.ErrAnnotationIndexConversion,
},
"no-op_return output annotated as data": {
broadcaster: newMockBroadcaster(),
repo: newMockRepository(),
storedOutputs: []database.Output{},
outline: &outlines.Transaction{
BEEF: givenTxWithP2PKHOutput.BEEF(),
Annotations: transaction.Annotations{
Expand All @@ -278,46 +259,78 @@ func TestRecordOutlineOpReturnErrorCases(t *testing.T) {
},
expectErr: txerrors.ErrAnnotationMismatch,
},
"error during broadcasting": {
broadcaster: newMockBroadcaster().withError(errors.New("broadcast error")),
repo: newMockRepository().withOutput(database.Output{
TxID: givenTXWithOpReturn(t).InputUTXO(0).TxID,
Vout: givenTXWithOpReturn(t).InputUTXO(0).Vout,
}),
outline: &outlines.Transaction{
BEEF: givenTXWithOpReturn(t).BEEF(),
Annotations: transaction.Annotations{
Outputs: transaction.OutputsAnnotations{
0: &transaction.OutputAnnotation{
Bucket: bucket.Data,
},
},
},
},
expectErr: txerrors.ErrTxBroadcast,
},
}
for name, test := range tests {
t.Run(name, func(t *testing.T) {
// given:
service := record.NewService(tester.Logger(t), test.repo, test.broadcaster)
initialOutputs := test.repo.getAllOutputs()
initialData := test.repo.getAllData()
given, then := testabilities.New(t)
service := given.WithStoredOutputs(test.storedOutputs...).NewRecordService()

// when:
err := service.RecordTransactionOutline(context.Background(), test.outline)

// then:
require.Error(t, err)
require.ErrorIs(t, err, test.expectErr)

// ensure that no changes were made to the repository
require.ElementsMatch(t, initialOutputs, test.repo.getAllOutputs())
require.ElementsMatch(t, initialData, test.repo.getAllData())
then.WithErrorIs(err, test.expectErr).NothingChanged()
})
}
}

func TestOnBroadcastErr(t *testing.T) {
wregulski marked this conversation as resolved.
Show resolved Hide resolved
// given:
given, then := testabilities.New(t)
service := given.
WithStoredOutputs(database.Output{
TxID: givenTXWithOpReturn(t).InputUTXO(0).TxID,
Vout: givenTXWithOpReturn(t).InputUTXO(0).Vout,
SpendingTX: nil,
}).
WillFailOnBroadcast(errors.New("broadcast error")).
NewRecordService()

// and:
outline := givenStandardOpReturnOutline(t)

// when:
err := service.RecordTransactionOutline(context.Background(), outline)

// then:
then.WithErrorIs(err, txerrors.ErrTxBroadcast).NothingChanged()
}

func TestOnSaveTXErr(t *testing.T) {
// given:
given, then := testabilities.New(t)
service := given.
WillFailOnSaveTX(errors.New("saveTX error")).
NewRecordService()

// and:
outline := givenStandardOpReturnOutline(t)

// when:
err := service.RecordTransactionOutline(context.Background(), outline)

// then:
then.WithErrorIs(err, txerrors.ErrSavingData).NothingChanged()
}

func TestOnGetOutputsErr(t *testing.T) {
// given:
given, then := testabilities.New(t)
service := given.
WillFailOnGetOutputs(errors.New("getOutputs error")).
NewRecordService()

// and:
outline := givenStandardOpReturnOutline(t)

// when:
err := service.RecordTransactionOutline(context.Background(), outline)

// then:
then.WithErrorIs(err, txerrors.ErrGettingOutputs).NothingChanged()
}

func ptr[T any](value T) *T {
return &value
}
8 changes: 8 additions & 0 deletions engine/transaction/record/testabilities/ability_record_outline.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package testabilities

import "testing"

func New(t testing.TB) (RecordServiceFixture, RecordOutlineAssert) {
g := given(t)
return g, then(t, g)
}
Loading
Loading