rspec-twirp 0.1.0 → 0.2.0

data/spec/make_request_spec.rb

@@ -0,0 +1,181 @@
+describe "make_twirp_request" do
+  let(:client) { HelloWorldClient.new(conn) }
+  let(:conn) { mock_twirp_connection(response) }
+  let!(:other_client) { HelloWorldClient.new(conn) }
+  let(:request) { HelloRequest.new(name: "World", count: 3) }
+  let(:response) { HelloResponse.new(message: ["Hello", "Hello", "Hello World"]) }
+
+  def hello
+    client.hello(request)
+  end
+
+  describe "block mode" do
+    it { expect { hello }.to make_twirp_request }
+
+    it "returns nil" do
+      expect {
+        expect(hello).to be_nil
+      }.to make_twirp_request
+    end
+
+    context "with client instance matcher" do
+      it "matches a client instance" do
+        expect { hello }.to make_twirp_request(client)
+      end
+
+      it "matches a pre-existing client instance" do
+        expect {
+          other_client.hello(HelloRequest.new)
+        }.to make_twirp_request(other_client)
+      end
+
+      it "catches client mismaches" do
+        expect {
+          expect { hello }.to make_twirp_request(other_client)
+        }.to fail
+      end
+    end
+
+    context "with client class matcher" do
+      it "matches a client class" do
+        expect { hello }.to make_twirp_request(HelloWorldClient)
+      end
+
+      it "matches subclasses" do
+        expect { hello }.to make_twirp_request(Twirp::Client)
+      end
+
+      it "catches mismatches" do
+        expect {
+          expect { hello }.to make_twirp_request(GoodbyeClient)
+        }.to fail
+      end
+
+      it "catches type errors" do
+        expect {
+          expect { hello }.to make_twirp_request(Object)
+        }.to raise_error(TypeError)
+      end
+    end
+
+    context "with rpc name matcher" do
+      it { expect { hello }.to make_twirp_request(:Hello) }
+      it { expect { hello }.to make_twirp_request("Hello") }
+      it { expect { hello }.to make_twirp_request(/^He/) }
+
+      it "catches mismatches" do
+        expect {
+          expect { hello }.to make_twirp_request(:Bye)
+        }.to fail
+
+        expect {
+          expect { hello }.to make_twirp_request(/B/)
+        }.to fail
+      end
+    end
+
+    context "with input matcher" do
+      it "matches messages" do
+        expect { hello }.to make_twirp_request.with(request)
+      end
+
+      it "matches message type" do
+        expect { hello }.to make_twirp_request.with(HelloRequest)
+      end
+
+      it "matches with attrs" do
+        expect { hello }.to make_twirp_request.with(count: 3)
+      end
+
+      context "with json request" do
+        it "matches messages" do
+          expect {
+            client.hello(name: "World")
+          }.to make_twirp_request.with(HelloRequest.new(name: "World"))
+        end
+
+        it "matches attrs" do
+          expect {
+            client.hello(name: "World")
+          }.to make_twirp_request.with(name: "World")
+        end
+      end
+
+      it "catches mismatches" do
+        expect {
+          expect { hello }.to make_twirp_request.with(count: 1)
+        }.to fail
+      end
+    end
+
+    context "with service matcher" do
+      it { expect { hello }.to make_twirp_request(HelloWorldService) }
+
+      it "catches mismatches" do
+        expect {
+          expect { hello }.to make_twirp_request(GoodbyeService)
+        }.to fail
+      end
+    end
+
+    describe ".and_call_original" do
+      it "calls original" do
+        expect {
+          expect(hello).to be_a_twirp_response(response)
+        }.to make_twirp_request.and_call_original
+      end
+    end
+
+    describe ".and_return" do
+      it "returns the specified value" do
+        expect {
+          expect(hello).to be_a_twirp_response(HelloRequest.new)
+        }.to make_twirp_request.and_return(HelloRequest.new)
+      end
+
+      it "returns the specified value" do
+        expect {
+          expect(hello).to be_a_twirp_response(HelloRequest.new)
+        }.to make_twirp_request.and_return(HelloRequest)
+      end
+    end
+  end
+
+  describe "inline mode" do
+    after { hello }
+
+    it { expect(client).to make_twirp_request }
+
+    it "matches a specific rpc method" do
+      expect(client).to make_twirp_request(:hello)
+    end
+
+    it "matches a specific rpc method by rpc name" do
+      expect(client).to make_twirp_request(:Hello)
+    end
+
+    it "fails when client is not called within scope" do
+      expect_expectation_failure {
+        expect(client).to make_twirp_request
+      }
+    end
+
+    describe ".with" do
+      let(:request) { HelloRequest.new(name: "Daniel") }
+
+      it "matches the request message" do
+        expect(client).to make_twirp_request(:hello).with(request)
+      end
+
+      it "matches the request arguments" do
+        expect(client).to make_twirp_request(:hello).with(name: "Daniel")
+      end
+
+      it "fails when params don't match" do
+        expect_expectation_failure {
+          expect(client).to make_twirp_request.with(name: "Bob")
+        }
+      end
+    end
+  end
+end

