v3_lease_test.go 23 KB

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