Add TestWebContentsFactory to content/public/test

TestWebContentsFactory is a class that can create WebContents for unittests,
but can be created on the stack. This gives it the advantage of being able to
be used in tests that are already inheriting from something other than
RenderViewTestHarness.

Review URL: https://codereview.chromium.org/962393002

Cr-Commit-Position: refs/heads/master@{#318740}

chrome/browser/ui/views/toolbar/toolbar_action_view_unittest.cc

@@ -11,84 +11,13 @@
 #include "chrome/browser/ui/views/toolbar/toolbar_action_view.h"
 #include "chrome/test/base/testing_profile.h"
 #include "content/public/test/test_browser_thread.h"
-#include "content/public/test/test_renderer_host.h"
-#include "content/public/test/web_contents_tester.h"
+#include "content/public/test/test_web_contents_factory.h"
 #include "ui/accessibility/ax_view_state.h"
 #include "ui/events/test/event_generator.h"
 #include "ui/views/test/views_test_base.h"
 
-#if defined(USE_AURA)
-#include "ui/aura/env.h"
-#endif
-
 namespace {
 
-// A helper class to create test web contents (tabs) for unit tests, without
-// inheriting from RenderViewTestHarness. Can create web contents, and will
-// clean up after itself upon destruction. Owns all created web contents.
-// A few notes:
-// - Works well allocated on the stack, because it should be destroyed before
-//   associated browser context.
-// - Doesn't play nice with web contents created any other way (because of
-//   the implementation of RenderViewHostTestEnabler). But if you are creating
-//   web contents already, what do you need this for? ;)
-// TODO(devlin): Look around and see if this class is needed elsewhere; if so,
-// move it there and expand the API a bit (methods to, e.g., delete/close a
-// web contents, access existing web contents, etc).
-class TestWebContentsFactory {
- public:
-  // |init_aura| initializes the aura environment (and cleans it up at
-  // shutdown, which is necessary for web contents. Since this method should
-  // only be called once, this should only be true if no other part of the test
-  // has initialized the environment.
-  explicit TestWebContentsFactory(bool init_aura);
-  ~TestWebContentsFactory();
-
-  // Creates a new WebContents with the given |context|, and returns it.
-  content::WebContents* CreateWebContents(content::BrowserContext* context);
- private:
-  // The test factory (and friends) for creating test web contents.
-  scoped_ptr<content::RenderViewHostTestEnabler> rvh_enabler_;
-  // The vector of web contents that this class created.
-  ScopedVector<content::WebContents> web_contents_;
-
-  // True if the factory initialized aura (and should thus tear it down).
-  bool init_aura_;
-
-  DISALLOW_COPY_AND_ASSIGN(TestWebContentsFactory);
-};
-
-TestWebContentsFactory::TestWebContentsFactory(bool init_aura)
-    : rvh_enabler_(new content::RenderViewHostTestEnabler()),
-      init_aura_(init_aura) {
-#if defined(USE_AURA)
-  if (init_aura)
-    aura::Env::CreateInstance(true);
-#endif
-}
-
-TestWebContentsFactory::~TestWebContentsFactory() {
-  web_contents_.clear();
-  // Let any posted tasks for web contents deletion run.
-  base::RunLoop().RunUntilIdle();
-  rvh_enabler_.reset();
-  // Let any posted tasks for RenderProcess/ViewHost deletion run.
-  base::RunLoop().RunUntilIdle();
-#if defined(USE_AURA)
-  if (init_aura_)
-    aura::Env::DeleteInstance();
-#endif
-}
-
-content::WebContents* TestWebContentsFactory::CreateWebContents(
-    content::BrowserContext* context) {
-  scoped_ptr<content::WebContents> web_contents(
-      content::WebContentsTester::CreateTestWebContents(context, nullptr));
-  DCHECK(web_contents);
-  web_contents_.push_back(web_contents.release());
-  return web_contents_.back();
-}
-
 // A test delegate for a toolbar action view.
 class TestToolbarActionViewDelegate : public ToolbarActionView::Delegate {
  public:
@@ -181,7 +110,7 @@ TEST_F(ToolbarActionViewUnitTest, BasicToolbarActionViewTest) {
   TestingProfile profile;
 
   // ViewsTestBase initializees the aura environment, so the factory shouldn't.
-  TestWebContentsFactory web_contents_factory(false);
+  content::TestWebContentsFactory web_contents_factory;
 
   TestToolbarActionViewController controller("fake controller");
   TestToolbarActionViewDelegate action_view_delegate;

content/content_tests.gypi

@@ -99,6 +99,7 @@
       'public/test/test_synchronous_compositor_android.h',
       'public/test/test_utils.cc',
       'public/test/test_utils.h',
+      'public/test/test_web_contents_factory.h',
       'public/test/unittest_test_suite.cc',
       'public/test/unittest_test_suite.h',
       'public/test/web_contents_observer_sanity_checker.cc',
@@ -164,6 +165,7 @@
       'test/test_render_view_host_factory.h',
       'test/test_web_contents.cc',
       'test/test_web_contents.h',
+      'test/test_web_contents_factory.cc',
       'test/web_gesture_curve_mock.cc',
       'test/web_gesture_curve_mock.h',
       'test/web_layer_tree_view_impl_for_testing.cc',

content/public/test/test_web_contents_factory.h

+// Copyright 2015 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.
+
+#ifndef CONTENT_PUBLIC_TEST_TEST_WEB_CONTENTS_FACTORY_H_
+#define CONTENT_PUBLIC_TEST_TEST_WEB_CONTENTS_FACTORY_H_
+
+#include "base/macros.h"
+#include "base/memory/scoped_vector.h"
+
+namespace content {
+class BrowserContext;
+class RenderViewHostTestEnabler;
+class WebContents;
+
+// A helper class to create test web contents (tabs) for unit tests, without
+// inheriting from RenderViewTestHarness. Can create web contents, and will
+// clean up after itself upon destruction. Owns all created web contents.
+// A few notes:
+// - Works well allocated on the stack, because it should be destroyed before
+//   associated browser context.
+// - Doesn't play nice with web contents created any other way (because of
+//   the implementation of RenderViewHostTestEnabler). But if you are creating
+//   web contents already, what do you need this for? ;)
+// TODO(devlin): The API is currently a bit sparse; there may need to be methods
+// to, e.g., delete/close a web contents, access existing web contents, etc.
+// These can be added as-needed.
+class TestWebContentsFactory {
+ public:
+  TestWebContentsFactory();
+  ~TestWebContentsFactory();
+
+  // Creates a new WebContents with the given |context|, and returns it.
+  // Ownership remains with the TestWebContentsFactory.
+  WebContents* CreateWebContents(BrowserContext* context);
+
+ private:
+  // The test factory (and friends) for creating test web contents.
+  scoped_ptr<RenderViewHostTestEnabler> rvh_enabler_;
+
+  // The vector of web contents that this class created.
+  ScopedVector<WebContents> web_contents_;
+
+  // True if the factory initialized aura (and should thus tear it down).
+  bool tear_down_aura_;
+
+  DISALLOW_COPY_AND_ASSIGN(TestWebContentsFactory);
+};
+
+}  // namespace content
+
+#endif  // CONTENT_PUBLIC_TEST_TEST_WEB_CONTENTS_FACTORY_H_

content/test/test_web_contents_factory.cc

+// Copyright 2015 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 "content/public/test/test_web_contents_factory.h"
+
+#include "base/run_loop.h"
+#include "content/public/browser/web_contents.h"
+#include "content/public/test/test_renderer_host.h"
+#include "content/public/test/web_contents_tester.h"
+
+#if defined(USE_AURA)
+#include "ui/aura/env.h"
+#endif
+
+namespace content {
+
+TestWebContentsFactory::TestWebContentsFactory()
+    : rvh_enabler_(new content::RenderViewHostTestEnabler()),
+      tear_down_aura_(false) {
+#if defined(USE_AURA)
+  if (aura::Env::GetInstanceDontCreate() == nullptr) {
+    aura::Env::CreateInstance(true);
+    tear_down_aura_ = true;
+  }
+#endif
+}
+
+TestWebContentsFactory::~TestWebContentsFactory() {
+  // We explicitly clear the vector to force destruction of any created web
+  // contents so that we can properly handle their cleanup (running posted
+  // tasks, etc).
+  web_contents_.clear();
+  // Let any posted tasks for web contents deletion run.
+  base::RunLoop().RunUntilIdle();
+  rvh_enabler_.reset();
+  // Let any posted tasks for RenderProcess/ViewHost deletion run.
+  base::RunLoop().RunUntilIdle();
+#if defined(USE_AURA)
+  if (tear_down_aura_)
+    aura::Env::DeleteInstance();
+#endif
+}
+
+WebContents* TestWebContentsFactory::CreateWebContents(
+    BrowserContext* context) {
+  web_contents_.push_back(
+      WebContentsTester::CreateTestWebContents(context, nullptr));
+  DCHECK(web_contents_.back());
+  return web_contents_.back();
+}
+
+}  // namespace content

ui/aura/env.cc

@@ -42,6 +42,11 @@ Env* Env::GetInstance() {
   return env;
 }
 
+// static
+Env* Env::GetInstanceDontCreate() {
+  return lazy_tls_ptr.Pointer()->Get();
+}
+
 // static
 void Env::DeleteInstance() {
   delete lazy_tls_ptr.Pointer()->Get();

ui/aura/env.h

@@ -37,6 +37,7 @@ class AURA_EXPORT Env : public ui::EventTarget, public base::SupportsUserData {
   // nativeviewportservice lives in the same process as the viewmanager.
   static void CreateInstance(bool create_event_source);
   static Env* GetInstance();
+  static Env* GetInstanceDontCreate();
   static void DeleteInstance();
 
   void AddObserver(EnvObserver* observer);