Push auth tests to client

Author: Matt Muller

gems/smithy-client/spec/smithy-client/plugins/http_api_key_auth_spec.rb

@@ -8,20 +8,23 @@ module Smithy
   module Client
     module Plugins
       describe HttpApiKeyAuth do
-        let(:sample_client) { ClientHelper.sample_client }
+        let(:shapes) { ClientHelper.sample_shapes }
+        let(:sample_client) { ClientHelper.sample_client(shapes: shapes) }
 
         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(sample_client::Plugins::Auth)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
           client_class.add_plugin(AnonymousAuth)
           client_class.add_plugin(HttpApiKeyAuth)
+          client_class.add_plugin(Protocol)
+          client_class.add_plugin(SignRequests)
           client_class.add_plugin(StubResponses)
           client_class
         end
 
-        let(:client) { client_class.new }
+        let(:client) { client_class.new(stub_responses: true) }
 
         it 'adds an :http_api_key option to config' do
           expect(client.config).to respond_to(:http_api_key)
@@ -32,20 +35,20 @@ module Plugins
         end
 
         it 'does not default a :http_api_key' do
+          client = client_class.new
           expect(client.config.http_api_key).to be_nil
         end
 
         it 'does not default a :http_api_key_provider' do
+          client = client_class.new
           expect(client.config.http_api_key_provider).to be_nil
         end
 
         it 'has a default :http_api_key when :stub_responses is true' do
-          client = client_class.new(stub_responses: true)
           expect(client.config.http_api_key).to eq('stubbed-api-key')
         end
 
         it 'has a default :http_api_key_provider when :stub_responses is true' do
-          client = client_class.new(stub_responses: true)
           provider = client.config.http_api_key_provider
           expect(provider).to be_a(HttpApiKeyProvider)
           expect(provider.identity({}).key).to eq('stubbed-api-key')
@@ -57,6 +60,35 @@ module Plugins
           expect(provider).to be_a(HttpApiKeyProvider)
           expect(provider.identity({}).key).to eq('api-key')
         end
+
+        context 'signing' do
+          it 'signs in the header' do
+            shapes['smithy.ruby.tests#SampleClient']['traits']['smithy.api#httpApiKeyAuth'] = {
+              'name' => 'x-api-key', 'in' => 'header'
+            }
+
+            output = client.operation
+            expect(output.context.request.headers['x-api-key']).to eq('stubbed-api-key')
+          end
+
+          it 'signs in the header with a custom scheme' do
+            shapes['smithy.ruby.tests#SampleClient']['traits']['smithy.api#httpApiKeyAuth'] = {
+              'name' => 'x-api-key', 'in' => 'header', 'scheme' => 'ApiKey'
+            }
+
+            output = client.operation
+            expect(output.context.request.headers['x-api-key']).to eq('ApiKey stubbed-api-key')
+          end
+
+          it 'can sign on the query string' do
+            shapes['smithy.ruby.tests#SampleClient']['traits']['smithy.api#httpApiKeyAuth'] = {
+              'name' => 'x-api-key', 'in' => 'query'
+            }
+
+            output = client.operation
+            expect(output.context.request.endpoint.query).to include('x-api-key=stubbed-api-key')
+          end
+        end
       end
     end
   end

gems/smithy-client/spec/smithy-client/plugins/http_basic_auth_spec.rb

@@ -8,20 +8,23 @@ module Smithy
   module Client
     module Plugins
       describe HttpBasicAuth do
-        let(:sample_client) { ClientHelper.sample_client }
+        let(:shapes) { ClientHelper.sample_shapes }
+        let(:sample_client) { ClientHelper.sample_client(shapes: shapes) }
 
         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(sample_client::Plugins::Auth)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
           client_class.add_plugin(AnonymousAuth)
           client_class.add_plugin(HttpBasicAuth)
+          client_class.add_plugin(Protocol)
+          client_class.add_plugin(SignRequests)
           client_class.add_plugin(StubResponses)
           client_class
         end
 
-        let(:client) { client_class.new }
+        let(:client) { client_class.new(stub_responses: true) }
 
         it 'adds an :http_login_username option to config' do
           expect(client.config).to respond_to(:http_login_username)
@@ -36,22 +39,22 @@ module Plugins
         end
 
         it 'does not default an :http_login_username or :http_login_password' do
+          client = client_class.new
           expect(client.config.http_login_username).to be_nil
           expect(client.config.http_login_password).to be_nil
         end
 
         it 'does not default a :http_login_provider' do
+          client = client_class.new
           expect(client.config.http_login_provider).to be_nil
         end
 
         it 'has a default :http_login_username and :http_login_password when :stub_responses is true' do
-          client = client_class.new(stub_responses: true)
           expect(client.config.http_login_username).to eq('stubbed-username')
           expect(client.config.http_login_password).to eq('stubbed-password')
         end
 
         it 'has a default :http_login_provider when :stub_responses is true' do
-          client = client_class.new(stub_responses: true)
           provider = client.config.http_login_provider
           expect(provider).to be_a(HttpLoginProvider)
           identity = provider.identity({})
@@ -77,6 +80,17 @@ module Plugins
           provider = client.config.http_login_provider
           expect(provider).to be_nil
         end
+
+        context 'signing' do
+          it 'signs in the header' do
+            shapes['smithy.ruby.tests#SampleClient']['traits']['smithy.api#httpBasicAuth'] = {}
+
+            output = client.operation
+            identity_string = "#{client.config.http_login_username}:#{client.config.http_login_password}"
+            expect(output.context.request.headers['Authorization'])
+              .to eq("Basic #{Base64.strict_encode64(identity_string)}")
+          end
+        end
       end
     end
   end

