cluster_test.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924
  1. // Copyright 2015 CoreOS, Inc.
  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. "fmt"
  17. "io/ioutil"
  18. "log"
  19. "math/rand"
  20. "net"
  21. "net/http"
  22. "net/http/httptest"
  23. "os"
  24. "reflect"
  25. "sort"
  26. "strconv"
  27. "strings"
  28. "sync/atomic"
  29. "testing"
  30. "time"
  31. "github.com/coreos/etcd/client"
  32. "github.com/coreos/etcd/etcdserver"
  33. "github.com/coreos/etcd/etcdserver/api/v3rpc"
  34. "github.com/coreos/etcd/etcdserver/etcdhttp"
  35. "github.com/coreos/etcd/etcdserver/etcdserverpb"
  36. "github.com/coreos/etcd/pkg/testutil"
  37. "github.com/coreos/etcd/pkg/transport"
  38. "github.com/coreos/etcd/pkg/types"
  39. "github.com/coreos/etcd/rafthttp"
  40. "github.com/coreos/etcd/Godeps/_workspace/src/golang.org/x/net/context"
  41. "github.com/coreos/etcd/Godeps/_workspace/src/google.golang.org/grpc"
  42. )
  43. const (
  44. tickDuration = 10 * time.Millisecond
  45. clusterName = "etcd"
  46. requestTimeout = 20 * time.Second
  47. )
  48. var (
  49. electionTicks = 10
  50. // integration test uses well-known ports to listen for each running member,
  51. // which ensures restarted member could listen on specific port again.
  52. nextListenPort int64 = 20000
  53. )
  54. func init() {
  55. // open microsecond-level time log for integration test debugging
  56. log.SetFlags(log.Ltime | log.Lmicroseconds | log.Lshortfile)
  57. if t := os.Getenv("ETCD_ELECTION_TIMEOUT_TICKS"); t != "" {
  58. if i, err := strconv.ParseInt(t, 10, 64); err == nil {
  59. electionTicks = int(i)
  60. }
  61. }
  62. }
  63. func TestClusterOf1(t *testing.T) { testCluster(t, 1) }
  64. func TestClusterOf3(t *testing.T) { testCluster(t, 3) }
  65. func testCluster(t *testing.T, size int) {
  66. defer afterTest(t)
  67. c := NewCluster(t, size)
  68. c.Launch(t)
  69. defer c.Terminate(t)
  70. clusterMustProgress(t, c.Members)
  71. }
  72. func TestTLSClusterOf3(t *testing.T) {
  73. defer afterTest(t)
  74. c := NewClusterByConfig(t, &clusterConfig{size: 3, usePeerTLS: true})
  75. c.Launch(t)
  76. defer c.Terminate(t)
  77. clusterMustProgress(t, c.Members)
  78. }
  79. func TestClusterOf1UsingDiscovery(t *testing.T) { testClusterUsingDiscovery(t, 1) }
  80. func TestClusterOf3UsingDiscovery(t *testing.T) { testClusterUsingDiscovery(t, 3) }
  81. func testClusterUsingDiscovery(t *testing.T, size int) {
  82. defer afterTest(t)
  83. dc := NewCluster(t, 1)
  84. dc.Launch(t)
  85. defer dc.Terminate(t)
  86. // init discovery token space
  87. dcc := mustNewHTTPClient(t, dc.URLs())
  88. dkapi := client.NewKeysAPI(dcc)
  89. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  90. if _, err := dkapi.Create(ctx, "/_config/size", fmt.Sprintf("%d", size)); err != nil {
  91. t.Fatal(err)
  92. }
  93. cancel()
  94. c := NewClusterByConfig(
  95. t,
  96. &clusterConfig{size: size, discoveryURL: dc.URL(0) + "/v2/keys"},
  97. )
  98. c.Launch(t)
  99. defer c.Terminate(t)
  100. clusterMustProgress(t, c.Members)
  101. }
  102. func TestTLSClusterOf3UsingDiscovery(t *testing.T) {
  103. defer afterTest(t)
  104. dc := NewCluster(t, 1)
  105. dc.Launch(t)
  106. defer dc.Terminate(t)
  107. // init discovery token space
  108. dcc := mustNewHTTPClient(t, dc.URLs())
  109. dkapi := client.NewKeysAPI(dcc)
  110. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  111. if _, err := dkapi.Create(ctx, "/_config/size", fmt.Sprintf("%d", 3)); err != nil {
  112. t.Fatal(err)
  113. }
  114. cancel()
  115. c := NewClusterByConfig(t,
  116. &clusterConfig{
  117. size: 3,
  118. usePeerTLS: true,
  119. discoveryURL: dc.URL(0) + "/v2/keys"},
  120. )
  121. c.Launch(t)
  122. defer c.Terminate(t)
  123. clusterMustProgress(t, c.Members)
  124. }
  125. func TestDoubleClusterSizeOf1(t *testing.T) { testDoubleClusterSize(t, 1) }
  126. func TestDoubleClusterSizeOf3(t *testing.T) { testDoubleClusterSize(t, 3) }
  127. func testDoubleClusterSize(t *testing.T, size int) {
  128. defer afterTest(t)
  129. c := NewCluster(t, size)
  130. c.Launch(t)
  131. defer c.Terminate(t)
  132. for i := 0; i < size; i++ {
  133. c.AddMember(t)
  134. }
  135. clusterMustProgress(t, c.Members)
  136. }
  137. func TestDoubleTLSClusterSizeOf3(t *testing.T) {
  138. defer afterTest(t)
  139. c := NewClusterByConfig(t, &clusterConfig{size: 3, usePeerTLS: true})
  140. c.Launch(t)
  141. defer c.Terminate(t)
  142. for i := 0; i < 3; i++ {
  143. c.AddMember(t)
  144. }
  145. clusterMustProgress(t, c.Members)
  146. }
  147. func TestDecreaseClusterSizeOf3(t *testing.T) { testDecreaseClusterSize(t, 3) }
  148. func TestDecreaseClusterSizeOf5(t *testing.T) { testDecreaseClusterSize(t, 5) }
  149. func testDecreaseClusterSize(t *testing.T, size int) {
  150. defer afterTest(t)
  151. c := NewCluster(t, size)
  152. c.Launch(t)
  153. defer c.Terminate(t)
  154. // TODO: remove the last but one member
  155. for i := 0; i < size-1; i++ {
  156. id := c.Members[len(c.Members)-1].s.ID()
  157. c.RemoveMember(t, uint64(id))
  158. c.waitLeader(t, c.Members)
  159. }
  160. clusterMustProgress(t, c.Members)
  161. }
  162. func TestForceNewCluster(t *testing.T) {
  163. c := NewCluster(t, 3)
  164. c.Launch(t)
  165. cc := mustNewHTTPClient(t, []string{c.Members[0].URL()})
  166. kapi := client.NewKeysAPI(cc)
  167. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  168. resp, err := kapi.Create(ctx, "/foo", "bar")
  169. if err != nil {
  170. t.Fatalf("unexpected create error: %v", err)
  171. }
  172. cancel()
  173. // ensure create has been applied in this machine
  174. ctx, cancel = context.WithTimeout(context.Background(), requestTimeout)
  175. if _, err = kapi.Watcher("/foo", &client.WatcherOptions{AfterIndex: resp.Node.ModifiedIndex - 1}).Next(ctx); err != nil {
  176. t.Fatalf("unexpected watch error: %v", err)
  177. }
  178. cancel()
  179. c.Members[0].Stop(t)
  180. c.Members[1].Terminate(t)
  181. c.Members[2].Terminate(t)
  182. c.Members[0].ForceNewCluster = true
  183. err = c.Members[0].Restart(t)
  184. if err != nil {
  185. t.Fatalf("unexpected ForceRestart error: %v", err)
  186. }
  187. defer c.Members[0].Terminate(t)
  188. c.waitLeader(t, c.Members[:1])
  189. // use new http client to init new connection
  190. cc = mustNewHTTPClient(t, []string{c.Members[0].URL()})
  191. kapi = client.NewKeysAPI(cc)
  192. // ensure force restart keep the old data, and new cluster can make progress
  193. ctx, cancel = context.WithTimeout(context.Background(), requestTimeout)
  194. if _, err := kapi.Watcher("/foo", &client.WatcherOptions{AfterIndex: resp.Node.ModifiedIndex - 1}).Next(ctx); err != nil {
  195. t.Fatalf("unexpected watch error: %v", err)
  196. }
  197. cancel()
  198. clusterMustProgress(t, c.Members[:1])
  199. }
  200. func TestAddMemberAfterClusterFullRotation(t *testing.T) {
  201. defer afterTest(t)
  202. c := NewCluster(t, 3)
  203. c.Launch(t)
  204. defer c.Terminate(t)
  205. // remove all the previous three members and add in three new members.
  206. for i := 0; i < 3; i++ {
  207. c.RemoveMember(t, uint64(c.Members[0].s.ID()))
  208. c.waitLeader(t, c.Members)
  209. c.AddMember(t)
  210. c.waitLeader(t, c.Members)
  211. }
  212. c.AddMember(t)
  213. c.waitLeader(t, c.Members)
  214. clusterMustProgress(t, c.Members)
  215. }
  216. // Ensure we can remove a member then add a new one back immediately.
  217. func TestIssue2681(t *testing.T) {
  218. defer afterTest(t)
  219. c := NewCluster(t, 5)
  220. c.Launch(t)
  221. defer c.Terminate(t)
  222. c.RemoveMember(t, uint64(c.Members[4].s.ID()))
  223. c.waitLeader(t, c.Members)
  224. c.AddMember(t)
  225. c.waitLeader(t, c.Members)
  226. clusterMustProgress(t, c.Members)
  227. }
  228. // Ensure we can remove a member after a snapshot then add a new one back.
  229. func TestIssue2746(t *testing.T) {
  230. defer afterTest(t)
  231. c := NewCluster(t, 5)
  232. for _, m := range c.Members {
  233. m.SnapCount = 10
  234. }
  235. c.Launch(t)
  236. defer c.Terminate(t)
  237. // force a snapshot
  238. for i := 0; i < 20; i++ {
  239. clusterMustProgress(t, c.Members)
  240. }
  241. c.RemoveMember(t, uint64(c.Members[4].s.ID()))
  242. c.waitLeader(t, c.Members)
  243. c.AddMember(t)
  244. c.waitLeader(t, c.Members)
  245. clusterMustProgress(t, c.Members)
  246. }
  247. // Ensure etcd will not panic when removing a just started member.
  248. func TestIssue2904(t *testing.T) {
  249. defer afterTest(t)
  250. // start 1-member cluster to ensure member 0 is the leader of the cluster.
  251. c := NewCluster(t, 1)
  252. c.Launch(t)
  253. defer c.Terminate(t)
  254. c.AddMember(t)
  255. c.Members[1].Stop(t)
  256. // send remove member-1 request to the cluster.
  257. cc := mustNewHTTPClient(t, c.URLs())
  258. ma := client.NewMembersAPI(cc)
  259. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  260. // the proposal is not committed because member 1 is stopped, but the
  261. // proposal is appended to leader's raft log.
  262. ma.Remove(ctx, c.Members[1].s.ID().String())
  263. cancel()
  264. // restart member, and expect it to send updateAttr request.
  265. // the log in the leader is like this:
  266. // [..., remove 1, ..., update attr 1, ...]
  267. c.Members[1].Restart(t)
  268. // when the member comes back, it ack the proposal to remove itself,
  269. // and apply it.
  270. <-c.Members[1].s.StopNotify()
  271. // terminate removed member
  272. c.Members[1].Terminate(t)
  273. c.Members = c.Members[:1]
  274. // wait member to be removed.
  275. c.waitMembersMatch(t, c.HTTPMembers())
  276. }
  277. // clusterMustProgress ensures that cluster can make progress. It creates
  278. // a random key first, and check the new key could be got from all client urls
  279. // of the cluster.
  280. func clusterMustProgress(t *testing.T, membs []*member) {
  281. cc := mustNewHTTPClient(t, []string{membs[0].URL()})
  282. kapi := client.NewKeysAPI(cc)
  283. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  284. key := fmt.Sprintf("foo%d", rand.Int())
  285. resp, err := kapi.Create(ctx, "/"+key, "bar")
  286. if err != nil {
  287. t.Fatalf("create on %s error: %v", membs[0].URL(), err)
  288. }
  289. cancel()
  290. for i, m := range membs {
  291. u := m.URL()
  292. mcc := mustNewHTTPClient(t, []string{u})
  293. mkapi := client.NewKeysAPI(mcc)
  294. mctx, mcancel := context.WithTimeout(context.Background(), requestTimeout)
  295. if _, err := mkapi.Watcher(key, &client.WatcherOptions{AfterIndex: resp.Node.ModifiedIndex - 1}).Next(mctx); err != nil {
  296. t.Fatalf("#%d: watch on %s error: %v", i, u, err)
  297. }
  298. mcancel()
  299. }
  300. }
  301. type clusterConfig struct {
  302. size int
  303. usePeerTLS bool
  304. discoveryURL string
  305. useV3 bool
  306. useGRPC bool
  307. }
  308. type cluster struct {
  309. cfg *clusterConfig
  310. Members []*member
  311. }
  312. func (c *cluster) fillClusterForMembers() error {
  313. if c.cfg.discoveryURL != "" {
  314. // cluster will be discovered
  315. return nil
  316. }
  317. addrs := make([]string, 0)
  318. for _, m := range c.Members {
  319. scheme := "http"
  320. if !m.PeerTLSInfo.Empty() {
  321. scheme = "https"
  322. }
  323. for _, l := range m.PeerListeners {
  324. addrs = append(addrs, fmt.Sprintf("%s=%s://%s", m.Name, scheme, l.Addr().String()))
  325. }
  326. }
  327. clusterStr := strings.Join(addrs, ",")
  328. var err error
  329. for _, m := range c.Members {
  330. m.InitialPeerURLsMap, err = types.NewURLsMap(clusterStr)
  331. if err != nil {
  332. return err
  333. }
  334. }
  335. return nil
  336. }
  337. func newCluster(t *testing.T, cfg *clusterConfig) *cluster {
  338. c := &cluster{cfg: cfg}
  339. ms := make([]*member, cfg.size)
  340. for i := 0; i < cfg.size; i++ {
  341. ms[i] = c.mustNewMember(t)
  342. }
  343. c.Members = ms
  344. if err := c.fillClusterForMembers(); err != nil {
  345. t.Fatal(err)
  346. }
  347. return c
  348. }
  349. // NewCluster returns an unlaunched cluster of the given size which has been
  350. // set to use static bootstrap.
  351. func NewCluster(t *testing.T, size int) *cluster {
  352. return newCluster(t, &clusterConfig{size: size})
  353. }
  354. // NewClusterByConfig returns an unlaunched cluster defined by a cluster configuration
  355. func NewClusterByConfig(t *testing.T, cfg *clusterConfig) *cluster {
  356. return newCluster(t, cfg)
  357. }
  358. func (c *cluster) Launch(t *testing.T) {
  359. errc := make(chan error)
  360. for _, m := range c.Members {
  361. // Members are launched in separate goroutines because if they boot
  362. // using discovery url, they have to wait for others to register to continue.
  363. go func(m *member) {
  364. errc <- m.Launch()
  365. }(m)
  366. }
  367. for range c.Members {
  368. if err := <-errc; err != nil {
  369. t.Fatalf("error setting up member: %v", err)
  370. }
  371. }
  372. // wait cluster to be stable to receive future client requests
  373. c.waitMembersMatch(t, c.HTTPMembers())
  374. c.waitVersion()
  375. }
  376. func (c *cluster) URL(i int) string {
  377. return c.Members[i].ClientURLs[0].String()
  378. }
  379. func (c *cluster) URLs() []string {
  380. urls := make([]string, 0)
  381. for _, m := range c.Members {
  382. for _, u := range m.ClientURLs {
  383. urls = append(urls, u.String())
  384. }
  385. }
  386. return urls
  387. }
  388. func (c *cluster) HTTPMembers() []client.Member {
  389. ms := make([]client.Member, len(c.Members))
  390. for i, m := range c.Members {
  391. scheme := "http"
  392. if !m.PeerTLSInfo.Empty() {
  393. scheme = "https"
  394. }
  395. ms[i].Name = m.Name
  396. for _, ln := range m.PeerListeners {
  397. ms[i].PeerURLs = append(ms[i].PeerURLs, scheme+"://"+ln.Addr().String())
  398. }
  399. for _, ln := range m.ClientListeners {
  400. ms[i].ClientURLs = append(ms[i].ClientURLs, "http://"+ln.Addr().String())
  401. }
  402. }
  403. return ms
  404. }
  405. func (c *cluster) mustNewMember(t *testing.T) *member {
  406. name := c.name(rand.Int())
  407. m := mustNewMember(t, name, c.cfg.usePeerTLS)
  408. m.DiscoveryURL = c.cfg.discoveryURL
  409. m.V3demo = c.cfg.useV3
  410. if c.cfg.useGRPC {
  411. if err := m.listenGRPC(); err != nil {
  412. t.Fatal(err)
  413. }
  414. }
  415. return m
  416. }
  417. func (c *cluster) addMember(t *testing.T) {
  418. m := c.mustNewMember(t)
  419. scheme := "http"
  420. if c.cfg.usePeerTLS {
  421. scheme = "https"
  422. }
  423. // send add request to the cluster
  424. cc := mustNewHTTPClient(t, []string{c.URL(0)})
  425. ma := client.NewMembersAPI(cc)
  426. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  427. peerURL := scheme + "://" + m.PeerListeners[0].Addr().String()
  428. if _, err := ma.Add(ctx, peerURL); err != nil {
  429. t.Fatalf("add member on %s error: %v", c.URL(0), err)
  430. }
  431. cancel()
  432. // wait for the add node entry applied in the cluster
  433. members := append(c.HTTPMembers(), client.Member{PeerURLs: []string{peerURL}, ClientURLs: []string{}})
  434. c.waitMembersMatch(t, members)
  435. m.InitialPeerURLsMap = types.URLsMap{}
  436. for _, mm := range c.Members {
  437. m.InitialPeerURLsMap[mm.Name] = mm.PeerURLs
  438. }
  439. m.InitialPeerURLsMap[m.Name] = m.PeerURLs
  440. m.NewCluster = false
  441. if err := m.Launch(); err != nil {
  442. t.Fatal(err)
  443. }
  444. c.Members = append(c.Members, m)
  445. // wait cluster to be stable to receive future client requests
  446. c.waitMembersMatch(t, c.HTTPMembers())
  447. }
  448. func (c *cluster) AddMember(t *testing.T) {
  449. c.addMember(t)
  450. }
  451. func (c *cluster) RemoveMember(t *testing.T, id uint64) {
  452. // send remove request to the cluster
  453. cc := mustNewHTTPClient(t, c.URLs())
  454. ma := client.NewMembersAPI(cc)
  455. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  456. if err := ma.Remove(ctx, types.ID(id).String()); err != nil {
  457. t.Fatalf("unexpected remove error %v", err)
  458. }
  459. cancel()
  460. newMembers := make([]*member, 0)
  461. for _, m := range c.Members {
  462. if uint64(m.s.ID()) != id {
  463. newMembers = append(newMembers, m)
  464. } else {
  465. select {
  466. case <-m.s.StopNotify():
  467. m.Terminate(t)
  468. // 1s stop delay + election timeout + 1s disk and network delay + connection write timeout
  469. // TODO: remove connection write timeout by selecting on http response closeNotifier
  470. // blocking on https://github.com/golang/go/issues/9524
  471. case <-time.After(time.Second + time.Duration(electionTicks)*tickDuration + time.Second + rafthttp.ConnWriteTimeout):
  472. t.Fatalf("failed to remove member %s in time", m.s.ID())
  473. }
  474. }
  475. }
  476. c.Members = newMembers
  477. c.waitMembersMatch(t, c.HTTPMembers())
  478. }
  479. func (c *cluster) Terminate(t *testing.T) {
  480. for _, m := range c.Members {
  481. m.Terminate(t)
  482. }
  483. }
  484. func (c *cluster) waitMembersMatch(t *testing.T, membs []client.Member) {
  485. for _, u := range c.URLs() {
  486. cc := mustNewHTTPClient(t, []string{u})
  487. ma := client.NewMembersAPI(cc)
  488. for {
  489. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  490. ms, err := ma.List(ctx)
  491. cancel()
  492. if err == nil && isMembersEqual(ms, membs) {
  493. break
  494. }
  495. time.Sleep(tickDuration)
  496. }
  497. }
  498. return
  499. }
  500. func (c *cluster) waitLeader(t *testing.T, membs []*member) {
  501. possibleLead := make(map[uint64]bool)
  502. var lead uint64
  503. for _, m := range membs {
  504. possibleLead[uint64(m.s.ID())] = true
  505. }
  506. for lead == 0 || !possibleLead[lead] {
  507. lead = 0
  508. for _, m := range membs {
  509. if lead != 0 && lead != m.s.Lead() {
  510. lead = 0
  511. break
  512. }
  513. lead = m.s.Lead()
  514. }
  515. time.Sleep(10 * tickDuration)
  516. }
  517. }
  518. func (c *cluster) waitVersion() {
  519. for _, m := range c.Members {
  520. for {
  521. if m.s.ClusterVersion() != nil {
  522. break
  523. }
  524. time.Sleep(tickDuration)
  525. }
  526. }
  527. }
  528. func (c *cluster) name(i int) string {
  529. return fmt.Sprint("node", i)
  530. }
  531. // isMembersEqual checks whether two members equal except ID field.
  532. // The given wmembs should always set ID field to empty string.
  533. func isMembersEqual(membs []client.Member, wmembs []client.Member) bool {
  534. sort.Sort(SortableMemberSliceByPeerURLs(membs))
  535. sort.Sort(SortableMemberSliceByPeerURLs(wmembs))
  536. for i := range membs {
  537. membs[i].ID = ""
  538. }
  539. return reflect.DeepEqual(membs, wmembs)
  540. }
  541. func newLocalListener(t *testing.T) net.Listener {
  542. port := atomic.AddInt64(&nextListenPort, 1)
  543. l, err := net.Listen("tcp", "127.0.0.1:"+strconv.FormatInt(port, 10))
  544. if err != nil {
  545. t.Fatal(err)
  546. }
  547. return l
  548. }
  549. func newListenerWithAddr(t *testing.T, addr string) net.Listener {
  550. var err error
  551. var l net.Listener
  552. // TODO: we want to reuse a previous closed port immediately.
  553. // a better way is to set SO_REUSExx instead of doing retry.
  554. for i := 0; i < 5; i++ {
  555. l, err = net.Listen("tcp", addr)
  556. if err == nil {
  557. break
  558. }
  559. time.Sleep(500 * time.Millisecond)
  560. }
  561. if err != nil {
  562. t.Fatal(err)
  563. }
  564. return l
  565. }
  566. type member struct {
  567. etcdserver.ServerConfig
  568. PeerListeners, ClientListeners []net.Listener
  569. grpcListener net.Listener
  570. // inited PeerTLSInfo implies to enable peer TLS
  571. PeerTLSInfo transport.TLSInfo
  572. raftHandler *testutil.PauseableHandler
  573. s *etcdserver.EtcdServer
  574. hss []*httptest.Server
  575. grpcServer *grpc.Server
  576. grpcAddr string
  577. }
  578. // mustNewMember return an inited member with the given name. If usePeerTLS is
  579. // true, it will set PeerTLSInfo and use https scheme to communicate between
  580. // peers.
  581. func mustNewMember(t *testing.T, name string, usePeerTLS bool) *member {
  582. var (
  583. testTLSInfo = transport.TLSInfo{
  584. KeyFile: "./fixtures/server.key.insecure",
  585. CertFile: "./fixtures/server.crt",
  586. TrustedCAFile: "./fixtures/ca.crt",
  587. ClientCertAuth: true,
  588. }
  589. err error
  590. )
  591. m := &member{}
  592. peerScheme := "http"
  593. if usePeerTLS {
  594. peerScheme = "https"
  595. }
  596. pln := newLocalListener(t)
  597. m.PeerListeners = []net.Listener{pln}
  598. m.PeerURLs, err = types.NewURLs([]string{peerScheme + "://" + pln.Addr().String()})
  599. if err != nil {
  600. t.Fatal(err)
  601. }
  602. if usePeerTLS {
  603. m.PeerTLSInfo = testTLSInfo
  604. }
  605. cln := newLocalListener(t)
  606. m.ClientListeners = []net.Listener{cln}
  607. m.ClientURLs, err = types.NewURLs([]string{"http://" + cln.Addr().String()})
  608. if err != nil {
  609. t.Fatal(err)
  610. }
  611. m.Name = name
  612. m.DataDir, err = ioutil.TempDir(os.TempDir(), "etcd")
  613. if err != nil {
  614. t.Fatal(err)
  615. }
  616. clusterStr := fmt.Sprintf("%s=%s://%s", name, peerScheme, pln.Addr().String())
  617. m.InitialPeerURLsMap, err = types.NewURLsMap(clusterStr)
  618. if err != nil {
  619. t.Fatal(err)
  620. }
  621. m.InitialClusterToken = clusterName
  622. m.NewCluster = true
  623. m.ServerConfig.PeerTLSInfo = m.PeerTLSInfo
  624. m.ElectionTicks = electionTicks
  625. m.TickMs = uint(tickDuration / time.Millisecond)
  626. return m
  627. }
  628. // startGRPC starts a grpc server over a unix domain socket on the member
  629. func (m *member) listenGRPC() error {
  630. if m.V3demo == false {
  631. return fmt.Errorf("starting grpc server without v3 configured")
  632. }
  633. m.grpcAddr = m.Name + ".sock"
  634. if err := os.RemoveAll(m.grpcAddr); err != nil {
  635. return err
  636. }
  637. l, err := net.Listen("unix", m.grpcAddr)
  638. if err != nil {
  639. return fmt.Errorf("listen failed on grpc socket %s (%v)", m.grpcAddr, err)
  640. }
  641. m.grpcListener = l
  642. return nil
  643. }
  644. // newGrpcClient creates a new grpc client connection to the member
  645. func NewGRPCClient(m *member) (*grpc.ClientConn, error) {
  646. if m.grpcAddr == "" {
  647. return nil, fmt.Errorf("member not configured for grpc")
  648. }
  649. f := func(a string, t time.Duration) (net.Conn, error) {
  650. return net.Dial("unix", a)
  651. }
  652. unixdialer := grpc.WithDialer(f)
  653. return grpc.Dial(m.grpcAddr, unixdialer)
  654. }
  655. // Clone returns a member with the same server configuration. The returned
  656. // member will not set PeerListeners and ClientListeners.
  657. func (m *member) Clone(t *testing.T) *member {
  658. mm := &member{}
  659. mm.ServerConfig = m.ServerConfig
  660. var err error
  661. clientURLStrs := m.ClientURLs.StringSlice()
  662. mm.ClientURLs, err = types.NewURLs(clientURLStrs)
  663. if err != nil {
  664. // this should never fail
  665. panic(err)
  666. }
  667. peerURLStrs := m.PeerURLs.StringSlice()
  668. mm.PeerURLs, err = types.NewURLs(peerURLStrs)
  669. if err != nil {
  670. // this should never fail
  671. panic(err)
  672. }
  673. clusterStr := m.InitialPeerURLsMap.String()
  674. mm.InitialPeerURLsMap, err = types.NewURLsMap(clusterStr)
  675. if err != nil {
  676. // this should never fail
  677. panic(err)
  678. }
  679. mm.InitialClusterToken = m.InitialClusterToken
  680. mm.ElectionTicks = m.ElectionTicks
  681. mm.PeerTLSInfo = m.PeerTLSInfo
  682. return mm
  683. }
  684. // Launch starts a member based on ServerConfig, PeerListeners
  685. // and ClientListeners.
  686. func (m *member) Launch() error {
  687. var err error
  688. if m.s, err = etcdserver.NewServer(&m.ServerConfig); err != nil {
  689. return fmt.Errorf("failed to initialize the etcd server: %v", err)
  690. }
  691. m.s.SyncTicker = time.Tick(500 * time.Millisecond)
  692. m.s.Start()
  693. m.raftHandler = &testutil.PauseableHandler{Next: etcdhttp.NewPeerHandler(m.s.Cluster(), m.s.RaftHandler())}
  694. for _, ln := range m.PeerListeners {
  695. hs := &httptest.Server{
  696. Listener: ln,
  697. Config: &http.Server{Handler: m.raftHandler},
  698. }
  699. if m.PeerTLSInfo.Empty() {
  700. hs.Start()
  701. } else {
  702. hs.TLS, err = m.PeerTLSInfo.ServerConfig()
  703. if err != nil {
  704. return err
  705. }
  706. hs.StartTLS()
  707. }
  708. m.hss = append(m.hss, hs)
  709. }
  710. for _, ln := range m.ClientListeners {
  711. hs := &httptest.Server{
  712. Listener: ln,
  713. Config: &http.Server{Handler: etcdhttp.NewClientHandler(m.s, m.ServerConfig.ReqTimeout())},
  714. }
  715. hs.Start()
  716. m.hss = append(m.hss, hs)
  717. }
  718. if m.grpcListener != nil {
  719. m.grpcServer = grpc.NewServer()
  720. etcdserverpb.RegisterKVServer(m.grpcServer, v3rpc.NewKVServer(m.s))
  721. etcdserverpb.RegisterWatchServer(m.grpcServer, v3rpc.NewWatchServer(m.s))
  722. etcdserverpb.RegisterLeaseServer(m.grpcServer, v3rpc.NewLeaseServer(m.s))
  723. go m.grpcServer.Serve(m.grpcListener)
  724. }
  725. return nil
  726. }
  727. func (m *member) WaitOK(t *testing.T) {
  728. cc := mustNewHTTPClient(t, []string{m.URL()})
  729. kapi := client.NewKeysAPI(cc)
  730. for {
  731. ctx, cancel := context.WithTimeout(context.Background(), requestTimeout)
  732. _, err := kapi.Get(ctx, "/", nil)
  733. if err != nil {
  734. time.Sleep(tickDuration)
  735. continue
  736. }
  737. cancel()
  738. break
  739. }
  740. for m.s.Leader() == 0 {
  741. time.Sleep(tickDuration)
  742. }
  743. }
  744. func (m *member) URL() string { return m.ClientURLs[0].String() }
  745. func (m *member) Pause() {
  746. m.raftHandler.Pause()
  747. m.s.PauseSending()
  748. }
  749. func (m *member) Resume() {
  750. m.raftHandler.Resume()
  751. m.s.ResumeSending()
  752. }
  753. // Close stops the member's etcdserver and closes its connections
  754. func (m *member) Close() {
  755. if m.grpcServer != nil {
  756. m.grpcServer.Stop()
  757. m.grpcServer = nil
  758. }
  759. m.s.Stop()
  760. for _, hs := range m.hss {
  761. hs.CloseClientConnections()
  762. hs.Close()
  763. }
  764. }
  765. // Stop stops the member, but the data dir of the member is preserved.
  766. func (m *member) Stop(t *testing.T) {
  767. m.Close()
  768. m.hss = nil
  769. }
  770. // Restart starts the member using the preserved data dir.
  771. func (m *member) Restart(t *testing.T) error {
  772. newPeerListeners := make([]net.Listener, 0)
  773. for _, ln := range m.PeerListeners {
  774. newPeerListeners = append(newPeerListeners, newListenerWithAddr(t, ln.Addr().String()))
  775. }
  776. m.PeerListeners = newPeerListeners
  777. newClientListeners := make([]net.Listener, 0)
  778. for _, ln := range m.ClientListeners {
  779. newClientListeners = append(newClientListeners, newListenerWithAddr(t, ln.Addr().String()))
  780. }
  781. m.ClientListeners = newClientListeners
  782. if m.grpcListener != nil {
  783. if err := m.listenGRPC(); err != nil {
  784. t.Fatal(err)
  785. }
  786. }
  787. return m.Launch()
  788. }
  789. // Terminate stops the member and removes the data dir.
  790. func (m *member) Terminate(t *testing.T) {
  791. m.Close()
  792. if err := os.RemoveAll(m.ServerConfig.DataDir); err != nil {
  793. t.Fatal(err)
  794. }
  795. }
  796. func mustNewHTTPClient(t *testing.T, eps []string) client.Client {
  797. cfg := client.Config{Transport: mustNewTransport(t, transport.TLSInfo{}), Endpoints: eps}
  798. c, err := client.New(cfg)
  799. if err != nil {
  800. t.Fatal(err)
  801. }
  802. return c
  803. }
  804. func mustNewTransport(t *testing.T, tlsInfo transport.TLSInfo) *http.Transport {
  805. // tick in integration test is short, so 1s dial timeout could play well.
  806. tr, err := transport.NewTimeoutTransport(tlsInfo, time.Second, rafthttp.ConnReadTimeout, rafthttp.ConnWriteTimeout)
  807. if err != nil {
  808. t.Fatal(err)
  809. }
  810. return tr
  811. }
  812. type SortableMemberSliceByPeerURLs []client.Member
  813. func (p SortableMemberSliceByPeerURLs) Len() int { return len(p) }
  814. func (p SortableMemberSliceByPeerURLs) Less(i, j int) bool {
  815. return p[i].PeerURLs[0] < p[j].PeerURLs[0]
  816. }
  817. func (p SortableMemberSliceByPeerURLs) Swap(i, j int) { p[i], p[j] = p[j], p[i] }