grpc_mock 0.3.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d717cdc98c3aa591bd9f3681b243c0fe51a80775d8ff2e3f6a4722c717aa0838
-  data.tar.gz: 2843c56fe8383a8d1bb1bacb2c5f64ed3d6f4342ea884052e1bdbf60aa063ba9
+  metadata.gz: cb0de4a6e730f8e575b50ecfa9ee0d92b97dd3380900dc119de0a41abc285457
+  data.tar.gz: 912662c5b9ed4398a8377d9207621208f3bcfdf201eff0a4e4cd7ec95e152600
 SHA512:
-  metadata.gz: 394cf9c6dfd230e467d10d89933927cbec13273b11c4188358ffacba750dcd8df6eddfd4d546509411962d541c7d99118501d118acdedfbd0004c805d0d94937
-  data.tar.gz: d85fd1a0f7f73b94e35d8288648f264bb3c57b63a28d5135d3f9648589fc97d60244255741ea8e5e96b5934b7d2535d82ae49977cbf2db67f7e03ccad753b8d6
+  metadata.gz: f78e70b411a828142b828ca7348e27b25dbd76a86af5fa8886146fd0459f427598f132c092af084848e90a9b5c35dd921f5b77408b5a94850e8ea4fc6b760e79
+  data.tar.gz: 2cabdde68d88771fca38020d2f5b6cd5cf2ec7462ada062a84139252aeda8103f811486bbdb2e1dc4dbaaaa8c9f134e7880525f7dbfbe1a4672c67a1379190a3

data/README.md

@@ -28,37 +28,71 @@ require 'grpc_mock/rspec'
 
 ## Examples
 
-See definition of protocol buffers and gRPC generated code in [spec/exmaples/hello](https://github.com/ganmacs/grpc_mock/tree/master/spec/examples/hello)
+See definition of protocol buffers and gRPC generated code in [spec/examples/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.22.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)
+    module Adapter
+      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
+          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
+          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
+          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
+          mock.evaluate(r, nil) # FIXME: provide BidiCall equivalent
         elsif GrpcMock.config.allow_net_connect
           super
         else
@@ -71,8 +75,6 @@ module GrpcMock
         end
       end
     end
-    GRPC.send(:remove_const, :ClientStub)
-    GRPC.send(:const_set, :ClientStub, AdapterClass)
 
     def self.disable!
       @enabled = false
@@ -95,3 +97,9 @@ module GrpcMock
     end
   end
 end
+
+module GRPC
+  class ClientStub
+    prepend GrpcMock::GrpcStubAdapter::Adapter
+  end
+end

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

@@ -18,8 +18,9 @@ module GrpcMock
       self
     end
 
-    def to_return(*values)
+    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

data/lib/grpc_mock/response.rb

@@ -16,7 +16,7 @@ module GrpcMock
                      end
       end
 
-      def evaluate
+      def evaluate(_request = nil, _call = nil)
         raise @exception.dup
       end
     end
@@ -26,9 +26,19 @@ module GrpcMock
         @value = value
       end
 
-      def evaluate
+      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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_mock
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.4
 platform: ruby
 authors:
 - Yuta Iwama
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2021-01-29 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.22.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.22.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,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
@@ -151,7 +152,7 @@ homepage: https://github.com/ganmacs/grpc_mock
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Library for stubbing grpc in Ruby
 test_files: []