file_stream_writer_test.h 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
  1. // Copyright 2020 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. #ifndef STORAGE_BROWSER_FILE_SYSTEM_FILE_STREAM_WRITER_TEST_H_
  5. #define STORAGE_BROWSER_FILE_SYSTEM_FILE_STREAM_WRITER_TEST_H_
  6. #include <cstdio>
  7. #include "base/callback_helpers.h"
  8. #include "base/files/file_util.h"
  9. #include "base/files/scoped_temp_dir.h"
  10. #include "base/task/single_thread_task_runner.h"
  11. #include "base/test/task_environment.h"
  12. #include "base/threading/thread.h"
  13. #include "net/base/io_buffer.h"
  14. #include "net/base/net_errors.h"
  15. #include "net/base/test_completion_callback.h"
  16. #include "storage/browser/file_system/file_stream_test_utils.h"
  17. #include "storage/browser/file_system/file_stream_writer.h"
  18. #include "testing/gtest/include/gtest/gtest.h"
  19. namespace storage {
  20. // An interface for derived FileStreamWriter to implement. This allows multiple
  21. // FileStreamWriter implementations can share the same test framework. Tests
  22. // should implement CreateFileWithContent, CreateWriter, FilePathExists, and
  23. // GetFileContent to manipulate files for their particular implementation.
  24. class FileStreamWriterTest : public testing::Test {
  25. public:
  26. static constexpr base::StringPiece kTestFileName = "file_a";
  27. virtual bool CreateFileWithContent(const std::string& name,
  28. const std::string& data) = 0;
  29. virtual std::unique_ptr<FileStreamWriter> CreateWriter(
  30. const std::string& name,
  31. int64_t offset) = 0;
  32. virtual bool FilePathExists(const std::string& name) = 0;
  33. virtual std::string GetFileContent(const std::string& name) = 0;
  34. static void NeverCalled(int unused) { ADD_FAILURE(); }
  35. protected:
  36. // Must be listed before base::test::TaskEnvironment.
  37. base::ScopedTempDir dir_;
  38. base::test::TaskEnvironment task_environment_{
  39. base::test::TaskEnvironment::MainThreadType::IO};
  40. };
  41. template <class SubClass>
  42. class FileStreamWriterTypedTest : public SubClass {
  43. public:
  44. void SetUp() override { SubClass::SetUp(); }
  45. };
  46. TYPED_TEST_SUITE_P(FileStreamWriterTypedTest);
  47. TYPED_TEST_P(FileStreamWriterTypedTest, Write) {
  48. EXPECT_TRUE(
  49. this->CreateFileWithContent(std::string(this->kTestFileName), "foobar"));
  50. std::unique_ptr<FileStreamWriter> writer(
  51. this->CreateWriter(std::string(this->kTestFileName), 0));
  52. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "foo"));
  53. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "bar"));
  54. EXPECT_TRUE(this->FilePathExists(std::string(this->kTestFileName)));
  55. EXPECT_EQ("foobar", this->GetFileContent(std::string(this->kTestFileName)));
  56. }
  57. TYPED_TEST_P(FileStreamWriterTypedTest, WriteMiddle) {
  58. EXPECT_TRUE(
  59. this->CreateFileWithContent(std::string(this->kTestFileName), "foobar"));
  60. std::unique_ptr<FileStreamWriter> writer(
  61. this->CreateWriter(std::string(this->kTestFileName), 2));
  62. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "xxx"));
  63. EXPECT_TRUE(this->FilePathExists(std::string(this->kTestFileName)));
  64. EXPECT_EQ("foxxxr", this->GetFileContent(std::string(this->kTestFileName)));
  65. }
  66. TYPED_TEST_P(FileStreamWriterTypedTest, WriteNearEnd) {
  67. EXPECT_TRUE(
  68. this->CreateFileWithContent(std::string(this->kTestFileName), "foobar"));
  69. std::unique_ptr<FileStreamWriter> writer(
  70. this->CreateWriter(std::string(this->kTestFileName), 5));
  71. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "xxx"));
  72. EXPECT_TRUE(this->FilePathExists(std::string(this->kTestFileName)));
  73. EXPECT_EQ("foobaxxx", this->GetFileContent(std::string(this->kTestFileName)));
  74. }
  75. TYPED_TEST_P(FileStreamWriterTypedTest, WriteEnd) {
  76. EXPECT_TRUE(
  77. this->CreateFileWithContent(std::string(this->kTestFileName), "foobar"));
  78. std::unique_ptr<FileStreamWriter> writer(
  79. this->CreateWriter(std::string(this->kTestFileName), 6));
  80. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "xxx"));
  81. EXPECT_TRUE(this->FilePathExists(std::string(this->kTestFileName)));
  82. EXPECT_EQ("foobarxxx",
  83. this->GetFileContent(std::string(this->kTestFileName)));
  84. }
  85. TYPED_TEST_P(FileStreamWriterTypedTest, WriteAfterEnd) {
  86. EXPECT_TRUE(
  87. this->CreateFileWithContent(std::string(this->kTestFileName), "foobar"));
  88. std::unique_ptr<FileStreamWriter> writer(
  89. this->CreateWriter(std::string(this->kTestFileName), 7));
  90. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "xxx"));
  91. EXPECT_TRUE(this->FilePathExists(std::string(this->kTestFileName)));
  92. EXPECT_EQ(std::string("foobar\0xxx", 10),
  93. this->GetFileContent(std::string(this->kTestFileName)));
  94. }
  95. TYPED_TEST_P(FileStreamWriterTypedTest, WriteFailForNonexistingFile) {
  96. ASSERT_FALSE(this->FilePathExists(std::string(this->kTestFileName)));
  97. std::unique_ptr<FileStreamWriter> writer(
  98. this->CreateWriter(std::string(this->kTestFileName), 0));
  99. EXPECT_EQ(net::ERR_FILE_NOT_FOUND, WriteStringToWriter(writer.get(), "foo"));
  100. EXPECT_FALSE(this->FilePathExists(std::string(this->kTestFileName)));
  101. }
  102. TYPED_TEST_P(FileStreamWriterTypedTest, CancelBeforeOperation) {
  103. std::unique_ptr<FileStreamWriter> writer(
  104. this->CreateWriter(std::string(this->kTestFileName), 0));
  105. // Cancel immediately fails when there's no in-flight operation.
  106. EXPECT_EQ(net::ERR_UNEXPECTED, writer->Cancel(base::DoNothing()));
  107. }
  108. TYPED_TEST_P(FileStreamWriterTypedTest, CancelAfterFinishedOperation) {
  109. EXPECT_TRUE(
  110. this->CreateFileWithContent(std::string(this->kTestFileName), "foobar"));
  111. std::unique_ptr<FileStreamWriter> writer(
  112. this->CreateWriter(std::string(this->kTestFileName), 0));
  113. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "foo"));
  114. // Cancel immediately fails when there's no in-flight operation.
  115. EXPECT_EQ(net::ERR_UNEXPECTED, writer->Cancel(base::DoNothing()));
  116. // Write operation is already completed.
  117. EXPECT_TRUE(this->FilePathExists(std::string(this->kTestFileName)));
  118. EXPECT_EQ("foobar", this->GetFileContent(std::string(this->kTestFileName)));
  119. }
  120. TYPED_TEST_P(FileStreamWriterTypedTest, CancelWrite) {
  121. EXPECT_TRUE(
  122. this->CreateFileWithContent(std::string(this->kTestFileName), "foobar"));
  123. std::unique_ptr<FileStreamWriter> writer(
  124. this->CreateWriter(std::string(this->kTestFileName), 0));
  125. scoped_refptr<net::StringIOBuffer> buffer(
  126. base::MakeRefCounted<net::StringIOBuffer>("xxx"));
  127. int result =
  128. writer->Write(buffer.get(), buffer->size(),
  129. base::BindOnce(&FileStreamWriterTest::NeverCalled));
  130. ASSERT_EQ(net::ERR_IO_PENDING, result);
  131. net::TestCompletionCallback callback;
  132. writer->Cancel(callback.callback());
  133. int cancel_result = writer->Cancel(callback.callback());
  134. EXPECT_EQ(net::OK, callback.GetResult(cancel_result));
  135. }
  136. TYPED_TEST_P(FileStreamWriterTypedTest, CancelFlush) {
  137. EXPECT_TRUE(
  138. this->CreateFileWithContent(std::string(this->kTestFileName), ""));
  139. std::unique_ptr<FileStreamWriter> writer(
  140. this->CreateWriter(std::string(this->kTestFileName), 0));
  141. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "foo"));
  142. int cancel_expectation = net::OK;
  143. int result = writer->Flush(base::DoNothing());
  144. // Flush can run synchronously or asynchronously.
  145. if (result == net::OK) {
  146. // Cancel() should error if called when there is no in-flight operation.
  147. cancel_expectation = net::ERR_UNEXPECTED;
  148. } else {
  149. EXPECT_EQ(net::ERR_IO_PENDING, result);
  150. }
  151. net::TestCompletionCallback callback;
  152. int cancel_result = writer->Cancel(callback.callback());
  153. EXPECT_EQ(cancel_expectation, callback.GetResult(cancel_result));
  154. EXPECT_EQ("foo", this->GetFileContent(std::string(this->kTestFileName)));
  155. }
  156. TYPED_TEST_P(FileStreamWriterTypedTest, FlushBeforeWriting) {
  157. EXPECT_TRUE(
  158. this->CreateFileWithContent(std::string(this->kTestFileName), ""));
  159. std::unique_ptr<FileStreamWriter> writer(
  160. this->CreateWriter(std::string(this->kTestFileName), 0));
  161. EXPECT_EQ(net::OK, writer->Flush(base::DoNothing()));
  162. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "foo"));
  163. EXPECT_EQ("foo", this->GetFileContent(std::string(this->kTestFileName)));
  164. }
  165. TYPED_TEST_P(FileStreamWriterTypedTest, FlushAfterWriting) {
  166. EXPECT_TRUE(
  167. this->CreateFileWithContent(std::string(this->kTestFileName), ""));
  168. std::unique_ptr<FileStreamWriter> writer(
  169. this->CreateWriter(std::string(this->kTestFileName), 0));
  170. EXPECT_EQ(net::OK, WriteStringToWriter(writer.get(), "foo"));
  171. net::TestCompletionCallback callback;
  172. int result =
  173. writer->Flush(base::OnceCallback<void(int)>(callback.callback()));
  174. ASSERT_EQ(net::OK, callback.GetResult(result));
  175. EXPECT_EQ("foo", this->GetFileContent(std::string(this->kTestFileName)));
  176. }
  177. REGISTER_TYPED_TEST_SUITE_P(FileStreamWriterTypedTest,
  178. Write,
  179. WriteMiddle,
  180. WriteNearEnd,
  181. WriteEnd,
  182. WriteAfterEnd,
  183. WriteFailForNonexistingFile,
  184. CancelBeforeOperation,
  185. CancelAfterFinishedOperation,
  186. CancelWrite,
  187. CancelFlush,
  188. FlushBeforeWriting,
  189. FlushAfterWriting);
  190. } // namespace storage
  191. #endif // STORAGE_BROWSER_FILE_SYSTEM_FILE_STREAM_WRITER_TEST_H_