tcr 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 228eadaf6c734a9281952492ab146d7fee17e246
-  data.tar.gz: 64045b81372a13b4d957ea02bd266b5c7c443d3a
+SHA256:
+  metadata.gz: ab0a471bccd0a80a5d75bec6909dc521072b2ad666af34935f1d6ab596d9f2b4
+  data.tar.gz: eb6d9817d928173edd5354dc206fe7dd3e35a0f38ffde356e0e6e233e0a58431
 SHA512:
-  metadata.gz: 1210aebd2ec013acb28546caeae5b29022e8cd7ddee1cb9e7814140c86d6e8fcc351798b10b2d2637baf104b7617719d3f28001bb3cde4cfee4821fa697625a5
-  data.tar.gz: d05fc665286ace6c2b77c6f30890aff288e872344da943a2f5c09afcf468c8c7b82acbabff10f227092fc6322aabbbf9cf82a0c10cdc758b07e004533110d84f
+  metadata.gz: cedcebdd9373876a73534581ef013945ab20912ba86b71375b14de26043c135420f5140a2c1cf9d920afc9eacaa9b2f567d173c5d2525aa60db19ac97f43f606
+  data.tar.gz: d41afdda3c2d24c85e461db3247fed88ed5c9019e0929251c03b199b37dc3dc7a261796c3266041aea90ffbdf9b0c6053a2e627a9e7b7258382430db85df66a9

data/.github/workflows/tcr.yml

@@ -0,0 +1,47 @@
+name: TCR Spec Suite
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - "2.0.0"
+          - "2.1.9"
+          - "2.2.10"
+          - "2.3.7"
+          - "2.4.4"
+          - "2.5.1"
+          - "2.7.3"
+          - "3.0.1"
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Initial setup
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rspec
+
+  testall:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    name: Test (matrix)
+    needs: [test]
+    steps:
+      - name: Check status of all test runs
+        if: ${{ needs.test.result != 'success' }}
+        run: exit 1

data/lib/tcr/recordable_tcp_socket.rb

@@ -5,46 +5,55 @@ require 'thread'
 
 module TCR
   class RecordableTCPSocket
-    attr_reader :live, :socket
-    attr_accessor :recording
+    attr_reader :live, :socket, :recording
 
     def initialize(address, port, cassette)
       raise TCR::NoCassetteError.new unless TCR.cassette
 
       @read_lock = Queue.new
+      @recording = cassette.next_session
+      @live = cassette.recording?
 
-      if cassette.recording?
-        @live = true
-        @socket = TCPSocket.real_open(address, port)
+      if live
+        begin
+          @socket = TCPSocket.real_open(address, port)
+        rescue => e
+          recording << ["error", Marshal.dump(e)]
+          raise
+        end
       else
-        @live   = false
         @closed = false
+        check_recording_for_errors
       end
-      @recording = cassette.next_session
     end
 
-    def read(bytes)
-      _read(:read, bytes)
+    def read(*args)
+      _read(:read, args)
     end
 
     def getc(*args)
-      _read(:getc, *args)
+      _read(:getc, args)
     end
 
     def gets(*args)
-      _read(:gets, *args)
+      _read(:gets, args)
     end
 
     def read_nonblock(*args)
-      _read(:read_nonblock, *args, blocking: false)
+      _read(:read_nonblock, args, blocking: false)
+    end
+
+    def print(str, *args)
+      _write(:print, str, args)
     end
 
-    def print(str)
-      _write(:print, str)
+    def write(str, *args)
+      _write(:write, str, args)
+      str.length
     end
 
-    def write(str)
-      _write(:write, str)
+    def write_nonblock(str, *args)
+      _write(:write_nonblock, str, args)
       str.length
     end
 
@@ -75,6 +84,10 @@ module TCR
 
     private
 
+    def check_recording_for_errors
+      raise Marshal.load(recording.first.last) if recording.first.first == "error"
+    end
+
     def _intercept_socket
       if @socket
         @socket = yield @socket
