// Copyright (c) 2014-2017 The btcsuite developers // Copyright (c) 2015-2017 The Decred developers // Use of this source code is governed by an ISC // license that can be found in the LICENSE file. package btcjson_test import ( "bytes" "encoding/json" "fmt" "reflect" "testing" "github.com/btcsuite/btcd/btcjson" ) // TestChainSvrWsNtfns tests all of the chain server websocket-specific // notifications marshal and unmarshal into valid results include handling of // optional fields being omitted in the marshalled command, while optional // fields with defaults have the default assigned on unmarshalled commands. func TestChainSvrWsNtfns(t *testing.T) { t.Parallel() tests := []struct { name string newNtfn func() (interface{}, error) staticNtfn func() interface{} marshalled string unmarshalled interface{} }{ { name: "blockconnected", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("blockconnected", "123", 100000, 123456789) }, staticNtfn: func() interface{} { return btcjson.NewBlockConnectedNtfn("123", 100000, 123456789) }, marshalled: `{"jsonrpc":"1.0","method":"blockconnected","params":["123",100000,123456789],"id":null}`, unmarshalled: &btcjson.BlockConnectedNtfn{ Hash: "123", Height: 100000, Time: 123456789, }, }, { name: "blockdisconnected", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("blockdisconnected", "123", 100000, 123456789) }, staticNtfn: func() interface{} { return btcjson.NewBlockDisconnectedNtfn("123", 100000, 123456789) }, marshalled: `{"jsonrpc":"1.0","method":"blockdisconnected","params":["123",100000,123456789],"id":null}`, unmarshalled: &btcjson.BlockDisconnectedNtfn{ Hash: "123", Height: 100000, Time: 123456789, }, }, { name: "filteredblockconnected", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("filteredblockconnected", 100000, "header", []string{"tx0", "tx1"}) }, staticNtfn: func() interface{} { return btcjson.NewFilteredBlockConnectedNtfn(100000, "header", []string{"tx0", "tx1"}) }, marshalled: `{"jsonrpc":"1.0","method":"filteredblockconnected","params":[100000,"header",["tx0","tx1"]],"id":null}`, unmarshalled: &btcjson.FilteredBlockConnectedNtfn{ Height: 100000, Header: "header", SubscribedTxs: []string{"tx0", "tx1"}, }, }, { name: "filteredblockdisconnected", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("filteredblockdisconnected", 100000, "header") }, staticNtfn: func() interface{} { return btcjson.NewFilteredBlockDisconnectedNtfn(100000, "header") }, marshalled: `{"jsonrpc":"1.0","method":"filteredblockdisconnected","params":[100000,"header"],"id":null}`, unmarshalled: &btcjson.FilteredBlockDisconnectedNtfn{ Height: 100000, Header: "header", }, }, { name: "recvtx", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("recvtx", "001122", `{"height":100000,"hash":"123","index":0,"time":12345678}`) }, staticNtfn: func() interface{} { blockDetails := btcjson.BlockDetails{ Height: 100000, Hash: "123", Index: 0, Time: 12345678, } return btcjson.NewRecvTxNtfn("001122", &blockDetails) }, marshalled: `{"jsonrpc":"1.0","method":"recvtx","params":["001122",{"height":100000,"hash":"123","index":0,"time":12345678}],"id":null}`, unmarshalled: &btcjson.RecvTxNtfn{ HexTx: "001122", Block: &btcjson.BlockDetails{ Height: 100000, Hash: "123", Index: 0, Time: 12345678, }, }, }, { name: "redeemingtx", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("redeemingtx", "001122", `{"height":100000,"hash":"123","index":0,"time":12345678}`) }, staticNtfn: func() interface{} { blockDetails := btcjson.BlockDetails{ Height: 100000, Hash: "123", Index: 0, Time: 12345678, } return btcjson.NewRedeemingTxNtfn("001122", &blockDetails) }, marshalled: `{"jsonrpc":"1.0","method":"redeemingtx","params":["001122",{"height":100000,"hash":"123","index":0,"time":12345678}],"id":null}`, unmarshalled: &btcjson.RedeemingTxNtfn{ HexTx: "001122", Block: &btcjson.BlockDetails{ Height: 100000, Hash: "123", Index: 0, Time: 12345678, }, }, }, { name: "rescanfinished", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("rescanfinished", "123", 100000, 12345678) }, staticNtfn: func() interface{} { return btcjson.NewRescanFinishedNtfn("123", 100000, 12345678) }, marshalled: `{"jsonrpc":"1.0","method":"rescanfinished","params":["123",100000,12345678],"id":null}`, unmarshalled: &btcjson.RescanFinishedNtfn{ Hash: "123", Height: 100000, Time: 12345678, }, }, { name: "rescanprogress", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("rescanprogress", "123", 100000, 12345678) }, staticNtfn: func() interface{} { return btcjson.NewRescanProgressNtfn("123", 100000, 12345678) }, marshalled: `{"jsonrpc":"1.0","method":"rescanprogress","params":["123",100000,12345678],"id":null}`, unmarshalled: &btcjson.RescanProgressNtfn{ Hash: "123", Height: 100000, Time: 12345678, }, }, { name: "txaccepted", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("txaccepted", "123", 1.5) }, staticNtfn: func() interface{} { return btcjson.NewTxAcceptedNtfn("123", 1.5) }, marshalled: `{"jsonrpc":"1.0","method":"txaccepted","params":["123",1.5],"id":null}`, unmarshalled: &btcjson.TxAcceptedNtfn{ TxID: "123", Amount: 1.5, }, }, { name: "txacceptedverbose", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("txacceptedverbose", `{"hex":"001122","txid":"123","version":1,"locktime":4294967295,"vin":null,"vout":null,"confirmations":0}`) }, staticNtfn: func() interface{} { txResult := btcjson.TxRawResult{ Hex: "001122", Txid: "123", Version: 1, LockTime: 4294967295, Vin: nil, Vout: nil, Confirmations: 0, } return btcjson.NewTxAcceptedVerboseNtfn(txResult) }, marshalled: `{"jsonrpc":"1.0","method":"txacceptedverbose","params":[{"hex":"001122","txid":"123","version":1,"locktime":4294967295,"vin":null,"vout":null}],"id":null}`, unmarshalled: &btcjson.TxAcceptedVerboseNtfn{ RawTx: btcjson.TxRawResult{ Hex: "001122", Txid: "123", Version: 1, LockTime: 4294967295, Vin: nil, Vout: nil, Confirmations: 0, }, }, }, { name: "relevanttxaccepted", newNtfn: func() (interface{}, error) { return btcjson.NewCmd("relevanttxaccepted", "001122") }, staticNtfn: func() interface{} { return btcjson.NewRelevantTxAcceptedNtfn("001122") }, marshalled: `{"jsonrpc":"1.0","method":"relevanttxaccepted","params":["001122"],"id":null}`, unmarshalled: &btcjson.RelevantTxAcceptedNtfn{ Transaction: "001122", }, }, } t.Logf("Running %d tests", len(tests)) for i, test := range tests { // Marshal the notification as created by the new static // creation function. The ID is nil for notifications. marshalled, err := btcjson.MarshalCmd(btcjson.RpcVersion1, nil, test.staticNtfn()) if err != nil { t.Errorf("MarshalCmd #%d (%s) unexpected error: %v", i, test.name, err) continue } if !bytes.Equal(marshalled, []byte(test.marshalled)) { t.Errorf("Test #%d (%s) unexpected marshalled data - "+ "got %s, want %s", i, test.name, marshalled, test.marshalled) continue } // Ensure the notification is created without error via the // generic new notification creation function. cmd, err := test.newNtfn() if err != nil { t.Errorf("Test #%d (%s) unexpected NewCmd error: %v ", i, test.name, err) } // Marshal the notification as created by the generic new // notification creation function. The ID is nil for // notifications. marshalled, err = btcjson.MarshalCmd(btcjson.RpcVersion1, nil, cmd) if err != nil { t.Errorf("MarshalCmd #%d (%s) unexpected error: %v", i, test.name, err) continue } if !bytes.Equal(marshalled, []byte(test.marshalled)) { t.Errorf("Test #%d (%s) unexpected marshalled data - "+ "got %s, want %s", i, test.name, marshalled, test.marshalled) continue } var request btcjson.Request if err := json.Unmarshal(marshalled, &request); err != nil { t.Errorf("Test #%d (%s) unexpected error while "+ "unmarshalling JSON-RPC request: %v", i, test.name, err) continue } cmd, err = btcjson.UnmarshalCmd(&request) if err != nil { t.Errorf("UnmarshalCmd #%d (%s) unexpected error: %v", i, test.name, err) continue } if !reflect.DeepEqual(cmd, test.unmarshalled) { t.Errorf("Test #%d (%s) unexpected unmarshalled command "+ "- got %s, want %s", i, test.name, fmt.Sprintf("(%T) %+[1]v", cmd), fmt.Sprintf("(%T) %+[1]v\n", test.unmarshalled)) continue } } }