1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
|
Feature: Cassette format
VCR Cassettes are files that contain all of the information
about the requests and corresponding responses in a
human-readable/editable format. A cassette contains an array
of HTTP interactions, each of which has the following:
- request
- method
- uri
- body
- encoding
- string
- headers
- response
- status
- code
- message
- headers
- body
- encoding
- string
- http version
By default, VCR uses YAML to serialize this data. You can configure
VCR to use a different serializer, either on a cassette-by-cassette
basis, or as a default for all cassettes if you use the `default_cassette_options`.
VCR supports the following serializers out of the box:
- `:yaml`--Uses ruby's standard library YAML. This may use psych or syck,
depending on your ruby installation.
- `:syck`--Uses syck (the ruby 1.8 YAML engine). This is useful when using
VCR on a project that must run in environments where psych is not available
(such as on ruby 1.8), to ensure that syck is always used.
- `:psych`--Uses psych (the new ruby 1.9 YAML engine). This is useful when
you want to ensure that psych is always used.
- `:json`--Uses [multi_json](https://github.com/intridea/multi_json)
to serialize the cassette data as JSON.
- `:compressed`--Wraps the default YAML serializer with Zlib, writing
compressed cassettes to disk.
You can also register a custom serializer using:
VCR.configure do |config|
config.cassette_serializers[:my_custom_serializer] = my_serializer
end
Your serializer must implement the following methods:
- `file_extension`
- `serialize(hash)`
- `deserialize(string)`
Scenario Outline: Request/Response data is saved to disk as YAML by default
Given a file named "cassette_yaml.rb" with:
"""ruby
include_http_adapter_for("<http_lib>")
if ARGV.any?
$server = start_sinatra_app do
get('/:path') { ARGV[0] + ' ' + params[:path] }
end
end
require 'vcr'
VCR.configure do |c|
<configuration>
c.cassette_library_dir = 'cassettes'
c.before_record do |i|
i.request.uri.sub!(/:\d+/, ':7777')
end
end
VCR.use_cassette('example') do
make_http_request(:get, "http://localhost:#{$server.port}/foo", nil, 'Accept-Encoding' => 'identity')
make_http_request(:get, "http://localhost:#{$server.port}/bar", nil, 'Accept-Encoding' => 'identity')
end
"""
When I successfully run `ruby cassette_yaml.rb 'Hello'`
Then the file "cassettes/example.yml" should contain YAML like:
"""
---
http_interactions:
- request:
method: get
uri: http://localhost:7777/foo
body:
encoding: UTF-8
string: ""
headers:
Accept-Encoding:
- identity
response:
status:
code: 200
message: OK
headers:
Content-Type:
- text/html;charset=utf-8
Content-Length:
- "9"
body:
encoding: UTF-8
string: Hello foo
http_version: "1.1"
recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
- request:
method: get
uri: http://localhost:7777/bar
body:
encoding: UTF-8
string: ""
headers:
Accept-Encoding:
- identity
response:
status:
code: 200
message: OK
headers:
Content-Type:
- text/html;charset=utf-8
Content-Length:
- "9"
body:
encoding: UTF-8
string: Hello bar
http_version: "1.1"
recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
recorded_with: VCR 2.0.0
"""
Examples:
| configuration | http_lib |
| c.hook_into :webmock | net/http |
| c.hook_into :webmock | httpclient |
| c.hook_into :webmock | patron |
| c.hook_into :webmock | curb |
| c.hook_into :webmock | em-http-request |
| c.hook_into :webmock | typhoeus |
| c.hook_into :typhoeus | typhoeus |
| c.hook_into :excon | excon |
| c.hook_into :faraday | faraday (w/ net_http) |
Scenario: Request/Response data can be saved as JSON
Given a file named "cassette_json.rb" with:
"""ruby
include_http_adapter_for("net/http")
$server = start_sinatra_app do
get('/:path') { ARGV[0] + ' ' + params[:path] }
end
require 'vcr'
VCR.configure do |c|
c.hook_into :webmock
c.cassette_library_dir = 'cassettes'
c.before_record do |i|
i.request.uri.sub!(/:\d+/, ':7777')
end
c.default_cassette_options = {
:match_requests_on => [:method, :host, :path]
}
end
VCR.use_cassette('example', :serialize_with => :json) do
puts response_body_for(:get, "http://localhost:#{$server.port}/foo", nil, 'Accept-Encoding' => 'identity')
puts response_body_for(:get, "http://localhost:#{$server.port}/bar", nil, 'Accept-Encoding' => 'identity')
end
"""
When I run `ruby cassette_json.rb 'Hello'`
Then the file "cassettes/example.json" should contain JSON like:
"""json
{
"http_interactions": [
{
"response": {
"body": {
"encoding": "UTF-8",
"string": "Hello foo"
},
"http_version": null,
"status": { "code": 200, "message": "OK" },
"headers": {
"Date": [ "Thu, 27 Oct 2011 06:16:31 GMT" ],
"Content-Type": [ "text/html;charset=utf-8" ],
"Content-Length": [ "9" ],
"Server": [ "WEBrick/1.3.1 (Ruby/1.8.7/2011-06-30)" ],
"Connection": [ "Keep-Alive" ]
}
},
"request": {
"uri": "http://localhost:7777/foo",
"body": {
"encoding": "UTF-8",
"string": ""
},
"method": "get",
"headers": {
"Accept-Encoding": [ "identity" ]
}
},
"recorded_at": "Tue, 01 Nov 2011 04:58:44 GMT"
},
{
"response": {
"body": {
"encoding": "UTF-8",
"string": "Hello bar"
},
"http_version": null,
"status": { "code": 200, "message": "OK" },
"headers": {
"Date": [ "Thu, 27 Oct 2011 06:16:31 GMT" ],
"Content-Type": [ "text/html;charset=utf-8" ],
"Content-Length": [ "9" ],
"Server": [ "WEBrick/1.3.1 (Ruby/1.8.7/2011-06-30)" ],
"Connection": [ "Keep-Alive" ]
}
},
"request": {
"uri": "http://localhost:7777/bar",
"body": {
"encoding": "UTF-8",
"string": ""
},
"method": "get",
"headers": {
"Accept-Encoding": [ "identity" ]
}
},
"recorded_at": "Tue, 01 Nov 2011 04:58:44 GMT"
}
],
"recorded_with": "VCR 2.0.0"
}
"""
When I run `ruby cassette_json.rb`
Then it should pass with:
"""
Hello foo
Hello bar
"""
Scenario: Request/Response data can be saved as compressed YAML
Given a file named "cassette_compressed.rb" with:
"""ruby
include_http_adapter_for("net/http")
$server = start_sinatra_app do
get('/:path') { ARGV[0] + ' ' + params[:path] }
end
require 'vcr'
VCR.configure do |c|
c.hook_into :webmock
c.cassette_library_dir = 'cassettes'
c.before_record do |i|
i.request.uri.sub!(/:\d+/, ':7777')
end
c.default_cassette_options = {
:match_requests_on => [:method, :host, :path]
}
end
VCR.use_cassette('example', :serialize_with => :compressed) do
puts response_body_for(:get, "http://localhost:#{$server.port}/foo", nil, 'Accept-Encoding' => 'identity')
puts response_body_for(:get, "http://localhost:#{$server.port}/bar", nil, 'Accept-Encoding' => 'identity')
end
"""
When I run `ruby cassette_compressed.rb 'Hello'`
Then the file "cassettes/example.gz" should contain compressed YAML like:
"""
---
http_interactions:
- request:
method: get
uri: http://localhost:7777/foo
body:
encoding: UTF-8
string: ""
headers:
Accept-Encoding:
- identity
response:
status:
code: 200
message: OK
headers:
Content-Type:
- text/html;charset=utf-8
Content-Length:
- "9"
body:
encoding: UTF-8
string: Hello foo
recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
- request:
method: get
uri: http://localhost:7777/bar
body:
encoding: UTF-8
string: ""
headers:
Accept-Encoding:
- identity
response:
status:
code: 200
message: OK
headers:
Content-Type:
- text/html;charset=utf-8
Content-Length:
- "9"
body:
encoding: UTF-8
string: Hello bar
recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
recorded_with: VCR 2.0.0
"""
When I run `ruby cassette_compressed.rb`
Then it should pass with:
"""
Hello foo
Hello bar
"""
Scenario: Request/Response data can be saved using a custom serializer
Given a file named "cassette_ruby.rb" with:
"""ruby
include_http_adapter_for("net/http")
$server = start_sinatra_app do
get('/:path') { ARGV[0] + ' ' + params[:path] }
end
require 'vcr'
# purely for demonstration purposes; obviously, don't actually
# use ruby #inspect / #eval for your serialization...
ruby_serializer = Object.new
class << ruby_serializer
def file_extension; "ruby"; end
def serialize(hash); hash.inspect; end
def deserialize(string); eval(string); end
end
VCR.configure do |c|
c.hook_into :webmock
c.cassette_library_dir = 'cassettes'
c.cassette_serializers[:ruby] = ruby_serializer
c.before_record do |i|
i.request.uri.sub!(/:\d+/, ':7777')
end
c.default_cassette_options = {
:match_requests_on => [:method, :host, :path]
}
end
VCR.use_cassette('example', :serialize_with => :ruby) do
puts response_body_for(:get, "http://localhost:#{$server.port}/foo", nil, 'Accept-Encoding' => 'identity')
puts response_body_for(:get, "http://localhost:#{$server.port}/bar", nil, 'Accept-Encoding' => 'identity')
end
"""
When I run `ruby cassette_ruby.rb 'Hello'`
Then the file "cassettes/example.ruby" should contain ruby like:
"""
{"http_interactions"=>
[{"request"=>
{"method"=>"get",
"uri"=>"http://localhost:7777/foo",
"body"=>{"encoding"=>"UTF-8", "string"=>""},
"headers"=>{"Accept"=>["*/*"], "Accept-Encoding"=>["identity"], "User-Agent"=>["Ruby"]}},
"response"=>
{"status"=>{"code"=>200, "message"=>"OK "},
"headers"=>
{"Content-Type"=>["text/html;charset=utf-8"],
"Content-Length"=>["9"],
"Connection"=>["Keep-Alive"]},
"body"=>{"encoding"=>"UTF-8", "string"=>"Hello foo"},
"http_version"=>nil},
"recorded_at"=>"Tue, 01 Nov 2011 04:58:44 GMT"},
{"request"=>
{"method"=>"get",
"uri"=>"http://localhost:7777/bar",
"body"=>{"encoding"=>"UTF-8", "string"=>""},
"headers"=>{"Accept"=>["*/*"], "Accept-Encoding"=>["identity"], "User-Agent"=>["Ruby"]}},
"response"=>
{"status"=>{"code"=>200, "message"=>"OK "},
"headers"=>
{"Content-Type"=>["text/html;charset=utf-8"],
"Content-Length"=>["9"],
"Connection"=>["Keep-Alive"]},
"body"=>{"encoding"=>"UTF-8", "string"=>"Hello bar"},
"http_version"=>nil},
"recorded_at"=>"Tue, 01 Nov 2011 04:58:44 GMT"}],
"recorded_with"=>"VCR 2.0.0"}
"""
When I run `ruby cassette_ruby.rb`
Then it should pass with:
"""
Hello foo
Hello bar
"""
|