@@ -91,10 +104,10 @@ module TCR
       @read_lock << 1
     end
 
-    def _write(method, data)
+    def _write(method, data, args)
       if live
         payload = data.dup if !data.is_a?(Symbol)
-        @socket.__send__(method, payload)
+        _delegate_call(method, args.unshift(payload))
         recording << ["write", data.dup]
       else
         direction, data = recording.shift
@@ -103,14 +116,11 @@ module TCR
       end
     end
 
-    def _read(method, *args)
-      blocking = true
-      if args.last.is_a?(::Hash)
-        blocking = args.pop.fetch(:blocking, true)
-      end
+    def _read(method, args, opts = {})
+      blocking = opts.fetch(:blocking, true)
 
       if live
-          data    = @socket.__send__(method, *args)
+          data    = _delegate_call(method, args)
           payload = data.dup if !data.is_a?(Symbol)
           recording << ["read", payload]
       else
@@ -122,6 +132,15 @@ module TCR
       data
     end
 
+    def _delegate_call(method, args)
+      if RUBY_VERSION >= "2.7" && Hash === args.last
+        kwargs = args.pop
+        @socket.__send__(method, *args, **kwargs)
+      else
+        @socket.__send__(method, *args)
+      end
+    end
+
     def _ensure_direction(desired, actual)
       raise TCR::DirectionMismatchError.new("Expected to '#{desired}' but next in recording was '#{actual}'") unless desired == actual
     end
@@ -138,6 +157,14 @@ module TCR
       end
     end
 
+    def ssl_version
+      ""
+    end
+
+    def cipher
+      []
+    end
+
     def sync_close=(arg)
       true
     end
@@ -161,6 +188,9 @@ module TCR
     def session=(args)
     end
 
+    def hostname=(args)
+    end
+
     def io
       self
     end

data/lib/tcr/version.rb

@@ -1,3 +1,3 @@
 module TCR
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/tcr.rb

@@ -88,11 +88,11 @@ class Socket
   class << self
     alias_method :real_tcp, :tcp
 
-    def tcp(host, port, socket_opts)
+    def tcp(host, port, *socket_opts)
       if TCR.configuration.hook_tcp_ports.include?(port)
         TCR::RecordableTCPSocket.new(host, port, TCR.cassette)
       else
-        real_tcp(host, port, socket_opts)
+        real_tcp(host, port, *socket_opts)
       end
     end
   end

data/spec/spec_helper.rb

@@ -19,7 +19,6 @@ end
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

data/spec/tcr_spec.rb

@@ -25,54 +25,91 @@ RSpec.describe TCR do
   end
 
   describe ".configuration" do
-     it "has a default cassette location configured" do
-       TCR.configuration.cassette_library_dir.should == "fixtures/tcr_cassettes"
-     end
+    it "has a default cassette location configured" do
+      TCR.configuration.cassette_library_dir.should == "fixtures/tcr_cassettes"
+    end
 
-     it "has an empty list of hook ports by default" do
-       TCR.configuration.hook_tcp_ports.should == []
-     end
+    it "has an empty list of hook ports by default" do
+      TCR.configuration.hook_tcp_ports.should == []
+    end
 
-     it "defaults to erroring on read/write mismatch access" do
-       TCR.configuration.block_for_reads.should be_falsey
-     end
+    it "defaults to erroring on read/write mismatch access" do
+      TCR.configuration.block_for_reads.should be_falsey
+    end
 
-     it "defaults to hit all to false" do
-       TCR.configuration.hit_all.should be_falsey
-     end
-   end
+    it "defaults to hit all to false" do
+      TCR.configuration.hit_all.should be_falsey
+    end
+  end
 
   describe ".configure" do
