github.com/snowblossomcoin/go-ethereum@v1.9.25/console/console_test.go (about) 1 // Copyright 2015 The go-ethereum Authors 2 // This file is part of the go-ethereum library. 3 // 4 // The go-ethereum library is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU Lesser General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // The go-ethereum library is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU Lesser General Public License for more details. 13 // 14 // You should have received a copy of the GNU Lesser General Public License 15 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. 16 17 package console 18 19 import ( 20 "bytes" 21 "errors" 22 "fmt" 23 "io/ioutil" 24 "os" 25 "strings" 26 "testing" 27 "time" 28 29 "github.com/ethereum/go-ethereum/common" 30 "github.com/ethereum/go-ethereum/consensus/ethash" 31 "github.com/ethereum/go-ethereum/console/prompt" 32 "github.com/ethereum/go-ethereum/core" 33 "github.com/ethereum/go-ethereum/eth" 34 "github.com/ethereum/go-ethereum/internal/jsre" 35 "github.com/ethereum/go-ethereum/miner" 36 "github.com/ethereum/go-ethereum/node" 37 ) 38 39 const ( 40 testInstance = "console-tester" 41 testAddress = "0x8605cdbbdb6d264aa742e77020dcbc58fcdce182" 42 ) 43 44 // hookedPrompter implements UserPrompter to simulate use input via channels. 45 type hookedPrompter struct { 46 scheduler chan string 47 } 48 49 func (p *hookedPrompter) PromptInput(prompt string) (string, error) { 50 // Send the prompt to the tester 51 select { 52 case p.scheduler <- prompt: 53 case <-time.After(time.Second): 54 return "", errors.New("prompt timeout") 55 } 56 // Retrieve the response and feed to the console 57 select { 58 case input := <-p.scheduler: 59 return input, nil 60 case <-time.After(time.Second): 61 return "", errors.New("input timeout") 62 } 63 } 64 65 func (p *hookedPrompter) PromptPassword(prompt string) (string, error) { 66 return "", errors.New("not implemented") 67 } 68 func (p *hookedPrompter) PromptConfirm(prompt string) (bool, error) { 69 return false, errors.New("not implemented") 70 } 71 func (p *hookedPrompter) SetHistory(history []string) {} 72 func (p *hookedPrompter) AppendHistory(command string) {} 73 func (p *hookedPrompter) ClearHistory() {} 74 func (p *hookedPrompter) SetWordCompleter(completer prompt.WordCompleter) {} 75 76 // tester is a console test environment for the console tests to operate on. 77 type tester struct { 78 workspace string 79 stack *node.Node 80 ethereum *eth.Ethereum 81 console *Console 82 input *hookedPrompter 83 output *bytes.Buffer 84 } 85 86 // newTester creates a test environment based on which the console can operate. 87 // Please ensure you call Close() on the returned tester to avoid leaks. 88 func newTester(t *testing.T, confOverride func(*eth.Config)) *tester { 89 // Create a temporary storage for the node keys and initialize it 90 workspace, err := ioutil.TempDir("", "console-tester-") 91 if err != nil { 92 t.Fatalf("failed to create temporary keystore: %v", err) 93 } 94 95 // Create a networkless protocol stack and start an Ethereum service within 96 stack, err := node.New(&node.Config{DataDir: workspace, UseLightweightKDF: true, Name: testInstance}) 97 if err != nil { 98 t.Fatalf("failed to create node: %v", err) 99 } 100 ethConf := ð.Config{ 101 Genesis: core.DeveloperGenesisBlock(15, common.Address{}), 102 Miner: miner.Config{ 103 Etherbase: common.HexToAddress(testAddress), 104 }, 105 Ethash: ethash.Config{ 106 PowMode: ethash.ModeTest, 107 }, 108 } 109 if confOverride != nil { 110 confOverride(ethConf) 111 } 112 ethBackend, err := eth.New(stack, ethConf) 113 if err != nil { 114 t.Fatalf("failed to register Ethereum protocol: %v", err) 115 } 116 // Start the node and assemble the JavaScript console around it 117 if err = stack.Start(); err != nil { 118 t.Fatalf("failed to start test stack: %v", err) 119 } 120 client, err := stack.Attach() 121 if err != nil { 122 t.Fatalf("failed to attach to node: %v", err) 123 } 124 prompter := &hookedPrompter{scheduler: make(chan string)} 125 printer := new(bytes.Buffer) 126 127 console, err := New(Config{ 128 DataDir: stack.DataDir(), 129 DocRoot: "testdata", 130 Client: client, 131 Prompter: prompter, 132 Printer: printer, 133 Preload: []string{"preload.js"}, 134 }) 135 if err != nil { 136 t.Fatalf("failed to create JavaScript console: %v", err) 137 } 138 // Create the final tester and return 139 return &tester{ 140 workspace: workspace, 141 stack: stack, 142 ethereum: ethBackend, 143 console: console, 144 input: prompter, 145 output: printer, 146 } 147 } 148 149 // Close cleans up any temporary data folders and held resources. 150 func (env *tester) Close(t *testing.T) { 151 if err := env.console.Stop(false); err != nil { 152 t.Errorf("failed to stop embedded console: %v", err) 153 } 154 if err := env.stack.Close(); err != nil { 155 t.Errorf("failed to tear down embedded node: %v", err) 156 } 157 os.RemoveAll(env.workspace) 158 } 159 160 // Tests that the node lists the correct welcome message, notably that it contains 161 // the instance name, coinbase account, block number, data directory and supported 162 // console modules. 163 func TestWelcome(t *testing.T) { 164 tester := newTester(t, nil) 165 defer tester.Close(t) 166 167 tester.console.Welcome() 168 169 output := tester.output.String() 170 if want := "Welcome"; !strings.Contains(output, want) { 171 t.Fatalf("console output missing welcome message: have\n%s\nwant also %s", output, want) 172 } 173 if want := fmt.Sprintf("instance: %s", testInstance); !strings.Contains(output, want) { 174 t.Fatalf("console output missing instance: have\n%s\nwant also %s", output, want) 175 } 176 if want := fmt.Sprintf("coinbase: %s", testAddress); !strings.Contains(output, want) { 177 t.Fatalf("console output missing coinbase: have\n%s\nwant also %s", output, want) 178 } 179 if want := "at block: 0"; !strings.Contains(output, want) { 180 t.Fatalf("console output missing sync status: have\n%s\nwant also %s", output, want) 181 } 182 if want := fmt.Sprintf("datadir: %s", tester.workspace); !strings.Contains(output, want) { 183 t.Fatalf("console output missing coinbase: have\n%s\nwant also %s", output, want) 184 } 185 } 186 187 // Tests that JavaScript statement evaluation works as intended. 188 func TestEvaluate(t *testing.T) { 189 tester := newTester(t, nil) 190 defer tester.Close(t) 191 192 tester.console.Evaluate("2 + 2") 193 if output := tester.output.String(); !strings.Contains(output, "4") { 194 t.Fatalf("statement evaluation failed: have %s, want %s", output, "4") 195 } 196 } 197 198 // Tests that the console can be used in interactive mode. 199 func TestInteractive(t *testing.T) { 200 // Create a tester and run an interactive console in the background 201 tester := newTester(t, nil) 202 defer tester.Close(t) 203 204 go tester.console.Interactive() 205 206 // Wait for a prompt and send a statement back 207 select { 208 case <-tester.input.scheduler: 209 case <-time.After(time.Second): 210 t.Fatalf("initial prompt timeout") 211 } 212 select { 213 case tester.input.scheduler <- "2+2": 214 case <-time.After(time.Second): 215 t.Fatalf("input feedback timeout") 216 } 217 // Wait for the second prompt and ensure first statement was evaluated 218 select { 219 case <-tester.input.scheduler: 220 case <-time.After(time.Second): 221 t.Fatalf("secondary prompt timeout") 222 } 223 if output := tester.output.String(); !strings.Contains(output, "4") { 224 t.Fatalf("statement evaluation failed: have %s, want %s", output, "4") 225 } 226 } 227 228 // Tests that preloaded JavaScript files have been executed before user is given 229 // input. 230 func TestPreload(t *testing.T) { 231 tester := newTester(t, nil) 232 defer tester.Close(t) 233 234 tester.console.Evaluate("preloaded") 235 if output := tester.output.String(); !strings.Contains(output, "some-preloaded-string") { 236 t.Fatalf("preloaded variable missing: have %s, want %s", output, "some-preloaded-string") 237 } 238 } 239 240 // Tests that JavaScript scripts can be executes from the configured asset path. 241 func TestExecute(t *testing.T) { 242 tester := newTester(t, nil) 243 defer tester.Close(t) 244 245 tester.console.Execute("exec.js") 246 247 tester.console.Evaluate("execed") 248 if output := tester.output.String(); !strings.Contains(output, "some-executed-string") { 249 t.Fatalf("execed variable missing: have %s, want %s", output, "some-executed-string") 250 } 251 } 252 253 // Tests that the JavaScript objects returned by statement executions are properly 254 // pretty printed instead of just displaying "[object]". 255 func TestPrettyPrint(t *testing.T) { 256 tester := newTester(t, nil) 257 defer tester.Close(t) 258 259 tester.console.Evaluate("obj = {int: 1, string: 'two', list: [3, 3, 3], obj: {null: null, func: function(){}}}") 260 261 // Define some specially formatted fields 262 var ( 263 one = jsre.NumberColor("1") 264 two = jsre.StringColor("\"two\"") 265 three = jsre.NumberColor("3") 266 null = jsre.SpecialColor("null") 267 fun = jsre.FunctionColor("function()") 268 ) 269 // Assemble the actual output we're after and verify 270 want := `{ 271 int: ` + one + `, 272 list: [` + three + `, ` + three + `, ` + three + `], 273 obj: { 274 null: ` + null + `, 275 func: ` + fun + ` 276 }, 277 string: ` + two + ` 278 } 279 ` 280 if output := tester.output.String(); output != want { 281 t.Fatalf("pretty print mismatch: have %s, want %s", output, want) 282 } 283 } 284 285 // Tests that the JavaScript exceptions are properly formatted and colored. 286 func TestPrettyError(t *testing.T) { 287 tester := newTester(t, nil) 288 defer tester.Close(t) 289 tester.console.Evaluate("throw 'hello'") 290 291 want := jsre.ErrorColor("hello") + "\n\tat <eval>:1:7(1)\n\n" 292 if output := tester.output.String(); output != want { 293 t.Fatalf("pretty error mismatch: have %s, want %s", output, want) 294 } 295 } 296 297 // Tests that tests if the number of indents for JS input is calculated correct. 298 func TestIndenting(t *testing.T) { 299 testCases := []struct { 300 input string 301 expectedIndentCount int 302 }{ 303 {`var a = 1;`, 0}, 304 {`"some string"`, 0}, 305 {`"some string with (parenthesis`, 0}, 306 {`"some string with newline 307 ("`, 0}, 308 {`function v(a,b) {}`, 0}, 309 {`function f(a,b) { var str = "asd("; };`, 0}, 310 {`function f(a) {`, 1}, 311 {`function f(a, function(b) {`, 2}, 312 {`function f(a, function(b) { 313 var str = "a)}"; 314 });`, 0}, 315 {`function f(a,b) { 316 var str = "a{b(" + a, ", " + b; 317 }`, 0}, 318 {`var str = "\"{"`, 0}, 319 {`var str = "'("`, 0}, 320 {`var str = "\\{"`, 0}, 321 {`var str = "\\\\{"`, 0}, 322 {`var str = 'a"{`, 0}, 323 {`var obj = {`, 1}, 324 {`var obj = { {a:1`, 2}, 325 {`var obj = { {a:1}`, 1}, 326 {`var obj = { {a:1}, b:2}`, 0}, 327 {`var obj = {}`, 0}, 328 {`var obj = { 329 a: 1, b: 2 330 }`, 0}, 331 {`var test = }`, -1}, 332 {`var str = "a\""; var obj = {`, 1}, 333 } 334 335 for i, tt := range testCases { 336 counted := countIndents(tt.input) 337 if counted != tt.expectedIndentCount { 338 t.Errorf("test %d: invalid indenting: have %d, want %d", i, counted, tt.expectedIndentCount) 339 } 340 } 341 }