ash_test_base.h revision bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3
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 ASH_TEST_ASH_TEST_BASE_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define ASH_TEST_ASH_TEST_BASE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 117dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#include "base/message_loop/message_loop.h" 1290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "base/threading/thread.h" 13a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch#include "content/public/test/test_browser_thread_bundle.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "testing/gtest/include/gtest/gtest.h" 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "third_party/skia/include/core/SkColor.h" 162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "ui/aura/client/window_types.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/test/test_views_delegate.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#if defined(OS_WIN) 20c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ui/base/win/scoped_ole_initializer.h" 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#endif 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace aura { 24c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)class RootWindow; 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class Window; 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class WindowDelegate; 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace test { 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class EventGenerator; 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace test 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace aura 322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace ash { 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace internal { 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class DisplayManager; 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace internal 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace test { 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 40c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)class AshTestHelper; 41c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#if defined(OS_WIN) 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class TestMetroViewerProcessHost; 43c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#endif 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AshTestViewsDelegate : public views::TestViewsDelegate { 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overriden from TestViewsDelegate. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual content::WebContents* CreateWebContents( 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::BrowserContext* browser_context, 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::SiteInstance* site_instance) OVERRIDE; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AshTestBase : public testing::Test { 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AshTestBase(); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~AshTestBase(); 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // testing::Test: 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetUp() OVERRIDE; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void TearDown() OVERRIDE; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Update the display configuration as given in |display_specs|. 632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // See ash::test::DisplayManagerTestApi::UpdateDisplay for more details. 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void UpdateDisplay(const std::string& display_specs); 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a RootWindow. Usually this is the active RootWindow, but that 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // method can return NULL sometimes, and in those cases, we fall back on the 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // primary RootWindow. 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::RootWindow* CurrentContext(); 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Versions of the functions in aura::test:: that go through our shell 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // StackingController instead of taking a parent. 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::Window* CreateTestWindowInShellWithId(int id); 742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::Window* CreateTestWindowInShellWithBounds(const gfx::Rect& bounds); 752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::Window* CreateTestWindowInShell(SkColor color, 762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int id, 772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const gfx::Rect& bounds); 782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::Window* CreateTestWindowInShellWithDelegate( 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::WindowDelegate* delegate, 802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int id, 812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const gfx::Rect& bounds); 822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::Window* CreateTestWindowInShellWithDelegateAndType( 832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::WindowDelegate* delegate, 842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::client::WindowType type, 852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int id, 862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const gfx::Rect& bounds); 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Attach |window| to the current shell's root window. 892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void SetDefaultParentByPrimaryRootWindow(aura::Window* window); 902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the EventGenerator that uses screen coordinates and works 922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // across multiple displays. It createse a new generator if it 932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // hasn't been created yet. 942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) aura::test::EventGenerator& GetEventGenerator(); 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 97bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch enum UserSessionBlockReason { 98bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch FIRST_BLOCK_REASON, 99bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch BLOCKED_BY_LOCK_SCREEN = FIRST_BLOCK_REASON, 100bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch BLOCKED_BY_LOGIN_SCREEN, 101bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch BLOCKED_BY_USER_ADDING_SCREEN, 102bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch NUMBER_OF_BLOCK_REASONS 103bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch }; 104bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch 1057d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) // True if the running environment supports multiple displays, 1067d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) // or false otherwise (e.g. win8 bot). 1077d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) static bool SupportsMultipleDisplays(); 1087d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) 109eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // True if the running environment supports host window resize, 110eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // or false otherwise (e.g. win8 bot). 111eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch static bool SupportsHostWindowResize(); 112eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RunAllPendingInMessageLoop(); 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Utility methods to emulate user logged in or not, session started or not 1162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and user able to lock screen or not cases. 1172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void SetSessionStarted(bool session_started); 1182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void SetUserLoggedIn(bool user_logged_in); 1192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void SetCanLockScreen(bool can_lock_screen); 120bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch void SetUserAddingScreenRunning(bool user_adding_screen_running); 121bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch 122bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch // Methods to emulate blocking and unblocking user session with given 123bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch // |block_reason|. 124bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch void BlockUserSession(UserSessionBlockReason block_reason); 125bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch void UnblockUserSession(); 1262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 128c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool setup_called_; 129c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool teardown_called_; 130a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch content::TestBrowserThreadBundle thread_bundle_; 131c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<AshTestHelper> ash_test_helper_; 1322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) scoped_ptr<aura::test::EventGenerator> event_generator_; 1332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#if defined(OS_WIN) 13490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // Note that the order is important here as ipc_thread_ should be destroyed 13590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // after metro_viewer_host_->channel_. 13690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) scoped_ptr<base::Thread> ipc_thread_; 1372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) scoped_ptr<TestMetroViewerProcessHost> metro_viewer_host_; 138c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) ui::ScopedOleInitializer ole_initializer_; 1392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#endif 1402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(AshTestBase); 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace test 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace ash 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // ASH_TEST_ASH_TEST_BASE_H_ 148