hoodoo 1.0.2

data/spec/presenters/walk_spec.rb

@@ -0,0 +1,198 @@
+require "spec_helper"
+
+
+# This specific file just tests the presenter layer "#walk" method. It
+# uses (at the time of writing) every single kind of schema field to
+# varying degrees (where possible, e.g. "object") of complexity and
+# then runs one "walk" call over the whole thing to verify that it does
+# get called on every node.
+
+describe Hoodoo::Presenters::Base do
+  before do
+    class TestWalkPresenterA < Hoodoo::Presenters::Base
+      schema do
+
+        # Simple fields
+
+        boolean  :test_boolean
+        datetime :test_datetime
+        date     :test_date
+        decimal  :test_decimal, :precision => 2
+        enum     :test_enum, :from => [ :one, :two ]
+        float    :test_float
+        integer  :test_integer
+        string   :test_string, :length => 8
+        tags     :test_tags
+        text     :test_text
+        uuid     :test_uuid
+
+        # Objects, in their various permitted forms
+
+        object :test_object_2 do
+          text :test_object_2_text_1
+          text :test_object_2_text_2
+        end
+
+        object :test_object_3 do
+          text :test_object_3_text_1
+          object :test_object_3_object_1 do
+            text :test_object_3_object_1_text_1
+          end
+          array :test_object_3_array_1 do
+            text :test_object_3_array_1_text_1
+            text :test_object_3_array_1_text_2
+          end
+          text :test_object_3_text_2
+        end
+
+        # Arrays, in their various permitted forms
+
+        array :text_array_1
+
+        array :test_array_2 do
+          text :test_array_2_text_1
+          text :test_array_2_text_2
+        end
+
+        array :test_array_3 do
+          text :test_array_3_text_1
+          object :test_array_3_object_1 do
+            text :test_array_3_object_1_text_1
+            text :test_array_3_object_1_text_2
+          end
+          text :test_array_3_text_2
+        end
+
+        # Hashes, in their various complex permitted forms
+
+        hash :test_hash_1
+
+        hash :test_hash_2 do
+          key :test_hash_2_key_1 do
+            text :test_hash_2_key_1_text_1
+            object :test_hash_2_key_1_object_1 do
+              text :test_hash_2_key_1_object_1_text_1
+            end
+          end
+          key :test_hash_2_key_2 do
+            array :test_hash_2_key_2_array_1 do
+              text :test_hash_2_key_2_array_1_text_1
+            end
+          end
+        end
+
+        hash :test_hash_3 do
+          keys do
+            text :test_hash_3_keys_text_1
+            object :test_hash_3_keys_object_1 do
+              text :test_hash_3_keys_object_1_text_1
+            end
+            array :test_hash_3_keys_array_1 do
+              text :test_hash_3_keys_array_1_text_1
+            end
+          end
+        end
+
+        hash :test_hash_4 do
+          keys :length => 4
+        end
+
+      end # 'schema do'
+    end   # 'class TestWalkPresenter < Hoodoo::Presenters::Base'
+
+    class TestWalkPresenterB < Hoodoo::Presenters::Base
+      schema do
+        text :simple_text
+      end
+    end
+
+    class TestWalkPresenterC < Hoodoo::Presenters::Base
+      schema do
+      end
+    end
+
+  end # 'before do'
+
+  context '#walk' do
+    it 'handles complex tree' do
+      names = []
+
+      TestWalkPresenterA.walk do | property |
+        names << property.name
+      end
+
+      expected_names = [ '' ] + %w{
+        test_boolean
+        test_datetime
+        test_date
+        test_decimal
+        test_enum
+        test_float
+        test_integer
+        test_string
+        test_tags
+        test_text
+        test_uuid
+        test_object_2
+        test_object_2_text_1
+        test_object_2_text_2
+        test_object_3
+        test_object_3_text_1
+        test_object_3_object_1
+        test_object_3_object_1_text_1
+        test_object_3_array_1
+        test_object_3_array_1_text_1
+        test_object_3_array_1_text_2
+        test_object_3_text_2
+        text_array_1
+        test_array_2
+        test_array_2_text_1
+        test_array_2_text_2
+        test_array_3
+        test_array_3_text_1
+        test_array_3_object_1
+        test_array_3_object_1_text_1
+        test_array_3_object_1_text_2
+        test_array_3_text_2
+        test_hash_1
+        test_hash_2
+        test_hash_2_key_1
+        test_hash_2_key_1_text_1
+        test_hash_2_key_1_object_1
+        test_hash_2_key_1_object_1_text_1
+        test_hash_2_key_2
+        test_hash_2_key_2_array_1
+        test_hash_2_key_2_array_1_text_1
+        test_hash_3
+        test_hash_3_keys_text_1
+        test_hash_3_keys_object_1
+        test_hash_3_keys_object_1_text_1
+        test_hash_3_keys_array_1
+        test_hash_3_keys_array_1_text_1
+        test_hash_4
+      }
+
+      expect( names ).to eq( expected_names )
+    end
+
+    it 'handles simple tree' do
+      names = []
+
+      TestWalkPresenterB.walk do | property |
+        names << property.name
+      end
+
+      expect( names ).to eq( [ '', 'simple_text' ] )
+    end
+
+    it 'handles empty tree' do
+      names = []
+
+      TestWalkPresenterC.walk do | property |
+        names << property.name
+      end
+
+      expect( names ).to eq( [ '' ] )
+    end
+  end
+end

