8d066f1f42
This commit replaces ioutil.TempDir with t.TempDir in tests. The
directory created by t.TempDir is automatically removed when the test
and all its subtests complete.
Prior to this commit, temporary directory created using ioutil.TempDir
had to be removed manually by calling os.RemoveAll, which is omitted in
some tests. The error handling boilerplate e.g.
defer func() {
if err := os.RemoveAll(dir); err != nil {
t.Fatal(err)
}
}
is also tedious, but t.TempDir handles this for us nicely.
Reference: https://pkg.go.dev/testing#T.TempDir
Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
112 lines
2.7 KiB
Go
112 lines
2.7 KiB
Go
// 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 (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/docker/docker/pkg/reexec"
|
|
"github.com/ethereum/go-ethereum/internal/cmdtest"
|
|
"github.com/ethereum/go-ethereum/rpc"
|
|
)
|
|
|
|
type testgeth struct {
|
|
*cmdtest.TestCmd
|
|
|
|
// template variables for expect
|
|
Datadir string
|
|
Etherbase string
|
|
}
|
|
|
|
func init() {
|
|
// Run the app if we've been exec'd as "geth-test" in runGeth.
|
|
reexec.Register("geth-test", func() {
|
|
if err := app.Run(os.Args); err != nil {
|
|
fmt.Fprintln(os.Stderr, err)
|
|
os.Exit(1)
|
|
}
|
|
os.Exit(0)
|
|
})
|
|
}
|
|
|
|
func TestMain(m *testing.M) {
|
|
// check if we have been reexec'd
|
|
if reexec.Init() {
|
|
return
|
|
}
|
|
os.Exit(m.Run())
|
|
}
|
|
|
|
// spawns geth with the given command line args. If the args don't set --datadir, the
|
|
// child g gets a temporary data directory.
|
|
func runGeth(t *testing.T, args ...string) *testgeth {
|
|
tt := &testgeth{}
|
|
tt.TestCmd = cmdtest.NewTestCmd(t, tt)
|
|
for i, arg := range args {
|
|
switch arg {
|
|
case "--datadir":
|
|
if i < len(args)-1 {
|
|
tt.Datadir = args[i+1]
|
|
}
|
|
case "--miner.etherbase":
|
|
if i < len(args)-1 {
|
|
tt.Etherbase = args[i+1]
|
|
}
|
|
}
|
|
}
|
|
if tt.Datadir == "" {
|
|
// The temporary datadir will be removed automatically if something fails below.
|
|
tt.Datadir = t.TempDir()
|
|
args = append([]string{"--datadir", tt.Datadir}, args...)
|
|
}
|
|
|
|
// Boot "geth". This actually runs the test binary but the TestMain
|
|
// function will prevent any tests from running.
|
|
tt.Run("geth-test", args...)
|
|
|
|
return tt
|
|
}
|
|
|
|
// waitForEndpoint attempts to connect to an RPC endpoint until it succeeds.
|
|
func waitForEndpoint(t *testing.T, endpoint string, timeout time.Duration) {
|
|
probe := func() bool {
|
|
ctx, cancel := context.WithTimeout(context.Background(), timeout)
|
|
defer cancel()
|
|
c, err := rpc.DialContext(ctx, endpoint)
|
|
if c != nil {
|
|
_, err = c.SupportedModules()
|
|
c.Close()
|
|
}
|
|
return err == nil
|
|
}
|
|
|
|
start := time.Now()
|
|
for {
|
|
if probe() {
|
|
return
|
|
}
|
|
if time.Since(start) > timeout {
|
|
t.Fatal("endpoint", endpoint, "did not open within", timeout)
|
|
}
|
|
time.Sleep(200 * time.Millisecond)
|
|
}
|
|
}
|