-    it "configures cassette location" do
-      expect {
-        TCR.configure { |c| c.cassette_library_dir = "some/dir" }
-      }.to change{ TCR.configuration.cassette_library_dir }.from("fixtures/tcr_cassettes").to("some/dir")
+    context "with cassette_library_dir option" do
+      it "configures cassette location" do
+        expect {
+          TCR.configure { |c| c.cassette_library_dir = "some/dir" }
+        }.to change{ TCR.configuration.cassette_library_dir }.from("fixtures/tcr_cassettes").to("some/dir")
+      end
     end
 
-    it "configures tcp ports to hook" do
-      expect {
-        TCR.configure { |c| c.hook_tcp_ports = [2525] }
-      }.to change{ TCR.configuration.hook_tcp_ports }.from([]).to([2525])
+    context "with hook_tcp_ports option" do
+      it "configures tcp ports to hook" do
+        expect {
+          TCR.configure { |c| c.hook_tcp_ports = [2525] }
+        }.to change{ TCR.configuration.hook_tcp_ports }.from([]).to([2525])
+      end
     end
 
-    it "configures allowing a blocking read mode" do
-      expect {
+    context "with block_for_reads option" do
+      before(:each) {
+        TCR.configure { |c|
+          c.hook_tcp_ports = [9999]
+          c.cassette_library_dir = '.'
+        }
+      }
+
+      it "configures allowing a blocking read mode" do
+        expect {
+          TCR.configure { |c| c.block_for_reads = true }
+        }.to change{ TCR.configuration.block_for_reads }.from(false).to(true)
+      end
+
+      it "blocks read thread until data is available instead of raising mismatch error" do
         TCR.configure { |c| c.block_for_reads = true }
-      }.to change{ TCR.configuration.block_for_reads }.from(false).to(true)
-    end
+        reads = Queue.new
 
-    it "configures to check if all sesstions was hit" do
-      expect {
-        TCR.configure { |c| c.hit_all = true }
-      }.to change{ TCR.configuration.hit_all }.from(false).to(true)
+        TCR.use_cassette("spec/fixtures/block_for_reads") do
+          sock = TCPSocket.open("google.com", 9999)
+
+          t = Thread.new do
+            reads << sock.gets
+          end
+
+          expect(reads.size).to eq(0)
+          sock.print("hello\n")
+          t.value
+          expect(reads.size).to eq(1)
+        end
+      end
+
+      context "when disabled" do
+        it "raises mismatch error" do
+          TCR.use_cassette("spec/fixtures/block_for_reads") do
+            sock = TCPSocket.open("google.com", 9999)
+            expect {
+              Timeout::timeout(1) { sock.gets }
+            }.to raise_error(TCR::DirectionMismatchError)
+          end
+        end
+      end
     end
-  end
 
-  it "raises an error if you connect to a hooked port without using a cassette" do
-    TCR.configure { |c| c.hook_tcp_ports = [2525] }
-    expect {
-      tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
-    }.to raise_error(TCR::NoCassetteError)
+    context "with hit_all option" do
+      it "configures to check if all sessions were hit" do
+        expect {
+          TCR.configure { |c| c.hit_all = true }
+        }.to change{ TCR.configuration.hit_all }.from(false).to(true)
+      end
+    end
   end
 
   describe ".turned_off" do
@@ -98,44 +135,6 @@ RSpec.describe TCR do
     end
   end
 
-  describe "block_for_reads" do
-    before(:each) {
-      TCR.configure { |c|
-        c.hook_tcp_ports = [9999]
-        c.cassette_library_dir = '.'
-      }
-    }
-
-    it "blocks read thread until data is available instead of raising mismatch error" do
-      TCR.configure { |c| c.block_for_reads = true }
-      reads = Queue.new
-
-      TCR.use_cassette("spec/fixtures/block_for_reads") do
-        sock = TCPSocket.open("google.com", 9999)
-
-        t = Thread.new do
-          reads << sock.gets
-        end
-
-        expect(reads.size).to eq(0)
-        sock.print("hello\n")
-        t.value
-        expect(reads.size).to eq(1)
-      end
-    end
-
-    context "when disabled" do
-      it "raises mismatch error" do
-        TCR.use_cassette("spec/fixtures/block_for_reads") do
-          sock = TCPSocket.open("google.com", 9999)
-          expect {
-            Timeout::timeout(1) { sock.gets }
-          }.to raise_error(TCR::DirectionMismatchError)
-        end
-      end
-    end
-  end
-
   describe ".use_cassette" do
     before(:each) {
       TCR.configure { |c|
@@ -144,6 +143,13 @@ RSpec.describe TCR do
       }
     }
 
