File: fswatchertest.cpp

package info (click to toggle)
wxpython4.0 4.2.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 221,752 kB
  • sloc: cpp: 962,555; python: 230,573; ansic: 170,731; makefile: 51,756; sh: 9,342; perl: 1,564; javascript: 584; php: 326; xml: 200
file content (921 lines) | stat: -rw-r--r-- 27,015 bytes parent folder | download | duplicates (3)
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
///////////////////////////////////////////////////////////////////////////////
// Name:        tests/fswatcher/fswatchertest.cpp
// Purpose:     wxFileSystemWatcher unit test
// Author:      Bartosz Bekier
// Created:     2009-06-11
// Copyright:   (c) 2009 Bartosz Bekier
///////////////////////////////////////////////////////////////////////////////

// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------

#include "testprec.h"


#ifndef WX_PRECOMP
    #include "wx/timer.h"
#endif

#if wxUSE_FSWATCHER

#include "wx/evtloop.h"
#include "wx/filename.h"
#include "wx/filefn.h"
#include "wx/fswatcher.h"
#include "wx/log.h"
#include "wx/scopedptr.h"
#include "wx/stdpaths.h"
#include "wx/vector.h"

#include "testfile.h"

// ----------------------------------------------------------------------------
// local functions
// ----------------------------------------------------------------------------

// class generating file system events
class EventGenerator
{
public:
    static EventGenerator& Get()
    {
        if (!ms_instance)
            ms_instance = new EventGenerator(GetWatchDir());

        return *ms_instance;
    }

    EventGenerator(const wxFileName& path) : m_base(path)
    {
        m_old = wxFileName();
        m_file = RandomName();
        m_new = RandomName();
    }

    // operations
    bool CreateFile()
    {
        wxFile file(m_file.GetFullPath(), wxFile::write);
        return file.IsOpened() && m_file.FileExists();
    }

    bool RenameFile()
    {
        REQUIRE(m_file.FileExists());

        wxLogDebug("Renaming %s=>%s", m_file.GetFullPath(), m_new.GetFullPath());

        bool ret = wxRenameFile(m_file.GetFullPath(), m_new.GetFullPath());
        if (ret)
        {
            m_old = m_file;
            m_file = m_new;
            m_new = RandomName();
        }

        return ret;
    }

    bool DeleteFile()
    {
        REQUIRE(m_file.FileExists());

        bool ret =  wxRemoveFile(m_file.GetFullPath());
        if (ret)
        {
            m_old = m_file;
            m_file = m_new;
            m_new = RandomName();
        }

        return ret;
    }

    bool TouchFile()
    {
        return m_file.Touch();
    }

    bool ReadFile()
    {
        wxFile f(m_file.GetFullPath());
        REQUIRE(f.IsOpened());

        char buf[1];
        ssize_t count = f.Read(buf, sizeof(buf));
        CHECK(count > 0);

        return true;
    }

    bool ModifyFile()
    {
        REQUIRE(m_file.FileExists());

        wxFile file(m_file.GetFullPath(), wxFile::write_append);
        REQUIRE(file.IsOpened());

        CHECK(file.Write("Words of Wisdom, Lloyd. Words of wisdom\n"));
        return file.Close();
    }

    // helpers
    wxFileName RandomName(int length = 10)
    {
        return RandomName(m_base, length);
    }

    // static helpers
    static const wxFileName& GetWatchDir()
    {
        if (ms_watchDir.DirExists())
            return ms_watchDir;

        wxString tmp = wxStandardPaths::Get().GetTempDir();
        ms_watchDir.AssignDir(tmp);

        // XXX look for more unique name? there is no function to generate
        // unique filename, the file always get created...
        ms_watchDir.AppendDir("fswatcher_test");
        REQUIRE(!ms_watchDir.DirExists());

        TestLogEnabler enableLogs;
        REQUIRE(ms_watchDir.Mkdir());

        REQUIRE(ms_watchDir.DirExists());

        return ms_watchDir;
    }

