vcr/vcrPublic

NotificationsYou must be signed in to change notification settings
Fork511
Star6k

Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests.

License

View license

6k stars 511 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 2,146 Commits
.github		.github
docs		docs
features		features
lib		lib
script		script
spec		spec
.gitignore		.gitignore
.rspec		.rspec
.yardopts		.yardopts
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
DEVELOPMENT.md		DEVELOPMENT.md
Gemfile		Gemfile
LICENSE		LICENSE
MAINTAINERS		MAINTAINERS
README.md		README.md
Rakefile		Rakefile
Upgrade.md		Upgrade.md
cucumber.yml		cucumber.yml
vcr.gemspec		vcr.gemspec

Repository files navigation

vcr

Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests.

Help Wanted

We're looking for more maintainers. If you'd like to help maintain a well-used gem please spend some time reviewing pull requests, issues, or participating in discussions.

Usage

require'rubygems'require'test/unit'require'vcr'VCR.configuredo |config|config.cassette_library_dir="fixtures/vcr_cassettes"config.hook_into:webmockendclassVCRTest <Test::Unit::TestCasedeftest_example_dot_comVCR.use_cassette("synopsis")doresponse=Net::HTTP.get_response(URI('http://www.iana.org/domains/reserved'))assert_match/Example domains/,response.bodyendendend

Run this test once, and VCR will record the HTTP request tofixtures/vcr_cassettes/synopsis.yml. Run it again, and VCR will replay the response from iana.org when the HTTP request is made. This test is now fast (no real HTTP requests are made anymore), deterministic (the test will continue to pass, even if you are offline, or iana.org goes down for maintenance) and accurate (the response will contain the same headers and body you get from a real request). You can use a different cassette library directory (e.g., "test/vcr_cassettes").

NOTE: To avoid storing any sensitive information in cassettes, check outFilter Sensitive Data in the documentation.

Rails and Minitest:Donot use 'test/fixtures' as the directory if you're using Rails and Minitest (Rails will instead transitively load any files in that directory as models).

Features

Automatically records and replays your HTTP interactions with minimal setup/configuration code.
Supports and works with the HTTP stubbing facilities of multiple libraries. Currently, the following are supported:
Supports multiple HTTP libraries:
- Patron (when using WebMock)
- Curb (when using WebMock -- only supports Curl::Easy at the moment)
- HTTPClient (when using WebMock)
- em-http-request (when using WebMock)
- Net::HTTP (when using WebMock)
- Typhoeus (Typhoeus::Hydra, but not Typhoeus::Easy or Typhoeus::Multi)
- Excon
- Faraday
- And of course any library built on Net::HTTP, such asMechanize,HTTParty orRest Client.
Request matching is configurable based on HTTP method, URI, host, path, body and headers, or you can easily implement a custom request matcher to handle any need.
The same request can receive different responses in different tests--just use different cassettes.
The recorded requests and responses are stored on disk in a serialization format of your choice (currently YAML and JSON are built in, and you can easily implement your own custom serializer) and can easily be inspected and edited.
Dynamic responses are supported using ERB.
Optionally re-records cassettes on a configurable regular interval to keep them fresh and current.
Disables all HTTP requests that you don't explicitly allow.
Simple Cucumber integration is provided using tags.
Includes convenient RSpec macros and integration with RSpec 2 metadata.
Known to work well with many popular Ruby libraries including RSpec 1 & 2, Cucumber, Test::Unit, Capybara, Mechanize, Rest Client and HTTParty.
Includes Rack and Faraday middleware.
Supports filtering sensitive data from the response body

The docs come in two flavors:

Theusage docs contain example-based documentation (VCR's Cucumber suite, in fact). It's a good place to look when you are first getting started with VCR, or if you want to see an example of how to use a feature.
Therubydoc.info docs contain API documentation. The API docs contain detailed info about all of VCR's public API.
See theCHANGELOG doc for info about what's new and changed.

There is also a Railscast (from 2011), which will get you up and running in no-timehttp://railscasts.com/episodes/291-testing-with-vcr.

Release Policy

VCR follows the principles ofsemantic versioning. TheAPI documentation defines VCR's public API. Patch level releases contain only bug fixes. Minor releases contain backward-compatible new features. Major new releases contain backwards-incompatible changes to the public API.

Ruby Interpreter Compatibility

VCR versions 6.x are tested on the following ruby interpreters:

MRI 3.3
MRI 3.2
MRI 3.1
MRI 3.0
MRI 2.7
MRI 2.6

VCR 6.0.0 is the last version supporting >= 2.3.VCR 6.1.0 is the last version supporting >= 2.6.Upcoming releases will only explicitly support >= 2.7.

Development

Source hosted onGitHub.
Direct questions and discussions onGitHub Issues.
Report bugs/issues onGitHub Issues.
Pull requests are very welcome! Please include spec and/or feature coverage for every patch,and create a topic branch for every separate change you make.
See theContributingguide for instructions on running the specs and features.
Code quality metrics are checked byCode Climate.
Documentation is generated withYARD (cheat sheet).To generate while developing: