Improve testing of protocol and stub responses

Matt Muller · Matt Muller · commit 25fd392a262a · 2025-04-09T11:41:15.000-04:00
diff --git a/gems/smithy-client/lib/smithy-client/plugins/protocol.rb b/gems/smithy-client/lib/smithy-client/plugins/protocol.rb
@@ -12,9 +12,25 @@ class Protocol < Plugin
           docstring: 'The protocol to use for request serialization and response deserialization.'
         )
 
-        def add_handlers(handlers, config)
-          return unless config.protocol
+        # @api private
+        class BuildHandler < Handler
+          def call(context)
+            context.config.protocol.build_request(context)
+            @handler.call(context)
+          end
+        end
+
+        # @api private
+        class ParseHandler < Handler
+          def call(context)
+            output = @handler.call(context)
+            output.error = context.config.protocol.parse_error(context) unless output.error
+            output.data = context.config.protocol.parse_data(context) unless output.error
+            output
+          end
+        end
 
+        def add_handlers(handlers, config)
           handlers.add(BuildHandler)
           handlers.add(ParseHandler, step: :parse)
         end
@@ -45,24 +61,6 @@ def resolve_default_protocol(client_class, options)
           end
         end
       end
-
-      # @api private
-      class BuildHandler < Handler
-        def call(context)
-          context.config.protocol.build_request(context)
-          @handler.call(context)
-        end
-      end
-
-      # @api private
-      class ParseHandler < Handler
-        def call(context)
-          output = @handler.call(context)
-          output.error = context.config.protocol.parse_error(context) unless output.error
-          output.data = context.config.protocol.parse_data(context) unless output.error
-          output
-        end
-      end
     end
   end
 end
diff --git a/gems/smithy-client/lib/smithy-client/rpc_v2_cbor/request_builder.rb b/gems/smithy-client/lib/smithy-client/rpc_v2_cbor/request_builder.rb
@@ -55,7 +55,7 @@ def event_stream?(shape)
         end
 
         def event_stream_shape?(shape)
-          shape.traits.include?('smithy.api#streaming') && shape.is_a?(Shapes::Union)
+          shape.traits.include?('smithy.api#streaming') && shape.is_a?(Schema::Shapes::UnionShape)
         end
 
         def build_url(context)
diff --git a/gems/smithy-client/spec/smithy-client/param_converter_spec.rb b/gems/smithy-client/spec/smithy-client/param_converter_spec.rb
@@ -10,7 +10,7 @@ module Client
     describe ParamConverter do
       describe '#convert' do
         it 'performs a deeply nested conversion of values' do
-          client_class = ClientHelper.sample_service
+          client_class = ClientHelper.sample_client
           rules = client_class.const_get(:Schema).const_get(:SERVICE).operation(:operation).input
           structure = client_class.const_get(:Types).const_get(:Structure)
           union = client_class.const_get(:Types).const_get(:Union).const_get(:Structure)
diff --git a/gems/smithy-client/spec/smithy-client/param_validator_spec.rb b/gems/smithy-client/spec/smithy-client/param_validator_spec.rb
@@ -6,11 +6,11 @@ module Smithy
   module Client
     describe ParamValidator do
       let(:shapes) { SchemaHelper.sample_shapes }
-      let(:sample_service) { ClientHelper.sample_service(shapes: shapes) }
-      let(:service) { sample_service.const_get(:Schema).const_get(:SERVICE) }
+      let(:sample_client) { ClientHelper.sample_client(shapes: shapes) }
+      let(:service_shape) { sample_client.const_get(:Schema).const_get(:SERVICE) }
 
       def validate(params, expected_errors = [])
-        schema = service.operation(:operation).input
+        schema = service_shape.operation(:operation).input
         if expected_errors.empty?
           ParamValidator.new(schema).validate!(params)
         else
@@ -271,7 +271,7 @@ def match_errors(error, expected_errors)
         end
 
         it 'accepts a modeled type' do
-          structure = sample_service.const_get(:Types).const_get(:Structure).new({})
+          structure = sample_client.const_get(:Types).const_get(:Structure).new({})
           validate({ structure: structure })
         end
       end
@@ -312,12 +312,12 @@ def match_errors(error, expected_errors)
         end
 
         it 'accepts a modeled type' do
