test/test_db.py

   1 #
   2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
   3 # This module is free software, and you may redistribute it and/or modify
   4 # under the same terms as Python, so long as this copyright message and
   5 # disclaimer are retained in their original form.
   6 #
   7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
   8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
   9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
  10 # POSSIBILITY OF SUCH DAMAGE.
  11 #
  12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  14 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
  15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
  16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  17 #
  18 # $Id: test_db.py,v 1.20 2002-04-03 05:54:31 richard Exp $
  19
  20 import unittest, os, shutil
  21
  22 from roundup.hyperdb import String, Password, Link, Multilink, Date, \
  23     Interval, Class, DatabaseError
  24 from roundup.roundupdb import FileClass
  25 from roundup import date, password
  26
  27 def setupSchema(db, create):
  28     status = Class(db, "status", name=String())
  29     status.setkey("name")
  30     if create:
  31         status.create(name="unread")
  32         status.create(name="in-progress")
  33         status.create(name="testing")
  34         status.create(name="resolved")
  35     Class(db, "user", username=String(), password=Password())
  36     Class(db, "issue", title=String(), status=Link("status"),
  37         nosy=Multilink("user"), deadline=Date(), foo=Interval())
  38     FileClass(db, "file", name=String(), type=String())
  39     db.commit()
  40
  41 class MyTestCase(unittest.TestCase):
  42     def tearDown(self):
  43         if os.path.exists('_test_dir'):
  44             shutil.rmtree('_test_dir')
  45
  46 class config:
  47     DATABASE='_test_dir'
  48     MAILHOST = 'localhost'
  49     MAIL_DOMAIN = 'fill.me.in.'
  50     INSTANCE_NAME = 'Roundup issue tracker'
  51     ISSUE_TRACKER_EMAIL = 'issue_tracker@%s'%MAIL_DOMAIN
  52     ISSUE_TRACKER_WEB = 'http://some.useful.url/'
  53     ADMIN_EMAIL = 'roundup-admin@%s'%MAIL_DOMAIN
  54     FILTER_POSITION = 'bottom'      # one of 'top', 'bottom', 'top and bottom'
  55     ANONYMOUS_ACCESS = 'deny'       # either 'deny' or 'allow'
  56     ANONYMOUS_REGISTER = 'deny'     # either 'deny' or 'allow'
  57     MESSAGES_TO_AUTHOR = 'no'       # either 'yes' or 'no'
  58     EMAIL_SIGNATURE_POSITION = 'bottom'
  59
  60 class anydbmDBTestCase(MyTestCase):
  61     def setUp(self):
  62         from roundup.backends import anydbm
  63         # remove previous test, ignore errors
  64         if os.path.exists(config.DATABASE):
  65             shutil.rmtree(config.DATABASE)
  66         os.makedirs(config.DATABASE + '/files')
  67         self.db = anydbm.Database(config, 'test')
  68         setupSchema(self.db, 1)
  69
  70     def testChanges(self):
  71         self.db.issue.create(title="spam", status='1')
  72         self.db.issue.create(title="eggs", status='2')
  73         self.db.issue.create(title="ham", status='4')
  74         self.db.issue.create(title="arguments", status='2')
  75         self.db.issue.create(title="abuse", status='1')
  76         self.db.issue.addprop(fixer=Link("user"))
  77         props = self.db.issue.getprops()
  78         keys = props.keys()
  79         keys.sort()
  80         self.assertEqual(keys, ['deadline', 'fixer', 'foo', 'id', 'nosy',
  81             'status', 'title'])
  82         self.db.issue.set('5', status='2')
  83         self.db.issue.get('5', "status")
  84
  85         a = self.db.issue.get('5', "deadline")
  86         self.db.issue.set('5', deadline=date.Date())
  87         b = self.db.issue.get('5', "deadline")
  88         self.db.commit()
  89         self.assertNotEqual(a, b)
  90         self.assertNotEqual(b, date.Date('1970-1-1 00:00:00'))
  91         self.db.issue.set('5', deadline=date.Date())
  92
  93         a = self.db.issue.get('5', "foo")
  94         self.db.issue.set('5', foo=date.Interval('-1d'))
  95         self.assertNotEqual(a, self.db.issue.get('5', "foo"))
  96
  97         self.db.status.get('2', "name")
  98         self.db.issue.get('5', "title")
  99         self.db.issue.find(status = self.db.status.lookup("in-progress"))
 100         self.db.commit()
 101         self.db.issue.history('5')
 102         self.db.status.history('1')
 103         self.db.status.history('2')
 104
 105     def testSerialisation(self):
 106         self.db.issue.create(title="spam", status='1',
 107             deadline=date.Date(), foo=date.Interval('-1d'))
 108         self.db.commit()
 109         assert isinstance(self.db.issue.get('1', 'deadline'), date.Date)
 110         assert isinstance(self.db.issue.get('1', 'foo'), date.Interval)
 111         self.db.user.create(username="fozzy",
 112             password=password.Password('t. bear'))
 113         self.db.commit()
 114         assert isinstance(self.db.user.get('1', 'password'), password.Password)
 115
 116     def testTransactions(self):
 117         # remember the number of items we started
 118         num_issues = len(self.db.issue.list())
 119         num_files = self.db.numfiles()
 120         self.db.issue.create(title="don't commit me!", status='1')
 121         self.assertNotEqual(num_issues, len(self.db.issue.list()))
 122         self.db.rollback()
 123         self.assertEqual(num_issues, len(self.db.issue.list()))
 124         self.db.issue.create(title="please commit me!", status='1')
 125         self.assertNotEqual(num_issues, len(self.db.issue.list()))
 126         self.db.commit()
 127         self.assertNotEqual(num_issues, len(self.db.issue.list()))
 128         self.db.rollback()
 129         self.assertNotEqual(num_issues, len(self.db.issue.list()))
 130         self.db.file.create(name="test", type="text/plain", content="hi")
 131         self.db.rollback()
 132         self.assertEqual(num_files, self.db.numfiles())
 133         for i in range(10):
 134             self.db.file.create(name="test", type="text/plain",
 135                     content="hi %d"%(i))
 136             self.db.commit()
 137         num_files2 = self.db.numfiles()
 138         self.assertNotEqual(num_files, num_files2)
 139         self.db.file.create(name="test", type="text/plain", content="hi")
 140         self.db.rollback()
 141         self.assertNotEqual(num_files, self.db.numfiles())
 142         self.assertEqual(num_files2, self.db.numfiles())
 143
 144
 145
 146     def testExceptions(self):
 147         # this tests the exceptions that should be raised
 148         ar = self.assertRaises
 149
 150         #
 151         # class create
 152         #
 153         # string property
 154         ar(TypeError, self.db.status.create, name=1)
 155         # invalid property name
 156         ar(KeyError, self.db.status.create, foo='foo')
 157         # key name clash
 158         ar(ValueError, self.db.status.create, name='unread')
 159         # invalid link index
 160         ar(IndexError, self.db.issue.create, title='foo', status='bar')
 161         # invalid link value
 162         ar(ValueError, self.db.issue.create, title='foo', status=1)
 163         # invalid multilink type
 164         ar(TypeError, self.db.issue.create, title='foo', status='1',
 165             nosy='hello')
 166         # invalid multilink index type
 167         ar(ValueError, self.db.issue.create, title='foo', status='1',
 168             nosy=[1])
 169         # invalid multilink index
 170         ar(IndexError, self.db.issue.create, title='foo', status='1',
 171             nosy=['10'])
 172
 173         #
 174         # class get
 175         #
 176         # invalid node id
 177         ar(IndexError, self.db.status.get, '10', 'name')
 178         # invalid property name
 179         ar(KeyError, self.db.status.get, '2', 'foo')
 180
 181         #
 182         # class set
 183         #
 184         # invalid node id
 185         ar(IndexError, self.db.issue.set, '1', name='foo')
 186         # invalid property name
 187         ar(KeyError, self.db.status.set, '1', foo='foo')
 188         # string property
 189         ar(TypeError, self.db.status.set, '1', name=1)
 190         # key name clash
 191         ar(ValueError, self.db.status.set, '2', name='unread')
 192         # set up a valid issue for me to work on
 193         self.db.issue.create(title="spam", status='1')
 194         # invalid link index
 195         ar(IndexError, self.db.issue.set, '1', title='foo', status='bar')
 196         # invalid link value
 197         ar(ValueError, self.db.issue.set, '1', title='foo', status=1)
 198         # invalid multilink type
 199         ar(TypeError, self.db.issue.set, '1', title='foo', status='1',
 200             nosy='hello')
 201         # invalid multilink index type
 202         ar(ValueError, self.db.issue.set, '1', title='foo', status='1',
 203             nosy=[1])
 204         # invalid multilink index
 205         ar(IndexError, self.db.issue.set, '1', title='foo', status='1',
 206             nosy=['10'])
 207
 208     def testJournals(self):
 209         self.db.issue.addprop(fixer=Link("user", do_journal='yes'))
 210         self.db.user.create(username="mary")
 211         self.db.user.create(username="pete")
 212         self.db.issue.create(title="spam", status='1')
 213         self.db.commit()
 214
 215         # journal entry for issue create
 216         journal = self.db.getjournal('issue', '1')
 217         self.assertEqual(1, len(journal))
 218         (nodeid, date_stamp, journaltag, action, params) = journal[0]
 219         self.assertEqual(nodeid, '1')
 220         self.assertEqual(journaltag, 'test')
 221         self.assertEqual(action, 'create')
 222         keys = params.keys()
 223         keys.sort()
 224         self.assertEqual(keys, ['deadline', 'fixer', 'foo', 'nosy',
 225             'status', 'title'])
 226         self.assertEqual(None,params['deadline'])
 227         self.assertEqual(None,params['fixer'])
 228         self.assertEqual(None,params['foo'])
 229         self.assertEqual([],params['nosy'])
 230         self.assertEqual('1',params['status'])
 231         self.assertEqual('spam',params['title'])
 232
 233         # journal entry for link
 234         journal = self.db.getjournal('user', '1')
 235         self.assertEqual(1, len(journal))
 236         self.db.issue.set('1', fixer='1')
 237         self.db.commit()
 238         journal = self.db.getjournal('user', '1')
 239         self.assertEqual(2, len(journal))
 240         (nodeid, date_stamp, journaltag, action, params) = journal[1]
 241         self.assertEqual('1', nodeid)
 242         self.assertEqual('test', journaltag)
 243         self.assertEqual('link', action)
 244         self.assertEqual(('issue', '1', 'fixer'), params)
 245
 246         # journal entry for unlink
 247         self.db.issue.set('1', fixer='2')
 248         self.db.commit()
 249         journal = self.db.getjournal('user', '1')
 250         self.assertEqual(3, len(journal))
 251         (nodeid, date_stamp, journaltag, action, params) = journal[2]
 252         self.assertEqual('1', nodeid)
 253         self.assertEqual('test', journaltag)
 254         self.assertEqual('unlink', action)
 255         self.assertEqual(('issue', '1', 'fixer'), params)
 256
 257     def testPack(self):
 258         self.db.issue.create(title="spam", status='1')
 259         self.db.commit()
 260         self.db.issue.set('1', status='2')
 261         self.db.commit()
 262         self.db.issue.set('1', status='3')
 263         self.db.commit()
 264         pack_before = date.Date(". + 1d")
 265         self.db.pack(pack_before)
 266         journal = self.db.getjournal('issue', '1')
 267         self.assertEqual(2, len(journal))
 268
 269     def testRetire(self):
 270         pass
 271
 272
 273 class anydbmReadOnlyDBTestCase(MyTestCase):
 274     def setUp(self):
 275         from roundup.backends import anydbm
 276         # remove previous test, ignore errors
 277         if os.path.exists(config.DATABASE):
 278             shutil.rmtree(config.DATABASE)
 279         os.makedirs(config.DATABASE + '/files')
 280         db = anydbm.Database(config, 'test')
 281         setupSchema(db, 1)
 282         self.db = anydbm.Database(config)
 283         setupSchema(self.db, 0)
 284
 285     def testExceptions(self):
 286         # this tests the exceptions that should be raised
 287         ar = self.assertRaises
 288
 289         # this tests the exceptions that should be raised
 290         ar(DatabaseError, self.db.status.create, name="foo")
 291         ar(DatabaseError, self.db.status.set, '1', name="foo")
 292         ar(DatabaseError, self.db.status.retire, '1')
 293
 294
 295 class bsddbDBTestCase(anydbmDBTestCase):
 296     def setUp(self):
 297         from roundup.backends import bsddb
 298         # remove previous test, ignore errors
 299         if os.path.exists(config.DATABASE):
 300             shutil.rmtree(config.DATABASE)
 301         os.makedirs(config.DATABASE + '/files')
 302         self.db = bsddb.Database(config, 'test')
 303         setupSchema(self.db, 1)
 304
 305 class bsddbReadOnlyDBTestCase(anydbmReadOnlyDBTestCase):
 306     def setUp(self):
 307         from roundup.backends import bsddb
 308         # remove previous test, ignore errors
 309         if os.path.exists(config.DATABASE):
 310             shutil.rmtree(config.DATABASE)
 311         os.makedirs(config.DATABASE + '/files')
 312         db = bsddb.Database(config, 'test')
 313         setupSchema(db, 1)
 314         self.db = bsddb.Database(config)
 315         setupSchema(self.db, 0)
 316
 317
 318 class bsddb3DBTestCase(anydbmDBTestCase):
 319     def setUp(self):
 320         from roundup.backends import bsddb3
 321         # remove previous test, ignore errors
 322         if os.path.exists(config.DATABASE):
 323             shutil.rmtree(config.DATABASE)
 324         os.makedirs(config.DATABASE + '/files')
 325         self.db = bsddb3.Database(config, 'test')
 326         setupSchema(self.db, 1)
 327
 328 class bsddb3ReadOnlyDBTestCase(anydbmReadOnlyDBTestCase):
 329     def setUp(self):
 330         from roundup.backends import bsddb3
 331         # remove previous test, ignore errors
 332         if os.path.exists(config.DATABASE):
 333             shutil.rmtree(config.DATABASE)
 334         os.makedirs(config.DATABASE + '/files')
 335         db = bsddb3.Database(config, 'test')
 336         setupSchema(db, 1)
 337         self.db = bsddb3.Database(config)
 338         setupSchema(self.db, 0)
 339
 340
 341 def suite():
 342     l = [
 343          unittest.makeSuite(anydbmDBTestCase, 'test'),
 344          unittest.makeSuite(anydbmReadOnlyDBTestCase, 'test')
 345     ]
 346
 347     try:
 348         import bsddb
 349         l.append(unittest.makeSuite(bsddbDBTestCase, 'test'))
 350         l.append(unittest.makeSuite(bsddbReadOnlyDBTestCase, 'test'))
 351     except:
 352         print 'bsddb module not found, skipping bsddb DBTestCase'
 353
 354 #    try:
 355 #        import bsddb3
 356 #        l.append(unittest.makeSuite(bsddb3DBTestCase, 'test'))
 357 #        l.append(unittest.makeSuite(bsddb3ReadOnlyDBTestCase, 'test'))
 358 #    except:
 359 #        print 'bsddb3 module not found, skipping bsddb3 DBTestCase'
 360
 361     return unittest.TestSuite(l)
 362
 363 #
 364 # $Log: not supported by cvs2svn $
 365 # Revision 1.19  2002/02/25 14:34:31  grubert
 366 #  . use blobfiles in back_anydbm which is used in back_bsddb.
 367 #    change test_db as dirlist does not work for subdirectories.
 368 #    ATTENTION: blobfiles now creates subdirectories for files.
 369 #
 370 # Revision 1.18  2002/01/22 07:21:13  richard
 371 # . fixed back_bsddb so it passed the journal tests
 372 #
 373 # ... it didn't seem happy using the back_anydbm _open method, which is odd.
 374 # Yet another occurrance of whichdb not being able to recognise older bsddb
 375 # databases. Yadda yadda. Made the HYPERDBDEBUG stuff more sane in the
 376 # process.
 377 #
 378 # Revision 1.17  2002/01/22 05:06:09  rochecompaan
 379 # We need to keep the last 'set' entry in the journal to preserve
 380 # information on 'activity' for nodes.
 381 #
 382 # Revision 1.16  2002/01/21 16:33:20  rochecompaan
 383 # You can now use the roundup-admin tool to pack the database
 384 #
 385 # Revision 1.15  2002/01/19 13:16:04  rochecompaan
 386 # Journal entries for link and multilink properties can now be switched on
 387 # or off.
 388 #
 389 # Revision 1.14  2002/01/16 07:02:57  richard
 390 #  . lots of date/interval related changes:
 391 #    - more relaxed date format for input
 392 #
 393 # Revision 1.13  2002/01/14 02:20:15  richard
 394 #  . changed all config accesses so they access either the instance or the
 395 #    config attriubute on the db. This means that all config is obtained from
 396 #    instance_config instead of the mish-mash of classes. This will make
 397 #    switching to a ConfigParser setup easier too, I hope.
 398 #
 399 # At a minimum, this makes migration a _little_ easier (a lot easier in the
 400 # 0.5.0 switch, I hope!)
 401 #
 402 # Revision 1.12  2001/12/17 03:52:48  richard
 403 # Implemented file store rollback. As a bonus, the hyperdb is now capable of
 404 # storing more than one file per node - if a property name is supplied,
 405 # the file is called designator.property.
 406 # I decided not to migrate the existing files stored over to the new naming
 407 # scheme - the FileClass just doesn't specify the property name.
 408 #
 409 # Revision 1.11  2001/12/10 23:17:20  richard
 410 # Added transaction tests to test_db
 411 #
 412 # Revision 1.10  2001/12/03 21:33:39  richard
 413 # Fixes so the tests use commit and not close
 414 #
 415 # Revision 1.9  2001/12/02 05:06:16  richard
 416 # . We now use weakrefs in the Classes to keep the database reference, so
 417 #   the close() method on the database is no longer needed.
 418 #   I bumped the minimum python requirement up to 2.1 accordingly.
 419 # . #487480 ] roundup-server
 420 # . #487476 ] INSTALL.txt
 421 #
 422 # I also cleaned up the change message / post-edit stuff in the cgi client.
 423 # There's now a clearly marked "TODO: append the change note" where I believe
 424 # the change note should be added there. The "changes" list will obviously
 425 # have to be modified to be a dict of the changes, or somesuch.
 426 #
 427 # More testing needed.
 428 #
 429 # Revision 1.8  2001/10/09 07:25:59  richard
 430 # Added the Password property type. See "pydoc roundup.password" for
 431 # implementation details. Have updated some of the documentation too.
 432 #
 433 # Revision 1.7  2001/08/29 06:23:59  richard
 434 # Disabled the bsddb3 module entirely in the unit testing. See CHANGES for
 435 # details.
 436 #
 437 # Revision 1.6  2001/08/07 00:24:43  richard
 438 # stupid typo
 439 #
 440 # Revision 1.5  2001/08/07 00:15:51  richard
 441 # Added the copyright/license notice to (nearly) all files at request of
 442 # Bizar Software.
 443 #
 444 # Revision 1.4  2001/07/30 03:45:56  richard
 445 # Added more DB to test_db. Can skip tests where imports fail.
 446 #
 447 # Revision 1.3  2001/07/29 07:01:39  richard
 448 # Added vim command to all source so that we don't get no steenkin' tabs :)
 449 #
 450 # Revision 1.2  2001/07/29 04:09:20  richard
 451 # Added the fabricated property "id" to all hyperdb classes.
 452 #
 453 # Revision 1.1  2001/07/27 06:55:07  richard
 454 # moving tests -> test
 455 #
 456 # Revision 1.7  2001/07/27 06:26:43  richard
 457 # oops - wasn't deleting the test dir after the read-only tests
 458 #
 459 # Revision 1.6  2001/07/27 06:23:59  richard
 460 # consistency
 461 #
 462 # Revision 1.5  2001/07/27 06:23:09  richard
 463 # Added some new hyperdb tests to make sure we raise the right exceptions.
 464 #
 465 # Revision 1.4  2001/07/25 04:34:31  richard
 466 # Added id and log to tests files...
 467 #
 468 #
 469 # vim: set filetype=python ts=4 sw=4 et si