    static void RemoveWatchDir()
    {
        REQUIRE(ms_watchDir.DirExists());

        // just to be really sure we know what we remove
        REQUIRE( ms_watchDir.GetDirs().Last() == "fswatcher_test" );

        TestLogEnabler enableLogs;
        CHECK( ms_watchDir.Rmdir(wxPATH_RMDIR_RECURSIVE) );

        ms_watchDir = wxFileName();
    }

    static wxFileName RandomName(const wxFileName& base, int length = 10)
    {
        static int ALFA_CNT = 'z' - 'a';

        wxString s;
        for (int i = 0 ; i < length; ++i)
        {
            char c = 'a' + (rand() % ALFA_CNT);
            s += c;
        }

        return wxFileName(base.GetFullPath(), s);
    }

public:
    wxFileName m_base;     // base dir for doing operations
    wxFileName m_file;     // current file name
    wxFileName m_old;      // previous file name
    wxFileName m_new;      // name after renaming

protected:
    static EventGenerator* ms_instance;

private:
    static wxFileName ms_watchDir;
};

EventGenerator* EventGenerator::ms_instance = 0;
wxFileName EventGenerator::ms_watchDir;


// Abstract base class from which concrete event tests inherit.
//
// This class provides the common test skeleton which various virtual hooks
// that should or can be reimplemented by the derived classes.
class FSWTesterBase : public wxEvtHandler
{
public:
    FSWTesterBase(int types = wxFSW_EVENT_ALL) :
        eg(EventGenerator::Get()),
        m_eventTypes(types)
    {
        Bind(wxEVT_FSWATCHER, &FSWTesterBase::OnFileSystemEvent, this);

        // wxFileSystemWatcher can be created only once the event loop is
        // running, so we can't do it from here and will do it from inside the
        // loop when this event handler is invoked.
        CallAfter(&FSWTesterBase::OnIdleInit);
    }

    virtual ~FSWTesterBase()
    {
        if (m_loop.IsRunning())
            m_loop.Exit();
    }

    void Exit()
    {
        m_loop.Exit();
    }

    // sends idle event, so we get called in a moment
    void SendIdle()
    {
        wxIdleEvent* e = new wxIdleEvent();
        QueueEvent(e);
    }

    void Run()
    {
        m_loop.Run();
    }

    void OnIdleInit()
    {
        REQUIRE(Init());

        GenerateEvent();

        // Check the result when the next idle event comes: note that we can't
        // use CallAfter() here, unfortunately, because OnIdleCheckResult()
        // would then be called immediately, from the same event loop iteration
        // as we're called from, because the idle/pending events are processed
        // for as long as there any. Instead, we need to return to the event
        // loop itself to give it a chance to dispatch wxFileSystemWatcherEvent
        // and wait until our handler for it calls SendIdle() which will then
        // end up calling OnIdleCheckResult() afterwards.
        Bind(wxEVT_IDLE, &FSWTesterBase::OnIdleCheckResult, this);
    }

    void OnIdleCheckResult(wxIdleEvent& WXUNUSED(event))
    {
        Unbind(wxEVT_IDLE, &FSWTesterBase::OnIdleCheckResult, this);

        CheckResult();
        Exit();
    }

    virtual bool Init()
    {
        // test we're good to go
        CHECK(wxEventLoopBase::GetActive());

        // XXX only now can we construct Watcher, because we need
        // active loop here
        m_watcher.reset(new wxFileSystemWatcher());
        m_watcher->SetOwner(this);

        // add dir to be watched
        wxFileName dir = EventGenerator::GetWatchDir();
        CHECK(m_watcher->Add(dir, m_eventTypes));

        return true;
    }