data/spec/services/discovery/discoverers/by_consul_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Hoodoo::Services::Discovery::ByConsul do
+  before :each do
+    @d = described_class.new
+  end
+
+  # TODO: Assume static mapping and no Consul communication to mock out.
+
+  it 'announces' do
+    result = @d.announce( 'Version', '2' ) # Intentional string use
+    expect( result ).to be_a( Hoodoo::Services::Discovery::ForAMQP )
+    expect( result.resource ).to eq( :Version )
+    expect( result.version ).to eq( 2 )
+    expect( result.queue_name ).to eq( 'service.version' )
+    expect( result.equivalent_path ).to eq( '/v2/versions')
+  end
+
+  it 'discovers' do
+    result = @d.announce( 'Version', 2 )
+    @d.instance_variable_set( '@known_local_resources', {} ) # Hack for test!
+
+    result = @d.discover( :Version, 2 )
+    expect( result.resource ).to eq( :Version )
+    expect( result.version ).to eq( 2 )
+    expect( result.queue_name ).to eq( 'service.version' )
+    expect( result.equivalent_path ).to eq( '/v2/versions')
+  end
+end

data/spec/services/discovery/discoverers/by_convention_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Hoodoo::Services::Discovery::ByConvention do
+  context 'with default routing' do
+    before :each do
+      @d = described_class.new( :base_uri => 'http://pond.org.uk' )
+    end
+
+    it 'announces' do
+      result = @d.announce( 'Apple', '3' ) # Intentional string use
+      expect( result ).to be_a( Hoodoo::Services::Discovery::ForHTTP )
+      expect( result.resource ).to eq( :Apple )
+      expect( result.version ).to eq( 3 )
+      expect( result.endpoint_uri.to_s ).to eq( 'http://pond.org.uk/v3/apples')
+
+      result = @d.announce( 'Sheep', 2 )
+      expect( result.endpoint_uri.to_s ).to eq( 'http://pond.org.uk/v2/sheep')
+    end
+
+    it 'discovers' do
+      @d.announce( 'Apple', 3 )
+      @d.instance_variable_set( '@known_local_resources', {} ) # Hack for test!
+
+      result = @d.discover( :Apple, 3 )
+      expect( result ).to be_a( Hoodoo::Services::Discovery::ForHTTP )
+      expect( result.resource ).to eq( :Apple )
+      expect( result.version ).to eq( 3 )
+      expect( result.endpoint_uri.to_s ).to eq( 'http://pond.org.uk/v3/apples')
+    end
+  end
+
+  context 'with overridden routing' do
+    before :each do
+      @d = described_class.new(
+        :base_uri => 'http://pond.org.uk',
+        :routing => {
+          :Version => { 1 => '/v1/version', 2 => '/version_2/version_singleton' },
+          :Health  => { 2 => '/v2/health' }
+        }
+      )
+    end
+
+    it 'discovers' do
+      @d.announce( :Version, 1 )
+      @d.announce( 'Version', 2 ) # Intentional string use
+      @d.announce( :Version, 3 )
+      @d.announce( :Apple, 3 )
+      @d.announce( :Health, 1 )
+      @d.announce( :Health, 2 )
+
+      @d.instance_variable_set( '@known_local_resources', {} ) # Hack for test!
+
+      result = @d.discover( :Version, 1 )
+      expect( result.endpoint_uri.to_s ).to eq( 'http://pond.org.uk/v1/version')
+      result = @d.discover( :Version, 2 )
+      expect( result.endpoint_uri.to_s ).to eq( 'http://pond.org.uk/version_2/version_singleton')
+      result = @d.discover( :Version, 3 )
+      expect( result.endpoint_uri.to_s ).to eq( 'http://pond.org.uk/v3/versions')
+      result = @d.discover( :Apple, 3 )
+      expect( result.endpoint_uri.to_s ).to eq( 'http://pond.org.uk/v3/apples')
+      result = @d.discover( :Health, 1 )
+      expect( result.endpoint_uri.to_s ).to eq( 'http://pond.org.uk/v1/healths')
+      result = @d.discover( :Health, 2 )
+      expect( result.endpoint_uri.to_s ).to eq( 'http://pond.org.uk/v2/health')
+    end
+  end
+end

