hoodoo 1.11.0 → 1.12.0

data/spec/active/active_record/support_spec.rb

@@ -1,6 +1,28 @@
 require 'spec_helper.rb'
 
 describe Hoodoo::ActiveRecord::Support do
+  context '#framework_search_and_filter_data' do
+    it 'returns the expected number of keys' do
+      hash = described_class.framework_search_and_filter_data()
+      expect( hash.keys.count ).to eq( Hoodoo::Services::Middleware::FRAMEWORK_QUERY_DATA.keys.count )
+    end
+
+    it 'complains if there is a mismatch' do
+      middleware = Hoodoo::Services::Middleware
+      old_value  = middleware.const_get( 'FRAMEWORK_QUERY_DATA' )
+
+      middleware.send( :remove_const, 'FRAMEWORK_QUERY_DATA' )
+      middleware.const_set( 'FRAMEWORK_QUERY_DATA', old_value.merge( { Hoodoo::UUID.generate() => 1 } ) )
+
+      expect {
+        described_class.framework_search_and_filter_data()
+      }.to raise_error( RuntimeError, 'Hoodoo::ActiveRecord::Support#framework_search_and_filter_data: Mismatch between internal mapping and Hoodoo::Services::Middleware::FRAMEWORK_QUERY_DATA' )
+
+      middleware.send( :remove_const, 'FRAMEWORK_QUERY_DATA' )
+      middleware.const_set( 'FRAMEWORK_QUERY_DATA', old_value )
+    end
+  end
+
   context '#self.process_to_map' do
     it 'processes as expected' do
       proc1 = Proc.new { puts "hello" }

data/spec/client/paginated_enumeration_spec.rb

@@ -1,37 +1,34 @@
 require 'securerandom'
 require 'spec_helper.rb'
 
-#
 # These tests define the following Services.
 #
 # Clients can call into any of them to invoke the different calling semantics
 # between them.
 #
-#
-# ┌──────────────────────────────────────────────┐ ┌──────────────────────────┐
-# │                                              │ │                          │
-# │               RSpecNumberService             │ │ RSpecRemoteNumberService │
-# │                                              │ │                          │
-# │                                              │ │                          │
-# │ ┌──────────────┐           ┌────────────────┐│ │  ┌───────────────────┐   │
-# │ │              │  inter    │                ││ │  │                   │   │
-# │ │ RSpecNumber  │◀resource ─│RSpecEvenNumber ││ │  │  RSpecOddNumber   │   │
-# │ │              │  local    │                ││ │  │                   │   │
-# │ └──────────────┘           └────────────────┘│ │  └───────────────────┘   │
-# │         ▲                                    │ │            │             │
-# │         │                            inter   │ │            │             │
-# │         └───────────────────────────resource ┼─┼────────────┘             │
-# │                                      remote  │ │                          │
-# └──────────────────────────────────────────────┘ └──────────────────────────┘
+# +----------------------------------------------+ +--------------------------+
+# |                                              | |                          |
+# |               RSpecNumberService             | | RSpecRemoteNumberService |
+# |                                              | |                          |
+# |                                              | |                          |
+# | +--------------+          +----------------+ | |  +-------------------+   |
+# | |              |  inter   |                | | |  |                   |   |
+# | | RSpecNumber  |<resource-|RSpecEvenNumber | | |  |  RSpecOddNumber   |   |
+# | |              |  local   |                | | |  |                   |   |
+# | +--------------+          +----------------+ | |  +-------------------+   |
+# |         ^                                    | |            |             |
+# |         |                          inter     | |            |             |
+# |         +------------------------ resource --+-+------------+             |
+# |                                    remote    | |                          |
+# +----------------------------------------------+ +--------------------------+
 #
 # To start the services in your specs do:
 #
 #     spec_helper_start_svc_app_in_thread_for( RSpecNumberService )
-#     spec_helper_start_svc_app_in_thread_for( RSpecRemoteNumberService)
-#
+#     spec_helper_start_svc_app_in_thread_for( RSpecRemoteNumberService )
+
+###############################################################################
 
-################################################################################
-#
 # Create a 'RSpecNumber' Resource with the following properties:
 #
 # - manages 'Number' resources ie: { 'number': 3 }, for numbers between 0 & 999
