This is a small tool for setting up a lightweight stub server that replays previously recorded VCR cassettes.
Usually VCR is used internally while running the test suite. In that case, the library is responsible for intercepting HTTP requests.
But in some cases, it can be useful to be able to spin up a live HTTP server which given a preexisting VCR cassette, would respond to each request with its matching recorded response.
One such case might come when implementing usage of Pact, where vcr-stub-server can be used to prevent the provider service from making requests to external services during pact verification. This project was inspired by Pact's own Stub Service.
-
Unfortunately, there isn't one standard for cassette YAML files, each VCR implementation does it differently. For example, cassette YAML files created by VCR.py won't be compatible with YAML files created by the Ruby implementation of VCR, etc.
Therfore this tool currently only supports VCR.py, using the library's own implementation of parsing the YAML files.
-
The recorded requests in your YAML cassette file must all be made to the same host.
$ pip install vcr-stub-server
Once the package is installed, use the vcr-stub-server command to spin up your stub server.
$ vcr-stub-server path/to/vcr_cassette.yml
Bug reports and pull requests are welcome on GitHub at https://github.com/thatguysimon/vcr-stub-server. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.