v3_lease_test.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866
  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. "fmt"
  17. "testing"
  18. "time"
  19. "golang.org/x/net/context"
  20. "google.golang.org/grpc"
  21. "google.golang.org/grpc/metadata"
  22. "github.com/coreos/etcd/etcdserver/api/v3rpc/rpctypes"
  23. pb "github.com/coreos/etcd/etcdserver/etcdserverpb"
  24. "github.com/coreos/etcd/mvcc/mvccpb"
  25. "github.com/coreos/etcd/pkg/testutil"
  26. )
  27. // TestV3LeasePrmote ensures the newly elected leader can promote itself
  28. // to the primary lessor, refresh the leases and start to manage leases.
  29. // TODO: use customized clock to make this test go faster?
  30. func TestV3LeasePrmote(t *testing.T) {
  31. clus := NewClusterV3(t, &ClusterConfig{Size: 3})
  32. defer clus.Terminate(t)
  33. // create lease
  34. lresp, err := toGRPC(clus.RandClient()).Lease.LeaseGrant(context.TODO(), &pb.LeaseGrantRequest{TTL: 5})
  35. if err != nil {
  36. t.Fatal(err)
  37. }
  38. if lresp.Error != "" {
  39. t.Fatal(lresp.Error)
  40. }
  41. // wait until the lease is going to expire.
  42. time.Sleep(time.Duration(lresp.TTL-1) * time.Second)
  43. // kill the current leader, all leases should be refreshed.
  44. toStop := clus.waitLeader(t, clus.Members)
  45. clus.Members[toStop].Stop(t)
  46. var toWait []*member
  47. for i, m := range clus.Members {
  48. if i != toStop {
  49. toWait = append(toWait, m)
  50. }
  51. }
  52. clus.waitLeader(t, toWait)
  53. clus.Members[toStop].Restart(t)
  54. clus.waitLeader(t, clus.Members)
  55. // ensure lease is refreshed by waiting for a "long" time.
  56. // it was going to expire anyway.
  57. time.Sleep(3 * time.Second)
  58. if !leaseExist(t, clus, lresp.ID) {
  59. t.Error("unexpected lease not exists")
  60. }
  61. // let lease expires. total lease = 5 seconds and we already
  62. // waits for 3 seconds, so 3 seconds more is enough.
  63. time.Sleep(3 * time.Second)
  64. if leaseExist(t, clus, lresp.ID) {
  65. t.Error("unexpected lease exists")
  66. }
  67. }
  68. // TestV3LeaseRevoke ensures a key is deleted once its lease is revoked.
  69. func TestV3LeaseRevoke(t *testing.T) {
  70. defer testutil.AfterTest(t)
  71. testLeaseRemoveLeasedKey(t, func(clus *ClusterV3, leaseID int64) error {
  72. lc := toGRPC(clus.RandClient()).Lease
  73. _, err := lc.LeaseRevoke(context.TODO(), &pb.LeaseRevokeRequest{ID: leaseID})
  74. return err
  75. })
  76. }
  77. // TestV3LeaseGrantById ensures leases may be created by a given id.
  78. func TestV3LeaseGrantByID(t *testing.T) {
  79. defer testutil.AfterTest(t)
  80. clus := NewClusterV3(t, &ClusterConfig{Size: 3})
  81. defer clus.Terminate(t)
  82. // create fixed lease
  83. lresp, err := toGRPC(clus.RandClient()).Lease.LeaseGrant(
  84. context.TODO(),
  85. &pb.LeaseGrantRequest{ID: 1, TTL: 1})
  86. if err != nil {
  87. t.Errorf("could not create lease 1 (%v)", err)
  88. }
  89. if lresp.ID != 1 {
  90. t.Errorf("got id %v, wanted id %v", lresp.ID, 1)
  91. }
  92. // create duplicate fixed lease
  93. _, err = toGRPC(clus.RandClient()).Lease.LeaseGrant(
  94. context.TODO(),
  95. &pb.LeaseGrantRequest{ID: 1, TTL: 1})
  96. if !eqErrGRPC(err, rpctypes.ErrGRPCLeaseExist) {
  97. t.Error(err)
  98. }
  99. // create fresh fixed lease
  100. lresp, err = toGRPC(clus.RandClient()).Lease.LeaseGrant(
  101. context.TODO(),
  102. &pb.LeaseGrantRequest{ID: 2, TTL: 1})
  103. if err != nil {
  104. t.Errorf("could not create lease 2 (%v)", err)
  105. }
  106. if lresp.ID != 2 {
  107. t.Errorf("got id %v, wanted id %v", lresp.ID, 2)
  108. }
  109. }
  110. // TestV3LeaseExpire ensures a key is deleted once a key expires.
  111. func TestV3LeaseExpire(t *testing.T) {
  112. defer testutil.AfterTest(t)
  113. testLeaseRemoveLeasedKey(t, func(clus *ClusterV3, leaseID int64) error {
  114. // let lease lapse; wait for deleted key
  115. ctx, cancel := context.WithCancel(context.Background())
  116. defer cancel()
  117. wStream, err := toGRPC(clus.RandClient()).Watch.Watch(ctx)
  118. if err != nil {
  119. return err
  120. }
  121. wreq := &pb.WatchRequest{RequestUnion: &pb.WatchRequest_CreateRequest{
  122. CreateRequest: &pb.WatchCreateRequest{
  123. Key: []byte("foo"), StartRevision: 1}}}
  124. if err := wStream.Send(wreq); err != nil {
  125. return err
  126. }
  127. if _, err := wStream.Recv(); err != nil {
  128. // the 'created' message
  129. return err
  130. }
  131. if _, err := wStream.Recv(); err != nil {
  132. // the 'put' message
  133. return err
  134. }
  135. errc := make(chan error, 1)
  136. go func() {
  137. resp, err := wStream.Recv()
  138. switch {
  139. case err != nil:
  140. errc <- err
  141. case len(resp.Events) != 1:
  142. fallthrough
  143. case resp.Events[0].Type != mvccpb.DELETE:
  144. errc <- fmt.Errorf("expected key delete, got %v", resp)
  145. default:
  146. errc <- nil
  147. }
  148. }()
  149. select {
  150. case <-time.After(15 * time.Second):
  151. return fmt.Errorf("lease expiration too slow")
  152. case err := <-errc:
  153. return err
  154. }
  155. })
  156. }
  157. // TestV3LeaseKeepAlive ensures keepalive keeps the lease alive.
  158. func TestV3LeaseKeepAlive(t *testing.T) {
  159. defer testutil.AfterTest(t)
  160. testLeaseRemoveLeasedKey(t, func(clus *ClusterV3, leaseID int64) error {
  161. lc := toGRPC(clus.RandClient()).Lease
  162. lreq := &pb.LeaseKeepAliveRequest{ID: leaseID}
  163. ctx, cancel := context.WithCancel(context.Background())
  164. defer cancel()
  165. lac, err := lc.LeaseKeepAlive(ctx)
  166. if err != nil {
  167. return err
  168. }
  169. defer lac.CloseSend()
  170. // renew long enough so lease would've expired otherwise
  171. for i := 0; i < 3; i++ {
  172. if err = lac.Send(lreq); err != nil {
  173. return err
  174. }
  175. lresp, rxerr := lac.Recv()
  176. if rxerr != nil {
  177. return rxerr
  178. }
  179. if lresp.ID != leaseID {
  180. return fmt.Errorf("expected lease ID %v, got %v", leaseID, lresp.ID)
  181. }
  182. time.Sleep(time.Duration(lresp.TTL/2) * time.Second)
  183. }
  184. _, err = lc.LeaseRevoke(context.TODO(), &pb.LeaseRevokeRequest{ID: leaseID})
  185. return err
  186. })
  187. }
  188. // TestV3LeaseExists creates a lease on a random client and confirms it exists in the cluster.
  189. func TestV3LeaseExists(t *testing.T) {
  190. defer testutil.AfterTest(t)
  191. clus := NewClusterV3(t, &ClusterConfig{Size: 3})
  192. defer clus.Terminate(t)
  193. // create lease
  194. ctx0, cancel0 := context.WithCancel(context.Background())
  195. defer cancel0()
  196. lresp, err := toGRPC(clus.RandClient()).Lease.LeaseGrant(
  197. ctx0,
  198. &pb.LeaseGrantRequest{TTL: 30})
  199. if err != nil {
  200. t.Fatal(err)
  201. }
  202. if lresp.Error != "" {
  203. t.Fatal(lresp.Error)
  204. }
  205. if !leaseExist(t, clus, lresp.ID) {
  206. t.Error("unexpected lease not exists")
  207. }
  208. }
  209. // TestV3LeaseLeases creates leases and confirms list RPC fetches created ones.
  210. func TestV3LeaseLeases(t *testing.T) {
  211. defer testutil.AfterTest(t)
  212. clus := NewClusterV3(t, &ClusterConfig{Size: 1})
  213. defer clus.Terminate(t)
  214. ctx0, cancel0 := context.WithCancel(context.Background())
  215. defer cancel0()
  216. // create leases
  217. ids := []int64{}
  218. for i := 0; i < 5; i++ {
  219. lresp, err := toGRPC(clus.RandClient()).Lease.LeaseGrant(
  220. ctx0,
  221. &pb.LeaseGrantRequest{TTL: 30})
  222. if err != nil {
  223. t.Fatal(err)
  224. }
  225. if lresp.Error != "" {
  226. t.Fatal(lresp.Error)
  227. }
  228. ids = append(ids, lresp.ID)
  229. }
  230. lresp, err := toGRPC(clus.RandClient()).Lease.LeaseLeases(
  231. context.Background(),
  232. &pb.LeaseLeasesRequest{})
  233. if err != nil {
  234. t.Fatal(err)
  235. }
  236. for i := range lresp.Leases {
  237. if lresp.Leases[i].ID != ids[i] {
  238. t.Fatalf("#%d: lease ID expected %d, got %d", i, ids[i], lresp.Leases[i].ID)
  239. }
  240. }
  241. }
  242. // TestV3LeaseRenewStress keeps creating lease and renewing it immediately to ensure the renewal goes through.
  243. // it was oberserved that the immediate lease renewal after granting a lease from follower resulted lease not found.
  244. // related issue https://github.com/coreos/etcd/issues/6978
  245. func TestV3LeaseRenewStress(t *testing.T) {
  246. testLeaseStress(t, stressLeaseRenew)
  247. }
  248. // TestV3LeaseTimeToLiveStress keeps creating lease and retrieving it immediately to ensure the lease can be retrieved.
  249. // it was oberserved that the immediate lease retrieval after granting a lease from follower resulted lease not found.
  250. // related issue https://github.com/coreos/etcd/issues/6978
  251. func TestV3LeaseTimeToLiveStress(t *testing.T) {
  252. testLeaseStress(t, stressLeaseTimeToLive)
  253. }
  254. func testLeaseStress(t *testing.T, stresser func(context.Context, pb.LeaseClient) error) {
  255. defer testutil.AfterTest(t)
  256. clus := NewClusterV3(t, &ClusterConfig{Size: 3})
  257. defer clus.Terminate(t)
  258. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  259. defer cancel()
  260. errc := make(chan error)
  261. for i := 0; i < 30; i++ {
  262. for j := 0; j < 3; j++ {
  263. go func(i int) { errc <- stresser(ctx, toGRPC(clus.Client(i)).Lease) }(j)
  264. }
  265. }
  266. for i := 0; i < 90; i++ {
  267. if err := <-errc; err != nil {
  268. t.Fatal(err)
  269. }
  270. }
  271. }
  272. func stressLeaseRenew(tctx context.Context, lc pb.LeaseClient) (reterr error) {
  273. defer func() {
  274. if tctx.Err() != nil {
  275. reterr = nil
  276. }
  277. }()
  278. lac, err := lc.LeaseKeepAlive(tctx)
  279. if err != nil {
  280. return err
  281. }
  282. for tctx.Err() == nil {
  283. resp, gerr := lc.LeaseGrant(tctx, &pb.LeaseGrantRequest{TTL: 60})
  284. if gerr != nil {
  285. continue
  286. }
  287. err = lac.Send(&pb.LeaseKeepAliveRequest{ID: resp.ID})
  288. if err != nil {
  289. continue
  290. }
  291. rresp, rxerr := lac.Recv()
  292. if rxerr != nil {
  293. continue
  294. }
  295. if rresp.TTL == 0 {
  296. return fmt.Errorf("TTL shouldn't be 0 so soon")
  297. }
  298. }
  299. return nil
  300. }
  301. func stressLeaseTimeToLive(tctx context.Context, lc pb.LeaseClient) (reterr error) {
  302. defer func() {
  303. if tctx.Err() != nil {
  304. reterr = nil
  305. }
  306. }()
  307. for tctx.Err() == nil {
  308. resp, gerr := lc.LeaseGrant(tctx, &pb.LeaseGrantRequest{TTL: 60})
  309. if gerr != nil {
  310. continue
  311. }
  312. _, kerr := lc.LeaseTimeToLive(tctx, &pb.LeaseTimeToLiveRequest{ID: resp.ID})
  313. if rpctypes.Error(kerr) == rpctypes.ErrLeaseNotFound {
  314. return kerr
  315. }
  316. }
  317. return nil
  318. }
  319. func TestV3PutOnNonExistLease(t *testing.T) {
  320. defer testutil.AfterTest(t)
  321. clus := NewClusterV3(t, &ClusterConfig{Size: 1})
  322. defer clus.Terminate(t)
  323. ctx, cancel := context.WithCancel(context.Background())
  324. defer cancel()
  325. badLeaseID := int64(0x12345678)
  326. putr := &pb.PutRequest{Key: []byte("foo"), Value: []byte("bar"), Lease: badLeaseID}
  327. _, err := toGRPC(clus.RandClient()).KV.Put(ctx, putr)
  328. if !eqErrGRPC(err, rpctypes.ErrGRPCLeaseNotFound) {
  329. t.Errorf("err = %v, want %v", err, rpctypes.ErrGRPCLeaseNotFound)
  330. }
  331. }
  332. // TestV3GetNonExistLease ensures client retrieving nonexistent lease on a follower doesn't result node panic
  333. // related issue https://github.com/coreos/etcd/issues/6537
  334. func TestV3GetNonExistLease(t *testing.T) {
  335. defer testutil.AfterTest(t)
  336. clus := NewClusterV3(t, &ClusterConfig{Size: 3})
  337. defer clus.Terminate(t)
  338. ctx, cancel := context.WithCancel(context.Background())
  339. defer cancel()
  340. lc := toGRPC(clus.RandClient()).Lease
  341. lresp, err := lc.LeaseGrant(ctx, &pb.LeaseGrantRequest{TTL: 10})
  342. if err != nil {
  343. t.Errorf("failed to create lease %v", err)
  344. }
  345. _, err = lc.LeaseRevoke(context.TODO(), &pb.LeaseRevokeRequest{ID: lresp.ID})
  346. if err != nil {
  347. t.Fatal(err)
  348. }
  349. leaseTTLr := &pb.LeaseTimeToLiveRequest{
  350. ID: lresp.ID,
  351. Keys: true,
  352. }
  353. for _, client := range clus.clients {
  354. // quorum-read to ensure revoke completes before TimeToLive
  355. if _, err := toGRPC(client).KV.Range(ctx, &pb.RangeRequest{Key: []byte("_")}); err != nil {
  356. t.Fatal(err)
  357. }
  358. resp, err := toGRPC(client).Lease.LeaseTimeToLive(ctx, leaseTTLr)
  359. if err != nil {
  360. t.Fatalf("expected non nil error, but go %v", err)
  361. }
  362. if resp.TTL != -1 {
  363. t.Fatalf("expected TTL to be -1, but got %v", resp.TTL)
  364. }
  365. }
  366. }
  367. // TestV3LeaseSwitch tests a key can be switched from one lease to another.
  368. func TestV3LeaseSwitch(t *testing.T) {
  369. defer testutil.AfterTest(t)
  370. clus := NewClusterV3(t, &ClusterConfig{Size: 3})
  371. defer clus.Terminate(t)
  372. key := "foo"
  373. // create lease
  374. ctx, cancel := context.WithCancel(context.Background())
  375. defer cancel()
  376. lresp1, err1 := toGRPC(clus.RandClient()).Lease.LeaseGrant(ctx, &pb.LeaseGrantRequest{TTL: 30})
  377. if err1 != nil {
  378. t.Fatal(err1)
  379. }
  380. lresp2, err2 := toGRPC(clus.RandClient()).Lease.LeaseGrant(ctx, &pb.LeaseGrantRequest{TTL: 30})
  381. if err2 != nil {
  382. t.Fatal(err2)
  383. }
  384. // attach key on lease1 then switch it to lease2
  385. put1 := &pb.PutRequest{Key: []byte(key), Lease: lresp1.ID}
  386. _, err := toGRPC(clus.RandClient()).KV.Put(ctx, put1)
  387. if err != nil {
  388. t.Fatal(err)
  389. }
  390. put2 := &pb.PutRequest{Key: []byte(key), Lease: lresp2.ID}
  391. _, err = toGRPC(clus.RandClient()).KV.Put(ctx, put2)
  392. if err != nil {
  393. t.Fatal(err)
  394. }
  395. // revoke lease1 should not remove key
  396. _, err = toGRPC(clus.RandClient()).Lease.LeaseRevoke(ctx, &pb.LeaseRevokeRequest{ID: lresp1.ID})
  397. if err != nil {
  398. t.Fatal(err)
  399. }
  400. rreq := &pb.RangeRequest{Key: []byte("foo")}
  401. rresp, err := toGRPC(clus.RandClient()).KV.Range(context.TODO(), rreq)
  402. if err != nil {
  403. t.Fatal(err)
  404. }
  405. if len(rresp.Kvs) != 1 {
  406. t.Fatalf("unexpect removal of key")
  407. }
  408. // revoke lease2 should remove key
  409. _, err = toGRPC(clus.RandClient()).Lease.LeaseRevoke(ctx, &pb.LeaseRevokeRequest{ID: lresp2.ID})
  410. if err != nil {
  411. t.Fatal(err)
  412. }
  413. rresp, err = toGRPC(clus.RandClient()).KV.Range(context.TODO(), rreq)
  414. if err != nil {
  415. t.Fatal(err)
  416. }
  417. if len(rresp.Kvs) != 0 {
  418. t.Fatalf("lease removed but key remains")
  419. }
  420. }
  421. // TestV3LeaseFailover ensures the old leader drops lease keepalive requests within
  422. // election timeout after it loses its quorum. And the new leader extends the TTL of
  423. // the lease to at least TTL + election timeout.
  424. func TestV3LeaseFailover(t *testing.T) {
  425. clus := NewClusterV3(t, &ClusterConfig{Size: 3})
  426. defer clus.Terminate(t)
  427. toIsolate := clus.waitLeader(t, clus.Members)
  428. lc := toGRPC(clus.Client(toIsolate)).Lease
  429. // create lease
  430. lresp, err := lc.LeaseGrant(context.TODO(), &pb.LeaseGrantRequest{TTL: 5})
  431. if err != nil {
  432. t.Fatal(err)
  433. }
  434. if lresp.Error != "" {
  435. t.Fatal(lresp.Error)
  436. }
  437. // isolate the current leader with its followers.
  438. clus.Members[toIsolate].Pause()
  439. lreq := &pb.LeaseKeepAliveRequest{ID: lresp.ID}
  440. md := metadata.Pairs(rpctypes.MetadataRequireLeaderKey, rpctypes.MetadataHasLeader)
  441. mctx := metadata.NewOutgoingContext(context.Background(), md)
  442. ctx, cancel := context.WithCancel(mctx)
  443. defer cancel()
  444. lac, err := lc.LeaseKeepAlive(ctx)
  445. if err != nil {
  446. t.Fatal(err)
  447. }
  448. defer lac.CloseSend()
  449. // send keep alive to old leader until the old leader starts
  450. // to drop lease request.
  451. var expectedExp time.Time
  452. for {
  453. if err = lac.Send(lreq); err != nil {
  454. break
  455. }
  456. lkresp, rxerr := lac.Recv()
  457. if rxerr != nil {
  458. break
  459. }
  460. expectedExp = time.Now().Add(time.Duration(lkresp.TTL) * time.Second)
  461. time.Sleep(time.Duration(lkresp.TTL/2) * time.Second)
  462. }
  463. clus.Members[toIsolate].Resume()
  464. clus.waitLeader(t, clus.Members)
  465. // lease should not expire at the last received expire deadline.
  466. time.Sleep(time.Until(expectedExp) - 500*time.Millisecond)
  467. if !leaseExist(t, clus, lresp.ID) {
  468. t.Error("unexpected lease not exists")
  469. }
  470. }
  471. // TestV3LeaseRequireLeader ensures that a Recv will get a leader
  472. // loss error if there is no leader.
  473. func TestV3LeaseRequireLeader(t *testing.T) {
  474. defer testutil.AfterTest(t)
  475. clus := NewClusterV3(t, &ClusterConfig{Size: 3})
  476. defer clus.Terminate(t)
  477. lc := toGRPC(clus.Client(0)).Lease
  478. clus.Members[1].Stop(t)
  479. clus.Members[2].Stop(t)
  480. md := metadata.Pairs(rpctypes.MetadataRequireLeaderKey, rpctypes.MetadataHasLeader)
  481. mctx := metadata.NewOutgoingContext(context.Background(), md)
  482. ctx, cancel := context.WithCancel(mctx)
  483. defer cancel()
  484. lac, err := lc.LeaseKeepAlive(ctx)
  485. if err != nil {
  486. t.Fatal(err)
  487. }
  488. donec := make(chan struct{})
  489. go func() {
  490. defer close(donec)
  491. resp, err := lac.Recv()
  492. if err == nil {
  493. t.Fatalf("got response %+v, expected error", resp)
  494. }
  495. if grpc.ErrorDesc(err) != rpctypes.ErrNoLeader.Error() {
  496. t.Errorf("err = %v, want %v", err, rpctypes.ErrNoLeader)
  497. }
  498. }()
  499. select {
  500. case <-time.After(5 * time.Second):
  501. t.Fatal("did not receive leader loss error (in 5-sec)")
  502. case <-donec:
  503. }
  504. }
  505. const fiveMinTTL int64 = 300
  506. // TestV3LeaseRecoverAndRevoke ensures that revoking a lease after restart deletes the attached key.
  507. func TestV3LeaseRecoverAndRevoke(t *testing.T) {
  508. clus := NewClusterV3(t, &ClusterConfig{Size: 1})
  509. defer clus.Terminate(t)
  510. kvc := toGRPC(clus.Client(0)).KV
  511. lsc := toGRPC(clus.Client(0)).Lease
  512. lresp, err := lsc.LeaseGrant(context.TODO(), &pb.LeaseGrantRequest{TTL: fiveMinTTL})
  513. if err != nil {
  514. t.Fatal(err)
  515. }
  516. if lresp.Error != "" {
  517. t.Fatal(lresp.Error)
  518. }
  519. _, err = kvc.Put(context.TODO(), &pb.PutRequest{Key: []byte("foo"), Value: []byte("bar"), Lease: lresp.ID})
  520. if err != nil {
  521. t.Fatal(err)
  522. }
  523. // restart server and ensure lease still exists
  524. clus.Members[0].Stop(t)
  525. clus.Members[0].Restart(t)
  526. clus.waitLeader(t, clus.Members)
  527. // overwrite old client with newly dialed connection
  528. // otherwise, error with "grpc: RPC failed fast due to transport failure"
  529. nc, err := NewClientV3(clus.Members[0])
  530. if err != nil {
  531. t.Fatal(err)
  532. }
  533. kvc = toGRPC(nc).KV
  534. lsc = toGRPC(nc).Lease
  535. defer nc.Close()
  536. // revoke should delete the key
  537. _, err = lsc.LeaseRevoke(context.TODO(), &pb.LeaseRevokeRequest{ID: lresp.ID})
  538. if err != nil {
  539. t.Fatal(err)
  540. }
  541. rresp, err := kvc.Range(context.TODO(), &pb.RangeRequest{Key: []byte("foo")})
  542. if err != nil {
  543. t.Fatal(err)
  544. }
  545. if len(rresp.Kvs) != 0 {
  546. t.Fatalf("lease removed but key remains")
  547. }
  548. }
  549. // TestV3LeaseRevokeAndRecover ensures that revoked key stays deleted after restart.
  550. func TestV3LeaseRevokeAndRecover(t *testing.T) {
  551. clus := NewClusterV3(t, &ClusterConfig{Size: 1})
  552. defer clus.Terminate(t)
  553. kvc := toGRPC(clus.Client(0)).KV
  554. lsc := toGRPC(clus.Client(0)).Lease
  555. lresp, err := lsc.LeaseGrant(context.TODO(), &pb.LeaseGrantRequest{TTL: fiveMinTTL})
  556. if err != nil {
  557. t.Fatal(err)
  558. }
  559. if lresp.Error != "" {
  560. t.Fatal(lresp.Error)
  561. }
  562. _, err = kvc.Put(context.TODO(), &pb.PutRequest{Key: []byte("foo"), Value: []byte("bar"), Lease: lresp.ID})
  563. if err != nil {
  564. t.Fatal(err)
  565. }
  566. // revoke should delete the key
  567. _, err = lsc.LeaseRevoke(context.TODO(), &pb.LeaseRevokeRequest{ID: lresp.ID})
  568. if err != nil {
  569. t.Fatal(err)
  570. }
  571. // restart server and ensure revoked key doesn't exist
  572. clus.Members[0].Stop(t)
  573. clus.Members[0].Restart(t)
  574. clus.waitLeader(t, clus.Members)
  575. // overwrite old client with newly dialed connection
  576. // otherwise, error with "grpc: RPC failed fast due to transport failure"
  577. nc, err := NewClientV3(clus.Members[0])
  578. if err != nil {
  579. t.Fatal(err)
  580. }
  581. kvc = toGRPC(nc).KV
  582. defer nc.Close()
  583. rresp, err := kvc.Range(context.TODO(), &pb.RangeRequest{Key: []byte("foo")})
  584. if err != nil {
  585. t.Fatal(err)
  586. }
  587. if len(rresp.Kvs) != 0 {
  588. t.Fatalf("lease removed but key remains")
  589. }
  590. }
  591. // TestV3LeaseRecoverKeyWithDetachedLease ensures that revoking a detached lease after restart
  592. // does not delete the key.
  593. func TestV3LeaseRecoverKeyWithDetachedLease(t *testing.T) {
  594. clus := NewClusterV3(t, &ClusterConfig{Size: 1})
  595. defer clus.Terminate(t)
  596. kvc := toGRPC(clus.Client(0)).KV
  597. lsc := toGRPC(clus.Client(0)).Lease
  598. lresp, err := lsc.LeaseGrant(context.TODO(), &pb.LeaseGrantRequest{TTL: fiveMinTTL})
  599. if err != nil {
  600. t.Fatal(err)
  601. }
  602. if lresp.Error != "" {
  603. t.Fatal(lresp.Error)
  604. }
  605. _, err = kvc.Put(context.TODO(), &pb.PutRequest{Key: []byte("foo"), Value: []byte("bar"), Lease: lresp.ID})
  606. if err != nil {
  607. t.Fatal(err)
  608. }
  609. // overwrite lease with none
  610. _, err = kvc.Put(context.TODO(), &pb.PutRequest{Key: []byte("foo"), Value: []byte("bar")})
  611. if err != nil {
  612. t.Fatal(err)
  613. }
  614. // restart server and ensure lease still exists
  615. clus.Members[0].Stop(t)
  616. clus.Members[0].Restart(t)
  617. clus.waitLeader(t, clus.Members)
  618. // overwrite old client with newly dialed connection
  619. // otherwise, error with "grpc: RPC failed fast due to transport failure"
  620. nc, err := NewClientV3(clus.Members[0])
  621. if err != nil {
  622. t.Fatal(err)
  623. }
  624. kvc = toGRPC(nc).KV
  625. lsc = toGRPC(nc).Lease
  626. defer nc.Close()
  627. // revoke the detached lease
  628. _, err = lsc.LeaseRevoke(context.TODO(), &pb.LeaseRevokeRequest{ID: lresp.ID})
  629. if err != nil {
  630. t.Fatal(err)
  631. }
  632. rresp, err := kvc.Range(context.TODO(), &pb.RangeRequest{Key: []byte("foo")})
  633. if err != nil {
  634. t.Fatal(err)
  635. }
  636. if len(rresp.Kvs) != 1 {
  637. t.Fatalf("only detached lease removed, key should remain")
  638. }
  639. }
  640. func TestV3LeaseRecoverKeyWithMutipleLease(t *testing.T) {
  641. clus := NewClusterV3(t, &ClusterConfig{Size: 1})
  642. defer clus.Terminate(t)
  643. kvc := toGRPC(clus.Client(0)).KV
  644. lsc := toGRPC(clus.Client(0)).Lease
  645. var leaseIDs []int64
  646. for i := 0; i < 2; i++ {
  647. lresp, err := lsc.LeaseGrant(context.TODO(), &pb.LeaseGrantRequest{TTL: fiveMinTTL})
  648. if err != nil {
  649. t.Fatal(err)
  650. }
  651. if lresp.Error != "" {
  652. t.Fatal(lresp.Error)
  653. }
  654. leaseIDs = append(leaseIDs, lresp.ID)
  655. _, err = kvc.Put(context.TODO(), &pb.PutRequest{Key: []byte("foo"), Value: []byte("bar"), Lease: lresp.ID})
  656. if err != nil {
  657. t.Fatal(err)
  658. }
  659. }
  660. // restart server and ensure lease still exists
  661. clus.Members[0].Stop(t)
  662. clus.Members[0].Restart(t)
  663. clus.waitLeader(t, clus.Members)
  664. for i, leaseID := range leaseIDs {
  665. if !leaseExist(t, clus, leaseID) {
  666. t.Errorf("#%d: unexpected lease not exists", i)
  667. }
  668. }
  669. // overwrite old client with newly dialed connection
  670. // otherwise, error with "grpc: RPC failed fast due to transport failure"
  671. nc, err := NewClientV3(clus.Members[0])
  672. if err != nil {
  673. t.Fatal(err)
  674. }
  675. kvc = toGRPC(nc).KV
  676. lsc = toGRPC(nc).Lease
  677. defer nc.Close()
  678. // revoke the old lease
  679. _, err = lsc.LeaseRevoke(context.TODO(), &pb.LeaseRevokeRequest{ID: leaseIDs[0]})
  680. if err != nil {
  681. t.Fatal(err)
  682. }
  683. // key should still exist
  684. rresp, err := kvc.Range(context.TODO(), &pb.RangeRequest{Key: []byte("foo")})
  685. if err != nil {
  686. t.Fatal(err)
  687. }
  688. if len(rresp.Kvs) != 1 {
  689. t.Fatalf("only detached lease removed, key should remain")
  690. }
  691. // revoke the latest lease
  692. _, err = lsc.LeaseRevoke(context.TODO(), &pb.LeaseRevokeRequest{ID: leaseIDs[1]})
  693. if err != nil {
  694. t.Fatal(err)
  695. }
  696. rresp, err = kvc.Range(context.TODO(), &pb.RangeRequest{Key: []byte("foo")})
  697. if err != nil {
  698. t.Fatal(err)
  699. }
  700. if len(rresp.Kvs) != 0 {
  701. t.Fatalf("lease removed but key remains")
  702. }
  703. }
  704. // acquireLeaseAndKey creates a new lease and creates an attached key.
  705. func acquireLeaseAndKey(clus *ClusterV3, key string) (int64, error) {
  706. // create lease
  707. lresp, err := toGRPC(clus.RandClient()).Lease.LeaseGrant(
  708. context.TODO(),
  709. &pb.LeaseGrantRequest{TTL: 1})
  710. if err != nil {
  711. return 0, err
  712. }
  713. if lresp.Error != "" {
  714. return 0, fmt.Errorf(lresp.Error)
  715. }
  716. // attach to key
  717. put := &pb.PutRequest{Key: []byte(key), Lease: lresp.ID}
  718. if _, err := toGRPC(clus.RandClient()).KV.Put(context.TODO(), put); err != nil {
  719. return 0, err
  720. }
  721. return lresp.ID, nil
  722. }
  723. // testLeaseRemoveLeasedKey performs some action while holding a lease with an
  724. // attached key "foo", then confirms the key is gone.
  725. func testLeaseRemoveLeasedKey(t *testing.T, act func(*ClusterV3, int64) error) {
  726. clus := NewClusterV3(t, &ClusterConfig{Size: 3})
  727. defer clus.Terminate(t)
  728. leaseID, err := acquireLeaseAndKey(clus, "foo")
  729. if err != nil {
  730. t.Fatal(err)
  731. }
  732. if err = act(clus, leaseID); err != nil {
  733. t.Fatal(err)
  734. }
  735. // confirm no key
  736. rreq := &pb.RangeRequest{Key: []byte("foo")}
  737. rresp, err := toGRPC(clus.RandClient()).KV.Range(context.TODO(), rreq)
  738. if err != nil {
  739. t.Fatal(err)
  740. }
  741. if len(rresp.Kvs) != 0 {
  742. t.Fatalf("lease removed but key remains")
  743. }
  744. }
  745. func leaseExist(t *testing.T, clus *ClusterV3, leaseID int64) bool {
  746. l := toGRPC(clus.RandClient()).Lease
  747. _, err := l.LeaseGrant(context.Background(), &pb.LeaseGrantRequest{ID: leaseID, TTL: 5})
  748. if err == nil {
  749. _, err = l.LeaseRevoke(context.Background(), &pb.LeaseRevokeRequest{ID: leaseID})
  750. if err != nil {
  751. t.Fatalf("failed to check lease %v", err)
  752. }
  753. return false
  754. }
  755. if eqErrGRPC(err, rpctypes.ErrGRPCLeaseExist) {
  756. return true
  757. }
  758. t.Fatalf("unexpecter error %v", err)
  759. return true
  760. }