123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352 |
- // Copyright 2020 The go-ethereum Authors
- // This file is part of the go-ethereum library.
- //
- // The go-ethereum library is free software: you can redistribute it and/or modify
- // it under the terms of the GNU Lesser General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // The go-ethereum library is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Lesser General Public License for more details.
- //
- // You should have received a copy of the GNU Lesser General Public License
- // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
- package node
- import (
- "bytes"
- "io"
- "net"
- "net/http"
- "net/url"
- "strings"
- "testing"
- "github.com/ethereum/go-ethereum/rpc"
- "github.com/stretchr/testify/assert"
- )
- // This test uses the admin_startRPC and admin_startWS APIs,
- // checking whether the HTTP server is started correctly.
- func TestStartRPC(t *testing.T) {
- type test struct {
- name string
- cfg Config
- fn func(*testing.T, *Node, *privateAdminAPI)
- // Checks. These run after the node is configured and all API calls have been made.
- wantReachable bool // whether the HTTP server should be reachable at all
- wantHandlers bool // whether RegisterHandler handlers should be accessible
- wantRPC bool // whether JSON-RPC/HTTP should be accessible
- wantWS bool // whether JSON-RPC/WS should be accessible
- }
- tests := []test{
- {
- name: "all off",
- cfg: Config{},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- },
- wantReachable: false,
- wantHandlers: false,
- wantRPC: false,
- wantWS: false,
- },
- {
- name: "rpc enabled through config",
- cfg: Config{HTTPHost: "127.0.0.1"},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- },
- wantReachable: true,
- wantHandlers: true,
- wantRPC: true,
- wantWS: false,
- },
- {
- name: "rpc enabled through API",
- cfg: Config{},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- _, err := api.StartHTTP(sp("127.0.0.1"), ip(0), nil, nil, nil)
- assert.NoError(t, err)
- },
- wantReachable: true,
- wantHandlers: true,
- wantRPC: true,
- wantWS: false,
- },
- {
- name: "rpc start again after failure",
- cfg: Config{},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- // Listen on a random port.
- listener, err := net.Listen("tcp", "127.0.0.1:0")
- if err != nil {
- t.Fatal("can't listen:", err)
- }
- defer listener.Close()
- port := listener.Addr().(*net.TCPAddr).Port
- // Now try to start RPC on that port. This should fail.
- _, err = api.StartHTTP(sp("127.0.0.1"), ip(port), nil, nil, nil)
- if err == nil {
- t.Fatal("StartHTTP should have failed on port", port)
- }
- // Try again after unblocking the port. It should work this time.
- listener.Close()
- _, err = api.StartHTTP(sp("127.0.0.1"), ip(port), nil, nil, nil)
- assert.NoError(t, err)
- },
- wantReachable: true,
- wantHandlers: true,
- wantRPC: true,
- wantWS: false,
- },
- {
- name: "rpc stopped through API",
- cfg: Config{HTTPHost: "127.0.0.1"},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- _, err := api.StopHTTP()
- assert.NoError(t, err)
- },
- wantReachable: false,
- wantHandlers: false,
- wantRPC: false,
- wantWS: false,
- },
- {
- name: "rpc stopped twice",
- cfg: Config{HTTPHost: "127.0.0.1"},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- _, err := api.StopHTTP()
- assert.NoError(t, err)
- _, err = api.StopHTTP()
- assert.NoError(t, err)
- },
- wantReachable: false,
- wantHandlers: false,
- wantRPC: false,
- wantWS: false,
- },
- {
- name: "ws enabled through config",
- cfg: Config{WSHost: "127.0.0.1"},
- wantReachable: true,
- wantHandlers: false,
- wantRPC: false,
- wantWS: true,
- },
- {
- name: "ws enabled through API",
- cfg: Config{},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- _, err := api.StartWS(sp("127.0.0.1"), ip(0), nil, nil)
- assert.NoError(t, err)
- },
- wantReachable: true,
- wantHandlers: false,
- wantRPC: false,
- wantWS: true,
- },
- {
- name: "ws stopped through API",
- cfg: Config{WSHost: "127.0.0.1"},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- _, err := api.StopWS()
- assert.NoError(t, err)
- },
- wantReachable: false,
- wantHandlers: false,
- wantRPC: false,
- wantWS: false,
- },
- {
- name: "ws stopped twice",
- cfg: Config{WSHost: "127.0.0.1"},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- _, err := api.StopWS()
- assert.NoError(t, err)
- _, err = api.StopWS()
- assert.NoError(t, err)
- },
- wantReachable: false,
- wantHandlers: false,
- wantRPC: false,
- wantWS: false,
- },
- {
- name: "ws enabled after RPC",
- cfg: Config{HTTPHost: "127.0.0.1"},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- wsport := n.http.port
- _, err := api.StartWS(sp("127.0.0.1"), ip(wsport), nil, nil)
- assert.NoError(t, err)
- },
- wantReachable: true,
- wantHandlers: true,
- wantRPC: true,
- wantWS: true,
- },
- {
- name: "ws enabled after RPC then stopped",
- cfg: Config{HTTPHost: "127.0.0.1"},
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- wsport := n.http.port
- _, err := api.StartWS(sp("127.0.0.1"), ip(wsport), nil, nil)
- assert.NoError(t, err)
- _, err = api.StopWS()
- assert.NoError(t, err)
- },
- wantReachable: true,
- wantHandlers: true,
- wantRPC: true,
- wantWS: false,
- },
- {
- name: "rpc stopped with ws enabled",
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- _, err := api.StartHTTP(sp("127.0.0.1"), ip(0), nil, nil, nil)
- assert.NoError(t, err)
- wsport := n.http.port
- _, err = api.StartWS(sp("127.0.0.1"), ip(wsport), nil, nil)
- assert.NoError(t, err)
- _, err = api.StopHTTP()
- assert.NoError(t, err)
- },
- wantReachable: false,
- wantHandlers: false,
- wantRPC: false,
- wantWS: false,
- },
- {
- name: "rpc enabled after ws",
- fn: func(t *testing.T, n *Node, api *privateAdminAPI) {
- _, err := api.StartWS(sp("127.0.0.1"), ip(0), nil, nil)
- assert.NoError(t, err)
- wsport := n.http.port
- _, err = api.StartHTTP(sp("127.0.0.1"), ip(wsport), nil, nil, nil)
- assert.NoError(t, err)
- },
- wantReachable: true,
- wantHandlers: true,
- wantRPC: true,
- wantWS: true,
- },
- }
- for _, test := range tests {
- test := test
- t.Run(test.name, func(t *testing.T) {
- t.Parallel()
- // Apply some sane defaults.
- config := test.cfg
- // config.Logger = testlog.Logger(t, log.LvlDebug)
- config.P2P.NoDiscovery = true
- // Create Node.
- stack, err := New(&config)
- if err != nil {
- t.Fatal("can't create node:", err)
- }
- defer stack.Close()
- // Register the test handler.
- stack.RegisterHandler("test", "/test", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Write([]byte("OK"))
- }))
- if err := stack.Start(); err != nil {
- t.Fatal("can't start node:", err)
- }
- // Run the API call hook.
- if test.fn != nil {
- test.fn(t, stack, &privateAdminAPI{stack})
- }
- // Check if the HTTP endpoints are available.
- baseURL := stack.HTTPEndpoint()
- reachable := checkReachable(baseURL)
- handlersAvailable := checkBodyOK(baseURL + "/test")
- rpcAvailable := checkRPC(baseURL)
- wsAvailable := checkRPC(strings.Replace(baseURL, "http://", "ws://", 1))
- if reachable != test.wantReachable {
- t.Errorf("HTTP server is %sreachable, want it %sreachable", not(reachable), not(test.wantReachable))
- }
- if handlersAvailable != test.wantHandlers {
- t.Errorf("RegisterHandler handlers %savailable, want them %savailable", not(handlersAvailable), not(test.wantHandlers))
- }
- if rpcAvailable != test.wantRPC {
- t.Errorf("HTTP RPC %savailable, want it %savailable", not(rpcAvailable), not(test.wantRPC))
- }
- if wsAvailable != test.wantWS {
- t.Errorf("WS RPC %savailable, want it %savailable", not(wsAvailable), not(test.wantWS))
- }
- })
- }
- }
- // checkReachable checks if the TCP endpoint in rawurl is open.
- func checkReachable(rawurl string) bool {
- u, err := url.Parse(rawurl)
- if err != nil {
- panic(err)
- }
- conn, err := net.Dial("tcp", u.Host)
- if err != nil {
- return false
- }
- conn.Close()
- return true
- }
- // checkBodyOK checks whether the given HTTP URL responds with 200 OK and body "OK".
- func checkBodyOK(url string) bool {
- resp, err := http.Get(url)
- if err != nil {
- return false
- }
- defer resp.Body.Close()
- if resp.StatusCode != 200 {
- return false
- }
- buf := make([]byte, 2)
- if _, err = io.ReadFull(resp.Body, buf); err != nil {
- return false
- }
- return bytes.Equal(buf, []byte("OK"))
- }
- // checkRPC checks whether JSON-RPC works against the given URL.
- func checkRPC(url string) bool {
- c, err := rpc.Dial(url)
- if err != nil {
- return false
- }
- defer c.Close()
- _, err = c.SupportedModules()
- return err == nil
- }
- // string/int pointer helpers.
- func sp(s string) *string { return &s }
- func ip(i int) *int { return &i }
- func not(ok bool) string {
- if ok {
- return ""
- }
- return "not "
- }
|