data/spec/message_spec.rb

@@ -0,0 +1,83 @@
+describe "be_a_twirp_message" do
+  subject { HelloRequest.new(**attrs) }
+
+  let(:attrs) { {} }
+
+  it { is_expected.to be_a_twirp_message }
+
+  it "works with responses also" do
+    expect(HelloResponse.new).to be_a_twirp_message
+  end
+
+  it "supports compound matchers" do
+    expect([ subject ]).to include(a_twirp_message)
+  end
+
+  it "catches non-twirp subjects" do
+    expect {
+      expect(Object).to be_a_twirp_message
+    }.to fail_with /Expected a Twirp message, found Object/
+  end
+
+  it "matches a specific message type" do
+    is_expected.to be_a_twirp_message(HelloRequest)
+  end
+
+  it "catches type mismatches" do
+    expect {
+      is_expected.to be_a_twirp_message(GoodbyeRequest)
+    }.to fail_with /message of type GoodbyeRequest/
+  end
+
+  it "catches erroneous message types" do
+    expect {
+      is_expected.to be_a_twirp_message(Object)
+    }.to raise_error(TypeError, /Object/)
+  end
+
+  context "with attributes" do
+    let(:attrs) { { name: "Bob", count: 3 } }
+
+    it "can match attributes" do
+      is_expected.to be_a_twirp_message(HelloRequest, **attrs)
+    end
+
+    it "supports regex matches" do
+      is_expected.to be_a_twirp_message(name: /^B/)
+    end
+
+    it "supports range matches" do
+      is_expected.to be_a_twirp_message(count: 1..5)
+    end
+
+    it "catches mismatches" do
+      expect {
+        is_expected.to be_a_twirp_message(GoodbyeRequest, name: "Bob")
+      }.to fail_with /message of type/
+
+      expect {
+        is_expected.to be_a_twirp_message(name: "nope")
+      }.to fail_with /to have name: "nope"/
+
+      expect {
+        is_expected.to be_a_twirp_message(name: /no/)
+      }.to fail_with /to have name: \/no\//
+
+      expect {
+        is_expected.to be_a_twirp_message(count: 1)
+      }.to fail_with /to have count: 1/
+    end
+
+    it "catches the erroneous attribute matches" do
+      expect {
+        is_expected.to be_a_twirp_message(namezzz: "Bob")
+      }.to raise_error(ArgumentError, /namezzz/)
+    end
+
+    it "catches type mismatches" do
+      expect {
+        is_expected.to be_a_twirp_message(name: 123)
+      }.to raise_error(TypeError, /string field.*given Integer/)
+    end
+  end
+end

data/spec/mock_connection_spec.rb

