etcdv3 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afad56a64c9b93a3438296356e13a9980625d193
-  data.tar.gz: 6190434f69a1645f25f5336f3bebaf1efc8f3775
+  metadata.gz: 9275ec7e8408f87efd369493235bea9e7bd18a98
+  data.tar.gz: 9fcdd5d3199a60e6c0066758dc32e455e5125e8c
 SHA512:
-  metadata.gz: 95d1672d8f0e0cd1843bf76d2998977c347711887ebacbae463d2d4aa86586b9c4ce663b9dd28e220c8a7cd87d55c94c7cb3381af98988c4ad232d2a733e9913
-  data.tar.gz: 520c207ec53edc8a5ea840f138780c4b7a3e0f2a21180f135045dbb170e3bdaed9a2ebc2fb72b192e7de8295d67f83be9a5572cc9677196a4607b917c3a5f5e7
+  metadata.gz: f5755de875074e6268cd378568ba6633d141d71efeccffe197f59fa142c6fcaa553a4802d438b551f24808b524e07e68221d435f9cf20a434620850164bdf1e7
+  data.tar.gz: ee7cf3faf3e6694843a3c99ee553d3bbcf081c491fa463cf36223bc8e8eb6688c8fb2fe19a42c3d0737ed56d849504e9cea5215e65cc978380448502c4894a24

data/lib/etcdv3/auth.rb

@@ -8,8 +8,8 @@ class Etcd
       'readwrite' => Authpb::Permission::Type::READWRITE
     }
 
-    def initialize(hostname, port, credentials, metadata = {})
-      @stub = Etcdserverpb::Auth::Stub.new("#{hostname}:#{port}", credentials)
+    def initialize(hostname, credentials, metadata = {})
+      @stub = Etcdserverpb::Auth::Stub.new(hostname, credentials)
       @metadata = metadata
     end
 

data/lib/etcdv3/kv.rb

@@ -1,8 +1,8 @@
 
 class Etcd
   class KV
-    def initialize(hostname, port, credentials, metadata={})
-      @stub = Etcdserverpb::KV::Stub.new("#{hostname}:#{port}", credentials)
+    def initialize(hostname, credentials, metadata={})
+      @stub = Etcdserverpb::KV::Stub.new(hostname, credentials)
       @metadata = metadata
     end
 

data/lib/etcdv3/lease.rb

@@ -1,8 +1,8 @@
 
 class Etcd
   class Lease
-    def initialize(hostname, port, credentials, metadata={})
-      @stub = Etcdserverpb::Lease::Stub.new("#{hostname}:#{port}", credentials)
+    def initialize(hostname, credentials, metadata={})
+      @stub = Etcdserverpb::Lease::Stub.new(hostname, credentials)
       @metadata = metadata
     end
 

data/lib/etcdv3/maintenance.rb

@@ -14,8 +14,8 @@ class Etcd
       deactivate: 2
     }
 
-    def initialize(hostname, port, credentials, metadata = {})
-      @stub = Etcdserverpb::Maintenance::Stub.new("#{hostname}:#{port}", credentials)
+    def initialize(hostname, credentials, metadata = {})
+      @stub = Etcdserverpb::Maintenance::Stub.new(hostname, credentials)
       @metadata = metadata
     end
 

data/lib/etcdv3/request.rb

@@ -0,0 +1,41 @@
+class Etcd
+  class Request
+
+    attr_reader :metacache
+
+    def initialize(hostname, credentials, metadata, metacache)
+      @hostname = hostname
+      @credentials = credentials
+      @metadata = metadata
+      @metacache = metacache
+    end
+
+    def handle(interface, method, method_args=[])
+      interface = resolve_interface(interface)
+      interface.send(method, *method_args)
+    end
+
+    private
+
+    def resolve_interface(interface)
+      self.send(interface)
+    end
+
+    def auth
+      @auth ||= Etcd::Auth.new(@hostname, @credentials, @metadata)
+    end
+
+    def kv
+      @kv ||= Etcd::KV.new(@hostname, @credentials, @metadata)
+    end
+
+    def maintenance
+      @maintenance ||= Etcd::Maintenance.new(@hostname, @credentials, @metadata)
+    end
+
+    def lease
+      @lease ||= Etcd::Lease.new(@hostname, @credentials, @metadata)
+    end
+
+  end
+end

