VCR
1.0.0
1.0.0
  • Initial page
  • record_modes
    • :none
    • :new_episodes
    • :all
    • :once
  • test_frameworks
    • Usage with Test::Unit
    • Usage with Cucumber
    • Usage with RSpec metadata
  • request_matching
    • Matching on Headers
    • Matching on Body
    • Matching on Method
    • URI without param(s)
    • Identical requests are replayed in sequence
    • Matching on Body
    • Playback repeats
    • Matching on URI
    • Matching on Host
    • Matching on Path
    • Matching on Query string
    • Register and use a custom matcher
  • cassettes
    • exclusive cassette
    • Update content_length header
    • Error for HTTP request made when no cassette is in use
    • Naming
    • Allow Unused HTTP Interactions
    • Freezing Time
    • Decode compressed response
    • Dynamic ERB cassettes
    • Automatic Re-recording
    • Cassette format
  • configuration
    • hook_into
    • cassette_library_dir
    • Filter sensitive data
    • Ignore Request
    • Debug Logging
    • default_cassette_options
    • query_parser
    • uri_parser
    • Allow HTTP connections when no cassette
    • Preserve Exact Body Bytes
  • http_libraries
    • EM HTTP Request
    • Net::HTTP
  • hooks
    • before_playback hook
    • after_http_request hook
    • before_http_request hook
    • before_record hook
    • around_http_request hook
  • middleware
    • Faraday middleware
    • Rack
Powered by GitBook
On this page
  • Background ()
  • Previously recorded responses are replayed
  • New requests result in an error when the cassette file exists
  • New requests get recorded when there is no cassette file

Was this helpful?

  1. record_modes

:once

The :once record mode will:

  • Replay previously recorded interactions.

  • Record new interactions if there is no cassette file.

  • Cause an error to be raised for new requests if there is a cassette file.

    It is similar to the :new_episodes record mode, but will prevent new, unexpected requests from being made (i.e. because the request URI changed or whatever).

    :once is the default record mode, used when you do not set one.

Background ()

Given a file named "setup.rb" with:

$server = start_sinatra_app do
  get('/') { 'Hello' }
end

require 'vcr'

VCR.configure do |c|
  c.hook_into                :webmock
  c.cassette_library_dir     = 'cassettes'
end

And a previously recorded cassette file "cassettes/example.yml" with:

--- 
http_interactions: 
- request: 
    method: get
    uri: http://example.com/foo
    body: 
      encoding: UTF-8
      string: ""
    headers: {}
  response: 
    status: 
      code: 200
      message: OK
    headers: 
      Content-Length: 
      - "20"
    body: 
      encoding: UTF-8
      string: example.com response
    http_version: "1.1"
  recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
recorded_with: VCR 2.0.0

Previously recorded responses are replayed

Given a file named "replay_recorded_response.rb" with:

require 'setup'

VCR.use_cassette('example', :record => :once) do
  response = Net::HTTP.get_response('example.com', '/foo')
  puts "Response: #{response.body}"
end

When I run ruby replay_recorded_response.rb

Then it should pass with "Response: example.com response".

New requests result in an error when the cassette file exists

Given a file named "error_for_new_requests_when_cassette_exists.rb" with:

require 'setup'

VCR.use_cassette('example', :record => :once) do
  response = Net::HTTP.get_response('localhost', '/', $server.port)
  puts "Response: #{response.body}"
end

When I run ruby error_for_new_requests_when_cassette_exists.rb

Then it should fail with "An HTTP request has been made that VCR does not know how to handle".

New requests get recorded when there is no cassette file

Given a file named "record_new_requests.rb" with:

require 'setup'

VCR.use_cassette('example', :record => :once) do
  response = Net::HTTP.get_response('localhost', '/', $server.port)
  puts "Response: #{response.body}"
end

When I remove the file "cassettes/example.yml"

And I run ruby record_new_requests.rb

Then it should pass with "Response: Hello"

And the file "cassettes/example.yml" should contain "Hello".

Previous:allNexttest_frameworks

Last updated 5 years ago

Was this helpful?