    virtual void CheckResult()
    {
        REQUIRE( !m_events.empty() );

        const wxFileSystemWatcherEvent * const e = m_events.front();

        // this is our "reference event"
        const wxFileSystemWatcherEvent expected = ExpectedEvent();

        CHECK( e->GetChangeType() == expected.GetChangeType() );

        CHECK( e->GetEventType() == wxEVT_FSWATCHER );

        // XXX this needs change
        CHECK( e->GetEventCategory() == wxEVT_CATEGORY_UNKNOWN );

        CHECK( e->GetPath() == expected.GetPath() );
        CHECK( e->GetNewPath() == expected.GetNewPath() );

        // Under MSW extra modification events are sometimes reported after a
        // rename and we just can't get rid of them, so ignore them in this
        // test if they do happen.
        if ( e->GetChangeType() == wxFSW_EVENT_RENAME &&
                m_events.size() == 2 )
        {
            const wxFileSystemWatcherEvent* const e2 = m_events.back();
            if ( e2->GetChangeType() == wxFSW_EVENT_MODIFY &&
                    e2->GetPath() == e->GetNewPath() )
            {
                // This is a modify event for the new file, ignore it.
                return;
            }
        }

        WX_ASSERT_EQUAL_MESSAGE
        (
            (
                "Extra events received, last one is of type %x, path=\"%s\" "
                "(the original event was for \"%s\" (\"%s\")",
                m_events.back()->GetChangeType(),
                m_events.back()->GetPath().GetFullPath(),
                e->GetPath().GetFullPath(),
                e->GetNewPath().GetFullPath()
            ),
            1, m_events.size()
        );

        delete e;
    }

    virtual void GenerateEvent() = 0;

    virtual wxFileSystemWatcherEvent ExpectedEvent() = 0;


protected:
    EventGenerator& eg;
    wxEventLoop m_loop;    // loop reference

    wxScopedPtr<wxFileSystemWatcher> m_watcher;

    int m_eventTypes;  // Which event-types to watch. Normally all of them

    wxVector<wxFileSystemWatcherEvent*> m_events;

private:
    void OnFileSystemEvent(wxFileSystemWatcherEvent& evt)
    {
        wxLogDebug("--- %s ---", evt.ToString());
        m_events.push_back(wxDynamicCast(evt.Clone(), wxFileSystemWatcherEvent));

        // test finished
        SendIdle();
    }
};


// ----------------------------------------------------------------------------
// test fixture
// ----------------------------------------------------------------------------

class FileSystemWatcherTestCase
{
public:
    FileSystemWatcherTestCase()
    {
        // Before each test, remove the dir if it exists.
        // It would exist if the previous test run was aborted.
        wxString tmp = wxStandardPaths::Get().GetTempDir();
        wxFileName dir;
        dir.AssignDir(tmp);
        dir.AppendDir("fswatcher_test");
        dir.Rmdir(wxPATH_RMDIR_RECURSIVE);
        EventGenerator::Get().GetWatchDir();
    }

    ~FileSystemWatcherTestCase()
    {
        EventGenerator::Get().RemoveWatchDir();
    }
};

// ----------------------------------------------------------------------------
// TestEventCreate
// ----------------------------------------------------------------------------

TEST_CASE_METHOD(FileSystemWatcherTestCase,
                 "wxFileSystemWatcher::EventCreate", "[fsw]")
{
    class EventTester : public FSWTesterBase
    {
    public:
        virtual void GenerateEvent() wxOVERRIDE
        {
            CHECK(eg.CreateFile());
        }

        virtual wxFileSystemWatcherEvent ExpectedEvent() wxOVERRIDE
        {
            wxFileSystemWatcherEvent event(wxFSW_EVENT_CREATE);
            event.SetPath(eg.m_file);
            event.SetNewPath(eg.m_file);
            return event;
        }
    };

    EventTester tester;

    tester.Run();
}

// ----------------------------------------------------------------------------
// TestEventDelete
// ----------------------------------------------------------------------------

