net/websockets/websocket_test_util.h - chromium/src - Git at Google

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 #ifndef NET_WEBSOCKETS_WEBSOCKET_TEST_UTIL_H_
 #define NET_WEBSOCKETS_WEBSOCKET_TEST_UTIL_H_

 #include <stdint.h>

 #include <memory>
 #include <string>

 #include "base/macros.h"
 #include "net/url_request/url_request_test_util.h"
 #include "net/websockets/websocket_stream.h"

 namespace url {
 class Origin;
 }  // namespace url

 namespace net {

 class MockClientSocketFactory;
 class ProxyService;
 class SequencedSocketData;
 struct SSLSocketDataProvider;

 class LinearCongruentialGenerator {
  public:
   explicit LinearCongruentialGenerator(uint32_t seed);
   uint32_t Generate();

  private:
   uint64_t current_;
 };

 // Generates a standard WebSocket handshake request. The challenge key used is
 // "dGhlIHNhbXBsZSBub25jZQ==". Each header in |extra_headers| must be terminated
 // with "\r\n".
 std::string WebSocketStandardRequest(
     const std::string& path,
     const std::string& host,
     const url::Origin& origin,
     const std::string& send_additional_request_headers,
     const std::string& extra_headers);

 // Generates a standard WebSocket handshake request. The challenge key used is
 // "dGhlIHNhbXBsZSBub25jZQ==". |cookies| must be empty or terminated with
 // "\r\n". Each header in |extra_headers| must be terminated with "\r\n".
 std::string WebSocketStandardRequestWithCookies(
     const std::string& path,
     const std::string& host,
     const url::Origin& origin,
     const std::string& cookies,
     const std::string& send_additional_request_headers,
     const std::string& extra_headers);

 // A response with the appropriate accept header to match the above challenge
 // key. Each header in |extra_headers| must be terminated with "\r\n".
 std::string WebSocketStandardResponse(const std::string& extra_headers);

 // This class provides a convenient way to construct a MockClientSocketFactory
 // for WebSocket tests.
 class WebSocketMockClientSocketFactoryMaker {
  public:
   WebSocketMockClientSocketFactoryMaker();
   ~WebSocketMockClientSocketFactoryMaker();

   // Tell the factory to create a socket which expects |expect_written| to be
   // written, and responds with |return_to_read|. The test will fail if the
   // expected text is not written, or all the bytes are not read. This adds data
   // for a new mock-socket using AddRawExpections(), and so can be called
   // multiple times to queue up multiple mock sockets, but usually in those
   // cases the lower-level AddRawExpections() interface is more appropriate.
   void SetExpectations(const std::string& expect_written,
                        const std::string& return_to_read);

   // A low-level interface to permit arbitrary expectations to be added. The
   // mock sockets will be created in the same order that they were added.
   void AddRawExpectations(std::unique_ptr<SequencedSocketData> socket_data);

   // Allow an SSL socket data provider to be added. You must also supply a mock
   // transport socket for it to use. If the mock SSL handshake fails then the
   // mock transport socket will connect but have nothing read or written. If the
   // mock handshake succeeds then the data from the underlying transport socket
   // will be passed through unchanged (without encryption).
   void AddSSLSocketDataProvider(
       std::unique_ptr<SSLSocketDataProvider> ssl_socket_data);

   // Call to get a pointer to the factory, which remains owned by this object.
   MockClientSocketFactory* factory();

  private:
   struct Detail;
   std::unique_ptr<Detail> detail_;

   DISALLOW_COPY_AND_ASSIGN(WebSocketMockClientSocketFactoryMaker);
 };

 // This class encapsulates the details of creating a
 // TestURLRequestContext that returns mock ClientSocketHandles that do what is
 // required by the tests.
 struct WebSocketTestURLRequestContextHost {
  public:
   WebSocketTestURLRequestContextHost();
   ~WebSocketTestURLRequestContextHost();

   void SetExpectations(const std::string& expect_written,
                        const std::string& return_to_read) {
     maker_.SetExpectations(expect_written, return_to_read);
   }

   void AddRawExpectations(std::unique_ptr<SequencedSocketData> socket_data);

   // Allow an SSL socket data provider to be added.
   void AddSSLSocketDataProvider(
       std::unique_ptr<SSLSocketDataProvider> ssl_socket_data);

   // Allow a proxy to be set. Usage:
   //   SetProxyConfig("proxy1:8000");
   // Any syntax accepted by net::ProxyConfig::ParseFromString() will work.
   // Do not call after GetURLRequestContext() has been called.
   void SetProxyConfig(const std::string& proxy_rules);

   // Call after calling one of SetExpections() or AddRawExpectations(). The
   // returned pointer remains owned by this object.
   TestURLRequestContext* GetURLRequestContext();

   const TestNetworkDelegate& network_delegate() const {
     return network_delegate_;
   }

  private:
   WebSocketMockClientSocketFactoryMaker maker_;
   TestURLRequestContext url_request_context_;
   TestNetworkDelegate network_delegate_;
   std::unique_ptr<ProxyService> proxy_service_;
   bool url_request_context_initialized_;

   DISALLOW_COPY_AND_ASSIGN(WebSocketTestURLRequestContextHost);
 };

 }  // namespace net

 #endif  // NET_WEBSOCKETS_WEBSOCKET_TEST_UTIL_H_
	// Copyright 2013 The Chromium Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	#ifndef NET_WEBSOCKETS_WEBSOCKET_TEST_UTIL_H_
	#define NET_WEBSOCKETS_WEBSOCKET_TEST_UTIL_H_

	#include <stdint.h>

	#include <memory>
	#include <string>

	#include "base/macros.h"
	#include "net/url_request/url_request_test_util.h"
	#include "net/websockets/websocket_stream.h"

	namespace url {
	class Origin;
	} // namespace url

	namespace net {

	class MockClientSocketFactory;
	class ProxyService;
	class SequencedSocketData;
	struct SSLSocketDataProvider;

	class LinearCongruentialGenerator {
	public:
	explicit LinearCongruentialGenerator(uint32_t seed);
	uint32_t Generate();

	private:
	uint64_t current_;
	};

	// Generates a standard WebSocket handshake request. The challenge key used is
	// "dGhlIHNhbXBsZSBub25jZQ==". Each header in \|extra_headers\| must be terminated
	// with "\r\n".
	std::string WebSocketStandardRequest(
	const std::string& path,
	const std::string& host,
	const url::Origin& origin,
	const std::string& send_additional_request_headers,
	const std::string& extra_headers);

	// Generates a standard WebSocket handshake request. The challenge key used is
	// "dGhlIHNhbXBsZSBub25jZQ==". \|cookies\| must be empty or terminated with
	// "\r\n". Each header in \|extra_headers\| must be terminated with "\r\n".
	std::string WebSocketStandardRequestWithCookies(
	const std::string& path,
	const std::string& host,
	const url::Origin& origin,
	const std::string& cookies,
	const std::string& send_additional_request_headers,
	const std::string& extra_headers);

	// A response with the appropriate accept header to match the above challenge
	// key. Each header in \|extra_headers\| must be terminated with "\r\n".
	std::string WebSocketStandardResponse(const std::string& extra_headers);

	// This class provides a convenient way to construct a MockClientSocketFactory
	// for WebSocket tests.
	class WebSocketMockClientSocketFactoryMaker {
	public:
	WebSocketMockClientSocketFactoryMaker();
	~WebSocketMockClientSocketFactoryMaker();

	// Tell the factory to create a socket which expects \|expect_written\| to be
	// written, and responds with \|return_to_read\|. The test will fail if the
	// expected text is not written, or all the bytes are not read. This adds data
	// for a new mock-socket using AddRawExpections(), and so can be called
	// multiple times to queue up multiple mock sockets, but usually in those
	// cases the lower-level AddRawExpections() interface is more appropriate.
	void SetExpectations(const std::string& expect_written,
	const std::string& return_to_read);

	// A low-level interface to permit arbitrary expectations to be added. The
	// mock sockets will be created in the same order that they were added.
	void AddRawExpectations(std::unique_ptr<SequencedSocketData> socket_data);

	// Allow an SSL socket data provider to be added. You must also supply a mock
	// transport socket for it to use. If the mock SSL handshake fails then the
	// mock transport socket will connect but have nothing read or written. If the
	// mock handshake succeeds then the data from the underlying transport socket
	// will be passed through unchanged (without encryption).
	void AddSSLSocketDataProvider(
	std::unique_ptr<SSLSocketDataProvider> ssl_socket_data);

	// Call to get a pointer to the factory, which remains owned by this object.
	MockClientSocketFactory* factory();

	private:
	struct Detail;
	std::unique_ptr<Detail> detail_;

	DISALLOW_COPY_AND_ASSIGN(WebSocketMockClientSocketFactoryMaker);
	};

	// This class encapsulates the details of creating a
	// TestURLRequestContext that returns mock ClientSocketHandles that do what is
	// required by the tests.
	struct WebSocketTestURLRequestContextHost {
	public:
	WebSocketTestURLRequestContextHost();
	~WebSocketTestURLRequestContextHost();

	void SetExpectations(const std::string& expect_written,
	const std::string& return_to_read) {
	maker_.SetExpectations(expect_written, return_to_read);
	}

	void AddRawExpectations(std::unique_ptr<SequencedSocketData> socket_data);

	// Allow an SSL socket data provider to be added.
	void AddSSLSocketDataProvider(
	std::unique_ptr<SSLSocketDataProvider> ssl_socket_data);

	// Allow a proxy to be set. Usage:
	// SetProxyConfig("proxy1:8000");
	// Any syntax accepted by net::ProxyConfig::ParseFromString() will work.
	// Do not call after GetURLRequestContext() has been called.
	void SetProxyConfig(const std::string& proxy_rules);

	// Call after calling one of SetExpections() or AddRawExpectations(). The
	// returned pointer remains owned by this object.
	TestURLRequestContext* GetURLRequestContext();

	const TestNetworkDelegate& network_delegate() const {
	return network_delegate_;
	}

	private:
	WebSocketMockClientSocketFactoryMaker maker_;
	TestURLRequestContext url_request_context_;
	TestNetworkDelegate network_delegate_;
	std::unique_ptr<ProxyService> proxy_service_;
	bool url_request_context_initialized_;

	DISALLOW_COPY_AND_ASSIGN(WebSocketTestURLRequestContextHost);
	};

	} // namespace net

	#endif // NET_WEBSOCKETS_WEBSOCKET_TEST_UTIL_H_