right_support 2.10.1 → 2.11.2

data/spec/rack/request_logger_spec.rb

@@ -8,14 +8,77 @@ describe RightSupport::Rack::RequestLogger do
     @app.should_receive(:call).and_return([200, {}, 'body']).by_default
     @logger = mock_logger
     @env = {'rack.logger' => @logger}
-    @middleware = RightSupport::Rack::RequestLogger.new(@app)
+    @options = {}
   end
 
+  subject { described_class.new(@app, @options) }
+
   context :initialize do
     context 'without :logger option' do
       it 'uses rack.logger' do
         @logger.should_receive(:info).at_least.once
-        @middleware.call(@env).should == [200, {}, 'body']
+        subject.call(@env).should == [200, {}, 'body']
+      end
+    end
+
+    context 'with :logger option' do
+      it 'uses given logger' do
+        @env = {'rack.logger' => flexmock('overridden')}
+        @options[:logger] = @logger
+        @logger.should_receive(:info).at_least.once
+        subject.call(@env).should == [200, {}, 'body']
+      end
+    end
+
+    context 'with :normalize_40x option' do
+      it 'omits some 40x details and disables global session Set-Cookie fields' do
+        @options[:normalize_40x] = true
+        @app = flexmock('Rack app')
+        body = 'insecure information'
+        headers = { 'TooMuch' => 'info', 'Content-Type' => 'text/plain', 'Content-Length' => body.bytesize.to_s }
+        iterative = [nil, headers, body]
+        @app.should_receive(:call).and_return(iterative)
+
+        # note that sending 'X-Debug' header should have no effect on a
+        # normalized 40x response
+        @env.merge!(described_class::DEBUG_MODE_HTTP_HEADER => 'true')
+        (400..499).each do |code|
+          iterative[0] = code
+          if described_class::NORMALIZE_40X.include?(code)
+            env = @env.dup
+            subject.call(env).should == [code, { 'Content-Length' => '0'}, []]
+            env.should == @env.merge(
+              'global_session.req.renew' => false,
+              'global_session.req.update' => false,
+              described_class::DEBUG_MODE_ENV_KEY => false)
+          else
+            subject.call(@env).should == iterative
+          end
+        end
+      end
+    end
+
+    context 'with :normalize_40x_set_cookie option' do
+      it 'disables global session Set-Cookie fields' do
+        @options[:normalize_40x_set_cookie] = true
+        @app = flexmock('Rack app')
+        body = 'whatever'
+        headers = { 'Content-Type' => 'text/plain', 'Content-Length' => body.bytesize.to_s }
+        iterative = [nil, headers, body]
+        @app.should_receive(:call).and_return(iterative)
+
+        (400..499).each do |code|
+          iterative[0] = code
+          if described_class::NORMALIZE_40X.include?(code)
+            env = @env.dup
+            subject.call(env).should == iterative
+            env.should == @env.merge(
+              'global_session.req.renew' => false,
+              'global_session.req.update' => false)
+          else
+            subject.call(@env).should == iterative
+          end
+        end
       end
     end
   end
@@ -29,7 +92,7 @@ describe RightSupport::Rack::RequestLogger do
       it 'logs the exception' do
         @logger.should_receive(:error).at_least.once
         lambda {
-          @middleware.call(@env)
+          subject.call(@env)
         }.should raise_error
       end
     end
@@ -43,14 +106,14 @@ describe RightSupport::Rack::RequestLogger do
       it 'logs the exception' do
         @logger.should_receive(:info)
         @logger.should_receive(:error).at_least.once
-        @middleware.call(@env)
+        subject.call(@env)
       end
 
       it 'skips logging the exception when already handled' do
         @logger.should_receive(:info)
         @logger.should_receive(:error).never
         @env['sinatra.error.handled'] = true
-        @middleware.call(@env)
+        subject.call(@env)
       end
     end
 
@@ -58,37 +121,37 @@ describe RightSupport::Rack::RequestLogger do
       before(:each) do
         @options = {:except => [/bar/]}
         @env.merge!('PATH_INFO' => '/foo/bar')
-        @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+        subject = described_class.new(@app, @options)
         @logger.should_receive(:level).and_return(Logger::INFO).by_default
       end
 
       it 'limits if logger in debug mode' do
         @logger.should_receive(:level).and_return(Logger::DEBUG)
         @logger.should_receive(:info).never
-        @middleware.call(@env)
+        subject.call(@env)
       end
 
       it 'does not limit if HTTP_X_DEBUG set' do
         @logger.should_receive(:info).at_least.once
-        @middleware.call(@env.merge('HTTP_X_DEBUG' => true))
+        subject.call(@env.merge('HTTP_X_DEBUG' => true))
       end
 
       it 'does not log for paths matching :except option' do
         @logger.should_receive(:info).never
-        @middleware.call(@env)
+        subject.call(@env)
       end
 
       it 'does log for paths matching :only option' do
         @options = {:only => [/bar/]}
