grpc_mock 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 128da2bce960f7416a796a0b96bd0866a79bf30decc85e064d5c951b2f93a939
-  data.tar.gz: 7086f3897090c64f0d97aaa0cfbda4138787921929be89495f820dbeb866e533
+  metadata.gz: ed55b4c744bb9a0b6c705e5e3c05e54a8ddc8739f1e5a660387f8269a7454170
+  data.tar.gz: aad2eee18de57d3f752f85c3e1f013032603bf487c3dc8a98044116507b6e43d
 SHA512:
-  metadata.gz: 23511c5cacc91af0c26eafceee5f0a986605cb44feccf169608a35ff8f353a6f0933bc8ea0af22fbb9f04f190b5791ce6b76825040cb49e9655815bdb0f7b1a1
-  data.tar.gz: b069f76b458a0d95c7006a9f079e2c6bcd7c600ef563355716aa15f9208f79e3262a49a3efea6e7bc09169e5e2a8d60945f6bd772683896f44323bf3fbe7f5f4
+  metadata.gz: 5c92bfe07183760fea13c77e3d999da4e57c7d92e9e664572a4c421344fa775061dc9b72772a9bec1f4ac908fcbedb8b1b657ecf27220e6dfa0d9c70dba3bc8c
+  data.tar.gz: d507ea97f5124eef53fb5e8d5fe61748f0105f6defa1b50879ec6f7770928887fd906b7a84520d9a3726e9217b341570873807a9e7f70472f887b22d88b03540

data/README.md

