tests/fileconf/fileconftest.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        tests/fileconf/fileconf.cpp
   3 // Purpose:     wxFileConf unit test
   4 // Author:      Vadim Zeitlin
   5 // Created:     2004-09-19
   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 #if wxUSE_FILECONFIG
  21
  22 #ifndef WX_PRECOMP
  23 #endif // WX_PRECOMP
  24
  25 #include "wx/fileconf.h"
  26 #include "wx/sstream.h"
  27
  28 static const wxChar *testconfig =
  29 _T("[root]\n")
  30 _T("entry=value\n")
  31 _T("[root/group1]\n")
  32 _T("[root/group1/subgroup]\n")
  33 _T("subentry=subvalue\n")
  34 _T("subentry2=subvalue2\n")
  35 _T("[root/group2]\n")
  36 ;
  37
  38 // ----------------------------------------------------------------------------
  39 // test class
  40 // ----------------------------------------------------------------------------
  41
  42 class FileConfigTestCase : public CppUnit::TestCase
  43 {
  44 public:
  45     FileConfigTestCase() { }
  46
  47 private:
  48     CPPUNIT_TEST_SUITE( FileConfigTestCase );
  49         CPPUNIT_TEST( Path );
  50         CPPUNIT_TEST( AddEntries );
  51         CPPUNIT_TEST( GetEntries );
  52         CPPUNIT_TEST( GetGroups );
  53         CPPUNIT_TEST( HasEntry );
  54         CPPUNIT_TEST( HasGroup );
  55         CPPUNIT_TEST( Save );
  56         CPPUNIT_TEST( DeleteEntry );
  57         CPPUNIT_TEST( DeleteGroup );
  58         CPPUNIT_TEST( DeleteAll );
  59         CPPUNIT_TEST( RenameEntry );
  60         CPPUNIT_TEST( RenameGroup );
  61         CPPUNIT_TEST( DeleteLastGroup );
  62     CPPUNIT_TEST_SUITE_END();
  63
  64     void Path();
  65     void AddEntries();
  66     void GetEntries();
  67     void GetGroups();
  68     void HasEntry();
  69     void HasGroup();
  70     void Save();
  71     void DeleteEntry();
  72     void DeleteGroup();
  73     void DeleteAll();
  74     void RenameEntry();
  75     void RenameGroup();
  76     void DeleteLastGroup();
  77
  78     static wxString ChangePath(wxFileConfig& fc, const wxChar *path)
  79     {
  80         fc.SetPath(path);
  81
  82         return fc.GetPath();
  83     }
  84
  85     static wxString Dump(wxFileConfig& fc)
  86     {
  87         wxStringOutputStream sos;
  88         fc.Save(sos);
  89         return wxTextFile::Translate(sos.GetString(), wxTextFileType_Unix);
  90     }
  91
  92     void CheckGroupEntries(const wxFileConfig& fc,
  93                            const wxChar *path,
  94                            size_t nEntries,
  95                            ...);
  96     void CheckGroupSubgroups(const wxFileConfig& fc,
  97                              const wxChar *path,
  98                              size_t nGroups,
  99                              ...);
 100
 101     DECLARE_NO_COPY_CLASS(FileConfigTestCase)
 102 };
 103
 104 // register in the unnamed registry so that these tests are run by default
 105 CPPUNIT_TEST_SUITE_REGISTRATION( FileConfigTestCase );
 106
 107 // also include in it's own registry so that these tests can be run alone
 108 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( FileConfigTestCase, "FileConfigTestCase" );
 109
 110 void FileConfigTestCase::Path()
 111 {
 112     wxStringInputStream sis(testconfig);
 113     wxFileConfig fc(sis);
 114
 115     CPPUNIT_ASSERT( ChangePath(fc, _T("")) == _T("") );
 116     CPPUNIT_ASSERT( ChangePath(fc, _T("/")) == _T("") );
 117     CPPUNIT_ASSERT( ChangePath(fc, _T("root")) == _T("/root") );
 118     CPPUNIT_ASSERT( ChangePath(fc, _T("/root")) == _T("/root") );
 119     CPPUNIT_ASSERT( ChangePath(fc, _T("/root/group1/subgroup")) == _T("/root/group1/subgroup") );
 120     CPPUNIT_ASSERT( ChangePath(fc, _T("/root/group2")) == _T("/root/group2") );
 121 }
 122
 123 void FileConfigTestCase::AddEntries()
 124 {
 125     wxFileConfig fc;
 126
 127     CPPUNIT_ASSERT( Dump(fc) == _T("") );
 128
 129     fc.Write(_T("/Foo"), _T("foo"));
 130     CPPUNIT_ASSERT( Dump(fc) == _T("Foo=foo\n") );
 131
 132     fc.Write(_T("/Bar/Baz"), _T("baz"));
 133     CPPUNIT_ASSERT( Dump(fc) == _T("Foo=foo\n[Bar]\nBaz=baz\n") );
 134
 135     fc.DeleteAll();
 136     CPPUNIT_ASSERT( Dump(fc) == _T("") );
 137
 138     fc.Write(_T("/Bar/Baz"), _T("baz"));
 139     CPPUNIT_ASSERT( Dump(fc) == _T("[Bar]\nBaz=baz\n") );
 140
 141     fc.Write(_T("/Foo"), _T("foo"));
 142     CPPUNIT_ASSERT( Dump(fc) == _T("Foo=foo\n[Bar]\nBaz=baz\n") );
 143 }
 144
 145 void
 146 FileConfigTestCase::CheckGroupEntries(const wxFileConfig& fc,
 147                                       const wxChar *path,
 148                                       size_t nEntries,
 149                                       ...)
 150 {
 151     wxConfigPathChanger change(&fc, wxString(path) + _T("/"));
 152
 153     CPPUNIT_ASSERT( fc.GetNumberOfEntries() == nEntries );
 154
 155     va_list ap;
 156     va_start(ap, nEntries);
 157
 158     long cookie;
 159     wxString name;
 160     for ( bool cont = fc.GetFirstEntry(name, cookie);
 161           cont;
 162           cont = fc.GetNextEntry(name, cookie), nEntries-- )
 163     {
 164         CPPUNIT_ASSERT( name == va_arg(ap, wxChar *) );
 165     }
 166
 167     CPPUNIT_ASSERT( nEntries == 0 );
 168
 169     va_end(ap);
 170 }
 171
 172 void
 173 FileConfigTestCase::CheckGroupSubgroups(const wxFileConfig& fc,
 174                                         const wxChar *path,
 175                                         size_t nGroups,
 176                                         ...)
 177 {
 178     wxConfigPathChanger change(&fc, wxString(path) + _T("/"));
 179
 180     CPPUNIT_ASSERT( fc.GetNumberOfGroups() == nGroups );
 181
 182     va_list ap;
 183     va_start(ap, nGroups);
 184
 185     long cookie;
 186     wxString name;
 187     for ( bool cont = fc.GetFirstGroup(name, cookie);
 188           cont;
 189           cont = fc.GetNextGroup(name, cookie), nGroups-- )
 190     {
 191         CPPUNIT_ASSERT( name == va_arg(ap, wxChar *) );
 192     }
 193
 194     CPPUNIT_ASSERT( nGroups == 0 );
 195
 196     va_end(ap);
 197 }
 198
 199 void FileConfigTestCase::GetEntries()
 200 {
 201     wxStringInputStream sis(testconfig);
 202     wxFileConfig fc(sis);
 203
 204     CheckGroupEntries(fc, _T(""), 0);
 205     CheckGroupEntries(fc, _T("/root"), 1, _T("entry"));
 206     CheckGroupEntries(fc, _T("/root/group1"), 0);
 207     CheckGroupEntries(fc, _T("/root/group1/subgroup"),
 208                         2, _T("subentry"), _T("subentry2"));
 209 }
 210
 211 void FileConfigTestCase::GetGroups()
 212 {
 213     wxStringInputStream sis(testconfig);
 214     wxFileConfig fc(sis);
 215
 216     CheckGroupSubgroups(fc, _T(""), 1, _T("root"));
 217     CheckGroupSubgroups(fc, _T("/root"), 2, _T("group1"), _T("group2"));
 218     CheckGroupSubgroups(fc, _T("/root/group1"), 1, _T("subgroup"));
 219     CheckGroupSubgroups(fc, _T("/root/group2"), 0);
 220 }
 221
 222 void FileConfigTestCase::HasEntry()
 223 {
 224     wxStringInputStream sis(testconfig);
 225     wxFileConfig fc(sis);
 226
 227     CPPUNIT_ASSERT( !fc.HasEntry(_T("root")) );
 228     CPPUNIT_ASSERT( fc.HasEntry(_T("root/entry")) );
 229     CPPUNIT_ASSERT( fc.HasEntry(_T("/root/entry")) );
 230     CPPUNIT_ASSERT( fc.HasEntry(_T("root/group1/subgroup/subentry")) );
 231     CPPUNIT_ASSERT( !fc.HasEntry(_T("")) );
 232     CPPUNIT_ASSERT( !fc.HasEntry(_T("root/group1")) );
 233     CPPUNIT_ASSERT( !fc.HasEntry(_T("subgroup/subentry")) );
 234 }
 235
 236 void FileConfigTestCase::HasGroup()
 237 {
 238     wxStringInputStream sis(testconfig);
 239     wxFileConfig fc(sis);
 240
 241     CPPUNIT_ASSERT( fc.HasGroup(_T("root")) );
 242     CPPUNIT_ASSERT( fc.HasGroup(_T("root/group1")) );
 243     CPPUNIT_ASSERT( fc.HasGroup(_T("root/group1/subgroup")) );
 244     CPPUNIT_ASSERT( fc.HasGroup(_T("root/group2")) );
 245     CPPUNIT_ASSERT( !fc.HasGroup(_T("foot")) );
 246     CPPUNIT_ASSERT( !fc.HasGroup(_T("")) );
 247     CPPUNIT_ASSERT( !fc.HasGroup(_T("root/group")) );
 248     CPPUNIT_ASSERT( !fc.HasGroup(_T("root//subgroup")) );
 249 }
 250
 251 void FileConfigTestCase::Save()
 252 {
 253     wxStringInputStream sis(testconfig);
 254     wxFileConfig fc(sis);
 255     CPPUNIT_ASSERT( Dump(fc) == testconfig );
 256 }
 257
 258 void FileConfigTestCase::DeleteEntry()
 259 {
 260     wxStringInputStream sis(testconfig);
 261     wxFileConfig fc(sis);
 262
 263     CPPUNIT_ASSERT( !fc.DeleteEntry(_T("foo")) );
 264
 265     CPPUNIT_ASSERT( fc.DeleteEntry(_T("root/group1/subgroup/subentry")) );
 266     CPPUNIT_ASSERT( Dump(fc) == _T("[root]\n")
 267                                 _T("entry=value\n")
 268                                 _T("[root/group1]\n")
 269                                 _T("[root/group1/subgroup]\n")
 270                                 _T("subentry2=subvalue2\n")
 271                                 _T("[root/group2]\n") );
 272
 273     // group should be deleted now as well as it became empty
 274     wxConfigPathChanger change(&fc, _T("root/group1/subgroup/subentry2"));
 275     CPPUNIT_ASSERT( fc.DeleteEntry(_T("subentry2")) );
 276     CPPUNIT_ASSERT( Dump(fc) == _T("[root]\n")
 277                                 _T("entry=value\n")
 278                                 _T("[root/group1]\n")
 279                                 _T("[root/group2]\n") );
 280 }
 281
 282 void FileConfigTestCase::DeleteGroup()
 283 {
 284     wxStringInputStream sis(testconfig);
 285     wxFileConfig fc(sis);
 286
 287     CPPUNIT_ASSERT( !fc.DeleteGroup(_T("foo")) );
 288
 289     CPPUNIT_ASSERT( fc.DeleteGroup(_T("root/group1")) );
 290     CPPUNIT_ASSERT( Dump(fc) == _T("[root]\n")
 291                                 _T("entry=value\n")
 292                                 _T("[root/group2]\n") );
 293
 294     CPPUNIT_ASSERT( fc.DeleteGroup(_T("root/group2")) );
 295     CPPUNIT_ASSERT( Dump(fc) == _T("[root]\n")
 296                                 _T("entry=value\n") );
 297
 298     CPPUNIT_ASSERT( fc.DeleteGroup(_T("root")) );
 299     CPPUNIT_ASSERT( Dump(fc).empty() );
 300 }
 301
 302 void FileConfigTestCase::DeleteAll()
 303 {
 304     wxStringInputStream sis(testconfig);
 305     wxFileConfig fc(sis);
 306
 307     CPPUNIT_ASSERT( fc.DeleteAll() );
 308     CPPUNIT_ASSERT( Dump(fc).empty() );
 309 }
 310
 311 void FileConfigTestCase::RenameEntry()
 312 {
 313     wxStringInputStream sis(testconfig);
 314     wxFileConfig fc(sis);
 315
 316     fc.SetPath(_T("root"));
 317     CPPUNIT_ASSERT( fc.RenameEntry(_T("entry"), _T("newname")) );
 318     CPPUNIT_ASSERT( Dump(fc) == _T("[root]\n")
 319                                 _T("newname=value\n")
 320                                 _T("[root/group1]\n")
 321                                 _T("[root/group1/subgroup]\n")
 322                                 _T("subentry=subvalue\n")
 323                                 _T("subentry2=subvalue2\n")
 324                                 _T("[root/group2]\n") );
 325
 326     fc.SetPath(_T("group1/subgroup"));
 327     CPPUNIT_ASSERT( !fc.RenameEntry(_T("entry"), _T("newname")) );
 328     CPPUNIT_ASSERT( !fc.RenameEntry(_T("subentry"), _T("subentry2")) );
 329
 330     CPPUNIT_ASSERT( fc.RenameEntry(_T("subentry"), _T("subentry1")) );
 331     CPPUNIT_ASSERT( Dump(fc) == _T("[root]\n")
 332                                 _T("newname=value\n")
 333                                 _T("[root/group1]\n")
 334                                 _T("[root/group1/subgroup]\n")
 335                                 _T("subentry2=subvalue2\n")
 336                                 _T("subentry1=subvalue\n")
 337                                 _T("[root/group2]\n") );
 338 }
 339
 340 void FileConfigTestCase::RenameGroup()
 341 {
 342     wxStringInputStream sis(testconfig);
 343     wxFileConfig fc(sis);
 344
 345     CPPUNIT_ASSERT( fc.RenameGroup(_T("root"), _T("foot")) );
 346     CPPUNIT_ASSERT( Dump(fc) == _T("[foot]\n")
 347                                 _T("entry=value\n")
 348                                 _T("[foot/group1]\n")
 349                                 _T("[foot/group1/subgroup]\n")
 350                                 _T("subentry=subvalue\n")
 351                                 _T("subentry2=subvalue2\n")
 352                                 _T("[foot/group2]\n") );
 353 }
 354
 355
 356 static void EmptyConfigAndWriteKey()
 357 {
 358     wxFileConfig fc(_T("deleteconftest"));
 359
 360     const wxString groupPath = _T("/root");
 361
 362     if (fc.Exists(groupPath))
 363     {
 364         // using DeleteGroup exposes the problem, using DeleteAll doesn't
 365         CPPUNIT_ASSERT( fc.DeleteGroup(groupPath) );
 366     }
 367
 368     // the config must be empty for the problem to arise
 369     CPPUNIT_ASSERT( !fc.GetNumberOfEntries(true) );
 370     CPPUNIT_ASSERT( !fc.GetNumberOfGroups(true) );
 371
 372
 373     // this crashes on second call of this function
 374     CPPUNIT_ASSERT( fc.Write(groupPath + _T("/entry"), _T("value")) );
 375 }
 376
 377 void FileConfigTestCase::DeleteLastGroup()
 378 {
 379     /*
 380     We make 2 of the same calls, first to create a file config with a single
 381     group and key...
 382     */
 383     ::EmptyConfigAndWriteKey();
 384
 385     /*
 386     ... then the same but this time the key's group is deleted before the
 387     key is written again. This causes a crash.
 388     */
 389     ::EmptyConfigAndWriteKey();
 390
 391
 392     // clean up
 393     wxLogNull noLogging;
 394     (void) ::wxRemoveFile(
 395         wxFileConfig::GetLocalFileName(_T("deleteconftest")) );
 396 }
 397
 398 #endif // wxUSE_FILECONFIG
 399