-          union_structure = sample_service.const_get(:Types).const_get(:Union).const_get(:Structure)
+          union_structure = sample_client.const_get(:Types).const_get(:Union).const_get(:Structure)
           validate({ union: union_structure.new({ string: 'string' }) })
         end
 
         it 'raises an error when given the wrong modeled type' do
-          union_structure = sample_service.const_get(:Types).const_get(:Union).const_get(:Structure)
+          union_structure = sample_client.const_get(:Types).const_get(:Union).const_get(:Structure)
           validate({ union: union_structure.new({ structure: 'abc' }) },
                    'expected params[:union][:structure] to be a Hash, got class String instead.')
         end
diff --git a/gems/smithy-client/spec/smithy-client/plugins/http_api_key_auth_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/http_api_key_auth_spec.rb
@@ -8,13 +8,13 @@ module Smithy
   module Client
     module Plugins
       describe HttpApiKeyAuth do
-        let(:sample_service) { ClientHelper.sample_service }
+        let(:sample_client) { ClientHelper.sample_client }
 
         let(:client_class) do
-          client_class = sample_service.const_get(:Client)
+          client_class = sample_client.const_get(:Client)
           client_class.clear_plugins
-          client_class.add_plugin(sample_service::Plugins::Endpoint)
-          client_class.add_plugin(sample_service::Plugins::Auth)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
+          client_class.add_plugin(sample_client::Plugins::Auth)
           client_class.add_plugin(AnonymousAuth)
           client_class.add_plugin(HttpApiKeyAuth)
           client_class.add_plugin(StubResponses)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/http_basic_auth_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/http_basic_auth_spec.rb
@@ -8,13 +8,13 @@ module Smithy
   module Client
     module Plugins
       describe HttpBasicAuth do
-        let(:sample_service) { ClientHelper.sample_service }
+        let(:sample_client) { ClientHelper.sample_client }
 
         let(:client_class) do
-          client_class = sample_service.const_get(:Client)
+          client_class = sample_client.const_get(:Client)
           client_class.clear_plugins
-          client_class.add_plugin(sample_service::Plugins::Endpoint)
-          client_class.add_plugin(sample_service::Plugins::Auth)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
+          client_class.add_plugin(sample_client::Plugins::Auth)
           client_class.add_plugin(AnonymousAuth)
           client_class.add_plugin(HttpBasicAuth)
           client_class.add_plugin(StubResponses)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/http_bearer_auth_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/http_bearer_auth_spec.rb
@@ -8,13 +8,13 @@ module Smithy
   module Client
     module Plugins
       describe HttpBearerAuth do
-        let(:sample_service) { ClientHelper.sample_service }
+        let(:sample_client) { ClientHelper.sample_client }
 
         let(:client_class) do
-          client_class = sample_service.const_get(:Client)
+          client_class = sample_client.const_get(:Client)
           client_class.clear_plugins
-          client_class.add_plugin(sample_service::Plugins::Endpoint)
-          client_class.add_plugin(sample_service::Plugins::Auth)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
+          client_class.add_plugin(sample_client::Plugins::Auth)
           client_class.add_plugin(AnonymousAuth)
           client_class.add_plugin(HttpBearerAuth)
           client_class.add_plugin(StubResponses)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/http_digest_auth_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/http_digest_auth_spec.rb
@@ -8,13 +8,13 @@ module Smithy
   module Client
     module Plugins
       describe HttpDigestAuth do
-        let(:sample_service) { ClientHelper.sample_service }
+        let(:sample_client) { ClientHelper.sample_client }
 
         let(:client_class) do
-          client_class = sample_service.const_get(:Client)
+          client_class = sample_client.const_get(:Client)
           client_class.clear_plugins
-          client_class.add_plugin(sample_service::Plugins::Endpoint)
-          client_class.add_plugin(sample_service::Plugins::Auth)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
+          client_class.add_plugin(sample_client::Plugins::Auth)
           client_class.add_plugin(AnonymousAuth)
           client_class.add_plugin(HttpDigestAuth)
           client_class.add_plugin(StubResponses)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/logging_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/logging_spec.rb
@@ -9,7 +9,7 @@ module Client
     module Plugins
       describe Logging do
         let(:client_class) do
