tonic-rails 0.1.0 → 0.3.0

data/lib/tonic/rails/testing/minitest.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "tonic/rails/testing"
+require "tonic/rails/testing/errors"
+
+module Tonic
+  module Rails
+    module Testing
+      # Minitest assertions for gRPC statuses:
+      #
+      #   class ItemServiceTest < ActiveSupport::TestCase
+      #     include Tonic::Rails::Testing::Assertions
+      #
+      #     test "missing items" do
+      #       error = assert_grpc_error(:not_found) { Tonic::Rails::Testing.call(ItemService, :GetItem, { id: 0 }) }
+      #       assert_match(/0/, error.message)
+      #     end
+      #   end
+      module Assertions
+        # Asserts the block raises a gRPC status (Tonic::Rails::RpcError or
+        # GRPC::BadStatus) with the given code and, optionally, message
+        # (String or Regexp).  Returns the error.
+        def assert_grpc_error(code = nil, message = nil, &)
+          errors = Testing::Errors
+          error = assert_raises(*errors.classes, &)
+          if code
+            expected = Tonic::Rails::RpcError.normalize_code(code)
+            assert_equal(
+              errors.code_name(expected), errors.code_name(errors.code(error)),
+              "Expected gRPC status #{errors.code_name(expected).to_s.upcase}, got #{errors.describe(error)}"
+            )
+          end
+          if message
+            assert(
+              errors.message_matches?(message, errors.message(error)),
+              "Expected gRPC message #{message.inspect}, got #{errors.message(error).inspect}",
+            )
+          end
+          error
+        end
+      end
+    end
+  end
+end

data/lib/tonic/rails/testing/rspec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rspec/expectations"
+require "tonic/rails/testing"
+require "tonic/rails/testing/errors"
+
+# Matches a block that ends with a gRPC status, raised as a
+# Tonic::Rails::RpcError (Testing.call) or a GRPC::BadStatus (the official
+# client):
+#
+#   expect { Tonic::Rails::Testing.call(ItemService, :GetItem, { id: 0 }) }
+#     .to raise_grpc_error(:not_found)
+#   expect { stub.get_item(request) }.to raise_grpc_error(:invalid_argument).with_message(/name/)
+#   expect { ... }.to raise_grpc_error   # any non-OK status
+RSpec::Matchers.define :raise_grpc_error do |expected_code = nil|
+  errors = Tonic::Rails::Testing::Errors
+
+  supports_block_expectations
+
+  chain(:with_message) { |message| @expected_message = message }
+
+  match do |block|
+    @expected = expected_code && Tonic::Rails::RpcError.normalize_code(expected_code)
+    begin
+      block.call
+      @error = nil
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      raise unless errors.status?(e)
+
+      @error = e
+    end
+    return false unless @error
+
+    (@expected.nil? || errors.code(@error) == @expected) &&
+      (!defined?(@expected_message) || errors.message_matches?(@expected_message, errors.message(@error)))
+  end
+
+  description do
+    text = +"raise a gRPC error"
+    text << " #{errors.code_name(@expected).to_s.upcase}" if @expected
+    text << " with message #{@expected_message.inspect}" if defined?(@expected_message)
+    text
+  end
+
+  failure_message do
+    actual = @error ? "got #{errors.describe(@error)}" : "nothing was raised"
+    "expected block to #{description}, but #{actual}"
+  end
+
+  failure_message_when_negated do
+    "expected block not to #{description}, but got #{errors.describe(@error)}"
+  end
+end

data/lib/tonic/rails/testing.rb

@@ -28,19 +28,35 @@ module Tonic
         attr_reader :error
       end
 
-      # Response side of a call: collects encoded messages.
+      # Response side of a call: collects encoded messages and metadata.
       class Sender
-        attr_reader :messages
+        attr_reader :messages, :headers, :trailers
 
         def initialize
           @messages = []
+          @headers = {}
+          @trailers = {}
         end
 
         def push(bytes)
           @messages << bytes
         end
+
+        def send_headers(headers)
+          raise "response headers must be sent before any response message" unless @messages.empty?
+
+          @headers.merge!(headers)
+        end
+
+        def add_trailers(trailers)
+          @trailers.merge!(trailers)
+        end
       end
 
+      # What a call produced: the response (or responses, for streaming),
+      # plus the response headers and trailers as they'd go on the wire.
+      Result = Struct.new(:response, :headers, :trailers)
+
       module_function
 
       # @param service_class [Class] handler class
