1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: tests/fswatcher/fswatchertest.cpp
3 // Purpose: wxFileSystemWatcher unit test
4 // Author: Bartosz Bekier
7 // Copyright: (c) 2009 Bartosz Bekier
8 ///////////////////////////////////////////////////////////////////////////////
10 // ----------------------------------------------------------------------------
12 // ----------------------------------------------------------------------------
24 #include "wx/evtloop.h"
25 #include "wx/filename.h"
26 #include "wx/filefn.h"
27 #include "wx/stdpaths.h"
28 #include "wx/fswatcher.h"
32 // ----------------------------------------------------------------------------
34 // ----------------------------------------------------------------------------
36 // class generating file system events
40 static EventGenerator
& Get()
43 ms_instance
= new EventGenerator(GetWatchDir());
48 EventGenerator(const wxFileName
& path
) : m_base(path
)
51 m_file
= RandomName();
58 wxFile
file(m_file
.GetFullPath(), wxFile
::write
);
59 return file
.IsOpened() && m_file
.FileExists();
64 CPPUNIT_ASSERT(m_file
.FileExists());
66 wxLogDebug("Renaming %s=>%s", m_file
.GetFullPath(), m_new
.GetFullPath());
68 bool ret
= wxRenameFile(m_file
.GetFullPath(), m_new
.GetFullPath());
81 CPPUNIT_ASSERT(m_file
.FileExists());
83 bool ret
= wxRemoveFile(m_file
.GetFullPath());
96 return m_file
.Touch();
101 wxFile
f(m_file
.GetFullPath());
102 CPPUNIT_ASSERT(f
.IsOpened());
105 ssize_t count
= f
.Read(buf
, sizeof(buf
));
106 CPPUNIT_ASSERT(count
> 0);
113 CPPUNIT_ASSERT(m_file
.FileExists());
115 wxFile
file(m_file
.GetFullPath(), wxFile
::write_append
);
116 CPPUNIT_ASSERT(file
.IsOpened());
118 CPPUNIT_ASSERT(file
.Write("Words of Wisdom, Lloyd. Words of wisdom\n"));
123 wxFileName
RandomName(int length
= 10)
125 return RandomName(m_base
, length
);
129 static const wxFileName
& GetWatchDir()
131 static wxFileName dir
;
136 wxString tmp
= wxStandardPaths
::Get().GetTempDir();
139 // XXX look for more unique name? there is no function to generate
140 // unique filename, the file always get created...
141 dir
.AppendDir("fswatcher_test");
142 CPPUNIT_ASSERT(!dir
.DirExists());
143 CPPUNIT_ASSERT(dir
.Mkdir());
148 static void RemoveWatchDir()
150 wxFileName dir
= GetWatchDir();
151 CPPUNIT_ASSERT(dir
.DirExists());
153 // just to be really sure we know what we remove
154 CPPUNIT_ASSERT_EQUAL( "fswatcher_test", dir
.GetDirs().Last() );
156 // FIXME-VC6: using non-static Rmdir() results in ICE
157 CPPUNIT_ASSERT( wxFileName
::Rmdir(dir
.GetFullPath(), wxPATH_RMDIR_RECURSIVE
) );
160 static wxFileName
RandomName(const wxFileName
& base
, int length
= 10)
162 static int ALFA_CNT
= 'z' - 'a';
165 for (int i
= 0 ; i
< length
; ++i
)
167 char c
= 'a' + (rand() % ALFA_CNT
);
171 return wxFileName(base
.GetFullPath(), s
);
175 wxFileName m_base
; // base dir for doing operations
176 wxFileName m_file
; // current file name
177 wxFileName m_old
; // previous file name
178 wxFileName m_new
; // name after renaming
181 static EventGenerator
* ms_instance
;
184 EventGenerator
* EventGenerator
::ms_instance
= 0;
187 // custom event handler
188 class EventHandler
: public wxEvtHandler
191 enum { WAIT_DURATION
= 3 };
194 eg(EventGenerator
::Get()), m_loop(0), m_count(0), m_watcher(0)
196 m_loop
= new wxEventLoop();
197 Connect(wxEVT_IDLE
, wxIdleEventHandler(EventHandler
::OnIdle
));
198 Connect(wxEVT_FSWATCHER
, wxFileSystemWatcherEventHandler(
199 EventHandler
::OnFileSystemEvent
));
202 virtual ~EventHandler()
207 if (m_loop
->IsRunning())
218 // sends idle event, so we get called in a moment
221 wxIdleEvent
* e
= new wxIdleEvent();
231 void OnIdle(wxIdleEvent
& /*evt*/)
233 bool more
= Action();
242 // returns whether we should produce more idle events
243 virtual bool Action()
248 CPPUNIT_ASSERT(Init());
259 // TODO a mechanism that will break the loop in case we
260 // don't receive a file system event
261 // this below doesn't quite work, so all tests must pass :-)
266 CPPUNIT_ASSERT(KeepWaiting());
272 CPPUNIT_ASSERT(AfterWait());
275 } // switch (m_count)
282 // test we're good to go
283 CPPUNIT_ASSERT(wxEventLoopBase
::GetActive());
285 // XXX only now can we construct Watcher, because we need
287 m_watcher
= new wxFileSystemWatcher();
288 m_watcher
->SetOwner(this);
290 // add dir to be watched
291 wxFileName dir
= EventGenerator
::GetWatchDir();
292 CPPUNIT_ASSERT(m_watcher
->Add(dir
, wxFSW_EVENT_ALL
));
297 virtual bool KeepWaiting()
299 // did we receive event already?
302 // well, let's wait a bit more
303 wxSleep(WAIT_DURATION
);
309 virtual bool AfterWait()
311 // fail if still no events
314 ("No events during %d seconds!", static_cast<int>(WAIT_DURATION
)),
321 virtual void OnFileSystemEvent(wxFileSystemWatcherEvent
& evt
)
323 wxLogDebug("--- %s ---", evt
.ToString());
324 m_lastEvent
= wxDynamicCast(evt
.Clone(), wxFileSystemWatcherEvent
);
325 m_events
.Add(m_lastEvent
);
332 virtual void CheckResult()
334 CPPUNIT_ASSERT_MESSAGE( "No events received", !m_events
.empty() );
336 const wxFileSystemWatcherEvent
* const e
= m_events
.front();
338 // this is our "reference event"
339 const wxFileSystemWatcherEvent expected
= ExpectedEvent();
341 CPPUNIT_ASSERT_EQUAL( expected
.GetChangeType(), e
->GetChangeType() );
343 CPPUNIT_ASSERT_EQUAL((int)wxEVT_FSWATCHER
, e
->GetEventType());
345 // XXX this needs change
346 CPPUNIT_ASSERT_EQUAL(wxEVT_CATEGORY_UNKNOWN
, e
->GetEventCategory());
348 CPPUNIT_ASSERT_EQUAL(expected
.GetPath(), e
->GetPath());
349 CPPUNIT_ASSERT_EQUAL(expected
.GetNewPath(), e
->GetNewPath());
351 // Under MSW extra modification events are sometimes reported after a
352 // rename and we just can't get rid of them, so ignore them in this
353 // test if they do happen.
354 if ( e
->GetChangeType() == wxFSW_EVENT_RENAME
&&
355 m_events
.size() == 2 )
357 const wxFileSystemWatcherEvent
* const e2
= m_events
.back();
358 if ( e2
->GetChangeType() == wxFSW_EVENT_MODIFY
&&
359 e2
->GetPath() == e
->GetNewPath() )
361 // This is a modify event for the new file, ignore it.
366 WX_ASSERT_EQUAL_MESSAGE
369 "Extra events received, last one is of type %x, path=\"%s\" "
370 "(the original event was for \"%s\" (\"%s\")",
371 m_events
.back()->GetChangeType(),
372 m_events
.back()->GetPath().GetFullPath(),
373 e
->GetPath().GetFullPath(),
374 e
->GetNewPath().GetFullPath()
381 virtual void GenerateEvent() = 0;
383 virtual wxFileSystemWatcherEvent
ExpectedEvent() = 0;
388 wxEventLoopBase
* m_loop
; // loop reference
389 int m_count
; // idle events count
391 wxFileSystemWatcher
* m_watcher
;
392 bool tested
; // indicates, whether we have already passed the test
394 #include "wx/arrimpl.cpp"
395 WX_DEFINE_ARRAY_PTR(wxFileSystemWatcherEvent
*, wxArrayEvent
);
396 wxArrayEvent m_events
;
397 wxFileSystemWatcherEvent
* m_lastEvent
;
401 // ----------------------------------------------------------------------------
403 // ----------------------------------------------------------------------------
405 class FileSystemWatcherTestCase
: public CppUnit
::TestCase
408 FileSystemWatcherTestCase() { }
410 virtual void setUp();
411 virtual void tearDown();
414 wxEventLoopBase
* m_loop
;
417 CPPUNIT_TEST_SUITE( FileSystemWatcherTestCase
);
418 CPPUNIT_TEST( TestEventCreate
);
419 CPPUNIT_TEST( TestEventDelete
);
420 CPPUNIT_TEST( TestTrees
);
422 // kqueue-based implementation doesn't collapse create/delete pairs in
423 // renames and doesn't detect neither modifications nor access to the
424 // files reliably currently so disable these tests
426 // FIXME: fix the code and reenable them
428 CPPUNIT_TEST( TestEventRename
);
429 CPPUNIT_TEST( TestEventModify
);
431 // MSW implementation doesn't detect file access events currently
433 CPPUNIT_TEST( TestEventAccess
);
434 #endif // __WINDOWS__
435 #endif // !wxHAS_KQUEUE
437 CPPUNIT_TEST( TestNoEventsAfterRemove
);
438 CPPUNIT_TEST_SUITE_END();
440 void TestEventCreate();
441 void TestEventDelete();
442 void TestEventRename();
443 void TestEventModify();
444 void TestEventAccess();
447 void TestNoEventsAfterRemove();
449 DECLARE_NO_COPY_CLASS(FileSystemWatcherTestCase
)
452 // the test currently hangs under OS X for some reason and this prevents tests
453 // ran by buildbot from completing so disable it until someone has time to
456 // FIXME: debug and fix this!
458 // register in the unnamed registry so that these tests are run by default
459 CPPUNIT_TEST_SUITE_REGISTRATION( FileSystemWatcherTestCase
);
462 // also include in its own registry so that these tests can be run alone
463 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( FileSystemWatcherTestCase
,
464 "FileSystemWatcherTestCase" );
466 void FileSystemWatcherTestCase
::setUp()
468 wxLog
::AddTraceMask(wxTRACE_FSWATCHER
);
469 EventGenerator
::Get().GetWatchDir();
472 void FileSystemWatcherTestCase
::tearDown()
474 EventGenerator
::Get().RemoveWatchDir();
477 // ----------------------------------------------------------------------------
479 // ----------------------------------------------------------------------------
480 void FileSystemWatcherTestCase
::TestEventCreate()
482 wxLogDebug("TestEventCreate()");
484 class EventTester
: public EventHandler
487 virtual void GenerateEvent()
489 CPPUNIT_ASSERT(eg
.CreateFile());
492 virtual wxFileSystemWatcherEvent
ExpectedEvent()
494 wxFileSystemWatcherEvent
event(wxFSW_EVENT_CREATE
);
495 event
.SetPath(eg
.m_file
);
496 event
.SetNewPath(eg
.m_file
);
503 wxLogTrace(wxTRACE_FSWATCHER
, "TestEventCreate tester created()");
508 // ----------------------------------------------------------------------------
510 // ----------------------------------------------------------------------------
511 void FileSystemWatcherTestCase
::TestEventDelete()
513 wxLogDebug("TestEventDelete()");
515 class EventTester
: public EventHandler
518 virtual void GenerateEvent()
520 CPPUNIT_ASSERT(eg
.DeleteFile());
523 virtual wxFileSystemWatcherEvent
ExpectedEvent()
525 wxFileSystemWatcherEvent
event(wxFSW_EVENT_DELETE
);
526 event
.SetPath(eg
.m_old
);
528 // CHECK maybe new path here could be NULL or sth?
529 event
.SetNewPath(eg
.m_old
);
534 // we need to create a file now, so we can delete it
535 EventGenerator
::Get().CreateFile();
541 // ----------------------------------------------------------------------------
543 // ----------------------------------------------------------------------------
544 void FileSystemWatcherTestCase
::TestEventRename()
546 wxLogDebug("TestEventRename()");
548 class EventTester
: public EventHandler
551 virtual void GenerateEvent()
553 CPPUNIT_ASSERT(eg
.RenameFile());
556 virtual wxFileSystemWatcherEvent
ExpectedEvent()
558 wxFileSystemWatcherEvent
event(wxFSW_EVENT_RENAME
);
559 event
.SetPath(eg
.m_old
);
560 event
.SetNewPath(eg
.m_file
);
565 // need a file to rename later
566 EventGenerator
::Get().CreateFile();
572 // ----------------------------------------------------------------------------
574 // ----------------------------------------------------------------------------
575 void FileSystemWatcherTestCase
::TestEventModify()
577 wxLogDebug("TestEventModify()");
579 class EventTester
: public EventHandler
582 virtual void GenerateEvent()
584 CPPUNIT_ASSERT(eg
.ModifyFile());
587 virtual wxFileSystemWatcherEvent
ExpectedEvent()
589 wxFileSystemWatcherEvent
event(wxFSW_EVENT_MODIFY
);
590 event
.SetPath(eg
.m_file
);
591 event
.SetNewPath(eg
.m_file
);
596 // we need to create a file to modify
597 EventGenerator
::Get().CreateFile();
603 // ----------------------------------------------------------------------------
605 // ----------------------------------------------------------------------------
606 void FileSystemWatcherTestCase
::TestEventAccess()
608 wxLogDebug("TestEventAccess()");
610 class EventTester
: public EventHandler
613 virtual void GenerateEvent()
615 CPPUNIT_ASSERT(eg
.ReadFile());
618 virtual wxFileSystemWatcherEvent
ExpectedEvent()
620 wxFileSystemWatcherEvent
event(wxFSW_EVENT_ACCESS
);
621 event
.SetPath(eg
.m_file
);
622 event
.SetNewPath(eg
.m_file
);
627 // we need to create a file to read from it and write sth to it
628 EventGenerator
::Get().CreateFile();
629 EventGenerator
::Get().ModifyFile();
635 // ----------------------------------------------------------------------------
637 // ----------------------------------------------------------------------------
638 void FileSystemWatcherTestCase
::TestTrees()
640 class TreeTester
: public EventHandler
642 const size_t subdirs
;
646 TreeTester() : subdirs(5), files(3) {}
648 void GrowTree(wxFileName dir
)
650 CPPUNIT_ASSERT(dir
.Mkdir());
652 // Create a branch of 5 numbered subdirs, each containing 3
654 for ( unsigned d
= 0; d
< subdirs
; ++d
)
656 dir
.AppendDir(wxString
::Format("subdir%u", d
+1));
657 CPPUNIT_ASSERT(dir
.Mkdir());
659 const wxString prefix
= dir
.GetPathWithSep();
660 for ( unsigned f
= 0; f
< files
; ++f
)
662 // Just create the files.
663 wxFile(prefix
+ wxString
::Format("file%u", f
+1),
669 void RmDir(wxFileName dir
)
671 CPPUNIT_ASSERT(dir
.DirExists());
673 CPPUNIT_ASSERT(dir
.Rmdir(wxPATH_RMDIR_RECURSIVE
));
676 void WatchDir(wxFileName dir
)
678 CPPUNIT_ASSERT(m_watcher
);
680 // Store the initial count; there may already be some watches
681 const int initial
= m_watcher
->GetWatchedPathsCount();
684 CPPUNIT_ASSERT_EQUAL(initial
+ 1,
685 m_watcher
->GetWatchedPathsCount());
688 void RemoveSingleWatch(wxFileName dir
)
690 CPPUNIT_ASSERT(m_watcher
);
692 const int initial
= m_watcher
->GetWatchedPathsCount();
694 m_watcher
->Remove(dir
);
695 CPPUNIT_ASSERT_EQUAL(initial
- 1,
696 m_watcher
->GetWatchedPathsCount());
699 void WatchTree(const wxFileName
& dir
)
701 CPPUNIT_ASSERT(m_watcher
);
704 treeitems
= (subdirs
*files
) + subdirs
+ 1; // +1 for the trunk
706 // Store the initial count; there may already be some watches
707 const int initial
= m_watcher
->GetWatchedPathsCount();
711 m_watcher
->AddTree(dir
);
712 const int plustree
= m_watcher
->GetWatchedPathsCount();
714 CPPUNIT_ASSERT_EQUAL(initial
+ treeitems
, plustree
);
716 m_watcher
->RemoveTree(dir
);
717 CPPUNIT_ASSERT_EQUAL(initial
, m_watcher
->GetWatchedPathsCount());
720 void RemoveAllWatches()
722 CPPUNIT_ASSERT(m_watcher
);
724 m_watcher
->RemoveAll();
725 CPPUNIT_ASSERT_EQUAL(0, m_watcher
->GetWatchedPathsCount());
728 virtual void GenerateEvent()
730 // We don't use this function for events. Just run the tests
732 wxFileName watchdir
= EventGenerator
::GetWatchDir();
733 CPPUNIT_ASSERT(watchdir
.DirExists());
735 wxFileName
treedir(watchdir
);
736 treedir
.AppendDir("treetrunk");
737 CPPUNIT_ASSERT(!treedir
.DirExists());
739 wxFileName
singledir(watchdir
);
740 singledir
.AppendDir("single");
741 CPPUNIT_ASSERT(!singledir
.DirExists());
742 CPPUNIT_ASSERT(singledir
.Mkdir());
747 RemoveSingleWatch(singledir
);
748 // Add it back again, ready to test RemoveAll()
760 virtual wxFileSystemWatcherEvent
ExpectedEvent()
762 CPPUNIT_FAIL("Shouldn't be called");
764 return wxFileSystemWatcherEvent(wxFSW_EVENT_ERROR
);
767 virtual void CheckResult()
769 // Do nothing. We override this to prevent receiving events in
781 // We can't define this class locally inside TestNoEventsAfterRemove() for some
782 // reason with g++ 4.0 under OS X 10.5, it results in the following mysterious
785 // /var/tmp//ccTkNCkc.s:unknown:Non-global symbol:
786 // __ZThn80_ZN25FileSystemWatcherTestCase23TestNoEventsAfterRemoveEvEN11EventTester6NotifyEv.eh
787 // can't be a weak_definition
789 // So define this class outside the function instead.
790 class NoEventsAfterRemoveEventTester
: public EventHandler
,
794 NoEventsAfterRemoveEventTester()
796 // We need to use an inactivity timer as we never get any file
797 // system events in this test, so we consider that the test is
798 // finished when this 1s timeout expires instead of, as usual,
799 // stopping after getting the file system events.
803 virtual void GenerateEvent()
805 m_watcher
->Remove(EventGenerator
::GetWatchDir());
806 CPPUNIT_ASSERT(eg
.CreateFile());
809 virtual void CheckResult()
811 CPPUNIT_ASSERT( m_events
.empty() );
814 virtual wxFileSystemWatcherEvent
ExpectedEvent()
816 CPPUNIT_FAIL( "Shouldn't be called" );
818 return wxFileSystemWatcherEvent(wxFSW_EVENT_ERROR
);
821 virtual void Notify()
827 } // anonymous namespace
829 void FileSystemWatcherTestCase
::TestNoEventsAfterRemove()
831 NoEventsAfterRemoveEventTester tester
;