Adds unit tests for offline_pages::PrerenderAdapter calling PrerenderManager.

chrome/browser/android/offline_pages/prerender_adapter_unittest.cc

+// Copyright 2016 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 "chrome/browser/android/offline_pages/prerender_adapter.h"
+
+#include "chrome/browser/prerender/prerender_manager_factory.h"
+#include "chrome/test/base/testing_profile.h"
+#include "content/public/browser/browser_thread.h"
+#include "content/public/browser/web_contents.h"
+#include "content/public/test/test_browser_thread_bundle.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+using prerender::FinalStatus;
+using prerender::Origin;
+using prerender::PrerenderContents;
+using prerender::PrerenderManager;
+using prerender::PrerenderManagerFactory;
+
+namespace offline_pages {
+
+namespace {
+
+class StubPrerenderContents : public PrerenderContents {
+ public:
+  StubPrerenderContents(PrerenderManager* prerender_manager,
+                        const GURL& url,
+                        Origin origin);
+
+  ~StubPrerenderContents() override;
+
+  void StartPrerendering(
+      const gfx::Size& size,
+      content::SessionStorageNamespace* session_storage_namespace) override;
+
+  void ReportStartEvent() { NotifyPrerenderStart(); }
+  void ReportOnLoadEvent() { NotifyPrerenderStopLoading(); }
+  void ReportDomContentEvent() { NotifyPrerenderDomContentLoaded(); }
+  void StopWithStatus(FinalStatus final_status) { Destroy(final_status); }
+};
+
+StubPrerenderContents::StubPrerenderContents(
+    PrerenderManager* prerender_manager,
+    const GURL& url,
+    Origin origin)
+    : PrerenderContents(prerender_manager,
+                        NULL,
+                        url,
+                        content::Referrer(),
+                        origin) {}
+
+StubPrerenderContents::~StubPrerenderContents() {}
+
+void StubPrerenderContents::StartPrerendering(
+    const gfx::Size& size,
+    content::SessionStorageNamespace* session_storage_namespace) {
+  prerendering_has_started_ = true;
+}
+
+class StubPrerenderContentsFactory : public PrerenderContents::Factory {
+ public:
+  StubPrerenderContentsFactory()
+      : create_prerender_contents_called_(false),
+        last_prerender_contents_(nullptr) {}
+
+  ~StubPrerenderContentsFactory() override {}
+
+  PrerenderContents* CreatePrerenderContents(
+      PrerenderManager* prerender_manager,
+      Profile* profile,
+      const GURL& url,
+      const content::Referrer& referrer,
+      Origin origin) override;
+
+  bool create_prerender_contents_called() const {
+    return create_prerender_contents_called_;
+  }
+
+  StubPrerenderContents* last_prerender_contents() const {
+    return last_prerender_contents_;
+  }
+
+ private:
+  bool create_prerender_contents_called_;
+  StubPrerenderContents* last_prerender_contents_;
+
+  DISALLOW_COPY_AND_ASSIGN(StubPrerenderContentsFactory);
+};
+
+PrerenderContents* StubPrerenderContentsFactory::CreatePrerenderContents(
+    PrerenderManager* prerender_manager,
+    Profile* profile,
+    const GURL& url,
+    const content::Referrer& referrer,
+    Origin origin) {
+  create_prerender_contents_called_ = true;
+  last_prerender_contents_ = new StubPrerenderContents(
+      prerender_manager, url, prerender::ORIGIN_OFFLINE);
+  return last_prerender_contents_;
+}
+
+}  // namespace
+
+// Test class.
+class PrerenderAdapterTest : public testing::Test,
+                             public PrerenderAdapter::Observer {
+ public:
+  PrerenderAdapterTest();
+  ~PrerenderAdapterTest() override;
+
+  // PrerenderAdapter::Observer implementation:
+  void OnPrerenderStart() override;
+  void OnPrerenderStopLoading() override;
+  void OnPrerenderDomContentLoaded() override;
+  void OnPrerenderStop() override;
+
+  void SetUp() override;
+
+  // Returns the PrerenderLoader to test.
+  PrerenderAdapter* adapter() const { return adapter_.get(); }
+  StubPrerenderContentsFactory* prerender_contents_factory() {
+    return prerender_contents_factory_;
+  }
+  Profile* profile() { return &profile_; }
+  PrerenderManager* prerender_manager() { return prerender_manager_; }
+  bool observer_start_called() const { return observer_start_called_; }
+  bool observer_stop_loading_called() const {
+    return observer_stop_loading_called_;
+  }
+  bool observer_dom_content_loaded_called() const {
+    return observer_dom_content_loaded_called_;
+  }
+  bool observer_stop_called() const { return observer_stop_called_; }
+
+ private:
+  content::TestBrowserThreadBundle thread_bundle_;
+  TestingProfile profile_;
+  std::unique_ptr<PrerenderAdapter> adapter_;
+  StubPrerenderContentsFactory* prerender_contents_factory_;
+  PrerenderManager* prerender_manager_;
+  bool observer_start_called_;
+  bool observer_stop_loading_called_;
+  bool observer_dom_content_loaded_called_;
+  bool observer_stop_called_;
+
+  DISALLOW_COPY_AND_ASSIGN(PrerenderAdapterTest);
+};
+
+PrerenderAdapterTest::PrerenderAdapterTest()
+    : thread_bundle_(content::TestBrowserThreadBundle::IO_MAINLOOP),
+      prerender_manager_(nullptr),
+      observer_start_called_(false),
+      observer_stop_loading_called_(false),
+      observer_dom_content_loaded_called_(false),
+      observer_stop_called_(false) {}
+
+void PrerenderAdapterTest::OnPrerenderStart() {
+  observer_start_called_ = true;
+}
+
+PrerenderAdapterTest::~PrerenderAdapterTest() {
+  prerender_manager_->Shutdown();
+}
+
+void PrerenderAdapterTest::OnPrerenderStopLoading() {
+  observer_stop_loading_called_ = true;
+}
+
+void PrerenderAdapterTest::OnPrerenderDomContentLoaded() {
+  observer_dom_content_loaded_called_ = true;
+}
+
+void PrerenderAdapterTest::OnPrerenderStop() {
+  observer_stop_called_ = true;
+}
+
+void PrerenderAdapterTest::SetUp() {

[pasko, 2016/06/15 12:25:00]

also I think various *_called should be reset in SetUp()

[dougarnett, 2016/06/15 15:45:04]

thanks - done

+  adapter_.reset(new PrerenderAdapter(this));
+  prerender_contents_factory_ = new StubPrerenderContentsFactory();
+  prerender_manager_ = PrerenderManagerFactory::GetForProfile(profile());
+  prerender_manager_->SetPrerenderContentsFactoryForTest(
+      prerender_contents_factory_);
+  prerender_manager_->SetMode(PrerenderManager::PRERENDER_MODE_ENABLED);
+  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
+}
+
+TEST_F(PrerenderAdapterTest, CanPrerender) {
+  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
+  EXPECT_TRUE(adapter()->CanPrerender());
+
+  prerender_manager()->SetMode(PrerenderManager::PRERENDER_MODE_DISABLED);
+  EXPECT_FALSE(adapter()->CanPrerender());
+}
+
+TEST_F(PrerenderAdapterTest, StartPrerenderFailsForUnsupportedScheme) {
+  content::WebContents* session_contents = content::WebContents::Create(
+      content::WebContents::CreateParams(profile()));
+  content::SessionStorageNamespace* sessionStorageNamespace =
+      session_contents->GetController().GetDefaultSessionStorageNamespace();
+  gfx::Size renderWindowSize = session_contents->GetContainerBounds().size();
+  GURL url("file://file.test");
+  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);

[pasko, 2016/06/15 12:25:00]

DCHECKs are not nice in tests because they kill the process, can this be
converted to ASSERT_*?

[dougarnett, 2016/06/15 15:45:04]

Unfortunately I don't find an ASSERT_CURRENTLY_ON macro and the DCHECK macros
comparision is hard to read so don't want to EXPECT here on it. 

Actually, I don't think I need them in the tests so just keeping the one in
Setup to ensure the test is set up on the right thread.

[pasko, 2016/06/15 17:20:27]

There is ASSERT_TRUE(BrowserThread::CurrentlyOn(BrowserThread::UI))

Totally up to you :)

[dougarnett, 2016/06/15 18:15:07]

Duh - Done ;-)

+  EXPECT_FALSE(adapter()->StartPrerender(
+      profile(), url, sessionStorageNamespace, renderWindowSize));
+  EXPECT_TRUE(prerender_contents_factory()->create_prerender_contents_called());
+  EXPECT_FALSE(adapter()->IsActive());
+}

[pasko, 2016/06/15 12:25:00]

it would be nice to also EXPECT_FALSE for these:
observer_start_called()
observer_dom_content_loaded_called()
observer_stop_loading_called()
observer_stop_called()

[dougarnett, 2016/06/15 15:45:04]

Done.

+
+TEST_F(PrerenderAdapterTest, StartPrerenderSucceeds) {
+  content::WebContents* session_contents = content::WebContents::Create(
+      content::WebContents::CreateParams(profile()));
+  content::SessionStorageNamespace* sessionStorageNamespace =
+      session_contents->GetController().GetDefaultSessionStorageNamespace();
+  gfx::Size renderWindowSize = session_contents->GetContainerBounds().size();
+  GURL url("https://url.test");
+  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
+  EXPECT_TRUE(adapter()->StartPrerender(profile(), url, sessionStorageNamespace,
+                                        renderWindowSize));
+  EXPECT_TRUE(prerender_contents_factory()->create_prerender_contents_called());
+  EXPECT_NE(nullptr, prerender_contents_factory()->last_prerender_contents());
+  EXPECT_TRUE(adapter()->IsActive());
+
+  // Exercise observer event call paths.
+  prerender_contents_factory()->last_prerender_contents()->ReportStartEvent();
+  // PumpLoop();
+  EXPECT_TRUE(observer_start_called());
+  prerender_contents_factory()
+      ->last_prerender_contents()
+      ->ReportDomContentEvent();
+  EXPECT_TRUE(observer_dom_content_loaded_called());
+  prerender_contents_factory()->last_prerender_contents()->ReportOnLoadEvent();
+  EXPECT_TRUE(observer_stop_loading_called());
+  prerender_contents_factory()->last_prerender_contents()->StopWithStatus(
+      FinalStatus::FINAL_STATUS_CANCELLED);
+  EXPECT_TRUE(observer_stop_called());
+  EXPECT_EQ(FinalStatus::FINAL_STATUS_CANCELLED, adapter()->GetFinalStatus());
+
+  // Exercise access methods even though no interesting values set beneath.
+  EXPECT_EQ(nullptr, adapter()->GetWebContents());
+
+  adapter()->DestroyActive();
+  EXPECT_FALSE(adapter()->IsActive());
+}
+
+}  // namespace offline_pages