Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve functional test code

Browse Source 
Get duplicated code wraped in common functions, and simplify
error handling.

Signed-off-by: Benjamin Wang <wachao@vmware.com>
This commit is contained in:
Benjamin Wang 2022-08-15 16:59:39 +08:00
parent a1405e9633
commit bba4eb4d81
4 changed files with 73 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

150
tests/functional/agent/handler.go
View File

@ -86,8 +86,7 @@ func (srv *Server) handleTesterRequest(req *rpcpb.Request) (resp *rpcpb.Response
// just archive the first file // just archive the first file
func (srv *Server) createEtcdLogFile() error { func (srv *Server) createEtcdLogFile() error {
var err error var err error
srv.etcdLogFile, err = os.Create(srv.Member.Etcd.LogOutputs[0]) if srv.etcdLogFile, err = os.Create(srv.Member.Etcd.LogOutputs[0]); err != nil {
if err != nil {
return err return err
} }
srv.lg.Info("created etcd log file", zap.String("path", srv.Member.Etcd.LogOutputs[0])) srv.lg.Info("created etcd log file", zap.String("path", srv.Member.Etcd.LogOutputs[0]))
@ -172,8 +171,7 @@ func (srv *Server) stopEtcd(sig os.Signal) error {
zap.String("signal", sig.String()), zap.String("signal", sig.String()),
) )
err := srv.etcdCmd.Process.Signal(sig) if err := srv.etcdCmd.Process.Signal(sig); err != nil {
if err != nil {
return err return err
} }
@ -191,7 +189,7 @@ func (srv *Server) stopEtcd(sig os.Signal) error {
return e return e
} }
err = <-errc err := <-errc
srv.lg.Info( srv.lg.Info(
"stopped etcd command", "stopped etcd command",
@ -306,29 +304,16 @@ func (srv *Server) stopProxy() {
// if started with manual TLS, stores TLS assets // if started with manual TLS, stores TLS assets
// from tester/client to disk before starting etcd process // from tester/client to disk before starting etcd process
func (srv *Server) saveTLSAssets() error { func (srv *Server) saveTLSAssets() error {
if srv.Member.PeerCertPath != "" { const defaultFileMode os.FileMode = 0644
if srv.Member.PeerCertData == "" {
return fmt.Errorf("got empty data for %q", srv.Member.PeerCertPath) if err := safeDataToFile(srv.Member.PeerCertPath, []byte(srv.Member.PeerCertData), defaultFileMode); err != nil {
} return err
if err := os.WriteFile(srv.Member.PeerCertPath, []byte(srv.Member.PeerCertData), 0644); err != nil {
return err
}
} }
if srv.Member.PeerKeyPath != "" { if err := safeDataToFile(srv.Member.PeerKeyPath, []byte(srv.Member.PeerKeyData), defaultFileMode); err != nil {
if srv.Member.PeerKeyData == "" { return err
return fmt.Errorf("got empty data for %q", srv.Member.PeerKeyPath)
}
if err := os.WriteFile(srv.Member.PeerKeyPath, []byte(srv.Member.PeerKeyData), 0644); err != nil {
return err
}
} }
if srv.Member.PeerTrustedCAPath != "" { if err := safeDataToFile(srv.Member.PeerTrustedCAPath, []byte(srv.Member.PeerTrustedCAData), defaultFileMode); err != nil {
if srv.Member.PeerTrustedCAData == "" { return err
return fmt.Errorf("got empty data for %q", srv.Member.PeerTrustedCAPath)
}
if err := os.WriteFile(srv.Member.PeerTrustedCAPath, []byte(srv.Member.PeerTrustedCAData), 0644); err != nil {
return err
}
} }
if srv.Member.PeerCertPath != "" && if srv.Member.PeerCertPath != "" &&
srv.Member.PeerKeyPath != "" && srv.Member.PeerKeyPath != "" &&
@ -341,29 +326,14 @@ func (srv *Server) saveTLSAssets() error {
) )
} }
if srv.Member.ClientCertPath != "" { if err := safeDataToFile(srv.Member.ClientCertPath, []byte(srv.Member.ClientCertData), defaultFileMode); err != nil {
if srv.Member.ClientCertData == "" { return err
return fmt.Errorf("got empty data for %q", srv.Member.ClientCertPath)
}
if err := os.WriteFile(srv.Member.ClientCertPath, []byte(srv.Member.ClientCertData), 0644); err != nil {
return err
}
} }
if srv.Member.ClientKeyPath != "" { if err := safeDataToFile(srv.Member.ClientKeyPath, []byte(srv.Member.ClientKeyData), defaultFileMode); err != nil {
if srv.Member.ClientKeyData == "" { return err
return fmt.Errorf("got empty data for %q", srv.Member.ClientKeyPath)
}
if err := os.WriteFile(srv.Member.ClientKeyPath, []byte(srv.Member.ClientKeyData), 0644); err != nil {
return err
}
} }
if srv.Member.ClientTrustedCAPath != "" { if err := safeDataToFile(srv.Member.ClientTrustedCAPath, []byte(srv.Member.ClientTrustedCAData), defaultFileMode); err != nil {
if srv.Member.ClientTrustedCAData == "" { return err
return fmt.Errorf("got empty data for %q", srv.Member.ClientTrustedCAPath)
}
if err := os.WriteFile(srv.Member.ClientTrustedCAPath, []byte(srv.Member.ClientTrustedCAData), 0644); err != nil {
return err
}
} }
if srv.Member.ClientCertPath != "" && if srv.Member.ClientCertPath != "" &&
srv.Member.ClientKeyPath != "" && srv.Member.ClientKeyPath != "" &&
@ -390,24 +360,18 @@ func (srv *Server) loadAutoTLSAssets() error {
zap.String("dir", fdir), zap.String("dir", fdir),
zap.String("endpoint", srv.EtcdClientEndpoint), zap.String("endpoint", srv.EtcdClientEndpoint),
) )
// load peer cert.pem
certPath := filepath.Join(fdir, "cert.pem") certPath := filepath.Join(fdir, "cert.pem")
if !fileutil.Exist(certPath) { certData, err := loadFileData(certPath)
return fmt.Errorf("cannot find %q", certPath)
}
certData, err := os.ReadFile(certPath)
if err != nil { if err != nil {
return fmt.Errorf("cannot read %q (%v)", certPath, err) return err
} }
srv.Member.PeerCertData = string(certData) srv.Member.PeerCertData = string(certData)
// load peer key.pem
keyPath := filepath.Join(fdir, "key.pem") keyPath := filepath.Join(fdir, "key.pem")
if !fileutil.Exist(keyPath) { keyData, err := loadFileData(keyPath)
return fmt.Errorf("cannot find %q", keyPath)
}
keyData, err := os.ReadFile(keyPath)
if err != nil { if err != nil {
return fmt.Errorf("cannot read %q (%v)", keyPath, err) return err
} }
srv.Member.PeerKeyData = string(keyData) srv.Member.PeerKeyData = string(keyData)
@ -431,24 +395,18 @@ func (srv *Server) loadAutoTLSAssets() error {
zap.String("dir", fdir), zap.String("dir", fdir),
zap.String("endpoint", srv.EtcdClientEndpoint), zap.String("endpoint", srv.EtcdClientEndpoint),
) )
// load client cert.pem
certPath := filepath.Join(fdir, "cert.pem") certPath := filepath.Join(fdir, "cert.pem")
if !fileutil.Exist(certPath) { certData, err := loadFileData(certPath)
return fmt.Errorf("cannot find %q", certPath)
}
certData, err := os.ReadFile(certPath)
if err != nil { if err != nil {
return fmt.Errorf("cannot read %q (%v)", certPath, err) return err
} }
srv.Member.ClientCertData = string(certData) srv.Member.ClientCertData = string(certData)
// load client key.pem
keyPath := filepath.Join(fdir, "key.pem") keyPath := filepath.Join(fdir, "key.pem")
if !fileutil.Exist(keyPath) { keyData, err := loadFileData(keyPath)
return fmt.Errorf("cannot find %q", keyPath)
}
keyData, err := os.ReadFile(keyPath)
if err != nil { if err != nil {
return fmt.Errorf("cannot read %q (%v)", keyPath, err) return err
} }
srv.Member.ClientKeyData = string(keyData) srv.Member.ClientKeyData = string(keyData)
@ -473,28 +431,27 @@ func (srv *Server) handle_INITIAL_START_ETCD(req *rpcpb.Request) (*rpcpb.Respons
}, nil }, nil
} }
err := fileutil.TouchDirAll(srv.lg, srv.Member.BaseDir) if err := fileutil.TouchDirAll(srv.lg, srv.Member.BaseDir); err != nil {
if err != nil {
return nil, err return nil, err
} }
srv.lg.Info("created base directory", zap.String("path", srv.Member.BaseDir)) srv.lg.Info("created base directory", zap.String("path", srv.Member.BaseDir))
if srv.etcdServer == nil { if srv.etcdServer == nil {
if err = srv.createEtcdLogFile(); err != nil { if err := srv.createEtcdLogFile(); err != nil {
return nil, err return nil, err
} }
} }
if err = srv.saveTLSAssets(); err != nil { if err := srv.saveTLSAssets(); err != nil {
return nil, err return nil, err
} }
if err = srv.createEtcd(false, req.Member.Failpoints); err != nil { if err := srv.createEtcd(false, req.Member.Failpoints); err != nil {
return nil, err return nil, err
} }
if err = srv.runEtcd(); err != nil { if err := srv.runEtcd(); err != nil {
return nil, err return nil, err
} }
if err = srv.loadAutoTLSAssets(); err != nil { if err := srv.loadAutoTLSAssets(); err != nil {
return nil, err return nil, err
} }
@ -508,8 +465,7 @@ func (srv *Server) handle_INITIAL_START_ETCD(req *rpcpb.Request) (*rpcpb.Respons
func (srv *Server) handle_RESTART_ETCD(req *rpcpb.Request) (*rpcpb.Response, error) { func (srv *Server) handle_RESTART_ETCD(req *rpcpb.Request) (*rpcpb.Response, error) {
var err error var err error
if !fileutil.Exist(srv.Member.BaseDir) { if !fileutil.Exist(srv.Member.BaseDir) {
err = fileutil.TouchDirAll(srv.lg, srv.Member.BaseDir) if err = fileutil.TouchDirAll(srv.lg, srv.Member.BaseDir); err != nil {
if err != nil {
return nil, err return nil, err
} }
} }
@ -552,8 +508,7 @@ func (srv *Server) handle_SIGTERM_ETCD() (*rpcpb.Response, error) {
} }
func (srv *Server) handle_SIGQUIT_ETCD_AND_REMOVE_DATA() (*rpcpb.Response, error) { func (srv *Server) handle_SIGQUIT_ETCD_AND_REMOVE_DATA() (*rpcpb.Response, error) {
err := srv.stopEtcd(syscall.SIGQUIT) if err := srv.stopEtcd(syscall.SIGQUIT); err != nil {
if err != nil {
return nil, err return nil, err
} }
@ -565,10 +520,10 @@ func (srv *Server) handle_SIGQUIT_ETCD_AND_REMOVE_DATA() (*rpcpb.Response, error
} }
// for debugging purposes, rename instead of removing // for debugging purposes, rename instead of removing
if err = os.RemoveAll(srv.Member.BaseDir + ".backup"); err != nil { if err := os.RemoveAll(srv.Member.BaseDir + ".backup"); err != nil {
return nil, err return nil, err
} }
if err = os.Rename(srv.Member.BaseDir, srv.Member.BaseDir+".backup"); err != nil { if err := os.Rename(srv.Member.BaseDir, srv.Member.BaseDir+".backup"); err != nil {
return nil, err return nil, err
} }
srv.lg.Info( srv.lg.Info(
@ -579,8 +534,7 @@ func (srv *Server) handle_SIGQUIT_ETCD_AND_REMOVE_DATA() (*rpcpb.Response, error
// create a new log file for next new member restart // create a new log file for next new member restart
if !fileutil.Exist(srv.Member.BaseDir) { if !fileutil.Exist(srv.Member.BaseDir) {
err = fileutil.TouchDirAll(srv.lg, srv.Member.BaseDir) if err := fileutil.TouchDirAll(srv.lg, srv.Member.BaseDir); err != nil {
if err != nil {
return nil, err return nil, err
} }
} }
@ -592,8 +546,7 @@ func (srv *Server) handle_SIGQUIT_ETCD_AND_REMOVE_DATA() (*rpcpb.Response, error
} }
func (srv *Server) handle_SAVE_SNAPSHOT() (*rpcpb.Response, error) { func (srv *Server) handle_SAVE_SNAPSHOT() (*rpcpb.Response, error) {
err := srv.Member.SaveSnapshot(srv.lg) if err := srv.Member.SaveSnapshot(srv.lg); err != nil {
if err != nil {
return nil, err return nil, err
} }
return &rpcpb.Response{ return &rpcpb.Response{
@ -604,8 +557,7 @@ func (srv *Server) handle_SAVE_SNAPSHOT() (*rpcpb.Response, error) {
} }
func (srv *Server) handle_RESTORE_RESTART_FROM_SNAPSHOT(req *rpcpb.Request) (resp *rpcpb.Response, err error) { func (srv *Server) handle_RESTORE_RESTART_FROM_SNAPSHOT(req *rpcpb.Request) (resp *rpcpb.Response, err error) {
err = srv.Member.RestoreSnapshot(srv.lg) if err = srv.Member.RestoreSnapshot(srv.lg); err != nil {
if err != nil {
return nil, err return nil, err
} }
resp, err = srv.handle_RESTART_FROM_SNAPSHOT(req) resp, err = srv.handle_RESTART_FROM_SNAPSHOT(req)
@ -637,8 +589,7 @@ func (srv *Server) handle_RESTART_FROM_SNAPSHOT(req *rpcpb.Request) (resp *rpcpb
} }
func (srv *Server) handle_SIGQUIT_ETCD_AND_ARCHIVE_DATA() (*rpcpb.Response, error) { func (srv *Server) handle_SIGQUIT_ETCD_AND_ARCHIVE_DATA() (*rpcpb.Response, error) {
err := srv.stopEtcd(syscall.SIGQUIT) if err := srv.stopEtcd(syscall.SIGQUIT); err != nil {
if err != nil {
return nil, err return nil, err
} }
@ -650,18 +601,13 @@ func (srv *Server) handle_SIGQUIT_ETCD_AND_ARCHIVE_DATA() (*rpcpb.Response, erro
} }
// TODO: support separate WAL directory // TODO: support separate WAL directory
if err = archive( if err := archive(srv.lg, srv.Member.BaseDir, srv.Member.Etcd.LogOutputs[0], srv.Member.Etcd.DataDir); err != nil {
srv.lg,
srv.Member.BaseDir,
srv.Member.Etcd.LogOutputs[0],
srv.Member.Etcd.DataDir,
); err != nil {
return nil, err return nil, err
} }
srv.lg.Info("archived data", zap.String("base-dir", srv.Member.BaseDir)) srv.lg.Info("archived data", zap.String("base-dir", srv.Member.BaseDir))
if srv.etcdServer == nil { if srv.etcdServer == nil {
if err = srv.createEtcdLogFile(); err != nil { if err := srv.createEtcdLogFile(); err != nil {
return nil, err return nil, err
} }
} }
@ -681,8 +627,7 @@ func (srv *Server) handle_SIGQUIT_ETCD_AND_ARCHIVE_DATA() (*rpcpb.Response, erro
// stop proxy, etcd, delete data directory // stop proxy, etcd, delete data directory
func (srv *Server) handle_SIGQUIT_ETCD_AND_REMOVE_DATA_AND_STOP_AGENT() (*rpcpb.Response, error) { func (srv *Server) handle_SIGQUIT_ETCD_AND_REMOVE_DATA_AND_STOP_AGENT() (*rpcpb.Response, error) {
err := srv.stopEtcd(syscall.SIGQUIT) if err := srv.stopEtcd(syscall.SIGQUIT); err != nil {
if err != nil {
return nil, err return nil, err
} }
@ -693,8 +638,7 @@ func (srv *Server) handle_SIGQUIT_ETCD_AND_REMOVE_DATA_AND_STOP_AGENT() (*rpcpb.
srv.etcdLogFile.Close() srv.etcdLogFile.Close()
} }
err = os.RemoveAll(srv.Member.BaseDir) if err := os.RemoveAll(srv.Member.BaseDir); err != nil {
if err != nil {
return nil, err return nil, err
} }
srv.lg.Info("removed base directory", zap.String("dir", srv.Member.BaseDir)) srv.lg.Info("removed base directory", zap.String("dir", srv.Member.BaseDir))

6
tests/functional/agent/server.go
View File

@ -138,12 +138,6 @@ func (srv *Server) Transport(stream rpcpb.Transport_TransportServer) (reterr err
// TODO: handle error and retry // TODO: handle error and retry
return return
} }
if req.Member != nil {
srv.Member = req.Member
}
if req.Tester != nil {
srv.Tester = req.Tester
}
var resp *rpcpb.Response var resp *rpcpb.Response
resp, err = srv.handleTesterRequest(req) resp, err = srv.handleTesterRequest(req)

24
tests/functional/agent/utils.go
View File

@ -15,6 +15,7 @@
package agent package agent
import ( import (
"fmt"
"io" "io"
"net" "net"
"net/url" "net/url"
@ -102,6 +103,29 @@ func copyFile(src, dst string) error {
return w.Sync() return w.Sync()
} }
func safeDataToFile(filePath string, fileData []byte, mode os.FileMode) error {
if filePath != "" {
if len(fileData) == 0 {
return fmt.Errorf("got empty data for %q", filePath)
}
if err := os.WriteFile(filePath, fileData, mode); err != nil {
return fmt.Errorf("writing file %q failed, %w", filePath, err)
}
}
return nil
}
func loadFileData(filePath string) ([]byte, error) {
if !fileutil.Exist(filePath) {
return nil, fmt.Errorf("cannot find %q", filePath)
}
data, err := os.ReadFile(filePath)
if err != nil {
return nil, fmt.Errorf("read file %q failed, %w", filePath, err)
}
return data, nil
}
func cleanPageCache() error { func cleanPageCache() error {
// https://www.kernel.org/doc/Documentation/sysctl/vm.txt // https://www.kernel.org/doc/Documentation/sysctl/vm.txt
// https://github.com/torvalds/linux/blob/master/fs/drop_caches.c // https://github.com/torvalds/linux/blob/master/fs/drop_caches.c

6
tests/functional/cmd/etcd-tester/etcd_tester_test.go
View File

@ -38,15 +38,13 @@ func TestFunctional(t *testing.T) {
t.Fatalf("failed to create a cluster: %v", err) t.Fatalf("failed to create a cluster: %v", err)
} }
err = clus.Send_INITIAL_START_ETCD() if err = clus.Send_INITIAL_START_ETCD(); err != nil {
if err != nil {
t.Fatal("Bootstrap failed", zap.Error(err)) t.Fatal("Bootstrap failed", zap.Error(err))
} }
defer clus.Send_SIGQUIT_ETCD_AND_REMOVE_DATA_AND_STOP_AGENT() defer clus.Send_SIGQUIT_ETCD_AND_REMOVE_DATA_AND_STOP_AGENT()
t.Log("wait health after bootstrap") t.Log("wait health after bootstrap")
err = clus.WaitHealth() if err = clus.WaitHealth(); err != nil {
if err != nil {
t.Fatal("WaitHealth failed", zap.Error(err)) t.Fatal("WaitHealth failed", zap.Error(err))
} }