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