OLD | NEW |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef BASE_TEST_TEST_REG_UTIL_H_ | 5 #ifndef BASE_TEST_TEST_REG_UTIL_H_ |
6 #define BASE_TEST_TEST_REG_UTIL_H_ | 6 #define BASE_TEST_TEST_REG_UTIL_H_ |
7 | 7 |
8 // Registry utility functions used only by tests. | 8 // Registry utility functions used only by tests. |
9 | 9 |
10 #include <string> | |
11 #include <vector> | |
12 | |
13 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
| 11 #include "base/memory/scoped_vector.h" |
| 12 #include "base/strings/string16.h" |
| 13 #include "base/time/time.h" |
14 #include "base/win/registry.h" | 14 #include "base/win/registry.h" |
15 | 15 |
16 namespace registry_util { | 16 namespace registry_util { |
17 | 17 |
18 // Allows a test to easily override registry hives so that it can start from a | 18 // Allows a test to easily override registry hives so that it can start from a |
19 // known good state, or make sure to not leave any side effects once the test | 19 // known good state, or make sure to not leave any side effects once the test |
20 // completes. | 20 // completes. This supports parallel tests. All the overrides are scoped to the |
| 21 // lifetime of the override manager. Destroy the manager to undo the overrides. |
| 22 // |
| 23 // Overridden hives use keys stored at, for instance: |
| 24 // HKCU\Software\Chromium\TempTestKeys\ |
| 25 // 13028145911617809$02AB211C-CF73-478D-8D91-618E11998AED |
| 26 // The key path are comprises of: |
| 27 // - The test key root, HKCU\Software\Chromium\TempTestKeys\ |
| 28 // - The base::Time::ToInternalValue of the creation time. This is used to |
| 29 // delete stale keys left over from crashed tests. |
| 30 // - A GUID used for preventing name collisions (although unlikely) between |
| 31 // two RegistryOverrideManagers created with the same timestamp. |
21 class RegistryOverrideManager { | 32 class RegistryOverrideManager { |
22 public: | 33 public: |
23 // All overridden hives will be descendents of this registry path under the | |
24 // main HKCU hive. | |
25 static const wchar_t kTempTestKeyPath[]; | |
26 | |
27 RegistryOverrideManager(); | 34 RegistryOverrideManager(); |
28 ~RegistryOverrideManager(); | 35 ~RegistryOverrideManager(); |
29 | 36 |
30 // Override the given registry hive using a temporary key named by temp_name | 37 // Override the given registry hive using a temporary key named by temp_name |
31 // under the temporary test key path. | 38 // under the temporary test key path. There is no need to randomize |
32 void OverrideRegistry(HKEY override, const std::wstring& temp_name); | 39 // |override_name|, as a random parent key is generated. Multiple overrides to |
33 | 40 // the same hive are not supported and lead to undefined behavior. |
34 // Deletes all temporary test keys used by the overrides. | 41 void OverrideRegistry(HKEY override, const string16& override_name); |
35 static void DeleteAllTempKeys(); | |
36 | |
37 // Removes all overrides and deletes all temporary test keys used by the | |
38 // overrides. | |
39 void RemoveAllOverrides(); | |
40 | 42 |
41 private: | 43 private: |
| 44 friend class RegistryOverrideManagerTest; |
| 45 |
42 // Keeps track of one override. | 46 // Keeps track of one override. |
43 class ScopedRegistryKeyOverride { | 47 class ScopedRegistryKeyOverride { |
44 public: | 48 public: |
45 ScopedRegistryKeyOverride(HKEY override, const std::wstring& temp_name); | 49 ScopedRegistryKeyOverride(HKEY override, const string16& key_path); |
46 ~ScopedRegistryKeyOverride(); | 50 ~ScopedRegistryKeyOverride(); |
47 | 51 |
48 private: | 52 private: |
49 HKEY override_; | 53 HKEY override_; |
50 base::win::RegKey temp_key_; | 54 base::win::RegKey temp_key_; |
51 std::wstring temp_name_; | |
52 | 55 |
53 DISALLOW_COPY_AND_ASSIGN(ScopedRegistryKeyOverride); | 56 DISALLOW_COPY_AND_ASSIGN(ScopedRegistryKeyOverride); |
54 }; | 57 }; |
55 | 58 |
56 std::vector<ScopedRegistryKeyOverride*> overrides_; | 59 // Used for testing only. |
| 60 RegistryOverrideManager(const base::Time& timestamp, |
| 61 const string16& test_key_root); |
| 62 |
| 63 base::Time timestamp_; |
| 64 string16 guid_; |
| 65 |
| 66 string16 test_key_root_; |
| 67 ScopedVector<ScopedRegistryKeyOverride> overrides_; |
57 | 68 |
58 DISALLOW_COPY_AND_ASSIGN(RegistryOverrideManager); | 69 DISALLOW_COPY_AND_ASSIGN(RegistryOverrideManager); |
59 }; | 70 }; |
60 | 71 |
| 72 // Generates a temporary key path that will be eventually deleted |
| 73 // automatically if the process crashes. |
| 74 string16 GenerateTempKeyPath(); |
| 75 |
61 } // namespace registry_util | 76 } // namespace registry_util |
62 | 77 |
63 #endif // BASE_TEST_TEST_REG_UTIL_H_ | 78 #endif // BASE_TEST_TEST_REG_UTIL_H_ |
OLD | NEW |