Define the public interface for content browser SiteInstance. This interface is implemented by th...

content/browser/site_instance_unittest.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.

[jam, 2012/01/24 03:29:33]

nit: rename this file to site_instance_impl_unittest.cc (we do this by
convention)

[ananta, 2012/01/24 23:46:26]

Done.

 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/compiler_specific.h"
 #include "base/stl_util.h"
 #include "base/string16.h"
 #include "content/browser/browser_thread_impl.h"
 #include "content/browser/browsing_instance.h"
 #include "content/browser/child_process_security_policy.h"
 #include "content/browser/mock_content_browser_client.h"
 #include "content/browser/renderer_host/render_process_host_impl.h"
 #include "content/browser/renderer_host/render_view_host.h"
 #include "content/browser/renderer_host/test_render_view_host.h"
-#include "content/browser/site_instance.h"
+#include "content/browser/site_instance_impl.h"
 #include "content/browser/tab_contents/navigation_entry_impl.h"
 #include "content/browser/tab_contents/tab_contents.h"
 #include "content/browser/webui/empty_web_ui_factory.h"
 #include "content/public/common/content_client.h"
 #include "content/public/common/content_constants.h"
 #include "content/public/common/url_constants.h"
 #include "content/test/test_browser_context.h"
 #include "googleurl/src/url_util.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
@@ skipping 119 matching lines @@
   virtual ~TestBrowsingInstance() {
     (*delete_counter_)++;
   }
 
   // Set by individual tests.
   bool use_process_per_site_;
 
   int* delete_counter_;
 };
 
-class TestSiteInstance : public SiteInstance {
+class TestSiteInstance : public SiteInstanceImpl {
  public:
   static TestSiteInstance* CreateTestSiteInstance(
       content::BrowserContext* browser_context,
       int* site_delete_counter,
       int* browsing_delete_counter) {
     TestBrowsingInstance* browsing_instance =
         new TestBrowsingInstance(browser_context, browsing_delete_counter);
     return new TestSiteInstance(browsing_instance, site_delete_counter);
   }
 
  private:
   TestSiteInstance(BrowsingInstance* browsing_instance, int* delete_counter)
-    : SiteInstance(browsing_instance), delete_counter_(delete_counter) {}
+    : SiteInstanceImpl(browsing_instance), delete_counter_(delete_counter) {}
   virtual ~TestSiteInstance() {
     (*delete_counter_)++;
   }
 
   int* delete_counter_;
 };
 
 }  // namespace
 
 // Test to ensure no memory leaks for SiteInstance objects.
