Merge a37b082967edc7730b4dc0d69fa7d56ec814f325 into 594427d28cf1547a02fb08db6e65ce72b02a8af6

This commit is contained in:
Arka Saha 2024-09-17 13:57:00 +01:00 committed by GitHub
commit 10fecb5050
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 97 additions and 62 deletions

View File

@ -33,6 +33,8 @@ import (
const DEBUG_LINES_TAIL = 40 const DEBUG_LINES_TAIL = 40
type ExpectProcess struct { type ExpectProcess struct {
name string
cmd *exec.Cmd cmd *exec.Cmd
fpty *os.File fpty *os.File
wg sync.WaitGroup wg sync.WaitGroup
@ -42,23 +44,24 @@ type ExpectProcess struct {
count int // increment whenever new line gets added count int // increment whenever new line gets added
err error err error
// StopSignal is the signal Stop sends to the process; defaults to SIGKILL. // StopSignal is the signal Stop sends to the process; defaults to SIGTERM.
StopSignal os.Signal StopSignal os.Signal
} }
// NewExpect creates a new process for expect testing. // NewExpect creates a new process for expect testing.
func NewExpect(name string, arg ...string) (ep *ExpectProcess, err error) { func NewExpect(name string, arg ...string) (ep *ExpectProcess, err error) {
// if env[] is nil, use current system env // if env[] is nil, use current system env and the default command as name
return NewExpectWithEnv(name, arg, nil) return NewExpectWithEnv(name, arg, nil, name)
} }
// NewExpectWithEnv creates a new process with user defined env variables for expect testing. // NewExpectWithEnv creates a new process with user defined env variables for expect testing.
func NewExpectWithEnv(name string, args []string, env []string) (ep *ExpectProcess, err error) { func NewExpectWithEnv(name string, args []string, env []string, serverProcessConfigName string) (ep *ExpectProcess, err error) {
cmd := exec.Command(name, args...) cmd := exec.Command(name, args...)
cmd.Env = env cmd.Env = env
ep = &ExpectProcess{ ep = &ExpectProcess{
name: serverProcessConfigName,
cmd: cmd, cmd: cmd,
StopSignal: syscall.SIGKILL, StopSignal: syscall.SIGTERM,
} }
ep.cmd.Stderr = ep.cmd.Stdout ep.cmd.Stderr = ep.cmd.Stdout
ep.cmd.Stdin = nil ep.cmd.Stdin = nil
@ -72,6 +75,10 @@ func NewExpectWithEnv(name string, args []string, env []string) (ep *ExpectProce
return ep, nil return ep, nil
} }
func (ep *ExpectProcess) Pid() int {
return ep.cmd.Process.Pid
}
func (ep *ExpectProcess) read() { func (ep *ExpectProcess) read() {
defer ep.wg.Done() defer ep.wg.Done()
printDebugLines := os.Getenv("EXPECT_DEBUG") != "" printDebugLines := os.Getenv("EXPECT_DEBUG") != ""
@ -81,7 +88,7 @@ func (ep *ExpectProcess) read() {
ep.mu.Lock() ep.mu.Lock()
if l != "" { if l != "" {
if printDebugLines { if printDebugLines {
fmt.Printf("%s-%d: %s", ep.cmd.Path, ep.cmd.Process.Pid, l) fmt.Printf("%s (%s) (%d): %s", ep.cmd.Path, ep.name, ep.cmd.Process.Pid, l)
} }
ep.lines = append(ep.lines, l) ep.lines = append(ep.lines, l)
ep.count++ ep.count++
@ -114,7 +121,7 @@ func (ep *ExpectProcess) ExpectFunc(f func(string) bool) (string, error) {
break break
} }
ep.mu.Unlock() ep.mu.Unlock()
time.Sleep(time.Millisecond * 100) time.Sleep(time.Millisecond * 10)
} }
ep.mu.Lock() ep.mu.Lock()
lastLinesIndex := len(ep.lines) - DEBUG_LINES_TAIL lastLinesIndex := len(ep.lines) - DEBUG_LINES_TAIL

View File

@ -20,14 +20,15 @@ import (
"net/url" "net/url"
"os" "os"
"path" "path"
"regexp"
"strings" "strings"
"testing" "testing"
"time" "time"
"go.etcd.io/etcd/pkg/v3/proxy"
"go.etcd.io/etcd/server/v3/etcdserver"
"go.uber.org/zap" "go.uber.org/zap"
"go.uber.org/zap/zaptest" "go.uber.org/zap/zaptest"
"go.etcd.io/etcd/server/v3/etcdserver"
) )
const EtcdProcessBasePort = 20000 const EtcdProcessBasePort = 20000
@ -40,6 +41,9 @@ const (
ClientTLSAndNonTLS ClientTLSAndNonTLS
) )
// allow alphanumerics, underscores and dashes
var testNameCleanRegex = regexp.MustCompile(`[^a-zA-Z0-9 \-_]+`)
func NewConfigNoTLS() *EtcdProcessClusterConfig { func NewConfigNoTLS() *EtcdProcessClusterConfig {
return &EtcdProcessClusterConfig{ClusterSize: 3, return &EtcdProcessClusterConfig{ClusterSize: 3,
InitialToken: "new", InitialToken: "new",
@ -260,43 +264,45 @@ func (cfg *EtcdProcessClusterConfig) PeerScheme() string {
return setupScheme(cfg.BasePeerScheme, cfg.IsPeerTLS) return setupScheme(cfg.BasePeerScheme, cfg.IsPeerTLS)
} }
func (cfg *EtcdProcessClusterConfig) EtcdServerProcessConfig(tb testing.TB, i int) *EtcdServerProcessConfig { func (cfg *EtcdProcessClusterConfig) EtcdServerProcessConfigs(tb testing.TB) []*EtcdServerProcessConfig {
lg := zaptest.NewLogger(tb)
if cfg.BasePort == 0 {
cfg.BasePort = EtcdProcessBasePort
}
if cfg.ExecPath == "" {
cfg.ExecPath = BinPath
}
if cfg.SnapshotCount == 0 {
cfg.SnapshotCount = etcdserver.DefaultSnapshotCount
}
etcdCfgs := make([]*EtcdServerProcessConfig, cfg.ClusterSize)
initialCluster := make([]string, cfg.ClusterSize)
for i := 0; i < cfg.ClusterSize; i++ {
var curls []string var curls []string
var curl string var curl, curltls string
port := cfg.BasePort + 5*i port := cfg.BasePort + 5*i
clientPort := port curlHost := fmt.Sprintf("localhost:%d", port)
peerPort := port + 1
peer2Port := port + 3
clientHttpPort := port + 4
if cfg.ClientTLS == ClientTLSAndNonTLS { switch cfg.ClientTLS {
curl = clientURL(cfg.ClientScheme(), clientPort, ClientNonTLS) case ClientNonTLS, ClientTLS:
curls = []string{curl, clientURL(cfg.ClientScheme(), clientPort, ClientTLS)} curl = (&url.URL{Scheme: cfg.ClientScheme(), Host: curlHost}).String()
} else {
curl = clientURL(cfg.ClientScheme(), clientPort, cfg.ClientTLS)
curls = []string{curl} curls = []string{curl}
case ClientTLSAndNonTLS:
curl = (&url.URL{Scheme: "http", Host: curlHost}).String()
curltls = (&url.URL{Scheme: "https", Host: curlHost}).String()
curls = []string{curl, curltls}
} }
purl := url.URL{Scheme: cfg.PeerScheme(), Host: fmt.Sprintf("localhost:%d", peerPort)} purl := url.URL{Scheme: cfg.PeerScheme(), Host: fmt.Sprintf("localhost:%d", port+1)}
peerAdvertiseUrl := url.URL{Scheme: cfg.PeerScheme(), Host: fmt.Sprintf("localhost:%d", peerPort)}
var proxyCfg *proxy.ServerConfig
if cfg.PeerProxy {
if !cfg.IsPeerTLS {
panic("Can't use peer proxy without peer TLS as it can result in malformed packets")
}
peerAdvertiseUrl.Host = fmt.Sprintf("localhost:%d", peer2Port)
proxyCfg = &proxy.ServerConfig{
Logger: zap.NewNop(),
To: purl,
From: peerAdvertiseUrl,
}
}
name := fmt.Sprintf("test-%d", i) name := fmt.Sprintf("%s-test-%d", testNameCleanRegex.ReplaceAllString(tb.Name(), ""), i)
dataDirPath := cfg.DataDirPath dataDirPath := cfg.DataDirPath
if cfg.DataDirPath == "" { if cfg.DataDirPath == "" {
dataDirPath = tb.TempDir() dataDirPath = tb.TempDir()
} }
initialCluster[i] = fmt.Sprintf("%s=%s", name, purl.String())
args := []string{ args := []string{
"--name", name, "--name", name,

View File

@ -26,8 +26,9 @@ import (
"strconv" "strconv"
"strings" "strings"
"go.etcd.io/etcd/pkg/v3/expect"
"go.uber.org/zap" "go.uber.org/zap"
"go.etcd.io/etcd/pkg/v3/expect"
) )
type proxyEtcdProcess struct { type proxyEtcdProcess struct {
@ -123,6 +124,7 @@ func (p *proxyEtcdProcess) Logs() LogsExpect {
type proxyProc struct { type proxyProc struct {
lg *zap.Logger lg *zap.Logger
name string
execPath string execPath string
args []string args []string
ep string ep string
@ -138,7 +140,7 @@ func (pp *proxyProc) start() error {
if pp.proc != nil { if pp.proc != nil {
panic("already started") panic("already started")
} }
proc, err := SpawnCmdWithLogger(pp.lg, append([]string{pp.execPath}, pp.args...), nil) proc, err := SpawnCmdWithLogger(pp.lg, append([]string{pp.execPath}, pp.args...), nil, pp.name)
if err != nil { if err != nil {
return err return err
} }
@ -202,6 +204,7 @@ func newProxyV2Proc(cfg *EtcdServerProcessConfig) *proxyV2Proc {
} }
return &proxyV2Proc{ return &proxyV2Proc{
proxyProc: proxyProc{ proxyProc: proxyProc{
name: cfg.Name,
lg: cfg.lg, lg: cfg.lg,
execPath: cfg.ExecPath, execPath: cfg.ExecPath,
args: append(args, cfg.TlsArgs...), args: append(args, cfg.TlsArgs...),
@ -288,6 +291,7 @@ func newProxyV3Proc(cfg *EtcdServerProcessConfig) *proxyV3Proc {
} }
return &proxyV3Proc{ return &proxyV3Proc{
proxyProc{ proxyProc{
name: cfg.Name,
lg: cfg.lg, lg: cfg.lg,
execPath: cfg.ExecPath, execPath: cfg.ExecPath,
args: append(args, tlsArgs...), args: append(args, tlsArgs...),

View File

@ -27,11 +27,12 @@ import (
"testing" "testing"
"time" "time"
"go.uber.org/zap"
"github.com/coreos/go-semver/semver" "github.com/coreos/go-semver/semver"
"go.etcd.io/etcd/client/pkg/v3/fileutil" "go.etcd.io/etcd/client/pkg/v3/fileutil"
"go.etcd.io/etcd/pkg/v3/expect" "go.etcd.io/etcd/pkg/v3/expect"
"go.etcd.io/etcd/pkg/v3/proxy" "go.etcd.io/etcd/pkg/v3/proxy"
"go.uber.org/zap"
) )
var ( var (
@ -148,33 +149,33 @@ func (ep *EtcdServerProcess) Start() error {
} }
} }
ep.cfg.lg.Info("starting server...", zap.String("name", ep.cfg.Name)) ep.cfg.lg.Info("starting server...", zap.String("name", ep.cfg.Name))
proc, err := SpawnCmdWithLogger(ep.cfg.lg, append([]string{ep.cfg.ExecPath}, ep.cfg.Args...), ep.cfg.EnvVars) proc, err := SpawnCmdWithLogger(ep.cfg.lg, append([]string{ep.cfg.ExecPath}, ep.cfg.Args...), ep.cfg.EnvVars, ep.cfg.Name)
if err != nil { if err != nil {
return err return err
} }
ep.proc = proc ep.proc = proc
err = ep.waitReady() err = ep.waitReady()
if err == nil { if err == nil {
ep.cfg.lg.Info("started server.", zap.String("name", ep.cfg.Name)) ep.cfg.lg.Info("started server.", zap.String("name", ep.cfg.Name), zap.Int("pid", ep.proc.Pid()))
} }
return err return err
} }
func (ep *EtcdServerProcess) Restart() error { func (ep *EtcdServerProcess) Restart() error {
ep.cfg.lg.Info("restaring server...", zap.String("name", ep.cfg.Name)) ep.cfg.lg.Info("restarting server...", zap.String("name", ep.cfg.Name))
if err := ep.Stop(); err != nil { if err := ep.Stop(); err != nil {
return err return err
} }
ep.donec = make(chan struct{}) ep.donec = make(chan struct{})
err := ep.Start() err := ep.Start()
if err == nil { if err == nil {
ep.cfg.lg.Info("restared server", zap.String("name", ep.cfg.Name)) ep.cfg.lg.Info("restarted server", zap.String("name", ep.cfg.Name))
} }
return err return err
} }
func (ep *EtcdServerProcess) Stop() (err error) { func (ep *EtcdServerProcess) Stop() (err error) {
ep.cfg.lg.Info("stoping server...", zap.String("name", ep.cfg.Name)) ep.cfg.lg.Info("stopping server...", zap.String("name", ep.cfg.Name))
if ep == nil || ep.proc == nil { if ep == nil || ep.proc == nil {
return nil return nil
} }
@ -230,7 +231,7 @@ func (ep *EtcdServerProcess) Config() *EtcdServerProcessConfig { return ep.cfg }
func (ep *EtcdServerProcess) Logs() LogsExpect { func (ep *EtcdServerProcess) Logs() LogsExpect {
if ep.proc == nil { if ep.proc == nil {
ep.cfg.lg.Panic("Please grap logs before process is stopped") ep.cfg.lg.Panic("Please grab logs before process is stopped")
} }
return ep.proc return ep.proc
} }

View File

@ -22,17 +22,14 @@ import (
"os" "os"
"strings" "strings"
"go.etcd.io/etcd/pkg/v3/expect"
"go.uber.org/zap" "go.uber.org/zap"
"go.etcd.io/etcd/pkg/v3/expect"
) )
const noOutputLineCount = 0 // regular binaries emit no extra lines const noOutputLineCount = 0 // regular binaries emit no extra lines
func SpawnCmd(args []string, envVars map[string]string) (*expect.ExpectProcess, error) { func SpawnCmdWithLogger(lg *zap.Logger, args []string, envVars map[string]string, name string) (*expect.ExpectProcess, error) {
return SpawnCmdWithLogger(zap.NewNop(), args, envVars)
}
func SpawnCmdWithLogger(lg *zap.Logger, args []string, envVars map[string]string) (*expect.ExpectProcess, error) {
wd, err := os.Getwd() wd, err := os.Getwd()
if err != nil { if err != nil {
return nil, err return nil, err
@ -40,11 +37,19 @@ func SpawnCmdWithLogger(lg *zap.Logger, args []string, envVars map[string]string
env := mergeEnvVariables(envVars) env := mergeEnvVariables(envVars)
if strings.HasSuffix(args[0], "/etcdctl3") { if strings.HasSuffix(args[0], "/etcdctl3") {
env = append(env, "ETCDCTL_API=3") env = append(env, "ETCDCTL_API=3")
lg.Info("spawning process with ETCDCTL_API=3", zap.Strings("args", args), zap.String("working-dir", wd), zap.Strings("environment-variables", env)) lg.Info("spawning process with ETCDCTL_API=3",
return expect.NewExpectWithEnv(CtlBinPath, args[1:], env) zap.Strings("args", args),
zap.String("working-dir", wd),
zap.String("name", name),
zap.Strings("environment-variables", env))
return expect.NewExpectWithEnv(CtlBinPath, args[1:], env, name)
} }
lg.Info("spawning process", zap.Strings("args", args), zap.String("working-dir", wd), zap.Strings("environment-variables", env)) lg.Info("spawning process",
return expect.NewExpectWithEnv(args[0], args[1:], env) zap.Strings("args", args),
zap.String("working-dir", wd),
zap.String("name", name),
zap.Strings("environment-variables", env))
return expect.NewExpectWithEnv(args[0], args[1:], env, name)
} }
func mergeEnvVariables(envVars map[string]string) []string { func mergeEnvVariables(envVars map[string]string) []string {

View File

@ -17,6 +17,18 @@
package e2e package e2e
func AddV2Args(args []string) []string { import (
return append(args, "--experimental-enable-v2v3", "v2/") "strings"
"go.uber.org/zap"
"go.etcd.io/etcd/pkg/v3/expect"
)
func SpawnCmd(args []string, envVars map[string]string) (*expect.ExpectProcess, error) {
return SpawnNamedCmd(strings.Join(args, "_"), args, envVars)
}
func SpawnNamedCmd(processName string, args []string, envVars map[string]string) (*expect.ExpectProcess, error) {
return SpawnCmdWithLogger(zap.NewNop(), args, envVars, processName)
} }