data/lib/etcdv3/version.rb

@@ -1,3 +1,3 @@
 class Etcd
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'.freeze
 end

data/lib/etcdv3.rb

@@ -1,12 +1,14 @@
 
 require 'grpc'
 require 'uri'
+require 'base64'
 
 require 'etcdv3/etcdrpc/rpc_services_pb'
 require 'etcdv3/auth'
 require 'etcdv3/kv'
 require 'etcdv3/maintenance'
 require 'etcdv3/lease'
+require 'etcdv3/request'
 
 class Etcd
 
@@ -45,167 +47,165 @@ class Etcd
     @credentials = resolve_credentials
     @metadata = {}
     @metadata[:token] = auth.generate_token(user, password) unless user.nil?
+    @metacache = set_metacache
   end
 
   # Version of Etcd running on member
   def version
-    maintenance.member_status.version
+    request.handle(:maintenance, 'member_status').version
   end
 
   # Store size in bytes.
   def db_size
-    maintenance.member_status.dbSize
+    request.handle(:maintenance, 'member_status').dbSize
   end
 
   # Cluster leader id
   def leader_id
-    maintenance.member_status.leader
+    request.handle(:maintenance, 'member_status').leader
   end
 
   # Inserts a new key.
   def put(key, value, lease_id: nil)
-    kv.put(key, value, lease_id)
+    request.handle(:kv, 'put', [key, value, lease_id])
   end
 
   # Fetches key(s).
   def get(key, range_end='')
-    kv.get(key, range_end)
+    request.handle(:get, 'get', [key, range_end])
   end
 
   # Grant a lease with a speified TTL
   def grant_lease(ttl)
-    lease.grant_lease(ttl)
+    request.handle(:lease, 'grant_lease', [ttl])
   end
 
   # Revokes lease and delete all attached keys
   def revoke_lease(id)
-    lease.revoke_lease(id)
+    request.handle(:lease, 'revoke_lease', [id])
   end
 
   # Returns information regarding the current state of the lease
   def lease_ttl(id)
-    lease.lease_ttl(id)
+    request.handle(:lease, 'lease_ttl', [id])
   end
 
   # Creates new user.
   def add_user(user, password)
-    auth.add_user(user, password)
+    request.handle(:auth, 'add_user', [user, password])
   end
 
   # Fetch specified user
   def get_user(user)
-    auth.get_user(user)
+    request.handle(:auth, 'get_user', [user])
   end
 
   # Delete specified user.
   def delete_user(user)
-    auth.delete_user(user)
+    request.handle(:auth, 'delete_user', [user])
   end
 
   # Changes the specified users password.
   def change_user_password(user, new_password)
-    auth.change_user_password(user, new_password)
+    request.handle(:auth, 'change_user_password', [user, new_password])
   end
 
   # List all users.
   def user_list
-    auth.user_list
-  end
-
-  # Authenticate using specified user and password.
-  # On successful authentication, an auth token will be assigned to the instance.
-  def authenticate(user, password)
-    token = auth.generate_token(user, password)
-    return false unless token
-    @metadata[:token] = token
-    @options[:user] = user
-    @options[:password] = password
-
-    true
+    request.handle(:auth, 'user_list')
   end
 
   # List all roles.
   def role_list
-    auth.role_list
+    request.handle(:auth, 'role_list')
   end
 
   # Add role with specified name.
   def add_role(name)
-    auth.add_role(name)
+    request.handle(:auth, 'add_role', [name])
   end
 
   # Fetches a specified role.
   def get_role(name)