@@ skipping 62 matching lines @@
 
 // Test that NavigationEntries with SiteInstances can be cloned, but that their
 // SiteInstances can be changed afterwards.  Also tests that the ref counts are
 // updated properly after the change.
 TEST_F(SiteInstanceTest, CloneNavigationEntry) {
   int site_delete_counter1 = 0;
   int site_delete_counter2 = 0;
   int browsing_delete_counter = 0;
   const GURL url("test:foo");
 
-  SiteInstance* instance1 =
+  content::SiteInstance* instance1 =
       TestSiteInstance::CreateTestSiteInstance(NULL, &site_delete_counter1,
                                                &browsing_delete_counter);
-  SiteInstance* instance2 =
+  content::SiteInstance* instance2 =
       TestSiteInstance::CreateTestSiteInstance(NULL, &site_delete_counter2,
                                                &browsing_delete_counter);
 
   NavigationEntryImpl* e1 = new NavigationEntryImpl(
       instance1, 0, url, content::Referrer(), string16(),
       content::PAGE_TRANSITION_LINK, false);
   // Clone the entry
   NavigationEntryImpl* e2 = new NavigationEntryImpl(*e1);
 
   // Should be able to change the SiteInstance of the cloned entry.
@@ skipping 12 matching lines @@
 
   // Both BrowsingInstances are also now deleted
   EXPECT_EQ(2, browsing_delete_counter);
 }
 
 // Test to ensure GetProcess returns and creates processes correctly.
 TEST_F(SiteInstanceTest, GetProcess) {
   // Ensure that GetProcess returns a process.
   scoped_ptr<TestBrowserContext> browser_context(new TestBrowserContext());
   scoped_ptr<content::RenderProcessHost> host1;
-  scoped_refptr<SiteInstance> instance(
-      SiteInstance::CreateSiteInstance(browser_context.get()));
+  scoped_refptr<content::SiteInstance> instance(
+      content::SiteInstance::CreateSiteInstance(browser_context.get()));
   host1.reset(instance->GetProcess());
   EXPECT_TRUE(host1.get() != NULL);
 
   // Ensure that GetProcess creates a new process.
-  scoped_refptr<SiteInstance> instance2(
-      SiteInstance::CreateSiteInstance(browser_context.get()));
+  scoped_refptr<content::SiteInstance> instance2(
+    content::SiteInstance::CreateSiteInstance(browser_context.get()));
   scoped_ptr<content::RenderProcessHost> host2(instance2->GetProcess());
   EXPECT_TRUE(host2.get() != NULL);
   EXPECT_NE(host1.get(), host2.get());
 }
 
 // Test to ensure SetSite and site() work properly.
 TEST_F(SiteInstanceTest, SetSite) {
-  scoped_refptr<SiteInstance> instance(SiteInstance::CreateSiteInstance(NULL));
-  EXPECT_FALSE(instance->has_site());
-  EXPECT_TRUE(instance->site().is_empty());
+  scoped_refptr<content::SiteInstance> instance(
+      content::SiteInstance::CreateSiteInstance(NULL));
+  EXPECT_FALSE(instance->HasSite());
+  EXPECT_TRUE(instance->GetSite().is_empty());
 
   instance->SetSite(GURL("http://www.google.com/index.html"));
-  EXPECT_EQ(GURL("http://google.com"), instance->site());
+  EXPECT_EQ(GURL("http://google.com"), instance->GetSite());
 
-  EXPECT_TRUE(instance->has_site());
+  EXPECT_TRUE(instance->HasSite());
 }
 
 // Test to ensure GetSiteForURL properly returns sites for URLs.
 TEST_F(SiteInstanceTest, GetSiteForURL) {
   // Pages are irrelevant.
   GURL test_url = GURL("http://www.google.com/index.html");
   EXPECT_EQ(GURL("http://google.com"),
-            SiteInstance::GetSiteForURL(NULL, test_url));
+            content::SiteInstance::GetSiteForURL(NULL, test_url));
 
   // Ports are irrlevant.
   test_url = GURL("https://www.google.com:8080");
   EXPECT_EQ(GURL("https://google.com"),
-            SiteInstance::GetSiteForURL(NULL, test_url));
+            content::SiteInstance::GetSiteForURL(NULL, test_url));
 
   // Javascript URLs have no site.
   test_url = GURL("javascript:foo();");
-  EXPECT_EQ(GURL(), SiteInstance::GetSiteForURL(NULL, test_url));
+  EXPECT_EQ(GURL(), content::SiteInstance::GetSiteForURL(NULL, test_url));
 
   test_url = GURL("http://foo/a.html");
-  EXPECT_EQ(GURL("http://foo"), SiteInstance::GetSiteForURL(NULL, test_url));
+  EXPECT_EQ(GURL("http://foo"), content::SiteInstance::GetSiteForURL(
+      NULL, test_url));
 
   test_url = GURL("file:///C:/Downloads/");