-          client_class = ClientHelper.sample_service.const_get(:Client)
+          client_class = ClientHelper.sample_client.const_get(:Client)
           client_class.clear_plugins
           client_class.add_plugin(Logging)
           client_class.add_plugin(DummySendPlugin)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/net_http_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/net_http_spec.rb
@@ -9,7 +9,7 @@ module Client
     module Plugins
       describe NetHTTP do
         let(:client_class) do
-          client_class = ClientHelper.sample_service.const_get(:Client)
+          client_class = ClientHelper.sample_client.const_get(:Client)
           client_class.clear_plugins
           client_class.add_plugin(NetHTTP)
           client_class
diff --git a/gems/smithy-client/spec/smithy-client/plugins/pageable_output_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/pageable_output_spec.rb
@@ -55,12 +55,12 @@ module Plugins
           }
         end
 
-        let(:sample_service) { ClientHelper.sample_service(shapes: shapes) }
+        let(:sample_client) { ClientHelper.sample_client(shapes: shapes) }
 
         let(:client_class) do
-          client_class = sample_service.const_get(:Client)
+          client_class = sample_client.const_get(:Client)
           client_class.clear_plugins
-          client_class.add_plugin(sample_service::Plugins::Endpoint)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
           client_class.add_plugin(Protocol)
           client_class.add_plugin(PageableOutput)
           client_class.add_plugin(StubResponses)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/param_converter_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/param_converter_spec.rb
@@ -8,10 +8,10 @@ module Smithy
   module Client
     module Plugins
       describe ParamConverter do
-        let(:sample_service) { ClientHelper.sample_service }
+        let(:sample_client) { ClientHelper.sample_client }
 
         let(:client_class) do
-          client_class = sample_service.const_get(:Client)
+          client_class = sample_client.const_get(:Client)
           client_class.clear_plugins
           client_class.add_plugin(ParamConverter)
           client_class.add_plugin(DummySendPlugin)
@@ -39,7 +39,7 @@ module Plugins
 
         it 'calls the param converter' do
           params = {}
-          input = sample_service.const_get(:Schema).const_get(:SERVICE).operation(:operation).input
+          input = sample_client.const_get(:Schema).const_get(:SERVICE).operation(:operation).input
           expect(Client::ParamConverter).to receive(:new).with(input).and_call_original
           expect_any_instance_of(Client::ParamConverter).to receive(:convert).with(params).and_call_original
           client.operation(params)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/param_validator_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/param_validator_spec.rb
@@ -8,10 +8,10 @@ module Smithy
   module Client
     module Plugins
       describe ParamValidator do
-        let(:sample_service) { ClientHelper.sample_service }
+        let(:sample_client) { ClientHelper.sample_client }
 
         let(:client_class) do
-          client_class = sample_service.const_get(:Client)
+          client_class = sample_client.const_get(:Client)
           client_class.clear_plugins
           client_class.add_plugin(ParamValidator)
           client_class.add_plugin(DummySendPlugin)
@@ -39,7 +39,7 @@ module Plugins
 
         it 'calls the param validator' do
           params = {}
-          input = sample_service.const_get(:Schema).const_get(:SERVICE).operation(:operation).input
+          input = sample_client.const_get(:Schema).const_get(:SERVICE).operation(:operation).input
           expect(Client::ParamValidator).to receive(:new).with(input).and_call_original
           expect_any_instance_of(Client::ParamValidator).to receive(:validate!).with(params).and_call_original
           client.operation(params)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/protocol_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/protocol_spec.rb
