content/browser/resolve_proxy_msg_helper_unittest.cc

   1 // Copyright (c) 2011 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 #include "content/browser/resolve_proxy_msg_helper.h"
   6
   7 #include "content/browser/browser_thread_impl.h"
   8 #include "content/common/view_messages.h"
   9 #include "ipc/ipc_test_sink.h"
  10 #include "net/base/net_errors.h"
  11 #include "net/proxy/mock_proxy_resolver.h"
  12 #include "net/proxy/proxy_config_service.h"
  13 #include "net/proxy/proxy_service.h"
  14 #include "testing/gtest/include/gtest/gtest.h"
  15
  16 namespace content {
  17
  18 // This ProxyConfigService always returns "http://pac" as the PAC url to use.
  19 class MockProxyConfigService : public net::ProxyConfigService {
  20  public:
  21   void AddObserver(Observer* observer) override {}
  22   void RemoveObserver(Observer* observer) override {}
  23   ConfigAvailability GetLatestProxyConfig(net::ProxyConfig* results) override {
  24     *results = net::ProxyConfig::CreateFromCustomPacURL(GURL("http://pac"));
  25     return CONFIG_VALID;
  26   }
  27 };
  28
  29 class TestResolveProxyMsgHelper : public ResolveProxyMsgHelper {
  30  public:
  31   TestResolveProxyMsgHelper(
  32       net::ProxyService* proxy_service,
  33       IPC::Listener* listener)
  34       : ResolveProxyMsgHelper(proxy_service),
  35         listener_(listener) {}
  36   bool Send(IPC::Message* message) override {
  37     listener_->OnMessageReceived(*message);
  38     delete message;
  39     return true;
  40   }
  41
  42  protected:
  43   ~TestResolveProxyMsgHelper() override {}
  44
  45   IPC::Listener* listener_;
  46 };
  47
  48 class ResolveProxyMsgHelperTest : public testing::Test, public IPC::Listener {
  49  public:
  50   struct PendingResult {
  51     PendingResult(bool result,
  52                   const std::string& proxy_list)
  53         : result(result), proxy_list(proxy_list) {
  54     }
  55
  56     bool result;
  57     std::string proxy_list;
  58   };
  59
  60   ResolveProxyMsgHelperTest()
  61       : resolver_factory_(new net::MockAsyncProxyResolverFactory(false)),
  62         service_(new net::ProxyService(new MockProxyConfigService,
  63                                        make_scoped_ptr(resolver_factory_),
  64                                        NULL)),
  65         helper_(new TestResolveProxyMsgHelper(service_.get(), this)),
  66         io_thread_(BrowserThread::IO, &message_loop_) {
  67     test_sink_.AddFilter(this);
  68   }
  69
  70  protected:
  71   const PendingResult* pending_result() const { return pending_result_.get(); }
  72
  73   void clear_pending_result() {
  74     pending_result_.reset();
  75   }
  76
  77   IPC::Message* GenerateReply() {
  78     bool temp_bool;
  79     std::string temp_string;
  80     ViewHostMsg_ResolveProxy message(GURL(), &temp_bool, &temp_string);
  81     return IPC::SyncMessage::GenerateReply(&message);
  82   }
  83
  84   net::MockAsyncProxyResolverFactory* resolver_factory_;
  85   net::MockAsyncProxyResolver resolver_;
  86   scoped_ptr<net::ProxyService> service_;
  87   scoped_refptr<ResolveProxyMsgHelper> helper_;
  88   scoped_ptr<PendingResult> pending_result_;
  89
  90  private:
  91   bool OnMessageReceived(const IPC::Message& msg) override {
  92     TupleTypes<ViewHostMsg_ResolveProxy::ReplyParam>::ValueTuple reply_data;
  93     EXPECT_TRUE(ViewHostMsg_ResolveProxy::ReadReplyParam(&msg, &reply_data));
  94     DCHECK(!pending_result_.get());
  95     pending_result_.reset(
  96         new PendingResult(get<0>(reply_data), get<1>(reply_data)));
  97     test_sink_.ClearMessages();
  98     return true;
  99   }
 100
 101   base::MessageLoopForIO message_loop_;
 102   BrowserThreadImpl io_thread_;
 103   IPC::TestSink test_sink_;
 104 };
 105
 106 // Issue three sequential requests -- each should succeed.
 107 TEST_F(ResolveProxyMsgHelperTest, Sequential) {
 108   GURL url1("http://www.google1.com/");
 109   GURL url2("http://www.google2.com/");
 110   GURL url3("http://www.google3.com/");
 111
 112   // Messages are deleted by the sink.
 113   IPC::Message* msg1 = GenerateReply();
 114   IPC::Message* msg2 = GenerateReply();
 115   IPC::Message* msg3 = GenerateReply();
 116
 117   // Execute each request sequentially (so there are never 2 requests
 118   // outstanding at the same time).
 119
 120   helper_->OnResolveProxy(url1, msg1);
 121
 122   // Finish ProxyService's initialization.
 123   ASSERT_EQ(1u, resolver_factory_->pending_requests().size());
 124   resolver_factory_->pending_requests()[0]->CompleteNowWithForwarder(
 125       net::OK, &resolver_);
 126
 127   ASSERT_EQ(1u, resolver_.pending_requests().size());
 128   EXPECT_EQ(url1, resolver_.pending_requests()[0]->url());
 129   resolver_.pending_requests()[0]->results()->UseNamedProxy("result1:80");
 130   resolver_.pending_requests()[0]->CompleteNow(net::OK);
 131
 132   // Check result.
 133   EXPECT_EQ(true, pending_result()->result);
 134   EXPECT_EQ("PROXY result1:80", pending_result()->proxy_list);
 135   clear_pending_result();
 136
 137   helper_->OnResolveProxy(url2, msg2);
 138
 139   ASSERT_EQ(1u, resolver_.pending_requests().size());
 140   EXPECT_EQ(url2, resolver_.pending_requests()[0]->url());
 141   resolver_.pending_requests()[0]->results()->UseNamedProxy("result2:80");
 142   resolver_.pending_requests()[0]->CompleteNow(net::OK);
 143
 144   // Check result.
 145   EXPECT_EQ(true, pending_result()->result);
 146   EXPECT_EQ("PROXY result2:80", pending_result()->proxy_list);
 147   clear_pending_result();
 148
 149   helper_->OnResolveProxy(url3, msg3);
 150
 151   ASSERT_EQ(1u, resolver_.pending_requests().size());
 152   EXPECT_EQ(url3, resolver_.pending_requests()[0]->url());
 153   resolver_.pending_requests()[0]->results()->UseNamedProxy("result3:80");
 154   resolver_.pending_requests()[0]->CompleteNow(net::OK);
 155
 156   // Check result.
 157   EXPECT_EQ(true, pending_result()->result);
 158   EXPECT_EQ("PROXY result3:80", pending_result()->proxy_list);
 159   clear_pending_result();
 160 }
 161
 162 // Issue a request while one is already in progress -- should be queued.
 163 TEST_F(ResolveProxyMsgHelperTest, QueueRequests) {
 164   GURL url1("http://www.google1.com/");
 165   GURL url2("http://www.google2.com/");
 166   GURL url3("http://www.google3.com/");
 167
 168   IPC::Message* msg1 = GenerateReply();
 169   IPC::Message* msg2 = GenerateReply();
 170   IPC::Message* msg3 = GenerateReply();
 171
 172   // Start three requests. Since the proxy resolver is async, all the
 173   // requests will be pending.
 174
 175   helper_->OnResolveProxy(url1, msg1);
 176
 177   // Finish ProxyService's initialization.
 178   ASSERT_EQ(1u, resolver_factory_->pending_requests().size());
 179   resolver_factory_->pending_requests()[0]->CompleteNowWithForwarder(
 180       net::OK, &resolver_);
 181
 182   helper_->OnResolveProxy(url2, msg2);
 183   helper_->OnResolveProxy(url3, msg3);
 184
 185   // ResolveProxyHelper only keeps 1 request outstanding in ProxyService
 186   // at a time.
 187   ASSERT_EQ(1u, resolver_.pending_requests().size());
 188   EXPECT_EQ(url1, resolver_.pending_requests()[0]->url());
 189
 190   resolver_.pending_requests()[0]->results()->UseNamedProxy("result1:80");
 191   resolver_.pending_requests()[0]->CompleteNow(net::OK);
 192
 193   // Check result.
 194   EXPECT_EQ(true, pending_result()->result);
 195   EXPECT_EQ("PROXY result1:80", pending_result()->proxy_list);
 196   clear_pending_result();
 197
 198   ASSERT_EQ(1u, resolver_.pending_requests().size());
 199   EXPECT_EQ(url2, resolver_.pending_requests()[0]->url());
 200
 201   resolver_.pending_requests()[0]->results()->UseNamedProxy("result2:80");
 202   resolver_.pending_requests()[0]->CompleteNow(net::OK);
 203
 204   // Check result.
 205   EXPECT_EQ(true, pending_result()->result);
 206   EXPECT_EQ("PROXY result2:80", pending_result()->proxy_list);
 207   clear_pending_result();
 208
 209   ASSERT_EQ(1u, resolver_.pending_requests().size());
 210   EXPECT_EQ(url3, resolver_.pending_requests()[0]->url());
 211
 212   resolver_.pending_requests()[0]->results()->UseNamedProxy("result3:80");
 213   resolver_.pending_requests()[0]->CompleteNow(net::OK);
 214
 215   // Check result.
 216   EXPECT_EQ(true, pending_result()->result);
 217   EXPECT_EQ("PROXY result3:80", pending_result()->proxy_list);
 218   clear_pending_result();
 219 }
 220
 221 // Delete the helper while a request is in progress, and others are pending.
 222 TEST_F(ResolveProxyMsgHelperTest, CancelPendingRequests) {
 223   GURL url1("http://www.google1.com/");
 224   GURL url2("http://www.google2.com/");
 225   GURL url3("http://www.google3.com/");
 226
 227   // They will be deleted by the request's cancellation.
 228   IPC::Message* msg1 = GenerateReply();
 229   IPC::Message* msg2 = GenerateReply();
 230   IPC::Message* msg3 = GenerateReply();
 231
 232   // Start three requests. Since the proxy resolver is async, all the
 233   // requests will be pending.
 234
 235   helper_->OnResolveProxy(url1, msg1);
 236
 237   // Finish ProxyService's initialization.
 238   ASSERT_EQ(1u, resolver_factory_->pending_requests().size());
 239   resolver_factory_->pending_requests()[0]->CompleteNowWithForwarder(
 240       net::OK, &resolver_);
 241
 242   helper_->OnResolveProxy(url2, msg2);
 243   helper_->OnResolveProxy(url3, msg3);
 244
 245   // ResolveProxyHelper only keeps 1 request outstanding in ProxyService
 246   // at a time.
 247   ASSERT_EQ(1u, resolver_.pending_requests().size());
 248   EXPECT_EQ(url1, resolver_.pending_requests()[0]->url());
 249
 250   // Delete the underlying ResolveProxyMsgHelper -- this should cancel all
 251   // the requests which are outstanding.
 252   helper_ = NULL;
 253
 254   // The pending requests sent to the proxy resolver should have been cancelled.
 255
 256   EXPECT_EQ(0u, resolver_.pending_requests().size());
 257
 258   EXPECT_TRUE(pending_result() == NULL);
 259
 260   // It should also be the case that msg1, msg2, msg3 were deleted by the
 261   // cancellation. (Else will show up as a leak in Valgrind).
 262 }
 263
 264 }  // namespace content