[net] HostResolverImpl + DnsTransaction + DnsConfigService = Asynchronous DNS ready for experiments.

net/base/host_resolver_impl_unittest.cc

 // Copyright (c) 2012 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.
 
 #include "net/base/host_resolver_impl.h"
 
 #include <string>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
@@ skipping 33 matching lines @@
     HostResolverProc* resolver_proc) {
   return HostResolverImpl::ProcTaskParams(resolver_proc,
                                           kMaxRetryAttempts);
 }
 
 HostResolverImpl* CreateHostResolverImpl(HostResolverProc* resolver_proc) {
   return new HostResolverImpl(
       HostCache::CreateDefaultCache(),
       DefaultLimits(),
       DefaultParams(resolver_proc),
+      scoped_ptr<DnsConfigService>(NULL),
       NULL);
 }
 
 // This HostResolverImpl will only allow 1 outstanding resolve at a time.
 HostResolverImpl* CreateSerialHostResolverImpl(
     HostResolverProc* resolver_proc) {
   HostResolverImpl::ProcTaskParams params = DefaultParams(resolver_proc);
   params.max_retry_attempts = 0u;
 
   PrioritizedDispatcher::Limits limits(NUM_PRIORITIES, 1);
 
   return new HostResolverImpl(HostCache::CreateDefaultCache(),
                               limits,
                               params,
+                              scoped_ptr<DnsConfigService>(NULL),
                               NULL);
 }
 
 // Helper to create a HostResolver::RequestInfo.
 HostResolver::RequestInfo CreateResolverRequest(
     const std::string& hostname,
     RequestPriority priority) {
   HostResolver::RequestInfo info(HostPortPair(hostname, 80));
   info.set_priority(priority);
   return info;
@@ skipping 349 matching lines @@
 }
 
 TEST_F(HostResolverImplTest, FailedAsynchronousLookup) {
   AddressList addrlist;
   const int kPortnum = 80;
 
   scoped_refptr<RuleBasedHostResolverProc> resolver_proc(
       new RuleBasedHostResolverProc(NULL));
   resolver_proc->AddSimulatedFailure("just.testing");
 
-  scoped_ptr<HostResolver> host_resolver(
-      CreateHostResolverImpl(resolver_proc));
+  scoped_ptr<HostResolver> host_resolver(CreateHostResolverImpl(resolver_proc));
 
   HostResolver::RequestInfo info(HostPortPair("just.testing", kPortnum));
   CapturingBoundNetLog log(CapturingNetLog::kUnbounded);
   int err = host_resolver->Resolve(info, &addrlist, callback_, NULL,
                                    log.bound());
   EXPECT_EQ(ERR_IO_PENDING, err);
 
   CapturingNetLog::EntryList entries;
   log.GetEntries(&entries);
 
@@ skipping 18 matching lines @@
 }
 
 // Using WaitingHostResolverProc you can simulate very long lookups.
 class WaitingHostResolverProc : public HostResolverProc {
  public:
   explicit WaitingHostResolverProc(HostResolverProc* previous)
     : HostResolverProc(previous),
       is_waiting_(false, false),
       is_signaled_(false, false) {}
 
+  // If |manual_reset| is true, once Signalled, it will let all Resolve calls to
+  // proceed.

[mmenke, 2012/02/21 16:34:24]

nit:  Remove "to"

+  WaitingHostResolverProc(HostResolverProc* previous, bool manual_reset)
+    : HostResolverProc(previous),
+      is_waiting_(false, false),
+      is_signaled_(manual_reset, false) {}

[mmenke, 2012/02/21 16:34:24]

nit:  Fix indent

+
   // Waits until a call to |Resolve| is blocked. It is recommended to always
   // |Wait| before |Signal|, and required if issuing a series of two or more
   // calls to |Signal|, because |WaitableEvent| does not count the number of
   // signals.
   void Wait() {
     is_waiting_.Wait();
   }
 
   // Signals a waiting call to |Resolve|.
   void Signal() {
     is_signaled_.Signal();
   }
 
   // HostResolverProc methods:
   virtual int Resolve(const std::string& host,
                       AddressFamily address_family,
                       HostResolverFlags host_resolver_flags,
                       AddressList* addrlist,
                       int* os_error) {
     is_waiting_.Signal();
     is_signaled_.Wait();
     return ResolveUsingPrevious(host, address_family, host_resolver_flags,
                                 addrlist, os_error);
   }
 
  private:
   virtual ~WaitingHostResolverProc() {}
-
   base::WaitableEvent is_waiting_;
   base::WaitableEvent is_signaled_;
 };
 
 TEST_F(HostResolverImplTest, AbortedAsynchronousLookup) {
   scoped_refptr<WaitingHostResolverProc> resolver_proc(
       new WaitingHostResolverProc(NULL));
 
   CapturingNetLog net_log(CapturingNetLog::kUnbounded);
   CapturingBoundNetLog log(CapturingNetLog::kUnbounded);
   {
     // This resolver will be destroyed while a lookup is running on WorkerPool.
     scoped_ptr<HostResolver> host_resolver(
         new HostResolverImpl(HostCache::CreateDefaultCache(),
                              DefaultLimits(),
                              DefaultParams(resolver_proc),
+                             scoped_ptr<DnsConfigService>(NULL),
                              &net_log));
     AddressList addrlist;
     const int kPortnum = 80;
 
     HostResolver::RequestInfo info(HostPortPair("just.testing", kPortnum));
     int err = host_resolver->Resolve(info, &addrlist, callback_, NULL,
                                      log.bound());
     EXPECT_EQ(ERR_IO_PENDING, err);
 
     resolver_proc->Wait();
@@ skipping 15 matching lines @@
 
   int pos = ExpectLogContainsSomewhereAfter(net_log_entries, 0,
       NetLog::TYPE_HOST_RESOLVER_IMPL_REQUEST,
       NetLog::PHASE_BEGIN);
   pos = ExpectLogContainsSomewhereAfter(net_log_entries, pos + 1,
       NetLog::TYPE_HOST_RESOLVER_IMPL_JOB,
       NetLog::PHASE_BEGIN);
   pos = ExpectLogContainsSomewhereAfter(net_log_entries, pos + 1,
         NetLog::TYPE_HOST_RESOLVER_IMPL_PROC_TASK,
         NetLog::PHASE_BEGIN);
-  // Both Request and ProcTask need to be cancelled. (The Job is "aborted".)
-  pos = ExpectLogContainsSomewhereAfter(net_log_entries, pos + 1,
-      NetLog::TYPE_CANCELLED,
-      NetLog::PHASE_NONE);
-  // Don't care about order in which Request, Job and ProcTask end, or when the
-  // other one is cancelled.
+
+  // The Request needs to be cancelled. (The Job is "aborted".)
+  // Don't care about order in which Request, Job and ProcTask end.
   ExpectLogContainsSomewhereAfter(net_log_entries, pos + 1,
       NetLog::TYPE_CANCELLED,
       NetLog::PHASE_NONE);
   ExpectLogContainsSomewhereAfter(net_log_entries, pos + 1,
+      NetLog::TYPE_HOST_RESOLVER_IMPL_PROC_TASK,
+      NetLog::PHASE_END);
+  ExpectLogContainsSomewhereAfter(net_log_entries, pos + 1,
       NetLog::TYPE_HOST_RESOLVER_IMPL_REQUEST,
       NetLog::PHASE_END);
   ExpectLogContainsSomewhereAfter(net_log_entries, pos + 1,
-      NetLog::TYPE_HOST_RESOLVER_IMPL_PROC_TASK,
-      NetLog::PHASE_END);
-  ExpectLogContainsSomewhereAfter(net_log_entries, pos + 1,
       NetLog::TYPE_HOST_RESOLVER_IMPL_JOB,
       NetLog::PHASE_END);
 
   EXPECT_FALSE(callback_called_);
 }
 
 TEST_F(HostResolverImplTest, NumericIPv4Address) {
   // Stevens says dotted quads with AI_UNSPEC resolve to a single sockaddr_in.
 
   scoped_refptr<RuleBasedHostResolverProc> resolver_proc(
@@ skipping 384 matching lines @@
 
 TEST_F(HostResolverImplTest, StartWithinCallback) {
   // Use a capturing resolver_proc, since the verifier needs to know what calls
   // reached Resolver().  Also, the capturing resolver_proc is initially
   // blocked.
   scoped_refptr<CapturingHostResolverProc> resolver_proc(
       new CapturingHostResolverProc(NULL));
 
   // Turn off caching for this host resolver.
   scoped_ptr<HostResolver> host_resolver(new HostResolverImpl(
-      NULL, DefaultLimits(), DefaultParams(resolver_proc), NULL));
+      NULL,
+      DefaultLimits(),
+      DefaultParams(resolver_proc),
+      scoped_ptr<DnsConfigService>(NULL),
+      NULL));
 
   // The class will receive callbacks for when each resolve completes. It
   // checks that the right things happened.
   StartWithinCallbackVerifier verifier;
 
   // Start 4 requests, duplicating hosts "a". Since the resolver_proc is
   // blocked, these should all pile up until we signal it.
 
   ResolveRequest req1(host_resolver.get(), "a", 80, &verifier);
   ResolveRequest req2(host_resolver.get(), "a", 81, &verifier);
@@ skipping 147 matching lines @@
   EXPECT_EQ(ERR_ABORTED, callback.WaitForResult());
 
   rv = host_resolver->Resolve(info, &addrlist, callback.callback(), NULL,
                               BoundNetLog());
   EXPECT_EQ(ERR_IO_PENDING, rv);
   resolver_proc->Wait();
   resolver_proc->Signal();
   EXPECT_EQ(OK, callback.WaitForResult());
 }
 
-class ResolveWithinCallback {
+// Helper class used by AbortOnlyExistingRequestsOnIPAddressChange.
+class StartWithinAbortedCallbackVerifier : public ResolveRequest::Delegate {
  public:
-  explicit ResolveWithinCallback(const HostResolver::RequestInfo& info)
-      : info_(info) {}
+  StartWithinAbortedCallbackVerifier(const std::string& next_hostname)
+      : next_hostname_(next_hostname) {}
 
-  const CompletionCallback& callback() const { return callback_.callback(); }
-
-  int WaitForResult() {
-    int result = callback_.WaitForResult();
-    // Ditch the WaitingHostResolverProc so that the subsequent request
-    // succeeds.
-    host_resolver_.reset(
-        CreateHostResolverImpl(CreateCatchAllHostResolverProc()));
-    EXPECT_EQ(ERR_IO_PENDING,
-              host_resolver_->Resolve(info_, &addrlist_,
-                                      nested_callback_.callback(), NULL,
-                                      BoundNetLog()));
-    return result;
+  virtual void OnCompleted(ResolveRequest* resolve) {

[mmenke, 2012/02/21 16:34:24]

nit:  OVERRIDE

[szym, 2012/02/21 17:18:20]

Done. Also on the other 10 cases.

+    if (request_.get() == NULL) {
+      EXPECT_EQ(ERR_ABORTED, resolve->result());
+      // Start new request for a different hostname to ensure that the order
+      // of jobs in HostResolverImpl is not stable.
+      request_.reset(new ResolveRequest(resolve->resolver(),
+                                        next_hostname_,
+                                        resolve->port(),
+                                        this));
+    } else {
+      EXPECT_EQ(resolve, request_.get());
+      callback_.callback().Run(resolve->result());
+    }
   }
 
-  int WaitForNestedResult() {
-    return nested_callback_.WaitForResult();
+  int WaitUntilDone() {
+    return callback_.WaitForResult();
   }
 
  private:
-  const HostResolver::RequestInfo info_;
-  AddressList addrlist_;
+  std::string next_hostname_;
+  scoped_ptr<ResolveRequest> request_;
   TestCompletionCallback callback_;
-  TestCompletionCallback nested_callback_;
-  scoped_ptr<HostResolver> host_resolver_;
+  DISALLOW_COPY_AND_ASSIGN(StartWithinAbortedCallbackVerifier);
 };
 
-TEST_F(HostResolverImplTest, OnlyAbortExistingRequestsOnIPAddressChange) {
+// Tests that a new Request made from the callback of a previously aborted one
+// will not be aborted.
+TEST_F(HostResolverImplTest, AbortOnlyExistingRequestsOnIPAddressChange) {
+  // Setting |manual_reset| to true so that Signal unblocks all calls.
   scoped_refptr<WaitingHostResolverProc> resolver_proc(
-      new WaitingHostResolverProc(CreateCatchAllHostResolverProc()));
+      new WaitingHostResolverProc(CreateCatchAllHostResolverProc(), true));
   scoped_ptr<HostResolver> host_resolver(CreateHostResolverImpl(resolver_proc));
 
-  // Resolve "host1".
-  HostResolver::RequestInfo info(HostPortPair("host1", 70));
-  ResolveWithinCallback callback(info);
-  AddressList addrlist;
-  int rv = host_resolver->Resolve(info, &addrlist, callback.callback(), NULL,
-                                  BoundNetLog());
-  EXPECT_EQ(ERR_IO_PENDING, rv);
+  StartWithinAbortedCallbackVerifier verifier1("zzz");
+  StartWithinAbortedCallbackVerifier verifier2("aaa");
+  StartWithinAbortedCallbackVerifier verifier3("eee");
 
+  ResolveRequest req1(host_resolver.get(), "bbb", 40, &verifier1);
+  ResolveRequest req2(host_resolver.get(), "eee", 80, &verifier2);
+  ResolveRequest req3(host_resolver.get(), "ccc", 90, &verifier3);
+  // The jobs start immediately.
+  // Wait until at least one is blocked.
   resolver_proc->Wait();
-  // Triggering an IP address change.
+  // Trigger an IP address change.
   NetworkChangeNotifier::NotifyObserversOfIPAddressChangeForTests();
-  MessageLoop::current()->RunAllPending();  // Notification happens async.
-  EXPECT_EQ(ERR_ABORTED, callback.WaitForResult());
-  resolver_proc->Signal();  // release the thread from WorkerPool for cleanup
-  EXPECT_EQ(OK, callback.WaitForNestedResult());
+  // This should abort all running jobs.
+  MessageLoop::current()->RunAllPending();
+  EXPECT_EQ(ERR_ABORTED, req1.result());
+  EXPECT_EQ(ERR_ABORTED, req2.result());
+  EXPECT_EQ(ERR_ABORTED, req3.result());
+  // Unblock all calls to proc.
+  resolver_proc->Signal();
+  // Run until the re-started requests finish.
+  EXPECT_EQ(OK, verifier1.WaitUntilDone());
+  EXPECT_EQ(OK, verifier2.WaitUntilDone());
+  EXPECT_EQ(OK, verifier3.WaitUntilDone());
+  MessageLoop::current()->AssertIdle();
 }
 
 // Tests that when the maximum threads is set to 1, requests are dequeued
 // in order of priority.
 TEST_F(HostResolverImplTest, HigherPriorityRequestsStartedFirst) {
   scoped_refptr<CapturingHostResolverProc> resolver_proc(
       new CapturingHostResolverProc(NULL));
 
   scoped_ptr<HostResolverImpl> host_resolver(
       CreateSerialHostResolverImpl(resolver_proc));
@@ skipping 362 matching lines @@
   // the host. First and second attempt will be forced to sleep until they get
   // word that a resolution has completed. The 3rd resolution attempt will try
   // to get done ASAP, and won't sleep..
   int kAttemptNumberToResolve = 3;
   int kTotalAttempts = 3;
 
   scoped_refptr<LookupAttemptHostResolverProc> resolver_proc(
       new LookupAttemptHostResolverProc(
           NULL, kAttemptNumberToResolve, kTotalAttempts));
 
-  HostResolverImpl::ProcTaskParams params = DefaultParams(resolver_proc);
+  HostResolverImpl::ProcTaskParams params = DefaultParams(resolver_proc.get());
 
   // Specify smaller interval for unresponsive_delay_ for HostResolverImpl so
   // that unit test runs faster. For example, this test finishes in 1.5 secs
   // (500ms * 3).
   params.unresponsive_delay = TimeDelta::FromMilliseconds(500);
 
   scoped_ptr<HostResolverImpl> host_resolver(
       new HostResolverImpl(HostCache::CreateDefaultCache(),
                            DefaultLimits(),
                            params,
+                           scoped_ptr<DnsConfigService>(NULL),
                            NULL));
 
   // Resolve "host1".
   HostResolver::RequestInfo info(HostPortPair("host1", 70));
   TestCompletionCallback callback;
   AddressList addrlist;
   int rv = host_resolver->Resolve(info, &addrlist, callback.callback(), NULL,
                                   BoundNetLog());
   EXPECT_EQ(ERR_IO_PENDING, rv);
 
   // Resolve returns -4 to indicate that 3rd attempt has resolved the host.
   EXPECT_EQ(-4, callback.WaitForResult());
 
   resolver_proc->WaitForAllAttemptsToFinish(TimeDelta::FromMilliseconds(60000));
   MessageLoop::current()->RunAllPending();
 
   EXPECT_EQ(resolver_proc->total_attempts_resolved(), kTotalAttempts);
   EXPECT_EQ(resolver_proc->resolved_attempt_number(), kAttemptNumberToResolve);
 }
 
 // TODO(cbentzel): Test a mix of requests with different HostResolverFlags.
 
 }  // namespace net