[go: nahoru, domu]
Google Git
Sign in
chromium / chromium / src / f873781812fb1cb5679d9d82cc1441037d3f0d9a / . / base / test / test_reg_util_win.h
blob: 8f47eaf1f869afd8ddb28b82562adf308c84911f [file] [log] [blame]
Avi Drissmane4622aa2022-09-08 20:36:06[diff] [blame]1// Copyright 2011 The Chromium Authors
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
danakj0a448602015-03-10 00:31:16[diff] [blame]5#ifndef BASE_TEST_TEST_REG_UTIL_WIN_H_
6#define BASE_TEST_TEST_REG_UTIL_WIN_H_
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]7
8// Registry utility functions used only by tests.
dcheng093de9b2016-04-04 21:25:51[diff] [blame]9#include <memory>
Jan Wilken Dörrie0cf1e27f2019-09-11 09:58:23[diff] [blame]10#include <string>
kimwjdalslab64c482015-12-16 00:11:10[diff] [blame]11#include <vector>
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]12
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]13#include "base/time/time.h"
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]14#include "base/win/registry.h"
15
Will Harris576615e2023-09-01 20:58:32[diff] [blame]16namespace content {
17class BrowserTestBase;
18}
19
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]20namespace registry_util {
21
22// Allows a test to easily override registry hives so that it can start from a
23// known good state, or make sure to not leave any side effects once the test
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]24// completes. This supports parallel tests. All the overrides are scoped to the
25// lifetime of the override manager. Destroy the manager to undo the overrides.
26//
27// Overridden hives use keys stored at, for instance:
28// HKCU\Software\Chromium\TempTestKeys\
29// 13028145911617809$02AB211C-CF73-478D-8D91-618E11998AED
30// The key path are comprises of:
31// - The test key root, HKCU\Software\Chromium\TempTestKeys\
32// - The base::Time::ToInternalValue of the creation time. This is used to
33// delete stale keys left over from crashed tests.
34// - A GUID used for preventing name collisions (although unlikely) between
35// two RegistryOverrideManagers created with the same timestamp.
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]36class RegistryOverrideManager {
37 public:
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]38 RegistryOverrideManager();
Peter Boström7319bbd2021-09-15 22:59:38[diff] [blame]39
40 RegistryOverrideManager(const RegistryOverrideManager&) = delete;
41 RegistryOverrideManager& operator=(const RegistryOverrideManager&) = delete;
42
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]43 ~RegistryOverrideManager();
44
gab6f7c83b2014-09-18 02:37:47[diff] [blame]45 // Override the given registry hive using a randomly generated temporary key.
46 // Multiple overrides to the same hive are not supported and lead to undefined
47 // behavior.
pennymac84fd6692016-07-13 22:35:34[diff] [blame]48 // Optional return of the registry override path.
grtf6d7da22017-02-14 07:14:47[diff] [blame]49 // Calls to these functions must be wrapped in ASSERT_NO_FATAL_FAILURE to
Will Harris576615e2023-09-01 20:58:32[diff] [blame]50 // ensure that tests do not proceed in case of failure to override.
51 // HKEY_LOCAL_MACHINE should not be overridden in initialization for tests
52 // that launch sandboxed processes e.g. browser tests. It is safe to use from
53 // within a text fixture, and in unit tests.
gab6f7c83b2014-09-18 02:37:47[diff] [blame]54 void OverrideRegistry(HKEY override);
Jan Wilken Dörrie0cf1e27f2019-09-11 09:58:23[diff] [blame]55 void OverrideRegistry(HKEY override, std::wstring* override_path);
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]56
57 private:
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]58 friend class RegistryOverrideManagerTest;
Will Harris576615e2023-09-01 20:58:32[diff] [blame]59 friend class content::BrowserTestBase;
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]60
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]61 // Keeps track of one override.
62 class ScopedRegistryKeyOverride {
63 public:
Jan Wilken Dörrie0cf1e27f2019-09-11 09:58:23[diff] [blame]64 ScopedRegistryKeyOverride(HKEY override, const std::wstring& key_path);
Peter Boström7319bbd2021-09-15 22:59:38[diff] [blame]65
66 ScopedRegistryKeyOverride(const ScopedRegistryKeyOverride&) = delete;
67 ScopedRegistryKeyOverride& operator=(const ScopedRegistryKeyOverride&) =
68 delete;
69
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]70 ~ScopedRegistryKeyOverride();
71
72 private:
73 HKEY override_;
Jan Wilken Dörrie0cf1e27f2019-09-11 09:58:23[diff] [blame]74 std::wstring key_path_;
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]75 };
76
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]77 // Used for testing only.
78 RegistryOverrideManager(const base::Time& timestamp,
Jan Wilken Dörrie0cf1e27f2019-09-11 09:58:23[diff] [blame]79 const std::wstring& test_key_root);
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]80
Will Harris576615e2023-09-01 20:58:32[diff] [blame]81 // Whether or not to allow using the RegistryOverrideManager for HKLM (e.g. in
82 // browser_tests).
83 static void SetAllowHKLMRegistryOverrideForIntegrationTests(bool allow);
84
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]85 base::Time timestamp_;
Jan Wilken Dörrie0cf1e27f2019-09-11 09:58:23[diff] [blame]86 std::wstring guid_;
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]87
Jan Wilken Dörrie0cf1e27f2019-09-11 09:58:23[diff] [blame]88 std::wstring test_key_root_;
dcheng093de9b2016-04-04 21:25:51[diff] [blame]89 std::vector<std::unique_ptr<ScopedRegistryKeyOverride>> overrides_;
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]90};
91
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]92// Generates a temporary key path that will be eventually deleted
93// automatically if the process crashes.
Jan Wilken Dörrie0cf1e27f2019-09-11 09:58:23[diff] [blame]94std::wstring GenerateTempKeyPath();
tommycli@chromium.org19b5cc22013-11-15 04:48:37[diff] [blame]95
rogerta@chromium.orga8f85882011-08-24 20:02:42[diff] [blame]96} // namespace registry_util
97
danakj0a448602015-03-10 00:31:16[diff] [blame]98#endif // BASE_TEST_TEST_REG_UTIL_WIN_H_