pastarmovj@chromium.org | 8f45209 | 2012-05-09 19:50:10 +0900 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
license.bot | f003cfe | 2008-08-24 09:55:55 +0900 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 4 | |
evanm@google.com | 874d167 | 2008-10-31 08:54:04 +0900 | [diff] [blame] | 5 | #include "base/path_service.h" |
| 6 | |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 7 | #include "base/basictypes.h" |
brettw@chromium.org | 091db52 | 2012-11-17 05:34:23 +0900 | [diff] [blame] | 8 | #include "base/file_util.h" |
brettw@chromium.org | 59eef1f | 2013-02-24 14:40:52 +0900 | [diff] [blame] | 9 | #include "base/files/file_path.h" |
brettw@chromium.org | 091db52 | 2012-11-17 05:34:23 +0900 | [diff] [blame] | 10 | #include "base/files/scoped_temp_dir.h" |
avi@chromium.org | 67d593d | 2013-06-11 04:06:57 +0900 | [diff] [blame] | 11 | #include "base/strings/string_util.h" |
gab@chromium.org | 97fc1e6 | 2012-09-21 01:24:52 +0900 | [diff] [blame] | 12 | #include "build/build_config.h" |
wjia@chromium.org | 9d594d1 | 2012-09-20 10:59:36 +0900 | [diff] [blame] | 13 | #include "testing/gtest/include/gtest/gtest-spi.h" |
brettw@chromium.org | 091db52 | 2012-11-17 05:34:23 +0900 | [diff] [blame] | 14 | #include "testing/gtest/include/gtest/gtest.h" |
wjia@chromium.org | 9d594d1 | 2012-09-20 10:59:36 +0900 | [diff] [blame] | 15 | #include "testing/platform_test.h" |
gab@chromium.org | 4011fea | 2012-09-20 09:13:40 +0900 | [diff] [blame] | 16 | |
gab@chromium.org | 97fc1e6 | 2012-09-21 01:24:52 +0900 | [diff] [blame] | 17 | #if defined(OS_WIN) |
| 18 | #include <userenv.h> |
| 19 | #include "base/win/windows_version.h" |
| 20 | // userenv.dll is required for GetDefaultUserProfileDirectory(). |
| 21 | #pragma comment(lib, "userenv.lib") |
| 22 | #endif |
| 23 | |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 24 | namespace { |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 25 | |
| 26 | // Returns true if PathService::Get returns true and sets the path parameter |
| 27 | // to non-empty for the given PathService::DirType enumeration value. |
| 28 | bool ReturnsValidPath(int dir_type) { |
brettw@chromium.org | 82bcf51 | 2013-02-17 14:07:23 +0900 | [diff] [blame] | 29 | base::FilePath path; |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 30 | bool result = PathService::Get(dir_type, &path); |
maruel@chromium.org | 805e39a | 2013-01-26 08:00:55 +0900 | [diff] [blame] | 31 | |
gab@chromium.org | 798226b | 2012-11-07 07:27:01 +0900 | [diff] [blame] | 32 | // Some paths might not exist on some platforms in which case confirming |
| 33 | // |result| is true and !path.empty() is the best we can do. |
| 34 | bool check_path_exists = true; |
evan@chromium.org | 9e3973b | 2010-11-24 07:39:30 +0900 | [diff] [blame] | 35 | #if defined(OS_POSIX) |
viettrungluu@chromium.org | 366266c | 2010-11-24 11:23:15 +0900 | [diff] [blame] | 36 | // If chromium has never been started on this account, the cache path may not |
evan@chromium.org | 9e3973b | 2010-11-24 07:39:30 +0900 | [diff] [blame] | 37 | // exist. |
viettrungluu@chromium.org | 366266c | 2010-11-24 11:23:15 +0900 | [diff] [blame] | 38 | if (dir_type == base::DIR_CACHE) |
gab@chromium.org | 798226b | 2012-11-07 07:27:01 +0900 | [diff] [blame] | 39 | check_path_exists = false; |
evan@chromium.org | 9e3973b | 2010-11-24 07:39:30 +0900 | [diff] [blame] | 40 | #endif |
gab@chromium.org | 97fc1e6 | 2012-09-21 01:24:52 +0900 | [diff] [blame] | 41 | #if defined(OS_LINUX) |
| 42 | // On the linux try-bots: a path is returned (e.g. /home/chrome-bot/Desktop), |
| 43 | // but it doesn't exist. |
| 44 | if (dir_type == base::DIR_USER_DESKTOP) |
gab@chromium.org | 798226b | 2012-11-07 07:27:01 +0900 | [diff] [blame] | 45 | check_path_exists = false; |
gab@chromium.org | 97fc1e6 | 2012-09-21 01:24:52 +0900 | [diff] [blame] | 46 | #endif |
| 47 | #if defined(OS_WIN) |
gab@chromium.org | 798226b | 2012-11-07 07:27:01 +0900 | [diff] [blame] | 48 | if (dir_type == base::DIR_DEFAULT_USER_QUICK_LAUNCH) { |
| 49 | // On Windows XP, the Quick Launch folder for the "Default User" doesn't |
| 50 | // exist by default. At least confirm that the path returned begins with the |
| 51 | // Default User's profile path. |
| 52 | if (base::win::GetVersion() < base::win::VERSION_VISTA) { |
| 53 | wchar_t default_profile_path[MAX_PATH]; |
| 54 | DWORD size = arraysize(default_profile_path); |
| 55 | return (result && |
| 56 | ::GetDefaultUserProfileDirectory(default_profile_path, &size) && |
| 57 | StartsWith(path.value(), default_profile_path, false)); |
| 58 | } |
| 59 | } else if (dir_type == base::DIR_TASKBAR_PINS) { |
| 60 | // There is no pinned-to-taskbar shortcuts prior to Win7. |
gab@chromium.org | 6aaf8f0 | 2012-11-15 10:01:51 +0900 | [diff] [blame] | 61 | if (base::win::GetVersion() < base::win::VERSION_WIN7) |
gab@chromium.org | 798226b | 2012-11-07 07:27:01 +0900 | [diff] [blame] | 62 | check_path_exists = false; |
gab@chromium.org | 97fc1e6 | 2012-09-21 01:24:52 +0900 | [diff] [blame] | 63 | } |
| 64 | #endif |
dalecurtis@google.com | d30c682 | 2013-03-20 07:06:20 +0900 | [diff] [blame] | 65 | #if defined(OS_MACOSX) |
maruel@chromium.org | 805e39a | 2013-01-26 08:00:55 +0900 | [diff] [blame] | 66 | if (dir_type != base::DIR_EXE && dir_type != base::DIR_MODULE && |
| 67 | dir_type != base::FILE_EXE && dir_type != base::FILE_MODULE) { |
| 68 | if (path.ReferencesParent()) |
| 69 | return false; |
| 70 | } |
| 71 | #else |
| 72 | if (path.ReferencesParent()) |
| 73 | return false; |
| 74 | #endif |
gab@chromium.org | 798226b | 2012-11-07 07:27:01 +0900 | [diff] [blame] | 75 | return result && !path.empty() && (!check_path_exists || |
brettw@chromium.org | 10b6412 | 2013-07-12 02:36:07 +0900 | [diff] [blame^] | 76 | base::PathExists(path)); |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 77 | } |
| 78 | |
erikkay@google.com | 3620e4c | 2008-08-12 00:38:27 +0900 | [diff] [blame] | 79 | #if defined(OS_WIN) |
benwells@chromium.org | bd09d67 | 2012-08-30 18:16:55 +0900 | [diff] [blame] | 80 | // Function to test any directory keys that are not supported on some versions |
| 81 | // of Windows. Checks that the function fails and that the returned path is |
| 82 | // empty. |
maruel@google.com | 3117767 | 2008-08-08 08:59:04 +0900 | [diff] [blame] | 83 | bool ReturnsInvalidPath(int dir_type) { |
brettw@chromium.org | 82bcf51 | 2013-02-17 14:07:23 +0900 | [diff] [blame] | 84 | base::FilePath path; |
benwells@chromium.org | bd09d67 | 2012-08-30 18:16:55 +0900 | [diff] [blame] | 85 | bool result = PathService::Get(dir_type, &path); |
maruel@google.com | 3117767 | 2008-08-08 08:59:04 +0900 | [diff] [blame] | 86 | return !result && path.empty(); |
maruel@google.com | 15cfc7f | 2008-08-08 05:23:09 +0900 | [diff] [blame] | 87 | } |
erikkay@google.com | 3620e4c | 2008-08-12 00:38:27 +0900 | [diff] [blame] | 88 | #endif |
maruel@google.com | 15cfc7f | 2008-08-08 05:23:09 +0900 | [diff] [blame] | 89 | |
| 90 | } // namespace |
| 91 | |
erikkay@google.com | f240684 | 2008-08-21 00:59:49 +0900 | [diff] [blame] | 92 | // On the Mac this winds up using some autoreleased objects, so we need to |
| 93 | // be a PlatformTest. |
| 94 | typedef PlatformTest PathServiceTest; |
| 95 | |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 96 | // Test that all PathService::Get calls return a value and a true result |
| 97 | // in the development environment. (This test was created because a few |
| 98 | // later changes to Get broke the semantics of the function and yielded the |
| 99 | // correct value while returning false.) |
erikkay@google.com | f240684 | 2008-08-21 00:59:49 +0900 | [diff] [blame] | 100 | TEST_F(PathServiceTest, Get) { |
gab@chromium.org | 97fc1e6 | 2012-09-21 01:24:52 +0900 | [diff] [blame] | 101 | for (int key = base::PATH_START + 1; key < base::PATH_END; ++key) { |
michaelbai@google.com | 4464bef | 2011-08-27 01:43:59 +0900 | [diff] [blame] | 102 | #if defined(OS_ANDROID) |
gab@chromium.org | 97fc1e6 | 2012-09-21 01:24:52 +0900 | [diff] [blame] | 103 | if (key == base::FILE_MODULE || key == base::DIR_USER_DESKTOP) |
| 104 | continue; // Android doesn't implement FILE_MODULE and DIR_USER_DESKTOP; |
rohitrao@chromium.org | 5599a7f | 2012-09-26 03:16:25 +0900 | [diff] [blame] | 105 | #elif defined(OS_IOS) |
| 106 | if (key == base::DIR_USER_DESKTOP) |
| 107 | continue; // iOS doesn't implement DIR_USER_DESKTOP; |
michaelbai@google.com | 4464bef | 2011-08-27 01:43:59 +0900 | [diff] [blame] | 108 | #endif |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 109 | EXPECT_PRED1(ReturnsValidPath, key); |
| 110 | } |
mark@chromium.org | af9f62a | 2009-09-17 06:03:44 +0900 | [diff] [blame] | 111 | #if defined(OS_WIN) |
erikkay@google.com | 1d4507f | 2008-08-07 01:29:44 +0900 | [diff] [blame] | 112 | for (int key = base::PATH_WIN_START + 1; key < base::PATH_WIN_END; ++key) { |
benwells@chromium.org | bd09d67 | 2012-08-30 18:16:55 +0900 | [diff] [blame] | 113 | bool valid = true; |
| 114 | switch(key) { |
| 115 | case base::DIR_LOCAL_APP_DATA_LOW: |
| 116 | // DIR_LOCAL_APP_DATA_LOW is not supported prior Vista and is expected |
| 117 | // to fail. |
| 118 | valid = base::win::GetVersion() >= base::win::VERSION_VISTA; |
| 119 | break; |
| 120 | case base::DIR_APP_SHORTCUTS: |
| 121 | // DIR_APP_SHORTCUTS is not supported prior Windows 8 and is expected to |
| 122 | // fail. |
| 123 | valid = base::win::GetVersion() >= base::win::VERSION_WIN8; |
| 124 | break; |
maruel@google.com | 15cfc7f | 2008-08-08 05:23:09 +0900 | [diff] [blame] | 125 | } |
benwells@chromium.org | bd09d67 | 2012-08-30 18:16:55 +0900 | [diff] [blame] | 126 | |
| 127 | if (valid) |
| 128 | EXPECT_TRUE(ReturnsValidPath(key)) << key; |
| 129 | else |
| 130 | EXPECT_TRUE(ReturnsInvalidPath(key)) << key; |
erikkay@google.com | 1d4507f | 2008-08-07 01:29:44 +0900 | [diff] [blame] | 131 | } |
mark@chromium.org | af9f62a | 2009-09-17 06:03:44 +0900 | [diff] [blame] | 132 | #elif defined(OS_MACOSX) |
| 133 | for (int key = base::PATH_MAC_START + 1; key < base::PATH_MAC_END; ++key) { |
gab@chromium.org | 97fc1e6 | 2012-09-21 01:24:52 +0900 | [diff] [blame] | 134 | EXPECT_PRED1(ReturnsValidPath, key); |
| 135 | } |
| 136 | #elif defined(OS_ANDROID) |
| 137 | for (int key = base::PATH_ANDROID_START + 1; key < base::PATH_ANDROID_END; |
| 138 | ++key) { |
| 139 | EXPECT_PRED1(ReturnsValidPath, key); |
| 140 | } |
| 141 | #elif defined(OS_POSIX) |
| 142 | for (int key = base::PATH_POSIX_START + 1; key < base::PATH_POSIX_END; |
| 143 | ++key) { |
| 144 | EXPECT_PRED1(ReturnsValidPath, key); |
mark@chromium.org | af9f62a | 2009-09-17 06:03:44 +0900 | [diff] [blame] | 145 | } |
erikkay@google.com | 1d4507f | 2008-08-07 01:29:44 +0900 | [diff] [blame] | 146 | #endif |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 147 | } |
pastarmovj@chromium.org | 8f45209 | 2012-05-09 19:50:10 +0900 | [diff] [blame] | 148 | |
| 149 | // test that all versions of the Override function of PathService do what they |
| 150 | // are supposed to do. |
| 151 | TEST_F(PathServiceTest, Override) { |
| 152 | int my_special_key = 666; |
brettw@chromium.org | 091db52 | 2012-11-17 05:34:23 +0900 | [diff] [blame] | 153 | base::ScopedTempDir temp_dir; |
pastarmovj@chromium.org | 8f45209 | 2012-05-09 19:50:10 +0900 | [diff] [blame] | 154 | ASSERT_TRUE(temp_dir.CreateUniqueTempDir()); |
brettw@chromium.org | 82bcf51 | 2013-02-17 14:07:23 +0900 | [diff] [blame] | 155 | base::FilePath fake_cache_dir(temp_dir.path().AppendASCII("cache")); |
pastarmovj@chromium.org | 8f45209 | 2012-05-09 19:50:10 +0900 | [diff] [blame] | 156 | // PathService::Override should always create the path provided if it doesn't |
| 157 | // exist. |
| 158 | EXPECT_TRUE(PathService::Override(my_special_key, fake_cache_dir)); |
brettw@chromium.org | 10b6412 | 2013-07-12 02:36:07 +0900 | [diff] [blame^] | 159 | EXPECT_TRUE(base::PathExists(fake_cache_dir)); |
pastarmovj@chromium.org | 8f45209 | 2012-05-09 19:50:10 +0900 | [diff] [blame] | 160 | |
brettw@chromium.org | 82bcf51 | 2013-02-17 14:07:23 +0900 | [diff] [blame] | 161 | base::FilePath fake_cache_dir2(temp_dir.path().AppendASCII("cache2")); |
pastarmovj@chromium.org | 8f45209 | 2012-05-09 19:50:10 +0900 | [diff] [blame] | 162 | // PathService::OverrideAndCreateIfNeeded should obey the |create| parameter. |
| 163 | PathService::OverrideAndCreateIfNeeded(my_special_key, |
| 164 | fake_cache_dir2, |
| 165 | false); |
brettw@chromium.org | 10b6412 | 2013-07-12 02:36:07 +0900 | [diff] [blame^] | 166 | EXPECT_FALSE(base::PathExists(fake_cache_dir2)); |
pastarmovj@chromium.org | 8f45209 | 2012-05-09 19:50:10 +0900 | [diff] [blame] | 167 | EXPECT_TRUE(PathService::OverrideAndCreateIfNeeded(my_special_key, |
| 168 | fake_cache_dir2, |
| 169 | true)); |
brettw@chromium.org | 10b6412 | 2013-07-12 02:36:07 +0900 | [diff] [blame^] | 170 | EXPECT_TRUE(base::PathExists(fake_cache_dir2)); |
pastarmovj@chromium.org | 8f45209 | 2012-05-09 19:50:10 +0900 | [diff] [blame] | 171 | } |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 172 | |
| 173 | // Check if multiple overrides can co-exist. |
| 174 | TEST_F(PathServiceTest, OverrideMultiple) { |
| 175 | int my_special_key = 666; |
brettw@chromium.org | 091db52 | 2012-11-17 05:34:23 +0900 | [diff] [blame] | 176 | base::ScopedTempDir temp_dir; |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 177 | ASSERT_TRUE(temp_dir.CreateUniqueTempDir()); |
brettw@chromium.org | 82bcf51 | 2013-02-17 14:07:23 +0900 | [diff] [blame] | 178 | base::FilePath fake_cache_dir1(temp_dir.path().AppendASCII("1")); |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 179 | EXPECT_TRUE(PathService::Override(my_special_key, fake_cache_dir1)); |
brettw@chromium.org | 10b6412 | 2013-07-12 02:36:07 +0900 | [diff] [blame^] | 180 | EXPECT_TRUE(base::PathExists(fake_cache_dir1)); |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 181 | ASSERT_EQ(1, file_util::WriteFile(fake_cache_dir1.AppendASCII("t1"), ".", 1)); |
| 182 | |
brettw@chromium.org | 82bcf51 | 2013-02-17 14:07:23 +0900 | [diff] [blame] | 183 | base::FilePath fake_cache_dir2(temp_dir.path().AppendASCII("2")); |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 184 | EXPECT_TRUE(PathService::Override(my_special_key + 1, fake_cache_dir2)); |
brettw@chromium.org | 10b6412 | 2013-07-12 02:36:07 +0900 | [diff] [blame^] | 185 | EXPECT_TRUE(base::PathExists(fake_cache_dir2)); |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 186 | ASSERT_EQ(1, file_util::WriteFile(fake_cache_dir2.AppendASCII("t2"), ".", 1)); |
| 187 | |
brettw@chromium.org | 82bcf51 | 2013-02-17 14:07:23 +0900 | [diff] [blame] | 188 | base::FilePath result; |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 189 | EXPECT_TRUE(PathService::Get(my_special_key, &result)); |
| 190 | // Override might have changed the path representation but our test file |
| 191 | // should be still there. |
brettw@chromium.org | 10b6412 | 2013-07-12 02:36:07 +0900 | [diff] [blame^] | 192 | EXPECT_TRUE(base::PathExists(result.AppendASCII("t1"))); |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 193 | EXPECT_TRUE(PathService::Get(my_special_key + 1, &result)); |
brettw@chromium.org | 10b6412 | 2013-07-12 02:36:07 +0900 | [diff] [blame^] | 194 | EXPECT_TRUE(base::PathExists(result.AppendASCII("t2"))); |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 195 | } |
| 196 | |
| 197 | TEST_F(PathServiceTest, RemoveOverride) { |
| 198 | // Before we start the test we have to call RemoveOverride at least once to |
| 199 | // clear any overrides that might have been left from other tests. |
| 200 | PathService::RemoveOverride(base::DIR_TEMP); |
| 201 | |
brettw@chromium.org | 82bcf51 | 2013-02-17 14:07:23 +0900 | [diff] [blame] | 202 | base::FilePath original_user_data_dir; |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 203 | EXPECT_TRUE(PathService::Get(base::DIR_TEMP, &original_user_data_dir)); |
| 204 | EXPECT_FALSE(PathService::RemoveOverride(base::DIR_TEMP)); |
| 205 | |
brettw@chromium.org | 091db52 | 2012-11-17 05:34:23 +0900 | [diff] [blame] | 206 | base::ScopedTempDir temp_dir; |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 207 | ASSERT_TRUE(temp_dir.CreateUniqueTempDir()); |
| 208 | EXPECT_TRUE(PathService::Override(base::DIR_TEMP, temp_dir.path())); |
brettw@chromium.org | 82bcf51 | 2013-02-17 14:07:23 +0900 | [diff] [blame] | 209 | base::FilePath new_user_data_dir; |
pastarmovj@chromium.org | 5dce41a | 2012-09-27 04:05:12 +0900 | [diff] [blame] | 210 | EXPECT_TRUE(PathService::Get(base::DIR_TEMP, &new_user_data_dir)); |
| 211 | EXPECT_NE(original_user_data_dir, new_user_data_dir); |
| 212 | |
| 213 | EXPECT_TRUE(PathService::RemoveOverride(base::DIR_TEMP)); |
| 214 | EXPECT_TRUE(PathService::Get(base::DIR_TEMP, &new_user_data_dir)); |
| 215 | EXPECT_EQ(original_user_data_dir, new_user_data_dir); |
| 216 | } |