/
etcd.go
111 lines (97 loc) · 3.13 KB
/
etcd.go
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
// Package etcdtest provides test support for obtaining a client to an Etcd server.
//
package etcdtest
import (
"context"
"io/ioutil"
"log"
"os"
"os/exec"
"syscall"
"testing"
"time"
"go.etcd.io/etcd/client/v3"
)
// TestClient returns a client of the embedded Etcd test server. It asserts that
// the Etcd keyspace is empty before returning to the client. In other words,
// it asserts that the prior test cleaned up after itself.
func TestClient() *clientv3.Client {
var resp, err = _etcdClient.Get(context.Background(), "", clientv3.WithPrefix(), clientv3.WithLimit(5))
if err != nil {
log.Fatal(err)
} else if len(resp.Kvs) != 0 {
log.Fatalf("etcd not empty; did a previous test not clean up?\n%+v", resp)
}
return _etcdClient
}
// Cleanup is called at the completion of each test using TestClient,
// to remove any remaining key/value fixtures in the Etcd store.
func Cleanup() {
if _, err := _etcdClient.Delete(context.Background(), "", clientv3.WithPrefix()); err != nil {
log.Fatal(err)
}
}
var (
_cmd *exec.Cmd
_etcdClient *clientv3.Client
)
// TestMainWithEtcd is to be called by other packages which require
// functionality of the etcdtest package, before those tests run, as:
//
// func TestMain(m *testing.M) { etcdtest.TestMainWithEtcd(m) }
//
// This TestMain function is automatically invoked by the `go test`
// tool, providing an opportunity to start the embedded Etcd server
// prior to test invocations.
func TestMainWithEtcd(m *testing.M) {
_cmd = exec.Command("etcd",
"--listen-peer-urls", "unix://peer.sock:0",
"--listen-client-urls", "unix://client.sock:0",
"--advertise-client-urls", "unix://client.sock:0",
)
// The Etcd --log-level flag was added in v3.4. Use it's environment variable
// version to remain compatible with older `etcd` binaries.
_cmd.Env = append(_cmd.Env, "ETCD_LOG_LEVEL=error", "ETCD_LOGGER=zap")
_cmd.Env = append(_cmd.Env, os.Environ()...)
log.Println("Starting etcd: ", _cmd.Args)
var err error
if _cmd.Dir, err = ioutil.TempDir("", "etcdtest"); err != nil {
log.Fatal(err)
}
_cmd.Stdout = os.Stdout
_cmd.Stderr = os.Stderr
// If this process dies (e.x, due to an uncaught panic from a
// test timeout), deliver a SIGTERM to the `etcd` process).
// This ensures a wrapping `go test` doesn't hang forever awaiting
// the `etcd` child to exit.
_cmd.SysProcAttr = new(syscall.SysProcAttr)
_cmd.SysProcAttr.Pdeathsig = syscall.SIGTERM
if err = _cmd.Start(); err != nil {
log.Fatal(err)
}
os.Exit(func() int {
// Defer Etcd tear-down.
defer func() {
if err = _cmd.Process.Signal(syscall.SIGTERM); err != nil {
log.Fatal("failed to TERM etcd: ", err)
}
_ = _cmd.Wait()
if err = os.RemoveAll(_cmd.Dir); err != nil {
log.Fatalf("failed to remove etcd tmp directory %v: %v", _cmd.Dir, err)
}
}()
// Build client.
var ep = "unix://" + _cmd.Dir + "/client.sock:0"
log.Println("using test endpoint: " + ep)
if _etcdClient, err = clientv3.New(clientv3.Config{
Endpoints: []string{ep},
DialTimeout: 5 * time.Second,
}); err != nil {
log.Fatal(err)
}
// Verify test client works.
_ = TestClient()
// Run tests.
return m.Run()
}())
}