device_settings_test_helper.h revision c2e0dbddbe15c98d52c4786dac06cb8952a8ae6d
1// Copyright (c) 2012 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef CHROME_BROWSER_CHROMEOS_SETTINGS_DEVICE_SETTINGS_TEST_HELPER_H_ 6#define CHROME_BROWSER_CHROMEOS_SETTINGS_DEVICE_SETTINGS_TEST_HELPER_H_ 7 8#include <map> 9#include <string> 10#include <vector> 11 12#include "base/basictypes.h" 13#include "base/compiler_specific.h" 14#include "base/memory/ref_counted.h" 15#include "base/message_loop.h" 16#include "base/string_util.h" 17#include "chrome/browser/chromeos/policy/device_policy_builder.h" 18#include "chrome/browser/chromeos/settings/device_settings_service.h" 19#include "chrome/browser/chromeos/settings/device_settings_test_helper.h" 20#include "chrome/browser/chromeos/settings/mock_owner_key_util.h" 21#include "chromeos/dbus/session_manager_client.h" 22#include "content/public/test/test_browser_thread.h" 23#include "testing/gtest/include/gtest/gtest.h" 24 25namespace chromeos { 26 27// A helper class for tests mocking out session_manager's device settings 28// interface. The pattern is to initialize DeviceSettingsService with the helper 29// for the SessionManagerClient pointer. The helper records calls made by 30// DeviceSettingsService. The test can then verify state, after which it should 31// call one of the Flush() variants that will resume processing. 32class DeviceSettingsTestHelper : public SessionManagerClient { 33 public: 34 // Wraps a device settings service instance for testing. 35 DeviceSettingsTestHelper(); 36 virtual ~DeviceSettingsTestHelper(); 37 38 // Flushes operations on the current message loop and the blocking pool. 39 void FlushLoops(); 40 41 // Runs all pending store callbacks. 42 void FlushStore(); 43 44 // Runs all pending retrieve callbacks. 45 void FlushRetrieve(); 46 47 // Flushes all pending operations. 48 void Flush(); 49 50 // Checks whether any asynchronous Store/Retrieve operations are pending. 51 bool HasPendingOperations() const; 52 53 bool store_result() { 54 return device_policy_.store_result_; 55 } 56 void set_store_result(bool store_result) { 57 device_policy_.store_result_ = store_result; 58 } 59 60 const std::string& policy_blob() { 61 return device_policy_.policy_blob_; 62 } 63 void set_policy_blob(const std::string& policy_blob) { 64 device_policy_.policy_blob_ = policy_blob; 65 } 66 67 const std::string& device_local_account_policy_blob( 68 const std::string& id) const { 69 const std::map<std::string, PolicyState>::const_iterator entry = 70 device_local_account_policy_.find(id); 71 return entry == device_local_account_policy_.end() ? 72 EmptyString() : entry->second.policy_blob_; 73 } 74 75 void set_device_local_account_policy_blob(const std::string& id, 76 const std::string& policy_blob) { 77 device_local_account_policy_[id].policy_blob_ = policy_blob; 78 } 79 80 // SessionManagerClient: 81 virtual void AddObserver(Observer* observer) OVERRIDE; 82 virtual void RemoveObserver(Observer* observer) OVERRIDE; 83 virtual bool HasObserver(Observer* observer) OVERRIDE; 84 virtual void EmitLoginPromptReady() OVERRIDE; 85 virtual void EmitLoginPromptVisible() OVERRIDE; 86 virtual void RestartJob(int pid, const std::string& command_line) OVERRIDE; 87 virtual void RestartEntd() OVERRIDE; 88 virtual void StartSession(const std::string& user_email) OVERRIDE; 89 virtual void StopSession() OVERRIDE; 90 virtual void StartDeviceWipe() OVERRIDE; 91 virtual void RequestLockScreen() OVERRIDE; 92 virtual void NotifyLockScreenShown() OVERRIDE; 93 virtual void RequestUnlockScreen() OVERRIDE; 94 virtual void NotifyLockScreenDismissed() OVERRIDE; 95 virtual void RetrieveDevicePolicy( 96 const RetrievePolicyCallback& callback) OVERRIDE; 97 virtual void RetrieveUserPolicy( 98 const RetrievePolicyCallback& callback) OVERRIDE; 99 virtual void RetrieveDeviceLocalAccountPolicy( 100 const std::string& account_id, 101 const RetrievePolicyCallback& callback) OVERRIDE; 102 virtual void StoreDevicePolicy(const std::string& policy_blob, 103 const StorePolicyCallback& callback) OVERRIDE; 104 virtual void StoreUserPolicy(const std::string& policy_blob, 105 const StorePolicyCallback& callback) OVERRIDE; 106 virtual void StoreDeviceLocalAccountPolicy( 107 const std::string& account_id, 108 const std::string& policy_blob, 109 const StorePolicyCallback& callback) OVERRIDE; 110 111 private: 112 struct PolicyState { 113 bool store_result_; 114 std::string policy_blob_; 115 std::vector<StorePolicyCallback> store_callbacks_; 116 std::vector<RetrievePolicyCallback> retrieve_callbacks_; 117 118 PolicyState(); 119 ~PolicyState(); 120 121 bool HasPendingOperations() const { 122 return !store_callbacks_.empty() || !retrieve_callbacks_.empty(); 123 } 124 }; 125 126 PolicyState device_policy_; 127 std::map<std::string, PolicyState> device_local_account_policy_; 128 129 DISALLOW_COPY_AND_ASSIGN(DeviceSettingsTestHelper); 130}; 131 132// Wraps the singleton device settings and initializes it to the point where it 133// reports OWNERSHIP_NONE for the ownership status. 134class ScopedDeviceSettingsTestHelper : public DeviceSettingsTestHelper { 135 public: 136 ScopedDeviceSettingsTestHelper(); 137 virtual ~ScopedDeviceSettingsTestHelper(); 138 139 private: 140 DISALLOW_COPY_AND_ASSIGN(ScopedDeviceSettingsTestHelper); 141}; 142 143// A convenience test base class that initializes a DeviceSettingsService 144// instance for testing and allows for straightforward updating of device 145// settings. |device_settings_service_| starts out in uninitialized state, so 146// startup code gets tested as well. 147class DeviceSettingsTestBase : public testing::Test { 148 protected: 149 DeviceSettingsTestBase(); 150 virtual ~DeviceSettingsTestBase(); 151 152 virtual void SetUp() OVERRIDE; 153 virtual void TearDown() OVERRIDE; 154 155 // Flushes any pending device settings operations. 156 void FlushDeviceSettings(); 157 158 // Triggers an owner key and device settings reload on 159 // |device_settings_service_| and flushes the resulting load operation. 160 void ReloadDeviceSettings(); 161 162 MessageLoop loop_; 163 content::TestBrowserThread ui_thread_; 164 content::TestBrowserThread file_thread_; 165 166 policy::DevicePolicyBuilder device_policy_; 167 168 DeviceSettingsTestHelper device_settings_test_helper_; 169 scoped_refptr<MockOwnerKeyUtil> owner_key_util_; 170 // Local DeviceSettingsService instance for tests. Avoid using in combination 171 // with the global instance (DeviceSettingsService::Get()). 172 DeviceSettingsService device_settings_service_; 173 174 private: 175 DISALLOW_COPY_AND_ASSIGN(DeviceSettingsTestBase); 176}; 177 178} // namespace chromeos 179 180#endif // CHROME_BROWSER_CHROMEOS_SETTINGS_DEVICE_SETTINGS_TEST_HELPER_H_ 181