-        @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+        subject = described_class.new(@app, @options)
         @logger.should_receive(:info)
-        @middleware.call(@env)
+        subject.call(@env)
       end
 
       it 'sets rack.logging.enabled in Rack environment' do
         @logger.should_receive(:info).at_least.once
         @env.merge!('PATH_INFO' => '/my/app')
-        @middleware.call(@env)
+        subject.call(@env)
         @env['rack.logging.enabled'].should be_true
       end
     end
@@ -97,29 +160,29 @@ describe RightSupport::Rack::RequestLogger do
       before(:each) do
         @options = {}
         @env.merge!('PATH_INFO' => '/my/app', 'QUERY_STRING' => 'foo=bar')
-        @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+        subject = described_class.new(@app, @options)
       end
 
       it 'does not log the query string by default' do
         @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /\/my\/app\?\.{3}/ } )
-        @middleware.send(:log_request_begin, @logger, @env)
+        subject.send(:log_request_begin, @logger, @env)
       end
 
       context 'when the include_query_string option is true' do
         it 'logs the query string' do
           @options[:include_query_string] = true
-          @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+          subject = described_class.new(@app, @options)
           @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /\/my\/app\?foo%3Dbar/ } )
-          @middleware.send(:log_request_begin, @logger, @env)
+          subject.send(:log_request_begin, @logger, @env)
         end
       end
 
       context 'when the include_query_string option is false' do
         it 'does not log the query string' do
           @options[:include_query_string] = false
-          @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+          subject = described_class.new(@app, @options)
           @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /\/my\/app\?\.{3}/ } )
-          @middleware.send(:log_request_begin, @logger, @env)
+          subject.send(:log_request_begin, @logger, @env)
         end
       end
     end
@@ -131,13 +194,13 @@ describe RightSupport::Rack::RequestLogger do
 
       it 'logs X-Shard header if it is present' do
         @env['HTTP_X_SHARD'] = '9'
-        @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /Shard: 9;/ } )
-        @middleware.send(:log_request_begin, @logger, @env)
+        @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /Shard: 9$/ } )
+        subject.send(:log_request_begin, @logger, @env)
       end
 
       it 'logs "default" if X-Shard header is absent' do
-        @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /Shard: default;/ } )
-        @middleware.send(:log_request_begin, @logger, @env)
+        @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /Shard: default$/ } )
+        subject.send(:log_request_begin, @logger, @env)
       end
     end
 
@@ -147,15 +210,16 @@ describe RightSupport::Rack::RequestLogger do
         @env['rack.request_uuid'] = 'some-uuid'
       end
 
-      it 'tags the Processing line' do
-        @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /Request ID: some-uuid/ } )
-        @middleware.send(:log_request_begin, @logger, @env)
+      it 'tags the Started line' do
+        @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /^\[some\-uuid\] Started / } )
+        subject.send(:log_request_begin, @logger, @env)
       end
 
       it 'tags the Completed line' do
-        @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /Request ID: some-uuid/ } )
-        @middleware.send(:log_request_end, @logger, @env, 200, {}, '', Time.now)
+        @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /^\[some\-uuid\] Completed / } )
+        subject.send(:log_request_end, @logger, @env, 200, {}, '', Time.now)
       end
     end
+
   end
 end

data/spec/rack/request_tracker_spec.rb

@@ -1,5 +1,115 @@
 require 'spec_helper'
 
 describe RightSupport::Rack::RequestTracker do