@@ -51,11 +48,11 @@ class RSpecNumberImplementation < Hoodoo::Services::Implementation
   ERROR_RANGE  = 500..999
 
   def list( context )
-    request  = context.request
-
+    request   = context.request
     resources = []
-    implode = false
-    0.upto( request.list.limit - 1 ) do |i|
+    implode   = false
+
+    0.upto( request.list.limit - 1 ) do | i |
       num = request.list.offset + i
       implode = implode || ERROR_RANGE.include?( num )
       if NUMBER_RANGE.include?( num )
@@ -66,19 +63,18 @@ class RSpecNumberImplementation < Hoodoo::Services::Implementation
     end
 
     context.response.set_resources( resources, resources.count )
+
     if implode && request.list.filter_data[ 'force_error' ]
       context.response.add_error( 'platform.malformed' )
     end
   end
-
 end
 
-#
 # Interface for our implementation
 #
 class RSpecNumberInterface < Hoodoo::Services::Interface
   interface :RSpecNumber do
-    endpoint       :numbers, RSpecNumberImplementation
+    endpoint :numbers, RSpecNumberImplementation
     to_list do
       filter :force_error
     end
@@ -86,9 +82,8 @@ class RSpecNumberInterface < Hoodoo::Services::Interface
   end
 end
 
+###############################################################################
 
-################################################################################
-#
 # Create a 'RSpecEvenNumber' Resource with the following properties:
 #
 # - Calls RSpecNumber via the 'inter_resource_local' calling mechanism
@@ -129,7 +124,6 @@ class RSpecEvenNumberImplementation < Hoodoo::Services::Implementation
 
 end
 
-#
 # Interface for our implementation
 #
 class RSpecEvenNumberInterface < Hoodoo::Services::Interface
@@ -142,8 +136,8 @@ class RSpecEvenNumberInterface < Hoodoo::Services::Interface
   end
 end
 
-################################################################################
-#
+###############################################################################
+
 # Define our service, that implements both resources
 #
 class RSpecNumberService < Hoodoo::Services::Service
@@ -151,9 +145,8 @@ class RSpecNumberService < Hoodoo::Services::Service
                RSpecEvenNumberInterface
 end
 
+###############################################################################
 
-################################################################################
-#
 # Create a 'RSpecOddNumber' Resource with the following properties:
 #
 # - Calls RSpecNumber via the 'inter_resource_remote' calling mechanism
@@ -194,7 +187,6 @@ class RSpecOddNumberImplementation < Hoodoo::Services::Implementation
 
 end
 
-#
 # Interface for our implementation
 #
 class RSpecOddNumberInterface < Hoodoo::Services::Interface
@@ -207,19 +199,17 @@ class RSpecOddNumberInterface < Hoodoo::Services::Interface
   end
 end
 
-################################################################################
-#
+###############################################################################
+
 # Define our service, that implements both resources
 #
 class RSpecRemoteNumberService < Hoodoo::Services::Service
   comprised_of RSpecOddNumberInterface
 end
 
-
-
-##############################################################################
+###############################################################################
 # Tests
-##############################################################################
+###############################################################################
 
 describe Hoodoo::Client do
 
@@ -273,6 +263,15 @@ describe Hoodoo::Client do
 
     end
 