TEST_CASE_METHOD(FileSystemWatcherTestCase,
                 "wxFileSystemWatcher::EventDelete", "[fsw]")
{
    class EventTester : public FSWTesterBase
    {
    public:
        virtual void GenerateEvent() wxOVERRIDE
        {
            CHECK(eg.DeleteFile());
        }

        virtual wxFileSystemWatcherEvent ExpectedEvent() wxOVERRIDE
        {
            wxFileSystemWatcherEvent event(wxFSW_EVENT_DELETE);
            event.SetPath(eg.m_old);

            // CHECK maybe new path here could be NULL or sth?
            event.SetNewPath(eg.m_old);
            return event;
        }
    };

    // we need to create a file now, so we can delete it
    EventGenerator::Get().CreateFile();

    EventTester tester;
    tester.Run();
}

// kqueue-based implementation doesn't collapse create/delete pairs in
// renames and detects neither modifications nor access to the
// files reliably currently so disable these tests
//
// FIXME: fix the code and reenable them
#ifndef wxHAS_KQUEUE

// ----------------------------------------------------------------------------
// TestEventRename
// ----------------------------------------------------------------------------

TEST_CASE_METHOD(FileSystemWatcherTestCase,
                 "wxFileSystemWatcher::EventRename", "[fsw]")
{
    class EventTester : public FSWTesterBase
    {
    public:
        virtual void GenerateEvent() wxOVERRIDE
        {
            CHECK(eg.RenameFile());
        }

        virtual wxFileSystemWatcherEvent ExpectedEvent() wxOVERRIDE
        {
            wxFileSystemWatcherEvent event(wxFSW_EVENT_RENAME);
            event.SetPath(eg.m_old);
            event.SetNewPath(eg.m_file);
            return event;
        }
    };

    // need a file to rename later
    EventGenerator::Get().CreateFile();

    EventTester tester;
    tester.Run();
}

// ----------------------------------------------------------------------------
// TestEventModify
// ----------------------------------------------------------------------------

TEST_CASE_METHOD(FileSystemWatcherTestCase,
                 "wxFileSystemWatcher::EventModify", "[fsw]")
{
    class EventTester : public FSWTesterBase
    {
    public:
        virtual void GenerateEvent() wxOVERRIDE
        {
            CHECK(eg.ModifyFile());
        }

        virtual wxFileSystemWatcherEvent ExpectedEvent() wxOVERRIDE
        {
            wxFileSystemWatcherEvent event(wxFSW_EVENT_MODIFY);
            event.SetPath(eg.m_file);
            event.SetNewPath(eg.m_file);
            return event;
        }
    };

    // we need to create a file to modify
    EventGenerator::Get().CreateFile();

    EventTester tester;
    tester.Run();
}

// MSW implementation doesn't detect file access events currently
#ifndef __WINDOWS__

// ----------------------------------------------------------------------------
// TestEventAccess
// ----------------------------------------------------------------------------

TEST_CASE_METHOD(FileSystemWatcherTestCase,
                 "wxFileSystemWatcher::EventAccess", "[fsw]")
{
    class EventTester : public FSWTesterBase
    {
    public:
        virtual void GenerateEvent() wxOVERRIDE
        {
            CHECK(eg.ReadFile());
        }

        virtual wxFileSystemWatcherEvent ExpectedEvent() wxOVERRIDE
        {
            wxFileSystemWatcherEvent event(wxFSW_EVENT_ACCESS);
            event.SetPath(eg.m_file);
            event.SetNewPath(eg.m_file);
            return event;
        }
    };

    // we need to create a file to read from it and write sth to it
    EventGenerator::Get().CreateFile();
    EventGenerator::Get().ModifyFile();

    EventTester tester;
    tester.Run();
}

#endif // __WINDOWS__

#endif // !wxHAS_KQUEUE

