X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/58271f42ceaa3f27b96df865152fda417e5a52f7..cd794127ff73748f8199587897f57aa02c5ef059:/tests/filename/filenametest.cpp diff --git a/tests/filename/filenametest.cpp b/tests/filename/filenametest.cpp index 990dec860a..10ef920f39 100644 --- a/tests/filename/filenametest.cpp +++ b/tests/filename/filenametest.cpp @@ -23,10 +23,16 @@ #include "wx/filename.h" #include "wx/filefn.h" +#include "wx/stdpaths.h" +#include "wx/scopeguard.h" -#ifdef __WXMSW__ +#ifdef __WINDOWS__ #include "wx/msw/registry.h" -#endif // __WXMSW__ +#endif // __WINDOWS__ + +#ifdef __UNIX__ + #include +#endif // __UNIX__ #include "testfile.h" @@ -131,6 +137,13 @@ private: #endif // __WINDOWS__ CPPUNIT_TEST( TestUNC ); CPPUNIT_TEST( TestVolumeUniqueName ); + CPPUNIT_TEST( TestCreateTempFileName ); + CPPUNIT_TEST( TestGetTimes ); + CPPUNIT_TEST( TestExists ); + CPPUNIT_TEST( TestIsSame ); +#if defined(__UNIX__) + CPPUNIT_TEST( TestSymlinks ); +#endif // __UNIX__ CPPUNIT_TEST_SUITE_END(); void TestConstruction(); @@ -146,6 +159,13 @@ private: #endif // __WINDOWS__ void TestUNC(); void TestVolumeUniqueName(); + void TestCreateTempFileName(); + void TestGetTimes(); + void TestExists(); + void TestIsSame(); +#if defined(__UNIX__) + void TestSymlinks(); +#endif // __UNIX__ DECLARE_NO_COPY_CLASS(FileNameTestCase) }; @@ -153,7 +173,7 @@ private: // register in the unnamed registry so that these tests are run by default CPPUNIT_TEST_SUITE_REGISTRATION( FileNameTestCase ); -// also include in it's own registry so that these tests can be run alone +// also include in its own registry so that these tests can be run alone CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( FileNameTestCase, "FileNameTestCase" ); void FileNameTestCase::TestConstruction() @@ -309,7 +329,7 @@ void FileNameTestCase::TestNormalize() } tests[] = { // test wxPATH_NORM_ENV_VARS -#ifdef __WXMSW__ +#ifdef __WINDOWS__ { "%ABCDEF%/g/h/i", wxPATH_NORM_ENV_VARS, "abcdef/g/h/i", wxPATH_UNIX }, #else { "$(ABCDEF)/g/h/i", wxPATH_NORM_ENV_VARS, "abcdef/g/h/i", wxPATH_UNIX }, @@ -317,8 +337,11 @@ void FileNameTestCase::TestNormalize() // test wxPATH_NORM_DOTS { "a/.././b/c/../../", wxPATH_NORM_DOTS, "", wxPATH_UNIX }, - { "./", wxPATH_NORM_DOTS, "", wxPATH_UNIX }, - { "b/../", wxPATH_NORM_DOTS, "", wxPATH_UNIX }, + { "", wxPATH_NORM_DOTS, "", wxPATH_UNIX }, + { "./foo", wxPATH_NORM_DOTS, "foo", wxPATH_UNIX }, + { "b/../bar", wxPATH_NORM_DOTS, "bar", wxPATH_UNIX }, + { "c/../../quux", wxPATH_NORM_DOTS, "../quux", wxPATH_UNIX }, + { "/c/../../quux", wxPATH_NORM_DOTS, "/quux", wxPATH_UNIX }, // test wxPATH_NORM_TILDE: notice that ~ is only interpreted specially // when it is the first character in the file name @@ -390,7 +413,7 @@ void FileNameTestCase::TestNormalize() // and also that the registry key was changed recently and didn't take // effect yet but these are marginal cases which we consciously choose to // ignore for now) -#ifdef __WXMSW__ +#ifdef __WINDOWS__ long shortNamesDisabled; if ( wxRegKey ( @@ -404,7 +427,7 @@ void FileNameTestCase::TestNormalize() CPPUNIT_ASSERT_EQUAL( "..\\mkinstalldirs", fn.GetFullPath() ); } //else: when in doubt, don't run the test -#endif // __WXMSW__ +#endif // __WINDOWS__ } void FileNameTestCase::TestReplace() @@ -490,18 +513,24 @@ void FileNameTestCase::TestGetHumanReadable() wxSizeConvention conv; } testData[] = { - { "NA", 0, 1, wxSIZE_CONV_TRADIONAL }, - { "2.0 KB", 2000, 1, wxSIZE_CONV_TRADIONAL }, - { "1.953 KiB", 2000, 3, wxSIZE_CONV_IEC }, - { "2.000 KB", 2000, 3, wxSIZE_CONV_SI }, - { "297 KB", 304351, 0, wxSIZE_CONV_TRADIONAL }, - { "304 KB", 304351, 0, wxSIZE_CONV_SI }, + { "NA", 0, 1, wxSIZE_CONV_TRADITIONAL }, + { "2.0 KB", 2000, 1, wxSIZE_CONV_TRADITIONAL }, + { "1.953 KiB", 2000, 3, wxSIZE_CONV_IEC }, + { "2.000 KB", 2000, 3, wxSIZE_CONV_SI }, + { "297 KB", 304351, 0, wxSIZE_CONV_TRADITIONAL }, + { "304 KB", 304351, 0, wxSIZE_CONV_SI }, }; + CLocaleSetter loc; // we want to use "C" locale for LC_NUMERIC + // so that regardless of the system's locale + // the decimal point used by GetHumanReadableSize() + // is always '.' for ( unsigned n = 0; n < WXSIZEOF(testData); n++ ) { const TestData& td = testData[n]; + // take care of using the decimal point for the current locale before + // the actual comparison CPPUNIT_ASSERT_EQUAL ( td.result, @@ -568,3 +597,375 @@ void FileNameTestCase::TestVolumeUniqueName() "Program Files\\setup.exe", fn.GetFullPath(wxPATH_DOS) ); } + +void FileNameTestCase::TestCreateTempFileName() +{ + static const struct TestData + { + const char *prefix; + const char *expectedFolder; + bool shouldSucceed; + } testData[] = + { + { "", "$SYSTEM_TEMP", true }, + { "foo", "$SYSTEM_TEMP", true }, + { "..", "$SYSTEM_TEMP", true }, + { "../bar", "..", true }, +#ifdef __WINDOWS__ + { "$USER_DOCS_DIR\\", "$USER_DOCS_DIR", true }, + { "c:\\a\\directory\\which\\does\\not\\exist", "", false }, +#elif defined( __UNIX__ ) + { "$USER_DOCS_DIR/", "$USER_DOCS_DIR", true }, + { "/tmp/foo", "/tmp", true }, + { "/tmp/a/directory/which/does/not/exist", "", false }, +#endif // __UNIX__ + }; + + for ( size_t n = 0; n < WXSIZEOF(testData); n++ ) + { + wxString prefix = testData[n].prefix; + prefix.Replace("$USER_DOCS_DIR", wxStandardPaths::Get().GetDocumentsDir()); + + std::string errDesc = wxString::Format("failed on prefix '%s'", prefix).ToStdString(); + + wxString path = wxFileName::CreateTempFileName(prefix); + CPPUNIT_ASSERT_EQUAL_MESSAGE( errDesc, !testData[n].shouldSucceed, path.empty() ); + + if (testData[n].shouldSucceed) + { + errDesc += "; path is " + path.ToStdString(); + + // test the place where the temp file has been created + wxString expected = testData[n].expectedFolder; + expected.Replace("$SYSTEM_TEMP", wxStandardPaths::Get().GetTempDir()); + expected.Replace("$USER_DOCS_DIR", wxStandardPaths::Get().GetDocumentsDir()); + CPPUNIT_ASSERT_EQUAL_MESSAGE( errDesc, expected, wxFileName(path).GetPath() ); + + // the temporary file is created with full permissions for the current process + // so we should always be able to remove it: + CPPUNIT_ASSERT_MESSAGE( errDesc, wxRemoveFile(path) ); + } + } +} + +void FileNameTestCase::TestGetTimes() +{ + wxFileName fn(wxFileName::CreateTempFileName("filenametest")); + CPPUNIT_ASSERT( fn.IsOk() ); + wxON_BLOCK_EXIT1( wxRemoveFile, fn.GetFullPath() ); + + wxDateTime dtAccess, dtMod, dtCreate; + CPPUNIT_ASSERT( fn.GetTimes(&dtAccess, &dtMod, &dtCreate) ); + + // make sure all retrieved dates are equal to the current date&time + // with an accuracy up to 1 minute + CPPUNIT_ASSERT(dtCreate.IsEqualUpTo(wxDateTime::Now(), wxTimeSpan(0,1))); + CPPUNIT_ASSERT(dtMod.IsEqualUpTo(wxDateTime::Now(), wxTimeSpan(0,1))); + CPPUNIT_ASSERT(dtAccess.IsEqualUpTo(wxDateTime::Now(), wxTimeSpan(0,1))); +} + +void FileNameTestCase::TestExists() +{ + wxFileName fn(wxFileName::CreateTempFileName("filenametest")); + CPPUNIT_ASSERT( fn.IsOk() ); + wxON_BLOCK_EXIT1( wxRemoveFile, fn.GetFullPath() ); + + CPPUNIT_ASSERT( fn.FileExists() ); + CPPUNIT_ASSERT( !wxFileName::DirExists(fn.GetFullPath()) ); + + // FIXME-VC6: This compiler crashes with + // + // fatal error C1001: INTERNAL COMPILER ERROR + // (compiler file 'msc1.cpp', line 1794) + // + // when compiling calls to Exists() with parameter for some reason, just + // disable these tests there. +#ifndef __VISUALC6__ + CPPUNIT_ASSERT( fn.Exists(wxFILE_EXISTS_REGULAR) ); + CPPUNIT_ASSERT( !fn.Exists(wxFILE_EXISTS_DIR) ); +#endif + CPPUNIT_ASSERT( fn.Exists() ); + + const wxString& tempdir = wxFileName::GetTempDir(); + + wxFileName fileInTempDir(tempdir, "bloordyblop"); + CPPUNIT_ASSERT( !fileInTempDir.Exists() ); + CPPUNIT_ASSERT( fileInTempDir.DirExists() ); + + wxFileName dirTemp(wxFileName::DirName(tempdir)); + CPPUNIT_ASSERT( !dirTemp.FileExists() ); + CPPUNIT_ASSERT( dirTemp.DirExists() ); + +#ifndef __VISUALC6__ + CPPUNIT_ASSERT( dirTemp.Exists(wxFILE_EXISTS_DIR) ); + CPPUNIT_ASSERT( !dirTemp.Exists(wxFILE_EXISTS_REGULAR) ); +#endif + CPPUNIT_ASSERT( dirTemp.Exists() ); + +#ifdef __UNIX__ + CPPUNIT_ASSERT( !wxFileName::FileExists("/dev/null") ); + CPPUNIT_ASSERT( !wxFileName::DirExists("/dev/null") ); + CPPUNIT_ASSERT( wxFileName::Exists("/dev/null") ); + CPPUNIT_ASSERT( wxFileName::Exists("/dev/null", wxFILE_EXISTS_DEVICE) ); +#ifdef __LINUX__ + // These files are only guaranteed to exist under Linux. + // No need for wxFILE_EXISTS_NO_FOLLOW here; wxFILE_EXISTS_SYMLINK implies it + CPPUNIT_ASSERT( wxFileName::Exists("/dev/core", wxFILE_EXISTS_SYMLINK) ); + CPPUNIT_ASSERT( wxFileName::Exists("/dev/log", wxFILE_EXISTS_SOCKET) ); +#endif // __LINUX__ +#ifndef __VMS + wxString fifo = dirTemp.GetPath() + "/fifo"; + if (mkfifo(fifo.c_str(), 0600) == 0) + { + wxON_BLOCK_EXIT1(wxRemoveFile, fifo); + + CPPUNIT_ASSERT( wxFileName::Exists(fifo, wxFILE_EXISTS_FIFO) ); + } +#endif +#endif // __UNIX__ +} + +void FileNameTestCase::TestIsSame() +{ + wxFileName fn1( wxFileName::CreateTempFileName( "filenametest1" ) ); + CPPUNIT_ASSERT( fn1.IsOk() ); + wxON_BLOCK_EXIT1( wxRemoveFile, fn1.GetFullPath() ); + + wxFileName fn2( wxFileName::CreateTempFileName( "filenametest2" ) ); + CPPUNIT_ASSERT( fn2.IsOk() ); + wxON_BLOCK_EXIT1( wxRemoveFile, fn2.GetFullPath() ); + + CPPUNIT_ASSERT( fn1.SameAs( fn1 ) ); + CPPUNIT_ASSERT( !fn1.SameAs( fn2 ) ); + +#if defined(__UNIX__) + // We need to create a temporary directory and a temporary link. + // Unfortunately we can't use wxFileName::CreateTempFileName() for neither + // as it creates plain files, so use tempnam() explicitly instead. + char* tn = tempnam(NULL, "wxfn1"); + const wxString tempdir1 = wxString::From8BitData(tn); + free(tn); + + CPPUNIT_ASSERT( wxFileName::Mkdir(tempdir1) ); + // Unfortunately the casts are needed to select the overload we need here. + wxON_BLOCK_EXIT2( static_cast(wxFileName::Rmdir), + tempdir1, static_cast(wxPATH_RMDIR_RECURSIVE) ); + + tn = tempnam(NULL, "wxfn2"); + const wxString tempdir2 = wxString::From8BitData(tn); + free(tn); + CPPUNIT_ASSERT_EQUAL( 0, symlink(tempdir1.c_str(), tempdir2.c_str()) ); + wxON_BLOCK_EXIT1( wxRemoveFile, tempdir2 ); + + + wxFileName fn3(tempdir1, "foo"); + wxFileName fn4(tempdir2, "foo"); + + // These files have different paths, hence are different. + CPPUNIT_ASSERT( !fn3.SameAs(fn4) ); + + // Create and close a file to trigger creating it. + wxFile(fn3.GetFullPath(), wxFile::write); + + // Now that both files do exist we should be able to detect that they are + // actually the same file. + CPPUNIT_ASSERT( fn3.SameAs(fn4) ); +#endif // __UNIX__ +} + +#if defined(__UNIX__) + +// Tests for functions that are changed by ShouldFollowLink() +void FileNameTestCase::TestSymlinks() +{ + const wxString tmpdir(wxStandardPaths::Get().GetTempDir()); + + wxFileName tmpfn(wxFileName::DirName(tmpdir)); + + wxDateTime dtAccessTmp, dtModTmp, dtCreateTmp; + CPPUNIT_ASSERT(tmpfn.GetTimes(&dtAccessTmp, &dtModTmp, &dtCreateTmp)); + + // Create a temporary directory +#ifdef __VMS + wxString name = tmpdir + ".filenametestXXXXXX]"; + mkdir( name.char_str() , 0222 ); + wxString tempdir = name; +#else + wxString name = tmpdir + "/filenametestXXXXXX"; + wxString tempdir = wxString::From8BitData(mkdtemp(name.char_str())); + tempdir << wxFileName::GetPathSeparator(); +#endif + wxFileName tempdirfn(wxFileName::DirName(tempdir)); + CPPUNIT_ASSERT(tempdirfn.DirExists()); + + // Create a regular file in that dir, to act as a symlink target + wxFileName targetfn(wxFileName::CreateTempFileName(tempdir)); + CPPUNIT_ASSERT(targetfn.FileExists()); + + // Create a symlink to that file + wxFileName linktofile(tempdir, "linktofile"); + CPPUNIT_ASSERT_EQUAL(0, symlink(targetfn.GetFullPath().c_str(), + linktofile.GetFullPath().c_str())); + + // ... and another to the temporary directory + const wxString linktodirName(tempdir + "/linktodir"); + wxFileName linktodir(wxFileName::DirName(linktodirName)); + CPPUNIT_ASSERT_EQUAL(0, symlink(tmpfn.GetFullPath().c_str(), + linktodirName.c_str())); + + // And symlinks to both of those symlinks + wxFileName linktofilelnk(tempdir, "linktofilelnk"); + CPPUNIT_ASSERT_EQUAL(0, symlink(linktofile.GetFullPath().c_str(), + linktofilelnk.GetFullPath().c_str())); + wxFileName linktodirlnk(tempdir, "linktodirlnk"); + CPPUNIT_ASSERT_EQUAL(0, symlink(linktodir.GetFullPath().c_str(), + linktodirlnk.GetFullPath().c_str())); + + // Run the tests twice: once in the default symlink following mode and the + // second time without following symlinks. + bool deref = true; + for ( int n = 0; n < 2; ++n, deref = !deref ) + { + const std::string msg(deref ? " failed for the link target" + : " failed for the path itself"); + + if ( !deref ) + { + linktofile.DontFollowLink(); + linktodir.DontFollowLink(); + linktofilelnk.DontFollowLink(); + linktodirlnk.DontFollowLink(); + } + + // Test SameAs() + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Comparison with file" + msg, + deref, linktofile.SameAs(targetfn) + ); + + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Comparison with directory" + msg, + deref, linktodir.SameAs(tmpfn) + ); + + // A link-to-a-link should dereference through to the final target + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Comparison with link to a file" + msg, + deref, + linktofilelnk.SameAs(targetfn) + ); + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Comparison with link to a directory" + msg, + deref, + linktodirlnk.SameAs(tmpfn) + ); + + // Test GetTimes() + wxDateTime dtAccess, dtMod, dtCreate; + CPPUNIT_ASSERT_MESSAGE + ( + "Getting times of a directory" + msg, + linktodir.GetTimes(&dtAccess, &dtMod, &dtCreate) + ); + + // IsEqualTo() should be true only when dereferencing. Don't test each + // individually: accessing to create the link will have updated some + bool equal = dtCreate.IsEqualTo(dtCreateTmp) && + dtMod.IsEqualTo(dtModTmp) && + dtAccess.IsEqualTo(dtAccessTmp); + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Comparing directory times" + msg, + deref, + equal + ); + + // Test (File|Dir)Exists() + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Testing file existence" + msg, + deref, + linktofile.FileExists() + ); + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Testing directory existence" + msg, + deref, + linktodir.DirExists() + ); + + // Test wxFileName::Exists + // The wxFILE_EXISTS_NO_FOLLOW flag should override DontFollowLink() + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Testing file existence" + msg, + false, + linktofile.Exists(wxFILE_EXISTS_REGULAR | wxFILE_EXISTS_NO_FOLLOW) + ); + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Testing directory existence" + msg, + false, + linktodir.Exists(wxFILE_EXISTS_DIR | wxFILE_EXISTS_NO_FOLLOW) + ); + // and the static versions + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Testing file existence" + msg, + false, + wxFileName::Exists(linktofile.GetFullPath(), wxFILE_EXISTS_REGULAR | wxFILE_EXISTS_NO_FOLLOW) + ); + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Testing file existence" + msg, + true, + wxFileName::Exists(linktofile.GetFullPath(), wxFILE_EXISTS_REGULAR) + ); + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Testing directory existence" + msg, + false, + wxFileName::Exists(linktodir.GetFullPath(), wxFILE_EXISTS_DIR | wxFILE_EXISTS_NO_FOLLOW) + ); + CPPUNIT_ASSERT_EQUAL_MESSAGE + ( + "Testing directory existence" + msg, + true, + wxFileName::Exists(linktodir.GetFullPath(), wxFILE_EXISTS_DIR) + ); + } + + // Finally test Exists() after removing the file. + CPPUNIT_ASSERT(wxRemoveFile(targetfn.GetFullPath())); + // This should succeed, as the symlink still exists and + // the default wxFILE_EXISTS_ANY implies wxFILE_EXISTS_NO_FOLLOW + CPPUNIT_ASSERT(wxFileName(tempdir, "linktofile").Exists()); + // So should this one, as wxFILE_EXISTS_SYMLINK does too + CPPUNIT_ASSERT(wxFileName(tempdir, "linktofile"). + Exists(wxFILE_EXISTS_SYMLINK)); + // but not this one, as the now broken symlink is followed + CPPUNIT_ASSERT(!wxFileName(tempdir, "linktofile"). + Exists(wxFILE_EXISTS_REGULAR)); + CPPUNIT_ASSERT(linktofile.Exists()); + + // This is also a convenient place to test Rmdir() as we have things to + // remove. + + // First, check that removing a symlink to a directory fails. + CPPUNIT_ASSERT( !wxFileName::Rmdir(linktodirName) ); + + // And recursively removing it only removes the symlink itself, not the + // directory. + CPPUNIT_ASSERT( wxFileName::Rmdir(linktodirName, wxPATH_RMDIR_RECURSIVE) ); + CPPUNIT_ASSERT( tmpfn.Exists() ); + + // Finally removing the directory itself does remove everything. + CPPUNIT_ASSERT(tempdirfn.Rmdir(wxPATH_RMDIR_RECURSIVE)); + CPPUNIT_ASSERT( !tempdirfn.Exists() ); +} + +#endif // __UNIX__