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.
4
5#ifndef BASE_TEST_TEST_FILE_UTIL_H_
6#define BASE_TEST_TEST_FILE_UTIL_H_
7
8// File utility functions used only by tests.
9
10#include <string>
11
12#include "base/compiler_specific.h"
13#include "base/files/file_path.h"
14
15#if defined(OS_ANDROID)
16#include <jni.h>
17#include "base/basictypes.h"
18#endif
19
20namespace base {
21
22class FilePath;
23
24// Clear a specific file from the system cache like EvictFileFromSystemCache,
25// but on failure it will sleep and retry. On the Windows buildbots, eviction
26// can fail if the file is marked in use, and this will throw off timings that
27// rely on uncached files.
28bool EvictFileFromSystemCacheWithRetry(const FilePath& file);
29
30}  // namespace base
31
32// TODO(brettw) move all of this to the base namespace.
33namespace file_util {
34
35// Wrapper over base::Delete. On Windows repeatedly invokes Delete in case
36// of failure to workaround Windows file locking semantics. Returns true on
37// success.
38bool DieFileDie(const base::FilePath& file, bool recurse);
39
40// Clear a specific file from the system cache. After this call, trying
41// to access this file will result in a cold load from the hard drive.
42bool EvictFileFromSystemCache(const base::FilePath& file);
43
44#if defined(OS_WIN)
45// Returns true if the volume supports Alternate Data Streams.
46bool VolumeSupportsADS(const base::FilePath& path);
47
48// Returns true if the ZoneIdentifier is correctly set to "Internet" (3).
49// Note that this function must be called from the same process as
50// the one that set the zone identifier.  I.e. don't use it in UI/automation
51// based tests.
52bool HasInternetZoneIdentifier(const base::FilePath& full_path);
53#endif  // defined(OS_WIN)
54
55// In general it's not reliable to convert a FilePath to a wstring and we use
56// string16 elsewhere for Unicode strings, but in tests it is frequently
57// convenient to be able to compare paths to literals like L"foobar".
58std::wstring FilePathAsWString(const base::FilePath& path);
59base::FilePath WStringAsFilePath(const std::wstring& path);
60
61// For testing, make the file unreadable or unwritable.
62// In POSIX, this does not apply to the root user.
63bool MakeFileUnreadable(const base::FilePath& path) WARN_UNUSED_RESULT;
64bool MakeFileUnwritable(const base::FilePath& path) WARN_UNUSED_RESULT;
65
66#if defined(OS_ANDROID)
67// Register the ContentUriTestUrils JNI bindings.
68bool RegisterContentUriTestUtils(JNIEnv* env);
69
70// Insert an image file into the MediaStore, and retrieve the content URI for
71// testing purpose.
72base::FilePath InsertImageIntoMediaStore(const base::FilePath& path);
73#endif  // defined(OS_ANDROID)
74
75// Saves the current permissions for a path, and restores it on destruction.
76class PermissionRestorer {
77 public:
78  explicit PermissionRestorer(const base::FilePath& path);
79  ~PermissionRestorer();
80
81 private:
82  const base::FilePath path_;
83  void* info_;  // The opaque stored permission information.
84  size_t length_;  // The length of the stored permission information.
85
86  DISALLOW_COPY_AND_ASSIGN(PermissionRestorer);
87};
88
89}  // namespace file_util
90
91#endif  // BASE_TEST_TEST_FILE_UTIL_H_
92