#ifdef wxHAS_INOTIFY
// ----------------------------------------------------------------------------
// TestEventAttribute
// ----------------------------------------------------------------------------
TEST_CASE_METHOD(FileSystemWatcherTestCase,
                 "wxFileSystemWatcher::EventAttribute", "[fsw]")
{
    class EventTester : public FSWTesterBase
    {
    public:
        virtual void GenerateEvent() wxOVERRIDE
        {
            CHECK(eg.TouchFile());
        }

        virtual wxFileSystemWatcherEvent ExpectedEvent() wxOVERRIDE
        {
            wxFileSystemWatcherEvent event(wxFSW_EVENT_ATTRIB);
            event.SetPath(eg.m_file);
            event.SetNewPath(eg.m_file);
            return event;
        }
    };

    // we need to create a file to touch
    EventGenerator::Get().CreateFile();

    EventTester tester;
    tester.Run();
}

// ----------------------------------------------------------------------------
// TestSingleWatchtypeEvent: Watch only wxFSW_EVENT_ACCESS
// ----------------------------------------------------------------------------

TEST_CASE_METHOD(FileSystemWatcherTestCase,
                 "wxFileSystemWatcher::SingleWatchtypeEvent", "[fsw]")
{
    class EventTester : public FSWTesterBase
    {
    public:
        // We could pass wxFSW_EVENT_CREATE or MODIFY instead, but not RENAME or
        // DELETE as the event path fields would be wrong in CheckResult()
        EventTester() : FSWTesterBase(wxFSW_EVENT_ACCESS) {}

        virtual void GenerateEvent() wxOVERRIDE
        {
            // As wxFSW_EVENT_ACCESS is passed to the ctor only ReadFile() will
            // generate an event. Without it they all will, and the test fails
            CHECK(eg.CreateFile());
            CHECK(eg.ModifyFile());
            CHECK(eg.ReadFile());
        }

        virtual wxFileSystemWatcherEvent ExpectedEvent() wxOVERRIDE
        {
            wxFileSystemWatcherEvent event(wxFSW_EVENT_ACCESS);
            event.SetPath(eg.m_file);
            event.SetNewPath(eg.m_file);
            return event;
        }
    };

    EventTester tester;
    tester.Run();
}
#endif // wxHAS_INOTIFY

// ----------------------------------------------------------------------------
// TestTrees
// ----------------------------------------------------------------------------