-    auth.get_role(name)
+    request.handle(:auth, 'get_role', [name])
   end
 
   # Delete role.
   def delete_role(name)
-    auth.delete_role(name)
+    request.handle(:auth, 'delete_role', [name])
   end
 
   # Grants role to an existing user.
   def grant_role_to_user(user, role)
-    auth.grant_role_to_user(user, role)
+    request.handle(:auth, 'grant_role_to_user', [user, role])
   end
 
   # Revokes role from a specified user.
   def revoke_role_from_user(user, role)
-    auth.revoke_role_from_user(user, role)
+    request.handle(:auth, 'revoke_role_from_user', [user, role])
   end
 
   # Grants a new permission to an existing role.
   def grant_permission_to_role(name, permission, key, range_end='')
-    auth.grant_permission_to_role(name, permission, key, range_end)
+    request.handle(:auth, 'grant_permission_to_role', [name, permission, key, range_end])
   end
 
   def revoke_permission_from_role(name, permission, key, range_end='')
-    auth.revoke_permission_from_role(name, permission, key, range_end)
+    request.handle(:auth, 'revoke_permission_from_role', [name, permission, key, range_end])
+  end
+
+  # List active alarms
+  def alarm_list
+    request.handle(:maintenance, 'alarms', [:get, leader_id])
+  end
+
+  # Disarm alarms on a specified member.
+  def deactivate_alarms
+    request.handle(:maintenance, 'alarms', [leader_id])
   end
 
   # Enables authentication.
   def enable_auth
-    auth.enable_auth
+    request.handle(:auth, 'enable_auth')
   end
 
   # Disables authentication.
   # This will clear any active auth / token data.
   def disable_auth
-    response = auth.disable_auth
+    response = request.handle(:auth, 'disable_auth')
     if response
       @metadata.delete(:token)
       @options[:user] = nil
       @options[:password] = nil
+      @metacache = set_metacache
     end
     response
   end
 
-  # List active alarms
-  def alarm_list
-    maintenance.alarms(:get, leader_id)
-  end
+  # Authenticate using specified user and password.
+  # On successful authentication, an auth token will be assigned to the instance.
+  def authenticate(user, password)
+    token = request.handle(:auth, 'generate_token', [user, password])
+    return false unless token
+    @metadata[:token] = token
+    @options[:user] = user
+    @options[:password] = password
+    @metacache = set_metacache
 
-  # Disarm alarms on a specified member.
-  def deactivate_alarms
-    maintenance.alarms(:deactivate, leader_id)
+    true
   end
 
   private
 
-  def auth
-    Etcd::Auth.new(hostname, port, @credentials, @metadata)
-  end
-
-  def kv
-    Etcd::KV.new(hostname, port, @credentials, @metadata)
-  end
-
-  def maintenance
-    Etcd::Maintenance.new(hostname, port, @credentials, @metadata)
+  def request
+    # Only re-initialize when metadata changes.
+    return @request if @request && @request.metacache == @metacache
+    @request = Request.new("#{hostname}:#{port}", @credentials, @metadata, @metacache)
   end
 
-  def lease
-    Etcd::Lease.new(hostname, port, @credentials, @metadata)
+  # Generates a new hash using a base64 of the metadata.
+  def set_metacache
+    Base64.strict_encode64(@metadata.to_s)
   end
 
   def resolve_credentials

data/spec/etcd_spec.rb

@@ -2,14 +2,13 @@ require 'spec_helper'
 
 describe Etcd do
   context 'Insecure connection without Auth' do
-    let(:conn) do
-      Etcd.new(url: 'http://127.0.0.1:2379')
-    end
+
+    let(:conn) { local_connection }
+
     describe '#initialize' do
       subject { conn }
       it { is_expected.to have_attributes(scheme: 'http') }
       it { is_expected.to have_attributes(hostname: '127.0.0.1') }