@@ -0,0 +1,103 @@
+describe :mock_twirp_connection do
+  subject { client.bye(request) }
+
+  let(:client) { GoodbyeClient.new(conn) }
+  let(:request) { GoodbyeRequest.new }
+  let(:response) { GoodbyeResponse.new(**response_attrs) }
+  let(:response_attrs) { { message: "bye" } }
+
+  context "without a mock" do
+    let(:conn) { "http://localhost:3000/twirp/Goodbye/Bye" }
+
+    it { expect { subject }.to raise_error(Faraday::Error) }
+  end
+
+  describe "with a response instance" do
+    let(:conn) { mock_twirp_connection(response) }
+
+    it { is_expected.to be_a(Twirp::ClientResp) }
+    it { is_expected.to be_a_twirp_response }
+    it { is_expected.to be_a_twirp_response(response) }
+    it { is_expected.to be_a_twirp_response(message: "bye") }
+
+    it "catches mismatches" do
+      expect {
+        is_expected.to be_a_twirp_response(message: "nope")
+      }.to fail
+    end
+  end
+
+  describe "with a response type" do
+    let(:conn) { mock_twirp_connection(GoodbyeResponse) }
+
+    it { is_expected.to be_a_twirp_response(GoodbyeResponse) }
+
+    it "catches mismatches" do
+      expect {
+        is_expected.to be_a_twirp_response(HelloResponse)
+      }.to fail
+    end
+  end
+
+  describe "with default response" do
+    let(:conn) { mock_twirp_connection }
+
+    it { is_expected.to be_a_twirp_response(GoodbyeResponse) }
+
+    context "and with attrs" do
+      let(:conn) { mock_twirp_connection(message: "adios") }
+
+      it { is_expected.to be_a_twirp_response(message: "adios") }
+    end
+  end
+
+  describe "with an error" do
+    let(:conn) { mock_twirp_connection(error) }
+    let(:error) { Twirp::Error.not_found("nope") }
+
+    it { is_expected.to be_a_twirp_response.with_error(error) }
+
+    context "when error is symbol" do
+      let(:error) { :not_found }
+
+      it { is_expected.to be_a_twirp_response.with_error(404) }
+      it { is_expected.to be_a_twirp_response.with_error(:not_found) }
+    end
+
+    context "when error is integer" do
+      let(:error) { 500 }
+
+      it { is_expected.to be_a_twirp_response.with_error(500) }
+      it { is_expected.to be_a_twirp_response.with_error(:internal) }
+    end
+  end
+
+  describe "with a block" do
+    context "with a response object" do
+      let(:conn) { mock_twirp_connection { response } }
+
+      it { is_expected.to be_a_twirp_response(response) }
+    end
+
+    context "with response attrs" do
+      let(:conn) { mock_twirp_connection { response_attrs } }
+
+      it "determines the correct response type and incorporates the attrs" do
+        is_expected.to be_a_twirp_response(GoodbyeResponse, **response_attrs)
+      end
+    end
+
+    context "with error" do
+      let(:conn) { mock_twirp_connection { error } }
+      let(:error) { Twirp::Error.not_found("nope") }
+
+      it { is_expected.to be_a_twirp_response.with_error(error) }
+    end
+
+    context "with error code" do
+      let(:conn) { mock_twirp_connection { :not_found } }
+
+      it { is_expected.to be_a_twirp_response.with_error(:not_found) }
+    end
+  end
+end

data/spec/response_spec.rb

@@ -1,56 +1,124 @@
 describe "be_a_twirp_response" do
-  subject { HelloResponse.new(**attrs) }
+  context "with a response" do
+    subject { Twirp::ClientResp.new(response, nil) }
 
-  let(:attrs) { {} }
+    let(:response) { GoodbyeResponse.new }
 
-  it { is_expected.to be_a_twirp_response }
+    it { is_expected.to be_a_twirp_response }
 
-  it "catches non-twirp response" do
-    expect {
-      expect(Object).to be_a_twirp_response
-    }.to fail_with /Expected a Twirp response, found Object/
-  end
+    it "catches non-twirp response" do
+      expect {
+        expect(Object).to be_a_twirp_response
+      }.to fail_with /found Object/
+    end
 