-  it 'has test coverage'
+
+  let(:app) { flexmock('next middleware or rack app') }
+
+  let(:generator)              { described_class::Generator }
+  let(:generated_request_uuid) { 'generated-uuid' }
+  let(:request_uuid)           { 'given-uuid' }
+
+  subject { described_class.new(app) }
+
+  context :call do
+    context 'when ID is missing from request headers' do
+      it 'generates a new request ID and responds as UUID for legacy reasons' do
+        flexmock(generator).
+          should_receive(:generate).
+          and_return(generated_request_uuid).
+          once
+        original_env = {}
+        expected_env = original_env.merge(described_class::REQUEST_UUID_ENV_NAME => generated_request_uuid)
+        app.should_receive(:call).with(expected_env).and_return([200, {}, 'body']).once
+
+        actual = subject.call(original_env)
+
+        expected_headers = { described_class::REQUEST_UUID_HEADER => generated_request_uuid }
+        actual[1].should == expected_headers
+      end
+    end
+
+    context 'when ID sent with request' do
+      it 'passes incoming request ID and responds as ID' do
+        flexmock(generator).should_receive(:generate).never
+        original_env = { described_class::HTTP_REQUEST_ID_HEADER => request_uuid }
+        expected_env = original_env.merge(described_class::REQUEST_UUID_ENV_NAME => request_uuid)
+        app.should_receive(:call).with(expected_env).and_return([200, {}, 'body']).once
+
+        actual = subject.call(original_env)
+
+        expected_headers = { described_class::REQUEST_ID_HEADER => request_uuid }
+        actual[1].should == expected_headers
+      end
+    end
+
+    context 'when UUID sent with request' do
+      it 'passes incoming request UUID and responds as UUID' do
+        flexmock(generator).should_receive(:generate).never
+        original_env = { described_class::HTTP_REQUEST_UUID_HEADER => request_uuid }
+        expected_env = original_env.merge(described_class::REQUEST_UUID_ENV_NAME => request_uuid)
+        app.should_receive(:call).with(expected_env).and_return([200, {}, 'body']).once
+
+        actual = subject.call(original_env)
+
+        expected_headers = { described_class::REQUEST_UUID_HEADER => request_uuid }
+        actual[1].should == expected_headers
+      end
+    end
+
+    context 'when lineage sent with request' do
+      it 'passes all UUIDs in header under length limit' do
+        uuids = []
+        3.times do
+          uuids << ::RightSupport::Data::UUID.generate
+        end
+        lineage_uuid = uuids.join(described_class::UUID_SEPARATOR)
+        flexmock(generator).should_receive(:generate).never
+        original_env = { described_class::REQUEST_LINEAGE_UUID_HEADER => lineage_uuid }
+        expected_env = original_env.merge(described_class::REQUEST_UUID_ENV_NAME => lineage_uuid)
+        app.should_receive(:call).with(expected_env).and_return([200, {}, 'body']).once
+
+        actual = subject.call(original_env)
+
+        expected_headers = { described_class::REQUEST_UUID_HEADER => lineage_uuid }
+        actual[1].should == expected_headers
+      end
+    end
+
+    context 'when sent ID exceeds length limit' do
+      it 'passes truncated request ID' do
+        flexmock(generator).should_receive(:generate).never
+        too_long_id = 'x' * 1024
+        truncated_id = 'x' * described_class::MAX_REQUEST_UUID_LENGTH
+        original_env = { described_class::HTTP_REQUEST_ID_HEADER => too_long_id }
+        expected_env = original_env.merge(described_class::REQUEST_UUID_ENV_NAME => truncated_id)
+        app.should_receive(:call).with(expected_env).and_return([200, {}, 'body']).once
+
+        actual = subject.call(original_env)
+
+        expected_headers = { described_class::REQUEST_ID_HEADER => truncated_id }
+        actual[1].should == expected_headers
+      end
+    end
+
+  end
+
+  context :copy_request_uuid do
+    it 'does nothing when request UUID is missing' do
+      described_class.copy_request_uuid(nil, nil).should be_empty
+    end
+
+    it 'copies request UUID to target hash when present' do
+      env = {
+        described_class::REQUEST_UUID_ENV_NAME => request_uuid,
+        'other' => 'stuff'
+      }
+      other_headers = { 'Foo' => 'bar' }
+      expected = {
+        described_class::REQUEST_ID_HEADER => request_uuid
+      }.merge(other_headers)
+      actual = described_class.copy_request_uuid(env, other_headers)
+      actual.should == expected
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_support
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 2.11.2
 platform: ruby
 authors:
 - Tony Spataro
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -132,6 +132,7 @@ files:
 - lib/right_support/data/hash_tools.rb
 - lib/right_support/data/mash.rb
 - lib/right_support/data/serializer.rb
+- lib/right_support/data/token.rb
 - lib/right_support/data/unknown_type.rb
 - lib/right_support/data/uuid.rb
 - lib/right_support/db.rb
@@ -152,6 +153,7 @@ files:
 - lib/right_support/net/dns.rb
 - lib/right_support/net/http_client.rb
 - lib/right_support/net/lb.rb
+- lib/right_support/net/lb/base.rb
 - lib/right_support/net/lb/health_check.rb
 - lib/right_support/net/lb/round_robin.rb
 - lib/right_support/net/lb/sticky.rb
@@ -182,6 +184,7 @@ files:
 - spec/crypto/signed_hash_spec.rb
 - spec/data/hash_tools_spec.rb
 - spec/data/mash_spec.rb
+- spec/data/token_spec.rb
 - spec/data/uuid_spec.rb
 - spec/db/cassandra_model_part1_spec.rb
 - spec/db/cassandra_model_part2_spec.rb
@@ -200,11 +203,11 @@ files:
 - spec/log/step_level_logger_spec.rb
 - spec/log/system_logger_spec.rb
 - spec/net/address_helper_spec.rb
-- spec/net/balancing/health_check_spec.rb
-- spec/net/balancing/round_robin_spec.rb
-- spec/net/balancing/sticky_policy_spec.rb
 - spec/net/dns_spec.rb
 - spec/net/http_client_spec.rb
+- spec/net/lb/health_check_spec.rb
+- spec/net/lb/round_robin_spec.rb
+- spec/net/lb/sticky_spec.rb
 - spec/net/request_balancer_spec.rb
 - spec/net/s3_helper_spec.rb
 - spec/net/ssl_spec.rb