1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef NET_SPDY_SPDY_TEST_UTIL_COMMON_H_
6 #define NET_SPDY_SPDY_TEST_UTIL_COMMON_H_
11 #include "base/memory/ref_counted.h"
12 #include "base/memory/scoped_ptr.h"
13 #include "crypto/ec_private_key.h"
14 #include "crypto/ec_signature_creator.h"
15 #include "net/base/completion_callback.h"
16 #include "net/base/request_priority.h"
17 #include "net/base/test_completion_callback.h"
18 #include "net/cert/cert_verifier.h"
19 #include "net/dns/mock_host_resolver.h"
20 #include "net/http/http_auth_handler_factory.h"
21 #include "net/http/http_network_session.h"
22 #include "net/http/http_response_info.h"
23 #include "net/http/http_server_properties_impl.h"
24 #include "net/http/transport_security_state.h"
25 #include "net/proxy/proxy_service.h"
26 #include "net/socket/next_proto.h"
27 #include "net/socket/socket_test_util.h"
28 #include "net/spdy/spdy_protocol.h"
29 #include "net/ssl/ssl_config_service_defaults.h"
30 #include "net/url_request/url_request_context.h"
31 #include "net/url_request/url_request_context_storage.h"
32 #include "testing/gtest/include/gtest/gtest.h"
41 class SpdySessionPool
;
43 class SpdyStreamRequest
;
45 // Default upload data used by both, mock objects and framer when creating
47 const char kDefaultURL
[] = "http://www.google.com";
48 const char kUploadData
[] = "hello!";
49 const int kUploadDataSize
= arraysize(kUploadData
)-1;
51 // SpdyNextProtos returns a vector of next protocols for negotiating
53 NextProtoVector
SpdyNextProtos();
55 // Chop a frame into an array of MockWrites.
56 // |data| is the frame to chop.
57 // |length| is the length of the frame to chop.
58 // |num_chunks| is the number of chunks to create.
59 MockWrite
* ChopWriteFrame(const char* data
, int length
, int num_chunks
);
61 // Chop a SpdyFrame into an array of MockWrites.
62 // |frame| is the frame to chop.
63 // |num_chunks| is the number of chunks to create.
64 MockWrite
* ChopWriteFrame(const SpdyFrame
& frame
, int num_chunks
);
66 // Chop a frame into an array of MockReads.
67 // |data| is the frame to chop.
68 // |length| is the length of the frame to chop.
69 // |num_chunks| is the number of chunks to create.
70 MockRead
* ChopReadFrame(const char* data
, int length
, int num_chunks
);
72 // Chop a SpdyFrame into an array of MockReads.
73 // |frame| is the frame to chop.
74 // |num_chunks| is the number of chunks to create.
75 MockRead
* ChopReadFrame(const SpdyFrame
& frame
, int num_chunks
);
77 // Adds headers and values to a map.
78 // |extra_headers| is an array of { name, value } pairs, arranged as strings
79 // where the even entries are the header names, and the odd entries are the
81 // |headers| gets filled in from |extra_headers|.
82 void AppendToHeaderBlock(const char* const extra_headers
[],
83 int extra_header_count
,
84 SpdyHeaderBlock
* headers
);
86 // Create an async MockWrite from the given SpdyFrame.
87 MockWrite
CreateMockWrite(const SpdyFrame
& req
);
89 // Create an async MockWrite from the given SpdyFrame and sequence number.
90 MockWrite
CreateMockWrite(const SpdyFrame
& req
, int seq
);
92 MockWrite
CreateMockWrite(const SpdyFrame
& req
, int seq
, IoMode mode
);
94 // Create a MockRead from the given SpdyFrame.
95 MockRead
CreateMockRead(const SpdyFrame
& resp
);
97 // Create a MockRead from the given SpdyFrame and sequence number.
98 MockRead
CreateMockRead(const SpdyFrame
& resp
, int seq
);
100 MockRead
CreateMockRead(const SpdyFrame
& resp
, int seq
, IoMode mode
);
102 // Combines the given SpdyFrames into the given char array and returns
104 int CombineFrames(const SpdyFrame
** frames
, int num_frames
,
105 char* buff
, int buff_len
);
107 // Returns the SpdyPriority embedded in the given frame. Returns true
108 // and fills in |priority| on success.
109 bool GetSpdyPriority(SpdyMajorVersion version
,
110 const SpdyFrame
& frame
,
111 SpdyPriority
* priority
);
113 // Tries to create a stream in |session| synchronously. Returns NULL
115 base::WeakPtr
<SpdyStream
> CreateStreamSynchronously(
117 const base::WeakPtr
<SpdySession
>& session
,
119 RequestPriority priority
,
120 const BoundNetLog
& net_log
);
122 // Helper class used by some tests to release a stream as soon as it's
124 class StreamReleaserCallback
: public TestCompletionCallbackBase
{
126 StreamReleaserCallback();
128 virtual ~StreamReleaserCallback();
130 // Returns a callback that releases |request|'s stream.
131 CompletionCallback
MakeCallback(SpdyStreamRequest
* request
);
134 void OnComplete(SpdyStreamRequest
* request
, int result
);
137 const size_t kSpdyCredentialSlotUnused
= 0;
139 // This struct holds information used to construct spdy control and data frames.
140 struct SpdyHeaderInfo
{
143 SpdyStreamId assoc_id
;
144 SpdyPriority priority
;
145 size_t credential_slot
; // SPDY3 only
146 SpdyControlFlags control_flags
;
148 SpdyRstStreamStatus status
;
151 SpdyDataFlags data_flags
;
154 // An ECSignatureCreator that returns deterministic signatures.
155 class MockECSignatureCreator
: public crypto::ECSignatureCreator
{
157 explicit MockECSignatureCreator(crypto::ECPrivateKey
* key
);
159 // crypto::ECSignatureCreator
160 virtual bool Sign(const uint8
* data
,
162 std::vector
<uint8
>* signature
) OVERRIDE
;
163 virtual bool DecodeSignature(const std::vector
<uint8
>& signature
,
164 std::vector
<uint8
>* out_raw_sig
) OVERRIDE
;
167 crypto::ECPrivateKey
* key_
;
169 DISALLOW_COPY_AND_ASSIGN(MockECSignatureCreator
);
172 // An ECSignatureCreatorFactory creates MockECSignatureCreator.
173 class MockECSignatureCreatorFactory
: public crypto::ECSignatureCreatorFactory
{
175 MockECSignatureCreatorFactory();
176 virtual ~MockECSignatureCreatorFactory();
178 // crypto::ECSignatureCreatorFactory
179 virtual crypto::ECSignatureCreator
* Create(
180 crypto::ECPrivateKey
* key
) OVERRIDE
;
183 DISALLOW_COPY_AND_ASSIGN(MockECSignatureCreatorFactory
);
186 // Helper to manage the lifetimes of the dependencies for a
187 // HttpNetworkTransaction.
188 struct SpdySessionDependencies
{
189 // Default set of dependencies -- "null" proxy service.
190 explicit SpdySessionDependencies(NextProto protocol
);
192 // Custom proxy service dependency.
193 SpdySessionDependencies(NextProto protocol
, ProxyService
* proxy_service
);
195 ~SpdySessionDependencies();
197 static HttpNetworkSession
* SpdyCreateSession(
198 SpdySessionDependencies
* session_deps
);
199 static HttpNetworkSession
* SpdyCreateSessionDeterministic(
200 SpdySessionDependencies
* session_deps
);
201 static HttpNetworkSession::Params
CreateSessionParams(
202 SpdySessionDependencies
* session_deps
);
204 // NOTE: host_resolver must be ordered before http_auth_handler_factory.
205 scoped_ptr
<MockHostResolverBase
> host_resolver
;
206 scoped_ptr
<CertVerifier
> cert_verifier
;
207 scoped_ptr
<TransportSecurityState
> transport_security_state
;
208 scoped_ptr
<ProxyService
> proxy_service
;
209 scoped_refptr
<SSLConfigService
> ssl_config_service
;
210 scoped_ptr
<MockClientSocketFactory
> socket_factory
;
211 scoped_ptr
<DeterministicMockClientSocketFactory
> deterministic_socket_factory
;
212 scoped_ptr
<HttpAuthHandlerFactory
> http_auth_handler_factory
;
213 HttpServerPropertiesImpl http_server_properties
;
214 bool enable_ip_pooling
;
215 bool enable_compression
;
217 bool enable_user_alternate_protocol_ports
;
219 size_t stream_initial_recv_window_size
;
220 SpdySession::TimeFunc time_func
;
221 NextProtoVector next_protos
;
222 std::string trusted_spdy_proxy
;
223 bool force_spdy_over_ssl
;
224 bool force_spdy_always
;
225 bool use_alternate_protocols
;
226 bool enable_websocket_over_spdy
;
230 class SpdyURLRequestContext
: public URLRequestContext
{
232 SpdyURLRequestContext(NextProto protocol
,
233 bool force_spdy_over_ssl
,
234 bool force_spdy_always
);
235 virtual ~SpdyURLRequestContext();
237 MockClientSocketFactory
& socket_factory() { return socket_factory_
; }
240 MockClientSocketFactory socket_factory_
;
241 net::URLRequestContextStorage storage_
;
244 // Equivalent to pool->GetIfExists(spdy_session_key, BoundNetLog()) != NULL.
245 bool HasSpdySession(SpdySessionPool
* pool
, const SpdySessionKey
& key
);
247 // Creates a SPDY session for the given key and puts it in the SPDY
248 // session pool in |http_session|. A SPDY session for |key| must not
250 base::WeakPtr
<SpdySession
> CreateInsecureSpdySession(
251 const scoped_refptr
<HttpNetworkSession
>& http_session
,
252 const SpdySessionKey
& key
,
253 const BoundNetLog
& net_log
);
255 // Tries to create a SPDY session for the given key but expects the
256 // attempt to fail with the given error. A SPDY session for |key| must
257 // not already exist. The session will be created but close in the
258 // next event loop iteration.
259 base::WeakPtr
<SpdySession
> TryCreateInsecureSpdySessionExpectingFailure(
260 const scoped_refptr
<HttpNetworkSession
>& http_session
,
261 const SpdySessionKey
& key
,
262 Error expected_error
,
263 const BoundNetLog
& net_log
);
265 // Like CreateInsecureSpdySession(), but uses TLS.
266 base::WeakPtr
<SpdySession
> CreateSecureSpdySession(
267 const scoped_refptr
<HttpNetworkSession
>& http_session
,
268 const SpdySessionKey
& key
,
269 const BoundNetLog
& net_log
);
271 // Creates an insecure SPDY session for the given key and puts it in
272 // |pool|. The returned session will neither receive nor send any
273 // data. A SPDY session for |key| must not already exist.
274 base::WeakPtr
<SpdySession
> CreateFakeSpdySession(SpdySessionPool
* pool
,
275 const SpdySessionKey
& key
);
277 // Tries to create an insecure SPDY session for the given key but
278 // expects the attempt to fail with the given error. The session will
279 // neither receive nor send any data. A SPDY session for |key| must
280 // not already exist. The session will be created but close in the
281 // next event loop iteration.
282 base::WeakPtr
<SpdySession
> TryCreateFakeSpdySessionExpectingFailure(
283 SpdySessionPool
* pool
,
284 const SpdySessionKey
& key
,
285 Error expected_error
);
287 class SpdySessionPoolPeer
{
289 explicit SpdySessionPoolPeer(SpdySessionPool
* pool
);
291 void RemoveAliases(const SpdySessionKey
& key
);
292 void DisableDomainAuthenticationVerification();
293 void SetEnableSendingInitialData(bool enabled
);
296 SpdySessionPool
* const pool_
;
298 DISALLOW_COPY_AND_ASSIGN(SpdySessionPoolPeer
);
303 explicit SpdyTestUtil(NextProto protocol
);
305 // Add the appropriate headers to put |url| into |block|.
306 void AddUrlToHeaderBlock(base::StringPiece url
,
307 SpdyHeaderBlock
* headers
) const;
309 scoped_ptr
<SpdyHeaderBlock
> ConstructGetHeaderBlock(
310 base::StringPiece url
) const;
311 scoped_ptr
<SpdyHeaderBlock
> ConstructGetHeaderBlockForProxy(
312 base::StringPiece url
) const;
313 scoped_ptr
<SpdyHeaderBlock
> ConstructHeadHeaderBlock(
314 base::StringPiece url
,
315 int64 content_length
) const;
316 scoped_ptr
<SpdyHeaderBlock
> ConstructPostHeaderBlock(
317 base::StringPiece url
,
318 int64 content_length
) const;
319 scoped_ptr
<SpdyHeaderBlock
> ConstructPutHeaderBlock(
320 base::StringPiece url
,
321 int64 content_length
) const;
323 // Construct a SPDY frame. If it is a SYN_STREAM or SYN_REPLY frame (as
324 // specified in header_info.kind), the provided headers are included in the
326 SpdyFrame
* ConstructSpdyFrame(
327 const SpdyHeaderInfo
& header_info
,
328 scoped_ptr
<SpdyHeaderBlock
> headers
) const;
330 // Construct a SPDY frame. If it is a SYN_STREAM or SYN_REPLY frame (as
331 // specified in header_info.kind), the headers provided in extra_headers and
332 // (if non-NULL) tail_headers are concatenated and included in the frame.
333 // (extra_headers must always be non-NULL.)
334 SpdyFrame
* ConstructSpdyFrame(const SpdyHeaderInfo
& header_info
,
335 const char* const extra_headers
[],
336 int extra_header_count
,
337 const char* const tail_headers
[],
338 int tail_header_count
) const;
340 // Construct a generic SpdyControlFrame.
341 SpdyFrame
* ConstructSpdyControlFrame(
342 scoped_ptr
<SpdyHeaderBlock
> headers
,
344 SpdyStreamId stream_id
,
345 RequestPriority request_priority
,
347 SpdyControlFlags flags
,
348 SpdyStreamId associated_stream_id
) const;
350 // Construct a generic SpdyControlFrame.
352 // Warning: extra_header_count is the number of header-value pairs in
353 // extra_headers (so half the number of elements), but tail_headers_size is
354 // the actual number of elements (both keys and values) in tail_headers.
355 // TODO(ttuttle): Fix this inconsistency.
356 SpdyFrame
* ConstructSpdyControlFrame(
357 const char* const extra_headers
[],
358 int extra_header_count
,
360 SpdyStreamId stream_id
,
361 RequestPriority request_priority
,
363 SpdyControlFlags flags
,
364 const char* const* tail_headers
,
365 int tail_headers_size
,
366 SpdyStreamId associated_stream_id
) const;
368 // Construct an expected SPDY reply string from the given headers.
369 std::string
ConstructSpdyReplyString(const SpdyHeaderBlock
& headers
) const;
371 // Construct an expected SPDY SETTINGS frame.
372 // |settings| are the settings to set.
373 // Returns the constructed frame. The caller takes ownership of the frame.
374 SpdyFrame
* ConstructSpdySettings(const SettingsMap
& settings
) const;
376 // Constructs an expected SPDY SETTINGS acknowledgement frame, if the protocol
377 // version is SPDY4 or higher, or an empty placeholder frame otherwise.
378 SpdyFrame
* ConstructSpdySettingsAck() const;
380 // Construct a SPDY PING frame.
381 // Returns the constructed frame. The caller takes ownership of the frame.
382 SpdyFrame
* ConstructSpdyPing(uint32 ping_id
, bool is_ack
) const;
384 // Construct a SPDY GOAWAY frame with last_good_stream_id = 0.
385 // Returns the constructed frame. The caller takes ownership of the frame.
386 SpdyFrame
* ConstructSpdyGoAway() const;
388 // Construct a SPDY GOAWAY frame with the specified last_good_stream_id.
389 // Returns the constructed frame. The caller takes ownership of the frame.
390 SpdyFrame
* ConstructSpdyGoAway(SpdyStreamId last_good_stream_id
) const;
392 // Construct a SPDY GOAWAY frame with the specified last_good_stream_id,
393 // status, and description. Returns the constructed frame. The caller takes
394 // ownership of the frame.
395 SpdyFrame
* ConstructSpdyGoAway(SpdyStreamId last_good_stream_id
,
396 SpdyGoAwayStatus status
,
397 const std::string
& desc
) const;
399 // Construct a SPDY WINDOW_UPDATE frame.
400 // Returns the constructed frame. The caller takes ownership of the frame.
401 SpdyFrame
* ConstructSpdyWindowUpdate(
402 SpdyStreamId stream_id
,
403 uint32 delta_window_size
) const;
405 // Construct a SPDY RST_STREAM frame.
406 // Returns the constructed frame. The caller takes ownership of the frame.
407 SpdyFrame
* ConstructSpdyRstStream(SpdyStreamId stream_id
,
408 SpdyRstStreamStatus status
) const;
410 // Constructs a standard SPDY GET SYN frame, optionally compressed
412 // |extra_headers| are the extra header-value pairs, which typically
413 // will vary the most between calls.
414 // Returns a SpdyFrame.
415 SpdyFrame
* ConstructSpdyGet(const char* const url
,
417 SpdyStreamId stream_id
,
418 RequestPriority request_priority
) const;
420 SpdyFrame
* ConstructSpdyGetForProxy(const char* const url
,
422 SpdyStreamId stream_id
,
423 RequestPriority request_priority
) const;
425 // Constructs a standard SPDY GET SYN frame, optionally compressed.
426 // |extra_headers| are the extra header-value pairs, which typically
427 // will vary the most between calls. If |direct| is false, the
428 // the full url will be used instead of simply the path.
429 // Returns a SpdyFrame.
430 SpdyFrame
* ConstructSpdyGet(const char* const extra_headers
[],
431 int extra_header_count
,
434 RequestPriority request_priority
,
437 // Constructs a standard SPDY SYN_STREAM frame for a CONNECT request.
438 SpdyFrame
* ConstructSpdyConnect(const char* const extra_headers
[],
439 int extra_header_count
,
441 RequestPriority priority
) const;
443 // Constructs a standard SPDY push SYN frame.
444 // |extra_headers| are the extra header-value pairs, which typically
445 // will vary the most between calls.
446 // Returns a SpdyFrame.
447 SpdyFrame
* ConstructSpdyPush(const char* const extra_headers
[],
448 int extra_header_count
,
450 int associated_stream_id
,
452 SpdyFrame
* ConstructSpdyPush(const char* const extra_headers
[],
453 int extra_header_count
,
455 int associated_stream_id
,
458 const char* location
);
460 SpdyFrame
* ConstructInitialSpdyPushFrame(scoped_ptr
<SpdyHeaderBlock
> headers
,
462 int associated_stream_id
);
464 SpdyFrame
* ConstructSpdyPushHeaders(int stream_id
,
465 const char* const extra_headers
[],
466 int extra_header_count
);
468 // Construct a SPDY syn (HEADERS or SYN_STREAM, depending on protocol
469 // version) carrying exactly the given headers and priority.
470 SpdyFrame
* ConstructSpdySyn(int stream_id
,
471 const SpdyHeaderBlock
& headers
,
472 RequestPriority priority
,
476 // Construct a SPDY reply (HEADERS or SYN_REPLY, depending on protocol
477 // version) carrying exactly the given headers, and the default priority
478 // (or no priority, depending on protocl version).
479 // The |headers| parameter variant is preferred.
480 SpdyFrame
* ConstructSpdyReply(int stream_id
, const SpdyHeaderBlock
& headers
);
482 // Constructs a standard SPDY SYN_REPLY frame to match the SPDY GET.
483 // |extra_headers| are the extra header-value pairs, which typically
484 // will vary the most between calls.
485 // Returns a SpdyFrame.
486 SpdyFrame
* ConstructSpdyGetSynReply(const char* const extra_headers
[],
487 int extra_header_count
,
490 // Constructs a standard SPDY SYN_REPLY frame to match the SPDY GET.
491 // |extra_headers| are the extra header-value pairs, which typically
492 // will vary the most between calls.
493 // Returns a SpdyFrame.
494 SpdyFrame
* ConstructSpdyGetSynReplyRedirect(int stream_id
);
496 // Constructs a standard SPDY SYN_REPLY frame with an Internal Server
497 // Error status code.
498 // Returns a SpdyFrame.
499 SpdyFrame
* ConstructSpdySynReplyError(int stream_id
);
501 // Constructs a standard SPDY SYN_REPLY frame with the specified status code.
502 // Returns a SpdyFrame.
503 SpdyFrame
* ConstructSpdySynReplyError(const char* const status
,
504 const char* const* const extra_headers
,
505 int extra_header_count
,
508 // Constructs a standard SPDY POST SYN frame.
509 // |extra_headers| are the extra header-value pairs, which typically
510 // will vary the most between calls.
511 // Returns a SpdyFrame.
512 SpdyFrame
* ConstructSpdyPost(const char* url
,
513 SpdyStreamId stream_id
,
514 int64 content_length
,
515 RequestPriority priority
,
516 const char* const extra_headers
[],
517 int extra_header_count
);
519 // Constructs a chunked transfer SPDY POST SYN frame.
520 // |extra_headers| are the extra header-value pairs, which typically
521 // will vary the most between calls.
522 // Returns a SpdyFrame.
523 SpdyFrame
* ConstructChunkedSpdyPost(const char* const extra_headers
[],
524 int extra_header_count
);
526 // Constructs a standard SPDY SYN_REPLY frame to match the SPDY POST.
527 // |extra_headers| are the extra header-value pairs, which typically
528 // will vary the most between calls.
529 // Returns a SpdyFrame.
530 SpdyFrame
* ConstructSpdyPostSynReply(const char* const extra_headers
[],
531 int extra_header_count
);
533 // Constructs a single SPDY data frame with the contents "hello!"
534 SpdyFrame
* ConstructSpdyBodyFrame(int stream_id
,
537 // Constructs a single SPDY data frame with the given content.
538 SpdyFrame
* ConstructSpdyBodyFrame(int stream_id
, const char* data
,
539 uint32 len
, bool fin
);
541 // Wraps |frame| in the payload of a data frame in stream |stream_id|.
542 SpdyFrame
* ConstructWrappedSpdyFrame(const scoped_ptr
<SpdyFrame
>& frame
,
545 const SpdyHeaderInfo
MakeSpdyHeader(SpdyFrameType type
);
547 // For versions below SPDY4, adds the version HTTP/1.1 header.
548 void MaybeAddVersionHeader(SpdyFrameWithNameValueBlockIR
* frame_ir
) const;
549 void MaybeAddVersionHeader(SpdyHeaderBlock
* block
) const;
551 // Maps |priority| to SPDY version priority, and sets it on |frame_ir|.
552 void SetPriority(RequestPriority priority
, SpdySynStreamIR
* frame_ir
) const;
554 NextProto
protocol() const { return protocol_
; }
555 SpdyMajorVersion
spdy_version() const { return spdy_version_
; }
556 bool is_spdy2() const { return protocol_
< kProtoSPDY3
; }
557 bool include_version_header() const { return protocol_
< kProtoSPDY4
; }
558 scoped_ptr
<SpdyFramer
> CreateFramer(bool compressed
) const;
560 const char* GetMethodKey() const;
561 const char* GetStatusKey() const;
562 const char* GetHostKey() const;
563 const char* GetSchemeKey() const;
564 const char* GetVersionKey() const;
565 const char* GetPathKey() const;
568 // |content_length| may be NULL, in which case the content-length
569 // header will be omitted.
570 scoped_ptr
<SpdyHeaderBlock
> ConstructHeaderBlock(
571 base::StringPiece method
,
572 base::StringPiece url
,
573 int64
* content_length
) const;
575 const NextProto protocol_
;
576 const SpdyMajorVersion spdy_version_
;
581 #endif // NET_SPDY_SPDY_TEST_UTIL_COMMON_H_