data/spec/services/discovery/discoverers/by_drb/by_drb_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+# A lot of this class is already covered by tests elsewhere, e.g. the
+# drb_server_spec.rb stuff (via the middleware integration test part).
+
+describe Hoodoo::Services::Discovery::ByDRb do
+
+  # Shut down a DRb service expected to be running (in a thread) on
+  # the given port.
+  #
+  def shut_down_drb_service_on( port )
+    begin
+      Timeout::timeout( 10 ) do
+        loop do
+          begin
+            client = DRbObject.new_with_uri( Hoodoo::Services::Discovery::ByDRb::DRbServer.uri( port ) )
+            client.ping()
+            client.stop()
+            break
+          rescue DRb::DRbConnError
+            sleep 0.1
+          end
+        end
+      end
+    rescue Timeout::Error
+      raise "Timed out while waiting for DRb service to communicate"
+    end
+  end
+
+  # This also tests in passing specifying a port number right through
+  # the discoverer to the CLI script that starts a DRb server up.
+  #
+  # If you get timeouts from the test, it's likely that the port number
+  # hasn't reached the server startup script and the server has come up
+  # on a different port.
+  #
+  it 'runs a DRb service which can be pinged and shuts down' do
+    expect {
+      port = Hoodoo::Utilities.spare_port().to_s
+
+      discoverer = Hoodoo::Services::Discovery::ByDRb.new( :drb_port => port )
+      discoverer.announce( :Foo, 1, :host => '127.0.0.1', :port => '9292' )
+
+      shut_down_drb_service_on( port )
+    }.to_not raise_error
+  end
+
+  # Similar to the above, but this tests passing in a full URI and assuming
+  # that the service is already running.
+  #
+  it 'can contact an existing DRb server' do
+    expect {
+      port = Hoodoo::Utilities.spare_port().to_s
+
+      discoverer = Hoodoo::Services::Discovery::ByDRb.new( :drb_port => port )
+      discoverer.announce( :Foo, 1, :host => '127.0.0.1', :port => '9292' )
+
+      discoverer = Hoodoo::Services::Discovery::ByDRb.new(
+        :drb_uri => Hoodoo::Services::Discovery::ByDRb::DRbServer.uri( port )
+      )
+
+      expect( discoverer.discover( :Foo, 1 ) ).to be_a( Hoodoo::Services::Discovery::ForHTTP )
+
+      shut_down_drb_service_on( port )
+    }.to_not raise_error
+  end
+
+  it 'complains if it cannot contact an existing DRb server' do
+    port = Hoodoo::Utilities.spare_port().to_s
+    uri  = Hoodoo::Services::Discovery::ByDRb::DRbServer.uri( port )
+
+    expect {
+      discoverer = Hoodoo::Services::Discovery::ByDRb.new( :drb_uri => uri )
+      discoverer.discover( :Foo, 1 )
+    }.to raise_error(
+      RuntimeError,
+      "Hoodoo::Services::Discovery::ByDRb could not contact a DRb service registry at #{ uri }"
+    )
+  end
+end

data/spec/services/discovery/discoverers/by_drb/drb_server_spec.rb