-      it { is_expected.to have_attributes(port: 2379) }
       it { is_expected.to have_attributes(credentials: :this_channel_is_insecure) }
       it { is_expected.to have_attributes(token: nil) }
       it { is_expected.to have_attributes(user: nil) }
@@ -82,5 +81,32 @@ describe Etcd do
         end
       end
     end
+
+    describe '#metacache' do
+      context 'uses cached request object' do
+        let!(:object_id) { conn.send(:request).object_id }
+        before { conn.add_user('root', 'test') }
+        after { conn.delete_user('root') }
+        subject { conn.send(:request).object_id }
+        it { is_expected.to eq(object_id) }
+      end
+      context 'resets cache on auth' do
+        let!(:object_id) { conn.send(:request).object_id }
+        before do
+          conn.add_user('root', 'test')
+          conn.grant_role_to_user('root', 'root')
+          conn.enable_auth
+          conn.authenticate('root', 'test')
+          conn.add_user('boom', 'password')
+        end
+        after do
+          conn.disable_auth
+          conn.delete_user('root')
+          conn.delete_user('boom')
+        end
+        subject { conn.send(:request).object_id }
+        it { is_expected.to_not eq(object_id) }
+      end
+    end
   end
 end

data/spec/etcdv3/auth_spec.rb

@@ -2,9 +2,7 @@ require 'spec_helper'
 
 describe Etcd::Auth do
 
-  let(:stub) do
-    Etcd::Auth.new("127.0.0.1", 2379, :this_channel_is_insecure, {})
-  end
+  let(:stub) { local_stub(Etcd::Auth) }
 
   describe '#add_user' do
     after { stub.delete_user('boom') }

data/spec/etcdv3/kv_spec.rb

@@ -1,14 +1,8 @@
 require 'spec_helper'
 
 describe Etcd::KV do
-
-  let(:stub) do
-    Etcd::KV.new("127.0.0.1", 2379, :this_channel_is_insecure, {})
-  end
-
-  let(:lease_stub) do
-    Etcd::Lease.new("127.0.0.1", 2379, :this_channel_is_insecure, {})
-  end
+  let(:stub) { local_stub(Etcd::KV) }
+  let(:lease_stub) { local_stub(Etcd::Lease) }
 
   describe '#put' do
     context 'without lease' do

data/spec/etcdv3/lease_spec.rb

@@ -2,9 +2,7 @@ require 'spec_helper'
 
 describe Etcd::Lease do
 
-  let(:stub) do
-    Etcd::Lease.new("127.0.0.1", 2379, :this_channel_is_insecure, {})
-  end
+  let(:stub) { local_stub(Etcd::Lease) }
 
   describe '#grant_lease' do
     subject { stub.grant_lease(10) }

data/spec/etcdv3/maintenance_spec.rb

@@ -2,9 +2,7 @@ require 'spec_helper'
 
 describe Etcd::Maintenance do
 
-  let(:stub) do
-    Etcd::Maintenance.new("127.0.0.1", 2379, :this_channel_is_insecure, {})
-  end
+  let(:stub) { local_stub(Etcd::Maintenance) }
 
   describe "#member_status" do
     subject { stub.member_status }

data/spec/helpers/connections.rb

@@ -0,0 +1,21 @@
+module Helpers
+  module Connections
+
+    def local_connection
+      Etcd.new(url: "http://#{local_url}")
+    end
+
+    def local_stub(interface)
+      interface.new(local_url, :this_channel_is_insecure, {})
+    end
+
+    def local_url
+      "127.0.0.1:#{port}"
+    end
+
+    def port
+      ENV.fetch('ETCD_TEST_PORT', 2379).to_i
+    end
+
+  end
+end

data/spec/helpers/test_instance.rb

@@ -1,8 +1,16 @@
 require 'fileutils'
 require 'tmpdir'
+require 'socket'
+require 'timeout'
+require 'helpers/connections'
 
 module Helpers
   class TestInstance
+    include Helpers::Connections
+
+    class InvalidVersionException < StandardError; end
+    class PortInUseException < StandardError; end
+
     MINIMUM_VERSION = Gem::Version.new('3.0.0')
 
     def initialize
