etcdv3 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c90b3d66d75efdf3c6c608cc1ccaf9673731070
-  data.tar.gz: 7698e02e69968d2e6348dd01a7e6813d27d5d50e
+  metadata.gz: eea828b2c14cfeab2c0f9be8a84ea937131a5dc2
+  data.tar.gz: a2e02f9d0155f35185994c07cd7abc5a6d23d5df
 SHA512:
-  metadata.gz: 634ec36c4eccf0b93dd69b51a25e6515c06a26a1677264fb02d035c793cf905feb739ad9bde6e40ae30617416aebe7b85706bb4a1060cbb3d26d8b68e42a702f
-  data.tar.gz: 7043f69c71837cefc8168ff3d5c0225afc9109c4a1c5e9aab1bec7b5fcf56999c9866abac23c3a7b13e9de5422b1983ffae57448f85dafd65f5d369837d7d286
+  metadata.gz: bff96b426657924163a26df9ca1322b5600b33607453d4648affffe2e66bf7c7ef20e5fe2d0443435de71b74d9ceec637f968196315837426294d26dd1b84e78
+  data.tar.gz: 1a10f332e633b1010aba3a355b05ef82e2546e37413222de7553bcdb2461d0d2b368573af75a33e927349c4f461c81564d80adbe149ea7f6e5ac8b478158cc1e

data/.travis.yml

@@ -5,11 +5,9 @@ rvm:
   - 2.3.8
 
 env:
-  - ETCD_VERSION=v3.1.20
-  - ETCD_VERSION=v3.2.25
-# v3.3.10 is not working for whatever reason (at least in travis, spec passes
-# locally for me)
-#  - ETCD_VERSION=v3.3.10
+  - ETCD_VERSION_TO_TEST=v3.1.20
+  - ETCD_VERSION_TO_TEST=v3.2.25
+  - ETCD_VERSION_TO_TEST=v3.3.10
 
 install:
     - bundle install

data/README.md

@@ -149,12 +149,15 @@ end
 
 ## Watch
 ```ruby
-# Watch for changes on a specified key and return
-events = conn.watch('foo')
+# Watch for changes on a specified key for at most 10 seconds and return
+events = conn.watch('foo', timeout: 10)
 
 # Watch for changes on a specified key range and return
 events = conn.watch('foo', range_end: 'fop')
 
+# Watch for changes since a given revision
+events = conn.watch('foo', start_revision: 42)
+
 # Watches for changes continuously until killed.
 event_count = 0
 conn.watch('boom') do |events|

data/Rakefile

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-ETCD_VERSION = ENV["ETCD_VERSION"] || "v3.2.0"
-ETCD_URL = "https://github.com/coreos/etcd/releases/download/#{ETCD_VERSION}/etcd-#{ETCD_VERSION}-linux-amd64.tar.gz"
+ETCD_VERSION = ENV["ETCD_VERSION_TO_TEST"] || "v3.2.0"
+ETCD_URL = "https://github.com/coreos/etcd/releases/download/" \
+           "#{ETCD_VERSION}/etcd-#{ETCD_VERSION}-linux-amd64.tar.gz"
 
 require "tmpdir"
 

data/lib/etcdv3/version.rb

@@ -1,3 +1,3 @@
 class Etcdv3
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.10.1'.freeze
 end

data/lib/etcdv3/watch.rb

@@ -1,16 +1,20 @@
 class Etcdv3
   class Watch
+    include GRPC::Core::TimeConsts
 
-    def initialize(hostname, credentials, _timeout, metadata = {})
+    def initialize(hostname, credentials, timeout, metadata = {})
       @stub = Etcdserverpb::Watch::Stub.new(hostname, credentials)
+      @timeout = timeout
       @metadata = metadata
     end
 
-    def watch(key, range_end, block)
-      create_req = Etcdserverpb::WatchCreateRequest.new(key: key, range_end: range_end)
+    def watch(key, range_end, start_revision, block, timeout: nil)
+      create_req = Etcdserverpb::WatchCreateRequest.new(key: key)
+      create_req.range_end = range_end if range_end
+      create_req.start_revision = start_revision if start_revision
       watch_req = Etcdserverpb::WatchRequest.new(create_request: create_req)
       events = nil
-      @stub.watch([watch_req], metadata: @metadata).each do |resp|
+      @stub.watch([watch_req], metadata: @metadata, deadline: deadline(timeout)).each do |resp|
         next if resp.events.empty?
         if block
           block.call(resp.events)
@@ -21,5 +25,9 @@ class Etcdv3
       end
       events
     end
+
+    def deadline(timeout)
+      from_relative_time(timeout || @timeout)
+    end
   end
 end

data/lib/etcdv3.rb

@@ -219,8 +219,8 @@ class Etcdv3
   end
 
   # Watches for changes on a specified key range.
-  def watch(key, range_end: '', &block)
-    @conn.handle(:watch, 'watch', [key, range_end, block])
+  def watch(key, range_end: nil, start_revision: nil, timeout: nil, &block)
+    @conn.handle(:watch, 'watch', [key, range_end, start_revision, block, timeout: timeout])
   end
 
   def transaction(timeout: nil, &block)

data/spec/etcdv3/watch_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'securerandom'
+
+# Locking is not implemented in etcd v3.1.X
+unless $instance.version < Gem::Version.new("3.2.0")
+  describe Etcdv3::Watch do
+    let(:stub) { local_stub(Etcdv3::Watch, 1) }
+    let(:kv_stub) { local_stub(Etcdv3::KV, 1) }
+
+    context 'xxx' do
+      before(:each) do
+        kv_stub.put 'foo', 'bar'
+      end
+      it_should_behave_like "a method with a GRPC timeout", described_class, :watch, :watch, 'foo', "\0", 1, nil
+    end
+  end
+end

data/spec/etcdv3_spec.rb

@@ -181,6 +181,20 @@ describe Etcdv3 do
       end
     end
 
+    describe '#watch' do
+      let!(:foo) { conn.put('foo', 'bar') }
+      subject { conn.watch('foo', start_revision: 1) }
+      it { is_expected.to_not be_nil }
+      it "raises a GRPC::DeadlineExceeded exception when it takes too long"  do
+        expect do
+          conn.watch('foo', timeout: 0)
+        end.to raise_exception(GRPC::DeadlineExceeded)
+      end
+      it "accepts a timeout" do
+        expect{ conn.watch('foo', start_revision: 1, timeout: 10) }.to_not raise_exception
+      end
+    end
+
     describe '#lease_keep_alive_once' do
       let!(:lease_id) { conn.lease_grant(2)['ID'] }
       subject { conn.lease_keep_alive_once(lease_id) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Shaun Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -114,6 +114,7 @@ files:
 - spec/etcdv3/lease_spec.rb
 - spec/etcdv3/lock_spec.rb
 - spec/etcdv3/maintenance_spec.rb
+- spec/etcdv3/watch_spec.rb
 - spec/etcdv3_spec.rb
 - spec/helpers/connections.rb
 - spec/helpers/shared_examples_for_timeout.rb
@@ -151,6 +152,7 @@ test_files:
 - spec/etcdv3/lease_spec.rb
 - spec/etcdv3/lock_spec.rb
 - spec/etcdv3/maintenance_spec.rb
+- spec/etcdv3/watch_spec.rb
 - spec/etcdv3_spec.rb
 - spec/helpers/connections.rb
 - spec/helpers/shared_examples_for_timeout.rb