src/net/test/url_request/url_request_mock_http_job.h

   1 // Copyright (c) 2012 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 // A URLRequestJob class that pulls the net and http headers from disk.
   6
   7 #ifndef NET_TEST_URL_REQUEST_URL_REQUEST_MOCK_HTTP_JOB_H_
   8 #define NET_TEST_URL_REQUEST_URL_REQUEST_MOCK_HTTP_JOB_H_
   9
  10 #include <string>
  11
  12 #include "base/macros.h"
  13 #include "base/memory/ref_counted.h"
  14 #include "base/memory/scoped_ptr.h"
  15 #include "net/url_request/url_request_file_job.h"
  16 #include "url/gurl.h"
  17
  18 namespace base {
  19 class FilePath;
  20 class SequencedWorkerPool;
  21 }
  22
  23 namespace net {
  24 class URLRequestInterceptor;
  25 }
  26
  27 namespace net {
  28
  29 class URLRequestMockHTTPJob : public URLRequestFileJob {
  30  public:
  31   enum FailurePhase {
  32     START = 0,
  33     READ_ASYNC = 1,
  34     READ_SYNC = 2,
  35     MAX_FAILURE_PHASE = 3,
  36   };
  37
  38   // Note that all file IO is done using |worker_pool|.
  39   URLRequestMockHTTPJob(URLRequest* request,
  40                         NetworkDelegate* network_delegate,
  41                         const base::FilePath& file_path,
  42                         const scoped_refptr<base::TaskRunner>& task_runner);
  43
  44   void Start() override;
  45   bool ReadRawData(IOBuffer* buf, int buf_size, int* bytes_read) override;
  46   bool GetMimeType(std::string* mime_type) const override;
  47   int GetResponseCode() const override;
  48   bool GetCharset(std::string* charset) override;
  49   void GetResponseInfo(HttpResponseInfo* info) override;
  50   bool IsRedirectResponse(GURL* location, int* http_status_code) override;
  51
  52   // Adds the testing URLs to the URLRequestFilter.
  53   static void AddUrlHandler(
  54       const base::FilePath& base_path,
  55       const scoped_refptr<base::SequencedWorkerPool>& worker_pool);
  56
  57   // Respond to all HTTP requests of |hostname| with contents of the file
  58   // located at |file_path|.
  59   static void AddHostnameToFileHandler(
  60       const std::string& hostname,
  61       const base::FilePath& file,
  62       const scoped_refptr<base::SequencedWorkerPool>& worker_pool);
  63
  64   // Given the path to a file relative to the path passed to AddUrlHandler(),
  65   // construct a mock URL.
  66   static GURL GetMockUrl(const base::FilePath& path);
  67
  68   // Given the path to a file relative to the path passed to AddUrlHandler(),
  69   // construct a mock URL that reports |net_error| at given |phase| of the
  70   // request. Reporting |net_error| ERR_IO_PENDING results in a hung request.
  71   static GURL GetMockUrlWithFailure(const base::FilePath& path,
  72                                     FailurePhase phase,
  73                                     int net_error);
  74
  75   // Returns a URLRequestJobFactory::ProtocolHandler that serves
  76   // URLRequestMockHTTPJob's responding like an HTTP server. |base_path| is the
  77   // file path leading to the root of the directory to use as the root of the
  78   // HTTP server.
  79   static scoped_ptr<URLRequestInterceptor> CreateInterceptor(
  80       const base::FilePath& base_path,
  81       const scoped_refptr<base::SequencedWorkerPool>& worker_pool);
  82
  83   // Returns a URLRequestJobFactory::ProtocolHandler that serves
  84   // URLRequestMockHTTPJob's responding like an HTTP server. It responds to all
  85   // requests with the contents of |file|.
  86   static scoped_ptr<URLRequestInterceptor> CreateInterceptorForSingleFile(
  87       const base::FilePath& file,
  88       const scoped_refptr<base::SequencedWorkerPool>& worker_pool);
  89
  90  protected:
  91   ~URLRequestMockHTTPJob() override;
  92
  93  private:
  94   void GetResponseInfoConst(HttpResponseInfo* info) const;
  95   void SetHeadersAndStart(const std::string& raw_headers);
  96   // Checks query part of request url, and reports an error if it matches.
  97   // Error is parsed out from the query and is reported synchronously.
  98   // Reporting ERR_IO_PENDING results in a hung request.
  99   // The "readasync" error is posted asynchronously.
 100   bool MaybeReportErrorOnPhase(FailurePhase phase);
 101
 102   std::string raw_headers_;
 103   const scoped_refptr<base::TaskRunner> task_runner_;
 104
 105   base::WeakPtrFactory<URLRequestMockHTTPJob> weak_ptr_factory_;
 106
 107   DISALLOW_COPY_AND_ASSIGN(URLRequestMockHTTPJob);
 108 };
 109
 110 }  // namespace net
 111
 112 #endif  // NET_TEST_URL_REQUEST_URL_REQUEST_MOCK_HTTP_JOB_H_