Skip to content

Commit

Permalink
Reorder AshTestHelper setup/teardown.
Browse files Browse the repository at this point in the history 
This is in preparation for making AshTestHelper an AuraTestHelper
subclass.  The primary purpose here is to move the parts of setup/
teardown that will be handled by the AuraTestHelper to the start/end
of the ash setup/teardown phases, respectively, so that moving them
into AuraTestHelper will not change the relative order of anything.

The secondary purpose, subject to the above, is to better group
related functionality and add a few comments about ordering
requirements.  I didn't aim for perfection, just something better.

This is split into its own CL since reordering setup/teardown is risky;
there are many implicit dependencies.

There are some trivial changes:
* Removed a null-check of the cursor manager that was only needed for
  MASH.
* Explicitly reset all unique_ptrs during TearDown() rather than waiting
  until destruction for a few.
* Removed CHECK(!::wm::CaptureController::Get()) during teardown; it's
  not clear to me why we CHECK this but none of the other many bits of
  state destruction on teardown.

Otherwise, should be no functional change.

Bug: none
Change-Id: Ief088e58606b83e127e93daad0a60f90601b9866
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2121085
Auto-Submit: Peter Kasting <pkasting@chromium.org>
Commit-Queue: James Cook <jamescook@chromium.org>
Reviewed-by: James Cook <jamescook@chromium.org>
Cr-Commit-Position: refs/heads/master@{#753811}
  • Loading branch information
@pkasting
pkasting authored and Commit Bot committed Mar 26, 2020
1 parent aa4de8d commit ec1e1cf
Show file tree
Hide file tree
Showing 2 changed files with 131 additions and 143 deletions.
245 changes: 121 additions & 124 deletions ash/test/ash_test_helper.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,55 @@ AshTestHelper::InitParams::InitParams() = default;
AshTestHelper::InitParams::InitParams(InitParams&&) = default;
AshTestHelper::InitParams::~InitParams() = default;

AshTestHelper::AshTestHelper()
: command_line_(std::make_unique<base::test::ScopedCommandLine>()) {}
AshTestHelper::AshTestHelper() = default;

AshTestHelper::~AshTestHelper() {
// Ensure the next test starts with a null display::Screen. Done here because
// some tests use Screen after TearDown().
// Ensure the next test starts with a null display::Screen. This must be done
// here instead of in TearDown() since some tests test access to the Screen
// after the shell shuts down (which they use TearDown() to trigger).
ScreenAsh::DeleteScreenForShutdown();
}

void AshTestHelper::SetUp(InitParams init_params) {
// Aura-general setup -------------------------------------------------------

wm_state_ = std::make_unique<::wm::WMState>();

if (init_params.config_type != kShell) {
ui::test::EnableTestConfigForPlatformWindows();
ui::InitializeInputMethodForTesting();
}

ui::test::EventGeneratorDelegate::SetFactoryFunction(
base::BindRepeating(&aura::test::EventGeneratorDelegateAura::Create));

if (init_params.config_type == kUnitTest) {
zero_duration_mode_.reset(new ui::ScopedAnimationDurationScaleMode(
ui::ScopedAnimationDurationScaleMode::ZERO_DURATION));
}

if (!init_params.context_factory) {
context_factories_ = std::make_unique<ui::TestContextFactories>(false);
init_params.context_factory = context_factories_->GetContextFactory();
}

// Reset aura::Env to eliminate test dependency (https://crbug.com/586514).
aura::test::EnvTestHelper env_helper(aura::Env::GetInstance());
env_helper.ResetEnvForTesting();
env_helper.SetInputStateLookup(std::unique_ptr<aura::InputStateLookup>());

// Ash-specific setup -------------------------------------------------------

command_line_ = std::make_unique<base::test::ScopedCommandLine>();
statistics_provider_ =
std::make_unique<chromeos::system::ScopedFakeStatisticsProvider>();
prefs_provider_ = std::make_unique<TestPrefServiceProvider>();
notifier_settings_controller_ =
std::make_unique<TestNotifierSettingsController>();
assistant_service_ = std::make_unique<TestAssistantService>();
system_tray_client_ = std::make_unique<TestSystemTrayClient>();
photo_controller_ = std::make_unique<TestPhotoController>();

// TODO(jamescook): Can we do this without changing command line?
// Use the origin (1,1) so that it doesn't over
// lap with the native mouse cursor.
Expand All @@ -91,156 +130,108 @@ void AshTestHelper::SetUp(InitParams init_params) {
::switches::kHostWindowBounds, "10+10-800x600");
}

// Pre shell creation config init.
switch (init_params.config_type) {
case kUnitTest:
// Default for unit tests but not for perf tests.
zero_duration_mode_.reset(new ui::ScopedAnimationDurationScaleMode(
ui::ScopedAnimationDurationScaleMode::ZERO_DURATION));
TabletModeController::SetUseScreenshotForTest(false);
FALLTHROUGH;
case kPerfTest:
// Default for both unit and perf tests.
ui::test::EnableTestConfigForPlatformWindows();
display::ResetDisplayIdForTest();
ui::InitializeInputMethodForTesting();
break;
case kShell:
break;
}
if (init_params.config_type == kUnitTest)
TabletModeController::SetUseScreenshotForTest(false);

statistics_provider_ =
std::make_unique<chromeos::system::ScopedFakeStatisticsProvider>();
if (init_params.config_type != kShell)
display::ResetDisplayIdForTest();

ui::test::EventGeneratorDelegate::SetFactoryFunction(
base::BindRepeating(&aura::test::EventGeneratorDelegateAura::Create));
chromeos::CrasAudioClient::InitializeFake();
// Create CrasAudioHandler for testing since g_browser_process is not
// created in AshTestBase tests.
chromeos::CrasAudioHandler::InitializeForTesting();

wm_state_ = std::make_unique<::wm::WMState>();
// Only create a ViewsDelegate if the test didn't create one already.
if (!views::ViewsDelegate::GetInstance())
test_views_delegate_ = std::make_unique<AshTestViewsDelegate>();
// Reset the global state for the cursor manager. This includes the
// last cursor visibility state, etc.
::wm::CursorManager::ResetCursorVisibilityStateForTest();

if (!bluez::BluezDBusManager::IsInitialized()) {
bluez::BluezDBusManager::InitializeFake();
bluez_dbus_manager_initialized_ = true;
}

if (!chromeos::PowerManagerClient::Get())
chromeos::PowerManagerClient::InitializeFake();

if (!chromeos::PowerPolicyController::IsInitialized()) {
chromeos::PowerPolicyController::Initialize(
chromeos::PowerManagerClient::Get());
power_policy_controller_initialized_ = true;
}

chromeos::CrasAudioClient::InitializeFake();
// Create CrasAudioHandler for testing since g_browser_process is not
// created in AshTestBase tests.
chromeos::CrasAudioHandler::InitializeForTesting();

// Reset the global state for the cursor manager. This includes the
// last cursor visibility state, etc.
::wm::CursorManager::ResetCursorVisibilityStateForTest();
if (!NewWindowDelegate::GetInstance())
new_window_delegate_ = std::make_unique<TestNewWindowDelegate>();
if (!views::ViewsDelegate::GetInstance())
test_views_delegate_ = std::make_unique<AshTestViewsDelegate>();

ShellInitParams shell_init_params;
shell_init_params.delegate = std::move(init_params.delegate);
if (!shell_init_params.delegate)
shell_init_params.delegate = std::make_unique<TestShellDelegate>();
shell_init_params.context_factory = init_params.context_factory;
if (!shell_init_params.context_factory) {
context_factories_ = std::make_unique<ui::TestContextFactories>(false);
shell_init_params.context_factory = context_factories_->GetContextFactory();
}
shell_init_params.local_state = init_params.local_state;
shell_init_params.keyboard_ui_factory =
std::make_unique<TestKeyboardUIFactory>();
Shell::CreateInstance(std::move(shell_init_params));

// Reset aura::Env to eliminate test dependency (https://crbug.com/586514).
aura::test::EnvTestHelper env_helper(aura::Env::GetInstance());
env_helper.ResetEnvForTesting();

env_helper.SetInputStateLookup(std::unique_ptr<aura::InputStateLookup>());

Shell* shell = Shell::Get();

// Cursor is visible by default in tests.
// CursorManager is null on MASH.
if (shell->cursor_manager())
shell->cursor_manager()->ShowCursor();

prefs_provider_ = std::make_unique<TestPrefServiceProvider>();
session_controller_client_.reset(new TestSessionControllerClient(
shell->session_controller(), prefs_provider_.get()));
session_controller_client_->InitializeAndSetClient();

notifier_settings_controller_ =
std::make_unique<TestNotifierSettingsController>();
shell->cursor_manager()->ShowCursor();

assistant_service_ = std::make_unique<TestAssistantService>();
shell->assistant_controller()->SetAssistant(
assistant_service_->CreateRemoteAndBind());

system_tray_client_ = std::make_unique<TestSystemTrayClient>();
shell->system_tray_model()->SetClient(system_tray_client_.get());

photo_controller_ = std::make_unique<TestPhotoController>();

session_controller_client_.reset(new TestSessionControllerClient(
shell->session_controller(), prefs_provider_.get()));
session_controller_client_->InitializeAndSetClient();
if (init_params.start_session)
session_controller_client_->CreatePredefinedUserSessions(1);

// Requires the AppListController the Shell creates.
app_list_test_helper_ = std::make_unique<AppListTestHelper>();

if (!NewWindowDelegate::GetInstance())
new_window_delegate_ = std::make_unique<TestNewWindowDelegate>();

// Post shell creation config init.
switch (init_params.config_type) {
case kUnitTest:
// Tests that change the display configuration generally don't care about
// the notifications and the popup UI can interfere with things like
// cursors.
shell->screen_layout_observer()->set_show_notifications_for_testing(
false);

// Disable display change animations in unit tests.
DisplayConfigurationControllerTestApi(
shell->display_configuration_controller())
.SetDisplayAnimator(false);

// Remove the app dragging animations delay for testing purposes.
shell->overview_controller()->set_delayed_animation_task_delay_for_test(
base::TimeDelta());
// Tests expect empty wallpaper.
shell->wallpaper_controller()->CreateEmptyWallpaperForTesting();

FALLTHROUGH;
case kPerfTest:
// Don't change the display size due to host size resize.
display::test::DisplayManagerTestApi(shell->display_manager())
.DisableChangeDisplayUponHostResize();

// Create the test keyboard controller observer to respond to
// OnLoadKeyboardContentsRequested().
test_keyboard_controller_observer_ =
std::make_unique<TestKeyboardControllerObserver>(
shell->keyboard_controller());
break;
case kShell:
shell->wallpaper_controller()->ShowDefaultWallpaperForTesting();
break;
if (init_params.config_type == kShell) {
shell->wallpaper_controller()->ShowDefaultWallpaperForTesting();
return;
}

// Don't change the display size due to host size resize.
display::test::DisplayManagerTestApi(shell->display_manager())
.DisableChangeDisplayUponHostResize();

// Create the test keyboard controller observer to respond to
// OnLoadKeyboardContentsRequested().
test_keyboard_controller_observer_ =
std::make_unique<TestKeyboardControllerObserver>(
shell->keyboard_controller());

if (init_params.config_type != kUnitTest)
return;

// Tests that change the display configuration generally don't care about the
// notifications and the popup UI can interfere with things like cursors.
shell->screen_layout_observer()->set_show_notifications_for_testing(false);

// Disable display change animations in unit tests.
DisplayConfigurationControllerTestApi(
shell->display_configuration_controller())
.SetDisplayAnimator(false);

// Remove the app dragging animations delay for testing purposes.
shell->overview_controller()->set_delayed_animation_task_delay_for_test(
base::TimeDelta());

// Tests expect empty wallpaper.
shell->wallpaper_controller()->CreateEmptyWallpaperForTesting();
}

void AshTestHelper::TearDown() {
// Ash-specific teardown ----------------------------------------------------

// The AppListTestHelper holds a pointer to the AppListController the Shell
// owns, so shut the test helper down first.
app_list_test_helper_.reset();

Shell::DeleteInstance();
new_window_delegate_.reset();

// Needs to be reset after Shell::Get()->keyboard_controller() is deleted.
test_keyboard_controller_observer_.reset();

// Suspend the tear down until all resources are returned via
// CompositorFrameSinkClient::ReclaimResources()
Expand All @@ -249,45 +240,51 @@ void AshTestHelper::TearDown() {
chromeos::CrasAudioHandler::Shutdown();
chromeos::CrasAudioClient::Shutdown();

// The PowerPolicyController holds a pointer to the PowerManagementClient, so
// shut the controller down first.
if (power_policy_controller_initialized_) {
chromeos::PowerPolicyController::Shutdown();
power_policy_controller_initialized_ = false;
}

chromeos::PowerManagerClient::Shutdown();

TabletModeController::SetUseScreenshotForTest(true);

// Destroy all owned objects to prevent tests from depending on their state
// after this returns.
test_keyboard_controller_observer_.reset();
test_views_delegate_.reset();
new_window_delegate_.reset();
if (bluez_dbus_manager_initialized_) {
device::BluetoothAdapterFactory::Shutdown();
bluez::BluezDBusManager::Shutdown();
bluez_dbus_manager_initialized_ = false;
}
photo_controller_.reset();
system_tray_client_.reset();
assistant_service_.reset();
notifier_settings_controller_.reset();
prefs_provider_.reset();
statistics_provider_.reset();
command_line_.reset();

context_factories_.reset();
// Aura-general teardown ----------------------------------------------------

ui::ShutdownInputMethodForTesting();

// Context factory referenced by Env is now destroyed. Reset Env's members in
// case some other test tries to use it. This matters if someone else created
// Env (such as the test suite) and is long lived.
if (aura::Env::HasInstance())
aura::Env::GetInstance()->set_context_factory(nullptr);

ui::ShutdownInputMethodForTesting();
zero_duration_mode_.reset();

test_views_delegate_.reset();
wm_state_.reset();

command_line_.reset();

display::Display::ResetForceDeviceScaleFactorForTesting();

CHECK(!::wm::CaptureController::Get());

ui::test::EventGeneratorDelegate::SetFactoryFunction(
ui::test::EventGeneratorDelegate::FactoryFunction());

statistics_provider_.reset();

TabletModeController::SetUseScreenshotForTest(true);
context_factories_.reset();
zero_duration_mode_.reset();
wm_state_.reset();
}

PrefService* AshTestHelper::GetLocalStatePrefService() {
Expand Down
29 changes: 10 additions & 19 deletions ash/test/ash_test_helper.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,32 +135,23 @@ class AshTestHelper {
void reset_commandline() { command_line_.reset(); }

private:
std::unique_ptr<::wm::WMState> wm_state_;
std::unique_ptr<ui::ScopedAnimationDurationScaleMode> zero_duration_mode_;
std::unique_ptr<ui::TestContextFactories> context_factories_;
std::unique_ptr<base::test::ScopedCommandLine> command_line_;
std::unique_ptr<chromeos::system::ScopedFakeStatisticsProvider>
statistics_provider_;

std::unique_ptr<ui::ScopedAnimationDurationScaleMode> zero_duration_mode_;

std::unique_ptr<::wm::WMState> wm_state_;
std::unique_ptr<AshTestViewsDelegate> test_views_delegate_;

// Flags for whether various services were initialized here.
bool bluez_dbus_manager_initialized_ = false;
bool power_policy_controller_initialized_ = false;

std::unique_ptr<TestSessionControllerClient> session_controller_client_;
std::unique_ptr<TestNotifierSettingsController> notifier_settings_controller_;
std::unique_ptr<TestSystemTrayClient> system_tray_client_;
std::unique_ptr<TestPrefServiceProvider> prefs_provider_;
std::unique_ptr<TestNotifierSettingsController> notifier_settings_controller_;
std::unique_ptr<TestAssistantService> assistant_service_;
std::unique_ptr<ui::TestContextFactories> context_factories_;
std::unique_ptr<TestSystemTrayClient> system_tray_client_;
std::unique_ptr<TestPhotoController> photo_controller_;

std::unique_ptr<base::test::ScopedCommandLine> command_line_;

std::unique_ptr<AppListTestHelper> app_list_test_helper_;

bool bluez_dbus_manager_initialized_ = false;
bool power_policy_controller_initialized_ = false;
std::unique_ptr<TestNewWindowDelegate> new_window_delegate_;

std::unique_ptr<AshTestViewsDelegate> test_views_delegate_;
std::unique_ptr<TestSessionControllerClient> session_controller_client_;
std::unique_ptr<TestKeyboardControllerObserver>
test_keyboard_controller_observer_;

Expand Down

0 comments on commit ec1e1cf

Please sign in to comment.