ruby_skynet 0.5.0 → 0.6.0

data/test/service_registry_test.rb

@@ -0,0 +1,122 @@
+# Allow test to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'ruby_skynet'
+
+# Register an appender if one is not already registered
+if SemanticLogger::Logger.appenders.size == 0
+  SemanticLogger::Logger.default_level = :trace
+  SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new('test.log')
+end
+
+# Unit Test
+class ServiceRegistryTest < Test::Unit::TestCase
+  context RubySkynet::ServiceRegistry do
+
+    setup do
+      @service_name = 'MyRegistryService'
+      @version      = 5
+      @region       = 'RegistryTest'
+      @hostname     = '127.0.0.1'
+      @port         = 2100
+      @service_key  = "/services/#{@service_name}/#{@version}/#{@region}/#{@hostname}/#{@port}"
+    end
+
+    context "without a registered service" do
+      should "not be in doozer" do
+        RubySkynet.services.send(:doozer_pool).with_connection do |doozer|
+          assert_equal '', doozer[@service_key]
+        end
+      end
+    end
+
+    context "with a registered service" do
+      setup do
+        RubySkynet.services.register_service(@service_name, @version, @region, @hostname, @port)
+        # Allow time for doozer callback that service was registered
+        sleep 0.1
+      end
+
+      teardown do
+        RubySkynet.services.deregister_service(@service_name, @version, @region, @hostname, @port)
+        # Allow time for doozer callback that service was deregistered
+        sleep 0.1
+        # No servers should be in the local registry
+        assert_equal nil, RubySkynet.services.servers_for(@service_name, @version, @region)
+      end
+
+      should "find server using exact match" do
+        assert servers = RubySkynet.services.servers_for(@service_name, @version, @region)
+        assert_equal 1, servers.size
+        assert_equal "#{@hostname}:#{@port}", servers.first
+      end
+
+      should "find server using * version match" do
+        assert servers = RubySkynet.services.servers_for(@service_name, '*', @region)
+        assert_equal 1, servers.size
+        assert_equal "#{@hostname}:#{@port}", servers.first
+      end
+
+      context "with multiple servers" do
+        setup do
+          @second_hostname     = '127.0.10.1'
+          RubySkynet.services.register_service(@service_name, @version, @region, @hostname, @port+1)
+          RubySkynet.services.register_service(@service_name, @version, @region, @hostname, @port+3)
+          RubySkynet.services.register_service(@service_name, @version-1, @region, @hostname, @port+2)
+          RubySkynet.services.register_service(@service_name, @version, @region, @second_hostname, @port)
+        end
+
+        teardown do
+          RubySkynet.services.deregister_service(@service_name, @version, @region, @hostname, @port+1)
+          RubySkynet.services.deregister_service(@service_name, @version, @region, @hostname, @port+3)
+          RubySkynet.services.deregister_service(@service_name, @version-1, @region, @hostname, @port+2)
+          RubySkynet.services.deregister_service(@service_name, @version, @region, @second_hostname, @port)
+        end
+
+        should "using * version match" do
+          assert servers = RubySkynet.services.servers_for(@service_name, '*', @region)
+          assert_equal 3, servers.size, RubySkynet.services.to_h.to_s
+          assert_equal "#{@hostname}:#{@port}", servers.first
+          assert_equal "#{@hostname}:#{@port+3}", servers.last
+        end
+      end
+
+      should "return nil when service not found" do
+        assert_equal nil, RubySkynet.services.servers_for('MissingService', @version, @region)
+      end
+
+      should "return nil when version not found" do
+        assert_equal nil, RubySkynet.services.servers_for(@service_name, @version+1, @region)
+      end
+
+      should "return nil when region not found" do
+        assert_equal nil, RubySkynet.services.servers_for(@service_name, @version, 'OtherRegion')
+      end
+
+      should "be in doozer" do
+        RubySkynet.services.send(:doozer_pool).with_connection do |doozer|
+          assert_equal true, doozer[@service_key].length > 20
+        end
+      end
+    end
+
+    context "scoring" do
+      [
+        ['192.168.11.0',  4 ],
+        ['192.168.11.10', 3 ],
+        ['192.168.10.0',  2 ],
+        ['192.5.10.0',    1 ],
+        ['10.0.11.0',     0 ],
+      ].each do |test|
+        should "handle score #{test[1]}" do
+          local_ip_address = "192.168.11.0"
+          assert_equal test[1], RubySkynet::ServiceRegistry.score_for_server(test[0], local_ip_address), "Local: #{local_ip_address} Server: #{test[0]} Score: #{test[1]}"
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_skynet
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic_logger
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: resilient_socket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
-  name: ruby_protobuf
+  name: ruby_doozer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: gene_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 description: Ruby Client for invoking Skynet services
 email:
 - reidmo@gmail.com
