policy_recommendation_restorer_unittest.cc 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  1. // Copyright 2018 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. #include "ash/policy/policy_recommendation_restorer.h"
  5. #include "ash/constants/ash_pref_names.h"
  6. #include "ash/public/cpp/ash_prefs.h"
  7. #include "ash/session/session_controller_impl.h"
  8. #include "ash/session/test_session_controller_client.h"
  9. #include "ash/shell.h"
  10. #include "ash/test/ash_test_base.h"
  11. #include "base/memory/ptr_util.h"
  12. #include "components/prefs/pref_notifier_impl.h"
  13. #include "components/prefs/testing_pref_store.h"
  14. #include "components/sync_preferences/testing_pref_service_syncable.h"
  15. #include "ui/base/user_activity/user_activity_detector.h"
  16. namespace ash {
  17. class PolicyRecommendationRestorerTest : public NoSessionAshTestBase {
  18. public:
  19. PolicyRecommendationRestorerTest(const PolicyRecommendationRestorerTest&) =
  20. delete;
  21. PolicyRecommendationRestorerTest& operator=(
  22. const PolicyRecommendationRestorerTest&) = delete;
  23. protected:
  24. PolicyRecommendationRestorerTest()
  25. : recommended_prefs_(new TestingPrefStore),
  26. prefs_(new sync_preferences::TestingPrefServiceSyncable(
  27. /*managed_prefs=*/new TestingPrefStore,
  28. /*supervised_user_prefs=*/new TestingPrefStore,
  29. /*extension_prefs=*/new TestingPrefStore,
  30. /*standalone_browser_prefs=*/new TestingPrefStore,
  31. /*user_prefs=*/new TestingPrefStore,
  32. recommended_prefs_,
  33. new user_prefs::PrefRegistrySyncable,
  34. new PrefNotifierImpl)) {}
  35. ~PolicyRecommendationRestorerTest() override = default;
  36. // NoSessionAshTestBase override:
  37. void SetUp() override {
  38. TestSessionControllerClient::DisableAutomaticallyProvideSigninPref();
  39. NoSessionAshTestBase::SetUp();
  40. // Register sigin prefs but not connected to pref service yet. This allows
  41. // us set pref values before ash connects to pref service for testing.
  42. RegisterSigninProfilePrefs(prefs_->registry(), true /* for_test */);
  43. restorer_ = Shell::Get()->policy_recommendation_restorer();
  44. }
  45. void ConnectToSigninPrefService() {
  46. GetSessionControllerClient()->SetSigninScreenPrefService(
  47. base::WrapUnique(prefs_));
  48. ASSERT_EQ(Shell::Get()->session_controller()->GetSigninScreenPrefService(),
  49. prefs_);
  50. // Manually trigger a user activity, so that the delay is not skipped due to
  51. // no user input since a pref is started observing recommended value. See
  52. // PolicyRecommendationRestorer::Restore() for the information.
  53. ui::UserActivityDetector::Get()->HandleExternalUserActivity();
  54. }
  55. void SetRecommendedValues() {
  56. recommended_prefs_->SetBoolean(prefs::kAccessibilityLargeCursorEnabled,
  57. false);
  58. recommended_prefs_->SetBoolean(prefs::kAccessibilitySpokenFeedbackEnabled,
  59. false);
  60. recommended_prefs_->SetBoolean(prefs::kAccessibilityHighContrastEnabled,
  61. false);
  62. recommended_prefs_->SetBoolean(prefs::kAccessibilityScreenMagnifierEnabled,
  63. false);
  64. recommended_prefs_->SetBoolean(prefs::kAccessibilityVirtualKeyboardEnabled,
  65. false);
  66. }
  67. void SetUserSettings() {
  68. prefs_->SetBoolean(prefs::kAccessibilityLargeCursorEnabled, true);
  69. prefs_->SetBoolean(prefs::kAccessibilitySpokenFeedbackEnabled, true);
  70. prefs_->SetBoolean(prefs::kAccessibilityHighContrastEnabled, true);
  71. prefs_->SetBoolean(prefs::kAccessibilityScreenMagnifierEnabled, true);
  72. prefs_->SetBoolean(prefs::kAccessibilityVirtualKeyboardEnabled, true);
  73. }
  74. void VerifyPrefFollowsUser(const std::string& pref_name,
  75. const base::Value& expected_value) const {
  76. const sync_preferences::PrefServiceSyncable::Preference* pref =
  77. prefs_->FindPreference(pref_name);
  78. ASSERT_TRUE(pref);
  79. EXPECT_TRUE(pref->HasUserSetting());
  80. const base::Value* value = pref->GetValue();
  81. ASSERT_TRUE(value);
  82. EXPECT_EQ(expected_value, *value);
  83. }
  84. void VerifyPrefsFollowUser() const {
  85. VerifyPrefFollowsUser(prefs::kAccessibilityLargeCursorEnabled,
  86. base::Value(true));
  87. VerifyPrefFollowsUser(prefs::kAccessibilitySpokenFeedbackEnabled,
  88. base::Value(true));
  89. VerifyPrefFollowsUser(prefs::kAccessibilityHighContrastEnabled,
  90. base::Value(true));
  91. VerifyPrefFollowsUser(prefs::kAccessibilityScreenMagnifierEnabled,
  92. base::Value(true));
  93. VerifyPrefFollowsUser(prefs::kAccessibilityVirtualKeyboardEnabled,
  94. base::Value(true));
  95. }
  96. void VerifyPrefFollowsRecommendation(
  97. const std::string& pref_name,
  98. const base::Value& expected_value) const {
  99. const sync_preferences::PrefServiceSyncable::Preference* pref =
  100. prefs_->FindPreference(pref_name);
  101. ASSERT_TRUE(pref);
  102. EXPECT_TRUE(pref->IsRecommended());
  103. EXPECT_FALSE(pref->HasUserSetting());
  104. const base::Value* value = pref->GetValue();
  105. ASSERT_TRUE(value);
  106. EXPECT_EQ(expected_value, *value);
  107. }
  108. void VerifyPrefsFollowRecommendation() const {
  109. VerifyPrefFollowsRecommendation(prefs::kAccessibilityLargeCursorEnabled,
  110. base::Value(false));
  111. VerifyPrefFollowsRecommendation(prefs::kAccessibilitySpokenFeedbackEnabled,
  112. base::Value(false));
  113. VerifyPrefFollowsRecommendation(prefs::kAccessibilityHighContrastEnabled,
  114. base::Value(false));
  115. VerifyPrefFollowsRecommendation(prefs::kAccessibilityScreenMagnifierEnabled,
  116. base::Value(false));
  117. VerifyPrefFollowsRecommendation(prefs::kAccessibilityVirtualKeyboardEnabled,
  118. base::Value(false));
  119. }
  120. bool RestoreTimerIsRunning() {
  121. return restorer_->restore_timer_for_test()->IsRunning();
  122. }
  123. // If restore timer is running, stops it, runs its task and returns true.
  124. // Otherwise, returns false.
  125. [[nodiscard]] bool TriggerRestoreTimer() {
  126. if (!restorer_->restore_timer_for_test()->IsRunning())
  127. return false;
  128. restorer_->restore_timer_for_test()->FireNow();
  129. return true;
  130. }
  131. PolicyRecommendationRestorer* restorer_ = nullptr;
  132. // Ownerships are passed to SessionController.
  133. TestingPrefStore* recommended_prefs_;
  134. sync_preferences::TestingPrefServiceSyncable* prefs_;
  135. };
  136. // Verifies that when no recommended values have been set, |restorer_| does not
  137. // clear user settings on initialization and does not start a timer that will
  138. // clear user settings eventually.
  139. TEST_F(PolicyRecommendationRestorerTest, NoRecommendations) {
  140. SetUserSettings();
  141. ConnectToSigninPrefService();
  142. VerifyPrefsFollowUser();
  143. EXPECT_FALSE(RestoreTimerIsRunning());
  144. }
  145. // Verifies that when recommended values have been set, |restorer_| clears user
  146. // settings on signing pref initialization.
  147. TEST_F(PolicyRecommendationRestorerTest, RestoreOnSigninPrefInitialized) {
  148. SetRecommendedValues();
  149. SetUserSettings();
  150. ConnectToSigninPrefService();
  151. VerifyPrefsFollowRecommendation();
  152. EXPECT_FALSE(RestoreTimerIsRunning());
  153. }
  154. // Verifies that if recommended values change while the signin screen is being
  155. // shown, a timer is started that will clear user settings eventually.
  156. TEST_F(PolicyRecommendationRestorerTest,
  157. RestoreOnRecommendationChangeOnSigninScreen) {
  158. // No recommended values in observed prefs.
  159. ConnectToSigninPrefService();
  160. EXPECT_FALSE(RestoreTimerIsRunning());
  161. prefs_->SetBoolean(prefs::kAccessibilityLargeCursorEnabled, true);
  162. VerifyPrefFollowsUser(prefs::kAccessibilityLargeCursorEnabled,
  163. base::Value(true));
  164. EXPECT_FALSE(RestoreTimerIsRunning());
  165. recommended_prefs_->SetBoolean(prefs::kAccessibilityLargeCursorEnabled,
  166. false);
  167. EXPECT_TRUE(TriggerRestoreTimer());
  168. VerifyPrefFollowsRecommendation(prefs::kAccessibilityLargeCursorEnabled,
  169. base::Value(false));
  170. prefs_->SetBoolean(prefs::kAccessibilitySpokenFeedbackEnabled, true);
  171. VerifyPrefFollowsUser(prefs::kAccessibilitySpokenFeedbackEnabled,
  172. base::Value(true));
  173. recommended_prefs_->SetBoolean(prefs::kAccessibilitySpokenFeedbackEnabled,
  174. false);
  175. EXPECT_TRUE(TriggerRestoreTimer());
  176. VerifyPrefFollowsRecommendation(prefs::kAccessibilitySpokenFeedbackEnabled,
  177. base::Value(false));
  178. prefs_->SetBoolean(prefs::kAccessibilityHighContrastEnabled, true);
  179. VerifyPrefFollowsUser(prefs::kAccessibilityHighContrastEnabled,
  180. base::Value(true));
  181. recommended_prefs_->SetBoolean(prefs::kAccessibilityHighContrastEnabled,
  182. false);
  183. EXPECT_TRUE(TriggerRestoreTimer());
  184. VerifyPrefFollowsRecommendation(prefs::kAccessibilityHighContrastEnabled,
  185. base::Value(false));
  186. prefs_->SetBoolean(prefs::kAccessibilityScreenMagnifierEnabled, true);
  187. VerifyPrefFollowsUser(prefs::kAccessibilityScreenMagnifierEnabled,
  188. base::Value(true));
  189. recommended_prefs_->SetBoolean(prefs::kAccessibilityScreenMagnifierEnabled,
  190. false);
  191. EXPECT_TRUE(TriggerRestoreTimer());
  192. VerifyPrefFollowsRecommendation(prefs::kAccessibilityScreenMagnifierEnabled,
  193. base::Value(false));
  194. prefs_->SetBoolean(prefs::kAccessibilityVirtualKeyboardEnabled, true);
  195. VerifyPrefFollowsUser(prefs::kAccessibilityVirtualKeyboardEnabled,
  196. base::Value(true));
  197. recommended_prefs_->SetBoolean(prefs::kAccessibilityVirtualKeyboardEnabled,
  198. false);
  199. EXPECT_TRUE(TriggerRestoreTimer());
  200. VerifyPrefFollowsRecommendation(prefs::kAccessibilityVirtualKeyboardEnabled,
  201. base::Value(false));
  202. }
  203. // Verifies that if recommended values change while a user session is in
  204. // progress, user settings are cleared immediately.
  205. TEST_F(PolicyRecommendationRestorerTest,
  206. RestoreOnRecommendationChangeOnUserSession) {
  207. SetUserSettings();
  208. ConnectToSigninPrefService();
  209. SimulateUserLogin("user@test.com");
  210. VerifyPrefFollowsUser(prefs::kAccessibilityLargeCursorEnabled,
  211. base::Value(true));
  212. recommended_prefs_->SetBoolean(prefs::kAccessibilityLargeCursorEnabled,
  213. false);
  214. EXPECT_FALSE(RestoreTimerIsRunning());
  215. VerifyPrefFollowsRecommendation(prefs::kAccessibilityLargeCursorEnabled,
  216. base::Value(false));
  217. VerifyPrefFollowsUser(prefs::kAccessibilitySpokenFeedbackEnabled,
  218. base::Value(true));
  219. recommended_prefs_->SetBoolean(prefs::kAccessibilitySpokenFeedbackEnabled,
  220. false);
  221. EXPECT_FALSE(RestoreTimerIsRunning());
  222. VerifyPrefFollowsRecommendation(prefs::kAccessibilitySpokenFeedbackEnabled,
  223. base::Value(false));
  224. VerifyPrefFollowsUser(prefs::kAccessibilityHighContrastEnabled,
  225. base::Value(true));
  226. recommended_prefs_->SetBoolean(prefs::kAccessibilityHighContrastEnabled,
  227. false);
  228. EXPECT_FALSE(RestoreTimerIsRunning());
  229. VerifyPrefFollowsRecommendation(prefs::kAccessibilityHighContrastEnabled,
  230. base::Value(false));
  231. VerifyPrefFollowsUser(prefs::kAccessibilityScreenMagnifierEnabled,
  232. base::Value(true));
  233. recommended_prefs_->SetBoolean(prefs::kAccessibilityScreenMagnifierEnabled,
  234. false);
  235. EXPECT_FALSE(RestoreTimerIsRunning());
  236. VerifyPrefFollowsRecommendation(prefs::kAccessibilityScreenMagnifierEnabled,
  237. base::Value(false));
  238. VerifyPrefFollowsUser(prefs::kAccessibilityVirtualKeyboardEnabled,
  239. base::Value(true));
  240. recommended_prefs_->SetBoolean(prefs::kAccessibilityVirtualKeyboardEnabled,
  241. false);
  242. EXPECT_FALSE(RestoreTimerIsRunning());
  243. VerifyPrefFollowsRecommendation(prefs::kAccessibilityVirtualKeyboardEnabled,
  244. base::Value(false));
  245. }
  246. // Verifies that if no recommended values have been set and user settings
  247. // change, the user settings are not cleared immediately and no timer is started
  248. // that will clear the user settings eventually.
  249. TEST_F(PolicyRecommendationRestorerTest, DoNothingOnUserChange) {
  250. ConnectToSigninPrefService();
  251. // a11y mono audio is not observing recommended values in production.
  252. prefs_->SetBoolean(prefs::kAccessibilityMonoAudioEnabled, true);
  253. VerifyPrefFollowsUser(prefs::kAccessibilityMonoAudioEnabled,
  254. base::Value(true));
  255. EXPECT_FALSE(RestoreTimerIsRunning());
  256. }
  257. TEST_F(PolicyRecommendationRestorerTest, RestoreOnUserChange) {
  258. SetRecommendedValues();
  259. ConnectToSigninPrefService();
  260. EXPECT_FALSE(RestoreTimerIsRunning());
  261. prefs_->SetBoolean(prefs::kAccessibilityLargeCursorEnabled, true);
  262. VerifyPrefFollowsUser(prefs::kAccessibilityLargeCursorEnabled,
  263. base::Value(true));
  264. EXPECT_TRUE(TriggerRestoreTimer());
  265. VerifyPrefFollowsRecommendation(prefs::kAccessibilityLargeCursorEnabled,
  266. base::Value(false));
  267. EXPECT_FALSE(RestoreTimerIsRunning());
  268. prefs_->SetBoolean(prefs::kAccessibilitySpokenFeedbackEnabled, true);
  269. VerifyPrefFollowsUser(prefs::kAccessibilitySpokenFeedbackEnabled,
  270. base::Value(true));
  271. EXPECT_TRUE(TriggerRestoreTimer());
  272. VerifyPrefFollowsRecommendation(prefs::kAccessibilitySpokenFeedbackEnabled,
  273. base::Value(false));
  274. EXPECT_FALSE(RestoreTimerIsRunning());
  275. prefs_->SetBoolean(prefs::kAccessibilityHighContrastEnabled, true);
  276. VerifyPrefFollowsUser(prefs::kAccessibilityHighContrastEnabled,
  277. base::Value(true));
  278. EXPECT_TRUE(TriggerRestoreTimer());
  279. VerifyPrefFollowsRecommendation(prefs::kAccessibilityHighContrastEnabled,
  280. base::Value(false));
  281. EXPECT_FALSE(RestoreTimerIsRunning());
  282. prefs_->SetBoolean(prefs::kAccessibilityScreenMagnifierEnabled, true);
  283. VerifyPrefFollowsUser(prefs::kAccessibilityScreenMagnifierEnabled,
  284. base::Value(true));
  285. EXPECT_TRUE(TriggerRestoreTimer());
  286. VerifyPrefFollowsRecommendation(prefs::kAccessibilityScreenMagnifierEnabled,
  287. base::Value(false));
  288. EXPECT_FALSE(RestoreTimerIsRunning());
  289. prefs_->SetBoolean(prefs::kAccessibilityVirtualKeyboardEnabled, true);
  290. VerifyPrefFollowsUser(prefs::kAccessibilityVirtualKeyboardEnabled,
  291. base::Value(true));
  292. EXPECT_TRUE(TriggerRestoreTimer());
  293. VerifyPrefFollowsRecommendation(prefs::kAccessibilityVirtualKeyboardEnabled,
  294. base::Value(false));
  295. EXPECT_FALSE(RestoreTimerIsRunning());
  296. }
  297. // Verifies that if recommended values have not been set, user settings have
  298. // changed and a session is then started, the user settings are not cleared
  299. // immediately.
  300. TEST_F(PolicyRecommendationRestorerTest, DoNothingOnSessionStart) {
  301. ConnectToSigninPrefService();
  302. SetUserSettings();
  303. SimulateUserLogin("user@test.com");
  304. VerifyPrefsFollowUser();
  305. EXPECT_FALSE(RestoreTimerIsRunning());
  306. }
  307. // Verifies that user activity resets the timer which clears user settings.
  308. TEST_F(PolicyRecommendationRestorerTest, UserActivityResetsTimer) {
  309. recommended_prefs_->SetBoolean(prefs::kAccessibilityLargeCursorEnabled,
  310. false);
  311. ConnectToSigninPrefService();
  312. prefs_->SetBoolean(prefs::kAccessibilityLargeCursorEnabled, true);
  313. EXPECT_TRUE(RestoreTimerIsRunning());
  314. // Notify that there is user activity.
  315. restorer_->OnUserActivity(nullptr);
  316. VerifyPrefFollowsUser(prefs::kAccessibilityLargeCursorEnabled,
  317. base::Value(true));
  318. // Trigger reset timer to timeout.
  319. EXPECT_TRUE(TriggerRestoreTimer());
  320. VerifyPrefFollowsRecommendation(prefs::kAccessibilityLargeCursorEnabled,
  321. base::Value(false));
  322. EXPECT_FALSE(RestoreTimerIsRunning());
  323. }
  324. } // namespace ash