cluster.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904
  1. // Copyright 2016 The etcd Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package integration
  15. import (
  16. "crypto/tls"
  17. "fmt"
  18. "io/ioutil"
  19. "math/rand"
  20. "net"
  21. "net/http"
  22. "net/http/httptest"
  23. "os"
  24. "reflect"
  25. "sort"
  26. "strings"
  27. "sync"
  28. "sync/atomic"
  29. "testing"
  30. "time"
  31. "golang.org/x/net/context"
  32. "google.golang.org/grpc"
  33. "github.com/coreos/etcd/client"
  34. "github.com/coreos/etcd/clientv3"
  35. "github.com/coreos/etcd/etcdserver"
  36. "github.com/coreos/etcd/etcdserver/api/v2http"
  37. "github.com/coreos/etcd/etcdserver/api/v3rpc"
  38. pb "github.com/coreos/etcd/etcdserver/etcdserverpb"
  39. "github.com/coreos/etcd/pkg/testutil"
  40. "github.com/coreos/etcd/pkg/transport"
  41. "github.com/coreos/etcd/pkg/types"
  42. "github.com/coreos/etcd/rafthttp"
  43. "github.com/coreos/pkg/capnslog"
  44. )
  45. const (
  46. tickDuration = 10 * time.Millisecond
  47. clusterName = "etcd"
  48. requestTimeout = 20 * time.Second
  49. basePort = 21000
  50. UrlScheme = "unix"
  51. UrlSchemeTLS = "unixs"
  52. )
  53. var (
  54. electionTicks = 10
  55. // integration test uses unique ports, counting up, to listen for each
  56. // member, ensuring restarted members can listen on the same port again.
  57. localListenCount int64 = 0
  58. testTLSInfo = transport.TLSInfo{
  59. KeyFile: "./fixtures/server.key.insecure",
  60. CertFile: "./fixtures/server.crt",
  61. TrustedCAFile: "./fixtures/ca.crt",
  62. ClientCertAuth: true,
  63. }
  64. plog = capnslog.NewPackageLogger("github.com/coreos/etcd", "integration")
  65. )
  66. type ClusterConfig struct {
  67. Size int
  68. PeerTLS *transport.TLSInfo
  69. ClientTLS *transport.TLSInfo
  70. DiscoveryURL string
  71. UseGRPC bool
  72. QuotaBackendBytes int64
  73. }
  74. type cluster struct {
  75. cfg *ClusterConfig
  76. Members []*member
  77. }
  78. func schemeFromTLSInfo(tls *transport.TLSInfo) string {
  79. if tls == nil {
  80. return UrlScheme
  81. }
  82. return UrlSchemeTLS
  83. }
  84. func (c *cluster) fillClusterForMembers() error {
  85. if c.cfg.DiscoveryURL != "" {
  86. // cluster will be discovered
  87. return nil
  88. }
  89. addrs := make([]string, 0)
  90. for _, m := range c.Members {
  91. scheme := schemeFromTLSInfo(m.PeerTLSInfo)
  92. for _, l := range m.PeerListeners {
  93. addrs = append(addrs, fmt.Sprintf("%s=%s://%s", m.Name, scheme, l.Addr().String()))
  94. }
  95. }
  96. clusterStr := strings.Join(addrs, ",")
  97. var err error
  98. for _, m := range c.Members {
  99. m.InitialPeerURLsMap, err = types.NewURLsMap(clusterStr)
  100. if err != nil {
  101. return err
  102. }
  103. }
  104. return nil
  105. }
  106. func newCluster(t *testing.T, cfg *ClusterConfig) *cluster {
  107. c := &cluster{cfg: cfg}
  108. ms := make([]*member, cfg.Size)
  109. for i := 0; i < cfg.Size; i++ {
  110. ms[i] = c.mustNewMember(t)
  111. }
  112. c.Members = ms
  113. if err := c.fillClusterForMembers(); err != nil {
  114. t.Fatal(err)
  115. }
  116. return c
  117. }
  118. // NewCluster returns an unlaunched cluster of the given size which has been
  119. // set to use static bootstrap.
  120. func NewCluster(t *testing.T, size int) *cluster {
  121. return newCluster(t, &ClusterConfig{Size: size})
  122. }
  123. // NewClusterByConfig returns an unlaunched cluster defined by a cluster configuration
  124. func NewClusterByConfig(t *testing.T, cfg *ClusterConfig) *cluster {
  125. return newCluster(t, cfg)
  126. }
  127. func (c *cluster) Launch(t *testing.T) {
  128. errc := make(chan error)
  129. for _, m := range c.Members {
  130. // Members are launched in separate goroutines because if they boot
  131. // using discovery url, they have to wait for others to register to continue.
  132. go func(m *member) {
  133. errc <- m.Launch()
  134. }(m)
  135. }
  136. for range c.Members {
  137. if err := <-errc; err != nil {
  138. t.Fatalf("error setting up member: %v", err)
  139. }
  140. }
  141. // wait cluster to be stable to receive future client requests
  142. c.waitMembersMatch(t, c.HTTPMembers())
  143. c.waitVersion()
  144. }
  145. func (c *cluster) URL(i int) string {
  146. return c.Members[i].ClientURLs[0].String()
  147. }
  148. // URLs returns a list of all active client URLs in the cluster
  149. func (c *cluster) URLs() []string {
  150. return getMembersURLs(c.Members)
  151. }
  152. func getMembersURLs(members []*member) []string {
  153. urls := make([]string, 0)
  154. for _, m := range members {
  155. select {
  156. case <-m.s.StopNotify():
  157. continue
  158. default:
  159. }
  160. for _, u := range m.ClientURLs {
  161. urls = append(urls, u.String())
  162. }
  163. }
  164. return urls
  165. }
  166. // HTTPMembers returns a list of all active members as client.Members
  167. func (c *cluster) HTTPMembers() []client.Member {
  168. ms := []client.Member{}
  169. for _, m := range c.Members {
  170. pScheme := schemeFromTLSInfo(m.PeerTLSInfo)
  171. cScheme := schemeFromTLSInfo(m.ClientTLSInfo)
  172. cm := client.Member{Name: m.Name}
  173. for _, ln := range m.PeerListeners {
  174. cm.PeerURLs = append(cm.PeerURLs, pScheme+"://"+ln.Addr().String())
  175. }
  176. for _, ln := range m.ClientListeners {
  177. cm.ClientURLs = append(cm.ClientURLs, cScheme+"://"+ln.Addr().String())
  178. }
  179. ms = append(ms, cm)
  180. }
  181. return ms
  182. }
  183. func (c *cluster) mustNewMember(t *testing.T) *member {
  184. m := mustNewMember(t,
  185. memberConfig{
  186. name: c.name(rand.Int()),
  187. peerTLS: c.cfg.PeerTLS,
  188. clientTLS: c.cfg.ClientTLS,
  189. quotaBackendBytes: c.cfg.QuotaBackendBytes,
  190. })
  191. m.DiscoveryURL = c.cfg.DiscoveryURL
  192. if c.cfg.UseGRPC {
  193. if err := m.listenGRPC(); err != nil {
  194. t.Fatal(err)
  195. }
  196. }
  197. return m
  198. }
  199. func (c *cluster) addMember(t *testing.T) {
  200. m := c.mustNewMember(t)
  201. scheme := schemeFromTLSInfo(c.cfg.PeerTLS)
  202. // send add request to the cluster
  203. var err error
  204. for i := 0; i < len(c.Members); i++ {
  205. clientURL := c.URL(i)
  206. peerURL := scheme + "://" + m.PeerListeners[0].Addr().String()
  207. if err = c.addMemberByURL(t, clientURL, peerURL); err == nil {
  208. break
  209. }
  210. }
  211. if err != nil {
  212. t.Fatalf("add member failed on all members error: %v", err)
  213. }
  214. m.InitialPeerURLsMap = types.URLsMap{}
  215. for _, mm := range c.Members {
  216. m.InitialPeerURLsMap[mm.Name] = mm.PeerURLs
  217. }
  218. m.InitialPeerURLsMap[m.Name] = m.PeerURLs
  219. m.NewCluster = false
  220. if err := m.Launch(); err != nil {
  221. t.Fatal(err)
  222. }
  223. c.Members = append(c.Members, m)
  224. // wait cluster to be stable to receive future client requests
  225. c.waitMembersMatch(t, c.HTTPMembers())
  226. }
  227. func (c *cluster) addMemberByURL(t *testing.T, clientURL, peerURL string) error {
  228. cc := MustNewHTTPClient(t, []string{clientURL}, c.cfg.ClientTLS)
  229. ma := client.NewMembersAPI(cc)
  230. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  231. if _, err := ma.Add(ctx, peerURL); err != nil {
  232. return err
  233. }
  234. cancel()
  235. // wait for the add node entry applied in the cluster
  236. members := append(c.HTTPMembers(), client.Member{PeerURLs: []string{peerURL}, ClientURLs: []string{}})
  237. c.waitMembersMatch(t, members)
  238. return nil
  239. }
  240. func (c *cluster) AddMember(t *testing.T) {
  241. c.addMember(t)
  242. }
  243. func (c *cluster) RemoveMember(t *testing.T, id uint64) {
  244. if err := c.removeMember(t, id); err != nil {
  245. t.Fatal(err)
  246. }
  247. }
  248. func (c *cluster) removeMember(t *testing.T, id uint64) error {
  249. // send remove request to the cluster
  250. cc := MustNewHTTPClient(t, c.URLs(), c.cfg.ClientTLS)
  251. ma := client.NewMembersAPI(cc)
  252. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  253. if err := ma.Remove(ctx, types.ID(id).String()); err != nil {
  254. return err
  255. }
  256. cancel()
  257. newMembers := make([]*member, 0)
  258. for _, m := range c.Members {
  259. if uint64(m.s.ID()) != id {
  260. newMembers = append(newMembers, m)
  261. } else {
  262. select {
  263. case <-m.s.StopNotify():
  264. m.Terminate(t)
  265. // 1s stop delay + election timeout + 1s disk and network delay + connection write timeout
  266. // TODO: remove connection write timeout by selecting on http response closeNotifier
  267. // blocking on https://github.com/golang/go/issues/9524
  268. case <-time.After(time.Second + time.Duration(electionTicks)*tickDuration + time.Second + rafthttp.ConnWriteTimeout):
  269. t.Fatalf("failed to remove member %s in time", m.s.ID())
  270. }
  271. }
  272. }
  273. c.Members = newMembers
  274. c.waitMembersMatch(t, c.HTTPMembers())
  275. return nil
  276. }
  277. func (c *cluster) Terminate(t *testing.T) {
  278. for _, m := range c.Members {
  279. m.Terminate(t)
  280. }
  281. }
  282. func (c *cluster) waitMembersMatch(t *testing.T, membs []client.Member) {
  283. for _, u := range c.URLs() {
  284. cc := MustNewHTTPClient(t, []string{u}, c.cfg.ClientTLS)
  285. ma := client.NewMembersAPI(cc)
  286. for {
  287. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  288. ms, err := ma.List(ctx)
  289. cancel()
  290. if err == nil && isMembersEqual(ms, membs) {
  291. break
  292. }
  293. time.Sleep(tickDuration)
  294. }
  295. }
  296. return
  297. }
  298. func (c *cluster) WaitLeader(t *testing.T) int { return c.waitLeader(t, c.Members) }
  299. // waitLeader waits until given members agree on the same leader.
  300. func (c *cluster) waitLeader(t *testing.T, membs []*member) int {
  301. possibleLead := make(map[uint64]bool)
  302. var lead uint64
  303. for _, m := range membs {
  304. possibleLead[uint64(m.s.ID())] = true
  305. }
  306. cc := MustNewHTTPClient(t, getMembersURLs(membs), nil)
  307. kapi := client.NewKeysAPI(cc)
  308. // ensure leader is up via linearizable get
  309. for {
  310. ctx, cancel := context.WithTimeout(context.Background(), 10*tickDuration)
  311. _, err := kapi.Get(ctx, "0", &client.GetOptions{Quorum: true})
  312. cancel()
  313. if err == nil || strings.Contains(err.Error(), "Key not found") {
  314. break
  315. }
  316. }
  317. for lead == 0 || !possibleLead[lead] {
  318. lead = 0
  319. for _, m := range membs {
  320. select {
  321. case <-m.s.StopNotify():
  322. continue
  323. default:
  324. }
  325. if lead != 0 && lead != m.s.Lead() {
  326. lead = 0
  327. time.Sleep(10 * tickDuration)
  328. break
  329. }
  330. lead = m.s.Lead()
  331. }
  332. }
  333. for i, m := range membs {
  334. if uint64(m.s.ID()) == lead {
  335. return i
  336. }
  337. }
  338. return -1
  339. }
  340. func (c *cluster) WaitNoLeader(t *testing.T) { c.waitNoLeader(t, c.Members) }
  341. // waitNoLeader waits until given members lose leader.
  342. func (c *cluster) waitNoLeader(t *testing.T, membs []*member) {
  343. noLeader := false
  344. for !noLeader {
  345. noLeader = true
  346. for _, m := range membs {
  347. select {
  348. case <-m.s.StopNotify():
  349. continue
  350. default:
  351. }
  352. if m.s.Lead() != 0 {
  353. noLeader = false
  354. time.Sleep(10 * tickDuration)
  355. break
  356. }
  357. }
  358. }
  359. }
  360. func (c *cluster) waitVersion() {
  361. for _, m := range c.Members {
  362. for {
  363. if m.s.ClusterVersion() != nil {
  364. break
  365. }
  366. time.Sleep(tickDuration)
  367. }
  368. }
  369. }
  370. func (c *cluster) name(i int) string {
  371. return fmt.Sprint(i)
  372. }
  373. // isMembersEqual checks whether two members equal except ID field.
  374. // The given wmembs should always set ID field to empty string.
  375. func isMembersEqual(membs []client.Member, wmembs []client.Member) bool {
  376. sort.Sort(SortableMemberSliceByPeerURLs(membs))
  377. sort.Sort(SortableMemberSliceByPeerURLs(wmembs))
  378. for i := range membs {
  379. membs[i].ID = ""
  380. }
  381. return reflect.DeepEqual(membs, wmembs)
  382. }
  383. func newLocalListener(t *testing.T) net.Listener {
  384. c := atomic.AddInt64(&localListenCount, 1)
  385. // Go 1.8+ allows only numbers in port
  386. addr := fmt.Sprintf("127.0.0.1:%05d%05d", c+basePort, os.Getpid())
  387. return NewListenerWithAddr(t, addr)
  388. }
  389. func NewListenerWithAddr(t *testing.T, addr string) net.Listener {
  390. l, err := transport.NewUnixListener(addr)
  391. if err != nil {
  392. t.Fatal(err)
  393. }
  394. return l
  395. }
  396. type member struct {
  397. etcdserver.ServerConfig
  398. PeerListeners, ClientListeners []net.Listener
  399. grpcListener net.Listener
  400. // PeerTLSInfo enables peer TLS when set
  401. PeerTLSInfo *transport.TLSInfo
  402. // ClientTLSInfo enables client TLS when set
  403. ClientTLSInfo *transport.TLSInfo
  404. raftHandler *testutil.PauseableHandler
  405. s *etcdserver.EtcdServer
  406. hss []*httptest.Server
  407. grpcServer *grpc.Server
  408. grpcAddr string
  409. grpcBridge *bridge
  410. }
  411. func (m *member) GRPCAddr() string { return m.grpcAddr }
  412. type memberConfig struct {
  413. name string
  414. peerTLS *transport.TLSInfo
  415. clientTLS *transport.TLSInfo
  416. quotaBackendBytes int64
  417. }
  418. // mustNewMember return an inited member with the given name. If peerTLS is
  419. // set, it will use https scheme to communicate between peers.
  420. func mustNewMember(t *testing.T, mcfg memberConfig) *member {
  421. var err error
  422. m := &member{}
  423. peerScheme := schemeFromTLSInfo(mcfg.peerTLS)
  424. clientScheme := schemeFromTLSInfo(mcfg.clientTLS)
  425. pln := newLocalListener(t)
  426. m.PeerListeners = []net.Listener{pln}
  427. m.PeerURLs, err = types.NewURLs([]string{peerScheme + "://" + pln.Addr().String()})
  428. if err != nil {
  429. t.Fatal(err)
  430. }
  431. m.PeerTLSInfo = mcfg.peerTLS
  432. cln := newLocalListener(t)
  433. m.ClientListeners = []net.Listener{cln}
  434. m.ClientURLs, err = types.NewURLs([]string{clientScheme + "://" + cln.Addr().String()})
  435. if err != nil {
  436. t.Fatal(err)
  437. }
  438. m.ClientTLSInfo = mcfg.clientTLS
  439. m.Name = mcfg.name
  440. m.DataDir, err = ioutil.TempDir(os.TempDir(), "etcd")
  441. if err != nil {
  442. t.Fatal(err)
  443. }
  444. clusterStr := fmt.Sprintf("%s=%s://%s", mcfg.name, peerScheme, pln.Addr().String())
  445. m.InitialPeerURLsMap, err = types.NewURLsMap(clusterStr)
  446. if err != nil {
  447. t.Fatal(err)
  448. }
  449. m.InitialClusterToken = clusterName
  450. m.NewCluster = true
  451. m.BootstrapTimeout = 10 * time.Millisecond
  452. if m.PeerTLSInfo != nil {
  453. m.ServerConfig.PeerTLSInfo = *m.PeerTLSInfo
  454. }
  455. m.ElectionTicks = electionTicks
  456. m.TickMs = uint(tickDuration / time.Millisecond)
  457. m.QuotaBackendBytes = mcfg.quotaBackendBytes
  458. return m
  459. }
  460. // listenGRPC starts a grpc server over a unix domain socket on the member
  461. func (m *member) listenGRPC() error {
  462. // prefix with localhost so cert has right domain
  463. m.grpcAddr = "localhost:" + m.Name
  464. l, err := transport.NewUnixListener(m.grpcAddr)
  465. if err != nil {
  466. return fmt.Errorf("listen failed on grpc socket %s (%v)", m.grpcAddr, err)
  467. }
  468. m.grpcBridge, err = newBridge(m.grpcAddr)
  469. if err != nil {
  470. l.Close()
  471. return err
  472. }
  473. m.grpcAddr = m.grpcBridge.URL()
  474. m.grpcListener = l
  475. return nil
  476. }
  477. func (m *member) electionTimeout() time.Duration {
  478. return time.Duration(m.s.Cfg.ElectionTicks) * time.Millisecond
  479. }
  480. func (m *member) DropConnections() { m.grpcBridge.Reset() }
  481. // NewClientV3 creates a new grpc client connection to the member
  482. func NewClientV3(m *member) (*clientv3.Client, error) {
  483. if m.grpcAddr == "" {
  484. return nil, fmt.Errorf("member not configured for grpc")
  485. }
  486. cfg := clientv3.Config{
  487. Endpoints: []string{m.grpcAddr},
  488. DialTimeout: 5 * time.Second,
  489. }
  490. if m.ClientTLSInfo != nil {
  491. tls, err := m.ClientTLSInfo.ClientConfig()
  492. if err != nil {
  493. return nil, err
  494. }
  495. cfg.TLS = tls
  496. }
  497. return newClientV3(cfg)
  498. }
  499. // Clone returns a member with the same server configuration. The returned
  500. // member will not set PeerListeners and ClientListeners.
  501. func (m *member) Clone(t *testing.T) *member {
  502. mm := &member{}
  503. mm.ServerConfig = m.ServerConfig
  504. var err error
  505. clientURLStrs := m.ClientURLs.StringSlice()
  506. mm.ClientURLs, err = types.NewURLs(clientURLStrs)
  507. if err != nil {
  508. // this should never fail
  509. panic(err)
  510. }
  511. peerURLStrs := m.PeerURLs.StringSlice()
  512. mm.PeerURLs, err = types.NewURLs(peerURLStrs)
  513. if err != nil {
  514. // this should never fail
  515. panic(err)
  516. }
  517. clusterStr := m.InitialPeerURLsMap.String()
  518. mm.InitialPeerURLsMap, err = types.NewURLsMap(clusterStr)
  519. if err != nil {
  520. // this should never fail
  521. panic(err)
  522. }
  523. mm.InitialClusterToken = m.InitialClusterToken
  524. mm.ElectionTicks = m.ElectionTicks
  525. mm.PeerTLSInfo = m.PeerTLSInfo
  526. mm.ClientTLSInfo = m.ClientTLSInfo
  527. return mm
  528. }
  529. // Launch starts a member based on ServerConfig, PeerListeners
  530. // and ClientListeners.
  531. func (m *member) Launch() error {
  532. plog.Printf("launching %s (%s)", m.Name, m.grpcAddr)
  533. var err error
  534. if m.s, err = etcdserver.NewServer(&m.ServerConfig); err != nil {
  535. return fmt.Errorf("failed to initialize the etcd server: %v", err)
  536. }
  537. m.s.SyncTicker = time.Tick(500 * time.Millisecond)
  538. m.s.Start()
  539. m.raftHandler = &testutil.PauseableHandler{Next: v2http.NewPeerHandler(m.s)}
  540. for _, ln := range m.PeerListeners {
  541. hs := &httptest.Server{
  542. Listener: ln,
  543. Config: &http.Server{Handler: m.raftHandler},
  544. }
  545. if m.PeerTLSInfo == nil {
  546. hs.Start()
  547. } else {
  548. hs.TLS, err = m.PeerTLSInfo.ServerConfig()
  549. if err != nil {
  550. return err
  551. }
  552. hs.StartTLS()
  553. }
  554. m.hss = append(m.hss, hs)
  555. }
  556. for _, ln := range m.ClientListeners {
  557. hs := &httptest.Server{
  558. Listener: ln,
  559. Config: &http.Server{Handler: v2http.NewClientHandler(m.s, m.ServerConfig.ReqTimeout())},
  560. }
  561. if m.ClientTLSInfo == nil {
  562. hs.Start()
  563. } else {
  564. hs.TLS, err = m.ClientTLSInfo.ServerConfig()
  565. if err != nil {
  566. return err
  567. }
  568. hs.StartTLS()
  569. }
  570. m.hss = append(m.hss, hs)
  571. }
  572. if m.grpcListener != nil {
  573. var (
  574. tlscfg *tls.Config
  575. )
  576. if m.ClientTLSInfo != nil && !m.ClientTLSInfo.Empty() {
  577. tlscfg, err = m.ClientTLSInfo.ServerConfig()
  578. if err != nil {
  579. return err
  580. }
  581. }
  582. m.grpcServer = v3rpc.Server(m.s, tlscfg)
  583. go m.grpcServer.Serve(m.grpcListener)
  584. }
  585. plog.Printf("launched %s (%s)", m.Name, m.grpcAddr)
  586. return nil
  587. }
  588. func (m *member) WaitOK(t *testing.T) {
  589. cc := MustNewHTTPClient(t, []string{m.URL()}, m.ClientTLSInfo)
  590. kapi := client.NewKeysAPI(cc)
  591. for {
  592. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  593. _, err := kapi.Get(ctx, "/", nil)
  594. if err != nil {
  595. time.Sleep(tickDuration)
  596. continue
  597. }
  598. cancel()
  599. break
  600. }
  601. for m.s.Leader() == 0 {
  602. time.Sleep(tickDuration)
  603. }
  604. }
  605. func (m *member) URL() string { return m.ClientURLs[0].String() }
  606. func (m *member) Pause() {
  607. m.raftHandler.Pause()
  608. m.s.PauseSending()
  609. }
  610. func (m *member) Resume() {
  611. m.raftHandler.Resume()
  612. m.s.ResumeSending()
  613. }
  614. // Close stops the member's etcdserver and closes its connections
  615. func (m *member) Close() {
  616. if m.grpcBridge != nil {
  617. m.grpcBridge.Close()
  618. m.grpcBridge = nil
  619. }
  620. if m.grpcServer != nil {
  621. m.grpcServer.Stop()
  622. m.grpcServer = nil
  623. }
  624. m.s.HardStop()
  625. for _, hs := range m.hss {
  626. hs.CloseClientConnections()
  627. hs.Close()
  628. }
  629. }
  630. // Stop stops the member, but the data dir of the member is preserved.
  631. func (m *member) Stop(t *testing.T) {
  632. plog.Printf("stopping %s (%s)", m.Name, m.grpcAddr)
  633. m.Close()
  634. m.hss = nil
  635. plog.Printf("stopped %s (%s)", m.Name, m.grpcAddr)
  636. }
  637. // checkLeaderTransition waits for leader transition, returning the new leader ID.
  638. func checkLeaderTransition(t *testing.T, m *member, oldLead uint64) uint64 {
  639. interval := time.Duration(m.s.Cfg.TickMs) * time.Millisecond
  640. for m.s.Lead() == 0 || (m.s.Lead() == oldLead) {
  641. time.Sleep(interval)
  642. }
  643. return m.s.Lead()
  644. }
  645. // StopNotify unblocks when a member stop completes
  646. func (m *member) StopNotify() <-chan struct{} {
  647. return m.s.StopNotify()
  648. }
  649. // Restart starts the member using the preserved data dir.
  650. func (m *member) Restart(t *testing.T) error {
  651. plog.Printf("restarting %s (%s)", m.Name, m.grpcAddr)
  652. newPeerListeners := make([]net.Listener, 0)
  653. for _, ln := range m.PeerListeners {
  654. newPeerListeners = append(newPeerListeners, NewListenerWithAddr(t, ln.Addr().String()))
  655. }
  656. m.PeerListeners = newPeerListeners
  657. newClientListeners := make([]net.Listener, 0)
  658. for _, ln := range m.ClientListeners {
  659. newClientListeners = append(newClientListeners, NewListenerWithAddr(t, ln.Addr().String()))
  660. }
  661. m.ClientListeners = newClientListeners
  662. if m.grpcListener != nil {
  663. if err := m.listenGRPC(); err != nil {
  664. t.Fatal(err)
  665. }
  666. }
  667. err := m.Launch()
  668. plog.Printf("restarted %s (%s)", m.Name, m.grpcAddr)
  669. return err
  670. }
  671. // Terminate stops the member and removes the data dir.
  672. func (m *member) Terminate(t *testing.T) {
  673. plog.Printf("terminating %s (%s)", m.Name, m.grpcAddr)
  674. m.Close()
  675. if err := os.RemoveAll(m.ServerConfig.DataDir); err != nil {
  676. t.Fatal(err)
  677. }
  678. plog.Printf("terminated %s (%s)", m.Name, m.grpcAddr)
  679. }
  680. // Metric gets the metric value for a member
  681. func (m *member) Metric(metricName string) (string, error) {
  682. cfgtls := transport.TLSInfo{}
  683. tr, err := transport.NewTimeoutTransport(cfgtls, time.Second, time.Second, time.Second)
  684. if err != nil {
  685. return "", err
  686. }
  687. cli := &http.Client{Transport: tr}
  688. resp, err := cli.Get(m.ClientURLs[0].String() + "/metrics")
  689. if err != nil {
  690. return "", err
  691. }
  692. defer resp.Body.Close()
  693. b, rerr := ioutil.ReadAll(resp.Body)
  694. if rerr != nil {
  695. return "", rerr
  696. }
  697. lines := strings.Split(string(b), "\n")
  698. for _, l := range lines {
  699. if strings.HasPrefix(l, metricName) {
  700. return strings.Split(l, " ")[1], nil
  701. }
  702. }
  703. return "", nil
  704. }
  705. // InjectPartition drops connections from m to others, vice versa.
  706. func (m *member) InjectPartition(t *testing.T, others []*member) {
  707. for _, other := range others {
  708. m.s.CutPeer(other.s.ID())
  709. other.s.CutPeer(m.s.ID())
  710. }
  711. }
  712. // RecoverPartition recovers connections from m to others, vice versa.
  713. func (m *member) RecoverPartition(t *testing.T, others []*member) {
  714. for _, other := range others {
  715. m.s.MendPeer(other.s.ID())
  716. other.s.MendPeer(m.s.ID())
  717. }
  718. }
  719. func MustNewHTTPClient(t *testing.T, eps []string, tls *transport.TLSInfo) client.Client {
  720. cfgtls := transport.TLSInfo{}
  721. if tls != nil {
  722. cfgtls = *tls
  723. }
  724. cfg := client.Config{Transport: mustNewTransport(t, cfgtls), Endpoints: eps}
  725. c, err := client.New(cfg)
  726. if err != nil {
  727. t.Fatal(err)
  728. }
  729. return c
  730. }
  731. func mustNewTransport(t *testing.T, tlsInfo transport.TLSInfo) *http.Transport {
  732. // tick in integration test is short, so 1s dial timeout could play well.
  733. tr, err := transport.NewTimeoutTransport(tlsInfo, time.Second, rafthttp.ConnReadTimeout, rafthttp.ConnWriteTimeout)
  734. if err != nil {
  735. t.Fatal(err)
  736. }
  737. return tr
  738. }
  739. type SortableMemberSliceByPeerURLs []client.Member
  740. func (p SortableMemberSliceByPeerURLs) Len() int { return len(p) }
  741. func (p SortableMemberSliceByPeerURLs) Less(i, j int) bool {
  742. return p[i].PeerURLs[0] < p[j].PeerURLs[0]
  743. }
  744. func (p SortableMemberSliceByPeerURLs) Swap(i, j int) { p[i], p[j] = p[j], p[i] }
  745. type ClusterV3 struct {
  746. *cluster
  747. mu sync.Mutex
  748. clients []*clientv3.Client
  749. }
  750. // NewClusterV3 returns a launched cluster with a grpc client connection
  751. // for each cluster member.
  752. func NewClusterV3(t *testing.T, cfg *ClusterConfig) *ClusterV3 {
  753. cfg.UseGRPC = true
  754. clus := &ClusterV3{
  755. cluster: NewClusterByConfig(t, cfg),
  756. }
  757. clus.Launch(t)
  758. for _, m := range clus.Members {
  759. client, err := NewClientV3(m)
  760. if err != nil {
  761. t.Fatalf("cannot create client: %v", err)
  762. }
  763. clus.clients = append(clus.clients, client)
  764. }
  765. return clus
  766. }
  767. func (c *ClusterV3) TakeClient(idx int) {
  768. c.mu.Lock()
  769. c.clients[idx] = nil
  770. c.mu.Unlock()
  771. }
  772. func (c *ClusterV3) Terminate(t *testing.T) {
  773. c.mu.Lock()
  774. for _, client := range c.clients {
  775. if client == nil {
  776. continue
  777. }
  778. if err := client.Close(); err != nil {
  779. t.Error(err)
  780. }
  781. }
  782. c.mu.Unlock()
  783. c.cluster.Terminate(t)
  784. }
  785. func (c *ClusterV3) RandClient() *clientv3.Client {
  786. return c.clients[rand.Intn(len(c.clients))]
  787. }
  788. func (c *ClusterV3) Client(i int) *clientv3.Client {
  789. return c.clients[i]
  790. }
  791. type grpcAPI struct {
  792. // Cluster is the cluster API for the client's connection.
  793. Cluster pb.ClusterClient
  794. // KV is the keyvalue API for the client's connection.
  795. KV pb.KVClient
  796. // Lease is the lease API for the client's connection.
  797. Lease pb.LeaseClient
  798. // Watch is the watch API for the client's connection.
  799. Watch pb.WatchClient
  800. // Maintenance is the maintenance API for the client's connection.
  801. Maintenance pb.MaintenanceClient
  802. // Auth is the authentication API for the client's connection.
  803. Auth pb.AuthClient
  804. }