@@ -106,7 +106,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/e.rb
 - examples/echo_client.rb
 - examples/echo_server.rb
 - lib/rails/generators/ruby_skynet/config/config_generator.rb
@@ -116,22 +115,18 @@ files:
 - lib/ruby_skynet/client.rb
 - lib/ruby_skynet/common.rb
 - lib/ruby_skynet/connection.rb
-- lib/ruby_skynet/doozer/client.rb
-- lib/ruby_skynet/doozer/exceptions.rb
-- lib/ruby_skynet/doozer/msg.pb.rb
 - lib/ruby_skynet/exceptions.rb
 - lib/ruby_skynet/railtie.rb
 - lib/ruby_skynet/railties/ruby_skynet.rake
-- lib/ruby_skynet/registry.rb
 - lib/ruby_skynet/ruby_skynet.rb
 - lib/ruby_skynet/server.rb
 - lib/ruby_skynet/service.rb
+- lib/ruby_skynet/service_registry.rb
 - lib/ruby_skynet/version.rb
 - test.sh
 - test/base_test.rb
 - test/client_test.rb
-- test/doozer_client_test.rb
-- test/registry_test.rb
+- test/service_registry_test.rb
 - test/service_test.rb
 homepage: https://github.com/ClarityServices/ruby_skynet
 licenses:

data/lib/ruby_skynet/doozer/client.rb

