tests/filename/filenametest.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        tests/filename/filename.cpp
   3 // Purpose:     wxFileName unit test
   4 // Author:      Vadim Zeitlin
   5 // Created:     2004-07-25
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2004 Vadim Zeitlin
   8 ///////////////////////////////////////////////////////////////////////////////
   9
  10 // ----------------------------------------------------------------------------
  11 // headers
  12 // ----------------------------------------------------------------------------
  13
  14 #include "testprec.h"
  15
  16 #ifdef __BORLANDC__
  17     #pragma hdrstop
  18 #endif
  19
  20 #ifndef WX_PRECOMP
  21     #include "wx/utils.h"
  22 #endif // WX_PRECOMP
  23
  24 #include "wx/filename.h"
  25 #include "wx/filefn.h"
  26
  27 // ----------------------------------------------------------------------------
  28 // local functions
  29 // ----------------------------------------------------------------------------
  30
  31 // define stream inserter for wxFileName to use it in CPPUNIT_ASSERT_EQUAL()
  32 inline std::ostream& operator<<(std::ostream& o, const wxFileName& fn)
  33 {
  34     return o << fn.GetFullPath();
  35 }
  36
  37 // ----------------------------------------------------------------------------
  38 // test data
  39 // ----------------------------------------------------------------------------
  40
  41 static struct TestFileNameInfo
  42 {
  43     const wxChar *fullname;
  44     const wxChar *volume;
  45     const wxChar *path;
  46     const wxChar *name;
  47     const wxChar *ext;
  48     bool isAbsolute;
  49     wxPathFormat format;
  50 } filenames[] =
  51 {
  52     // the empty string
  53     { _T(""), _T(""), _T(""), _T(""), _T(""), false, wxPATH_UNIX },
  54     { _T(""), _T(""), _T(""), _T(""), _T(""), false, wxPATH_DOS },
  55     { _T(""), _T(""), _T(""), _T(""), _T(""), false, wxPATH_VMS },
  56
  57     // Unix file names
  58     { _T("/usr/bin/ls"), _T(""), _T("/usr/bin"), _T("ls"), _T(""), true, wxPATH_UNIX },
  59     { _T("/usr/bin/"), _T(""), _T("/usr/bin"), _T(""), _T(""), true, wxPATH_UNIX },
  60     { _T("~/.zshrc"), _T(""), _T("~"), _T(".zshrc"), _T(""), true, wxPATH_UNIX },
  61     { _T("../../foo"), _T(""), _T("../.."), _T("foo"), _T(""), false, wxPATH_UNIX },
  62     { _T("foo.bar"), _T(""), _T(""), _T("foo"), _T("bar"), false, wxPATH_UNIX },
  63     { _T("~/foo.bar"), _T(""), _T("~"), _T("foo"), _T("bar"), true, wxPATH_UNIX },
  64     { _T("/foo"), _T(""), _T("/"), _T("foo"), _T(""), true, wxPATH_UNIX },
  65     { _T("Mahogany-0.60/foo.bar"), _T(""), _T("Mahogany-0.60"), _T("foo"), _T("bar"), false, wxPATH_UNIX },
  66     { _T("/tmp/wxwin.tar.bz"), _T(""), _T("/tmp"), _T("wxwin.tar"), _T("bz"), true, wxPATH_UNIX },
  67
  68     // Windows file names
  69     { _T("foo.bar"), _T(""), _T(""), _T("foo"), _T("bar"), false, wxPATH_DOS },
  70     { _T("\\foo.bar"), _T(""), _T("\\"), _T("foo"), _T("bar"), false, wxPATH_DOS },
  71     { _T("c:foo.bar"), _T("c"), _T(""), _T("foo"), _T("bar"), false, wxPATH_DOS },
  72     { _T("c:\\foo.bar"), _T("c"), _T("\\"), _T("foo"), _T("bar"), true, wxPATH_DOS },
  73     { _T("c:\\Windows\\command.com"), _T("c"), _T("\\Windows"), _T("command"), _T("com"), true, wxPATH_DOS },
  74
  75 #if 0
  76     // NB: when using the wxFileName::GetLongPath() function on these two
  77     //     strings, the program will hang for several seconds blocking inside
  78     //     Win32 GetLongPathName() function
  79     { _T("\\\\server\\foo.bar"), _T("server"), _T("\\"), _T("foo"), _T("bar"), true, wxPATH_DOS },
  80     { _T("\\\\server\\dir\\foo.bar"), _T("server"), _T("\\dir"), _T("foo"), _T("bar"), true, wxPATH_DOS },
  81 #endif
  82
  83     // consecutive [back]slashes should be treated as single occurrences of
  84     // them and not interpreted as share names if there is a volume name
  85     { _T("c:\\aaa\\bbb\\ccc"), _T("c"), _T("\\aaa\\bbb"), _T("ccc"), _T(""), true, wxPATH_DOS },
  86     { _T("c:\\\\aaa\\bbb\\ccc"), _T("c"), _T("\\\\aaa\\bbb"), _T("ccc"), _T(""), true, wxPATH_DOS },
  87
  88     // wxFileName support for Mac file names is broken currently
  89 #if 0
  90     // Mac file names
  91     { _T("Volume:Dir:File"), _T("Volume"), _T("Dir"), _T("File"), _T(""), true, wxPATH_MAC },
  92     { _T("Volume:Dir:Subdir:File"), _T("Volume"), _T("Dir:Subdir"), _T("File"), _T(""), true, wxPATH_MAC },
  93     { _T("Volume:"), _T("Volume"), _T(""), _T(""), _T(""), true, wxPATH_MAC },
  94     { _T(":Dir:File"), _T(""), _T("Dir"), _T("File"), _T(""), false, wxPATH_MAC },
  95     { _T(":File.Ext"), _T(""), _T(""), _T("File"), _T(".Ext"), false, wxPATH_MAC },
  96     { _T("File.Ext"), _T(""), _T(""), _T("File"), _T(".Ext"), false, wxPATH_MAC },
  97 #endif // 0
  98
  99 #if 0
 100     // VMS file names
 101     // NB: on Windows they have the same effect of the \\server\\ strings
 102     //     (see the note above)
 103     { _T("device:[dir1.dir2.dir3]file.txt"), _T("device"), _T("dir1.dir2.dir3"), _T("file"), _T("txt"), true, wxPATH_VMS },
 104 #endif
 105     { _T("file.txt"), _T(""), _T(""), _T("file"), _T("txt"), false, wxPATH_VMS },
 106 };
 107
 108 // ----------------------------------------------------------------------------
 109 // test class
 110 // ----------------------------------------------------------------------------
 111
 112 class FileNameTestCase : public CppUnit::TestCase
 113 {
 114 public:
 115     FileNameTestCase() { }
 116
 117 private:
 118     CPPUNIT_TEST_SUITE( FileNameTestCase );
 119         CPPUNIT_TEST( TestConstruction );
 120         CPPUNIT_TEST( TestComparison );
 121         CPPUNIT_TEST( TestSplit );
 122         CPPUNIT_TEST( TestSetPath );
 123         CPPUNIT_TEST( TestStrip );
 124         CPPUNIT_TEST( TestNormalize );
 125         CPPUNIT_TEST( TestReplace );
 126 #ifdef __WINDOWS__
 127         CPPUNIT_TEST( TestShortLongPath );
 128 #endif // __WINDOWS__
 129     CPPUNIT_TEST_SUITE_END();
 130
 131     void TestConstruction();
 132     void TestComparison();
 133     void TestSplit();
 134     void TestSetPath();
 135     void TestStrip();
 136     void TestNormalize();
 137     void TestReplace();
 138 #ifdef __WINDOWS__
 139     void TestShortLongPath();
 140 #endif // __WINDOWS__
 141
 142     DECLARE_NO_COPY_CLASS(FileNameTestCase)
 143 };
 144
 145 // register in the unnamed registry so that these tests are run by default
 146 CPPUNIT_TEST_SUITE_REGISTRATION( FileNameTestCase );
 147
 148 // also include in it's own registry so that these tests can be run alone
 149 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( FileNameTestCase, "FileNameTestCase" );
 150
 151 void FileNameTestCase::TestConstruction()
 152 {
 153     for ( size_t n = 0; n < WXSIZEOF(filenames); n++ )
 154     {
 155         const TestFileNameInfo& fni = filenames[n];
 156
 157         wxFileName fn(fni.fullname, fni.format);
 158
 159         // the original full name could contain consecutive [back]slashes,
 160         // squeeze them except for the double backslash in the beginning in
 161         // Windows filenames where it has special meaning
 162         wxString fullnameOrig;
 163         if ( fni.format == wxPATH_DOS )
 164         {
 165             // copy the backslashes at beginning unchanged
 166             const wxChar *p = fni.fullname;
 167             while ( *p == _T('\\') )
 168                 fullnameOrig += *p++;
 169
 170             // replace consecutive slashes with single ones in the rest
 171             for ( wxChar chPrev = _T('\0'); *p; p++ )
 172             {
 173                 if ( *p == _T('\\') && chPrev == _T('\\') )
 174                     continue;
 175
 176                 chPrev = *p;
 177                 fullnameOrig += chPrev;
 178             }
 179         }
 180         else // !wxPATH_DOS
 181         {
 182             fullnameOrig = fni.fullname;
 183         }
 184
 185         fullnameOrig.Replace(_T("//"), _T("/"));
 186
 187
 188         wxString fullname = fn.GetFullPath(fni.format);
 189         CPPUNIT_ASSERT_EQUAL( fullnameOrig, fullname );
 190
 191         // notice that we use a dummy working directory to ensure that paths
 192         // with "../.." in them could be normalized, otherwise this would fail
 193         // if the test is run from root directory or its direct subdirectory
 194         CPPUNIT_ASSERT_MESSAGE
 195         (
 196             (const char *)wxString::Format(_T("Normalize(%s) failed"), fni.fullname).mb_str(),
 197             fn.Normalize(wxPATH_NORM_ALL, _T("/foo/bar/baz"), fni.format)
 198         );
 199
 200         if ( *fni.volume && *fni.path )
 201         {
 202             // check that specifying the volume separately or as part of the
 203             // path doesn't make any difference
 204             wxString pathWithVolume = fni.volume;
 205             pathWithVolume += wxFileName::GetVolumeSeparator(fni.format);
 206             pathWithVolume += fni.path;
 207
 208             CPPUNIT_ASSERT_EQUAL( wxFileName(pathWithVolume,
 209                                              fni.name,
 210                                              fni.ext,
 211                                              fni.format), fn );
 212         }
 213     }
 214
 215     wxFileName fn;
 216
 217     // empty strings
 218     fn.AssignDir(wxEmptyString);
 219     CPPUNIT_ASSERT( !fn.IsOk() );
 220
 221     fn.Assign(wxEmptyString);
 222     CPPUNIT_ASSERT( !fn.IsOk() );
 223
 224     fn.Assign(wxEmptyString, wxEmptyString);
 225     CPPUNIT_ASSERT( !fn.IsOk() );
 226
 227     fn.Assign(wxEmptyString, wxEmptyString, wxEmptyString);
 228     CPPUNIT_ASSERT( !fn.IsOk() );
 229
 230     fn.Assign(wxEmptyString, wxEmptyString, wxEmptyString, wxEmptyString);
 231     CPPUNIT_ASSERT( !fn.IsOk() );
 232 }
 233
 234 void FileNameTestCase::TestComparison()
 235 {
 236     wxFileName fn1(wxT("/tmp/file1"));
 237     wxFileName fn2(wxT("/tmp/dir2/../file2"));
 238     fn1.Normalize();
 239     fn2.Normalize();
 240     CPPUNIT_ASSERT_EQUAL(fn1.GetPath(), fn2.GetPath());
 241 }
 242
 243 void FileNameTestCase::TestSplit()
 244 {
 245     for ( size_t n = 0; n < WXSIZEOF(filenames); n++ )
 246     {
 247         const TestFileNameInfo& fni = filenames[n];
 248         wxString volume, path, name, ext;
 249         wxFileName::SplitPath(fni.fullname,
 250                               &volume, &path, &name, &ext, fni.format);
 251
 252         CPPUNIT_ASSERT_EQUAL( wxString(fni.volume), volume );
 253         CPPUNIT_ASSERT_EQUAL( wxString(fni.path), path );
 254         CPPUNIT_ASSERT_EQUAL( wxString(fni.name), name );
 255         CPPUNIT_ASSERT_EQUAL( wxString(fni.ext), ext );
 256     }
 257
 258     // special case of empty extension
 259     wxFileName fn(_T("foo."));
 260     CPPUNIT_ASSERT_EQUAL( wxString(_T("foo.")), fn.GetFullPath() );
 261 }
 262
 263 void FileNameTestCase::TestSetPath()
 264 {
 265     wxFileName fn(_T("d:\\test\\foo.bar"), wxPATH_DOS);
 266     fn.SetPath(_T("c:\\temp"), wxPATH_DOS);
 267     CPPUNIT_ASSERT( fn.SameAs(wxFileName(_T("c:\\temp\\foo.bar"), wxPATH_DOS)) );
 268
 269     fn = wxFileName(_T("/usr/bin/ls"), wxPATH_UNIX);
 270     fn.SetPath(_T("/usr/local/bin"), wxPATH_UNIX);
 271     CPPUNIT_ASSERT( fn.SameAs(wxFileName(_T("/usr/local/bin/ls"), wxPATH_UNIX)) );
 272 }
 273
 274 void FileNameTestCase::TestNormalize()
 275 {
 276     // prepare some data to be used later
 277     wxString sep = wxFileName::GetPathSeparator();
 278     wxString cwd = wxGetCwd();
 279     wxString home = wxGetUserHome();
 280
 281     cwd.Replace(sep, wxT("/"));
 282     if (cwd.Last() != wxT('/'))
 283         cwd += wxT('/');
 284     home.Replace(sep, wxT("/"));
 285     if (home.Last() != wxT('/'))
 286         home += wxT('/');
 287
 288     // since we will always be testing paths using the wxPATH_UNIX
 289     // format, we need to remove the volume, if present
 290     if (home.Contains(wxT(':')))
 291         home = home.AfterFirst(wxT(':'));
 292     if (cwd.Contains(wxT(':')))
 293         cwd = cwd.AfterFirst(wxT(':'));
 294
 295     static const struct FileNameTest
 296     {
 297         const char *original;
 298         int flags;
 299         const char *expected;
 300         wxPathFormat fmt;
 301     } tests[] =
 302     {
 303         // test wxPATH_NORM_ENV_VARS
 304 #ifdef __WXMSW__
 305         { "%ABCDEF%/g/h/i", wxPATH_NORM_ENV_VARS, "abcdef/g/h/i", wxPATH_UNIX },
 306 #else
 307         { "$(ABCDEF)/g/h/i", wxPATH_NORM_ENV_VARS, "abcdef/g/h/i", wxPATH_UNIX },
 308 #endif
 309
 310         // test wxPATH_NORM_DOTS
 311         { "a/.././b/c/../../", wxPATH_NORM_DOTS, "", wxPATH_UNIX },
 312
 313         // test wxPATH_NORM_TILDE
 314         // NB: do the tilde expansion also under Windows to test if it works there too
 315         { "/a/b/~", wxPATH_NORM_TILDE, "/a/b/~", wxPATH_UNIX },
 316         { "/~/a/b", wxPATH_NORM_TILDE, "HOME/a/b", wxPATH_UNIX },
 317         { "~/a/b", wxPATH_NORM_TILDE, "HOME/a/b", wxPATH_UNIX },
 318
 319         // test wxPATH_NORM_CASE
 320         { "Foo", wxPATH_NORM_CASE, "Foo", wxPATH_UNIX },
 321         { "Foo", wxPATH_NORM_CASE, "foo", wxPATH_DOS },
 322         { "C:\\Program Files\\wx", wxPATH_NORM_CASE,
 323           "c:\\program files\\wx", wxPATH_DOS },
 324         { "C:/Program Files/wx", wxPATH_NORM_ALL | wxPATH_NORM_CASE,
 325           "c:\\program files\\wx", wxPATH_DOS },
 326         { "C:\\Users\\zeitlin", wxPATH_NORM_ALL | wxPATH_NORM_CASE,
 327           "c:\\users\\zeitlin", wxPATH_DOS },
 328
 329         // test wxPATH_NORM_ABSOLUTE
 330         { "a/b/", wxPATH_NORM_ABSOLUTE, "CWD/a/b/", wxPATH_UNIX },
 331         { "a/b/c.ext", wxPATH_NORM_ABSOLUTE, "CWD/a/b/c.ext", wxPATH_UNIX },
 332         { "/a", wxPATH_NORM_ABSOLUTE, "/a", wxPATH_UNIX },
 333
 334         // test giving no flags at all to Normalize()
 335         { "a/b/", 0, "a/b/", wxPATH_UNIX },
 336         { "a/b/c.ext", 0, "a/b/c.ext", wxPATH_UNIX },
 337         { "/a", 0, "/a", wxPATH_UNIX },
 338
 339         // test handling dots without wxPATH_NORM_DOTS and wxPATH_NORM_ABSOLUTE
 340         // for both existing and non-existent files (this is important under
 341         // MSW where GetLongPathName() works only for the former)
 342         { "./foo", wxPATH_NORM_LONG, "./foo", wxPATH_UNIX },
 343         { "../foo", wxPATH_NORM_LONG, "../foo", wxPATH_UNIX },
 344         { ".\\test.bkl", wxPATH_NORM_LONG, ".\\test.bkl", wxPATH_DOS },
 345         { ".\\foo", wxPATH_NORM_LONG, ".\\foo", wxPATH_DOS },
 346         { "..\\Makefile.in", wxPATH_NORM_LONG, "..\\Makefile.in", wxPATH_DOS },
 347         { "..\\foo", wxPATH_NORM_LONG, "..\\foo", wxPATH_DOS },
 348 #ifdef __WXMSW__
 349         { "..\\MKINST~1", wxPATH_NORM_LONG, "..\\mkinstalldirs", wxPATH_DOS },
 350 #endif
 351     };
 352
 353     // set the env var ABCDEF
 354     wxSetEnv(_T("ABCDEF"), _T("abcdef"));
 355
 356     for ( size_t i = 0; i < WXSIZEOF(tests); i++ )
 357     {
 358         const FileNameTest& fnt = tests[i];
 359         wxFileName fn(fnt.original, fnt.fmt);
 360
 361         // be sure this normalization does not fail
 362         WX_ASSERT_MESSAGE
 363         (
 364             ("#%d: Normalize(%s) failed", (int)i, fnt.original),
 365             fn.Normalize(fnt.flags, cwd, fnt.fmt)
 366         );
 367
 368         // compare result with expected string
 369         wxString expected(tests[i].expected);
 370         expected.Replace(_T("HOME/"), home);
 371         expected.Replace(_T("CWD/"), cwd);
 372         WX_ASSERT_EQUAL_MESSAGE
 373         (
 374             ("array element #%d", (int)i),
 375             expected, fn.GetFullPath(fnt.fmt)
 376         );
 377     }
 378 }
 379
 380 void FileNameTestCase::TestReplace()
 381 {
 382     static const struct FileNameTest
 383     {
 384         const char *original;
 385         const char *env_contents;
 386         const char *replace_fmtstring;
 387         const char *expected;
 388         wxPathFormat fmt;
 389     } tests[] =
 390     {
 391         { "/usr/a/strange path/lib/someFile.ext", "/usr/a/strange path", "$%s", "$TEST_VAR/lib/someFile.ext", wxPATH_UNIX },
 392         { "/usr/a/path/lib/someFile.ext", "/usr/a/path", "$%s", "$TEST_VAR/lib/someFile.ext", wxPATH_UNIX },
 393         { "/usr/a/path/lib/someFile", "/usr/a/path/", "$%s", "$TEST_VARlib/someFile", wxPATH_UNIX },
 394         { "/usr/a/path/lib/", "/usr/a/path/", "$(%s)", "$(TEST_VAR)lib/", wxPATH_UNIX },
 395         { "/usr/a/path/lib/", "/usr/a/path/", "${{%s}}", "${{TEST_VAR}}lib/", wxPATH_UNIX },
 396         { "/usr/a/path/lib/", "/usr/a/path/", "%s", "TEST_VARlib/", wxPATH_UNIX },
 397         { "/usr/a/path/lib/", "/usr/a/path/", "%s//", "TEST_VAR/lib/", wxPATH_UNIX },
 398             // note: empty directory components are automatically removed by wxFileName thus
 399             //       using // in the replace format string has no effect
 400
 401         { "/usr/../a/path/lib/", "/usr/a/path/", "%s", "/usr/../a/path/lib/", wxPATH_UNIX },
 402         { "/usr/a/path/usr/usr", "/usr", "%s", "TEST_VAR/a/pathTEST_VAR/usr", wxPATH_UNIX },
 403         { "/usr/a/path/usr/usr", "/usr", "$%s", "$TEST_VAR/a/path$TEST_VAR/usr", wxPATH_UNIX },
 404         { "/a/b/c/d", "a/", "%s", "/TEST_VARb/c/d", wxPATH_UNIX },
 405
 406         { "C:\\A\\Strange Path\\lib\\someFile", "C:\\A\\Strange Path", "%%%s%%", "%TEST_VAR%\\lib\\someFile", wxPATH_WIN },
 407         { "C:\\A\\Path\\lib\\someFile", "C:\\A\\Path", "%%%s%%", "%TEST_VAR%\\lib\\someFile", wxPATH_WIN },
 408         { "C:\\A\\Path\\lib\\someFile", "C:\\A\\Path", "$(%s)", "$(TEST_VAR)\\lib\\someFile", wxPATH_WIN }
 409     };
 410
 411     for ( size_t i = 0; i < WXSIZEOF(tests); i++ )
 412     {
 413         const FileNameTest& fnt = tests[i];
 414         wxFileName fn(fnt.original, fnt.fmt);
 415
 416         // set the environment variable
 417         wxSetEnv(_T("TEST_VAR"), fnt.env_contents);
 418
 419         // be sure this ReplaceEnvVariable does not fail
 420         WX_ASSERT_MESSAGE
 421         (
 422             ("#%d: ReplaceEnvVariable(%s) failed", (int)i, fnt.replace_fmtstring),
 423             fn.ReplaceEnvVariable("TEST_VAR", fnt.replace_fmtstring, fnt.fmt)
 424         );
 425
 426         // compare result with expected string
 427         wxString expected(fnt.expected);
 428         WX_ASSERT_EQUAL_MESSAGE
 429         (
 430             ("array element #%d", (int)i),
 431             expected, fn.GetFullPath(fnt.fmt)
 432         );
 433     }
 434
 435     // now test ReplaceHomeDir
 436
 437     wxFileName fn = wxFileName::DirName(wxGetHomeDir());
 438     fn.AppendDir("test1");
 439     fn.AppendDir("test2");
 440     fn.AppendDir("test3");
 441     fn.SetName("some file");
 442
 443     WX_ASSERT_MESSAGE
 444     (
 445         ("ReplaceHomeDir(%s) failed", fn.GetFullPath()),
 446         fn.ReplaceHomeDir()
 447     );
 448
 449     CPPUNIT_ASSERT_EQUAL( wxString(_T("~/test1/test2/test3/some file")),
 450                           fn.GetFullPath(wxPATH_UNIX) );
 451 }
 452
 453 void FileNameTestCase::TestStrip()
 454 {
 455     CPPUNIT_ASSERT_EQUAL( "", wxFileName::StripExtension(_T("")) );
 456     CPPUNIT_ASSERT_EQUAL( ".", wxFileName::StripExtension(_T(".")) );
 457     CPPUNIT_ASSERT_EQUAL( ".vimrc", wxFileName::StripExtension(_T(".vimrc")) );
 458     CPPUNIT_ASSERT_EQUAL( "bad", wxFileName::StripExtension(_T("bad")) );
 459     CPPUNIT_ASSERT_EQUAL( "good", wxFileName::StripExtension(_T("good.wav")) );
 460     CPPUNIT_ASSERT_EQUAL( "good.wav", wxFileName::StripExtension(_T("good.wav.wav")) );
 461 }
 462
 463 #ifdef __WINDOWS__
 464
 465 void FileNameTestCase::TestShortLongPath()
 466 {
 467     wxFileName fn(_T("C:\\Program Files\\Windows NT\\Accessories\\wordpad.exe"));
 468
 469     // incredibly enough, GetLongPath() used to return different results during
 470     // the first and subsequent runs, test for this
 471     CPPUNIT_ASSERT_EQUAL( fn.GetLongPath(), fn.GetLongPath() );
 472     CPPUNIT_ASSERT_EQUAL( fn.GetShortPath(), fn.GetShortPath() );
 473 }
 474
 475 #endif // __WINDOWS__