Admixtures in BrowserTestBase

content/public/test/browser_test_base.h

 // Copyright (c) 2012 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_BROWSER_TEST_BASE_H_
 #define CONTENT_PUBLIC_TEST_BROWSER_TEST_BASE_H_
 
 #include "base/callback.h"
 #include "base/compiler_specific.h"
+#include "base/memory/scoped_vector.h"
 #include "base/threading/thread.h"
 #include "net/test/spawned_test_server/spawned_test_server.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace base {
 class CommandLine;
 class FilePath;
 }
 
 namespace net {
 namespace test_server {
 class EmbeddedTestServer;
 }
 
 class RuleBasedHostResolverProc;
 }  // namespace net
 
 namespace content {
 
 class BrowserTestBase : public testing::Test {
  public:
+  // Class that can be used to add some features not related directly
+  // to the testing process and do set ups needed for them in proper time.
+  // To do this you need to derive Admixture, implement
+  // all the methods you need there and (if needed) reload set ups, if you need
+  // to set up something because of this API.
+  class Admixture {
+   public:
+    Admixture() {}
+    virtual ~Admixture() {}
+    virtual void SetUpCommandLine(base::CommandLine* command_line) {}
+    virtual void SetUpOnMainThread() {}
+    virtual void SetUpInProcessBrowserTestFixture() = 0;

[dzhioev (left Google), 2014/08/15 14:37:14]

Add a default implementation for this method.

[Lisa Ignatyeva, 2014/08/15 16:12:37]

Done.

+    virtual bool SetUpUserDataDirectory();

[dzhioev (left Google), 2014/08/15 14:37:14]

I doubt this method will be really needed in admixtures. Let's remove it for
now.

[Lisa Ignatyeva, 2014/08/15 16:12:37]

Done.

+  };

[dzhioev (left Google), 2014/08/15 14:37:14]

We need TearDown* methods here as well.

[Lisa Ignatyeva, 2014/08/15 16:12:37]

Done.

+
   BrowserTestBase();
   virtual ~BrowserTestBase();
 
   // We do this so we can be used in a Task.
   void AddRef() {}
   void Release() {}
 
   // Configures everything for an in process browser test, then invokes
   // BrowserMain. BrowserMain ends up invoking RunTestOnMainThreadLoop.
   virtual void SetUp() OVERRIDE;
@@ skipping 82 matching lines @@
   // Call this before SetUp() to cause the test to generate pixel output.
   void EnablePixelOutput();
 
   // Call this before SetUp() to not use GL, but use software compositing
   // instead.
   void UseSoftwareCompositing();
 
   // Returns true if the test will be using GL acceleration via OSMesa.
   bool UsingOSMesa() const;
 
+  // Adds |admixture| as an admixture for this test.
+  void AddAdmixture(Admixture* admixture);

[dzhioev (left Google), 2014/08/15 14:37:14]

Please add comment that this method should only be called in test's constructor
and that BrowserTestBase takes ownership of |admixture|.

[Lisa Ignatyeva, 2014/08/15 16:12:37]

Done.

+
+  // Returns admixtures for this test.
+  ScopedVector<Admixture> GetAdmixtures();

[dzhioev (left Google), 2014/08/15 14:37:14]

It's a bad idea to pass ownership to caller. You can return constant ref to
ScopedVector from this method. Or even better, std::vector<Admixture*>.

[Lisa Ignatyeva, 2014/08/15 16:12:37]

Done.

+
+  // Passes admixtures ownership back.
+  void ReturnAdmixtures(ScopedVector<BrowserTestBase::Admixture> arg);
+
+  // Holds admixtures for this test.
+  ScopedVector<Admixture> admixtures_;

[dzhioev (left Google), 2014/08/15 14:37:14]

Put this declaration into private section.

[Lisa Ignatyeva, 2014/08/15 16:12:37]

Done.

  private:
   void ProxyRunTestOnMainThreadLoop();
 
   // Testing server, started on demand.
   scoped_ptr<net::SpawnedTestServer> test_server_;
 
   // Embedded test server, cheap to create, started on demand.
   scoped_ptr<net::test_server::EmbeddedTestServer> embedded_test_server_;
 
   // Host resolver used during tests.
@@ skipping 10 matching lines @@
   bool use_software_compositing_;
 
 #if defined(OS_POSIX)
   bool handle_sigterm_;
 #endif
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_TEST_BROWSER_TEST_BASE_H_