aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/geth/consolecmd_test.go
blob: e0e549e1242dc812270bfec145750e6bd9b58e8a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
// 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 (
    "crypto/rand"
    "math/big"
    "os"
    "path/filepath"
    "runtime"
    "sort"
    "strconv"
    "strings"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/rpc"
)

// 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
    geth := runGeth(t,
        "--port", "0", "--maxpeers", "0", "--nodiscover", "--nat", "none",
        "--etherbase", coinbase, "--shh",
        "console")

    // Gather all the infos the welcome message needs to contain
    geth.setTemplateFunc("goos", func() string { return runtime.GOOS })
    geth.setTemplateFunc("gover", runtime.Version)
    geth.setTemplateFunc("gethver", func() string { return verString })
    geth.setTemplateFunc("niltime", func() string { return time.Unix(0, 0).Format(time.RFC1123) })
    geth.setTemplateFunc("apis", func() []string {
        apis := append(strings.Split(rpc.DefaultIPCApis, ","), rpc.MetadataApi)
        sort.Strings(apis)
        return apis
    })

    // Verify the actual welcome message to the required template
    geth.expect(`
Welcome to the Geth JavaScript console!

instance: Geth/v{{gethver}}/{{goos}}/{{gover}}
coinbase: {{.Etherbase}}
at block: 0 ({{niltime}})
 datadir: {{.Datadir}}
 modules:{{range apis}} {{.}}:1.0{{end}}

> {{.InputLine "exit"}}
`)
    geth.expectExit()
}

// Tests that a console can be attached to a running node via various means.
func TestIPCAttachWelcome(t *testing.T) {
    // Configure the instance for IPC attachement
    coinbase := "0x8605cdbbdb6d264aa742e77020dcbc58fcdce182"
    var ipc string
    if runtime.GOOS == "windows" {
        ipc = `\\.\pipe\geth` + strconv.Itoa(trulyRandInt(100000, 999999))
    } else {
        ws := tmpdir(t)
        defer os.RemoveAll(ws)
        ipc = filepath.Join(ws, "geth.ipc")
    }
    // Note: we need --shh because testAttachWelcome checks for default
    // list of ipc modules and shh is included there.
    geth := runGeth(t,
        "--port", "0", "--maxpeers", "0", "--nodiscover", "--nat", "none",
        "--etherbase", coinbase, "--shh", "--ipcpath", ipc)

    time.Sleep(2 * time.Second) // Simple way to wait for the RPC endpoint to open
    testAttachWelcome(t, geth, "ipc:"+ipc)

    geth.interrupt()
    geth.expectExit()
}

func TestHTTPAttachWelcome(t *testing.T) {
    coinbase := "0x8605cdbbdb6d264aa742e77020dcbc58fcdce182"
    port := strconv.Itoa(trulyRandInt(1024, 65536)) // Yeah, sometimes this will fail, sorry :P
    geth := runGeth(t,
        "--port", "0", "--maxpeers", "0", "--nodiscover", "--nat", "none",
        "--etherbase", coinbase, "--rpc", "--rpcport", port)

    time.Sleep(2 * time.Second) // Simple way to wait for the RPC endpoint to open
    testAttachWelcome(t, geth, "http://localhost:"+port)

    geth.interrupt()
    geth.expectExit()
}

func TestWSAttachWelcome(t *testing.T) {
    coinbase := "0x8605cdbbdb6d264aa742e77020dcbc58fcdce182"
    port := strconv.Itoa(trulyRandInt(1024, 65536)) // Yeah, sometimes this will fail, sorry :P

    geth := runGeth(t,
        "--port", "0", "--maxpeers", "0", "--nodiscover", "--nat", "none",
        "--etherbase", coinbase, "--ws", "--wsport", port)

    time.Sleep(2 * time.Second) // Simple way to wait for the RPC endpoint to open
    testAttachWelcome(t, geth, "ws://localhost:"+port)

    geth.interrupt()
    geth.expectExit()
}

func testAttachWelcome(t *testing.T, geth *testgeth, endpoint string) {
    // Attach to a running geth note and terminate immediately
    attach := runGeth(t, "attach", endpoint)
    defer attach.expectExit()
    attach.stdin.Close()

    // Gather all the infos the welcome message needs to contain
    attach.setTemplateFunc("goos", func() string { return runtime.GOOS })
    attach.setTemplateFunc("gover", runtime.Version)
    attach.setTemplateFunc("gethver", func() string { return verString })
    attach.setTemplateFunc("etherbase", func() string { return geth.Etherbase })
    attach.setTemplateFunc("niltime", func() string { return time.Unix(0, 0).Format(time.RFC1123) })
    attach.setTemplateFunc("ipc", func() bool { return strings.HasPrefix(endpoint, "ipc") })
    attach.setTemplateFunc("datadir", func() string { return geth.Datadir })
    attach.setTemplateFunc("apis", func() []string {
        var apis []string
        if strings.HasPrefix(endpoint, "ipc") {
            apis = append(strings.Split(rpc.DefaultIPCApis, ","), rpc.MetadataApi)
        } else {
            apis = append(strings.Split(rpc.DefaultHTTPApis, ","), rpc.MetadataApi)
        }
        sort.Strings(apis)
        return apis
    })

    // Verify the actual welcome message to the required template
    attach.expect(`
Welcome to the Geth JavaScript console!

instance: Geth/v{{gethver}}/{{goos}}/{{gover}}
coinbase: {{etherbase}}
at block: 0 ({{niltime}}){{if ipc}}
 datadir: {{datadir}}{{end}}
 modules:{{range apis}} {{.}}:1.0{{end}}

> {{.InputLine "exit" }}
`)
    attach.expectExit()
}

// trulyRandInt generates a crypto random integer used by the console tests to
// not clash network ports with other tests running cocurrently.
func trulyRandInt(lo, hi int) int {
    num, _ := rand.Int(rand.Reader, big.NewInt(int64(hi-lo)))
    return int(num.Int64()) + lo
}