src/engine/SCons/SConsignTests.py

   1 #
   2 # __COPYRIGHT__
   3 #
   4 # Permission is hereby granted, free of charge, to any person obtaining
   5 # a copy of this software and associated documentation files (the
   6 # "Software"), to deal in the Software without restriction, including
   7 # without limitation the rights to use, copy, modify, merge, publish,
   8 # distribute, sublicense, and/or sell copies of the Software, and to
   9 # permit persons to whom the Software is furnished to do so, subject to
  10 # the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included
  13 # in all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  16 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  17 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  19 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  20 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22 #
  23
  24 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  25
  26 import os
  27 import sys
  28 import TestCmd
  29 import unittest
  30
  31 import SCons.dblite
  32
  33 import SCons.SConsign
  34
  35 class BuildInfo:
  36     def merge(self, object):
  37         pass
  38
  39 class DummySConsignEntry:
  40     def __init__(self, name):
  41         self.name = name
  42         self.binfo = BuildInfo()
  43     def convert_to_sconsign(self):
  44         self.c_to_s = 1
  45     def convert_from_sconsign(self, dir, name):
  46         self.c_from_s = 1
  47
  48 class FS:
  49     def __init__(self, top):
  50         self.Top = top
  51         self.Top.repositories = []
  52
  53 class DummyNode:
  54     def __init__(self, path='not_a_valid_path', binfo=None):
  55         self.path = path
  56         self.tpath = path
  57         self.fs = FS(self)
  58         self.binfo = binfo
  59     def get_stored_info(self):
  60         return self.binfo
  61     def get_binfo(self):
  62         return self.binfo
  63
  64 class SConsignTestCase(unittest.TestCase):
  65     def setUp(self):
  66         self.save_cwd = os.getcwd()
  67         self.test = TestCmd.TestCmd(workdir = '')
  68         os.chdir(self.test.workpath(''))
  69     def tearDown(self):
  70         self.test.cleanup()
  71         SCons.SConsign.Reset()
  72         os.chdir(self.save_cwd)
  73
  74 class BaseTestCase(SConsignTestCase):
  75
  76     def test_Base(self):
  77         aaa = DummySConsignEntry('aaa')
  78         bbb = DummySConsignEntry('bbb')
  79         bbb.arg1 = 'bbb arg1'
  80         ccc = DummySConsignEntry('ccc')
  81         ccc.arg2 = 'ccc arg2'
  82
  83         f = SCons.SConsign.Base()
  84         f.set_entry('aaa', aaa)
  85         f.set_entry('bbb', bbb)
  86
  87         #f.merge()
  88
  89         e = f.get_entry('aaa')
  90         assert e == aaa, e
  91         assert e.name == 'aaa', e.name
  92
  93         e = f.get_entry('bbb')
  94         assert e == bbb, e
  95         assert e.name == 'bbb', e.name
  96         assert e.arg1 == 'bbb arg1', e.arg1
  97         assert not hasattr(e, 'arg2'), e
  98
  99         f.set_entry('bbb', ccc)
 100
 101         e = f.get_entry('bbb')
 102         assert e.name == 'ccc', e.name
 103         assert not hasattr(e, 'arg1'), e
 104         assert e.arg2 == 'ccc arg2', e.arg1
 105
 106         ddd = DummySConsignEntry('ddd')
 107         eee = DummySConsignEntry('eee')
 108         fff = DummySConsignEntry('fff')
 109         fff.arg = 'fff arg'
 110
 111         f = SCons.SConsign.Base()
 112         f.set_entry('ddd', ddd)
 113         f.set_entry('eee', eee)
 114
 115         e = f.get_entry('ddd')
 116         assert e == ddd, e
 117         assert e.name == 'ddd', e.name
 118
 119         e = f.get_entry('eee')
 120         assert e == eee, e
 121         assert e.name == 'eee', e.name
 122         assert not hasattr(e, 'arg'), e
 123
 124         f.set_entry('eee', fff)
 125
 126         e = f.get_entry('eee')
 127         assert e.name == 'fff', e.name
 128         assert e.arg == 'fff arg', e.arg
 129
 130     def test_store_info(self):
 131         aaa = DummySConsignEntry('aaa')
 132         bbb = DummySConsignEntry('bbb')
 133         bbb.arg1 = 'bbb arg1'
 134         ccc = DummySConsignEntry('ccc')
 135         ccc.arg2 = 'ccc arg2'
 136
 137         f = SCons.SConsign.Base()
 138         f.store_info('aaa', DummyNode('aaa', aaa))
 139         f.store_info('bbb', DummyNode('bbb', bbb))
 140
 141         try:
 142             e = f.get_entry('aaa')
 143         except KeyError:
 144             pass
 145         else:
 146             raise Exception("unexpected entry %s" % e)
 147
 148         try:
 149             e = f.get_entry('bbb')
 150         except KeyError:
 151             pass
 152         else:
 153             raise Exception("unexpected entry %s" % e)
 154
 155         f.merge()
 156
 157         e = f.get_entry('aaa')
 158         assert e == aaa, "aaa = %s, e = %s" % (aaa, e)
 159         assert e.name == 'aaa', e.name
 160
 161         e = f.get_entry('bbb')
 162         assert e == bbb, "bbb = %s, e = %s" % (bbb, e)
 163         assert e.name == 'bbb', e.name
 164         assert e.arg1 == 'bbb arg1', e.arg1
 165         assert not hasattr(e, 'arg2'), e
 166
 167         f.store_info('bbb', DummyNode('bbb', ccc))
 168
 169         e = f.get_entry('bbb')
 170         assert e == bbb, e
 171         assert e.name == 'bbb', e.name
 172         assert e.arg1 == 'bbb arg1', e.arg1
 173         assert not hasattr(e, 'arg2'), e
 174
 175         f.merge()
 176
 177         e = f.get_entry('bbb')
 178         assert e.name == 'ccc', e.name
 179         assert not hasattr(e, 'arg1'), e
 180         assert e.arg2 == 'ccc arg2', e.arg1
 181
 182         ddd = DummySConsignEntry('ddd')
 183         eee = DummySConsignEntry('eee')
 184         fff = DummySConsignEntry('fff')
 185         fff.arg = 'fff arg'
 186
 187         f = SCons.SConsign.Base()
 188         f.store_info('ddd', DummyNode('ddd', ddd))
 189         f.store_info('eee', DummyNode('eee', eee))
 190
 191         f.merge()
 192
 193         e = f.get_entry('ddd')
 194         assert e == ddd, e
 195         assert e.name == 'ddd', e.name
 196
 197         e = f.get_entry('eee')
 198         assert e == eee, e
 199         assert e.name == 'eee', e.name
 200         assert not hasattr(e, 'arg'), e
 201
 202         f.store_info('eee', DummyNode('eee', fff))
 203
 204         e = f.get_entry('eee')
 205         assert e == eee, e
 206         assert e.name == 'eee', e.name
 207         assert not hasattr(e, 'arg'), e
 208
 209         f.merge()
 210
 211         e = f.get_entry('eee')
 212         assert e.name == 'fff', e.name
 213         assert e.arg == 'fff arg', e.arg
 214
 215 class SConsignDBTestCase(SConsignTestCase):
 216
 217     def test_SConsignDB(self):
 218         save_DataBase = SCons.SConsign.DataBase
 219         SCons.SConsign.DataBase = {}
 220         try:
 221             d1 = SCons.SConsign.DB(DummyNode('dir1'))
 222             d1.set_entry('aaa', DummySConsignEntry('aaa name'))
 223             d1.set_entry('bbb', DummySConsignEntry('bbb name'))
 224
 225             aaa = d1.get_entry('aaa')
 226             assert aaa.name == 'aaa name'
 227             bbb = d1.get_entry('bbb')
 228             assert bbb.name == 'bbb name'
 229
 230             d2 = SCons.SConsign.DB(DummyNode('dir2'))
 231             d2.set_entry('ccc', DummySConsignEntry('ccc name'))
 232             d2.set_entry('ddd', DummySConsignEntry('ddd name'))
 233
 234             ccc = d2.get_entry('ccc')
 235             assert ccc.name == 'ccc name'
 236             ddd = d2.get_entry('ddd')
 237             assert ddd.name == 'ddd name'
 238
 239             d31 = SCons.SConsign.DB(DummyNode('dir3/sub1'))
 240             d31.set_entry('eee', DummySConsignEntry('eee name'))
 241             d31.set_entry('fff', DummySConsignEntry('fff name'))
 242
 243             eee = d31.get_entry('eee')
 244             assert eee.name == 'eee name'
 245             fff = d31.get_entry('fff')
 246             assert fff.name == 'fff name'
 247
 248             d32 = SCons.SConsign.DB(DummyNode('dir3%ssub2' % os.sep))
 249             d32.set_entry('ggg', DummySConsignEntry('ggg name'))
 250             d32.set_entry('hhh', DummySConsignEntry('hhh name'))
 251
 252             ggg = d32.get_entry('ggg')
 253             assert ggg.name == 'ggg name'
 254             hhh = d32.get_entry('hhh')
 255             assert hhh.name == 'hhh name'
 256
 257         finally:
 258
 259             SCons.SConsign.DataBase = save_DataBase
 260
 261 class SConsignDirFileTestCase(SConsignTestCase):
 262
 263     def test_SConsignDirFile(self):
 264         bi_foo = DummySConsignEntry('foo')
 265         bi_bar = DummySConsignEntry('bar')
 266
 267         f = SCons.SConsign.DirFile(DummyNode())
 268         f.set_entry('foo', bi_foo)
 269         f.set_entry('bar', bi_bar)
 270
 271         e = f.get_entry('foo')
 272         assert e == bi_foo, e
 273         assert e.name == 'foo', e.name
 274
 275         e = f.get_entry('bar')
 276         assert e == bi_bar, e
 277         assert e.name == 'bar', e.name
 278         assert not hasattr(e, 'arg'), e
 279
 280         bbb = DummySConsignEntry('bbb')
 281         bbb.arg = 'bbb arg'
 282
 283         f.set_entry('bar', bbb)
 284
 285         e = f.get_entry('bar')
 286         assert e.name == 'bbb', e.name
 287         assert e.arg == 'bbb arg', e.arg
 288
 289
 290 class SConsignFileTestCase(SConsignTestCase):
 291
 292     def test_SConsignFile(self):
 293         test = self.test
 294         file = test.workpath('sconsign_file')
 295
 296         assert SCons.SConsign.DataBase == {}, SCons.SConsign.DataBase
 297         assert SCons.SConsign.DB_Name == ".sconsign", SCons.SConsign.DB_Name
 298         assert SCons.SConsign.DB_Module is SCons.dblite, SCons.SConsign.DB_Module
 299
 300         SCons.SConsign.File(file)
 301
 302         assert SCons.SConsign.DataBase == {}, SCons.SConsign.DataBase
 303         assert SCons.SConsign.DB_Name is file, SCons.SConsign.DB_Name
 304         assert SCons.SConsign.DB_Module is SCons.dblite, SCons.SConsign.DB_Module
 305
 306         SCons.SConsign.File(None)
 307
 308         assert SCons.SConsign.DataBase == {}, SCons.SConsign.DataBase
 309         assert SCons.SConsign.DB_Name is file, SCons.SConsign.DB_Name
 310         assert SCons.SConsign.DB_Module is None, SCons.SConsign.DB_Module
 311
 312         class Fake_DBM:
 313             def open(self, name, mode):
 314                 self.name = name
 315                 self.mode = mode
 316                 return self
 317             def __getitem__(self, key):
 318                 pass
 319             def __setitem__(self, key, value):
 320                 pass
 321
 322         fake_dbm = Fake_DBM()
 323
 324         SCons.SConsign.File(file, fake_dbm)
 325
 326         assert SCons.SConsign.DataBase == {}, SCons.SConsign.DataBase
 327         assert SCons.SConsign.DB_Name is file, SCons.SConsign.DB_Name
 328         assert SCons.SConsign.DB_Module is fake_dbm, SCons.SConsign.DB_Module
 329         assert not hasattr(fake_dbm, 'name'), fake_dbm
 330         assert not hasattr(fake_dbm, 'mode'), fake_dbm
 331
 332         SCons.SConsign.ForDirectory(DummyNode(test.workpath('dir')))
 333
 334         assert not SCons.SConsign.DataBase is None, SCons.SConsign.DataBase
 335         assert fake_dbm.name == file, fake_dbm.name
 336         assert fake_dbm.mode == "c", fake_dbm.mode
 337
 338
 339 class writeTestCase(SConsignTestCase):
 340
 341     def test_write(self):
 342
 343         test = self.test
 344         file = test.workpath('sconsign_file')
 345
 346         class Fake_DBM:
 347             def __getitem__(self, key):
 348                 return None
 349             def __setitem__(self, key, value):
 350                 pass
 351             def open(self, name, mode):
 352                 self.sync_count = 0
 353                 return self
 354             def sync(self):
 355                 self.sync_count = self.sync_count + 1
 356
 357         fake_dbm = Fake_DBM()
 358
 359         SCons.SConsign.DataBase = {}
 360         SCons.SConsign.File(file, fake_dbm)
 361
 362         f = SCons.SConsign.DB(DummyNode())
 363
 364         bi_foo = DummySConsignEntry('foo')
 365         bi_bar = DummySConsignEntry('bar')
 366         f.set_entry('foo', bi_foo)
 367         f.set_entry('bar', bi_bar)
 368
 369         SCons.SConsign.write()
 370
 371         assert bi_foo.c_to_s, bi_foo.c_to_s
 372         assert bi_bar.c_to_s, bi_bar.c_to_s
 373
 374         assert fake_dbm.sync_count == 1, fake_dbm.sync_count
 375
 376
 377
 378 if __name__ == "__main__":
 379     suite = unittest.TestSuite()
 380     tclasses = [
 381         BaseTestCase,
 382         SConsignDBTestCase,
 383         SConsignDirFileTestCase,
 384         SConsignFileTestCase,
 385         writeTestCase,
 386     ]
 387     for tclass in tclasses:
 388         names = unittest.getTestCaseNames(tclass, 'test_')
 389         suite.addTests(list(map(tclass, names)))
 390     if not unittest.TextTestRunner().run(suite).wasSuccessful():
 391         sys.exit(1)
 392
 393 # Local Variables:
 394 # tab-width:4
 395 # indent-tabs-mode:nil
 396 # End:
 397 # vim: set expandtab tabstop=4 shiftwidth=4: