rpctest

Documentation

Overview

Package rpctest provides utilities for testing RPC methods.

Index

• func RunTestCases[T any](t *testing.T, tests []TestCase[T], opts ...cmp.Option)
• type Server
  • func NewFileServer(t *testing.T, filename string) *Server
  • func NewServer(t *testing.T, r io.Reader) *Server
  • func (srv *Server) Close()
  • func (srv *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (srv *Server) URL() string
• type TestCase

Functions

func RunTestCases

func RunTestCases[T any](t *testing.T, tests []TestCase[T], opts ...cmp.Option)

Types

type Server

type Server struct {
	// contains filtered or unexported fields
}

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:

// 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"}

func NewFileServer

func NewFileServer(t *testing.T, filename string) *Server

NewFileServer returns a new instance of Server that serves the golden-file from the given filename.

func NewServer

func NewServer(t *testing.T, r io.Reader) *Server

NewServer returns a new instance of Server that serves the golden-file from Reader r.

func (*Server) Close

func (srv *Server) Close()

Close shuts down the server.

func (*Server) ServeHTTP

func (srv *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) URL

func (srv *Server) URL() string

URL returns the servers RPC endpoint url.

type TestCase

type TestCase[T any] struct {
	Golden  string                      // File name in local "testdata/" directory without ".golden" extension
	Call    w3types.RPCCallerFactory[T] // Call to test
	WantRet *T                          // Wanted return value of the call
	WantErr error                       // Wanted error of the call
}