cluster.go 23 KB

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