+    it 'detects internal inconsistencies' do
+      items = resources.first[ :endpoint ].list()
+      items.platform_errors.add_error( 'platform.timeout' )
+
+      expect {
+        items.enumerate_all { | item | }
+      }.to raise_error( RuntimeError, 'Hoodoo::Client::PaginatedEnumeration#enumerate_all: Unexpected internal state combination of results set and results error indication' )
+    end
+
     context 'different "limit" sizes' do
 
       let(:limits) {

data/spec/monkey/patch/newrelic_middleware_analytics_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper.rb'
+
+# This is little more than a coverage exercise.
+
+describe Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics do
+
+  class RSpecTestNRMAImplementation < Hoodoo::Services::Implementation
+    def list( context ); end
+  end
+
+  class RSpecTestNRMAInterface < Hoodoo::Services::Interface
+    interface :RSpecTestNRMA do
+      endpoint :rspec_test_nrma, RSpecTestNRMAImplementation
+    end
+  end
+
+  class RSpecTestNRMAService < Hoodoo::Services::Service
+    comprised_of RSpecTestNRMAInterface
+  end
+
+  def app
+    Rack::Builder.new do
+      use Hoodoo::Services::Middleware
+      run RSpecTestNRMAService.new
+    end
+  end
+
+  before :all do
+    $endpoint_monkey_log_inbound_request_count = 0
+
+    module NewRelic
+      module Agent
+        extend self
+        def add_custom_attributes( params )
+          $endpoint_monkey_log_inbound_request_count += 1
+        end
+      end
+    end
+
+    Hoodoo::Monkey.enable( extension_module: Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics )
+  end
+
+  after :all do
+    Hoodoo::Monkey.disable( extension_module: Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics )
+    Object.send( :remove_const, :NewRelic )
+  end
+
+  before :each do
+    expect( Hoodoo::Services::Middleware.ancestors ).to include( Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics::InstanceExtensions )
+  end
+
+  it 'calls the NewRelic patch' do
+    get '/v1/rspec_test_nrma', nil, { 'CONTENT_TYPE' => 'application/json; charset=utf-8' }
+    expect( last_response.status ).to eq( 200 )
+
+    # We expect two log calls; secure inbound and normal inbound.
+    #
+    expect( $endpoint_monkey_log_inbound_request_count ).to eq( 2 )
+  end
+end

data/spec/monkey/patch/newrelic_traced_amqp_spec.rb

@@ -19,7 +19,7 @@ describe Hoodoo::Monkey::Patch::NewRelicTracedAMQP, :order => :defined do
     @@newrelic_agent_disable_count = 0
 
     module NewRelic
-      class Agent
+      module Agent
         class CrossAppTracing
         end
       end
@@ -127,7 +127,7 @@ describe Hoodoo::Monkey::Patch::NewRelicTracedAMQP::AMQPNewRelicResponseWrapper
 
   before :all do
     module NewRelic
-      class Agent
+      module Agent
         class CrossAppTracing
           NR_APPDATA_HEADER = 'X_Foo_AppData'
         end

data/spec/new_relic/agent/method_tracer.rb

@@ -0,0 +1,35 @@
+########################################################################
+# File::    method_tracer.rb
+# (C)::     Loyalty New Zealand 2016
+#
+# Purpose:: Override NewRelic 'new_relic/agent/method_tracer'. See the
+#           top level 'spec/newrelic_rpm.rb' file for details.
+# ----------------------------------------------------------------------
+#           02-Dec-2016 (ADH): Created.
+########################################################################
+
+# Note that all of this will be defined when the test suite is starting up, but
+# during test runs, local redefinitions of NewRelic and *undefinitions* of that
+# constant will occur. The code only exists so that other "require"s will work
+# and thus provide coverage, mainly inside "newrelic_middleware_analytics.rb".
+#
+module NewRelic
+  module Agent
+    module MethodTracer
+
+      def self.included( klass )
+        klass.extend( ClassMethods )
+      end
+
+      module ClassMethods
+        module AddMethodTracer
+          def add_method_tracer( method_name, metric_name_code = nil, options = {} )
+          end
+        end
+
+        include AddMethodTracer
+      end
+
+    end
+  end
+end

data/spec/services/middleware/middleware_spec.rb

@@ -33,6 +33,8 @@ class RSpecTestServiceStubInterface < Hoodoo::Services::Interface
       sort :conventional => [:asc, :desc]
       search :foo, :bar
       filter :baz, :boo
+      do_not_search :created_before
+      do_not_filter :created_after
     end
     to_create do
       text :foo, :required => true
@@ -851,6 +853,42 @@ describe Hoodoo::Services::Middleware do
         expect(result['errors'][0]['reference']).to eq('search: thing\\, thang')
       end
 
+      it 'should respond to permitted framework search query parameter' do
+        dt     = DateTime.parse( Time.now.round.iso8601 )
+        str    = dt.iso8601
+        encstr = CGI.escape( CGI.escape( str ) ) # Remember, search values within the subquery string must be double escaped
+
+        expect_any_instance_of(RSpecTestServiceStubImplementation).to receive(:list).once do | ignored_rspec_mock_instance, context |
+          expect(context.request.list.search_data).to eq({'created_after' => dt})
+        end
+
+        get "/v2/rspec_test_service_stub?search=created_after%3D#{ encstr }", nil, { 'CONTENT_TYPE' => 'application/json; charset=utf-8' }
+        expect(last_response.status).to eq(200)
+      end
+
+      it 'should reject malformed value in permitted framework search query parameter' do
+        expect_any_instance_of(RSpecTestServiceStubImplementation).to_not receive(:list)
+        get "/v2/rspec_test_service_stub?search=created_after%3Dthing", nil, { 'CONTENT_TYPE' => 'application/json; charset=utf-8' }
+        expect(last_response.status).to eq(422)
+        result = JSON.parse(last_response.body)
+        expect(result['errors'][0]['code']).to eq('platform.malformed')
+        expect(result['errors'][0]['message']).to eq('One or more malformed or invalid query string parameters')
+        expect(result['errors'][0]['reference']).to eq('search: created_after')
+      end
+
+      it 'should reject prohibited framework search query parameter' do
+        str    = Time.now.iso8601
+        encstr = CGI.escape( CGI.escape( str ) ) # Remember, search values within the subquery string must be double escaped
+
+        expect_any_instance_of(RSpecTestServiceStubImplementation).to_not receive(:list)
+        get "/v2/rspec_test_service_stub?search=created_before%3D#{ encstr }", nil, { 'CONTENT_TYPE' => 'application/json; charset=utf-8' }
+        expect(last_response.status).to eq(422)
+        result = JSON.parse(last_response.body)
+        expect(result['errors'][0]['code']).to eq('platform.malformed')
+        expect(result['errors'][0]['message']).to eq('One or more malformed or invalid query string parameters')
+        expect(result['errors'][0]['reference']).to eq('search: created_before')
+      end
+
       it 'should respond to filter query parameter (form 1)' do
         expect_any_instance_of(RSpecTestServiceStubImplementation).to receive(:list).once do | ignored_rspec_mock_instance, context |
           expect(context.request.list.filter_data).to eq({'baz' => 'more', 'boo' => 'val'})
@@ -908,6 +946,42 @@ describe Hoodoo::Services::Middleware do
         expect(result['errors'][0]['reference']).to eq('filter: thung\\, theng')
       end
 
+      it 'should respond to permitted framework filter query parameter' do
+        dt     = DateTime.parse( Time.now.round.iso8601 )
+        str    = dt.iso8601
+        encstr = CGI.escape( CGI.escape( str ) ) # Remember, search values within the subquery string must be double escaped
+
+        expect_any_instance_of(RSpecTestServiceStubImplementation).to receive(:list).once do | ignored_rspec_mock_instance, context |
+          expect(context.request.list.filter_data).to eq({'created_before' => dt})
+        end
+
+        get "/v2/rspec_test_service_stub?filter=created_before%3D#{ encstr }", nil, { 'CONTENT_TYPE' => 'application/json; charset=utf-8' }
+        expect(last_response.status).to eq(200)
+      end
+
+      it 'should reject malformed value in permitted framework filter query parameter' do
+        expect_any_instance_of(RSpecTestServiceStubImplementation).to_not receive(:list)
+        get "/v2/rspec_test_service_stub?filter=created_before%3Dthing", nil, { 'CONTENT_TYPE' => 'application/json; charset=utf-8' }
+        expect(last_response.status).to eq(422)
+        result = JSON.parse(last_response.body)
+        expect(result['errors'][0]['code']).to eq('platform.malformed')
+        expect(result['errors'][0]['message']).to eq('One or more malformed or invalid query string parameters')
+        expect(result['errors'][0]['reference']).to eq('filter: created_before')
+      end
+
+      it 'should reject prohibited framework filter query parameter' do
+        str    = Time.now.iso8601
+        encstr = CGI.escape( CGI.escape( str ) ) # Remember, search values within the subquery string must be double escaped
+
+        expect_any_instance_of(RSpecTestServiceStubImplementation).to_not receive(:list)
+        get "/v2/rspec_test_service_stub?filter=created_after%3D#{ encstr }", nil, { 'CONTENT_TYPE' => 'application/json; charset=utf-8' }
+        expect(last_response.status).to eq(422)
+        result = JSON.parse(last_response.body)
+        expect(result['errors'][0]['code']).to eq('platform.malformed')
+        expect(result['errors'][0]['message']).to eq('One or more malformed or invalid query string parameters')
+        expect(result['errors'][0]['reference']).to eq('filter: created_after')
+      end
+
       it 'should respond to embed query parameter' do
         expect_any_instance_of(RSpecTestServiceStubImplementation).to receive(:list).once do | ignored_rspec_mock_instance, context |
           expect(context.request.embeds).to eq(['embs', 'emb'])

data/spec/services/services/interface_spec.rb

@@ -18,6 +18,8 @@ class RSpecTestInterfaceInterfaceA < Hoodoo::Services::Interface
       sort   :sort_one => [ :left, :right ], default( :sort_two ) => [ :up, :down ]
       search :search_one, :search_two, :search_three
       filter :filter_one, :filter_two, :filter_three
+      do_not_search :created_after, :created_before
+      do_not_filter :created_after
     end
 
     to_create do
@@ -74,6 +76,8 @@ describe Hoodoo::Services::Interface do
       expect(RSpecTestInterfaceInterfaceDefault.to_list.default_sort_direction).to eq('desc')
       expect(RSpecTestInterfaceInterfaceDefault.to_list.search).to be_empty
       expect(RSpecTestInterfaceInterfaceDefault.to_list.filter).to be_empty
+      expect(RSpecTestInterfaceInterfaceDefault.to_list.do_not_search).to be_empty
+      expect(RSpecTestInterfaceInterfaceDefault.to_list.do_not_filter).to be_empty
       expect(RSpecTestInterfaceInterfaceDefault.to_create).to be_nil
       expect(RSpecTestInterfaceInterfaceDefault.to_update).to be_nil
     end
@@ -94,6 +98,8 @@ describe Hoodoo::Services::Interface do
       expect(RSpecTestInterfaceInterfaceA.to_list.default_sort_direction).to eq('up')
       expect(RSpecTestInterfaceInterfaceA.to_list.search).to eq(['search_one', 'search_two', 'search_three'])
       expect(RSpecTestInterfaceInterfaceA.to_list.filter).to eq(['filter_one', 'filter_two', 'filter_three'])
+      expect(RSpecTestInterfaceInterfaceA.to_list.do_not_search).to eq(['created_after', 'created_before'])
+      expect(RSpecTestInterfaceInterfaceA.to_list.do_not_filter).to eq(['created_after'])
       expect(RSpecTestInterfaceInterfaceA.to_create).to_not be_nil
       expect(RSpecTestInterfaceInterfaceA.to_create.get_schema().properties['foo']).to be_a(Hoodoo::Presenters::Text)
       expect(RSpecTestInterfaceInterfaceA.to_create.get_schema().properties['bar']).to be_a(Hoodoo::Presenters::Enum)
@@ -258,5 +264,25 @@ describe Hoodoo::Services::Interface do
         }.to raise_error(RuntimeError, "Hoodoo::Services::Interface::ToListDSL\#default requires a String or Symbol - got 'Fixnum'")
       end
     end
+
+    context 'in #do_not_search' do
+      it 'should complain about unknown keys' do
+        expect {
+          Hoodoo::Services::Interface::ToListDSL.new( Hoodoo::Services::Interface::ToList.new ) do
+            do_not_search 'foo', 'bar'
+          end
+        }.to raise_error(RuntimeError, "Hoodoo::Services::Interface::ToListDSL\#do_not_search was given one or more unknown keys: foo, bar")
+      end
+    end
+
+    context 'in #do_not_filter' do
+      it 'should complain about unknown keys' do
+        expect {
+          Hoodoo::Services::Interface::ToListDSL.new( Hoodoo::Services::Interface::ToList.new ) do
+            do_not_filter 'baz', 'boo'
+          end
+        }.to raise_error(RuntimeError, "Hoodoo::Services::Interface::ToListDSL\#do_not_filter was given one or more unknown keys: baz, boo")
+      end
+    end
   end
 end