grpc_mock 0.3.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64d71ca90aa6a226e3adabaaeb57706fca0c0f64d2a1067ce6e43096325309dd
-  data.tar.gz: 31d13e31248b47d0fbef1e2b6a684c14e09849b9f122788154701f3df44c4acb
+  metadata.gz: 1d9ce22e13c7dae6452813ff348fab4e0b894f21b33fdff005600334df3f77d8
+  data.tar.gz: 4dfd66d56c40ac155d0d2d67c88f7f97dbb7931a34e93d1df0ce37a2e069cd18
 SHA512:
-  metadata.gz: 1da4555681fd8e75403c2cad300793c3a7732671258a09ee57426e4cf5b3df5ce68d8d1e8bf5db7ca8122e52997030dbc81de74984f2ff011dc053842de4cd90
-  data.tar.gz: c40cfd23df2b2106d13e752c882e1dfe809aed80f9bdc41723d632a7b77f9390bf9e20ebd524c7d65857bd5e7bfe527f4cf5eae7c0e04afc92fc28c429a6827b
+  metadata.gz: 4bb6164d3b3afa78b6bd8e85bb0c7864aea6b52c78038c3f1bc810faf944adfe60901d832df4b6bd6ce3cdad3a98b890974dc9a620e2ba81ecdbe82d58b05b71
+  data.tar.gz: 8b3385763458fe785ad159f4ca5601ff24fd8773f7c8ae3607429c388aef745e2504adcf966ae359af117001f894111f92f1f92a84dc43c4448c3e5f1ea78bfa

data/README.md

@@ -30,35 +30,69 @@ require 'grpc_mock/rspec'
 
 See definition of protocol buffers and gRPC generated code in [spec/exmaples/hello](https://github.com/ganmacs/grpc_mock/tree/master/spec/examples/hello)
 
-##### Stubbed request based on path and with the default response
+### Stubbed request based on path and with the default response
 
 ```ruby
 GrpcMock.stub_request("/hello.hello/Hello").to_return(Hello::HelloResponse.new(msg: 'test'))
 
 client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure)
-client = client.hello(Hello::HelloRequest.new(msg: 'hi')) # => Hello::HelloResponse.new(msg: 'test')
+client.hello(Hello::HelloRequest.new(msg: 'hi')) # => Hello::HelloResponse.new(msg: 'test')
 ```
 
-##### Stubbing requests based on path and request
+### Stubbing requests based on path and request
 
 ```ruby
 GrpcMock.stub_request("/hello.hello/Hello").with(Hello::HelloRequest.new(msg: 'hi')).to_return(Hello::HelloResponse.new(msg: 'test'))
 
 client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure)
-client = client.hello(Hello::HelloRequest.new(msg: 'hello')) # => send a request to server
-client = client.hello(Hello::HelloRequest.new(msg: 'hi'))    # => Hello::HelloResponse.new(msg: 'test') (without any requests to server)
+client.hello(Hello::HelloRequest.new(msg: 'hello')) # => send a request to server
+client client.hello(Hello::HelloRequest.new(msg: 'hi'))    # => Hello::HelloResponse.new(msg: 'test') (without any requests to server)
 ```
 
-##### Real requests to network can be allowed or disabled
+### Responding dynamically to the stubbed requests
+
+```ruby
+GrpcMock.stub_request("/hello.hello/Hello").to_return do |req, call|
+  Hello::HelloResponse.new(msg: "#{req.msg} too")
+end
+
+client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure)
+client.hello(Hello::HelloRequest.new(msg: 'hi'))    # => Hello::HelloResponse.new(msg: 'hi too')
+```
+
+### Real requests to network can be allowed or disabled
 
 ```ruby
 client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure)
 
 GrpcMock.disable_net_connect!
-client = client.hello(Hello::HelloRequest.new(msg: 'hello')) # => Raise NetConnectNotAllowedError error
+client.hello(Hello::HelloRequest.new(msg: 'hello')) # => Raise NetConnectNotAllowedError error
 
 GrpcMock.allow_net_connect!
-client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure) # => send a request to server
+Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure) # => send a request to server
+```
+
+### Raising errors
+
+**Exception declared by class**
+
+```ruby
+GrpcMock.stub_request("/hello.hello/Hello").to_raise(StandardError)
+
+client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure)
+client.hello(Hello::HelloRequest.new(msg: 'hi')) # => Raise StandardError
+```
+
+**or by exception instance**
+
+```ruby
+GrpcMock.stub_request("/hello.hello/Hello").to_raise(StandardError.new("Some error"))
+```
+
+**or by string**
+
+```ruby
+GrpcMock.stub_request("/hello.hello/Hello").to_raise("Some error")
 ```
 
 ## Contributing

data/grpc_mock.gemspec

@@ -22,12 +22,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'grpc', '>= 1.12.0', '< 1.21.0'
+  spec.add_dependency 'grpc', '>= 1.12.0', '< 2'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'grpc-tools'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
 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
+          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
+          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
+          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
+          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/request_stub.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require 'grpc_mock/request_pattern'
-require 'grpc_mock/resopnse_sequence'
+require 'grpc_mock/response'
+require 'grpc_mock/response_sequence'
 require 'grpc_mock/errors'
 
 module GrpcMock
@@ -17,8 +18,16 @@ module GrpcMock
       self
     end
 
-    def to_return(*resp)
-      @response_sequence << GrpcMock::ResponsesSequence.new(resp)
+    def to_return(*values, &block)
+      responses = [*values].flatten.map { |v| Response::Value.new(v) }
+      responses << Response::BlockValue.new(block) if block
+      @response_sequence << GrpcMock::ResponsesSequence.new(responses)
+      self
+    end
+
+    def to_raise(*exceptions)
+      responses = [*exceptions].flatten.map { |e| Response::ExceptionValue.new(e) }
+      @response_sequence << GrpcMock::ResponsesSequence.new(responses)
       self
     end
 

data/lib/grpc_mock/response.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module GrpcMock
+  module Response
+    class ExceptionValue
+      def initialize(exception)
+        @exception = case exception
+                     when String
+                       StandardError.new(exception)
+                     when Class
+                       exception.new('Exception from GrpcMock')
+                     when Exception
+                       exception
+                     else
+                       raise ArgumentError.new(message: "Invalid exception class: #{exception.class}")
+                     end
+      end
+
+      def evaluate(_request = nil, _call = nil)
+        raise @exception.dup
+      end
+    end
+
+    class Value
+      def initialize(value)
+        @value = value
+      end
+
+      def evaluate(_request = nil, _call = nil)
+        @value.dup
+      end
+    end
+
+    class BlockValue
+      def initialize(block)
+        @block = block
+      end
+
+      def evaluate(request, call = nil)
+        @block.call(request, call)
+      end
+    end
+  end
+end

data/lib/grpc_mock/stub_registry.rb

@@ -24,7 +24,7 @@ module GrpcMock
       end
 
       if rstub
-        rstub.response.dup
+        rstub.response
       end
     end
   end

data/lib/grpc_mock/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_mock
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Yuta Iwama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -19,7 +19,7 @@ dependencies:
         version: 1.12.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 1.12.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -76,16 +76,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -140,9 +140,11 @@ 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/resopnse_sequence.rb
+- lib/grpc_mock/response.rb
+- lib/grpc_mock/response_sequence.rb
 - lib/grpc_mock/rspec.rb
 - lib/grpc_mock/stub_registry.rb
 - lib/grpc_mock/version.rb