TEST_CASE_METHOD(FileSystemWatcherTestCase,
                 "wxFileSystemWatcher::Trees", "[fsw]")
{
    class TreeTester : public FSWTesterBase
    {
        const size_t subdirs;
        const size_t files;

    public:
        TreeTester() : subdirs(5), files(3) {}

        void GrowTree(wxFileName dir
#ifdef __UNIX__
                      , bool withSymlinks = false
#endif
                      )
        {
            REQUIRE(dir.Mkdir());
            // Now add a subdir with an easy name to remember in WatchTree()
            dir.AppendDir("child");
            REQUIRE(dir.Mkdir());
            wxFileName child(dir);  // Create a copy to which to symlink

            // Create a branch of 5 numbered subdirs, each containing 3
            // numbered files
            for ( unsigned d = 0; d < subdirs; ++d )
            {
                dir.AppendDir(wxString::Format("subdir%u", d+1));
                REQUIRE(dir.Mkdir());

                const wxString prefix = dir.GetPathWithSep();
                const wxString ext[] = { ".txt", ".log", "" };
                for ( unsigned f = 0; f < files; ++f )
                {
                    // Just create the files.
                    wxFile(prefix + wxString::Format("file%u", f+1) + ext[f],
                           wxFile::write);
                }
#if defined(__UNIX__)
                if ( withSymlinks )
                {
                    // Create a symlink to a files, and another to 'child'
                    CHECK
                    (
                        symlink(wxString(prefix + "file1").c_str(),
                                wxString(prefix + "file.lnk").c_str()) == 0
                    );

                    CHECK
                    (
                        symlink(child.GetFullPath().c_str(),
                                wxString(prefix + "dir.lnk").c_str()) == 0
                    );
                }
#endif // __UNIX__
            }
        }

        void RmDir(wxFileName dir)
        {
            REQUIRE(dir.DirExists());

            CHECK(dir.Rmdir(wxPATH_RMDIR_RECURSIVE));
        }

        void WatchDir(wxFileName dir)
        {
            REQUIRE(m_watcher);

            // Store the initial count; there may already be some watches
            const int initial = m_watcher->GetWatchedPathsCount();

            m_watcher->Add(dir);
            CHECK( m_watcher->GetWatchedPathsCount() == initial + 1 );
        }

        void RemoveSingleWatch(wxFileName dir)
        {
            REQUIRE(m_watcher);

            const int initial = m_watcher->GetWatchedPathsCount();

            m_watcher->Remove(dir);
            CHECK( m_watcher->GetWatchedPathsCount() == initial - 1 );
        }

        void WatchTree(const wxFileName& dir)
        {
            REQUIRE(m_watcher);

            int treeitems = 1; // the trunk
#if !defined(__WINDOWS__) && !defined(wxHAVE_FSEVENTS_FILE_NOTIFICATIONS)
            // When there's no file mask, wxMSW and wxOSX set a single watch
            // on the trunk which is implemented recursively.
            // wxGTK always sets an additional watch for each subdir
            treeitems += subdirs + 1; // +1 for 'child'
#endif // !__WINDOWS__ && !wxHAVE_FSEVENTS_FILE_NOTIFICATIONS

            // Store the initial count; there may already be some watches
            const int initial = m_watcher->GetWatchedPathsCount();

            GrowTree(dir);

            m_watcher->AddTree(dir);
            const int plustree = m_watcher->GetWatchedPathsCount();

            CHECK( plustree == initial + treeitems );

            m_watcher->RemoveTree(dir);
            CHECK( m_watcher->GetWatchedPathsCount() == initial );

            // Now test the refcount mechanism by watching items more than once
            wxFileName child(dir);
            child.AppendDir("child");
            m_watcher->AddTree(child);
            // Check some watches were added; we don't care about the number
            CHECK(initial < m_watcher->GetWatchedPathsCount());
            // Now watch the whole tree and check that the count is the same
            // as it was the first time, despite also adding 'child' separately
            // Except that in wxMSW this isn't true: each watch will be a
            // single, recursive dir; so fudge the count
            int fudge = 0;
#if defined(__WINDOWS__) || defined(wxHAVE_FSEVENTS_FILE_NOTIFICATIONS)
            fudge = 1;
#endif // __WINDOWS__ || wxHAVE_FSEVENTS_FILE_NOTIFICATIONS
            m_watcher->AddTree(dir);
            CHECK( m_watcher->GetWatchedPathsCount() == plustree + fudge );
            m_watcher->RemoveTree(child);
            CHECK(initial < m_watcher->GetWatchedPathsCount());
            m_watcher->RemoveTree(dir);
            CHECK( m_watcher->GetWatchedPathsCount() == initial );
#if defined(__UNIX__)
            // Finally, test a tree containing internal symlinks
            RmDir(dir);
            GrowTree(dir, true /* test symlinks */);

            // Without the DontFollowLink() call AddTree() would now assert
            // (and without the assert, it would infinitely loop)
            wxFileName fn = dir;
            fn.DontFollowLink();
            CHECK(m_watcher->AddTree(fn));
            CHECK(m_watcher->RemoveTree(fn));

            // Regrow the tree without symlinks, ready for the next test
            RmDir(dir);
            GrowTree(dir, false);
#endif // __UNIX__
        }

        void WatchTreeWithFilespec(const wxFileName& dir)
        {
            REQUIRE(m_watcher);
            REQUIRE(dir.DirExists()); // Was built in WatchTree()

            // Store the initial count; there may already be some watches
            const int initial = m_watcher->GetWatchedPathsCount();

            // When we use a filter, both wxMSW and wxGTK implementations set
            // an additional watch for each subdir (+1 for the root dir itself
            // and another +1 for "child").
            // On OS X, if we use FSEvents then we still only have 1 watch.
#ifdef wxHAVE_FSEVENTS_FILE_NOTIFICATIONS
            const int treeitems = 1;
#else
            const int treeitems = subdirs + 2;
#endif
            m_watcher->AddTree(dir, wxFSW_EVENT_ALL, "*.txt");

            CHECK( m_watcher->GetWatchedPathsCount() == initial + treeitems );

            // RemoveTree should try to remove only those files that were added
            m_watcher->RemoveTree(dir);
            CHECK( m_watcher->GetWatchedPathsCount() == initial );
        }

        void RemoveAllWatches()
        {
            REQUIRE(m_watcher);

            m_watcher->RemoveAll();
            CHECK( m_watcher->GetWatchedPathsCount() == 0 );
        }

        virtual void GenerateEvent() wxOVERRIDE
        {
            // We don't use this function for events. Just run the tests

            wxFileName watchdir = EventGenerator::GetWatchDir();

            wxFileName treedir(watchdir);
            treedir.AppendDir("treetrunk");
            CHECK(!treedir.DirExists());

            wxFileName singledir(watchdir);
            singledir.AppendDir("single");
            CHECK(!singledir.DirExists());
            CHECK(singledir.Mkdir());

            WatchDir(singledir);
            WatchTree(treedir);
            // Now test adding and removing a tree using a filespec
            // wxMSW uses the generic method to add matching files; which fails
            // as it doesn't support adding files :/ So disable the test
#ifndef __WINDOWS__
            WatchTreeWithFilespec(treedir);
#endif // __WINDOWS__

            RemoveSingleWatch(singledir);
            // Add it back again, ready to test RemoveAll()
            WatchDir(singledir);

            RemoveAllWatches();

            // Clean up
            RmDir(treedir);
            RmDir(singledir);

            Exit();
        }

        virtual wxFileSystemWatcherEvent ExpectedEvent() wxOVERRIDE
        {
            FAIL("Shouldn't be called");

            return wxFileSystemWatcherEvent(wxFSW_EVENT_ERROR);
        }

        virtual void CheckResult() wxOVERRIDE
        {
            // Do nothing. We override this to prevent receiving events in
            // ExpectedEvent()
        }
    };

    TreeTester tester;

    tester.Run();
}


