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 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "net/http/no_vary_search_cache_storage_file_operations.h"
#include <stddef.h>
#include <stdint.h>
#include <array>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
// Needed for the #if below it.
#include "build/build_config.h"
#if BUILDFLAG(IS_WIN)
#include <windows.h> // For SetFileAttributes
#endif // BUILDFLAG(IS_WIN)
#include "base/containers/to_vector.h"
#include "base/files/file.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/notreached.h"
#include "base/rand_util.h"
#include "base/strings/strcat.h"
#include "base/test/gmock_expected_support.h"
#include "base/test/insecure_random_generator.h"
#include "base/threading/simple_thread.h"
#include "base/time/time.h"
#include "base/types/optional_util.h"
#include "net/http/no_vary_search_cache_storage.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace net {
namespace {
using FileOperations = NoVarySearchCacheStorageFileOperations;
using enum base::File::Error;
using ::base::test::ErrorIs;
using ::base::test::HasValue;
using ::base::test::ValueIs;
using ::testing::Values;
constexpr size_t kBigSize = 100 * 1024 * 1024;
// Returns some non-empty contents for a file that can be passed to AtomicSave()
// when the test doesn't care what the contents are.
std::array<base::span<const uint8_t>, 1> DummyContents() {
static const std::vector<uint8_t> contents(1024u);
return std::to_array({base::span<const uint8_t>(contents)});
}
// Returns some data that is unlikely to be matched by chance.
std::vector<uint8_t> InterestingData() {
static const std::vector<uint8_t> data = [] {
static constexpr size_t kBigDataSize = 111;
std::vector<uint64_t> big_data;
big_data.reserve(kBigDataSize);
base::test::InsecureRandomGenerator gen;
gen.ReseedForTesting(0xfedcba9876543210);
for (size_t i = 0; i < kBigDataSize; ++i) {
big_data.push_back(gen.RandUint64());
}
return base::ToVector(base::as_byte_span(big_data));
}();
return data;
}
constexpr bool CanMakeFileUnwritable() {
return BUILDFLAG(IS_WIN) || BUILDFLAG(IS_POSIX);
}
void MakeFileUnwritable(const base::FilePath& path) {
#if BUILDFLAG(IS_POSIX)
ASSERT_TRUE(
base::SetPosixFilePermissions(path, base::FILE_PERMISSION_READ_BY_USER));
#elif BUILDFLAG(IS_WIN)
// It's not safe to assume the current attributes.
DWORD attrs = ::GetFileAttributes(path.value().c_str());
ASSERT_NE(INVALID_FILE_ATTRIBUTES, attrs);
ASSERT_TRUE(::SetFileAttributes(path.value().c_str(),
attrs | FILE_ATTRIBUTE_READONLY));
#else
NOTREACHED();
#endif // BUILDFLAG(IS_POSIX)
}
class FileOperationsTestBase : public ::testing::Test {
public:
void SetUp() override {
ASSERT_TRUE(dir_.CreateUniqueTempDir());
operations_ = FileOperations::Create(dir_.GetPath());
}
protected:
FileOperations* operations() { return operations_.get(); }
base::FilePath GetBasePath() const { return dir_.GetPath(); }
base::FilePath GetNVSPath() const {
return GetBasePath().AppendASCII(
NoVarySearchCacheStorageFileOperations::kNoVarySearchDirName);
}
private:
base::ScopedTempDir dir_;
std::unique_ptr<FileOperations> operations_;
};
class FileOperationsInitTest : public FileOperationsTestBase {
protected:
};
// The case where the dir already exists is implicitly tested by all the other
// tests, so there's no explicit test for it.
TEST_F(FileOperationsInitTest, InitCreatesDirIfMissing) {
// For this test we need a directory that doesn't already exist, so
// create a new FileOperations object for a sub-directory.
static constexpr std::string_view kSubDir = "subdir";
auto subdir_path = GetBasePath().AppendASCII(kSubDir);
auto operations = FileOperations::Create(GetBasePath().AppendASCII(kSubDir));
EXPECT_FALSE(base::PathExists(subdir_path));
EXPECT_TRUE(operations->Init());
EXPECT_TRUE(base::DirectoryExists(subdir_path));
}
TEST_F(FileOperationsInitTest, InitFailsIfDirIsFile) {
// For this test we need a directory that doesn't already exist, so
// create a new FileOperations object for a sub-directory.
static constexpr std::string_view kSubDir = "subdir";
auto subdir_path = GetBasePath().AppendASCII(kSubDir);
ASSERT_TRUE(base::WriteFile(subdir_path, ""));
auto operations = FileOperations::Create(GetBasePath().AppendASCII(kSubDir));
EXPECT_FALSE(operations->Init());
EXPECT_FALSE(base::DirectoryExists(subdir_path));
}
TEST_F(FileOperationsInitTest, InitCreateNoVarySearchDir) {
auto nvs_path = GetNVSPath();
EXPECT_FALSE(base::PathExists(nvs_path));
EXPECT_TRUE(operations()->Init());
EXPECT_TRUE(base::DirectoryExists(nvs_path));
}
TEST_F(FileOperationsInitTest, InitFailsIfNoVarySearchDirIsFile) {
auto nvs_path = GetNVSPath();
ASSERT_TRUE(base::WriteFile(nvs_path, ""));
EXPECT_FALSE(operations()->Init());
EXPECT_TRUE(base::PathExists(nvs_path));
EXPECT_FALSE(base::DirectoryExists(nvs_path));
}
class FileOperationsInitWithNVSDirTest : public FileOperationsInitTest {
public:
static constexpr std::string_view kSnapshot =
NoVarySearchCacheStorage::kSnapshotFilename;
static constexpr std::string_view kJournal =
NoVarySearchCacheStorage::kJournalFilename;
static constexpr std::string_view kExpected = "expected";
static constexpr std::string_view kUnexpected = "unexpected";
void SetUp() override {
FileOperationsInitTest::SetUp();
ASSERT_TRUE(base::CreateDirectory(GetNVSPath()));
}
bool Init() { return operations()->Init(); }
void ExpectContents(const base::FilePath& path) {
std::string contents;
ASSERT_TRUE(base::ReadFileToString(path, &contents));
EXPECT_EQ(contents, kExpected);
}
base::FilePath GetOldPath(std::string_view filename) const {
return GetBasePath().AppendASCII(filename);
}
base::FilePath GetNewPath(std::string_view filename) const {
return GetNVSPath().AppendASCII(filename);
}
// Makes a directory at `path` that won't be deleted by base::DeleteFile().
// This is done by putting a subdirectory inside it.
void MakeUndeletable(const base::FilePath& path) {
ASSERT_TRUE(base::CreateDirectory(path));
ASSERT_TRUE(base::CreateDirectory(path.AppendASCII("subdirectory")));
}
};
TEST_F(FileOperationsInitWithNVSDirTest,
InitSucceedsWhenNoVarySearchDirExists) {
EXPECT_TRUE(Init());
}
enum class Dirs {
kOld,
kNew,
};
class FileOperationsTempDeleteTest
: public FileOperationsInitWithNVSDirTest,
public ::testing::WithParamInterface<Dirs> {
protected:
base::FilePath GetTempFilePath() const {
const std::string filename = base::StrCat({kSnapshot, "-new"});
return GetParam() == Dirs::kOld ? GetOldPath(filename)
: GetNewPath(filename);
}
};
INSTANTIATE_TEST_SUITE_P(FileOperations,
FileOperationsTempDeleteTest,
Values(Dirs::kOld, Dirs::kNew),
[](const testing::TestParamInfo<Dirs>& info) {
return info.param == Dirs::kOld ? "Old" : "New";
});
TEST_P(FileOperationsTempDeleteTest, TempSnapshotDeleted) {
const auto path = GetTempFilePath();
ASSERT_TRUE(base::WriteFile(path, kUnexpected));
EXPECT_TRUE(Init());
EXPECT_FALSE(base::PathExists(path));
}
TEST_P(FileOperationsTempDeleteTest, TempSnapshotUndeletable) {
const auto path = GetTempFilePath();
MakeUndeletable(path);
// This failure is considered harmless, so Init() returns true.
EXPECT_TRUE(Init());
// If we can't delete it it isn't deleted, but nothing bad happens.
EXPECT_TRUE(base::PathExists(path));
}
enum class Files {
kSnapshot,
kJournal,
};
// TODO(https://crbug.com/421927600): Remove this text fixture and tests in
// December 2025 when removing MoveOldFilesIfNeeded() from the implementation.
class FileOperationsMovingTest : public FileOperationsInitWithNVSDirTest,
public ::testing::WithParamInterface<Files> {
protected:
std::string_view GetFilename() const {
return GetParam() == Files::kSnapshot ? kSnapshot : kJournal;
}
};
INSTANTIATE_TEST_SUITE_P(FileOperations,
FileOperationsMovingTest,
Values(Files::kSnapshot, Files::kJournal),
[](const testing::TestParamInfo<Files>& info) {
return info.param == Files::kSnapshot ? "Snapshot"
: "Journal";
});
TEST_P(FileOperationsMovingTest, MovedIfOldPathExists) {
const auto filename = GetFilename();
const auto old_path = GetOldPath(filename);
ASSERT_TRUE(base::WriteFile(old_path, kExpected));
EXPECT_TRUE(Init());
EXPECT_FALSE(base::PathExists(old_path));
ExpectContents(GetNewPath(filename));
}
TEST_P(FileOperationsMovingTest, DeletedIfTargetExists) {
const auto filename = GetFilename();
const auto new_path = GetNewPath(filename);
ASSERT_TRUE(base::WriteFile(new_path, kExpected));
const auto old_path = GetOldPath(filename);
ASSERT_TRUE(base::WriteFile(old_path, kUnexpected));
EXPECT_TRUE(Init());
ExpectContents(new_path);
EXPECT_FALSE(base::PathExists(old_path));
}
TEST_P(FileOperationsMovingTest, NoErrorIfUndeletable) {
const auto filename = GetFilename();
const auto new_path = GetNewPath(filename);
ASSERT_TRUE(base::WriteFile(new_path, kExpected));
const auto old_path = GetOldPath(filename);
MakeUndeletable(old_path);
// This failure is considered harmless, so Init() returns true.
EXPECT_TRUE(Init());
ExpectContents(new_path);
// It still exists, but nothing bad happens.
EXPECT_TRUE(base::PathExists(old_path));
}
// We need a way to make a path that can't be moved by base::ReplaceFile().
// There doesn't seem to be a common way to do this on POSIX and Windows, so use
// separate implementations.
class [[nodiscard]] ScopedUnmovablePathBase {
public:
ScopedUnmovablePathBase(const ScopedUnmovablePathBase&) = delete;
ScopedUnmovablePathBase& operator=(const ScopedUnmovablePathBase&) = delete;
protected:
explicit ScopedUnmovablePathBase(const base::FilePath& path) : path_(path) {}
~ScopedUnmovablePathBase() { EXPECT_TRUE(base::DeleteFile(path_)); }
const base::FilePath& path() { return path_; }
private:
const base::FilePath path_;
};
#if BUILDFLAG(IS_POSIX)
class [[nodiscard]] ScopedUnmovablePath : public ScopedUnmovablePathBase {
public:
static constexpr bool kSupported = true;
explicit ScopedUnmovablePath(const base::FilePath& path)
: ScopedUnmovablePathBase(path) {
EXPECT_TRUE(base::CreateDirectory(path));
// An unwritable directory is not movable in POSIX.
MakeFileUnwritable(path);
}
~ScopedUnmovablePath() {
using enum base::FilePermissionBits;
EXPECT_TRUE(base::SetPosixFilePermissions(
path(), FILE_PERMISSION_READ_BY_USER | FILE_PERMISSION_WRITE_BY_USER |
FILE_PERMISSION_EXECUTE_BY_USER));
}
};
#elif BUILDFLAG(IS_WIN)
class [[nodiscard]] ScopedUnmovablePath : public ScopedUnmovablePathBase {
public:
using enum base::File::Flags;
static constexpr bool kSupported = true;
// An open file is not movable on Windows.
explicit ScopedUnmovablePath(const base::FilePath& path)
: ScopedUnmovablePathBase(path),
handle_(path,
FLAG_CREATE_ALWAYS | FLAG_WRITE | FLAG_WIN_EXCLUSIVE_WRITE) {}
// This closes the handle, enabling the file to be deleted by the base class
// destructor.
~ScopedUnmovablePath() = default;
private:
base::File handle_;
};
#else // !BUILDFLAG(IS_POSIX) && !BUILDFLAG(IS_WIN)
// Currently this isn't supported on Fuchsia.
class [[nodiscard]] ScopedUnmovablePath : public ScopedUnmovablePathBase {
public:
static constexpr bool kSupported = false;
explicit ScopedUnmovablePath(const base::FilePath& path)
: ScopedUnmovablePathBase(path) {
NOTREACHED();
}
~ScopedUnmovablePath() = default;
};
#endif // BUILDFLAG(IS_POSIX)
TEST_P(FileOperationsMovingTest, NoErrorOnUnmovableFile) {
if constexpr (!ScopedUnmovablePath::kSupported) {
GTEST_SKIP() << "Don't know how to make a path unmovable on this platform";
}
const auto filename = GetFilename();
const auto old_path = GetOldPath(filename);
ScopedUnmovablePath make_unmovable(old_path);
// This failure is considered harmless, so Init() returns true.
EXPECT_TRUE(Init());
EXPECT_FALSE(base::PathExists(GetNewPath(filename)));
// It still exists, but nothing bad happens.
EXPECT_TRUE(base::PathExists(old_path));
}
class FileOperationsPostInitTest : public FileOperationsTestBase {
public:
void SetUp() override {
FileOperationsTestBase::SetUp();
ASSERT_TRUE(operations()->Init());
}
protected:
// We don't use FileOperations for file manipulations needed by the tests,
// because the implementation might have internally-consistent bugs.
// Reads `filename` and returns its contents in a vector on success.
std::optional<std::vector<uint8_t>> ReadFile(std::string_view filename) {
return base::ReadFileToBytes(GetPath(filename));
}
// Expects that file `filename` contains `contents` and causes the test to
// fail otherwise.
void ExpectContents(std::string_view filename,
base::span<const uint8_t> contents) {
ASSERT_OK_AND_ASSIGN(auto result, ReadFile(filename));
EXPECT_EQ(result, contents);
}
// Writes `data` to `filename`. Returns true on success.
bool WriteFile(std::string_view filename, base::span<const uint8_t> data) {
return base::WriteFile(GetPath(filename), data);
}
std::optional<base::Time> GetLastModified(std::string_view filename) {
base::File::Info info;
if (base::GetFileInfo(GetPath(filename), &info)) {
return info.last_modified;
}
return std::nullopt;
}
base::FilePath GetPath() const { return GetNVSPath(); }
base::FilePath GetPath(std::string_view filename) const {
return GetPath().AppendASCII(filename);
}
};
TEST_F(FileOperationsPostInitTest, LoadNonExistent) {
EXPECT_THAT(operations()->Load("non-existent", kBigSize),
ErrorIs(FILE_ERROR_NOT_FOUND));
}
TEST_F(FileOperationsPostInitTest, LoadExistent) {
static constexpr char kFilename[] = "existent";
const auto data = InterestingData();
EXPECT_TRUE(WriteFile(kFilename, data));
ASSERT_OK_AND_ASSIGN(auto result, operations()->Load(kFilename, kBigSize));
EXPECT_EQ(result.contents, data);
}
TEST_F(FileOperationsPostInitTest, LoadModificationTime) {
static constexpr char kFilename[] = "file.dat";
EXPECT_TRUE(WriteFile(kFilename, InterestingData()));
ASSERT_OK_AND_ASSIGN(auto last_modified, GetLastModified(kFilename));
ASSERT_OK_AND_ASSIGN(auto result, operations()->Load(kFilename, kBigSize));
EXPECT_EQ(result.last_modified, last_modified);
}
TEST_F(FileOperationsPostInitTest, LoadEmpty) {
static constexpr char kFilename[] = "empty";
EXPECT_TRUE(WriteFile(kFilename, base::span<const uint8_t>()));
ASSERT_OK_AND_ASSIGN(auto result, operations()->Load(kFilename, kBigSize));
EXPECT_TRUE(result.contents.empty());
}
TEST_F(FileOperationsPostInitTest, LoadTooBig) {
static constexpr char kFilename[] = "toobig.dat";
const auto data = InterestingData();
EXPECT_TRUE(WriteFile(kFilename, data));
EXPECT_THAT(operations()->Load(kFilename, data.size() - 1),
ErrorIs(FILE_ERROR_NO_MEMORY));
}
TEST_F(FileOperationsPostInitTest, AtomicSaveEmpty) {
static constexpr std::string_view kFilename = "empty";
EXPECT_EQ(operations()->AtomicSave(kFilename, {}), base::ok());
ASSERT_OK_AND_ASSIGN(auto contents, ReadFile(kFilename));
EXPECT_TRUE(contents.empty());
}
TEST_F(FileOperationsPostInitTest, AtomicSaveEmptySegments) {
static constexpr std::string_view kFilename = "segment.dat";
const auto data = InterestingData();
const auto [first, second] = base::span(data).split_at(data.size() / 2);
const auto segments =
std::to_array<base::span<const uint8_t>>({{}, first, {}, {}, second, {}});
EXPECT_EQ(operations()->AtomicSave(kFilename, segments), base::ok());
ExpectContents(kFilename, data);
}
TEST_F(FileOperationsPostInitTest, AtomicSaveOverwrites) {
static constexpr std::string_view kFilename = "atomic.dat";
EXPECT_TRUE(WriteFile(kFilename, std::vector<uint8_t>(64u)));
const auto data = InterestingData();
EXPECT_EQ(operations()->AtomicSave(kFilename, {data}), base::ok());
ExpectContents(kFilename, data);
}
TEST_F(FileOperationsPostInitTest, AtomicSaveOverwritesUnwritable) {
if (!CanMakeFileUnwritable()) {
GTEST_SKIP() << "Don't know how to make a file unwritable on this platform";
}
static constexpr std::string_view kFilename = "nowrite.dat";
EXPECT_TRUE(WriteFile(kFilename, {}));
MakeFileUnwritable(GetPath(kFilename));
const auto data = InterestingData();
EXPECT_EQ(operations()->AtomicSave(kFilename, {data}), base::ok());
ExpectContents(kFilename, data);
}
TEST_F(FileOperationsPostInitTest, AtomicSaveHandlesUnwritableTempFile) {
if (!CanMakeFileUnwritable()) {
GTEST_SKIP() << "Don't know how to make a file unwritable on this platform";
}
static constexpr std::string_view kFilename = "target.dat";
static constexpr std::string_view kTempFilename = "target-new.dat";
EXPECT_TRUE(WriteFile(kTempFilename, {}));
MakeFileUnwritable(GetPath(kTempFilename));
const auto data = InterestingData();
EXPECT_EQ(operations()->AtomicSave(kFilename, {data}), base::ok());
ExpectContents(kFilename, data);
}
// Tests the case where another file opens the temporary file during an
// AtomicSave operation. This actually happens with virus checkers on Windows.
TEST_F(FileOperationsPostInitTest, AtomicSaveRenameRace) {
static constexpr base::TimeDelta kMaxRacingTime = base::Seconds(1);
static constexpr std::string_view kFilename = "file.dat";
static constexpr std::string_view kTempFilename = "file-new.dat";
static constexpr size_t kNumberOfWrites = 100u;
// Unfortunately we need to start a thread to achieve the race condition.
class RacingThread : public base::DelegateSimpleThread::Delegate {
public:
RacingThread(const base::FilePath& file_to_open, base::AtomicFlag& flag)
: path_(file_to_open), flag_(flag) {}
RacingThread(const RacingThread&) = delete;
RacingThread& operator=(const RacingThread&) = delete;
// Defines the code to be executed on the racing thread.
void Run() override {
auto start_time = base::TimeTicks::Now();
while (!file_.IsValid()) {
using enum base::File::Flags;
file_.Initialize(path_, FLAG_OPEN | FLAG_READ);
if (base::TimeTicks::Now() > start_time + kMaxRacingTime) {
break;
}
}
if (file_.IsValid()) {
flag_->Set();
}
}
private:
const base::FilePath path_;
const base::raw_ref<base::AtomicFlag> flag_;
base::File file_;
};
base::AtomicFlag atomic_flag;
RacingThread racing_thread(GetPath(kTempFilename), atomic_flag);
base::DelegateSimpleThread thread(&racing_thread, "Racing thread");
thread.StartAsync();
// Make AtomicSave() do a large number of writes to make it more likely that
// the other thread will manage to win the race.
std::array<uint8_t, 1> one_write = {65};
std::vector<base::span<const uint8_t>> many_writes(kNumberOfWrites,
one_write);
auto start_time = base::TimeTicks::Now();
while (base::TimeTicks::Now() <= start_time + kMaxRacingTime) {
auto result = operations()->AtomicSave(kFilename, many_writes);
if (atomic_flag.IsSet()) {
#if BUILDFLAG(IS_WIN)
EXPECT_THAT(result, ErrorIs(base::File::FILE_ERROR_IN_USE));
#else
EXPECT_THAT(result, HasValue());
#endif // BUILDFLAG(IS_WIN)
break;
}
}
// The test passes by default if the racing thread fails to open the file
// before it can be renamed. Unfortunately that means that if it starts to
// fail, it may fail flakily.
thread.Join();
}
TEST_F(FileOperationsPostInitTest, CreateWriterCreatesFile) {
static constexpr std::string_view kFilename = "journal.dat";
auto writer = operations()->CreateWriter(kFilename);
EXPECT_THAT(writer, HasValue());
ExpectContents(kFilename, {});
}
TEST_F(FileOperationsPostInitTest, CreateWriterReplacesFile) {
static constexpr std::string_view kFilename = "journal.dat";
EXPECT_TRUE(WriteFile(kFilename, std::vector<uint8_t>(256u)));
auto writer = operations()->CreateWriter(kFilename);
EXPECT_THAT(writer, HasValue());
ExpectContents(kFilename, {});
}
TEST_F(FileOperationsPostInitTest, CreateWriterReplacesUnwritableFile) {
if (!CanMakeFileUnwritable()) {
GTEST_SKIP() << "Don't know how to make a file unwritable on this platform";
}
static constexpr std::string_view kFilename = "journal.dat";
EXPECT_TRUE(WriteFile(kFilename, std::vector<uint8_t>(256u)));
MakeFileUnwritable(GetPath(kFilename));
auto writer = operations()->CreateWriter(kFilename);
EXPECT_THAT(writer, HasValue());
ExpectContents(kFilename, {});
}
TEST_F(FileOperationsPostInitTest, WriterWriteWrites) {
static constexpr std::string_view kFilename = "journal.dat";
ASSERT_OK_AND_ASSIGN(auto writer, operations()->CreateWriter(kFilename));
const auto data = InterestingData();
writer->Write(data);
ExpectContents(kFilename, data);
}
TEST_F(FileOperationsPostInitTest, WriterWriteAppends) {
static constexpr std::string_view kFilename = "journal.dat";
ASSERT_OK_AND_ASSIGN(auto writer, operations()->CreateWriter(kFilename));
const auto data = InterestingData();
auto [first, second] = base::span(data).split_at(data.size() / 2);
writer->Write(first);
writer->Write(second);
ExpectContents(kFilename, data);
}
TEST_F(FileOperationsPostInitTest, CreateWriterUpdatesLastModifiedTime) {
static constexpr std::string_view kFilename = "journal.dat";
static constexpr base::TimeDelta kSleepTime = base::Milliseconds(1);
EXPECT_TRUE(WriteFile(kFilename, {}));
// The timestamp resolution is different on different operating systems, so
// just repeatedly call CreateWriter() until the time increases.
ASSERT_OK_AND_ASSIGN(auto original_last_modified, GetLastModified(kFilename));
base::Time new_last_modified;
do {
base::PlatformThread::Sleep(kSleepTime);
ASSERT_THAT(operations()->CreateWriter(kFilename), HasValue());
ASSERT_TRUE(
base::OptionalUnwrapTo(GetLastModified(kFilename), new_last_modified));
} while (new_last_modified == original_last_modified);
// This may fail if there is a backwards leap second or someone changes the
// system clock.
EXPECT_GT(new_last_modified, original_last_modified);
}
TEST_F(FileOperationsPostInitTest, VeryLongFilename) {
// No current system supports 1MB filenames.
const std::string filename(1024u * 1024u, 'X');
EXPECT_THAT(operations()->Load(filename, kBigSize),
ErrorIs(FILE_ERROR_FAILED));
EXPECT_THAT(operations()->AtomicSave(filename, DummyContents()),
ErrorIs(FILE_ERROR_FAILED));
EXPECT_THAT(operations()->CreateWriter(filename), ErrorIs(FILE_ERROR_FAILED));
}
class FileOperationsBadFilenameTest
: public FileOperationsPostInitTest,
public ::testing::WithParamInterface<std::string_view> {
protected:
std::string_view Filename() const { return GetParam(); }
};
INSTANTIATE_TEST_SUITE_P(FileOperations,
FileOperationsBadFilenameTest,
::testing::Values("foo/bar", ".", "..", "\x80"));
TEST_P(FileOperationsBadFilenameTest, Load) {
EXPECT_THAT(operations()->Load(Filename(), kBigSize),
ErrorIs(FILE_ERROR_SECURITY));
}
TEST_P(FileOperationsBadFilenameTest, AtomicSave) {
EXPECT_THAT(operations()->AtomicSave(Filename(), DummyContents()),
ErrorIs(FILE_ERROR_SECURITY));
}
TEST_P(FileOperationsBadFilenameTest, CreateWriter) {
EXPECT_THAT(operations()->CreateWriter(Filename()),
ErrorIs(FILE_ERROR_SECURITY));
}
} // namespace
} // namespace net
|