@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative '../../spec_helper'
+
+require 'smithy-client/plugins/protocol'
+
+module Smithy
+  module Client
+    module Plugins
+      describe Protocol do
+        let(:sample_client) { ClientHelper.sample_client }
+        let(:client_class) do
+          client_class = sample_client.const_get(:Client)
+          client_class.clear_plugins
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
+          client_class.add_plugin(Protocol)
+          client_class.add_plugin(StubResponses)
+          client_class
+        end
+
+        let(:client) { client_class.new(stub_responses: true) }
+
+        it 'adds a :protocol option to config' do
+          expect(client.config).to respond_to(:protocol)
+        end
+
+        it 'defaults :protocol to the modeled protocol' do
+          client = client_class.new
+          expect(client.config.protocol).to be_a(client_class.protocols.values.first)
+        end
+
+        it 'validates :protocol against available protocols when provided a string' do
+          expect { client_class.new(protocol: 'unknown') }
+            .to raise_error(ArgumentError, /Unknown protocol/)
+        end
+
+        it 'will use any provided protocol object' do
+          protocol = double('protocol')
+          client = client_class.new(protocol: protocol)
+          expect(client.config.protocol).to be(protocol)
+        end
+
+        it 'will use the stubbing protocol if :stub_responses is true and no protocol is available' do
+          expect(client_class).to receive(:protocols).and_return({})
+          expect(client.config.protocol).to be_a(Stubbing::Protocol)
+        end
+
+        it 'adds the build and parse handlers' do
+          expect(client.handlers).to include(Protocol::BuildHandler)
+          expect(client.handlers).to include(Protocol::ParseHandler)
+        end
+
+        describe Protocol::BuildHandler do
+          it 'calls the protocol build_request method' do
+            client = client_class.new(stub_responses: true)
+            expect(client.config.protocol).to receive(:build_request).and_call_original
+            client.operation
+          end
+        end
+
+        describe Protocol::ParseHandler do
+          it 'does not call parse_error if output has an error' do
+            client = client_class.new(stub_responses: true)
+            client.stub_responses(:operation, StandardError.new)
+            expect(client.config.protocol).not_to receive(:parse_error)
+            client.operation
+          end
+
+          it 'calls parse_error if output does not have an error' do
+            client = client_class.new(stub_responses: true)
+            expect(client.config.protocol).to receive(:parse_error)
+            client.operation
+          end
+
+          it 'does not call parse_data if an error was parsed' do
+            client = client_class.new(stub_responses: true)
+            client.stub_responses(:operation, sample_client::Errors::Error.new(nil, nil))
+            expect(client.config.protocol).not_to receive(:parse_data)
+            client.operation
+          end
+
+          it 'calls parse_data if no error was parsed' do
+            client = client_class.new(stub_responses: true)
+            expect(client.config.protocol).to receive(:parse_data)
+            client.operation
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/gems/smithy-client/spec/smithy-client/plugins/raise_response_errors_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/raise_response_errors_spec.rb
@@ -9,7 +9,7 @@ module Client
     module Plugins
       describe RaiseResponseErrors do
         let(:client_class) do
-          client_class = ClientHelper.sample_service.const_get(:Client)
+          client_class = ClientHelper.sample_client.const_get(:Client)
           client_class.clear_plugins
           client_class.add_plugin(RaiseResponseErrors)
           client_class.add_plugin(DummySendPlugin)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/response_target_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/response_target_spec.rb
@@ -9,7 +9,7 @@ module Client
     module Plugins
       describe ResponseTarget do
         let(:client_class) do
-          client_class = ClientHelper.sample_service.const_get(:Client)
+          client_class = ClientHelper.sample_client.const_get(:Client)
           client_class.clear_plugins
           client_class.add_plugin(ResponseTarget)
           client_class.add_plugin(DummySendPlugin)
diff --git a/gems/smithy-client/spec/smithy-client/plugins/retry_errors_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/retry_errors_spec.rb
@@ -9,11 +9,11 @@ module Smithy
   module Client
     module Plugins
       describe RetryErrors do
-        let(:service) { ClientHelper.sample_service }
+        let(:sample_client) { ClientHelper.sample_client }
         let(:client_class) do
-          client_class = service.const_get(:Client)
+          client_class = sample_client.const_get(:Client)
           client_class.clear_plugins
-          client_class.add_plugin(service::Plugins::Endpoint)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
           client_class.add_plugin(RetryErrors)
           client_class.add_plugin(StubResponses)
           client_class
diff --git a/gems/smithy-client/spec/smithy-client/plugins/stub_responses_spec.rb b/gems/smithy-client/spec/smithy-client/plugins/stub_responses_spec.rb
diff --git a/gems/smithy-client/spec/support/client_helper.rb b/gems/smithy-client/spec/support/client_helper.rb
diff --git a/gems/smithy-schema/spec/support/schema_helper.rb b/gems/smithy-schema/spec/support/schema_helper.rb
diff --git a/gems/smithy/spec/interfaces/client/stub_responses_spec.rb b/gems/smithy/spec/interfaces/client/stub_responses_spec.rb
