Merge pull request #150 from cloudstruct/test/localtxsubmission-message-unit-tests

test: encode/decode unit tests for localtxsubmission messages

Author: agaffney

cmd/go-ouroboros-network/localtxsubmission.go

@@ -13,15 +13,17 @@ import (
 )
 
 type localTxSubmissionFlags struct {
-	flagset *flag.FlagSet
-	txFile  string
+	flagset   *flag.FlagSet
+	txFile    string
+	rawTxFile string
 }
 
 func newLocalTxSubmissionFlags() *localTxSubmissionFlags {
 	f := &localTxSubmissionFlags{
 		flagset: flag.NewFlagSet("local-tx-submission", flag.ExitOnError),
 	}
 	f.flagset.StringVar(&f.txFile, "tx-file", "", "path to the JSON transaction file to submit")
+	f.flagset.StringVar(&f.rawTxFile, "raw-tx-file", "", "path to the raw transaction file to submit")
 	return f
 }
 
@@ -36,6 +38,10 @@ func testLocalTxSubmission(f *globalFlags) {
 		fmt.Printf("failed to parse subcommand args: %s\n", err)
 		os.Exit(1)
 	}
+	if localTxSubmissionFlags.txFile == "" && localTxSubmissionFlags.rawTxFile == "" {
+		fmt.Printf("you must specify -tx-file or -raw-tx-file\n")
+		os.Exit(1)
+	}
 
 	conn := createClientConnection(f)
 	errorChan := make(chan error)
@@ -60,23 +66,32 @@ func testLocalTxSubmission(f *globalFlags) {
 	}
 	o.LocalTxSubmission.Client.Start()
 
-	txData, err := ioutil.ReadFile(localTxSubmissionFlags.txFile)
-	if err != nil {
-		fmt.Printf("Failed to load transaction file: %s\n", err)
-		os.Exit(1)
-	}
+	var txBytes []byte
+	if localTxSubmissionFlags.txFile != "" {
+		txData, err := ioutil.ReadFile(localTxSubmissionFlags.txFile)
+		if err != nil {
+			fmt.Printf("Failed to load transaction file: %s\n", err)
+			os.Exit(1)
+		}
 
-	var jsonData map[string]string
-	err = json.Unmarshal(txData, &jsonData)
-	if err != nil {
-		fmt.Printf("failed to parse transaction file: %s\n", err)
-		os.Exit(1)
-	}
+		var jsonData map[string]string
+		err = json.Unmarshal(txData, &jsonData)
+		if err != nil {
+			fmt.Printf("failed to parse transaction file: %s\n", err)
+			os.Exit(1)
+		}
 
-	txBytes, err := hex.DecodeString(jsonData["cborHex"])
-	if err != nil {
-		fmt.Printf("failed to decode transaction: %s\n", err)
-		os.Exit(1)
+		txBytes, err = hex.DecodeString(jsonData["cborHex"])
+		if err != nil {
+			fmt.Printf("failed to decode transaction: %s\n", err)
+			os.Exit(1)
+		}
+	} else {
+		txBytes, err = ioutil.ReadFile(localTxSubmissionFlags.rawTxFile)
+		if err != nil {
+			fmt.Printf("Failed to load transaction file: %s\n", err)
+			os.Exit(1)
+		}
 	}
 
 	if err = o.LocalTxSubmission.Client.SubmitTx(ledger.TX_TYPE_ALONZO, txBytes); err != nil {

protocol/localtxsubmission/messages_test.go

@@ -2,9 +2,12 @@ package localtxsubmission
 
 import (
 	"encoding/hex"
+	"fmt"
+	"github.com/cloudstruct/go-cardano-ledger"
 	"github.com/cloudstruct/go-ouroboros-network/protocol"
 	"github.com/cloudstruct/go-ouroboros-network/utils"
 	"reflect"
+	"strings"
 	"testing"
 )
 
@@ -14,8 +17,41 @@ type testDefinition struct {
 	MessageType uint
 }
 
-// TODO: implement tests for more messages
+// Helper function to allow inline hex decoding without capturing the error
+func hexDecode(data string) []byte {
+	// Strip off any leading/trailing whitespace in hex string
+	data = strings.TrimSpace(data)
+	decoded, err := hex.DecodeString(data)
+	if err != nil {
+		panic(fmt.Sprintf("error decoding hex: %s", err))
+	}
+	return decoded
+}
+
+// Valid CBOR that serves as a placeholder for real TX content in the tests
+// [h'DEADBEEF']
+var placeholderTx = hexDecode("8144DEADBEEF")
+
+// Valid CBOR that serves as a placeholder for TX rejection errors
+// [2, 4]
+var placeholderRejectError = hexDecode("820204")
+
 var tests = []testDefinition{
+	{
+		CborHex:     fmt.Sprintf("82008204d81846%x", placeholderTx),
+		MessageType: MESSAGE_TYPE_SUBMIT_TX,
+		Message:     NewMsgSubmitTx(ledger.TX_TYPE_ALONZO, placeholderTx),
+	},
+	{
+		CborHex:     "8101",
+		Message:     NewMsgAcceptTx(),
+		MessageType: MESSAGE_TYPE_ACCEPT_TX,
+	},
+	{
+		CborHex:     fmt.Sprintf("8202%x", placeholderRejectError),
+		MessageType: MESSAGE_TYPE_REJECT_TX,
+		Message:     NewMsgRejectTx(placeholderRejectError),
+	},
 	{
 		CborHex:     "8103",
 		Message:     NewMsgDone(),