@@ -11,21 +19,28 @@ module Helpers
       @bin = discover_binary_path
       @version = discover_binary_version
 
-      raise "Invalid Etcd Version: #{@version}. Must be running 3.0+" \
-        if @version < MINIMUM_VERSION
+      raise InvalidVersionException if @version < MINIMUM_VERSION
+      raise PortInUseException if port_open?
+
+    rescue InvalidVersionException
+      puts "Invalid Etcd Version: #{@version}. Must be running 3.0+"
+      exit(1)
+    rescue PortInUseException
+      puts "Port #{port} is already in use. To choose a new port: `export ETCD_TEST_PORT=new_port`"
+      exit(1)
     end
 
     def start
       raise "Already running etcd servers(#{@pids.inspect})" unless @pids.empty?
-      puts 'Starting up testing environment...'
+      puts "Starting up testing environment on port #{port}..."
       @pids << spawn_etcd_instance
       sleep(5)
     end
 
     def spawn_etcd_instance
-      peer_url = 'http://127.0.0.1:2380'
-      client_url = 'http://127.0.0.1:2379'
-      cluster_url = 'node=http://127.0.0.1:2380'
+      peer_url = "http://127.0.0.1:#{port+1}"
+      client_url = "http://127.0.0.1:#{port}"
+      cluster_url = "node=http://127.0.0.1:#{port+1}"
       flags =  ' --name=node'
       flags << " --initial-advertise-peer-urls=#{peer_url}"
       flags << " --listen-peer-urls=#{peer_url}"
@@ -47,6 +62,8 @@ module Helpers
       @pids.clear
     end
 
+    private
+
     def discover_binary_path
       'etcd'
     end
@@ -54,6 +71,23 @@ module Helpers
     def discover_binary_version
       result = `#{@bin} --version | grep "etcd Version"`
       Gem::Version.new(result.split(':').last.strip)
+    rescue
+      puts "The etcd binary is not in $PATH. Export it, and try again."
+      exit(1)
     end
+
+    def port_open?(seconds=1)
+      Timeout::timeout(seconds) do
+        begin
+          TCPSocket.new('127.0.0.1', port).close
+          true
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+          false
+        end
+      end
+    rescue Timeout::Error
+      false
+    end
+
   end
 end

data/spec/spec_helper.rb

@@ -3,8 +3,11 @@ $LOAD_PATH.unshift File.expand_path('./helpers', __FILE__)
 
 require 'etcdv3'
 require 'helpers/test_instance'
+require 'helpers/connections'
 
 RSpec.configure do |config|
+  config.include(Helpers::Connections)
+  
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
@@ -12,6 +15,7 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
   config.shared_context_metadata_behavior = :apply_to_host_groups
+
   instance = Helpers::TestInstance.new
   config.before(:suite) do
     instance.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Shaun Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -66,12 +66,14 @@ files:
 - lib/etcdv3/protos/http.proto
 - lib/etcdv3/protos/kv.proto
 - lib/etcdv3/protos/rpc.proto
+- lib/etcdv3/request.rb
 - lib/etcdv3/version.rb
 - spec/etcd_spec.rb
 - spec/etcdv3/auth_spec.rb
 - spec/etcdv3/kv_spec.rb
 - spec/etcdv3/lease_spec.rb
 - spec/etcdv3/maintenance_spec.rb
+- spec/helpers/connections.rb
 - spec/helpers/test_instance.rb
 - spec/spec_helper.rb
 homepage: https://github.com/davissp14/etcdv3-ruby
@@ -104,5 +106,6 @@ test_files:
 - spec/etcdv3/kv_spec.rb
 - spec/etcdv3/lease_spec.rb
 - spec/etcdv3/maintenance_spec.rb
+- spec/helpers/connections.rb
 - spec/helpers/test_instance.rb
 - spec/spec_helper.rb