namespace
{

// We can't define this class locally inside TestNoEventsAfterRemove() for some
// reason with g++ 4.0 under OS X 10.5, it results in the following mysterious
// error:
//
// /var/tmp//ccTkNCkc.s:unknown:Non-global symbol:
// __ZThn80_ZN25FileSystemWatcherTestCase23TestNoEventsAfterRemoveEvEN11EventTester6NotifyEv.eh
// can't be a weak_definition
//
// So define this class outside the function instead.
class NoEventsAfterRemoveEventTester : public FSWTesterBase,
                                       public wxTimer
{
public:
    NoEventsAfterRemoveEventTester()
    {
        // We need to use an inactivity timer as we never get any file
        // system events in this test, so we consider that the test is
        // finished when this 1s timeout expires instead of, as usual,
        // stopping after getting the file system events.
        Start(1000, true);
    }

    virtual void GenerateEvent() wxOVERRIDE
    {
        m_watcher->Remove(EventGenerator::GetWatchDir());
        CHECK(eg.CreateFile());
    }

    virtual void CheckResult() wxOVERRIDE
    {
        REQUIRE( m_events.empty() );
    }

    virtual wxFileSystemWatcherEvent ExpectedEvent() wxOVERRIDE
    {
        FAIL( "Shouldn't be called" );

        return wxFileSystemWatcherEvent(wxFSW_EVENT_ERROR);
    }

    virtual void Notify() wxOVERRIDE
    {
        SendIdle();
    }
};

} // anonymous namespace

TEST_CASE_METHOD(FileSystemWatcherTestCase,
                 "wxFileSystemWatcher::NoEventsAfterRemove", "[fsw]")
{
    NoEventsAfterRemoveEventTester tester;
    tester.Run();
}

#endif // wxUSE_FSWATCHER