+    it "MUST be used when connecting to hooked ports (or else raises an error)" do
+      TCR.configure { |c| c.hook_tcp_ports = [2525] }
+      expect {
+        tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
+      }.to raise_error(TCR::NoCassetteError)
+    end
+
     it "requires a block to call" do
       expect {
         TCR.use_cassette("test")
@@ -416,9 +422,9 @@ RSpec.describe TCR do
       it "raises an error if you try to playback more sessions than you previously recorded" do
         expect {
           TCR.use_cassette("spec/fixtures/multitest-smtp") do
-            smtp = Net::SMTP.start("smtp.mandrillapp.com", 2525)
-            smtp = Net::SMTP.start("mail.smtp2go.com", 2525)
-            smtp = Net::SMTP.start("mail.smtp2go.com", 2525)
+            smtp = Net::SMTP.start("smtp.mandrillapp.com", 2525, starttls: false)
+            smtp = Net::SMTP.start("mail.smtp2go.com", 2525, starttls: false)
+            smtp = Net::SMTP.start("mail.smtp2go.com", 2525, starttls: false)
           end
         }.to raise_error(TCR::NoMoreSessionsError)
       end
@@ -426,21 +432,47 @@ RSpec.describe TCR do
       it "raises an error if you try to playback less sessions than you previously recorded" do
         expect {
           TCR.use_cassette("spec/fixtures/multitest-extra-smtp", hit_all: true) do
-            smtp = Net::SMTP.start("smtp.mandrillapp.com", 2525)
+            smtp = Net::SMTP.start("smtp.mandrillapp.com", 2525, starttls: false)
           end
         }.to raise_error(TCR::ExtraSessionsError)
       end
     end
   end
 
+  context "when TCPSocket.open raises an error during recording" do
+    before do
+      TCR.configure { |c|
+        c.format = "yaml" # JSON borks on binary strings
+        c.hook_tcp_ports = [143]
+        c.cassette_library_dir = "."
+      }
+
+      # record cassette
+      TCR.use_cassette("test") do
+        expect { Net::IMAP.new(nil) }.to raise_error(SystemCallError)
+      end
+    end
+
+    it "records error to cassette" do
+      expect(File.exist?('test.yaml')).to be(true)
+      expect(File.read('test.yaml')).not_to be_empty
+    end
+
+    it "re-raises the error during replay" do
+      TCR.use_cassette("test") do
+        expect { Net::IMAP.new(nil) }.to raise_error(SystemCallError)
+      end
+    end
+  end
+
   it "replaces sockets created with Socket.tcp" do
     TCR.configure { |c|
-      c.hook_tcp_ports = [23]
+      c.hook_tcp_ports = [80]
       c.cassette_library_dir = "."
     }
 
     TCR.use_cassette("test") do
-      sock = Socket.tcp("towel.blinkenlights.nl", 23, {})
+      sock = Socket.tcp("google.com", 80)
       expect(sock).to be_a(TCR::RecordableTCPSocket)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcr
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Rob Forman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-20 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -87,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tcr.yml"
 - ".gitignore"
 - ".rvmrc"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -118,7 +118,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,9 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.4.7
+signing_key:
 specification_version: 4
 summary: TCR is a lightweight VCR for TCP sockets.
 test_files:

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - "2.0.0"
-  - "2.1.10"
-  - "2.2.10"
-  - "2.3.7"
-  - "2.4.4"
-  - "2.5.1"
-before_install:
-  - gem install bundler
-script: bundle exec rspec