-  EXPECT_EQ(GURL(), SiteInstance::GetSiteForURL(NULL, test_url));
+  EXPECT_EQ(GURL(), content::SiteInstance::GetSiteForURL(NULL, test_url));
 
   // TODO(creis): Do we want to special case file URLs to ensure they have
   // either no site or a special "file://" site?  We currently return
   // "file://home/" as the site, which seems broken.
   // test_url = GURL("file://home/");
   // EXPECT_EQ(GURL(), SiteInstance::GetSiteForURL(NULL, test_url));
 }
 
 // Test of distinguishing URLs from different sites.  Most of this logic is
 // tested in RegistryControlledDomainTest.  This test focuses on URLs with
 // different schemes or ports.
 TEST_F(SiteInstanceTest, IsSameWebSite) {
   GURL url_foo = GURL("http://foo/a.html");
   GURL url_foo2 = GURL("http://foo/b.html");
   GURL url_foo_https = GURL("https://foo/a.html");
   GURL url_foo_port = GURL("http://foo:8080/a.html");
   GURL url_javascript = GURL("javascript:alert(1);");
   GURL url_crash = GURL(chrome::kAboutCrashURL);
   GURL url_browser_specified = GURL(kSameAsAnyInstanceURL);
 
   // Same scheme and port -> same site.
-  EXPECT_TRUE(SiteInstance::IsSameWebSite(NULL, url_foo, url_foo2));
+  EXPECT_TRUE(content::SiteInstance::IsSameWebSite(NULL, url_foo, url_foo2));
 
   // Different scheme -> different site.
-  EXPECT_FALSE(SiteInstance::IsSameWebSite(NULL, url_foo, url_foo_https));
+  EXPECT_FALSE(content::SiteInstance::IsSameWebSite(NULL, url_foo,
+                                                    url_foo_https));
 
   // Different port -> same site.
   // (Changes to document.domain make renderer ignore the port.)
-  EXPECT_TRUE(SiteInstance::IsSameWebSite(NULL, url_foo, url_foo_port));
+  EXPECT_TRUE(content::SiteInstance::IsSameWebSite(NULL, url_foo,
+                                                   url_foo_port));
 
   // JavaScript links should be considered same site for anything.
-  EXPECT_TRUE(SiteInstance::IsSameWebSite(NULL, url_javascript, url_foo));
-  EXPECT_TRUE(SiteInstance::IsSameWebSite(NULL, url_javascript, url_foo_https));
-  EXPECT_TRUE(SiteInstance::IsSameWebSite(NULL, url_javascript, url_foo_port));
+  EXPECT_TRUE(content::SiteInstance::IsSameWebSite(NULL, url_javascript,
+                                                   url_foo));
+  EXPECT_TRUE(content::SiteInstance::IsSameWebSite(NULL, url_javascript,
+                                                   url_foo_https));
+  EXPECT_TRUE(content::SiteInstance::IsSameWebSite(NULL, url_javascript,
+                                                   url_foo_port));
 
   // The URLs specified by the ContentBrowserClient should also be treated as
   // same site.
-  EXPECT_TRUE(SiteInstance::IsSameWebSite(NULL, url_crash, url_foo));
+  EXPECT_TRUE(content::SiteInstance::IsSameWebSite(NULL, url_crash,
+                                                   url_foo));
   EXPECT_TRUE(
-      SiteInstance::IsSameWebSite(NULL, url_browser_specified, url_foo));
+      content::SiteInstance::IsSameWebSite(NULL, url_browser_specified,
+      url_foo));
 }
 
 // Test to ensure that there is only one SiteInstance per site in a given
 // BrowsingInstance, when process-per-site is not in use.
 TEST_F(SiteInstanceTest, OneSiteInstancePerSite) {
   int delete_counter = 0;
   TestBrowsingInstance* browsing_instance =
       new TestBrowsingInstance(NULL, &delete_counter);
   browsing_instance->set_use_process_per_site(false);
 
   const GURL url_a1("http://www.google.com/1.html");
-  scoped_refptr<SiteInstance> site_instance_a1(
+  scoped_refptr<content::SiteInstance> site_instance_a1(
       browsing_instance->GetSiteInstanceForURL(url_a1));
   EXPECT_TRUE(site_instance_a1.get() != NULL);
 
   // A separate site should create a separate SiteInstance.
   const GURL url_b1("http://www.yahoo.com/");
-  scoped_refptr<SiteInstance> site_instance_b1(
+  scoped_refptr<content::SiteInstance> site_instance_b1(
       browsing_instance->GetSiteInstanceForURL(url_b1));
   EXPECT_NE(site_instance_a1.get(), site_instance_b1.get());
 
   // Getting the new SiteInstance from the BrowsingInstance and from another
   // SiteInstance in the BrowsingInstance should give the same result.
   EXPECT_EQ(site_instance_b1.get(),
             site_instance_a1->GetRelatedSiteInstance(url_b1));
 
   // A second visit to the original site should return the same SiteInstance.
   const GURL url_a2("http://www.google.com/2.html");
   EXPECT_EQ(site_instance_a1.get(),
             browsing_instance->GetSiteInstanceForURL(url_a2));
   EXPECT_EQ(site_instance_a1.get(),
             site_instance_a1->GetRelatedSiteInstance(url_a2));
 
   // A visit to the original site in a new BrowsingInstance (same or different
   // browser context) should return a different SiteInstance.
   TestBrowsingInstance* browsing_instance2 =
       new TestBrowsingInstance(NULL, &delete_counter);
   browsing_instance2->set_use_process_per_site(false);
   // Ensure the new SiteInstance is ref counted so that it gets deleted.
-  scoped_refptr<SiteInstance> site_instance_a2_2(
+  scoped_refptr<content::SiteInstance> site_instance_a2_2(
       browsing_instance2->GetSiteInstanceForURL(url_a2));
   EXPECT_NE(site_instance_a1.get(), site_instance_a2_2.get());
 
   // Should be able to see that we do have SiteInstances.
   EXPECT_TRUE(browsing_instance->HasSiteInstance(
       GURL("http://mail.google.com")));
   EXPECT_TRUE(browsing_instance2->HasSiteInstance(
       GURL("http://mail.google.com")));
   EXPECT_TRUE(browsing_instance->HasSiteInstance(
       GURL("http://mail.yahoo.com")));
 
   // Should be able to see that we don't have SiteInstances.
   EXPECT_FALSE(browsing_instance->HasSiteInstance(
       GURL("https://www.google.com")));
   EXPECT_FALSE(browsing_instance2->HasSiteInstance(
       GURL("http://www.yahoo.com")));
 
   // browsing_instances will be deleted when their SiteInstances are deleted
 }
 
 // Test to ensure that there is only one SiteInstance per site for an entire
 // BrowserContext, if process-per-site is in use.
 TEST_F(SiteInstanceTest, OneSiteInstancePerSiteInBrowserContext) {
   int delete_counter = 0;
   TestBrowsingInstance* browsing_instance =
       new TestBrowsingInstance(NULL, &delete_counter);
   browsing_instance->set_use_process_per_site(true);
 
   const GURL url_a1("http://www.google.com/1.html");
-  scoped_refptr<SiteInstance> site_instance_a1(
+  scoped_refptr<content::SiteInstance> site_instance_a1(
       browsing_instance->GetSiteInstanceForURL(url_a1));
   EXPECT_TRUE(site_instance_a1.get() != NULL);
 
   // A separate site should create a separate SiteInstance.
   const GURL url_b1("http://www.yahoo.com/");
-  scoped_refptr<SiteInstance> site_instance_b1(
+  scoped_refptr<content::SiteInstance> site_instance_b1(
       browsing_instance->GetSiteInstanceForURL(url_b1));
   EXPECT_NE(site_instance_a1.get(), site_instance_b1.get());
 
   // Getting the new SiteInstance from the BrowsingInstance and from another
   // SiteInstance in the BrowsingInstance should give the same result.
   EXPECT_EQ(site_instance_b1.get(),
             site_instance_a1->GetRelatedSiteInstance(url_b1));
 
   // A second visit to the original site should return the same SiteInstance.
   const GURL url_a2("http://www.google.com/2.html");
@@ skipping 13 matching lines @@
   EXPECT_EQ(site_instance_a1.get(),
             browsing_instance2->GetSiteInstanceForURL(url_a2));
 
   // A visit to the original site in a new BrowsingInstance (different browser
   // context) should return a different SiteInstance.
   scoped_ptr<TestBrowserContext> browser_context(new TestBrowserContext());
   TestBrowsingInstance* browsing_instance3 =
       new TestBrowsingInstance(browser_context.get(), &delete_counter);
   browsing_instance3->set_use_process_per_site(true);
   // Ensure the new SiteInstance is ref counted so that it gets deleted.
-  scoped_refptr<SiteInstance> site_instance_a2_3(
+  scoped_refptr<content::SiteInstance> site_instance_a2_3(
       browsing_instance3->GetSiteInstanceForURL(url_a2));
   EXPECT_NE(site_instance_a1.get(), site_instance_a2_3.get());
 
   // Should be able to see that we do have SiteInstances.
   EXPECT_TRUE(browsing_instance->HasSiteInstance(
       GURL("http://mail.google.com")));  // visited before
   EXPECT_TRUE(browsing_instance2->HasSiteInstance(
       GURL("http://mail.google.com")));  // visited before
   EXPECT_TRUE(browsing_instance->HasSiteInstance(
       GURL("http://mail.yahoo.com")));  // visited before
   EXPECT_TRUE(browsing_instance2->HasSiteInstance(
       GURL("http://www.yahoo.com")));  // different BI, but same browser context
 
   // Should be able to see that we don't have SiteInstances.
   EXPECT_FALSE(browsing_instance->HasSiteInstance(
       GURL("https://www.google.com")));  // not visited before
   EXPECT_FALSE(browsing_instance3->HasSiteInstance(
       GURL("http://www.yahoo.com")));  // different BI, different context
 
   // browsing_instances will be deleted when their SiteInstances are deleted
 }
 
-static SiteInstance* CreateSiteInstance(
+static SiteInstanceImpl* CreateSiteInstance(
     content::RenderProcessHostFactory* factory, const GURL& url) {
-  SiteInstance* instance = SiteInstance::CreateSiteInstanceForURL(NULL, url);
+  SiteInstanceImpl* instance =
+      reinterpret_cast<SiteInstanceImpl*>(
+          content::SiteInstance::CreateSiteInstanceForURL(NULL, url));
   instance->set_render_process_host_factory(factory);
   return instance;
 }
 
 // Test to ensure that pages that require certain privileges are grouped
 // in processes with similar pages.
 TEST_F(SiteInstanceTest, ProcessSharingByType) {
   MockRenderProcessHostFactory rph_factory;
   ChildProcessSecurityPolicy* policy =
       ChildProcessSecurityPolicy::GetInstance();
 
   // Make a bunch of mock renderers so that we hit the limit.
   std::vector<MockRenderProcessHost*> hosts;
   for (size_t i = 0; i < content::kMaxRendererProcessCount; ++i)
     hosts.push_back(new MockRenderProcessHost(NULL));
 
   // Create some extension instances and make sure they share a process.
-  scoped_refptr<SiteInstance> extension1_instance(
+  scoped_refptr<content::SiteInstance> extension1_instance(
       CreateSiteInstance(&rph_factory,
-      GURL(kPrivilegedScheme + std::string("://foo/bar"))));
+          GURL(kPrivilegedScheme + std::string("://foo/bar"))));
   set_privileged_process_id(extension1_instance->GetProcess()->GetID());
 
-  scoped_refptr<SiteInstance> extension2_instance(
+  scoped_refptr<content::SiteInstance> extension2_instance(
       CreateSiteInstance(&rph_factory,
-      GURL(kPrivilegedScheme + std::string("://baz/bar"))));
+          GURL(kPrivilegedScheme + std::string("://baz/bar"))));
 
   scoped_ptr<content::RenderProcessHost> extension_host(
       extension1_instance->GetProcess());
   EXPECT_EQ(extension1_instance->GetProcess(),
             extension2_instance->GetProcess());
 
   // Create some WebUI instances and make sure they share a process.
-  scoped_refptr<SiteInstance> webui1_instance(CreateSiteInstance(&rph_factory,
+  scoped_refptr<content::SiteInstance> webui1_instance(CreateSiteInstance(
+      &rph_factory,
       GURL(chrome::kChromeUIScheme + std::string("://newtab"))));
   policy->GrantWebUIBindings(webui1_instance->GetProcess()->GetID());
 
-  scoped_refptr<SiteInstance> webui2_instance(CreateSiteInstance(&rph_factory,
+  scoped_refptr<content::SiteInstance> webui2_instance(CreateSiteInstance(
+      &rph_factory,
       GURL(chrome::kChromeUIScheme + std::string("://history"))));
 
   scoped_ptr<content::RenderProcessHost> dom_host(
       webui1_instance->GetProcess());
   EXPECT_EQ(webui1_instance->GetProcess(), webui2_instance->GetProcess());
 
   // Make sure none of differing privilege processes are mixed.
   EXPECT_NE(extension1_instance->GetProcess(), webui1_instance->GetProcess());
 
   for (size_t i = 0; i < content::kMaxRendererProcessCount; ++i) {
     EXPECT_NE(extension1_instance->GetProcess(), hosts[i]);
     EXPECT_NE(webui1_instance->GetProcess(), hosts[i]);
   }
 
   STLDeleteContainerPointers(hosts.begin(), hosts.end());
 }
 
 // Test to ensure that HasWrongProcessForURL behaves properly for different
 // types of URLs.
 TEST_F(SiteInstanceTest, HasWrongProcessForURL) {
   scoped_ptr<TestBrowserContext> browser_context(new TestBrowserContext());
   scoped_ptr<content::RenderProcessHost> host;
-  scoped_refptr<SiteInstance> instance(
-      SiteInstance::CreateSiteInstance(browser_context.get()));
+  scoped_refptr<content::SiteInstance> instance(
+      content::SiteInstance::CreateSiteInstance(browser_context.get()));
 
-  EXPECT_FALSE(instance->has_site());
-  EXPECT_TRUE(instance->site().is_empty());
+  EXPECT_FALSE(instance->HasSite());
+  EXPECT_TRUE(instance->GetSite().is_empty());
 
   instance->SetSite(GURL("http://evernote.com/"));
-  EXPECT_TRUE(instance->has_site());
+  EXPECT_TRUE(instance->HasSite());
 
   // Check prior to "assigning" a process to the instance, which is expected
   // to return false due to not being attached to any process yet.
   EXPECT_FALSE(instance->HasWrongProcessForURL(GURL("http://google.com")));
 
   // The call to GetProcess actually creates a new real process, which works
   // fine, but might be a cause for problems in different contexts.
   host.reset(instance->GetProcess());
   EXPECT_TRUE(host.get() != NULL);
   EXPECT_TRUE(instance->HasProcess());
 
   EXPECT_FALSE(instance->HasWrongProcessForURL(GURL("http://evernote.com")));
   EXPECT_FALSE(instance->HasWrongProcessForURL(
       GURL("javascript:alert(document.location.href);")));
 
   EXPECT_TRUE(instance->HasWrongProcessForURL(GURL("chrome://settings")));
 }