net/http/http_transaction_test_util.h

   1 // Copyright 2014 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.
   4
   5 #ifndef NET_HTTP_HTTP_TRANSACTION_UNITTEST_H_
   6 #define NET_HTTP_HTTP_TRANSACTION_UNITTEST_H_
   7
   8 #include "net/http/http_transaction.h"
   9
  10 #include <string>
  11
  12 #include "base/callback.h"
  13 #include "base/compiler_specific.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "base/strings/string16.h"
  16 #include "net/base/io_buffer.h"
  17 #include "net/base/load_flags.h"
  18 #include "net/base/net_errors.h"
  19 #include "net/base/request_priority.h"
  20 #include "net/base/test_completion_callback.h"
  21 #include "net/disk_cache/disk_cache.h"
  22 #include "net/http/http_cache.h"
  23 #include "net/http/http_request_info.h"
  24 #include "net/http/http_response_headers.h"
  25 #include "net/http/http_response_info.h"
  26 #include "net/log/net_log.h"
  27 #include "net/socket/connection_attempts.h"
  28
  29 namespace net {
  30
  31 class HttpRequestHeaders;
  32 class IOBuffer;
  33 struct HttpRequestInfo;
  34
  35 //-----------------------------------------------------------------------------
  36 // mock transaction data
  37
  38 // these flags may be combined to form the test_mode field
  39 enum {
  40   TEST_MODE_NORMAL = 0,
  41   TEST_MODE_SYNC_NET_START = 1 << 0,
  42   TEST_MODE_SYNC_NET_READ  = 1 << 1,
  43   TEST_MODE_SYNC_CACHE_START = 1 << 2,
  44   TEST_MODE_SYNC_CACHE_READ  = 1 << 3,
  45   TEST_MODE_SYNC_CACHE_WRITE  = 1 << 4,
  46   TEST_MODE_SYNC_ALL = (TEST_MODE_SYNC_NET_START | TEST_MODE_SYNC_NET_READ |
  47                         TEST_MODE_SYNC_CACHE_START | TEST_MODE_SYNC_CACHE_READ |
  48                         TEST_MODE_SYNC_CACHE_WRITE),
  49   TEST_MODE_SLOW_READ = 1 << 5
  50 };
  51
  52 typedef void (*MockTransactionHandler)(const HttpRequestInfo* request,
  53                                        std::string* response_status,
  54                                        std::string* response_headers,
  55                                        std::string* response_data);
  56
  57 struct MockTransaction {
  58   const char* url;
  59   const char* method;
  60   // If |request_time| is unspecified, the current time will be used.
  61   base::Time request_time;
  62   const char* request_headers;
  63   int load_flags;
  64   const char* status;
  65   const char* response_headers;
  66   // If |response_time| is unspecified, the current time will be used.
  67   base::Time response_time;
  68   const char* data;
  69   int test_mode;
  70   MockTransactionHandler handler;
  71   CertStatus cert_status;
  72   // Value returned by MockNetworkTransaction::Start (potentially
  73   // asynchronously if |!(test_mode & TEST_MODE_SYNC_NET_START)|.)
  74   Error return_code;
  75 };
  76
  77 extern const MockTransaction kSimpleGET_Transaction;
  78 extern const MockTransaction kSimplePOST_Transaction;
  79 extern const MockTransaction kTypicalGET_Transaction;
  80 extern const MockTransaction kETagGET_Transaction;
  81 extern const MockTransaction kRangeGET_Transaction;
  82
  83 // returns the mock transaction for the given URL
  84 const MockTransaction* FindMockTransaction(const GURL& url);
  85
  86 // Add/Remove a mock transaction that can be accessed via FindMockTransaction.
  87 // There can be only one MockTransaction associated with a given URL.
  88 void AddMockTransaction(const MockTransaction* trans);
  89 void RemoveMockTransaction(const MockTransaction* trans);
  90
  91 struct ScopedMockTransaction : MockTransaction {
  92   ScopedMockTransaction() {
  93     AddMockTransaction(this);
  94   }
  95   explicit ScopedMockTransaction(const MockTransaction& t)
  96       : MockTransaction(t) {
  97     AddMockTransaction(this);
  98   }
  99   ~ScopedMockTransaction() {
 100     RemoveMockTransaction(this);
 101   }
 102 };
 103
 104 //-----------------------------------------------------------------------------
 105 // mock http request
 106
 107 class MockHttpRequest : public HttpRequestInfo {
 108  public:
 109   explicit MockHttpRequest(const MockTransaction& t);
 110 };
 111
 112 //-----------------------------------------------------------------------------
 113 // use this class to test completely consuming a transaction
 114
 115 class TestTransactionConsumer {
 116  public:
 117   TestTransactionConsumer(RequestPriority priority,
 118                           HttpTransactionFactory* factory);
 119   virtual ~TestTransactionConsumer();
 120
 121   void Start(const HttpRequestInfo* request, const BoundNetLog& net_log);
 122
 123   bool is_done() const { return state_ == DONE; }
 124   int error() const { return error_; }
 125
 126   const HttpResponseInfo* response_info() const {
 127     return trans_->GetResponseInfo();
 128   }
 129   const std::string& content() const { return content_; }
 130
 131  private:
 132   enum State {
 133     IDLE,
 134     STARTING,
 135     READING,
 136     DONE
 137   };
 138
 139   void DidStart(int result);
 140   void DidRead(int result);
 141   void DidFinish(int result);
 142   void Read();
 143
 144   void OnIOComplete(int result);
 145
 146   State state_;
 147   scoped_ptr<HttpTransaction> trans_;
 148   std::string content_;
 149   scoped_refptr<IOBuffer> read_buf_;
 150   int error_;
 151
 152   static int quit_counter_;
 153 };
 154
 155 //-----------------------------------------------------------------------------
 156 // mock network layer
 157
 158 class MockNetworkLayer;
 159
 160 // This transaction class inspects the available set of mock transactions to
 161 // find data for the request URL.  It supports IO operations that complete
 162 // synchronously or asynchronously to help exercise different code paths in the
 163 // HttpCache implementation.
 164 class MockNetworkTransaction
 165     : public HttpTransaction,
 166       public base::SupportsWeakPtr<MockNetworkTransaction> {
 167   typedef WebSocketHandshakeStreamBase::CreateHelper CreateHelper;
 168
 169  public:
 170   MockNetworkTransaction(RequestPriority priority, MockNetworkLayer* factory);
 171   ~MockNetworkTransaction() override;
 172
 173   int Start(const HttpRequestInfo* request,
 174             const CompletionCallback& callback,
 175             const BoundNetLog& net_log) override;
 176
 177   int RestartIgnoringLastError(const CompletionCallback& callback) override;
 178
 179   int RestartWithCertificate(X509Certificate* client_cert,
 180                              const CompletionCallback& callback) override;
 181
 182   int RestartWithAuth(const AuthCredentials& credentials,
 183                       const CompletionCallback& callback) override;
 184
 185   bool IsReadyToRestartForAuth() override;
 186
 187   int Read(IOBuffer* buf,
 188            int buf_len,
 189            const CompletionCallback& callback) override;
 190
 191   void StopCaching() override;
 192
 193   bool GetFullRequestHeaders(HttpRequestHeaders* headers) const override;
 194
 195   int64 GetTotalReceivedBytes() const override;
 196
 197   void DoneReading() override;
 198
 199   const HttpResponseInfo* GetResponseInfo() const override;
 200
 201   LoadState GetLoadState() const override;
 202
 203   UploadProgress GetUploadProgress() const override;
 204
 205   void SetQuicServerInfo(QuicServerInfo* quic_server_info) override;
 206
 207   bool GetLoadTimingInfo(LoadTimingInfo* load_timing_info) const override;
 208
 209   void SetPriority(RequestPriority priority) override;
 210
 211   void SetWebSocketHandshakeStreamCreateHelper(
 212       CreateHelper* create_helper) override;
 213
 214   void SetBeforeNetworkStartCallback(
 215       const BeforeNetworkStartCallback& callback) override;
 216
 217   void SetBeforeProxyHeadersSentCallback(
 218       const BeforeProxyHeadersSentCallback& callback) override;
 219
 220   int ResumeNetworkStart() override;
 221
 222   void GetConnectionAttempts(ConnectionAttempts* out) const override;
 223
 224   CreateHelper* websocket_handshake_stream_create_helper() {
 225     return websocket_handshake_stream_create_helper_;
 226   }
 227   RequestPriority priority() const { return priority_; }
 228   const HttpRequestInfo* request() const { return request_; }
 229
 230  private:
 231   int StartInternal(const HttpRequestInfo* request,
 232                     const CompletionCallback& callback,
 233                     const BoundNetLog& net_log);
 234   void CallbackLater(const CompletionCallback& callback, int result);
 235   void RunCallback(const CompletionCallback& callback, int result);
 236
 237   const HttpRequestInfo* request_;
 238   HttpResponseInfo response_;
 239   std::string data_;
 240   int data_cursor_;
 241   int test_mode_;
 242   RequestPriority priority_;
 243   CreateHelper* websocket_handshake_stream_create_helper_;
 244   base::WeakPtr<MockNetworkLayer> transaction_factory_;
 245   int64 received_bytes_;
 246
 247   // NetLog ID of the fake / non-existent underlying socket used by the
 248   // connection. Requires Start() be passed a BoundNetLog with a real NetLog to
 249   // be initialized.
 250   unsigned int socket_log_id_;
 251
 252   base::WeakPtrFactory<MockNetworkTransaction> weak_factory_;
 253
 254 };
 255
 256 class MockNetworkLayer : public HttpTransactionFactory,
 257                          public base::SupportsWeakPtr<MockNetworkLayer> {
 258  public:
 259   MockNetworkLayer();
 260   ~MockNetworkLayer() override;
 261
 262   int transaction_count() const { return transaction_count_; }
 263   bool done_reading_called() const { return done_reading_called_; }
 264   bool stop_caching_called() const { return stop_caching_called_; }
 265   void TransactionDoneReading();
 266   void TransactionStopCaching();
 267
 268   // Returns the last priority passed to CreateTransaction, or
 269   // DEFAULT_PRIORITY if it hasn't been called yet.
 270   RequestPriority last_create_transaction_priority() const {
 271     return last_create_transaction_priority_;
 272   }
 273
 274   // Returns the last transaction created by
 275   // CreateTransaction. Returns a NULL WeakPtr if one has not been
 276   // created yet, or the last transaction has been destroyed, or
 277   // ClearLastTransaction() has been called and a new transaction
 278   // hasn't been created yet.
 279   base::WeakPtr<MockNetworkTransaction> last_transaction() {
 280     return last_transaction_;
 281   }
 282
 283   // Makes last_transaction() return NULL until the next transaction
 284   // is created.
 285   void ClearLastTransaction() {
 286     last_transaction_.reset();
 287   }
 288
 289   // HttpTransactionFactory:
 290   int CreateTransaction(RequestPriority priority,
 291                         scoped_ptr<HttpTransaction>* trans) override;
 292   HttpCache* GetCache() override;
 293   HttpNetworkSession* GetSession() override;
 294
 295   // The caller must guarantee that |clock| will outlive this object.
 296   void SetClock(base::Clock* clock);
 297   base::Clock* clock() const { return clock_; }
 298
 299   // The current time (will use clock_ if it is non NULL).
 300   base::Time Now();
 301
 302  private:
 303   int transaction_count_;
 304   bool done_reading_called_;
 305   bool stop_caching_called_;
 306   RequestPriority last_create_transaction_priority_;
 307
 308   // By default clock_ is NULL but it can be set to a custom clock by test
 309   // frameworks using SetClock.
 310   base::Clock* clock_;
 311
 312   base::WeakPtr<MockNetworkTransaction> last_transaction_;
 313 };
 314
 315 //-----------------------------------------------------------------------------
 316 // helpers
 317
 318 // read the transaction completely
 319 int ReadTransaction(HttpTransaction* trans, std::string* result);
 320
 321 }  // namespace net
 322
 323 #endif  // NET_HTTP_HTTP_TRANSACTION_UNITTEST_H_