File: local_fd_unittest.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (154 lines) | stat: -rw-r--r-- 6,112 bytes parent folder | download | duplicates (6)
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
// Copyright 2024 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_system_provider/content_cache/local_fd.h"

#include <cstring>

#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/memory/scoped_refptr.h"
#include "base/rand_util.h"
#include "base/task/thread_pool.h"
#include "base/test/task_environment.h"
#include "base/test/test_future.h"
#include "net/base/io_buffer.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace ash::file_system_provider {
namespace {

using testing::Property;

class FileSystemProviderLocalFDTest : public testing::Test {
 protected:
  FileSystemProviderLocalFDTest() = default;
  ~FileSystemProviderLocalFDTest() override = default;

  void SetUp() override {
    EXPECT_TRUE(temp_dir_.CreateUniqueTempDir());
    task_runner_ = base::ThreadPool::CreateSequencedTaskRunner(
        {base::MayBlock(), base::TaskPriority::BEST_EFFORT,
         base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN});

    // Create a test file that will be used to read and write in every test.
    test_file_path_ = base::FilePath(temp_dir_.GetPath().Append("test"));
    test_file_contents_ = "test data";
    test_file_size_ = test_file_contents_.size();
    EXPECT_TRUE(base::WriteFile(test_file_path_, test_file_contents_));
  }

  base::FilePath test_file_path_;
  int test_file_size_ = -1;
  std::string test_file_contents_;
  scoped_refptr<base::SequencedTaskRunner> task_runner_;

  base::test::TaskEnvironment task_environment_;
  base::ScopedTempDir temp_dir_;
};

TEST_F(FileSystemProviderLocalFDTest, BytesCanBeReadSuccessfully) {
  // Create a buffer that the contents of `file_path` will be read into.
  scoped_refptr<net::IOBuffer> read_buffer =
      base::MakeRefCounted<net::IOBufferWithSize>(test_file_size_);

  LocalFD file(test_file_path_, task_runner_);
  base::test::TestFuture<base::FileErrorOr<int>> read_bytes_future;
  file.ReadBytes(read_buffer, /*offset=*/0, /*length=*/test_file_size_,
                 read_bytes_future.GetCallback());

  // Ensure that both the `bytes_read` on the callback and the actual size of
  // the buffer are the size of the data written to the underlying file.
  EXPECT_EQ(read_bytes_future.Get(), test_file_size_);
  EXPECT_EQ(read_buffer->size(), test_file_size_);

  // Close the file.
  base::test::TestFuture<void> close_future;
  file.Close(close_future.GetCallback());
  EXPECT_TRUE(close_future.Wait());
}

TEST_F(FileSystemProviderLocalFDTest, BytesCanBeReadThenWrittenTo) {
  scoped_refptr<net::IOBuffer> read_buffer =
      base::MakeRefCounted<net::IOBufferWithSize>(test_file_size_);

  // Read the current bytes from the existing file.
  LocalFD file(test_file_path_, task_runner_);
  base::test::TestFuture<base::FileErrorOr<int>> future;
  file.ReadBytes(read_buffer, /*offset=*/0, /*length=*/test_file_size_,
                 future.GetCallback());
  EXPECT_EQ(future.Get(), test_file_size_);
  EXPECT_EQ(read_buffer->size(), test_file_size_);

  // Prepare a buffer with some data to append to the existing file.
  std::string contents_to_append(" appended data");
  scoped_refptr<net::IOBuffer> write_buffer =
      base::MakeRefCounted<net::StringIOBuffer>(contents_to_append);

  // Attempt to write bytes to the existing file. The underlying `base::File`
  // was created with `base::File::FLAG_OPEN | base::File::FLAG_READ` which
  // ensures a failure if the file doesn't exist. Given we're not attempting to
  // write to the file, this should close that FD and re-open one that enables
  // writing
  base::test::TestFuture<base::File::Error> write_bytes_future;
  file.WriteBytes(write_buffer, test_file_size_, /*length=*/15,
                  write_bytes_future.GetCallback());
  EXPECT_EQ(write_bytes_future.Get(), base::File::FILE_OK);

  // Ensure the actual contents on disk get updated to include the appended
  // data.
  std::string actual_contents;
  EXPECT_TRUE(base::ReadFileToString(test_file_path_, &actual_contents));
  EXPECT_STREQ(actual_contents.c_str(),
               base::StrCat({test_file_contents_, contents_to_append}).c_str());
}

TEST_F(FileSystemProviderLocalFDTest, FileCanBeScheduledToBeClosed) {
  scoped_refptr<net::IOBuffer> buffer =
      base::MakeRefCounted<net::IOBufferWithSize>(test_file_size_);

  LocalFD file(test_file_path_, task_runner_);
  base::test::TestFuture<base::FileErrorOr<int>> read_bytes_future;
  file.ReadBytes(buffer, /*offset=*/0, /*length=*/test_file_size_,
                 read_bytes_future.GetCallback());

  // Expect file closure to eventually succeed.
  base::test::TestFuture<void> close_future;
  file.Close(close_future.GetCallback());
  EXPECT_EQ(read_bytes_future.Get(), test_file_size_);
  EXPECT_TRUE(close_future.Wait());
}

TEST_F(FileSystemProviderLocalFDTest, ConcurrentReadsAreNotAllowed) {
  scoped_refptr<net::IOBuffer> buffer =
      base::MakeRefCounted<net::IOBufferWithSize>(test_file_size_);

  LocalFD file(test_file_path_, task_runner_);

  // First read call should succeed.
  base::test::TestFuture<base::FileErrorOr<int>> read_bytes_future_allowed;
  file.ReadBytes(buffer, /*offset=*/0, /*length=*/1,
                 read_bytes_future_allowed.GetCallback());

  // Second call should not succeed as the first call is still waiting to be
  // executed.
  base::test::TestFuture<base::FileErrorOr<int>> read_bytes_future_disallowed;
  file.ReadBytes(buffer, /*offset=*/1, /*length=*/1,
                 read_bytes_future_disallowed.GetCallback());

  EXPECT_THAT(read_bytes_future_allowed.Get(),
              Property(&base::FileErrorOr<int>::value, 1));
  EXPECT_THAT(
      read_bytes_future_disallowed.Get(),
      Property(&base::FileErrorOr<int>::error, base::File::FILE_ERROR_IN_USE));

  // Expect file closure to eventually succeed.
  base::test::TestFuture<void> close_future;
  file.Close(close_future.GetCallback());
  EXPECT_TRUE(close_future.Wait());
}

}  // namespace
}  // namespace ash::file_system_provider