-  it "matches a specific response type" do
-    is_expected.to be_a_twirp_request(HelloResponse)
-  end
+    it "matches a specific response type" do
+      is_expected.to be_a_twirp_response(GoodbyeResponse)
+    end
 
-  it "catches type mismatches" do
-    expect {
-      is_expected.to be_a_twirp_request(GoodbyeResponse)
-    }.to fail_with /request of type GoodbyeResponse/
-  end
+    it "matches a specific response" do
+      is_expected.to be_a_twirp_response(response)
+    end
+
+    it "catches type mismatches" do
+      expect {
+        is_expected.to be_a_twirp_response(HelloResponse)
+      }.to fail_with /of type HelloResponse/
+    end
+
+    it "catches erroneous response types" do
+      expect {
+        is_expected.to be_a_twirp_response(Object)
+      }.to raise_error(ArgumentError, /Object/)
+    end
+
+    context "with attributes" do
+      subject { Twirp::ClientResp.new(GoodbyeResponse.new(**attrs), nil) }
 
-  context "with attributes" do
-    let(:attrs) { { message: msg } }
-    let(:msg) { [ "Hello World" ] }
+      let(:attrs) { { message: "bye", name: "Bob" } }
 
-    it { is_expected.to be_a_twirp_response(**attrs) }
+      it "can match attributes" do
+        is_expected.to be_a_twirp_response(GoodbyeResponse, **attrs)
+      end
 
-    it "supports regex matches" do
-      is_expected.to be_a_twirp_response(message: include(/Hello/))
+      it "supports regex matches" do
+        is_expected.to be_a_twirp_response(name: /^B/)
+      end
+
+      it "catches mismatches" do
+        expect {
+          is_expected.to be_a_twirp_response(name: "nope")
+        }.to fail_with /to have name: "nope"/
+
+        expect {
+          is_expected.to be_a_twirp_response(name: /no/)
+        }.to fail_with /to have name: \/no\//
+      end
+
+      it "catches the erroneous attributes" do
+        expect {
+          is_expected.to be_a_twirp_response(namezzz: "Bob")
+        }.to raise_error(ArgumentError, /namezzz/)
+      end
+
+      it "catches type mismatches" do
+        expect {
+          is_expected.to be_a_twirp_response(name: 123)
+        }.to raise_error(TypeError, /string field.*given Integer/)
+      end
+
+      it "can't also match a specific response" do
+        expect {
+          is_expected.to be_a_twirp_response(response, name: "Bob")
+        }.to raise_error(ArgumentError, /but not both/)
+      end
     end
+  end
+
+  context "with error" do
+    subject { Twirp::ClientResp.new(nil, error) }
+
+    let(:error) { Twirp::Error.new(code, msg, meta) }
+    let(:code) { :not_found }
+    let(:msg) { "Not Found" }
+    let(:meta) { { is_meta: "true" } }
+
+    it { is_expected.to be_a_twirp_response.with_error }
+    it { is_expected.to be_a_twirp_response.with_error(code) }
+    it { is_expected.to be_a_twirp_response.with_error(msg) }
+    it { is_expected.to be_a_twirp_response.with_error(**meta) }
+    it { is_expected.to be_a_twirp_response.with_error(/Not/) }
 
     it "catches mismatches" do
       expect {
-        is_expected.to be_a_twirp_response(message: [ "" ])
-      }.to fail_with /to have message/
+        is_expected.to be_a_twirp_response.with_error(:internal)
+      }.to fail_with /code: :internal/
+    end
+  end
+
+  context "with neither response nor error" do
+    subject { Twirp::ClientResp.new(nil, nil) }
 
+    it "fails the response match" do
       expect {
-        is_expected.to be_a_twirp_response(message: [ "Hello" ])
-      }.to fail_with /to have message/
+        is_expected.to be_a_twirp_response
+      }.to fail_with /to have data/
     end
 
