refactored rpctest

- package `rpctest` is not internal any more
- improved doc

module/eth/chain_id_test.go

@@ -4,8 +4,8 @@ import (
 	"testing"
 
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestChainID(t *testing.T) {

module/eth/gas_price_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestGasPrice(t *testing.T) {

module/eth/get_balance_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestBalance(t *testing.T) {

module/eth/get_block_by_hash_test.go

@@ -11,8 +11,8 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestBlockByHash__1(t *testing.T) {

module/eth/get_block_by_number_test.go

@@ -10,8 +10,8 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestBlockByNumber__1(t *testing.T) {

module/eth/get_code_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestCode(t *testing.T) {

module/eth/get_logs_test.go

@@ -8,8 +8,8 @@ import (
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/google/go-cmp/cmp"
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestLogs(t *testing.T) {

module/eth/get_storage_at_test.go

@@ -5,8 +5,8 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestStorageAt(t *testing.T) {

module/eth/get_transaction_by_hash_test.go

@@ -11,8 +11,8 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestTransactionByHash_Type0(t *testing.T) {

module/eth/get_transaction_count_test.go

@@ -4,8 +4,8 @@ import (
 	"testing"
 
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestNonce(t *testing.T) {

module/eth/get_transaction_receipt_test.go

@@ -11,8 +11,8 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestTransactionReceipt(t *testing.T) {

module/eth/send_raw_transaction_test.go

@@ -7,8 +7,8 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/lmittmann/w3"
-	"github.com/lmittmann/w3/internal/rpctest"
 	"github.com/lmittmann/w3/module/eth"
+	"github.com/lmittmann/w3/rpctest"
 )
 
 func TestSendTransaction(t *testing.T) {

internal/rpctest/server.go → rpctest/server.go

@@ -1,4 +1,4 @@
-// Package rpctest provides utilities for RPC testing.
+// Package rpctest provides utilities for testing RPC methods.
 package rpctest
 
 import (
@@ -13,6 +13,16 @@ import (
 	"testing"
 )
 
+// Server is a fake RPC endpoint that responds only to a single requests that
+// is definded in a golden-file.
+//
+// Request golden-files have the following format to define a single request
+// and the corresponding response:s
+//     // Comments and empty lines will be ignored.
+//     // Request starts with ">".
+//     > [{"jsonrpc":"2.0","id":1,"method":"eth_chainId"}]
+//     // Response starts with "<".
+//     < [{"jsonrpc":"2.0","id":1,"result":"0x1"}]
 type Server struct {
 	t *testing.T
 
@@ -24,6 +34,8 @@ type Server struct {
 	httptestSrv *httptest.Server
 }
 
+// NewServer returns a new instance of Server that serves the golden-file from
+// Reader r.
 func NewServer(t *testing.T, r io.Reader) *Server {
 	srv := &Server{t: t, reader: r}
 	httptestSrv := httptest.NewServer(srv)
@@ -32,6 +44,8 @@ func NewServer(t *testing.T, r io.Reader) *Server {
 	return srv
 }
 
+// NewFileServer returns a new instance of Server that serves the golden-file
+// from the given filename.
 func NewFileServer(t *testing.T, filename string) *Server {
 	f, err := os.Open(filename)
 	if err != nil {
@@ -60,18 +74,21 @@ func (srv *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	w.Write(srv.out)
 }
 
+// URL returns the servers RPC endpoint url.
 func (srv *Server) URL() string {
 	return srv.httptestSrv.URL
 }
 
+// Close shuts down the server.
 func (srv *Server) Close() {
 	srv.httptestSrv.Close()
-	if rc, ok := srv.reader.(io.ReadCloser); ok {
-		rc.Close()
-	}
 }
 
 func (srv *Server) readGolden() {
+	if rc, ok := srv.reader.(io.ReadCloser); ok {
+		defer rc.Close()
+	}
+
 	scan := bufio.NewScanner(srv.reader)
 	for scan.Scan() {
 		line := scan.Bytes()