@@ -1,209 +0,0 @@
-require 'ruby_skynet/doozer/msg.pb'
-require 'semantic_logger'
-require 'resilient_socket'
-require 'ruby_skynet/doozer/exceptions'
-require 'ruby_skynet/doozer/msg.pb'
-
-module RubySkynet
-  module Doozer
-    class Client
-
-      include SemanticLogger::Loggable
-
-      # Create a resilient client connection to a Doozer server
-      def initialize(params={})
-        # User configurable options
-        params[:read_timeout]           ||= 5
-        params[:connect_timeout]        ||= 3
-        params[:connect_retry_interval] ||= 0.1
-        params[:connect_retry_count]    ||= 3
-
-        # Server name and port where Doozer is running
-        # Defaults to 127.0.0.1:8046
-        params[:server] ||= '127.0.0.1:8046' unless params[:servers]
-
-        # Disable buffering the send since it is a RPC call
-        params[:buffered] = false
-
-        logger.trace "Socket Connection parameters", params.dup
-
-        # For each new connection
-        params[:on_connect] = Proc.new do |socket|
-          # Reset user_data on each connection
-          socket.user_data = 0
-        end
-
-        @socket = ResilientSocket::TCPClient.new(params)
-      end
-
-      # Close this client connection to doozer
-      def close
-        @socket.close if @socket
-      end
-
-      # Returns the current Doozer revision
-      def current_revision
-        invoke(Request.new(:verb => Request::Verb::REV)).rev
-      end
-
-      # Set a value in Doozer
-      #   path:  Path to the value to be set
-      #   value: Value to set
-      #   rev:   Revision at which to set the value
-      #         If not supplied it will replace the latest version on the server
-      #
-      # Returns the new revision of the updated value
-      #
-      # It is recommended to set the revision so that multiple clients do not
-      # attempt to update the value at the same time.
-      # Setting the revision also allows the call to be retried automatically
-      # in the event of a network failure
-      def set(path, value, rev=-1)
-        invoke(Request.new(:path => path, :value => value, :rev => rev, :verb => Request::Verb::SET), false).rev
-      end
-
-      # Sets the current value at the supplied path
-      def []=(path,value)
-        set(path, value)
-      end
-
-      # Return the value at the supplied path and revision
-      def get(path, rev = nil)
-        invoke(Request.new(:path => path, :rev => rev, :verb => Request::Verb::GET))
-      end
-
-      # Returns just the value at the supplied path, not the revision
-      def [](path)
-        get(path).value
-      end
-
-      # Deletes the file at path if rev is greater than or equal to the file's revision.
-      # Returns nil when the file was removed
-      # Raises an exception if an attempt to remove the file and its revision
-      #   is greater than that supplied
-      def delete(path, rev=-1)
-        invoke(Request.new(:path => path, :rev => rev, :verb => Request::Verb::DEL))
-        nil
-      end
-
-      # Returns the directory in the supplied path
-      # Use offset to get the next
-      # returns nil if no further paths are available
-      def directory(path, offset = 0, rev = nil)
-        begin
-          invoke(Request.new(:path => path, :rev => rev, :offset => offset, :verb => Request::Verb::GETDIR))
-        rescue RubySkynet::Doozer::ResponseError => exc
-          raise exc unless exc.message.include?('RANGE')
-          nil
-        end
-      end
-
-      def stat(path, rev = nil)
-        invoke(Request.new(:path => path, :rev => rev, :verb => Request::Verb::STAT))
-      end
-
-      def access(secret)
-        invoke(Request.new(:path => secret, :verb => Request::Verb::ACCESS))
-      end
-
-      # Returns every entry in the supplied path
-      # path can also contain wildcard characters such as '*'
-      # Example:
-      #   hosts = []
-      #   walk('/ctl/node/*/addr', current_revision).each do |node|
-      #     hosts << node.value unless hosts.include? node.value
-      #   end
-      def walk(path, rev = nil, offset = 0)
-        paths = []
-        revision = rev || current_revision
-        # Resume walk on network connection failure
-        @socket.retry_on_connection_failure do
-          while true
-            send(Request.new(:path => path, :rev => revision , :offset => offset, :verb => Request::Verb::WALK))
-            response = read
-            if response.err_code
-              break if response.err_code == Response::Err::RANGE
-            else
-              raise ResponseError.new("#{Response::Err.name_by_value(response.err_code)}: #{response.err_detail}") if response.err_code != 0
-            end
-            paths << response
-            offset += 1
-          end
-        end
-        paths
-      end
-
-      # Returns [Array] of hostname [String] with each string
-      # representing another Doozer server that can be connected to
-      def doozer_hosts
-        hosts = []
-        walk('/ctl/node/*/addr', current_revision).each do |node|
-          hosts << node.value unless hosts.include? node.value
-        end
-      end
-
-      # Wait for changes to the supplied path
-      # Returns the next change to the supplied path
-      def wait(path, rev=current_revision, timeout=-1)
-        invoke(Request.new(:path => path, :rev => rev, :verb => Request::Verb::WAIT), true, timeout)
-      end
-
-      # Watch for any changes to the supplied path, calling the supplied block
-      # for every change
-      # Runs until an exception is thrown
-      #
-      # If a connection error occurs it will create a new connection to doozer
-      # and resubmit the wait. I.e. Will continue from where it left off
-      # without any noticeable effect to the supplied block
-      def watch(path, rev=current_revision)
-        loop do
-          result = wait(path, rev, -1)
-          yield result
-          rev = result.rev + 1
-        end
-      end
-
-      #####################
-      #protected
-
-      # Call the Doozer server
-      #
-      # When readonly ==> true the request is always retried on network failure
-      # When readonly ==> false the request is retried on network failure
-      #   _only_ if a rev has been supplied
-      #
-      # When modifier is true
-      def invoke(request, readonly=true, timeout=nil)
-        retry_read = readonly || !request.rev.nil?
-        response = nil
-        @socket.retry_on_connection_failure do
-          send(request)
-          response = read(timeout) if retry_read
-        end
-        # Network error on read must be sent back to caller since we do not
-        # know if the modification was made
-        response = read(timeout) unless retry_read
-        raise ResponseError.new("#{Response::Err.name_by_value(response.err_code)} (#{response.err_code}): #{response.err_detail}") if response.err_code != 0
-        response
-      end
-
-      # Send the protobuf Request to Doozer
-      def send(request)
-        request.tag = 0
-        data = request.serialize_to_string
-        # An additional header is added to the request indicating the size of the request
-        head = [data.length].pack("N")
-        @socket.write(head+data)
-      end
-
-      # Read the protobuf Response from Doozer
-      def read(timeout=nil)
-        # First strip the additional header indicating the size of the subsequent response
-        head = @socket.read(4,nil,timeout)
-        length = head.unpack("N")[0]
-        Response.new.parse_from_string(@socket.read(length))
-      end
-
-    end
-  end
-end