-    it "catches the erroneous attributes" do
+    it "fails the error match" do
       expect {
-        is_expected.to be_a_twirp_response(msg: [])
-      }.to raise_error(ArgumentError, /msg/)
+        is_expected.to be_a_twirp_response.with_error
+      }.to fail_with /to have an error/
     end
+  end
 
-    it "catches type mismatches" do
+  context "with both response and error" do
+    subject { Twirp::ClientResp.new(GoodbyeResponse.new, Twirp::Error.not_found("Not Found")) }
+
+    it "fails" do
       expect {
-        is_expected.to be_a_twirp_response(message: "Hello World")
-      }.to raise_error(ArgumentError, /Expected array/)
+        is_expected.to be_a_twirp_response(name: "Bob").with_error
+      }.to raise_error(ArgumentError, /but not both/)
     end
   end
 end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: rspec-twirp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-25 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: twirp
+  name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rspec-expectations
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,21 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: twirp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -102,14 +102,18 @@ extra_rdoc_files: []
 files:
 - lib/rspec-twirp.rb
 - lib/rspec/twirp.rb
-- lib/rspec/twirp/client_response_matcher.rb
 - lib/rspec/twirp/error_matcher.rb
-- lib/rspec/twirp/request_matcher.rb
+- lib/rspec/twirp/helpers.rb
+- lib/rspec/twirp/make_request_matcher.rb
+- lib/rspec/twirp/message_matcher.rb
+- lib/rspec/twirp/mock_client.rb
+- lib/rspec/twirp/mock_connection.rb
 - lib/rspec/twirp/response_matcher.rb
 - lib/rspec/twirp/version.rb
-- spec/client_response_spec.rb
 - spec/error_spec.rb
-- spec/request_spec.rb
+- spec/make_request_spec.rb
+- spec/message_spec.rb
+- spec/mock_connection_spec.rb
 - spec/response_spec.rb
 homepage: https://github.com/dpep/rspec-twirp_rb
 licenses:
@@ -130,12 +134,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Gem::Specification::RSpec::Twirp
 test_files:
 - spec/error_spec.rb
-- spec/request_spec.rb
+- spec/make_request_spec.rb
+- spec/message_spec.rb
+- spec/mock_connection_spec.rb
 - spec/response_spec.rb
-- spec/client_response_spec.rb

data/lib/rspec/twirp/client_response_matcher.rb

@@ -1,48 +0,0 @@
-RSpec::Matchers.define :be_a_twirp_client_response do |type = nil, **attrs|
-  chain :with_error do |*matchers, **meta_matchers|
-    # code, msg, meta
-    @with_error = [ matchers, meta_matchers ]
-  end
-
-  match do |actual|
-    # ensure type is a valid twirp request type
-    if type && !(type < Google::Protobuf::MessageExts)
-      raise ArgumentError, "Expected `type` to be a Twirp response, found: #{type}"
-    end
-
-    @fail_msg = "Expected a Twirp::ClientResp, found #{actual}"
-    return false unless actual.is_a?(Twirp::ClientResp)
-
-    # match expected response type
-    @fail_msg = "Expected a Twirp::ClientResp of type #{type}, found #{actual.data&.class}"
-    return false if type && actual.data&.class != type
-
-    if @with_error
-      unless attrs.empty?
-        raise ArgumentError, "match data attributes or error, but not both"
-      end
-
-      @fail_msg = "Expected #{actual} to have an error"
-      return false unless actual.error
-
-      matchers, meta_matchers = @with_error
-      expect(actual.error).to be_a_twirp_error(*matchers, **meta_matchers)
-    else
-      @fail_msg = "Expected #{actual} to have data"
-      return false unless actual.data
-
-      expect(actual.data).to be_a_twirp_response(**attrs)
-    end
-  rescue RSpec::Expectations::ExpectationNotMetError => err
-    @fail_msg = err.message
-    false
-  end
-
-  description do
-    type ? "a #{type} Twirp response" : "a Twirp response"
-  end
-
-  failure_message { @fail_msg }
-end
-
-RSpec::Matchers.alias_matcher :a_twirp_client_response, :be_a_twirp_client_response