Added integration test; Modified the examples to reflect changes

Signed-off-by: Adam Brinckman <[email protected]>

Author: abrinckm

Fab3_Instructions.md

@@ -294,7 +294,7 @@ curl http://127.0.0.1:5000 -X POST -H "Content-Type:application/json" -d '{
     "gasUsed": 0,
     "cumulativeGasUsed": 0,
     "to": "",
-    "logs": null,
+    "logs": [],
     "status": "0x1",
     "from": "0xa6e427512d418a9f8f1277dff45a1942236005d3"
   },

fab3/types/types.go

@@ -200,6 +200,17 @@ type Log struct {
 	Index       string   `json:"logIndex"`
 }
 
+// MarshalJSON will json marshal the transaction receipt and set Logs to an empty []Log if none returned
+func (txReceipt *TxReceipt) MarshalJSON() ([]byte, error) {
+	receipt := *txReceipt
+
+	if receipt.Logs == nil {
+		receipt.Logs = []Log{}
+	}
+
+	return json.Marshal(receipt)
+}
+
 // Transaction represents an ethereum evm transaction.
 //
 // https://github.com/ethereum/wiki/wiki/JSON-RPC#returns-28

fab3/types/types_test.go

@@ -213,6 +213,35 @@ var _ = Describe("Types JSON Marshaling and Unmarshaling", func() {
 			[]byte(`{"blockHash":"0x1234567", "blockNumber":"", "to":"", "input":"","transactionIndex":"", "hash":"", "gasPrice":"0x0", "value":"0x0"}`)),
 	)
 
+	DescribeTable("TxReceipt MarshalJSON",
+		func(txReceipt TxReceipt, bytes []byte) {
+			marshalledData, err := txReceipt.MarshalJSON()
+			Expect(err).ToNot(HaveOccurred())
+
+			var target TxReceipt
+			err = json.Unmarshal(marshalledData, &target)
+			Expect(err).ToNot(HaveOccurred())
+
+			var expectedReceipt TxReceipt
+			err = json.Unmarshal(bytes, &expectedReceipt)
+			Expect(err).ToNot(HaveOccurred())
+
+			Expect(target).To(Equal(expectedReceipt))
+		},
+
+		Entry("empty receipt object",
+			TxReceipt{},
+			[]byte(`{"transactionHash":"","transactionIndex":"","blockHash":"","blockNumber":"","gasUsed":0,"cumulativeGasUsed":0,"to":"","logs":[],"status":"","from":""}`)),
+
+		Entry("non-empty receipt object",
+			TxReceipt{Status: "0x1", TransactionHash: "0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b", CumulativeGasUsed: 314159, GasUsed: 30234},
+			[]byte(`{"transactionHash":"0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b","transactionIndex":"","blockHash":"","blockNumber":"","gasUsed":30234,"cumulativeGasUsed":314159,"to":"","logs":[],"status":"0x1","from":""}`)),
+
+		Entry("non-empty logs field",
+			TxReceipt{Logs: make([]Log, 1), Status: "0x1", TransactionHash: "0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b", CumulativeGasUsed: 314159, GasUsed: 30234},
+			[]byte(`{"transactionHash":"0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b","transactionIndex":"","blockHash":"","blockNumber":"","gasUsed":30234,"cumulativeGasUsed":314159,"to":"","contractAddress":"","gasUsed":30234,"cumulativeGasUsed":314159,"to":"","logs":[{"address":"","topics":null,"blockNumber":"","transactionHash":"","transactionIndex":"","blockHash":"","logIndex":""}],"status":"0x1","from":""}`)),
+	)
+
 	DescribeTable("Block MarshalJSON",
 		func(blk Block, bytes []byte) {
 			By("copying the original struct")

integration/fab3/fab3_test.go

@@ -131,6 +131,7 @@ var _ = Describe("Fab3", func() {
 
 		receipt := rpcResp.Result
 
+		Expect(receipt.Logs).ToNot(BeNil())
 		checkHexEncoded(receipt.ContractAddress)
 		Expect(receipt.TransactionHash).To(Equal("0x" + txHash))
 		checkHexEncoded(receipt.BlockNumber)