data/lib/ruby_skynet/doozer/exceptions.rb

@@ -1,5 +0,0 @@
-module RubySkynet
-  module Doozer
-    class ResponseError < ::RuntimeError; end
-  end
-end

data/lib/ruby_skynet/doozer/msg.pb.rb

@@ -1,118 +0,0 @@
-### Generated by rprotoc. DO NOT EDIT!
-### <proto file: doozerd/server/msg.proto>
-# package server;
-#
-# // see doc/proto.md
-# message Request {
-#   optional int32 tag = 1;
-#
-#   enum Verb {
-#       GET      = 1;
-#       SET      = 2;
-#       DEL      = 3;
-#       REV      = 5;
-#       WAIT     = 6;
-#       NOP      = 7;
-#       WALK     = 9;
-#       GETDIR   = 14;
-#       STAT     = 16;
-#       ACCESS   = 99;
-#   }
-#   optional Verb verb = 2;
-#
-#   optional string path = 4;
-#   optional bytes value = 5;
-#   optional int32 other_tag = 6;
-#
-#   optional int32 offset = 7;
-#
-#   optional int64 rev = 9;
-# }
-#
-# // see doc/proto.md
-# message Response {
-#   optional int32 tag = 1;
-#   optional int32 flags = 2;
-#
-#   optional int64 rev = 3;
-#   optional string path = 5;
-#   optional bytes value = 6;
-#   optional int32 len = 8;
-#
-#   enum Err {
-#     // don't use value 0
-#     OTHER        = 127;
-#     TAG_IN_USE   = 1;
-#     UNKNOWN_VERB = 2;
-#     READONLY     = 3;
-#     TOO_LATE     = 4;
-#     REV_MISMATCH = 5;
-#     BAD_PATH     = 6;
-#     MISSING_ARG  = 7;
-#     RANGE        = 8;
-#     NOTDIR       = 20;
-#     ISDIR        = 21;
-#     NOENT        = 22;
-#   }
-#   optional Err err_code = 100;
-#   optional string err_detail = 101;
-# }
-
-require 'protobuf/message/message'
-require 'protobuf/message/enum'
-require 'protobuf/message/service'
-require 'protobuf/message/extend'
-
-module RubySkynet
-  module Doozer
-    class Request < ::Protobuf::Message
-      defined_in __FILE__
-      optional :int32, :tag, 1
-      class Verb < ::Protobuf::Enum
-        defined_in __FILE__
-        GET = value(:GET, 1)
-        SET = value(:SET, 2)
-        DEL = value(:DEL, 3)
-        REV = value(:REV, 5)
-        WAIT = value(:WAIT, 6)
-        NOP = value(:NOP, 7)
-        WALK = value(:WALK, 9)
-        GETDIR = value(:GETDIR, 14)
-        STAT = value(:STAT, 16)
-        ACCESS = value(:ACCESS, 99)
-      end
-      optional :Verb, :verb, 2
-      optional :string, :path, 4
-      optional :bytes, :value, 5
-      optional :int32, :other_tag, 6
-      optional :int32, :offset, 7
-      optional :int64, :rev, 9
-    end
-    class Response < ::Protobuf::Message
-      defined_in __FILE__
-      optional :int32, :tag, 1
-      optional :int32, :flags, 2
-      optional :int64, :rev, 3
-      optional :string, :path, 5
-      optional :bytes, :value, 6
-      optional :int32, :len, 8
-      class Err < ::Protobuf::Enum
-        defined_in __FILE__
-        OTHER = value(:OTHER, 127)
-        TAG_IN_USE = value(:TAG_IN_USE, 1)
-        UNKNOWN_VERB = value(:UNKNOWN_VERB, 2)
-        READONLY = value(:READONLY, 3)
-        TOO_LATE = value(:TOO_LATE, 4)
-        REV_MISMATCH = value(:REV_MISMATCH, 5)
-        BAD_PATH = value(:BAD_PATH, 6)
-        MISSING_ARG = value(:MISSING_ARG, 7)
-        RANGE = value(:RANGE, 8)
-        NOTDIR = value(:NOTDIR, 20)
-        ISDIR = value(:ISDIR, 21)
-        NOENT = value(:NOENT, 22)
-      end
-      optional :Err, :err_code, 100
-      optional :string, :err_detail, 101
-    end
-  end
-end