vcr/vcr
Vcr
VCR is a Ruby library that records and replays HTTP interactions during test runs, storing them in serialized cassette files. It captures real HTTP requests and responses, then serves those recorded responses instead of making actual network calls, enabling fast and deterministic test suites that work offline.
The library provides configurable request matching, allowing comparisons based on method, URI, host, path, body, or headers to find the correct recorded response. It supports scheduled cassette re-recording to automatically refresh stored interactions at a configurable interval, keeping test data current with live services. VCR also includes sensitive data filtering to strip or replace confidential information from recordings before saving them to disk, and blocks any HTTP requests that are not explicitly allowed or recorded in a cassette.
Recorded interactions can be serialized in YAML or JSON format, with support for custom serializers. The library is installed as a Ruby gem and integrates with common Ruby testing frameworks.
Features
- HTTP Interaction Replayers - Replays recorded HTTP interactions from serialized cassette files to eliminate network calls in tests.
- Request Matching - Compares incoming HTTP requests against recorded ones using method, URI, host, path, body, or headers.
- Composable Request Matchers - Compares incoming requests against recorded ones using method, URI, host, path, body, or headers.
- HTTP Interaction Recording - Captures real HTTP requests and responses during test runs and saves them to cassette files.
- HTTP Traffic Recording - Captures real HTTP requests and responses during test runs to replay them later for fast, deterministic tests.
- Sensitive Data Redaction - Strips or replaces confidential information from recorded HTTP interactions before saving them to disk.
- Cassette Refresh Schedulers - Automatically re-records HTTP interactions at a configurable interval to keep test cassettes current.
- Cassette Refresh Schedulers - Refreshes recorded HTTP interactions automatically at a configurable interval to keep them current.
- Request Matching Engines - Matches incoming requests against recorded ones using method, URI, host, path, body, or headers.
- Unallowed HTTP Request Blockers - Prevents any HTTP request not explicitly allowed or recorded in a cassette from being executed.
- Test Request Blockers - Prevents any HTTP request not explicitly allowed or recorded in a cassette from being executed.
- Scheduled Cassette Re-recorders - Automatically refreshes recorded HTTP interactions at a configurable interval to keep test cassettes current.
- Request Interception and Blocking - Blocks unallowed HTTP requests during tests to prevent unintended network calls.
- Unallowed HTTP Request Blockers - Prevents any HTTP request not explicitly allowed or recorded in a cassette from being executed.
- Ruby Frameworks and Tools - Records and replays HTTP interactions for testing.
- Testing - Records and replays HTTP interactions.
- Testing and Service Virtualization - Library for recording and replaying HTTP interactions in test suites.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
