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.
5 #include "base/path_service.h"
7 #include "base/basictypes.h"
8 #include "base/files/file_path.h"
9 #include "base/files/file_util.h"
10 #include "base/files/scoped_temp_dir.h"
11 #include "base/strings/string_util.h"
12 #include "build/build_config.h"
13 #include "testing/gtest/include/gtest/gtest-spi.h"
14 #include "testing/gtest/include/gtest/gtest.h"
15 #include "testing/platform_test.h"
18 #include "base/win/windows_version.h"
23 // Returns true if PathService::Get returns true and sets the path parameter
24 // to non-empty for the given PathService::DirType enumeration value.
25 bool ReturnsValidPath(int dir_type) {
27 bool result = PathService::Get(dir_type, &path);
29 // Some paths might not exist on some platforms in which case confirming
30 // |result| is true and !path.empty() is the best we can do.
31 bool check_path_exists = true;
33 // If chromium has never been started on this account, the cache path may not
35 if (dir_type == base::DIR_CACHE)
36 check_path_exists = false;
39 // On the linux try-bots: a path is returned (e.g. /home/chrome-bot/Desktop),
40 // but it doesn't exist.
41 if (dir_type == base::DIR_USER_DESKTOP)
42 check_path_exists = false;
45 if (dir_type == base::DIR_TASKBAR_PINS) {
46 // There is no pinned-to-taskbar shortcuts prior to Win7.
47 if (base::win::GetVersion() < base::win::VERSION_WIN7)
48 check_path_exists = false;
51 #if defined(OS_MACOSX)
52 if (dir_type != base::DIR_EXE && dir_type != base::DIR_MODULE &&
53 dir_type != base::FILE_EXE && dir_type != base::FILE_MODULE) {
54 if (path.ReferencesParent())
58 if (path.ReferencesParent())
61 return result && !path.empty() && (!check_path_exists ||
62 base::PathExists(path));
66 // Function to test any directory keys that are not supported on some versions
67 // of Windows. Checks that the function fails and that the returned path is
69 bool ReturnsInvalidPath(int dir_type) {
71 bool result = PathService::Get(dir_type, &path);
72 return !result && path.empty();
78 // On the Mac this winds up using some autoreleased objects, so we need to
80 typedef PlatformTest PathServiceTest;
82 // Test that all PathService::Get calls return a value and a true result
83 // in the development environment. (This test was created because a few
84 // later changes to Get broke the semantics of the function and yielded the
85 // correct value while returning false.)
86 TEST_F(PathServiceTest, Get) {
87 for (int key = base::PATH_START + 1; key < base::PATH_END; ++key) {
88 #if defined(OS_ANDROID)
89 if (key == base::FILE_MODULE || key == base::DIR_USER_DESKTOP ||
90 key == base::DIR_HOME)
91 continue; // Android doesn't implement these.
93 if (key == base::DIR_USER_DESKTOP)
94 continue; // iOS doesn't implement DIR_USER_DESKTOP;
96 EXPECT_PRED1(ReturnsValidPath, key);
99 for (int key = base::PATH_WIN_START + 1; key < base::PATH_WIN_END; ++key) {
102 case base::DIR_LOCAL_APP_DATA_LOW:
103 // DIR_LOCAL_APP_DATA_LOW is not supported prior Vista and is expected
105 valid = base::win::GetVersion() >= base::win::VERSION_VISTA;
107 case base::DIR_APP_SHORTCUTS:
108 // DIR_APP_SHORTCUTS is not supported prior Windows 8 and is expected to
110 valid = base::win::GetVersion() >= base::win::VERSION_WIN8;
115 EXPECT_TRUE(ReturnsValidPath(key)) << key;
117 EXPECT_TRUE(ReturnsInvalidPath(key)) << key;
119 #elif defined(OS_MACOSX)
120 for (int key = base::PATH_MAC_START + 1; key < base::PATH_MAC_END; ++key) {
121 EXPECT_PRED1(ReturnsValidPath, key);
123 #elif defined(OS_ANDROID)
124 for (int key = base::PATH_ANDROID_START + 1; key < base::PATH_ANDROID_END;
126 EXPECT_PRED1(ReturnsValidPath, key);
128 #elif defined(OS_POSIX)
129 for (int key = base::PATH_POSIX_START + 1; key < base::PATH_POSIX_END;
131 EXPECT_PRED1(ReturnsValidPath, key);
136 // Test that all versions of the Override function of PathService do what they
137 // are supposed to do.
138 TEST_F(PathServiceTest, Override) {
139 int my_special_key = 666;
140 base::ScopedTempDir temp_dir;
141 ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
142 base::FilePath fake_cache_dir(temp_dir.path().AppendASCII("cache"));
143 // PathService::Override should always create the path provided if it doesn't
145 EXPECT_TRUE(PathService::Override(my_special_key, fake_cache_dir));
146 EXPECT_TRUE(base::PathExists(fake_cache_dir));
148 base::FilePath fake_cache_dir2(temp_dir.path().AppendASCII("cache2"));
149 // PathService::OverrideAndCreateIfNeeded should obey the |create| parameter.
150 PathService::OverrideAndCreateIfNeeded(my_special_key,
154 EXPECT_FALSE(base::PathExists(fake_cache_dir2));
155 EXPECT_TRUE(PathService::OverrideAndCreateIfNeeded(my_special_key,
159 EXPECT_TRUE(base::PathExists(fake_cache_dir2));
161 #if defined(OS_POSIX)
162 base::FilePath non_existent(
163 base::MakeAbsoluteFilePath(temp_dir.path()).AppendASCII("non_existent"));
164 EXPECT_TRUE(non_existent.IsAbsolute());
165 EXPECT_FALSE(base::PathExists(non_existent));
166 #if !defined(OS_ANDROID)
167 // This fails because MakeAbsoluteFilePath fails for non-existent files.
168 // Earlier versions of Bionic libc don't fail for non-existent files, so
169 // skip this check on Android.
170 EXPECT_FALSE(PathService::OverrideAndCreateIfNeeded(my_special_key,
175 // This works because indicating that |non_existent| is absolute skips the
176 // internal MakeAbsoluteFilePath call.
177 EXPECT_TRUE(PathService::OverrideAndCreateIfNeeded(my_special_key,
181 // Check that the path has been overridden and no directory was created.
182 EXPECT_FALSE(base::PathExists(non_existent));
184 EXPECT_TRUE(PathService::Get(my_special_key, &path));
185 EXPECT_EQ(non_existent, path);
189 // Check if multiple overrides can co-exist.
190 TEST_F(PathServiceTest, OverrideMultiple) {
191 int my_special_key = 666;
192 base::ScopedTempDir temp_dir;
193 ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
194 base::FilePath fake_cache_dir1(temp_dir.path().AppendASCII("1"));
195 EXPECT_TRUE(PathService::Override(my_special_key, fake_cache_dir1));
196 EXPECT_TRUE(base::PathExists(fake_cache_dir1));
197 ASSERT_EQ(1, base::WriteFile(fake_cache_dir1.AppendASCII("t1"), ".", 1));
199 base::FilePath fake_cache_dir2(temp_dir.path().AppendASCII("2"));
200 EXPECT_TRUE(PathService::Override(my_special_key + 1, fake_cache_dir2));
201 EXPECT_TRUE(base::PathExists(fake_cache_dir2));
202 ASSERT_EQ(1, base::WriteFile(fake_cache_dir2.AppendASCII("t2"), ".", 1));
204 base::FilePath result;
205 EXPECT_TRUE(PathService::Get(my_special_key, &result));
206 // Override might have changed the path representation but our test file
207 // should be still there.
208 EXPECT_TRUE(base::PathExists(result.AppendASCII("t1")));
209 EXPECT_TRUE(PathService::Get(my_special_key + 1, &result));
210 EXPECT_TRUE(base::PathExists(result.AppendASCII("t2")));
213 TEST_F(PathServiceTest, RemoveOverride) {
214 // Before we start the test we have to call RemoveOverride at least once to
215 // clear any overrides that might have been left from other tests.
216 PathService::RemoveOverride(base::DIR_TEMP);
218 base::FilePath original_user_data_dir;
219 EXPECT_TRUE(PathService::Get(base::DIR_TEMP, &original_user_data_dir));
220 EXPECT_FALSE(PathService::RemoveOverride(base::DIR_TEMP));
222 base::ScopedTempDir temp_dir;
223 ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
224 EXPECT_TRUE(PathService::Override(base::DIR_TEMP, temp_dir.path()));
225 base::FilePath new_user_data_dir;
226 EXPECT_TRUE(PathService::Get(base::DIR_TEMP, &new_user_data_dir));
227 EXPECT_NE(original_user_data_dir, new_user_data_dir);
229 EXPECT_TRUE(PathService::RemoveOverride(base::DIR_TEMP));
230 EXPECT_TRUE(PathService::Get(base::DIR_TEMP, &new_user_data_dir));
231 EXPECT_EQ(original_user_data_dir, new_user_data_dir);