Roll src/third_party/WebKit d9c6159:8139f33 (svn 201974:201975)
[chromium-blink-merge.git] / base / files / important_file_writer_unittest.cc
blob71900c93d5e7c63326b6b96fb5e852c0a1e92afc
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.
5 #include "base/files/important_file_writer.h"
7 #include "base/bind.h"
8 #include "base/compiler_specific.h"
9 #include "base/files/file_path.h"
10 #include "base/files/file_util.h"
11 #include "base/files/scoped_temp_dir.h"
12 #include "base/location.h"
13 #include "base/logging.h"
14 #include "base/run_loop.h"
15 #include "base/single_thread_task_runner.h"
16 #include "base/thread_task_runner_handle.h"
17 #include "base/threading/thread.h"
18 #include "base/time/time.h"
19 #include "testing/gtest/include/gtest/gtest.h"
21 namespace base {
23 namespace {
25 std::string GetFileContent(const FilePath& path) {
26 std::string content;
27 if (!ReadFileToString(path, &content)) {
28 NOTREACHED();
30 return content;
33 class DataSerializer : public ImportantFileWriter::DataSerializer {
34 public:
35 explicit DataSerializer(const std::string& data) : data_(data) {
38 bool SerializeData(std::string* output) override {
39 output->assign(data_);
40 return true;
43 private:
44 const std::string data_;
47 class SuccessfulWriteObserver {
48 public:
49 SuccessfulWriteObserver() : successful_write_observed_(false) {}
51 // Register on_successful_write() to be called on the next successful write
52 // of |writer|.
53 void ObserveNextSuccessfulWrite(ImportantFileWriter* writer);
55 // Returns true if a successful write was observed via on_successful_write()
56 // and resets the observation state to false regardless.
57 bool GetAndResetObservationState();
59 private:
60 void on_successful_write() {
61 EXPECT_FALSE(successful_write_observed_);
62 successful_write_observed_ = true;
65 bool successful_write_observed_;
67 DISALLOW_COPY_AND_ASSIGN(SuccessfulWriteObserver);
70 void SuccessfulWriteObserver::ObserveNextSuccessfulWrite(
71 ImportantFileWriter* writer) {
72 writer->RegisterOnNextSuccessfulWriteCallback(base::Bind(
73 &SuccessfulWriteObserver::on_successful_write, base::Unretained(this)));
76 bool SuccessfulWriteObserver::GetAndResetObservationState() {
77 bool was_successful_write_observed = successful_write_observed_;
78 successful_write_observed_ = false;
79 return was_successful_write_observed;
82 } // namespace
84 class ImportantFileWriterTest : public testing::Test {
85 public:
86 ImportantFileWriterTest() { }
87 void SetUp() override {
88 ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
89 file_ = temp_dir_.path().AppendASCII("test-file");
92 protected:
93 SuccessfulWriteObserver successful_write_observer_;
94 FilePath file_;
95 MessageLoop loop_;
97 private:
98 ScopedTempDir temp_dir_;
101 TEST_F(ImportantFileWriterTest, Basic) {
102 ImportantFileWriter writer(file_, ThreadTaskRunnerHandle::Get());
103 EXPECT_FALSE(PathExists(writer.path()));
104 EXPECT_FALSE(successful_write_observer_.GetAndResetObservationState());
105 writer.WriteNow(make_scoped_ptr(new std::string("foo")));
106 RunLoop().RunUntilIdle();
108 EXPECT_FALSE(successful_write_observer_.GetAndResetObservationState());
109 ASSERT_TRUE(PathExists(writer.path()));
110 EXPECT_EQ("foo", GetFileContent(writer.path()));
113 TEST_F(ImportantFileWriterTest, BasicWithSuccessfulWriteObserver) {
114 ImportantFileWriter writer(file_, ThreadTaskRunnerHandle::Get());
115 EXPECT_FALSE(PathExists(writer.path()));
116 EXPECT_FALSE(successful_write_observer_.GetAndResetObservationState());
117 successful_write_observer_.ObserveNextSuccessfulWrite(&writer);
118 writer.WriteNow(make_scoped_ptr(new std::string("foo")));
119 RunLoop().RunUntilIdle();
121 // Confirm that the observer is invoked.
122 EXPECT_TRUE(successful_write_observer_.GetAndResetObservationState());
123 ASSERT_TRUE(PathExists(writer.path()));
124 EXPECT_EQ("foo", GetFileContent(writer.path()));
126 // Confirm that re-installing the observer works for another write.
127 EXPECT_FALSE(successful_write_observer_.GetAndResetObservationState());
128 successful_write_observer_.ObserveNextSuccessfulWrite(&writer);
129 writer.WriteNow(make_scoped_ptr(new std::string("bar")));
130 RunLoop().RunUntilIdle();
132 EXPECT_TRUE(successful_write_observer_.GetAndResetObservationState());
133 ASSERT_TRUE(PathExists(writer.path()));
134 EXPECT_EQ("bar", GetFileContent(writer.path()));
136 // Confirm that writing again without re-installing the observer doesn't
137 // result in a notification.
138 EXPECT_FALSE(successful_write_observer_.GetAndResetObservationState());
139 writer.WriteNow(make_scoped_ptr(new std::string("baz")));
140 RunLoop().RunUntilIdle();
142 EXPECT_FALSE(successful_write_observer_.GetAndResetObservationState());
143 ASSERT_TRUE(PathExists(writer.path()));
144 EXPECT_EQ("baz", GetFileContent(writer.path()));
147 TEST_F(ImportantFileWriterTest, ScheduleWrite) {
148 ImportantFileWriter writer(file_,
149 ThreadTaskRunnerHandle::Get(),
150 TimeDelta::FromMilliseconds(25));
151 EXPECT_FALSE(writer.HasPendingWrite());
152 DataSerializer serializer("foo");
153 writer.ScheduleWrite(&serializer);
154 EXPECT_TRUE(writer.HasPendingWrite());
155 ThreadTaskRunnerHandle::Get()->PostDelayedTask(
156 FROM_HERE, MessageLoop::QuitWhenIdleClosure(),
157 TimeDelta::FromMilliseconds(100));
158 MessageLoop::current()->Run();
159 EXPECT_FALSE(writer.HasPendingWrite());
160 ASSERT_TRUE(PathExists(writer.path()));
161 EXPECT_EQ("foo", GetFileContent(writer.path()));
164 TEST_F(ImportantFileWriterTest, DoScheduledWrite) {
165 ImportantFileWriter writer(file_, ThreadTaskRunnerHandle::Get());
166 EXPECT_FALSE(writer.HasPendingWrite());
167 DataSerializer serializer("foo");
168 writer.ScheduleWrite(&serializer);
169 EXPECT_TRUE(writer.HasPendingWrite());
170 writer.DoScheduledWrite();
171 ThreadTaskRunnerHandle::Get()->PostDelayedTask(
172 FROM_HERE, MessageLoop::QuitWhenIdleClosure(),
173 TimeDelta::FromMilliseconds(100));
174 MessageLoop::current()->Run();
175 EXPECT_FALSE(writer.HasPendingWrite());
176 ASSERT_TRUE(PathExists(writer.path()));
177 EXPECT_EQ("foo", GetFileContent(writer.path()));
180 TEST_F(ImportantFileWriterTest, BatchingWrites) {
181 ImportantFileWriter writer(file_,
182 ThreadTaskRunnerHandle::Get(),
183 TimeDelta::FromMilliseconds(25));
184 DataSerializer foo("foo"), bar("bar"), baz("baz");
185 writer.ScheduleWrite(&foo);
186 writer.ScheduleWrite(&bar);
187 writer.ScheduleWrite(&baz);
188 ThreadTaskRunnerHandle::Get()->PostDelayedTask(
189 FROM_HERE, MessageLoop::QuitWhenIdleClosure(),
190 TimeDelta::FromMilliseconds(100));
191 MessageLoop::current()->Run();
192 ASSERT_TRUE(PathExists(writer.path()));
193 EXPECT_EQ("baz", GetFileContent(writer.path()));
196 } // namespace base