@@ -0,0 +1,205 @@
+require 'spec_helper.rb'
+
+describe Hoodoo::Services::Discovery::ByDRb::DRbServer do
+
+  # When running tests we can't assume any particular static port is free
+  # on the test machine, so we must get a port dynamically. Since it might
+  # take a little while for a DRb server to fully shut down "behind the
+  # scenes" when we ask it to stop, its claimed port might not be free by
+  # the time the 'next test' runs, so we ask for a spare port for each
+  # test that runs.
+  #
+  before :each do
+    @drb_uri = "druby://127.0.0.1:#{ Hoodoo::Utilities.spare_port() }"
+  end
+
+  context "class instance" do
+    before do
+      @inst = described_class.new
+    end
+
+    it 'adds and reads endpoints' do
+      @inst.add( :Foo, 2, 'http://localhost:3030/v2/foo' )
+      @inst.add( :Foo, 1, 'http://127.0.0.1:3031/v1/foo' )
+      @inst.add( :Bar, 1, 'http://0.0.0.0:3032/v1/bar' )
+
+      expect( @inst.find( :Foo, 1 ) ).to eq( 'http://127.0.0.1:3031/v1/foo' )
+      expect( @inst.find( :Bar, 1 ) ).to eq( 'http://0.0.0.0:3032/v1/bar' )
+      expect( @inst.find( :Foo, 2 ) ).to eq( 'http://localhost:3030/v2/foo' )
+      expect( @inst.find( :Bar, 2 ) ).to be_nil
+    end
+
+    # RCov report coverage only; tests elsewhere call these but code runs
+    # in unusual execution contexts and doesn't get reported as covered.
+    #
+    it '#ping' do
+      expect( @inst.ping() ).to eq( true )
+    end
+  end
+
+  context "via DRb" do
+    it 'starts as a server' do
+      DRb.start_service( @drb_uri, Hoodoo::Services::Discovery::ByDRb::FRONT_OBJECT )
+      @drb_server = DRbObject.new_with_uri( @drb_uri )
+
+      expect do
+        @drb_server.add( :FooS, 2, 'http://localhost:3030/v2/foo_s' )
+      end.to_not raise_error
+
+      DRb.stop_service
+    end
+
+    it 'runs in a thread, can be pinged and shuts down' do
+      expect {
+        port = Hoodoo::Utilities.spare_port().to_s
+
+        thread = Thread.new do
+          ENV[ 'HOODOO_DISCOVERY_BY_DRB_PORT_OVERRIDE' ] = port
+          described_class.start()
+          ENV.delete( 'HOODOO_DISCOVERY_BY_DRB_PORT_OVERRIDE' )
+        end
+
+        client = nil
+
+        begin
+          Timeout::timeout( 5 ) do
+            loop do
+              begin
+                drb_service = DRbObject.new_with_uri( described_class.uri() )
+                drb_service.ping()
+                drb_service.stop()
+                break
+              rescue DRb::DRbConnError
+                sleep 0.1
+              end
+            end
+          end
+        rescue Timeout::Error
+          raise "Timed out while waiting for DRb service to communicat"
+        end
+
+        # For good measure...
+        #
+        ENV.delete( 'HOODOO_DISCOVERY_BY_DRB_PORT_OVERRIDE' )
+
+      }.to_not raise_error
+    end
+
+    it 'starts as a client' do
+      expect {
+        DRb.start_service( @drb_uri, Hoodoo::Services::Discovery::ByDRb::FRONT_OBJECT )
+        @drb_server = DRbObject.new_with_uri( @drb_uri )
+        @drb_server.add( :FooS2, 2, 'http://localhost:3030/v2/foo_s2' )
+
+        Thread.new do
+          @drb_client = DRbObject.new_with_uri( @drb_uri )
+          @drb_client.add( :FooC, 2, 'http://localhost:3030/v2/foo_c' )
+        end.join
+
+        DRb.stop_service
+
+      }.to_not raise_error
+    end
+
+    it 'synchronises data' do
+      DRb.start_service( @drb_uri, Hoodoo::Services::Discovery::ByDRb::FRONT_OBJECT )
+      @drb_server = DRbObject.new_with_uri( @drb_uri )
+
+      @drb_server.add( :Foo1, 2, 'http://localhost:3030/v2/foo_1' )
+      @drb_server.add( :Foo1, 1, 'http://127.0.0.1:3031/v1/foo_1' )
+
+      one = Thread.new do
+        @drb_client = DRbObject.new_with_uri( @drb_uri )
+        @drb_client.add( :Bar1, 1, 'http://0.0.0.0:3032/v1/bar_1' )
+
+        expect( @drb_client.find( :Foo1, 1 ) ).to eq( 'http://127.0.0.1:3031/v1/foo_1' )
+        expect( @drb_client.find( :Foo1, 2 ) ).to eq( 'http://localhost:3030/v2/foo_1' )
+        expect( @drb_client.find( :Foo1, 3 ) ).to be_nil
+
+        @drb_client.add( :Bar1, 1, 'http://0.0.0.0:3032/v1/bar_1' )
+      end.join
+
+      expect( @drb_server.find( :Bar1, 1 ) ).to eq( 'http://0.0.0.0:3032/v1/bar_1' )
+
+      DRb.stop_service
+    end
+
+    it 'flushes' do
+      DRb.start_service( @drb_uri, Hoodoo::Services::Discovery::ByDRb::FRONT_OBJECT )
+      @drb_server = DRbObject.new_with_uri( @drb_uri )
+
+      @drb_server.add( :Foo1, 2, 'http://localhost:3030/v2/foo_1' )
+      @drb_server.add( :Foo1, 1, 'http://127.0.0.1:3031/v1/foo_1' )
+
+      expect( @drb_server.find( :Foo1, 2 ) ).to_not be_nil
+      expect( @drb_server.find( :Foo1, 1 ) ).to_not be_nil
+
+      @drb_server.flush
+
+      expect( @drb_server.find( :Foo1, 2 ) ).to be_nil
+      expect( @drb_server.find( :Foo1, 1 ) ).to be_nil
+
+      DRb.stop_service
+    end
+  end
+
+  # A lot of this is copied from service_middleware_multi_spec.rb and
+  # it'd be cleaner if all these tests were in that one file, but it
+  # is nice to keep the tests specifically aimed at DRb here (even if
+  # a whole bunch of other stuff gets caught in the integration test).
+
+  @time_now = Time.now.to_s
+
+  class RSpecTestTimeImplementation < Hoodoo::Services::Implementation
+    def list( context )
+      context.response.set_resources( [ { 'time' => @time_now } ] )
+    end
+  end
+
+  class RSpecTestTimeInterface < Hoodoo::Services::Interface
+    interface( :RSpecDRbTestTime ) { endpoint :rspec_drb_test_time, RSpecTestTimeImplementation }
+  end
+
+  class RSpecTestTime < Hoodoo::Services::Service
+    comprised_of RSpecTestTimeInterface
+  end
+
+  class RSpecTestClockImplementation < Hoodoo::Services::Implementation
+    def list( context )
+      context.response.set_resources( context.resource( :RSpecDRbTestTime ).list() + [ { 'clock' => 'responded' } ] )
+    end
+  end
+
+  class RSpecTestClockInterface < Hoodoo::Services::Interface
+    interface( :RSpecDRbTestClock ) { endpoint :rspec_drb_test_clock, RSpecTestClockImplementation }
+  end
+
+  class RSpecTestClock < Hoodoo::Services::Service
+    comprised_of RSpecTestClockInterface
+  end
+
+  context 'via middleware' do
+
+    before :all do
+      @port1 = spec_helper_start_svc_app_in_thread_for( RSpecTestClock )
+      @port2 = spec_helper_start_svc_app_in_thread_for( RSpecTestTime  )
+    end
+
+    # This is a significant integration test; two real Webrick instances
+    # each with its own service on a free HTTP port; one talks to the other
+    # over local machine HTTP via the DRb service for discovery.
+    #
+    it 'properly supports service discovery' do
+      response = spec_helper_http( path: '/v1/rspec_drb_test_clock', port: @port1 )
+      expect( response.code ).to eq( '200' )
+
+      parsed = JSON.parse( response.body )
+      expect( parsed ).to eq( {
+        '_data' => [
+          { 'time'  => @time_now   },
+          { 'clock' => 'responded' }
+        ]
+      } )
+    end
+  end
+end