forked from Pissandshittium/pissandshittium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfile_path_watcher_unittest.cc
1266 lines (1052 loc) · 45 KB
/
file_path_watcher_unittest.cc
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
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/files/file_path_watcher.h"
#include <memory>
#include <set>
#include <string>
#include <vector>
#include "base/bind.h"
#include "base/callback_helpers.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/run_loop.h"
#include "base/strings/stringprintf.h"
#include "base/synchronization/waitable_event.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/bind.h"
#include "base/test/task_environment.h"
#include "base/test/test_file_util.h"
#include "base/test/test_timeouts.h"
#include "base/threading/thread.h"
#include "base/threading/thread_task_runner_handle.h"
#include "build/build_config.h"
#include "testing/gtest/include/gtest/gtest.h"
#if BUILDFLAG(IS_WIN)
#include <windows.h>
#include <aclapi.h>
#elif BUILDFLAG(IS_POSIX)
#include <sys/stat.h>
#endif
#if BUILDFLAG(IS_ANDROID)
#include "base/android/path_utils.h"
#endif // BUILDFLAG(IS_ANDROID)
#if BUILDFLAG(IS_POSIX)
#include "base/files/file_descriptor_watcher_posix.h"
#endif // BUILDFLAG(IS_POSIX)
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_FUCHSIA)
#include "base/files/file_path_watcher_inotify.h"
#include "base/format_macros.h"
#endif
namespace base {
namespace {
class TestDelegate;
// Aggregates notifications from the test delegates and breaks the run loop
// the test thread is waiting on once they all came in.
class NotificationCollector
: public base::RefCountedThreadSafe<NotificationCollector> {
public:
NotificationCollector() : task_runner_(ThreadTaskRunnerHandle::Get()) {}
// Called from the file thread by the delegates.
void OnChange(TestDelegate* delegate) {
task_runner_->PostTask(
FROM_HERE, base::BindOnce(&NotificationCollector::RecordChange, this,
base::Unretained(delegate)));
}
void Register(TestDelegate* delegate) {
delegates_.insert(delegate);
}
void Reset(base::OnceClosure signal_closure) {
signal_closure_ = std::move(signal_closure);
signaled_.clear();
}
bool Success() {
return signaled_ == delegates_;
}
private:
friend class base::RefCountedThreadSafe<NotificationCollector>;
~NotificationCollector() = default;
void RecordChange(TestDelegate* delegate) {
// Warning: |delegate| is Unretained. Do not dereference.
ASSERT_TRUE(task_runner_->BelongsToCurrentThread());
ASSERT_TRUE(delegates_.count(delegate));
signaled_.insert(delegate);
// Check whether all delegates have been signaled.
if (signal_closure_ && signaled_ == delegates_)
std::move(signal_closure_).Run();
}
// Set of registered delegates.
std::set<TestDelegate*> delegates_;
// Set of signaled delegates.
std::set<TestDelegate*> signaled_;
// The loop we should break after all delegates signaled.
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
// Closure to run when all delegates have signaled.
base::OnceClosure signal_closure_;
};
class TestDelegateBase : public SupportsWeakPtr<TestDelegateBase> {
public:
TestDelegateBase() = default;
TestDelegateBase(const TestDelegateBase&) = delete;
TestDelegateBase& operator=(const TestDelegateBase&) = delete;
virtual ~TestDelegateBase() = default;
virtual void OnFileChanged(const FilePath& path, bool error) = 0;
};
// A mock class for testing. Gmock is not appropriate because it is not
// thread-safe for setting expectations. Thus the test code cannot safely
// reset expectations while the file watcher is running.
// Instead, TestDelegate gets the notifications from FilePathWatcher and uses
// NotificationCollector to aggregate the results.
class TestDelegate : public TestDelegateBase {
public:
explicit TestDelegate(NotificationCollector* collector)
: collector_(collector) {
collector_->Register(this);
}
TestDelegate(const TestDelegate&) = delete;
TestDelegate& operator=(const TestDelegate&) = delete;
~TestDelegate() override = default;
// Configure this delegate so that it expects an error.
void set_expect_error() { expect_error_ = true; }
// TestDelegateBase:
void OnFileChanged(const FilePath& path, bool error) override {
if (error != expect_error_) {
ADD_FAILURE() << "Unexpected change for \"" << path
<< "\" with |error| = " << (error ? "true" : "false");
} else {
collector_->OnChange(this);
}
}
private:
scoped_refptr<NotificationCollector> collector_;
bool expect_error_ = false;
};
class FilePathWatcherTest : public testing::Test {
public:
FilePathWatcherTest()
#if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
: task_environment_(test::TaskEnvironment::MainThreadType::IO)
#endif
{
}
FilePathWatcherTest(const FilePathWatcherTest&) = delete;
FilePathWatcherTest& operator=(const FilePathWatcherTest&) = delete;
~FilePathWatcherTest() override = default;
protected:
void SetUp() override {
#if BUILDFLAG(IS_ANDROID)
// Watching files is only permitted when all parent directories are
// accessible, which is not the case for the default temp directory
// on Android which is under /data/data. Use /sdcard instead.
// TODO(pauljensen): Remove this when crbug.com/475568 is fixed.
FilePath parent_dir;
ASSERT_TRUE(android::GetExternalStorageDirectory(&parent_dir));
ASSERT_TRUE(temp_dir_.CreateUniqueTempDirUnderPath(parent_dir));
#else // BUILDFLAG(IS_ANDROID)
ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
#endif // BUILDFLAG(IS_ANDROID)
collector_ = new NotificationCollector();
}
void TearDown() override { RunLoop().RunUntilIdle(); }
FilePath test_file() {
return temp_dir_.GetPath().AppendASCII("FilePathWatcherTest");
}
FilePath test_link() {
return temp_dir_.GetPath().AppendASCII("FilePathWatcherTest.lnk");
}
[[nodiscard]] bool SetupWatch(const FilePath& target,
FilePathWatcher* watcher,
TestDelegateBase* delegate,
FilePathWatcher::Type watch_type);
[[nodiscard]] bool WaitForEvents() {
return WaitForEventsWithTimeout(TestTimeouts::action_timeout());
}
[[nodiscard]] bool WaitForEventsWithTimeout(TimeDelta timeout) {
RunLoop run_loop;
collector_->Reset(run_loop.QuitClosure());
// Make sure we timeout if we don't get notified.
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE, run_loop.QuitClosure(), timeout);
run_loop.Run();
return collector_->Success();
}
NotificationCollector* collector() { return collector_.get(); }
test::TaskEnvironment task_environment_;
ScopedTempDir temp_dir_;
scoped_refptr<NotificationCollector> collector_;
};
bool FilePathWatcherTest::SetupWatch(const FilePath& target,
FilePathWatcher* watcher,
TestDelegateBase* delegate,
FilePathWatcher::Type watch_type) {
return watcher->Watch(target, watch_type,
base::BindRepeating(&TestDelegateBase::OnFileChanged,
delegate->AsWeakPtr()));
}
// Basic test: Create the file and verify that we notice.
TEST_F(FilePathWatcherTest, NewFile) {
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(test_file(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(WriteFile(test_file(), "content"));
ASSERT_TRUE(WaitForEvents());
}
// Verify that modifying the file is caught.
TEST_F(FilePathWatcherTest, ModifiedFile) {
ASSERT_TRUE(WriteFile(test_file(), "content"));
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(test_file(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Now make sure we get notified if the file is modified.
ASSERT_TRUE(WriteFile(test_file(), "new content"));
ASSERT_TRUE(WaitForEvents());
}
// Verify that moving the file into place is caught.
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_MovedFile DISABLED_MovedFile
#else
#define MAYBE_MovedFile MovedFile
#endif
TEST_F(FilePathWatcherTest, MAYBE_MovedFile) {
FilePath source_file(temp_dir_.GetPath().AppendASCII("source"));
ASSERT_TRUE(WriteFile(source_file, "content"));
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(test_file(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Now make sure we get notified if the file is modified.
ASSERT_TRUE(base::Move(source_file, test_file()));
ASSERT_TRUE(WaitForEvents());
}
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_DeletedFile DISABLED_DeletedFile
#else
#define MAYBE_DeletedFile DeletedFile
#endif
TEST_F(FilePathWatcherTest, MAYBE_DeletedFile) {
ASSERT_TRUE(WriteFile(test_file(), "content"));
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(test_file(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Now make sure we get notified if the file is deleted.
base::DeleteFile(test_file());
ASSERT_TRUE(WaitForEvents());
}
// Used by the DeleteDuringNotify test below.
// Deletes the FilePathWatcher when it's notified.
class Deleter : public TestDelegateBase {
public:
explicit Deleter(base::OnceClosure done_closure)
: watcher_(std::make_unique<FilePathWatcher>()),
done_closure_(std::move(done_closure)) {}
Deleter(const Deleter&) = delete;
Deleter& operator=(const Deleter&) = delete;
~Deleter() override = default;
void OnFileChanged(const FilePath&, bool) override {
watcher_.reset();
std::move(done_closure_).Run();
}
FilePathWatcher* watcher() const { return watcher_.get(); }
private:
std::unique_ptr<FilePathWatcher> watcher_;
base::OnceClosure done_closure_;
};
// Verify that deleting a watcher during the callback doesn't crash.
TEST_F(FilePathWatcherTest, DeleteDuringNotify) {
base::RunLoop run_loop;
Deleter deleter(run_loop.QuitClosure());
ASSERT_TRUE(SetupWatch(test_file(), deleter.watcher(), &deleter,
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(WriteFile(test_file(), "content"));
run_loop.Run();
// We win if we haven't crashed yet.
// Might as well double-check it got deleted, too.
ASSERT_TRUE(deleter.watcher() == nullptr);
}
// Verify that deleting the watcher works even if there is a pending
// notification.
TEST_F(FilePathWatcherTest, DestroyWithPendingNotification) {
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
FilePathWatcher watcher;
ASSERT_TRUE(SetupWatch(test_file(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(WriteFile(test_file(), "content"));
}
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_MultipleWatchersSingleFile DISABLED_MultipleWatchersSingleFile
#else
#define MAYBE_MultipleWatchersSingleFile MultipleWatchersSingleFile
#endif
TEST_F(FilePathWatcherTest, MAYBE_MultipleWatchersSingleFile) {
FilePathWatcher watcher1, watcher2;
std::unique_ptr<TestDelegate> delegate1(new TestDelegate(collector()));
std::unique_ptr<TestDelegate> delegate2(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(test_file(), &watcher1, delegate1.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(SetupWatch(test_file(), &watcher2, delegate2.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(WriteFile(test_file(), "content"));
ASSERT_TRUE(WaitForEvents());
}
// Verify that watching a file whose parent directory doesn't exist yet works if
// the directory and file are created eventually.
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_NonExistentDirectory DISABLED_NonExistentDirectory
#else
#define MAYBE_NonExistentDirectory NonExistentDirectory
#endif
TEST_F(FilePathWatcherTest, MAYBE_NonExistentDirectory) {
FilePathWatcher watcher;
FilePath dir(temp_dir_.GetPath().AppendASCII("dir"));
FilePath file(dir.AppendASCII("file"));
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(file, &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(base::CreateDirectory(dir));
ASSERT_TRUE(WriteFile(file, "content"));
VLOG(1) << "Waiting for file creation";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(WriteFile(file, "content v2"));
VLOG(1) << "Waiting for file change";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(base::DeleteFile(file));
VLOG(1) << "Waiting for file deletion";
ASSERT_TRUE(WaitForEvents());
}
// Exercises watch reconfiguration for the case that directories on the path
// are rapidly created.
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_DirectoryChain DISABLED_DirectoryChain
#else
#define MAYBE_DirectoryChain DirectoryChain
#endif
TEST_F(FilePathWatcherTest, MAYBE_DirectoryChain) {
FilePath path(temp_dir_.GetPath());
std::vector<std::string> dir_names;
for (int i = 0; i < 20; i++) {
std::string dir(base::StringPrintf("d%d", i));
dir_names.push_back(dir);
path = path.AppendASCII(dir);
}
FilePathWatcher watcher;
FilePath file(path.AppendASCII("file"));
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(file, &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
FilePath sub_path(temp_dir_.GetPath());
for (std::vector<std::string>::const_iterator d(dir_names.begin());
d != dir_names.end(); ++d) {
sub_path = sub_path.AppendASCII(*d);
ASSERT_TRUE(base::CreateDirectory(sub_path));
}
VLOG(1) << "Create File";
ASSERT_TRUE(WriteFile(file, "content"));
VLOG(1) << "Waiting for file creation";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(WriteFile(file, "content v2"));
VLOG(1) << "Waiting for file modification";
ASSERT_TRUE(WaitForEvents());
}
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_DisappearingDirectory DISABLED_DisappearingDirectory
#else
#define MAYBE_DisappearingDirectory DisappearingDirectory
#endif
TEST_F(FilePathWatcherTest, MAYBE_DisappearingDirectory) {
FilePathWatcher watcher;
FilePath dir(temp_dir_.GetPath().AppendASCII("dir"));
FilePath file(dir.AppendASCII("file"));
ASSERT_TRUE(base::CreateDirectory(dir));
ASSERT_TRUE(WriteFile(file, "content"));
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(file, &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(base::DeletePathRecursively(dir));
ASSERT_TRUE(WaitForEvents());
}
// Tests that a file that is deleted and reappears is tracked correctly.
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_DeleteAndRecreate DISABLED_DeleteAndRecreate
#else
#define MAYBE_DeleteAndRecreate DeleteAndRecreate
#endif
TEST_F(FilePathWatcherTest, MAYBE_DeleteAndRecreate) {
ASSERT_TRUE(WriteFile(test_file(), "content"));
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(test_file(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(base::DeleteFile(test_file()));
VLOG(1) << "Waiting for file deletion";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(WriteFile(test_file(), "content"));
VLOG(1) << "Waiting for file creation";
ASSERT_TRUE(WaitForEvents());
}
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_WatchDirectory DISABLED_WatchDirectory
#else
#define MAYBE_WatchDirectory WatchDirectory
#endif
TEST_F(FilePathWatcherTest, MAYBE_WatchDirectory) {
FilePathWatcher watcher;
FilePath dir(temp_dir_.GetPath().AppendASCII("dir"));
FilePath file1(dir.AppendASCII("file1"));
FilePath file2(dir.AppendASCII("file2"));
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(dir, &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(base::CreateDirectory(dir));
VLOG(1) << "Waiting for directory creation";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(WriteFile(file1, "content"));
VLOG(1) << "Waiting for file1 creation";
ASSERT_TRUE(WaitForEvents());
#if !BUILDFLAG(IS_APPLE)
// Mac implementation does not detect files modified in a directory.
ASSERT_TRUE(WriteFile(file1, "content v2"));
VLOG(1) << "Waiting for file1 modification";
ASSERT_TRUE(WaitForEvents());
#endif // !BUILDFLAG(IS_APPLE)
ASSERT_TRUE(base::DeleteFile(file1));
VLOG(1) << "Waiting for file1 deletion";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(WriteFile(file2, "content"));
VLOG(1) << "Waiting for file2 creation";
ASSERT_TRUE(WaitForEvents());
}
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_MoveParent DISABLED_MoveParent
#else
#define MAYBE_MoveParent MoveParent
#endif
TEST_F(FilePathWatcherTest, MAYBE_MoveParent) {
FilePathWatcher file_watcher;
FilePathWatcher subdir_watcher;
FilePath dir(temp_dir_.GetPath().AppendASCII("dir"));
FilePath dest(temp_dir_.GetPath().AppendASCII("dest"));
FilePath subdir(dir.AppendASCII("subdir"));
FilePath file(subdir.AppendASCII("file"));
std::unique_ptr<TestDelegate> file_delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(file, &file_watcher, file_delegate.get(),
FilePathWatcher::Type::kNonRecursive));
std::unique_ptr<TestDelegate> subdir_delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(subdir, &subdir_watcher, subdir_delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Setup a directory hierarchy.
ASSERT_TRUE(base::CreateDirectory(subdir));
ASSERT_TRUE(WriteFile(file, "content"));
VLOG(1) << "Waiting for file creation";
ASSERT_TRUE(WaitForEvents());
// Move the parent directory.
base::Move(dir, dest);
VLOG(1) << "Waiting for directory move";
ASSERT_TRUE(WaitForEvents());
}
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_RecursiveWatch DISABLED_RecursiveWatch
#else
#define MAYBE_RecursiveWatch RecursiveWatch
#endif
TEST_F(FilePathWatcherTest, MAYBE_RecursiveWatch) {
FilePathWatcher watcher;
FilePath dir(temp_dir_.GetPath().AppendASCII("dir"));
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
bool setup_result = SetupWatch(dir, &watcher, delegate.get(),
FilePathWatcher::Type::kRecursive);
if (!FilePathWatcher::RecursiveWatchAvailable()) {
ASSERT_FALSE(setup_result);
return;
}
ASSERT_TRUE(setup_result);
// Main directory("dir") creation.
ASSERT_TRUE(base::CreateDirectory(dir));
ASSERT_TRUE(WaitForEvents());
// Create "$dir/file1".
FilePath file1(dir.AppendASCII("file1"));
ASSERT_TRUE(WriteFile(file1, "content"));
ASSERT_TRUE(WaitForEvents());
// Create "$dir/subdir".
FilePath subdir(dir.AppendASCII("subdir"));
ASSERT_TRUE(base::CreateDirectory(subdir));
ASSERT_TRUE(WaitForEvents());
// Create "$dir/subdir/subdir2".
FilePath subdir2(subdir.AppendASCII("subdir2"));
ASSERT_TRUE(base::CreateDirectory(subdir2));
ASSERT_TRUE(WaitForEvents());
// Rename "$dir/subdir/subdir2" to "$dir/subdir/subdir2b".
FilePath subdir2b(subdir.AppendASCII("subdir2b"));
base::Move(subdir2, subdir2b);
ASSERT_TRUE(WaitForEvents());
// Mac and Win don't generate events for Touch.
// Android TouchFile returns false.
#if !(BUILDFLAG(IS_APPLE) || BUILDFLAG(IS_WIN) || BUILDFLAG(IS_ANDROID))
// Touch "$dir".
Time access_time;
ASSERT_TRUE(Time::FromString("Wed, 16 Nov 1994, 00:00:00", &access_time));
ASSERT_TRUE(base::TouchFile(dir, access_time, access_time));
ASSERT_TRUE(WaitForEvents());
#endif // !(BUILDFLAG(IS_APPLE) || BUILDFLAG(IS_WIN) || BUILDFLAG(IS_ANDROID))
// Create "$dir/subdir/subdir_file1".
FilePath subdir_file1(subdir.AppendASCII("subdir_file1"));
ASSERT_TRUE(WriteFile(subdir_file1, "content"));
ASSERT_TRUE(WaitForEvents());
// Create "$dir/subdir/subdir_child_dir".
FilePath subdir_child_dir(subdir.AppendASCII("subdir_child_dir"));
ASSERT_TRUE(base::CreateDirectory(subdir_child_dir));
ASSERT_TRUE(WaitForEvents());
// Create "$dir/subdir/subdir_child_dir/child_dir_file1".
FilePath child_dir_file1(subdir_child_dir.AppendASCII("child_dir_file1"));
ASSERT_TRUE(WriteFile(child_dir_file1, "content v2"));
ASSERT_TRUE(WaitForEvents());
// Write into "$dir/subdir/subdir_child_dir/child_dir_file1".
ASSERT_TRUE(WriteFile(child_dir_file1, "content"));
ASSERT_TRUE(WaitForEvents());
// Apps cannot change file attributes on Android in /sdcard as /sdcard uses the
// "fuse" file system, while /data uses "ext4". Running these tests in /data
// would be preferable and allow testing file attributes and symlinks.
// TODO(pauljensen): Re-enable when crbug.com/475568 is fixed and SetUp() places
// the |temp_dir_| in /data.
#if !BUILDFLAG(IS_ANDROID)
// Modify "$dir/subdir/subdir_child_dir/child_dir_file1" attributes.
ASSERT_TRUE(base::MakeFileUnreadable(child_dir_file1));
ASSERT_TRUE(WaitForEvents());
#endif
// Delete "$dir/subdir/subdir_file1".
ASSERT_TRUE(base::DeleteFile(subdir_file1));
ASSERT_TRUE(WaitForEvents());
// Delete "$dir/subdir/subdir_child_dir/child_dir_file1".
ASSERT_TRUE(base::DeleteFile(child_dir_file1));
ASSERT_TRUE(WaitForEvents());
}
#if BUILDFLAG(IS_POSIX) && !BUILDFLAG(IS_ANDROID)
// Apps cannot create symlinks on Android in /sdcard as /sdcard uses the
// "fuse" file system, while /data uses "ext4". Running these tests in /data
// would be preferable and allow testing file attributes and symlinks.
// TODO(pauljensen): Re-enable when crbug.com/475568 is fixed and SetUp() places
// the |temp_dir_| in /data.
//
// This test is disabled on Fuchsia since it doesn't support symlinking.
TEST_F(FilePathWatcherTest, RecursiveWithSymLink) {
if (!FilePathWatcher::RecursiveWatchAvailable())
return;
FilePathWatcher watcher;
FilePath test_dir(temp_dir_.GetPath().AppendASCII("test_dir"));
ASSERT_TRUE(base::CreateDirectory(test_dir));
FilePath symlink(test_dir.AppendASCII("symlink"));
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(symlink, &watcher, delegate.get(),
FilePathWatcher::Type::kRecursive));
// Link creation.
FilePath target1(temp_dir_.GetPath().AppendASCII("target1"));
ASSERT_TRUE(base::CreateSymbolicLink(target1, symlink));
ASSERT_TRUE(WaitForEvents());
// Target1 creation.
ASSERT_TRUE(base::CreateDirectory(target1));
ASSERT_TRUE(WaitForEvents());
// Create a file in target1.
FilePath target1_file(target1.AppendASCII("file"));
ASSERT_TRUE(WriteFile(target1_file, "content"));
ASSERT_TRUE(WaitForEvents());
// Link change.
FilePath target2(temp_dir_.GetPath().AppendASCII("target2"));
ASSERT_TRUE(base::CreateDirectory(target2));
ASSERT_TRUE(base::DeleteFile(symlink));
ASSERT_TRUE(base::CreateSymbolicLink(target2, symlink));
ASSERT_TRUE(WaitForEvents());
// Create a file in target2.
FilePath target2_file(target2.AppendASCII("file"));
ASSERT_TRUE(WriteFile(target2_file, "content"));
ASSERT_TRUE(WaitForEvents());
}
#endif // BUILDFLAG(IS_POSIX) && !BUILDFLAG(IS_ANDROID)
#if BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
#define MAYBE_MoveChild DISABLED_MoveChild
#else
#define MAYBE_MoveChild MoveChild
#endif
TEST_F(FilePathWatcherTest, MAYBE_MoveChild) {
FilePathWatcher file_watcher;
FilePathWatcher subdir_watcher;
FilePath source_dir(temp_dir_.GetPath().AppendASCII("source"));
FilePath source_subdir(source_dir.AppendASCII("subdir"));
FilePath source_file(source_subdir.AppendASCII("file"));
FilePath dest_dir(temp_dir_.GetPath().AppendASCII("dest"));
FilePath dest_subdir(dest_dir.AppendASCII("subdir"));
FilePath dest_file(dest_subdir.AppendASCII("file"));
// Setup a directory hierarchy.
ASSERT_TRUE(base::CreateDirectory(source_subdir));
ASSERT_TRUE(WriteFile(source_file, "content"));
std::unique_ptr<TestDelegate> file_delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(dest_file, &file_watcher, file_delegate.get(),
FilePathWatcher::Type::kNonRecursive));
std::unique_ptr<TestDelegate> subdir_delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(dest_subdir, &subdir_watcher, subdir_delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Move the directory into place, s.t. the watched file appears.
ASSERT_TRUE(base::Move(source_dir, dest_dir));
ASSERT_TRUE(WaitForEvents());
}
// Verify that changing attributes on a file is caught
#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_FUCHSIA)
// TODO(crbug.com/851641): Re-enable for Fuchsia when inotify is fixed.
// Apps cannot change file attributes on Android in /sdcard as /sdcard uses the
// "fuse" file system, while /data uses "ext4". Running these tests in /data
// would be preferable and allow testing file attributes and symlinks.
// TODO(pauljensen): Re-enable when crbug.com/475568 is fixed and SetUp() places
// the |temp_dir_| in /data.
#define MAYBE_FileAttributesChanged DISABLED_FileAttributesChanged
#else
#define MAYBE_FileAttributesChanged FileAttributesChanged
#endif // BUILDFLAG(IS_ANDROID)
TEST_F(FilePathWatcherTest, MAYBE_FileAttributesChanged) {
ASSERT_TRUE(WriteFile(test_file(), "content"));
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(test_file(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Now make sure we get notified if the file is modified.
ASSERT_TRUE(base::MakeFileUnreadable(test_file()));
ASSERT_TRUE(WaitForEvents());
}
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
// Verify that creating a symlink is caught.
TEST_F(FilePathWatcherTest, CreateLink) {
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
// Note that we are watching the symlink
ASSERT_TRUE(SetupWatch(test_link(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Now make sure we get notified if the link is created.
// Note that test_file() doesn't have to exist.
ASSERT_TRUE(CreateSymbolicLink(test_file(), test_link()));
ASSERT_TRUE(WaitForEvents());
}
// Verify that deleting a symlink is caught.
TEST_F(FilePathWatcherTest, DeleteLink) {
// Unfortunately this test case only works if the link target exists.
// TODO(craig) fix this as part of crbug.com/91561.
ASSERT_TRUE(WriteFile(test_file(), "content"));
ASSERT_TRUE(CreateSymbolicLink(test_file(), test_link()));
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(SetupWatch(test_link(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Now make sure we get notified if the link is deleted.
ASSERT_TRUE(base::DeleteFile(test_link()));
ASSERT_TRUE(WaitForEvents());
}
// Verify that modifying a target file that a link is pointing to
// when we are watching the link is caught.
TEST_F(FilePathWatcherTest, ModifiedLinkedFile) {
ASSERT_TRUE(WriteFile(test_file(), "content"));
ASSERT_TRUE(CreateSymbolicLink(test_file(), test_link()));
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
// Note that we are watching the symlink.
ASSERT_TRUE(SetupWatch(test_link(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Now make sure we get notified if the file is modified.
ASSERT_TRUE(WriteFile(test_file(), "new content"));
ASSERT_TRUE(WaitForEvents());
}
// Verify that creating a target file that a link is pointing to
// when we are watching the link is caught.
TEST_F(FilePathWatcherTest, CreateTargetLinkedFile) {
ASSERT_TRUE(CreateSymbolicLink(test_file(), test_link()));
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
// Note that we are watching the symlink.
ASSERT_TRUE(SetupWatch(test_link(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Now make sure we get notified if the target file is created.
ASSERT_TRUE(WriteFile(test_file(), "content"));
ASSERT_TRUE(WaitForEvents());
}
// Verify that deleting a target file that a link is pointing to
// when we are watching the link is caught.
TEST_F(FilePathWatcherTest, DeleteTargetLinkedFile) {
ASSERT_TRUE(WriteFile(test_file(), "content"));
ASSERT_TRUE(CreateSymbolicLink(test_file(), test_link()));
FilePathWatcher watcher;
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
// Note that we are watching the symlink.
ASSERT_TRUE(SetupWatch(test_link(), &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
// Now make sure we get notified if the target file is deleted.
ASSERT_TRUE(base::DeleteFile(test_file()));
ASSERT_TRUE(WaitForEvents());
}
// Verify that watching a file whose parent directory is a link that
// doesn't exist yet works if the symlink is created eventually.
TEST_F(FilePathWatcherTest, LinkedDirectoryPart1) {
FilePathWatcher watcher;
FilePath dir(temp_dir_.GetPath().AppendASCII("dir"));
FilePath link_dir(temp_dir_.GetPath().AppendASCII("dir.lnk"));
FilePath file(dir.AppendASCII("file"));
FilePath linkfile(link_dir.AppendASCII("file"));
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
// dir/file should exist.
ASSERT_TRUE(base::CreateDirectory(dir));
ASSERT_TRUE(WriteFile(file, "content"));
// Note that we are watching dir.lnk/file which doesn't exist yet.
ASSERT_TRUE(SetupWatch(linkfile, &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(CreateSymbolicLink(dir, link_dir));
VLOG(1) << "Waiting for link creation";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(WriteFile(file, "content v2"));
VLOG(1) << "Waiting for file change";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(base::DeleteFile(file));
VLOG(1) << "Waiting for file deletion";
ASSERT_TRUE(WaitForEvents());
}
// Verify that watching a file whose parent directory is a
// dangling symlink works if the directory is created eventually.
TEST_F(FilePathWatcherTest, LinkedDirectoryPart2) {
FilePathWatcher watcher;
FilePath dir(temp_dir_.GetPath().AppendASCII("dir"));
FilePath link_dir(temp_dir_.GetPath().AppendASCII("dir.lnk"));
FilePath file(dir.AppendASCII("file"));
FilePath linkfile(link_dir.AppendASCII("file"));
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
// Now create the link from dir.lnk pointing to dir but
// neither dir nor dir/file exist yet.
ASSERT_TRUE(CreateSymbolicLink(dir, link_dir));
// Note that we are watching dir.lnk/file.
ASSERT_TRUE(SetupWatch(linkfile, &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(base::CreateDirectory(dir));
ASSERT_TRUE(WriteFile(file, "content"));
VLOG(1) << "Waiting for dir/file creation";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(WriteFile(file, "content v2"));
VLOG(1) << "Waiting for file change";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(base::DeleteFile(file));
VLOG(1) << "Waiting for file deletion";
ASSERT_TRUE(WaitForEvents());
}
// Verify that watching a file with a symlink on the path
// to the file works.
TEST_F(FilePathWatcherTest, LinkedDirectoryPart3) {
FilePathWatcher watcher;
FilePath dir(temp_dir_.GetPath().AppendASCII("dir"));
FilePath link_dir(temp_dir_.GetPath().AppendASCII("dir.lnk"));
FilePath file(dir.AppendASCII("file"));
FilePath linkfile(link_dir.AppendASCII("file"));
std::unique_ptr<TestDelegate> delegate(new TestDelegate(collector()));
ASSERT_TRUE(base::CreateDirectory(dir));
ASSERT_TRUE(CreateSymbolicLink(dir, link_dir));
// Note that we are watching dir.lnk/file but the file doesn't exist yet.
ASSERT_TRUE(SetupWatch(linkfile, &watcher, delegate.get(),
FilePathWatcher::Type::kNonRecursive));
ASSERT_TRUE(WriteFile(file, "content"));
VLOG(1) << "Waiting for file creation";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(WriteFile(file, "content v2"));
VLOG(1) << "Waiting for file change";
ASSERT_TRUE(WaitForEvents());
ASSERT_TRUE(base::DeleteFile(file));
VLOG(1) << "Waiting for file deletion";
ASSERT_TRUE(WaitForEvents());
}
// Regression tests that FilePathWatcherImpl does not leave its reference in
// `g_inotify_reader` due to a race in recursive watch.
// See https://crbug.com/990004.
TEST_F(FilePathWatcherTest, RacyRecursiveWatch) {
if (!FilePathWatcher::RecursiveWatchAvailable())
GTEST_SKIP();
FilePath dir(temp_dir_.GetPath().AppendASCII("dir"));
// Create and delete many subdirs. 20 is an arbitrary number big enough
// to have more chances to make FilePathWatcherImpl leak watchers.
std::vector<FilePath> subdirs;
for (int i = 0; i < 20; ++i)
subdirs.emplace_back(dir.AppendASCII(base::StringPrintf("subdir_%d", i)));
Thread subdir_updater("SubDir Updater");
ASSERT_TRUE(subdir_updater.Start());
auto subdir_update_task = base::BindLambdaForTesting([&]() {
for (const auto& subdir : subdirs) {
// First update event to trigger watch callback.
ASSERT_TRUE(CreateDirectory(subdir));
// Second update event. The notification sent for this event will race
// with the upcoming deletion of the directory below. This test is about
// verifying that the impl handles this.
FilePath subdir_file(subdir.AppendASCII("subdir_file"));
ASSERT_TRUE(WriteFile(subdir_file, "content"));
// Racy subdir delete to trigger watcher leak.
ASSERT_TRUE(DeletePathRecursively(subdir));
}
});
// Try the racy subdir update 100 times.
for (int i = 0; i < 100; ++i) {
RunLoop run_loop;
auto watcher = std::make_unique<FilePathWatcher>();
// Keep watch callback in `watcher_callback` so that "watcher.reset()"
// inside does not release the callback and the lambda capture with it.
// Otherwise, accessing `run_loop` as part of the lamda capture would be
// use-after-free under asan.
auto watcher_callback =
base::BindLambdaForTesting([&](const FilePath& path, bool error) {
// Release watchers in callback so that the leaked watchers of
// the subdir stays. Otherwise, when the subdir is deleted,
// its delete event would clean up leaked watchers in
// `g_inotify_reader`.
watcher.reset();
run_loop.Quit();
});
bool setup_result = watcher->Watch(dir, FilePathWatcher::Type::kRecursive,
watcher_callback);
ASSERT_TRUE(setup_result);
subdir_updater.task_runner()->PostTask(FROM_HERE, subdir_update_task);
// Wait for the watch callback.
run_loop.Run();
// `watcher` should have been released.
ASSERT_FALSE(watcher);
// There should be no outstanding watchers.
ASSERT_FALSE(FilePathWatcher::HasWatchesForTest());
}
}
// Verify that "Watch()" returns false and callback is not invoked when limit is
// hit during setup.
TEST_F(FilePathWatcherTest, InotifyLimitInWatch) {
auto watcher = std::make_unique<FilePathWatcher>();
// "test_file()" is like "/tmp/__unique_path__/FilePathWatcherTest" and has 4
// dir components ("/" + 3 named parts). "Watch()" creates inotify watches
// for each dir component of the given dir. It would fail with limit set to 1.
ScopedMaxNumberOfInotifyWatchesOverrideForTest max_inotify_watches(1);
ASSERT_FALSE(watcher->Watch(
test_file(), FilePathWatcher::Type::kNonRecursive,
base::BindLambdaForTesting(
[&](const FilePath& path, bool error) { ADD_FAILURE(); })));
// Triggers update but callback should not be invoked.
ASSERT_TRUE(WriteFile(test_file(), "content"));
// Ensures that the callback did not happen.
base::RunLoop().RunUntilIdle();