@@ -49,10 +65,23 @@ module Tonic
       #   request; an Array of them for client- and bidi-streaming RPCs
       # @param metadata [Hash{String=>String}]
       # @param timeout_ms [Integer, nil] simulated client deadline
+      # @param peer [Tonic::Rails::Peer, nil] simulated client (address, certificates)
       # @return [Google::Protobuf::AbstractMessage, Array] the response, or
       #   an Array of responses for server- and bidi-streaming RPCs
       # @raise [RpcError] when the handler ends the call with a status
-      def call(service_class, rpc_name, request, metadata: {}, timeout_ms: nil)
+      def call(service_class, rpc_name, request, metadata: {}, timeout_ms: nil, peer: nil)
+        invoke(service_class, rpc_name, request, metadata: metadata, timeout_ms: timeout_ms, peer: peer).response
+      end
+
+      # Like #call, but returns a Result with the response metadata too:
+      #
+      #   result = Tonic::Rails::Testing.invoke(ItemService, :GetItem, { id: 1 })
+      #   result.response.name           # => "Widget"
+      #   result.headers["x-cache"]      # => "hit"
+      #   result.trailers["x-cost-ms"]   # => "3"
+      #
+      # @return [Result]
+      def invoke(service_class, rpc_name, request, metadata: {}, timeout_ms: nil, peer: nil)
         spec = service_class.grpc_rpcs.fetch(rpc_name.to_s) do
           raise ArgumentError, "#{service_class} has no RPC #{rpc_name}"
         end
@@ -67,13 +96,15 @@ module Tonic
           reader: reader,
           sender: sender,
           timeout_ms: timeout_ms,
+          peer: peer,
         )
 
-        if spec[:response_stream]
+        response = if spec[:response_stream]
           sender.messages.map { |bytes| spec[:response].decode(bytes) }
         else
           spec[:response].decode(result)
         end
+        Result.new(response, sender.headers, sender.trailers)
       end
 
       def encode(klass, message)

data/lib/tonic/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Tonic
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/tonic-rails.rb

@@ -10,10 +10,14 @@ module Tonic
 end
 
 require "tonic/rails/version"
+require "tonic/rails/metadata"
+require "tonic/rails/peer"
 require "tonic/rails/rpc_error"
 require "tonic/rails/configuration"
 require "tonic/rails/router"
+require "tonic/rails/instrumentation"
 require "tonic/rails/base"
+require "tonic/rails/health"
 require "tonic/rails/reflection"
 require "tonic/rails/server"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tonic-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Tanous
@@ -77,11 +77,24 @@ files:
 - ext/tonic_rails_native/src/framing.rs
 - ext/tonic_rails_native/src/gvl.rs
 - ext/tonic_rails_native/src/lib.rs
+- ext/tonic_rails_native/src/log.rs
 - ext/tonic_rails_native/src/net.rs
 - ext/tonic_rails_native/src/server.rs
+- lib/generators/tonic_rails/install/install_generator.rb
+- lib/generators/tonic_rails/install/templates/tonic_rails.rb.tt
+- lib/generators/tonic_rails/service/service_generator.rb
+- lib/generators/tonic_rails/service/templates/handler.rb.tt
+- lib/generators/tonic_rails/service/templates/service.proto.tt
+- lib/generators/tonic_rails/service/templates/service_spec.rb.tt
+- lib/generators/tonic_rails/service/templates/service_test.rb.tt
+- lib/puma/plugin/tonic_rails.rb
 - lib/tonic-rails.rb
 - lib/tonic/rails/base.rb
 - lib/tonic/rails/configuration.rb
+- lib/tonic/rails/health.rb
+- lib/tonic/rails/instrumentation.rb
+- lib/tonic/rails/metadata.rb
+- lib/tonic/rails/peer.rb
 - lib/tonic/rails/railtie.rb
 - lib/tonic/rails/reflection.rb
 - lib/tonic/rails/router.rb
@@ -89,6 +102,9 @@ files:
 - lib/tonic/rails/server.rb
 - lib/tonic/rails/tasks/tonic-rails.rake
 - lib/tonic/rails/testing.rb
+- lib/tonic/rails/testing/errors.rb
+- lib/tonic/rails/testing/minitest.rb
+- lib/tonic/rails/testing/rspec.rb
 - lib/tonic/rails/version.rb
 homepage: https://github.com/CodingAnarchy/tonic-rails
 licenses: