PrerenderingLoader initial integration with PrerenderManager/PrerenderHandle

chrome/browser/android/offline_pages/prerendering_loader_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/prerendering_loader.h"
+
+#include "base/bind.h"
+#include "base/memory/ptr_util.h"
+#include "base/memory/ref_counted.h"
+#include "base/run_loop.h"
+#include "chrome/browser/prerender/prerender_handle.h"
+#include "chrome/browser/prerender/prerender_manager.h"
+#include "chrome/browser/prerender/prerender_manager_factory.h"
+#include "chrome/test/base/testing_profile.h"
+#include "content/public/test/test_browser_thread_bundle.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace offline_pages {
+
+// Adapter that intercepts prerender stack calls for testing.
+class TestAdapter : public PrerenderingLoader::PrerenderingAdapter {
+ public:
+  TestAdapter() {}
+  ~TestAdapter() override {}
+
+  // PrerenderAdapter implementation.
+  bool CanPrerender() const override;
+  bool AddPrerenderForOffline(
+      content::BrowserContext* browser_context,
+      const GURL& url,
+      content::SessionStorageNamespace* session_storage_namespace,
+      const gfx::Size& size) override;
+  void SetObserver(prerender::PrerenderHandle::Observer* observer) override;
+  bool IsPrerendering() const override;
+  void OnCancel() override;
+  content::WebContents* GetPrerenderContents() const override;
+  prerender::FinalStatus GetFinalStatus() const override;
+  bool IsActive() const override;
+  bool IsActive(prerender::PrerenderHandle* handle) const override;
+  void DestroyActive() override;
+
+  // Sets prerendering to be disabled. This will cause the CanPrerender()
+  // to return false.
+  void Disable();
+
+  // Configures mocked prerendering details.
+  void Configure(bool is_prerendering,
+                 content::WebContents* contents,
+                 prerender::FinalStatus final_status);
+
+  // Returns the observer for test access.
+  prerender::PrerenderHandle::Observer* GetObserver() const {
+    return observer_;
+  }
+
+ private:
+  bool active_;
+  bool disabled_;
+  bool is_prerendering_;
+  prerender::PrerenderHandle::Observer* observer_;
+  content::WebContents* contents_;
+  prerender::FinalStatus final_status_;
+
+  DISALLOW_COPY_AND_ASSIGN(TestAdapter);
+};
+
+void TestAdapter::Disable() {
+  disabled_ = true;
+}
+
+void TestAdapter::Configure(bool is_prerendering,
+                            content::WebContents* contents,
+                            prerender::FinalStatus final_status) {
+  is_prerendering_ = is_prerendering;
+  contents_ = contents;
+  final_status_ = final_status;
+}
+
+bool TestAdapter::CanPrerender() const {
+  return !disabled_;
+}
+
+bool TestAdapter::AddPrerenderForOffline(
+    content::BrowserContext* browser_context,
+    const GURL& url,
+    content::SessionStorageNamespace* session_storage_namespace,
+    const gfx::Size& size) {
+  active_ = true;
+  return true;
+}
+
+void TestAdapter::SetObserver(prerender::PrerenderHandle::Observer* observer) {
+  observer_ = observer;
+}
+
+bool TestAdapter::IsPrerendering() const {
+  return is_prerendering_;
+}
+
+void TestAdapter::OnCancel() {}
+
+content::WebContents* TestAdapter::GetPrerenderContents() const {
+  return contents_;
+}
+
+prerender::FinalStatus TestAdapter::GetFinalStatus() const {
+  return final_status_;
+}
+
+bool TestAdapter::IsActive() const {
+  return active_;
+}
+
+bool TestAdapter::IsActive(prerender::PrerenderHandle* handle) const {
+  return IsActive();
+}
+
+void TestAdapter::DestroyActive() {
+  active_ = false;
+}
+
+// Test class.
+class PrerenderingLoaderTest : public testing::Test {
+ public:
+  PrerenderingLoaderTest();
+  ~PrerenderingLoaderTest() override {}
+
+  void SetUp() override;
+
+  // Returns the PrerenderLoader to test.
+  PrerenderingLoader* loader() const { return loader_.get(); }
+  // Returns the TestAdapter to allow test behavior configuration.
+  TestAdapter* test_adapter() const { return test_adapter_; }
+  bool callback_called() { return callback_called_; }
+  bool did_load() { return did_load_; }
+  Profile* profile() { return &profile_; }
+  void OnLoadDone(bool loaded, content::WebContents* web_contents);
+  void PumpLoop();
+
+ private:
+  content::TestBrowserThreadBundle thread_bundle_;
+  TestingProfile profile_;
+  TestAdapter* test_adapter_;
+  std::unique_ptr<PrerenderingLoader> loader_;
+  bool callback_called_;
+  bool did_load_;
+
+  DISALLOW_COPY_AND_ASSIGN(PrerenderingLoaderTest);
+};
+
+PrerenderingLoaderTest::PrerenderingLoaderTest()
+    : thread_bundle_(content::TestBrowserThreadBundle::IO_MAINLOOP) {}  //,
+
+void PrerenderingLoaderTest::SetUp() {
+  loader_.reset(new PrerenderingLoader(&profile_));
+  test_adapter_ = new TestAdapter();
+  loader_->SetAdapterForTesting(test_adapter_);
+  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
+}
+
+void PrerenderingLoaderTest::OnLoadDone(bool loaded,
+                                        content::WebContents* web_contents) {
+  callback_called_ = true;
+  did_load_ = loaded;
+}
+
+void PrerenderingLoaderTest::PumpLoop() {
+  base::RunLoop().RunUntilIdle();
+}
+
+TEST_F(PrerenderingLoaderTest, CanPrerender) {
+  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
+  EXPECT_TRUE(loader()->CanPrerender());
+
+  test_adapter()->Disable();
+  EXPECT_FALSE(loader()->CanPrerender());
+}
+
+TEST_F(PrerenderingLoaderTest, StopLoadingWhenIdle) {
+  EXPECT_TRUE(loader()->IsIdle());
+  loader()->StopLoading();
+  EXPECT_TRUE(loader()->IsIdle());
+}
+
+TEST_F(PrerenderingLoaderTest, LoadPageLoadFailed) {
+  GURL gurl("http://testit.sea");
+  EXPECT_TRUE(loader()->IsIdle());
+  EXPECT_TRUE(loader()->LoadPage(
+      gurl,
+      base::Bind(&PrerenderingLoaderTest::OnLoadDone, base::Unretained(this))));
+  EXPECT_FALSE(loader()->IsIdle());
+
+  test_adapter()->GetObserver()->OnPrerenderDomContentLoaded(
+      nullptr /* handle */);

[Pete Williamson, 2016/05/10 22:13:15]

Handle is not very helpful here.  handle to PrerenderManager, perhaps?

[dougarnett, 2016/05/10 23:08:22]

Done.

+  PumpLoop();
+  EXPECT_TRUE(callback_called());
+  EXPECT_FALSE(did_load());  // Per no WebContents provided in callback.

[Pete Williamson, 2016/05/10 22:13:15]

// Since we didn't provide a web contents to the test adapter, it did not send
one with the callback, so the load fails.

Maybe a more explicit comment like the one above will make the test code easier
for a maintenance programmer to understand.

[dougarnett, 2016/05/10 23:08:22]

Done.

+}
+
+TEST_F(PrerenderingLoaderTest, LoadPageLoadSucceeded) {
+  test_adapter()->Configure(
+      true /* is_prerendering */,
+      content::TestWebContents::Create(profile(), nullptr),
+      prerender::FinalStatus::FINAL_STATUS_USED);
+  GURL gurl("http://testit.sea");
+  EXPECT_TRUE(loader()->IsIdle());
+  EXPECT_TRUE(loader()->LoadPage(
+      gurl,
+      base::Bind(&PrerenderingLoaderTest::OnLoadDone, base::Unretained(this))));
+
+  test_adapter()->GetObserver()->OnPrerenderDomContentLoaded(
+      nullptr /* handle */);
+  PumpLoop();
+  EXPECT_TRUE(callback_called());
+  EXPECT_TRUE(did_load());
+}
+
+}  // namespace offline_pages