gems/smithy-client/spec/smithy-client/plugins/http_bearer_auth_spec.rb

@@ -8,20 +8,23 @@ module Smithy
   module Client
     module Plugins
       describe HttpBearerAuth do
-        let(:sample_client) { ClientHelper.sample_client }
+        let(:shapes) { ClientHelper.sample_shapes }
+        let(:sample_client) { ClientHelper.sample_client(shapes: shapes) }
 
         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(sample_client::Plugins::Auth)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
           client_class.add_plugin(AnonymousAuth)
           client_class.add_plugin(HttpBearerAuth)
+          client_class.add_plugin(Protocol)
+          client_class.add_plugin(SignRequests)
           client_class.add_plugin(StubResponses)
           client_class
         end
 
-        let(:client) { client_class.new }
+        let(:client) { client_class.new(stub_responses: true) }
 
         it 'adds an :http_bearer_token option to config' do
           expect(client.config).to respond_to(:http_bearer_token)
@@ -32,20 +35,20 @@ module Plugins
         end
 
         it 'does not default a :http_bearer_token' do
+          client = client_class.new
           expect(client.config.http_bearer_token).to be_nil
         end
 
         it 'does not default a :http_bearer_provider' do
+          client = client_class.new
           expect(client.config.http_bearer_provider).to be_nil
         end
 
         it 'has a default :http_bearer_token when :stub_responses is true' do
-          client = client_class.new(stub_responses: true)
           expect(client.config.http_bearer_token).to eq('stubbed-bearer-token')
         end
 
         it 'has a default :http_bearer_provider when :stub_responses is true' do
-          client = client_class.new(stub_responses: true)
           provider = client.config.http_bearer_provider
           expect(provider).to be_a(HttpBearerProvider)
           expect(provider.identity({}).token).to eq('stubbed-bearer-token')
@@ -57,6 +60,16 @@ module Plugins
           expect(provider).to be_a(HttpBearerProvider)
           expect(provider.identity({}).token).to eq('bearer')
         end
+
+        context 'signing' do
+          it 'signs in the header' do
+            shapes['smithy.ruby.tests#SampleClient']['traits']['smithy.api#httpBearerAuth'] = {}
+
+            output = client.operation
+            expect(output.context.request.headers['Authorization'])
+              .to eq("Bearer #{client.config.http_bearer_token}")
+          end
+        end
       end
     end
   end

gems/smithy-client/spec/smithy-client/plugins/http_digest_auth_spec.rb

@@ -8,20 +8,23 @@ module Smithy
   module Client
     module Plugins
       describe HttpDigestAuth do
-        let(:sample_client) { ClientHelper.sample_client }
+        let(:shapes) { ClientHelper.sample_shapes }
+        let(:sample_client) { ClientHelper.sample_client(shapes: shapes) }
 
         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(sample_client::Plugins::Auth)
+          client_class.add_plugin(sample_client::Plugins::Endpoint)
           client_class.add_plugin(AnonymousAuth)
           client_class.add_plugin(HttpDigestAuth)
+          client_class.add_plugin(Protocol)
+          client_class.add_plugin(SignRequests)
           client_class.add_plugin(StubResponses)
           client_class
         end
 
-        let(:client) { client_class.new }
+        let(:client) { client_class.new(stub_responses: true) }
 
         it 'adds an :http_login_username option to config' do
           expect(client.config).to respond_to(:http_login_username)
@@ -36,22 +39,22 @@ module Plugins
         end
 
         it 'does not default an :http_login_username or :http_login_password' do
+          client = client_class.new
           expect(client.config.http_login_username).to be_nil
           expect(client.config.http_login_password).to be_nil
         end
 
         it 'does not default a :http_login_provider' do
+          client = client_class.new
           expect(client.config.http_login_provider).to be_nil
         end
 
         it 'has a default :http_login_username and :http_login_password when :stub_responses is true' do
-          client = client_class.new(stub_responses: true)
           expect(client.config.http_login_username).to eq('stubbed-username')
           expect(client.config.http_login_password).to eq('stubbed-password')
         end
 
         it 'has a default :http_login_provider when :stub_responses is true' do
-          client = client_class.new(stub_responses: true)
           provider = client.config.http_login_provider
           expect(provider).to be_a(HttpLoginProvider)
           identity = provider.identity({})
@@ -77,6 +80,10 @@ module Plugins
           provider = client.config.http_login_provider
           expect(provider).to be_nil
         end
+
+        context 'signing' do
+          it 'signs in the header'
+        end
       end
     end
   end

gems/smithy/spec/fixtures/auth/http_api_key_auth/model.json

@@ -3,26 +3,12 @@
     "shapes": {
         "smithy.ruby.tests#HttpApiKeyAuth": {
             "type": "service",
-            "operations": [
-                {
-                    "target": "smithy.ruby.tests#Operation"
-                }
-            ],
             "traits": {
                 "smithy.api#httpApiKeyAuth": {
                     "name": "x-api-key",
                     "in": "header"
                 }
             }
-        },
-        "smithy.ruby.tests#Operation": {
-            "type": "operation",
-            "input": {
-                "target": "smithy.api#Unit"
-            },
-            "output": {
-                "target": "smithy.api#Unit"
-            }
         }
     }
 }

gems/smithy/spec/fixtures/auth/http_api_key_auth/model.smithy

@@ -3,8 +3,4 @@ $version: "2"
 namespace smithy.ruby.tests
 
 @httpApiKeyAuth(name: "x-api-key", in: "header")
-service HttpApiKeyAuth {
-    operations: [Operation]
-}
-
-operation Operation {}
+service HttpApiKeyAuth {}