browser_test_base.h revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CONTENT_PUBLIC_TEST_BROWSER_TEST_BASE_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CONTENT_PUBLIC_TEST_BROWSER_TEST_BASE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "base/callback.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 1058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#include "base/threading/thread.h" 11b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)#include "net/test/spawned_test_server/spawned_test_server.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "testing/gtest/include/gtest/gtest.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CommandLine; 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace base { 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FilePath; 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)namespace net { 2190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)namespace test_server { 2290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)class EmbeddedTestServer; 2390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)} 2468043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 2568043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles)class RuleBasedHostResolverProc; 2668043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles)} // namespace net 2790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BrowserTestBase : public testing::Test { 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BrowserTestBase(); 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~BrowserTestBase(); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We do this so we can be used in a Task. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddRef() {} 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Release() {} 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Configures everything for an in process browser test, then invokes 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BrowserMain. BrowserMain ends up invoking RunTestOnMainThreadLoop. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetUp() OVERRIDE; 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Restores state configured in SetUp. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void TearDown() OVERRIDE; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Override this to add any custom setup code that needs to be done on the 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // main thread after the browser is created and just before calling 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // RunTestOnMainThread(). 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetUpOnMainThread() {} 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 51eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // Override this to add any custom teardown code that needs to be done on the 52eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // main thread right after RunTestOnMainThread(). 53eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch virtual void TearDownOnMainThread() {} 54eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Override this to add command line flags specific to your test. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetUpCommandLine(CommandLine* command_line) {} 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) // Returns the host resolver being used for the tests. Subclasses might want 5968043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) // to configure it inside tests. 6068043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) net::RuleBasedHostResolverProc* host_resolver() { 6168043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) return rule_based_resolver_.get(); 6268043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) } 6368043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We need these special methods because SetUp is the bottom of the stack 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // that winds up calling your test method, so it is not always an option 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to do what you want by overriding it and calling the superclass version. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Override this for things you would normally override SetUp for. It will be 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // called before your individual test fixture method is run, but after most 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of the overhead initialization has occured. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetUpInProcessBrowserTestFixture() {} 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Override this for things you would normally override TearDown for. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void TearDownInProcessBrowserTestFixture() {} 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Override this rather than TestBody. 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void RunTestOnMainThread() = 0; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is invoked from main after browser_init/browser_main have completed. 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This prepares for the test by creating a new browser, runs the test 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (RunTestOnMainThread), quits the browsers and returns. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void RunTestOnMainThreadLoop() = 0; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the testing server. Guaranteed to be non-NULL. 8690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // TODO(phajdan.jr): Remove test_server accessor (http://crbug.com/96594). 87c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const net::SpawnedTestServer* test_server() const { 88c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) return test_server_.get(); 89c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) } 90c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) net::SpawnedTestServer* test_server() { return test_server_.get(); } 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // Returns the embedded test server. Guaranteed to be non-NULL. 9390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) const net::test_server::EmbeddedTestServer* embedded_test_server() const { 9490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) return embedded_test_server_.get(); 9590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) } 9690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) net::test_server::EmbeddedTestServer* embedded_test_server() { 9790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) return embedded_test_server_.get(); 9890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) } 9990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_POSIX) 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is only needed by a test that raises SIGTERM to ensure that a specific 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // codepath is taken. 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DisableSIGTERMHandling() { 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) handle_sigterm_ = false; 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This function is meant only for classes that directly derive from this 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // class to construct the test server in their constructor. They might need to 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // call this after setting up the paths. Actual test cases should never call 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this. 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |test_server_base| is the path, relative to src, to give to the test HTTP 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // server. 1142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void CreateTestServer(const base::FilePath& test_server_base); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 116c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // When the test is running in --single-process mode, runs the given task on 117c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // the in-process renderer thread. A nested message loop is run until it 118c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // returns. 119c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void PostTaskToInProcessRendererAndWait(const base::Closure& task); 120c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 1215d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Call this before SetUp() to cause the test to generate pixel output. 1225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void EnablePixelOutput(); 123c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch 1245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Call this before SetUp() to not use GL, but use software compositing 1255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // instead. 1265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void UseSoftwareCompositing(); 1275d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1285d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Returns true if the test will be using GL acceleration via OSMesa. 1295d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool UsingOSMesa() const; 130c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ProxyRunTestOnMainThreadLoop(); 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Testing server, started on demand. 135c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<net::SpawnedTestServer> test_server_; 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // Embedded test server, cheap to create, started on demand. 13890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) scoped_ptr<net::test_server::EmbeddedTestServer> embedded_test_server_; 13990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) 14068043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) // Host resolver used during tests. 14168043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) scoped_refptr<net::RuleBasedHostResolverProc> rule_based_resolver_; 14268043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 1435d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // When true, the compositor will produce pixel output that can be read back 1445d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // for pixel tests. 1455d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool enable_pixel_output_; 146c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch 1475d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // When true, do compositing with the software backend instead of using GL. 1485d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool use_software_compositing_; 149c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_POSIX) 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool handle_sigterm_; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace content 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CONTENT_PUBLIC_TEST_BROWSER_TEST_BASE_H_ 158