Refactorings surrounding HostResolver:...

chrome/browser/net/dns_master_unittest.cc

 // Copyright (c) 2006-2008 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 <time.h>
 
 #include <algorithm>
 #include <sstream>
 #include <string>
 
 #include "base/message_loop.h"
 #include "base/scoped_ptr.h"
+#include "base/string_util.h"
 #include "base/timer.h"
 #include "chrome/browser/net/dns_global.h"
 #include "chrome/browser/net/dns_host_info.h"
 #include "chrome/common/net/dns.h"
 #include "net/base/address_list.h"
-#include "net/base/host_resolver.h"
-#include "net/base/host_resolver_unittest.h"
+#include "net/base/mock_host_resolver.h"
 #include "net/base/winsock_init.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using base::Time;
 using base::TimeDelta;
 
 namespace chrome_browser_net {
 
 class WaitForResolutionHelper;
 
@@ skipping 22 matching lines @@
 
  private:
   DnsMaster* master_;
   const NameList hosts_;
   HelperTimer* timer_;
 };
 
 class DnsMasterTest : public testing::Test {
  public:
   DnsMasterTest()
-      : mapper_(new net::RuleBasedHostMapper()),
+      : host_resolver_(new net::MockHostResolver()),
         default_max_queueing_delay_(TimeDelta::FromMilliseconds(
-            DnsPrefetcherInit::kMaxQueueingDelayMs)),
-        scoped_mapper_(mapper_.get()) {
+            DnsPrefetcherInit::kMaxQueueingDelayMs)) {
   }
 
  protected:
   virtual void SetUp() {
 #if defined(OS_WIN)
     net::EnsureWinsockInit();
 #endif
-    mapper_->AddRuleWithLatency("www.google.com", "127.0.0.1", 50);
-    mapper_->AddRuleWithLatency("gmail.google.com.com", "127.0.0.1", 70);
-    mapper_->AddRuleWithLatency("mail.google.com", "127.0.0.1", 44);
-    mapper_->AddRuleWithLatency("gmail.com", "127.0.0.1", 63);
+    net::RuleBasedHostResolverProc* rules = host_resolver_->rules();
+    rules->AddRuleWithLatency("www.google.com", "127.0.0.1", 50);
+    rules->AddRuleWithLatency("gmail.google.com.com", "127.0.0.1", 70);
+    rules->AddRuleWithLatency("mail.google.com", "127.0.0.1", 44);
+    rules->AddRuleWithLatency("gmail.com", "127.0.0.1", 63);
   }
 
   void WaitForResolution(DnsMaster* master, const NameList& hosts) {
     HelperTimer* timer = new HelperTimer();
     timer->Start(TimeDelta::FromMilliseconds(100),
                  new WaitForResolutionHelper(master, hosts, timer),
                  &WaitForResolutionHelper::Run);
     MessageLoop::current()->Run();
   }
 
-  scoped_refptr<net::RuleBasedHostMapper> mapper_;
+ private:
+  // IMPORTANT: do not move this below |host_resolver_|; the host resolver
+  // must not outlive the message loop, otherwise bad things can happen
+  // (like posting to a deleted message loop).
+  MessageLoop loop;
+
+ protected:
+  scoped_refptr<net::MockHostResolver> host_resolver_;
 
   // Shorthand to access TimeDelta of DnsPrefetcherInit::kMaxQueueingDelayMs.
   // (It would be a static constant... except style rules preclude that :-/ ).
   const TimeDelta default_max_queueing_delay_;
-
- private:
-  MessageLoop loop;
-  net::ScopedHostMapper scoped_mapper_;
 };
 
 //------------------------------------------------------------------------------
 // Provide a function to create unique (nonexistant) domains at *every* call.
 //------------------------------------------------------------------------------
 static std::string GetNonexistantDomain() {
   static std::string postfix = ".google.com";
   static std::string prefix = "www.";
   static std::string mid = "datecount";
 
   static int counter = 0;  // Make sure its unique.
   time_t number = time(NULL);
   std::ostringstream result;
   result << prefix << number << mid << ++counter << postfix;
   return result.str();
 }
 
 //------------------------------------------------------------------------------
 // Use a blocking function to contrast results we get via async services.
 //------------------------------------------------------------------------------
