VCR
v-6.0.0
v-6.0.0
  • Introduction
  • Upgrade
  • Changelog
  • About These Examples
  • License
  • Contributing
  • Cassettes
    • Cassette Format
    • Naming
    • Error for HTTP Request Made When No Cassette Is in Use
    • Dynamic ERB Cassettes
    • Automatic Re-Recording
    • Exclusive Cassette
    • Update Content Length Header
    • Decode Compressed Response
    • Allow Unused HTTP Interactions
    • Freezing Time
  • Record modes
    • Once
    • New Episodes
    • None
    • All
    • Record on Error
  • Configuration
    • Cassette Library Dir
    • Hook Into
    • Default Cassette Options
    • Ignore Request
    • Filter Sensitive Data
    • Allow HTTP Connections When No Cassette
    • Debug Logging
    • Preserve Exact Body Bytes
    • URI Parser
    • Query Parser
  • Hooks
    • Before Record Hook
    • Before Playback Hook
    • Before HTTP Request Hook
    • After HTTP Request Hook
    • Around HTTP Request Hook
  • Request matching
    • Introduction
    • Matching on Method
    • Matching on URI
    • Matching on Host
    • Matching on Path
    • Matching on Query String
    • Matching on Body
    • Matching on Headers
    • Identical Requests Are Replayed in Sequence
    • Register and Use a Custom Matcher
    • URI Without Param(s)
    • Playback Repeats
    • Matching on Body as JSON
  • Test frameworks
    • Usage With Test::Unit
    • Usage With RSpec Metadata
    • Usage With Cucumber
  • Middleware
    • Rack
    • Faraday Middleware
  • HTTP Libraries
    • Net::HTTP
    • EM HTTP Request
Powered by GitBook
On this page

Was this helpful?

  1. Test frameworks

Usage With Test::Unit

To use VCR with Test::Unit, wrap the body of any test method in VCR.use_cassette.

Use VCR.use_cassette in a test

Given a file named "test/test_server.rb" with:

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

Given a file named "test/test_helper.rb" with:

require 'test/test_server' if ENV['SERVER'] == 'true'
require 'test/unit'
require 'vcr'

VCR.configure do |c|
  c.hook_into :webmock
  c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
  c.default_cassette_options = {
    :match_requests_on => [:method, :host, :path]
  }
end

And a file named "test/vcr_example_test.rb" with:

require 'test_helper'

class VCRExampleTest < Test::Unit::TestCase
  def test_use_vcr
    VCR.use_cassette('test_unit_example') do
      response = Net::HTTP.get_response('localhost', '/', $server ? $server.port : 0)
      assert_equal "Hello", response.body
    end
  end
end

And the directory "test/fixtures/vcr_cassettes" does not exist

When I set the "SERVER" environment variable to "true"

And I run ruby -Itest test/vcr_example_test.rb

Then it should pass with "1 tests, 1 assertions, 0 failures, 0 errors"

And the file "test/fixtures/vcr_cassettes/test_unit_example.yml" should contain "Hello"

When I set the "SERVER" environment variable to "false"

And I run ruby -Itest test/vcr_example_test.rb

Then it should pass with "1 tests, 1 assertions, 0 failures, 0 errors".

PreviousMatching on Body as JSONNextUsage With RSpec Metadata

Last updated 5 years ago

Was this helpful?