@@ -52,7 +52,7 @@ client client.hello(Hello::HelloRequest.new(msg: 'hi'))    # => Hello::HelloResp
 ### Responding dynamically to the stubbed requests
 
 ```ruby
-GrpcMock.stub_request("/hello.hello/Hello").to_return do |req|
+GrpcMock.stub_request("/hello.hello/Hello").to_return do |req, call|
   Hello::HelloResponse.new(msg: "#{req.msg} too")
 end
 

data/lib/grpc_mock/grpc_stub_adapter.rb

@@ -2,20 +2,22 @@
 
 require 'grpc'
 require 'grpc_mock/errors'
+require 'grpc_mock/mocked_call'
 
 module GrpcMock
   class GrpcStubAdapter
     # To make hook point for GRPC::ClientStub
     # https://github.com/grpc/grpc/blob/bec3b5ada2c5e5d782dff0b7b5018df646b65cb0/src/ruby/lib/grpc/generic/service.rb#L150-L186
     class AdapterClass < GRPC::ClientStub
-      def request_response(method, request, *args)
+      def request_response(method, request, *args, metadata: {}, **kwargs)
         unless GrpcMock::GrpcStubAdapter.enabled?
           return super
         end
 
         mock = GrpcMock.stub_registry.response_for_request(method, request)
         if mock
-          mock.evaluate(request)
+          call = GrpcMock::MockedCall.new(metadata: metadata)
+          mock.evaluate(request, call.single_req_view)
         elsif GrpcMock.config.allow_net_connect
           super
         else
@@ -24,7 +26,7 @@ module GrpcMock
       end
 
       # TODO
-      def client_streamer(method, requests, *args)
+      def client_streamer(method, requests, *args, metadata: {}, **kwargs)
         unless GrpcMock::GrpcStubAdapter.enabled?
           return super
         end
@@ -32,7 +34,8 @@ module GrpcMock
         r = requests.to_a       # FIXME: this may not work
         mock = GrpcMock.stub_registry.response_for_request(method, r)
         if mock
-          mock.evaluate(r)
+          call = GrpcMock::MockedCall.new(metadata: metadata)
+          mock.evaluate(r, call.multi_req_view)
         elsif GrpcMock.config.allow_net_connect
           super
         else
@@ -40,14 +43,15 @@ module GrpcMock
         end
       end
 
-      def server_streamer(method, request, *args)
+      def server_streamer(method, request, *args, metadata: {}, **kwargs)
         unless GrpcMock::GrpcStubAdapter.enabled?
           return super
         end
 
         mock = GrpcMock.stub_registry.response_for_request(method, request)
         if mock
-          mock.evaluate(request)
+          call = GrpcMock::MockedCall.new(metadata: metadata)
+          mock.evaluate(request, call.single_req_view)
         elsif GrpcMock.config.allow_net_connect
           super
         else
@@ -55,7 +59,7 @@ module GrpcMock
         end
       end
 
-      def bidi_streamer(method, requests, *args)
+      def bidi_streamer(method, requests, *args, metadata: {}, **kwargs)
         unless GrpcMock::GrpcStubAdapter.enabled?
           return super
         end
@@ -63,7 +67,7 @@ module GrpcMock
         r = requests.to_a       # FIXME: this may not work
         mock = GrpcMock.stub_registry.response_for_request(method, r)
         if mock
-          mock.evaluate(r)
+          mock.evaluate(r, nil) # FIXME: provide BidiCall equivalent
         elsif GrpcMock.config.allow_net_connect
           super
         else

data/lib/grpc_mock/mocked_call.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'grpc'
+
+module GrpcMock
+  class MockedCall
+    attr_reader :deadline, :metadata
+
+    def initialize(metadata: {}, deadline: nil)
+      @metadata = sanitize_metadata(metadata)
+      @deadline = deadline
+    end
+
+    def multi_req_view
+      GRPC::ActiveCall::MultiReqView.new(self)
+    end
+
+    def single_req_view
+      GRPC::ActiveCall::SingleReqView.new(self)
+    end
+
+    private
+
+    def sanitize_metadata(metadata)
+      # Largely based on
+      # - grpc_rb_md_ary_fill_hash_cb https://github.com/grpc/grpc/blob/v1.29.1/src/ruby/ext/grpc/rb_call.c#L390-L465
+      # - grpc_rb_md_ary_convert https://github.com/grpc/grpc/blob/v1.29.1/src/ruby/ext/grpc/rb_call.c#L490-L511
+      # - grpc_rb_md_ary_to_h https://github.com/grpc/grpc/blob/v1.29.1/src/ruby/ext/grpc/rb_call.c#L513-L541
+      # See also https://github.com/grpc/grpc/blob/v1.29.1/doc/PROTOCOL-HTTP2.md for specification
+
+      raise TypeError, "got <#{metadata.class}>, want <Hash>" unless metadata.is_a?(Hash)
+
+      headers = []
+      metadata.each do |key, value|
+        raise TypeError, "bad type for key parameter" unless key.is_a?(String) || key.is_a?(Symbol)
+
+        key = key.to_s
+        # https://github.com/grpc/grpc/blob/v1.29.1/src/core/lib/surface/validate_metadata.cc#L61-L79
+        raise ArgumentError, "'#{key}' is an invalid header key" unless key.match?(/\A[a-z0-9-_.]+\z/) && key != ''
+        raise ArgumentError, "Header values must be of type string or array" unless value.is_a?(String) || value.is_a?(Array)
+
+        Array(value).each do |elem|
+          raise TypeError, "Header value must be of type string" unless elem.is_a?(String)
+
+          unless key.end_with?('-bin')
+            # Non-binary metadata are translated as plain HTTP2 headers, thus this requirement.
+            # https://github.com/grpc/grpc/blob/v1.29.1/src/core/lib/surface/validate_metadata.cc#L85-L92
+            raise ArgumentError, "Header value '#{elem}' has invalid characters" unless elem.match(/\A[ -~]+\z/)
+
+            # "ASCII-Value should not have leading or trailing whitespace. If it contains leading or trailing whitespace, it may be stripped."
+            # https://github.com/grpc/grpc/blob/v1.29.1/doc/PROTOCOL-HTTP2.md
+            elem = elem.strip
+          end
+          headers << [key, elem]
+        end
+      end
+
+      metadata = {}
+      headers.each do |key, elem|
+        if metadata[key].nil?
+          metadata[key] = elem
+        elsif metadata[key].is_a?(Array)
+          metadata[key] << elem
+        else
+          metadata[key] = [metadata[key], elem]
+        end
+      end
+
+      metadata
+    end
+  end
+end

data/lib/grpc_mock/response.rb

@@ -16,7 +16,7 @@ module GrpcMock
                      end
       end
 
-      def evaluate(_request = nil)
+      def evaluate(_request = nil, _call = nil)
         raise @exception.dup
       end
     end
@@ -26,7 +26,7 @@ module GrpcMock
         @value = value
       end
 
-      def evaluate(_request = nil)
+      def evaluate(_request = nil, _call = nil)
         @value.dup
       end
     end
@@ -36,8 +36,8 @@ module GrpcMock
         @block = block
       end
 
-      def evaluate(request)
-        @block.call(request)
+      def evaluate(request, call = nil)
+        @block.call(request, call)
       end
     end
   end

data/lib/grpc_mock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrpcMock
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_mock
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Yuta Iwama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -140,6 +140,7 @@ files:
 - lib/grpc_mock/grpc_stub_adapter.rb
 - lib/grpc_mock/matchers/hash_argument_matcher.rb
 - lib/grpc_mock/matchers/request_including_matcher.rb
+- lib/grpc_mock/mocked_call.rb
 - lib/grpc_mock/request_pattern.rb
 - lib/grpc_mock/request_stub.rb
 - lib/grpc_mock/response.rb