-TimeDelta BlockingDnsLookup(const std::string& hostname) {
-    Time start = Time::Now();
+TimeDelta BlockingDnsLookup(net::HostResolver* resolver,
+                            const std::string& hostname) {
+  Time start = Time::Now();
 
-    scoped_refptr<net::HostResolver> resolver(new net::HostResolver);
-    net::AddressList addresses;
-    net::HostResolver::RequestInfo info(hostname, 80);
-    resolver->Resolve(info, &addresses, NULL, NULL);
+  net::AddressList addresses;
+  net::HostResolver::RequestInfo info(hostname, 80);
+  resolver->Resolve(info, &addresses, NULL, NULL);
 
-    return Time::Now() - start;
+  return Time::Now() - start;
 }
 
 //------------------------------------------------------------------------------
 
 // First test to be sure the OS is caching lookups, which is the whole premise
 // of DNS prefetching.
 TEST_F(DnsMasterTest, OsCachesLookupsTest) {
-  mapper_->AllowDirectLookup("*.google.com");
+  // Make sure caching is disabled in the mock host resolver.
+  host_resolver_->Reset(NULL, 0, 0);
+  host_resolver_->rules()->AllowDirectLookup("*.google.com");
 
   const Time start = Time::Now();
   int all_lookups = 0;
   int lookups_with_improvement = 0;
   // This test can be really flaky on Linux. It should run in much shorter time,
   // but sometimes it won't and we don't like bogus failures.
   while (Time::Now() - start < TimeDelta::FromMinutes(1)) {
     std::string badname;
     badname = GetNonexistantDomain();
 
-    TimeDelta duration = BlockingDnsLookup(badname);
+    TimeDelta duration = BlockingDnsLookup(host_resolver_, badname);
 
     // Produce more than one result and remove the largest one
     // to reduce flakiness.
     std::vector<TimeDelta> cached_results;
     for (int j = 0; j < 3; j++)
-      cached_results.push_back(BlockingDnsLookup(badname));
+      cached_results.push_back(BlockingDnsLookup(host_resolver_, badname));
     std::sort(cached_results.begin(), cached_results.end());
     cached_results.pop_back();
 
     TimeDelta cached_sum = TimeDelta::FromSeconds(0);
     for (std::vector<TimeDelta>::const_iterator j = cached_results.begin();
          j != cached_results.end(); ++j)
       cached_sum += *j;
     TimeDelta cached_duration = cached_sum / cached_results.size();
 
     all_lookups++;
     if (cached_duration < duration)
       lookups_with_improvement++;
     if (all_lookups >= 10)
       if (lookups_with_improvement * 100 > all_lookups * 75)
         // Okay, we see the improvement for more than 75% of all lookups.
         return;
   }
   FAIL() << "No substantial improvement in lookup time.";
 }
 
 TEST_F(DnsMasterTest, StartupShutdownTest) {
-  scoped_refptr<DnsMaster> testing_master = new DnsMaster(new net::HostResolver,
+  scoped_refptr<DnsMaster> testing_master = new DnsMaster(host_resolver_,
       MessageLoop::current(), default_max_queueing_delay_,
       DnsPrefetcherInit::kMaxConcurrentLookups);
   testing_master->Shutdown();
 }
 
 TEST_F(DnsMasterTest, BenefitLookupTest) {
-  scoped_refptr<DnsMaster> testing_master = new DnsMaster(new net::HostResolver,
+  scoped_refptr<DnsMaster> testing_master = new DnsMaster(host_resolver_,
       MessageLoop::current(), default_max_queueing_delay_,
       DnsPrefetcherInit::kMaxConcurrentLookups);
 
   std::string goog("www.google.com"),
     goog2("gmail.google.com.com"),
     goog3("mail.google.com"),
     goog4("gmail.com");
   DnsHostInfo goog_info, goog2_info, goog3_info, goog4_info;
 
   // Simulate getting similar names from a network observer
@@ skipping 40 matching lines @@
   // Benefits can ONLY be reported once (for the first navigation).
   EXPECT_FALSE(testing_master->AccruePrefetchBenefits(GURL(), &goog_info));
   EXPECT_FALSE(testing_master->AccruePrefetchBenefits(GURL(), &goog2_info));
   EXPECT_FALSE(testing_master->AccruePrefetchBenefits(GURL(), &goog3_info));
   EXPECT_FALSE(testing_master->AccruePrefetchBenefits(GURL(), &goog4_info));
 
   testing_master->Shutdown();
 }
 
 TEST_F(DnsMasterTest, ShutdownWhenResolutionIsPendingTest) {
-  scoped_refptr<net::WaitingHostMapper> mapper = new net::WaitingHostMapper();
-  net::ScopedHostMapper scoped_mapper(mapper.get());
+  scoped_refptr<net::WaitingHostResolverProc> resolver_proc =
+      new net::WaitingHostResolverProc(NULL);
+  host_resolver_->Reset(resolver_proc, 0, 0);
 
-  scoped_refptr<DnsMaster> testing_master = new DnsMaster(new net::HostResolver,
+  scoped_refptr<DnsMaster> testing_master = new DnsMaster(host_resolver_,
       MessageLoop::current(), default_max_queueing_delay_,
       DnsPrefetcherInit::kMaxConcurrentLookups);
 
   std::string localhost("127.0.0.1");
   NameList names;
   names.insert(names.end(), localhost);
 
   testing_master->ResolveList(names, DnsHostInfo::PAGE_SCAN_MOTIVATED);
 
   MessageLoop::current()->PostDelayedTask(FROM_HERE,
                                           new MessageLoop::QuitTask(), 500);
   MessageLoop::current()->Run();
 
   EXPECT_FALSE(testing_master->WasFound(localhost));
 
   testing_master->Shutdown();
 
   // Clean up after ourselves.
-  mapper->Signal();
+  resolver_proc->Signal();
   MessageLoop::current()->RunAllPending();
 }
 
 TEST_F(DnsMasterTest, SingleLookupTest) {
-  scoped_refptr<DnsMaster> testing_master = new DnsMaster(new net::HostResolver,
+  scoped_refptr<DnsMaster> testing_master = new DnsMaster(host_resolver_,
       MessageLoop::current(), default_max_queueing_delay_,
       DnsPrefetcherInit::kMaxConcurrentLookups);
 
   std::string goog("www.google.com");
 
   NameList names;
   names.insert(names.end(), goog);
 
   // Try to flood the master with many concurrent requests.
   for (int i = 0; i < 10; i++)
     testing_master->ResolveList(names, DnsHostInfo::PAGE_SCAN_MOTIVATED);
 
   WaitForResolution(testing_master, names);
 
   EXPECT_TRUE(testing_master->WasFound(goog));
 
   MessageLoop::current()->RunAllPending();
 
   EXPECT_GT(testing_master->peak_pending_lookups(), names.size() / 2);
   EXPECT_LE(testing_master->peak_pending_lookups(), names.size());
   EXPECT_LE(testing_master->peak_pending_lookups(),
             testing_master->max_concurrent_lookups());
 
   testing_master->Shutdown();
 }
 
 TEST_F(DnsMasterTest, ConcurrentLookupTest) {
-  mapper_->AddSimulatedFailure("*.notfound");
+  host_resolver_->rules()->AddSimulatedFailure("*.notfound");
 
-  scoped_refptr<DnsMaster> testing_master = new DnsMaster(new net::HostResolver,
+  scoped_refptr<DnsMaster> testing_master = new DnsMaster(host_resolver_,
       MessageLoop::current(), default_max_queueing_delay_,
       DnsPrefetcherInit::kMaxConcurrentLookups);
 
   std::string goog("www.google.com"),
     goog2("gmail.google.com.com"),
     goog3("mail.google.com"),
     goog4("gmail.com");
   std::string bad1("bad1.notfound"),
     bad2("bad2.notfound");
 
   NameList names;
   names.insert(names.end(), goog);
   names.insert(names.end(), goog3);
   names.insert(names.end(), bad1);
   names.insert(names.end(), goog2);
   names.insert(names.end(), bad2);
   names.insert(names.end(), goog4);
   names.insert(names.end(), goog);
 
-  // Warm up the *OS* cache for all the goog domains.
-  BlockingDnsLookup(goog);
-  BlockingDnsLookup(goog2);
-  BlockingDnsLookup(goog3);
-  BlockingDnsLookup(goog4);
-
   // Try to flood the master with many concurrent requests.
   for (int i = 0; i < 10; i++)
     testing_master->ResolveList(names, DnsHostInfo::PAGE_SCAN_MOTIVATED);
 
   WaitForResolution(testing_master, names);
 
   EXPECT_TRUE(testing_master->WasFound(goog));
   EXPECT_TRUE(testing_master->WasFound(goog3));
   EXPECT_TRUE(testing_master->WasFound(goog2));
   EXPECT_TRUE(testing_master->WasFound(goog4));
   EXPECT_FALSE(testing_master->WasFound(bad1));
   EXPECT_FALSE(testing_master->WasFound(bad2));
 
   MessageLoop::current()->RunAllPending();
 
   EXPECT_FALSE(testing_master->WasFound(bad1));
   EXPECT_FALSE(testing_master->WasFound(bad2));
 
   EXPECT_GT(testing_master->peak_pending_lookups(), names.size() / 2);
   EXPECT_LE(testing_master->peak_pending_lookups(), names.size());
   EXPECT_LE(testing_master->peak_pending_lookups(),
             testing_master->max_concurrent_lookups());
 
   testing_master->Shutdown();
 }
 
 TEST_F(DnsMasterTest, DISABLED_MassiveConcurrentLookupTest) {
-  mapper_->AddSimulatedFailure("*.notfound");
+  host_resolver_->rules()->AddSimulatedFailure("*.notfound");
 
-  scoped_refptr<DnsMaster> testing_master = new DnsMaster(new net::HostResolver,
+  scoped_refptr<DnsMaster> testing_master = new DnsMaster(host_resolver_,
       MessageLoop::current(), default_max_queueing_delay_,
       DnsPrefetcherInit::kMaxConcurrentLookups);
 
   NameList names;
   for (int i = 0; i < 100; i++)
     names.push_back("host" + IntToString(i) + ".notfound");
 
   // Try to flood the master with many concurrent requests.
   for (int i = 0; i < 10; i++)
     testing_master->ResolveList(names, DnsHostInfo::PAGE_SCAN_MOTIVATED);
@@ skipping 84 matching lines @@
     }
     ++i;  // Skip latency value.
   }
   return kLatencyNotFound;
 }
 
 //------------------------------------------------------------------------------
 
 // Make sure nil referral lists really have no entries, and no latency listed.
 TEST_F(DnsMasterTest, ReferrerSerializationNilTest) {
-  scoped_refptr<DnsMaster> master = new DnsMaster(new net::HostResolver,
+  scoped_refptr<DnsMaster> master = new DnsMaster(host_resolver_,
       MessageLoop::current(), default_max_queueing_delay_,
       DnsPrefetcherInit::kMaxConcurrentLookups);
   ListValue referral_list;
   master->SerializeReferrers(&referral_list);
   EXPECT_EQ(0U, referral_list.GetSize());
   EXPECT_EQ(kLatencyNotFound, GetLatencyFromSerialization("a.com", "b.com",
                                                           referral_list));
 
   master->Shutdown();
 }
 
 // Make sure that when a serialization list includes a value, that it can be
 // deserialized into the database, and can be extracted back out via
 // serialization without being changed.
 TEST_F(DnsMasterTest, ReferrerSerializationSingleReferrerTest) {
-  scoped_refptr<DnsMaster> master = new DnsMaster(new net::HostResolver,
+  scoped_refptr<DnsMaster> master = new DnsMaster(host_resolver_,
       MessageLoop::current(), default_max_queueing_delay_,
       DnsPrefetcherInit::kMaxConcurrentLookups);
   std::string motivation_hostname = "www.google.com";
   std::string subresource_hostname = "icons.google.com";
   const int kLatency = 3;
   ListValue referral_list;
 
   AddToSerializedList(motivation_hostname, subresource_hostname, kLatency,
                       &referral_list);
 
   master->DeserializeReferrers(referral_list);
 
   ListValue recovered_referral_list;
   master->SerializeReferrers(&recovered_referral_list);
   EXPECT_EQ(1U, recovered_referral_list.GetSize());
   EXPECT_EQ(kLatency, GetLatencyFromSerialization(motivation_hostname,
                                                   subresource_hostname,
                                                   recovered_referral_list));
 
   master->Shutdown();
 }
 
 // Make sure the Trim() functionality works as expected.
 TEST_F(DnsMasterTest, ReferrerSerializationTrimTest) {
-  scoped_refptr<DnsMaster> master = new DnsMaster(new net::HostResolver,
+  scoped_refptr<DnsMaster> master = new DnsMaster(host_resolver_,
       MessageLoop::current(), default_max_queueing_delay_,
       DnsPrefetcherInit::kMaxConcurrentLookups);
   std::string motivation_hostname = "www.google.com";
   std::string icon_subresource_hostname = "icons.google.com";
   std::string img_subresource_hostname = "img.google.com";
   ListValue referral_list;
 
   AddToSerializedList(motivation_hostname, icon_subresource_hostname, 10,
                       &referral_list);
   AddToSerializedList(motivation_hostname, img_subresource_hostname, 3,
@@ skipping 114 matching lines @@
   EXPECT_EQ(queue.Pop(), "startup");
   EXPECT_EQ(queue.Pop(), "omni");
 
   EXPECT_TRUE(queue.IsEmpty());
 }
 
 
 
 
 }  // namespace chrome_browser_net