1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/ash/file_manager/restore_io_task.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/i18n/time_formatting.h"
#include "base/rand_util.h"
#include "base/run_loop.h"
#include "base/strings/strcat.h"
#include "base/test/gmock_callback_support.h"
#include "base/test/mock_callback.h"
#include "chrome/browser/ash/file_manager/path_util.h"
#include "chrome/browser/ash/file_manager/trash_unittest_base.h"
#include "chrome/test/base/testing_profile.h"
#include "content/public/test/browser_task_environment.h"
#include "mojo/public/cpp/bindings/self_owned_receiver.h"
#include "storage/browser/file_system/file_system_context.h"
#include "storage/browser/file_system/file_system_url.h"
#include "storage/browser/test/test_file_system_context.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/public/common/storage_key/storage_key.h"
namespace file_manager::io_task {
namespace {
using ::base::test::RunClosure;
using ::testing::_;
using ::testing::Field;
class ScopedFileForTest {
public:
ScopedFileForTest(const base::FilePath& absolute_file_path,
const std::string& file_contents)
: absolute_file_path_(absolute_file_path) {
EXPECT_TRUE(base::WriteFile(absolute_file_path_, file_contents));
}
~ScopedFileForTest() { EXPECT_TRUE(base::DeleteFile(absolute_file_path_)); }
const base::FilePath GetPath() { return absolute_file_path_; }
private:
const base::FilePath absolute_file_path_;
};
class RestoreIOTaskTest : public TrashBaseIOTest {
public:
RestoreIOTaskTest() = default;
RestoreIOTaskTest(const RestoreIOTaskTest&) = delete;
RestoreIOTaskTest& operator=(const RestoreIOTaskTest&) = delete;
std::string GenerateTrashInfoContents(const std::string& restore_path) {
return base::StrCat({"[Trash Info]\nPath=", restore_path, "\nDeletionDate=",
base::TimeFormatAsIso8601(base::Time::UnixEpoch())});
}
void ExpectRestorePathFailure(const std::string& restore_path_in_trashinfo) {
std::string foo_contents = base::RandBytesAsString(kTestFileSize);
std::string foo_metadata_contents =
GenerateTrashInfoContents(restore_path_in_trashinfo);
const base::FilePath trash_path =
downloads_dir_.Append(trash::kTrashFolderName);
ScopedFileForTest trash_info_file(
trash_path.Append(trash::kInfoFolderName).Append("foo.txt.trashinfo"),
foo_metadata_contents);
ScopedFileForTest trash_files_file(
trash_path.Append(trash::kFilesFolderName).Append("foo.txt"),
foo_contents);
base::RunLoop run_loop;
std::vector<storage::FileSystemURL> source_urls = {
CreateFileSystemURL(trash_info_file.GetPath()),
};
base::MockRepeatingCallback<void(const ProgressStatus&)> progress_callback;
base::MockOnceCallback<void(ProgressStatus)> complete_callback;
EXPECT_CALL(progress_callback, Run(_)).Times(0);
EXPECT_CALL(complete_callback,
Run(Field(&ProgressStatus::state, State::kError)))
.WillOnce(RunClosure(run_loop.QuitClosure()));
RestoreIOTask task(source_urls, profile_.get(), file_system_context_,
temp_dir_.GetPath());
task.Execute(progress_callback.Get(), complete_callback.Get());
run_loop.Run();
}
private:
content::BrowserTaskEnvironment task_environment_;
};
TEST_F(RestoreIOTaskTest, NoSourceUrlsShouldReturnSuccess) {
base::RunLoop run_loop;
std::vector<storage::FileSystemURL> source_urls;
base::MockRepeatingCallback<void(const ProgressStatus&)> progress_callback;
base::MockOnceCallback<void(ProgressStatus)> complete_callback;
// We should get one complete callback when the size check of `source_urls`
// finds none.
EXPECT_CALL(complete_callback,
Run(Field(&ProgressStatus::state, State::kSuccess)))
.WillOnce(RunClosure(run_loop.QuitClosure()));
RestoreIOTask task(source_urls, profile_.get(), file_system_context_,
temp_dir_.GetPath());
task.Execute(progress_callback.Get(), complete_callback.Get());
run_loop.Run();
}
TEST_F(RestoreIOTaskTest, URLsWithInvalidSuffixShouldError) {
std::string foo_contents = base::RandBytesAsString(kTestFileSize);
const base::FilePath file_path = temp_dir_.GetPath().Append("foo.txt");
ASSERT_TRUE(base::WriteFile(file_path, foo_contents));
base::RunLoop run_loop;
std::vector<storage::FileSystemURL> source_urls = {
CreateFileSystemURL(file_path),
};
base::MockRepeatingCallback<void(const ProgressStatus&)> progress_callback;
base::MockOnceCallback<void(ProgressStatus)> complete_callback;
// Progress callback should not be called as the suffix doesn't end in
// .trashinfo.
EXPECT_CALL(progress_callback, Run(_)).Times(0);
// We should get one complete callback when the verification of the suffix
// fails.
EXPECT_CALL(complete_callback,
Run(Field(&ProgressStatus::state, State::kError)))
.WillOnce(RunClosure(run_loop.QuitClosure()));
RestoreIOTask task(source_urls, profile_.get(), file_system_context_,
temp_dir_.GetPath());
task.Execute(progress_callback.Get(), complete_callback.Get());
run_loop.Run();
}
TEST_F(RestoreIOTaskTest, FilesNotInProperLocationShouldError) {
std::string foo_contents = base::RandBytesAsString(kTestFileSize);
const base::FilePath file_path =
temp_dir_.GetPath().Append("foo.txt.trashinfo");
ASSERT_TRUE(base::WriteFile(file_path, foo_contents));
base::RunLoop run_loop;
std::vector<storage::FileSystemURL> source_urls = {
CreateFileSystemURL(file_path),
};
base::MockRepeatingCallback<void(const ProgressStatus&)> progress_callback;
base::MockOnceCallback<void(ProgressStatus)> complete_callback;
// Progress callback should not be called as the supplied file is not within
// the .Trash/info directory.
EXPECT_CALL(progress_callback, Run(_)).Times(0);
// We should get one complete callback when the location is invalid.
EXPECT_CALL(complete_callback,
Run(Field(&ProgressStatus::state, State::kError)))
.WillOnce(RunClosure(run_loop.QuitClosure()));
RestoreIOTask task(source_urls, profile_.get(), file_system_context_,
temp_dir_.GetPath());
task.Execute(progress_callback.Get(), complete_callback.Get());
run_loop.Run();
}
TEST_F(RestoreIOTaskTest, MetadataWithNoCorrespondingFileShouldError) {
EnsureTrashDirectorySetup(downloads_dir_);
std::string foo_contents = base::RandBytesAsString(kTestFileSize);
const base::FilePath file_path =
downloads_dir_.Append(trash::kTrashFolderName)
.Append(trash::kInfoFolderName)
.Append("foo.txt.trashinfo");
ASSERT_TRUE(base::WriteFile(file_path, foo_contents));
base::RunLoop run_loop;
std::vector<storage::FileSystemURL> source_urls = {
CreateFileSystemURL(file_path),
};
base::MockRepeatingCallback<void(const ProgressStatus&)> progress_callback;
base::MockOnceCallback<void(ProgressStatus)> complete_callback;
// Progress callback should not be called as the corresponding file in the
// .Trash/files location does not exist.
EXPECT_CALL(progress_callback, Run(_)).Times(0);
// We should get one complete callback when the .Trash/files path doesn't
// exist.
EXPECT_CALL(complete_callback,
Run(Field(&ProgressStatus::state, State::kError)))
.WillOnce(RunClosure(run_loop.QuitClosure()));
RestoreIOTask task(source_urls, profile_.get(), file_system_context_,
temp_dir_.GetPath());
task.Execute(progress_callback.Get(), complete_callback.Get());
run_loop.Run();
}
TEST_F(RestoreIOTaskTest, InvalidRestorePaths) {
EnsureTrashDirectorySetup(downloads_dir_);
ExpectRestorePathFailure("/../../../bad/actor/foo.txt");
ExpectRestorePathFailure("../../../bad/actor/foo.txt");
ExpectRestorePathFailure("/");
}
TEST_F(RestoreIOTaskTest, ValidRestorePathShouldSucceedAndCreateDirectory) {
EnsureTrashDirectorySetup(downloads_dir_);
std::string foo_contents = base::RandBytesAsString(kTestFileSize);
std::string foo_metadata_contents =
GenerateTrashInfoContents("/Downloads/bar/foo.txt");
const base::FilePath trash_path =
downloads_dir_.Append(trash::kTrashFolderName);
const base::FilePath info_file_path =
trash_path.Append(trash::kInfoFolderName).Append("foo.txt.trashinfo");
ASSERT_TRUE(base::WriteFile(info_file_path, foo_metadata_contents));
const base::FilePath files_path =
trash_path.Append(trash::kFilesFolderName).Append("foo.txt");
ASSERT_TRUE(base::WriteFile(files_path, foo_contents));
base::RunLoop run_loop;
std::vector<storage::FileSystemURL> source_urls = {
CreateFileSystemURL(info_file_path),
};
base::MockRepeatingCallback<void(const ProgressStatus&)> progress_callback;
base::MockOnceCallback<void(ProgressStatus)> complete_callback;
EXPECT_CALL(progress_callback, Run(_)).Times(0);
EXPECT_CALL(complete_callback,
Run(Field(&ProgressStatus::state, State::kSuccess)))
.WillOnce(RunClosure(run_loop.QuitClosure()));
RestoreIOTask task(source_urls, profile_.get(), file_system_context_,
temp_dir_.GetPath());
task.Execute(progress_callback.Get(), complete_callback.Get());
run_loop.Run();
EXPECT_TRUE(base::PathExists(downloads_dir_.Append("bar").Append("foo.txt")));
}
TEST_F(RestoreIOTaskTest, ItemWithExistingConflictAreRenamed) {
EnsureTrashDirectorySetup(downloads_dir_);
std::string foo_contents = base::RandBytesAsString(kTestFileSize);
std::string foo_metadata_contents =
GenerateTrashInfoContents("/Downloads/bar/foo.txt");
const base::FilePath trash_path =
downloads_dir_.Append(trash::kTrashFolderName);
const base::FilePath info_file_path =
trash_path.Append(trash::kInfoFolderName).Append("foo.txt.trashinfo");
ASSERT_TRUE(base::WriteFile(info_file_path, foo_metadata_contents));
const base::FilePath files_path =
trash_path.Append(trash::kFilesFolderName).Append("foo.txt");
ASSERT_TRUE(base::WriteFile(files_path, foo_contents));
// Create conflicting item at same place restore is going to happen at.
const base::FilePath bar_dir = downloads_dir_.Append("bar");
ASSERT_TRUE(base::CreateDirectory(bar_dir));
ASSERT_TRUE(base::WriteFile(bar_dir.Append("foo.txt"), foo_contents));
base::RunLoop run_loop;
std::vector<storage::FileSystemURL> source_urls = {
CreateFileSystemURL(info_file_path),
};
base::MockRepeatingCallback<void(const ProgressStatus&)> progress_callback;
base::MockOnceCallback<void(ProgressStatus)> complete_callback;
EXPECT_CALL(progress_callback, Run(_)).Times(0);
EXPECT_CALL(complete_callback,
Run(Field(&ProgressStatus::state, State::kSuccess)))
.WillOnce(RunClosure(run_loop.QuitClosure()));
RestoreIOTask task(source_urls, profile_.get(), file_system_context_,
temp_dir_.GetPath());
task.Execute(progress_callback.Get(), complete_callback.Get());
run_loop.Run();
EXPECT_TRUE(base::PathExists(bar_dir.Append("foo.txt")));
EXPECT_TRUE(base::PathExists(bar_dir.Append("foo (1).txt")));
EXPECT_FALSE(base::PathExists(info_file_path));
}
class TrashServiceMojoDisconnector
: public ash::trash_service::mojom::TrashService {
public:
explicit TrashServiceMojoDisconnector(
mojo::PendingReceiver<ash::trash_service::mojom::TrashService> receiver) {
receivers_.Add(this, std::move(receiver));
}
~TrashServiceMojoDisconnector() override = default;
TrashServiceMojoDisconnector(const TrashServiceMojoDisconnector&) = delete;
TrashServiceMojoDisconnector& operator=(const TrashServiceMojoDisconnector&) =
delete;
// When the method is called, clear all mojo receivers. This is effectively
// disconnecting the mojo pipe and emulates the disconnect handler being
// invoked.
void ParseTrashInfoFile(
base::File trash_info_file,
ash::trash_service::ParseTrashInfoCallback callback) override {
receivers_.Clear();
}
private:
mojo::ReceiverSet<ash::trash_service::mojom::TrashService> receivers_;
};
class RestoreIOTaskDisconnectMojoTest : public TrashBaseIOTest {
public:
RestoreIOTaskDisconnectMojoTest() = default;
RestoreIOTaskDisconnectMojoTest(const RestoreIOTaskDisconnectMojoTest&) =
delete;
RestoreIOTaskDisconnectMojoTest& operator=(
const RestoreIOTaskDisconnectMojoTest&) = delete;
private:
content::BrowserTaskEnvironment task_environment_;
};
TEST_F(RestoreIOTaskDisconnectMojoTest,
TrashServiceMojoDisconnectShouldCompleteWithError) {
EnsureTrashDirectorySetup(downloads_dir_);
std::string foo_contents = base::RandBytesAsString(kTestFileSize);
const base::FilePath trash_path =
downloads_dir_.Append(trash::kTrashFolderName);
const base::FilePath info_file_path =
trash_path.Append(trash::kInfoFolderName).Append("foo.txt.trashinfo");
ASSERT_TRUE(base::WriteFile(info_file_path, foo_contents));
const base::FilePath files_path =
trash_path.Append(trash::kFilesFolderName).Append("foo.txt");
ASSERT_TRUE(base::WriteFile(files_path, foo_contents));
base::RunLoop run_loop;
std::vector<storage::FileSystemURL> source_urls = {
CreateFileSystemURL(info_file_path),
};
base::MockRepeatingCallback<void(const ProgressStatus&)> progress_callback;
base::MockOnceCallback<void(ProgressStatus)> complete_callback;
EXPECT_CALL(progress_callback, Run(_)).Times(0);
EXPECT_CALL(complete_callback,
Run(Field(&ProgressStatus::state, State::kError)))
.WillOnce(RunClosure(run_loop.QuitClosure()));
RestoreIOTask task(source_urls, profile_.get(), file_system_context_,
temp_dir_.GetPath());
task.Execute(progress_callback.Get(), complete_callback.Get());
run_loop.Run();
}
} // namespace
} // namespace file_manager::io_task
|