2016-05-06 04:40:23 -05:00
|
|
|
// Copyright 2016 The go-ethereum Authors
|
|
|
|
// This file is part of go-ethereum.
|
|
|
|
//
|
|
|
|
// go-ethereum is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// go-ethereum 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 General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
|
|
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
2016-06-08 05:53:07 -05:00
|
|
|
"crypto/rand"
|
|
|
|
"math/big"
|
2016-05-06 04:40:23 -05:00
|
|
|
"path/filepath"
|
|
|
|
"runtime"
|
|
|
|
"strconv"
|
|
|
|
"strings"
|
|
|
|
"testing"
|
|
|
|
"time"
|
|
|
|
|
2016-11-25 09:55:06 -06:00
|
|
|
"github.com/ethereum/go-ethereum/params"
|
2017-04-12 09:27:23 -05:00
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
2023-02-09 02:03:00 -06:00
|
|
|
ipcAPIs = "admin:1.0 clique:1.0 debug:1.0 engine:1.0 eth:1.0 miner:1.0 net:1.0 rpc:1.0 txpool:1.0 web3:1.0"
|
2017-04-12 09:27:23 -05:00
|
|
|
httpAPIs = "eth:1.0 net:1.0 rpc:1.0 web3:1.0"
|
2016-05-06 04:40:23 -05:00
|
|
|
)
|
|
|
|
|
2020-11-30 07:43:20 -06:00
|
|
|
// spawns geth with the given command line args, using a set of flags to minimise
|
|
|
|
// memory and disk IO. If the args don't set --datadir, the
|
|
|
|
// child g gets a temporary data directory.
|
|
|
|
func runMinimalGeth(t *testing.T, args ...string) *testgeth {
|
2023-02-09 02:03:00 -06:00
|
|
|
// --goerli to make the 'writing genesis to disk' faster (no accounts)
|
2020-11-30 07:43:20 -06:00
|
|
|
// --networkid=1337 to avoid cache bump
|
|
|
|
// --syncmode=full to avoid allocating fast sync bloom
|
2023-02-09 02:03:00 -06:00
|
|
|
allArgs := []string{"--goerli", "--networkid", "1337", "--authrpc.port", "0", "--syncmode=full", "--port", "0",
|
2022-05-03 05:12:40 -05:00
|
|
|
"--nat", "none", "--nodiscover", "--maxpeers", "0", "--cache", "64",
|
|
|
|
"--datadir.minfreedisk", "0"}
|
2020-11-30 07:43:20 -06:00
|
|
|
return runGeth(t, append(allArgs, args...)...)
|
|
|
|
}
|
|
|
|
|
2016-05-06 04:40:23 -05:00
|
|
|
// Tests that a node embedded within a console can be started up properly and
|
|
|
|
// then terminated by closing the input stream.
|
|
|
|
func TestConsoleWelcome(t *testing.T) {
|
|
|
|
coinbase := "0x8605cdbbdb6d264aa742e77020dcbc58fcdce182"
|
|
|
|
|
|
|
|
// Start a geth console, make sure it's cleaned up and terminate the console
|
2021-02-24 07:07:58 -06:00
|
|
|
geth := runMinimalGeth(t, "--miner.etherbase", coinbase, "console")
|
2016-05-06 04:40:23 -05:00
|
|
|
|
|
|
|
// Gather all the infos the welcome message needs to contain
|
2017-06-21 07:54:23 -05:00
|
|
|
geth.SetTemplateFunc("goos", func() string { return runtime.GOOS })
|
|
|
|
geth.SetTemplateFunc("goarch", func() string { return runtime.GOARCH })
|
|
|
|
geth.SetTemplateFunc("gover", runtime.Version)
|
2019-05-08 08:44:28 -05:00
|
|
|
geth.SetTemplateFunc("gethver", func() string { return params.VersionWithCommit("", "") })
|
2020-01-27 04:50:48 -06:00
|
|
|
geth.SetTemplateFunc("niltime", func() string {
|
2023-02-09 02:03:00 -06:00
|
|
|
return time.Unix(1548854791, 0).Format("Mon Jan 02 2006 15:04:05 GMT-0700 (MST)")
|
2020-01-27 04:50:48 -06:00
|
|
|
})
|
2017-06-21 07:54:23 -05:00
|
|
|
geth.SetTemplateFunc("apis", func() string { return ipcAPIs })
|
2016-05-06 04:40:23 -05:00
|
|
|
|
|
|
|
// Verify the actual welcome message to the required template
|
2017-06-21 07:54:23 -05:00
|
|
|
geth.Expect(`
|
2016-05-06 04:40:23 -05:00
|
|
|
Welcome to the Geth JavaScript console!
|
|
|
|
|
2017-04-05 14:51:01 -05:00
|
|
|
instance: Geth/v{{gethver}}/{{goos}}-{{goarch}}/{{gover}}
|
2016-05-06 04:40:23 -05:00
|
|
|
coinbase: {{.Etherbase}}
|
|
|
|
at block: 0 ({{niltime}})
|
|
|
|
datadir: {{.Datadir}}
|
2017-04-12 09:27:23 -05:00
|
|
|
modules: {{apis}}
|
2016-05-06 04:40:23 -05:00
|
|
|
|
2021-09-21 03:19:46 -05:00
|
|
|
To exit, press ctrl-d or type exit
|
2016-06-02 15:33:57 -05:00
|
|
|
> {{.InputLine "exit"}}
|
2016-05-06 04:40:23 -05:00
|
|
|
`)
|
2017-06-21 07:54:23 -05:00
|
|
|
geth.ExpectExit()
|
2016-05-06 04:40:23 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Tests that a console can be attached to a running node via various means.
|
2020-11-30 07:43:20 -06:00
|
|
|
func TestAttachWelcome(t *testing.T) {
|
|
|
|
var (
|
|
|
|
ipc string
|
|
|
|
httpPort string
|
|
|
|
wsPort string
|
|
|
|
)
|
2020-05-25 03:21:28 -05:00
|
|
|
// Configure the instance for IPC attachment
|
2016-05-06 04:40:23 -05:00
|
|
|
if runtime.GOOS == "windows" {
|
2016-06-08 05:53:07 -05:00
|
|
|
ipc = `\\.\pipe\geth` + strconv.Itoa(trulyRandInt(100000, 999999))
|
2016-05-06 04:40:23 -05:00
|
|
|
} else {
|
2022-04-08 08:44:55 -05:00
|
|
|
ipc = filepath.Join(t.TempDir(), "geth.ipc")
|
2016-05-06 04:40:23 -05:00
|
|
|
}
|
2020-11-30 07:43:20 -06:00
|
|
|
// And HTTP + WS attachment
|
|
|
|
p := trulyRandInt(1024, 65533) // Yeah, sometimes this will fail, sorry :P
|
|
|
|
httpPort = strconv.Itoa(p)
|
|
|
|
wsPort = strconv.Itoa(p + 1)
|
2021-02-24 07:07:58 -06:00
|
|
|
geth := runMinimalGeth(t, "--miner.etherbase", "0x8605cdbbdb6d264aa742e77020dcbc58fcdce182",
|
2020-11-30 07:43:20 -06:00
|
|
|
"--ipcpath", ipc,
|
|
|
|
"--http", "--http.port", httpPort,
|
|
|
|
"--ws", "--ws.port", wsPort)
|
|
|
|
t.Run("ipc", func(t *testing.T) {
|
|
|
|
waitForEndpoint(t, ipc, 3*time.Second)
|
|
|
|
testAttachWelcome(t, geth, "ipc:"+ipc, ipcAPIs)
|
|
|
|
})
|
|
|
|
t.Run("http", func(t *testing.T) {
|
|
|
|
endpoint := "http://127.0.0.1:" + httpPort
|
|
|
|
waitForEndpoint(t, endpoint, 3*time.Second)
|
|
|
|
testAttachWelcome(t, geth, endpoint, httpAPIs)
|
|
|
|
})
|
|
|
|
t.Run("ws", func(t *testing.T) {
|
|
|
|
endpoint := "ws://127.0.0.1:" + wsPort
|
|
|
|
waitForEndpoint(t, endpoint, 3*time.Second)
|
|
|
|
testAttachWelcome(t, geth, endpoint, httpAPIs)
|
|
|
|
})
|
2022-04-08 08:44:55 -05:00
|
|
|
geth.ExpectExit()
|
2016-05-06 04:40:23 -05:00
|
|
|
}
|
|
|
|
|
2017-04-12 09:27:23 -05:00
|
|
|
func testAttachWelcome(t *testing.T, geth *testgeth, endpoint, apis string) {
|
2022-10-11 02:37:33 -05:00
|
|
|
// Attach to a running geth node and terminate immediately
|
2016-05-06 04:40:23 -05:00
|
|
|
attach := runGeth(t, "attach", endpoint)
|
2017-06-21 07:54:23 -05:00
|
|
|
defer attach.ExpectExit()
|
|
|
|
attach.CloseStdin()
|
2016-05-06 04:40:23 -05:00
|
|
|
|
|
|
|
// Gather all the infos the welcome message needs to contain
|
2017-06-21 07:54:23 -05:00
|
|
|
attach.SetTemplateFunc("goos", func() string { return runtime.GOOS })
|
|
|
|
attach.SetTemplateFunc("goarch", func() string { return runtime.GOARCH })
|
|
|
|
attach.SetTemplateFunc("gover", runtime.Version)
|
2019-05-08 08:44:28 -05:00
|
|
|
attach.SetTemplateFunc("gethver", func() string { return params.VersionWithCommit("", "") })
|
2017-06-21 07:54:23 -05:00
|
|
|
attach.SetTemplateFunc("etherbase", func() string { return geth.Etherbase })
|
2020-01-27 04:50:48 -06:00
|
|
|
attach.SetTemplateFunc("niltime", func() string {
|
2023-02-09 02:03:00 -06:00
|
|
|
return time.Unix(1548854791, 0).Format("Mon Jan 02 2006 15:04:05 GMT-0700 (MST)")
|
2020-01-27 04:50:48 -06:00
|
|
|
})
|
2017-06-21 07:54:23 -05:00
|
|
|
attach.SetTemplateFunc("ipc", func() bool { return strings.HasPrefix(endpoint, "ipc") })
|
|
|
|
attach.SetTemplateFunc("datadir", func() string { return geth.Datadir })
|
|
|
|
attach.SetTemplateFunc("apis", func() string { return apis })
|
2016-05-06 04:40:23 -05:00
|
|
|
|
|
|
|
// Verify the actual welcome message to the required template
|
2017-06-21 07:54:23 -05:00
|
|
|
attach.Expect(`
|
2016-05-06 04:40:23 -05:00
|
|
|
Welcome to the Geth JavaScript console!
|
|
|
|
|
2017-04-05 14:51:01 -05:00
|
|
|
instance: Geth/v{{gethver}}/{{goos}}-{{goarch}}/{{gover}}
|
2016-05-06 04:40:23 -05:00
|
|
|
coinbase: {{etherbase}}
|
|
|
|
at block: 0 ({{niltime}}){{if ipc}}
|
|
|
|
datadir: {{datadir}}{{end}}
|
2017-04-12 09:27:23 -05:00
|
|
|
modules: {{apis}}
|
2016-05-06 04:40:23 -05:00
|
|
|
|
2021-09-21 03:19:46 -05:00
|
|
|
To exit, press ctrl-d or type exit
|
2016-06-02 15:33:57 -05:00
|
|
|
> {{.InputLine "exit" }}
|
2016-05-06 04:40:23 -05:00
|
|
|
`)
|
2017-06-21 07:54:23 -05:00
|
|
|
attach.ExpectExit()
|
2016-05-06 04:40:23 -05:00
|
|
|
}
|
2016-06-08 05:53:07 -05:00
|
|
|
|
|
|
|
// trulyRandInt generates a crypto random integer used by the console tests to
|
2022-08-19 01:00:21 -05:00
|
|
|
// not clash network ports with other tests running concurrently.
|
2016-06-08 05:53:07 -05:00
|
|
|
func trulyRandInt(lo, hi int) int {
|
|
|
|
num, _ := rand.Int(rand.Reader, big.NewInt(int64(hi-lo)))
|
|
|
|
return int(num.Int64()) + lo
|
|
|
|
}
|