File: typhoeus_spec.rb

package info (click to toggle)
ruby-faraday-typhoeus 1.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 196 kB
  • sloc: ruby: 422; sh: 18; makefile: 4
file content (352 lines) | stat: -rw-r--r-- 9,845 bytes parent folder | download
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
# frozen_string_literal: true

RSpec.describe Faraday::Adapter::Typhoeus do
  features :request_body_on_query_methods,
           :reason_phrase_parse,
           # transparent compression IS supported but tests will fail b/c
           # webmock is unaware of this
           #  :compression,
           :streaming,
           :trace_method

  # Runs the tests provide by Faraday, according to the features specified above.
  it_behaves_like 'an adapter'

  let(:base_url) { 'http://example.com' }
  let(:adapter) { described_class.new(nil) }
  let(:request) { Typhoeus::Request.new(base_url) }

  # TODO: context "when a response is stubbed"

  describe '#initialize' do
    let(:request) { adapter.method(:typhoeus_request).call({}) }

    context 'when no options specified' do
      let(:adapter) { described_class.new(nil) }
      it 'defers to curl on accepted encodings' do
        expect(request.options[:accept_encoding]).to eq('')
      end
    end

    context 'when typhoeus request options specified' do
      let(:adapter) { described_class.new(nil, { forbid_reuse: true, maxredirs: 1 }) }

      it 'should set options for request' do
        expect(request.options[:forbid_reuse]).to be_truthy
        expect(request.options[:maxredirs]).to eq(1)
      end
    end
  end

  describe '#perform_request' do
    let(:env) { {} }

    context 'when body' do
      let(:env) { { body: double(read: 'body') } }

      it 'reads body' do
        expect(adapter.method(:read_body).call(env)).to eq('body')
      end
    end

    context 'parallel_manager' do
      context 'when given' do
        let(:env) { { parallel_manager: double(queue: true), ssl: {}, request: {} } }

        it 'uses' do
          adapter.method(:perform_request).call(env)
        end
      end

      context 'when not given' do
        let(:env) { { method: :get, ssl: {}, request: {} } }

        it 'falls back to single' do
          expect(Typhoeus::Request).to receive(:new).and_return(double(options: {}, on_complete: [], run: true))
          adapter.method(:perform_request).call(env)
        end
      end
    end
  end

  describe '#request' do
    let(:env) do
      { url: 'url', method: :get, body: 'body', request_headers: {}, ssl: {}, request: {} }
    end

    let(:request) { adapter.method(:request).call(env) }

    it 'returns request' do
      expect(request).to be_a(Typhoeus::Request)
    end

    it 'sets url' do
      expect(request.base_url).to eq('url')
    end

    it 'sets http method' do
      expect(request.original_options[:method]).to eq(:get)
    end

    it 'sets body' do
      expect(request.original_options[:body]).to eq('body')
    end

    it 'sets headers' do
      expect(request.original_options[:headers]).to eq({})
    end

    it 'sets on_complete callback' do
      expect(request.on_complete.size).to eq(1)
    end
  end

  describe '#configure_socket' do
    let(:env) { { request: { bind: { host: 'interface' } } } }

    before { adapter.method(:configure_socket).call(request, env) }

    context 'when host' do
      it 'sets interface' do
        expect(request.options[:interface]).to eq('interface')
      end
    end
  end

  describe '#configure_timeout' do
    before { adapter.method(:configure_timeout).call(request, env) }

    context 'when timeout' do
      let(:env) { { request: { timeout: 1 } } }

      it 'sets timeout_ms' do
        expect(request.options[:timeout_ms]).to eq(1000)
      end
    end

    context 'when open_timeout' do
      let(:env) { { request: { open_timeout: 1 } } }

      it 'sets connecttimeout_ms' do
        expect(request.options[:connecttimeout_ms]).to eq(1000)
      end
    end
  end

  describe '#configure_proxy' do
    before { adapter.method(:configure_proxy).call(request, env) }

    context 'when proxy' do
      let(:env) { { request: { proxy: { uri: double(scheme: 'http', host: 'localhost', port: '3001') } } } }

      it 'sets proxy' do
        expect(request.options[:proxy]).to eq('http://localhost:3001')
      end

      context 'when username and password' do
        let(:env) do
          { request: { proxy: {
            uri: double(scheme: 'http', host: :a, port: :b),
            user: 'a',
            password: 'b'
          } } }
        end

        it 'sets proxyuserpwd' do
          expect(request.options[:proxyuserpwd]).to eq('a:b')
        end
      end
    end
  end

  describe '#configure_ssl' do
    before { adapter.method(:configure_ssl).call(request, env) }

    context 'when version' do
      let(:env) { { ssl: { version: 'a' } } }

      it 'sets sslversion' do
        expect(request.options[:sslversion]).to eq('a')
      end
    end

    context 'when client_cert' do
      let(:env) { { ssl: { client_cert: 'a' } } }

      it 'sets sslcert' do
        expect(request.options[:sslcert]).to eq('a')
      end
    end

    context 'when client_key' do
      let(:env) { { ssl: { client_key: 'a' } } }

      it 'sets sslkey' do
        expect(request.options[:sslkey]).to eq('a')
      end
    end

    context 'when ca_file' do
      let(:env) { { ssl: { ca_file: 'a' } } }

      it 'sets cainfo' do
        expect(request.options[:cainfo]).to eq('a')
      end
    end

    context 'when ca_path' do
      let(:env) { { ssl: { ca_path: 'a' } } }

      it 'sets capath' do
        expect(request.options[:capath]).to eq('a')
      end
    end

    context 'when client_cert_passwd' do
      let(:env) { { ssl: { client_cert_passwd: 'a' } } }

      it 'sets keypasswd to the value of client_cert_passwd' do
        expect(request.options[:keypasswd]).to eq('a')
      end
    end

    context 'when client_certificate_password' do
      let(:env) { { ssl: { client_certificate_password: 'a' } } }

      it 'sets keypasswd to the value of client_cert_passwd' do
        expect(request.options[:keypasswd]).to eq('a')
      end
    end

    context 'when no client_cert_passwd' do
      let(:env) { { ssl: {} } }

      it 'does not set keypasswd on options' do
        expect(request.options).not_to have_key :keypasswd
      end
    end

    context 'when verify is false' do
      let(:env) { { ssl: { verify: false } } }

      it 'sets ssl_verifyhost to 0' do
        expect(request.options[:ssl_verifyhost]).to eq(0)
      end

      it 'sets ssl_verifypeer to false' do
        expect(request.options[:ssl_verifypeer]).to be_falsey
      end
    end

    context 'when verify is true' do
      let(:env) { { ssl: { verify: true } } }

      it 'sets ssl_verifyhost to 2' do
        expect(request.options[:ssl_verifyhost]).to eq(2)
      end

      it 'sets ssl_verifypeer to true' do
        expect(request.options[:ssl_verifypeer]).to be_truthy
      end
    end
  end

  describe '#parallel?' do
    context 'when parallel_manager' do
      let(:env) { { parallel_manager: true } }

      it 'returns true' do
        expect(adapter.method(:parallel?).call(env)).to be_truthy
      end
    end

    context 'when no parallel_manager' do
      let(:env) { { parallel_manager: nil } }

      it 'returns false' do
        expect(adapter.method(:parallel?).call(env)).to be_falsey
      end
    end
  end

  context 'requests' do
    let(:http_method) { :get }
    let!(:request_stub) { stub_request(http_method, base_url) }

    let(:conn) do
      Faraday.new(url: base_url) do |faraday|
        faraday.adapter :typhoeus
      end
    end

    after do
      expect(request_stub).to have_been_requested unless request_stub.disabled?
    end

    context 'when parallel' do
      it 'returns a faraday response' do
        response = nil
        conn.in_parallel { response = conn.get('/') }
        expect(response).to be_a(Faraday::Response)
      end

      it 'succeeds' do
        response = nil
        conn.in_parallel { response = conn.get('/') }
        expect(response.status).to be(200)
      end
    end

    context 'when not parallel' do
      it 'returns a faraday response' do
        expect(conn.get('/')).to be_a(Faraday::Response)
      end

      it 'succeeds' do
        expect(conn.get('/').status).to be(200)
      end

      it 'sets timings' do
        response = conn.get('/')
        # TODO: make these not-nil after https://github.com/bblimke/webmock/pull/1038 lands
        expect(response.env.custom_members[:typhoeus_timings]).to eq({
                                                                       appconnect: nil,
                                                                       connect: nil,
                                                                       namelookup: nil,
                                                                       pretransfer: nil,
                                                                       redirect: nil,
                                                                       starttransfer: nil,
                                                                       total: nil
                                                                     })
      end
    end

    context 'failed connection' do
      before do
        request_stub.to_timeout
      end

      context 'when parallel' do
        it "isn't successful" do
          response = nil
          conn.in_parallel { response = conn.get('/') }
          expect(response.success?).to be_falsey
        end

        it 'translates the response code into an error message' do
          response = nil
          conn.in_parallel { response = conn.get('/') }

          expect(response.env[:typhoeus_timed_out]).to be true
          expect(response.env[:typhoeus_return_message]).to eq('Timeout was reached')
        end
      end

      context 'when not parallel' do
        it 'raises an error' do
          expect { conn.get('/') }.to raise_error(Faraday::TimeoutError, 'Timeout was reached')
        end
      end
    end
  end
end