test/test_cgi.py

   1 #
   2 # Copyright (c) 2003 Richard Jones, rjones@ekit-inc.com
   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 # This module is distributed in the hope that it will be useful,
   8 # but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10 #
  11 # $Id: test_cgi.py,v 1.9 2003-02-14 00:31:46 richard Exp $
  12
  13 import unittest, os, shutil, errno, sys, difflib, cgi
  14
  15 from roundup.cgi import client
  16 from roundup import init, instance, password, hyperdb, date
  17
  18 class FileUpload:
  19     def __init__(self, content, filename):
  20         self.content = content
  21         self.filename = filename
  22
  23 def makeForm(args):
  24     form = cgi.FieldStorage()
  25     for k,v in args.items():
  26         if type(v) is type([]):
  27             [form.list.append(cgi.MiniFieldStorage(k, x)) for x in v]
  28         elif isinstance(v, FileUpload):
  29             x = cgi.MiniFieldStorage(k, v.content)
  30             x.filename = v.filename
  31             form.list.append(x)
  32         else:
  33             form.list.append(cgi.MiniFieldStorage(k, v))
  34     return form
  35
  36 class config:
  37     TRACKER_NAME = 'testing testing'
  38     TRACKER_WEB = 'http://testing.testing/'
  39
  40 class FormTestCase(unittest.TestCase):
  41     def setUp(self):
  42         self.dirname = '_test_cgi_form'
  43         try:
  44             shutil.rmtree(self.dirname)
  45         except OSError, error:
  46             if error.errno not in (errno.ENOENT, errno.ESRCH): raise
  47         # create the instance
  48         init.install(self.dirname, 'classic', 'anydbm')
  49         init.initialise(self.dirname, 'sekrit')
  50         # check we can load the package
  51         self.instance = instance.open(self.dirname)
  52         # and open the database
  53         self.db = self.instance.open('admin')
  54         self.db.user.create(username='Chef', address='chef@bork.bork.bork',
  55             realname='Bork, Chef', roles='User')
  56         self.db.user.create(username='mary', address='mary@test',
  57             roles='User', realname='Contrary, Mary')
  58
  59         test = self.instance.dbinit.Class(self.db, "test",
  60             string=hyperdb.String(),
  61             boolean=hyperdb.Boolean(), link=hyperdb.Link('test'),
  62             multilink=hyperdb.Multilink('test'), date=hyperdb.Date(),
  63             interval=hyperdb.Interval())
  64
  65     def parseForm(self, form, classname='test', nodeid=None):
  66         cl = client.Client(self.instance, None, {'PATH_INFO':'/'},
  67             makeForm(form))
  68         cl.classname = classname
  69         cl.nodeid = nodeid
  70         cl.db = self.db
  71         return cl.parsePropsFromForm()
  72
  73     def tearDown(self):
  74         self.db.close()
  75         try:
  76             shutil.rmtree(self.dirname)
  77         except OSError, error:
  78             if error.errno not in (errno.ENOENT, errno.ESRCH): raise
  79
  80     #
  81     # Empty form
  82     #
  83     def testNothing(self):
  84         self.assertEqual(self.parseForm({}), ({('test', None): {}}, []))
  85
  86     def testNothingWithRequired(self):
  87         self.assertRaises(ValueError, self.parseForm, {':required': 'string'})
  88         self.assertRaises(ValueError, self.parseForm,
  89             {':required': 'title,status', 'status':'1'}, 'issue')
  90         self.assertRaises(ValueError, self.parseForm,
  91             {':required': ['title','status'], 'status':'1'}, 'issue')
  92         self.assertRaises(ValueError, self.parseForm,
  93             {':required': 'status', 'status':''}, 'issue')
  94         self.assertRaises(ValueError, self.parseForm,
  95             {':required': 'nosy', 'nosy':''}, 'issue')
  96
  97     #
  98     # Nonexistant edit
  99     #
 100     def testEditNonexistant(self):
 101         self.assertRaises(IndexError, self.parseForm, {'boolean': ''},
 102             'test', '1')
 103
 104     #
 105     # String
 106     #
 107     def testEmptyString(self):
 108         self.assertEqual(self.parseForm({'string': ''}),
 109             ({('test', None): {}}, []))
 110         self.assertEqual(self.parseForm({'string': ' '}),
 111             ({('test', None): {}}, []))
 112         self.assertRaises(ValueError, self.parseForm, {'string': ['', '']})
 113
 114     def testSetString(self):
 115         self.assertEqual(self.parseForm({'string': 'foo'}),
 116             ({('test', None): {'string': 'foo'}}, []))
 117         self.assertEqual(self.parseForm({'string': 'a\r\nb\r\n'}),
 118             ({('test', None): {'string': 'a\nb'}}, []))
 119         nodeid = self.db.issue.create(title='foo')
 120         self.assertEqual(self.parseForm({'title': 'foo'}, 'issue', nodeid),
 121             ({('issue', nodeid): {}}, []))
 122
 123     def testEmptyStringSet(self):
 124         nodeid = self.db.issue.create(title='foo')
 125         self.assertEqual(self.parseForm({'title': ''}, 'issue', nodeid),
 126             ({('issue', nodeid): {'title': None}}, []))
 127         nodeid = self.db.issue.create(title='foo')
 128         self.assertEqual(self.parseForm({'title': ' '}, 'issue', nodeid),
 129             ({('issue', nodeid): {'title': None}}, []))
 130
 131     def testFileUpload(self):
 132         file = FileUpload('foo', 'foo.txt')
 133         self.assertEqual(self.parseForm({'content': file}, 'file'),
 134             ({('file', None): {'content': 'foo', 'name': 'foo.txt',
 135             'type': 'text/plain'}}, []))
 136
 137     #
 138     # Link
 139     #
 140     def testEmptyLink(self):
 141         self.assertEqual(self.parseForm({'link': ''}),
 142             ({('test', None): {}}, []))
 143         self.assertEqual(self.parseForm({'link': ' '}),
 144             ({('test', None): {}}, []))
 145         self.assertRaises(ValueError, self.parseForm, {'link': ['', '']})
 146         self.assertEqual(self.parseForm({'link': '-1'}),
 147             ({('test', None): {}}, []))
 148
 149     def testSetLink(self):
 150         self.assertEqual(self.parseForm({'status': 'unread'}, 'issue'),
 151             ({('issue', None): {'status': '1'}}, []))
 152         self.assertEqual(self.parseForm({'status': '1'}, 'issue'),
 153             ({('issue', None): {'status': '1'}}, []))
 154         nodeid = self.db.issue.create(status='unread')
 155         self.assertEqual(self.parseForm({'status': 'unread'}, 'issue', nodeid),
 156             ({('issue', nodeid): {}}, []))
 157
 158     def testUnsetLink(self):
 159         nodeid = self.db.issue.create(status='unread')
 160         self.assertEqual(self.parseForm({'status': '-1'}, 'issue', nodeid),
 161             ({('issue', nodeid): {'status': None}}, []))
 162
 163     def testInvalidLinkValue(self):
 164 # XXX This is not the current behaviour - should we enforce this?
 165 #        self.assertRaises(IndexError, self.parseForm,
 166 #            {'status': '4'}))
 167         self.assertRaises(ValueError, self.parseForm, {'link': 'frozzle'})
 168         self.assertRaises(ValueError, self.parseForm, {'status': 'frozzle'},
 169             'issue')
 170
 171     #
 172     # Multilink
 173     #
 174     def testEmptyMultilink(self):
 175         self.assertEqual(self.parseForm({'nosy': ''}),
 176             ({('test', None): {}}, []))
 177         self.assertEqual(self.parseForm({'nosy': ' '}),
 178             ({('test', None): {}}, []))
 179
 180     def testSetMultilink(self):
 181         self.assertEqual(self.parseForm({'nosy': '1'}, 'issue'),
 182             ({('issue', None): {'nosy': ['1']}}, []))
 183         self.assertEqual(self.parseForm({'nosy': 'admin'}, 'issue'),
 184             ({('issue', None): {'nosy': ['1']}}, []))
 185         self.assertEqual(self.parseForm({'nosy': ['1','2']}, 'issue'),
 186             ({('issue', None): {'nosy': ['1','2']}}, []))
 187         self.assertEqual(self.parseForm({'nosy': '1,2'}, 'issue'),
 188             ({('issue', None): {'nosy': ['1','2']}}, []))
 189         self.assertEqual(self.parseForm({'nosy': 'admin,2'}, 'issue'),
 190             ({('issue', None): {'nosy': ['1','2']}}, []))
 191
 192     def testEmptyMultilinkSet(self):
 193         nodeid = self.db.issue.create(nosy=['1','2'])
 194         self.assertEqual(self.parseForm({'nosy': ''}, 'issue', nodeid),
 195             ({('issue', nodeid): {'nosy': []}}, []))
 196         nodeid = self.db.issue.create(nosy=['1','2'])
 197         self.assertEqual(self.parseForm({'nosy': ' '}, 'issue', nodeid),
 198             ({('issue', nodeid): {'nosy': []}}, []))
 199         self.assertEqual(self.parseForm({'nosy': '1,2'}, 'issue', nodeid),
 200             ({('issue', nodeid): {}}, []))
 201
 202     def testInvalidMultilinkValue(self):
 203 # XXX This is not the current behaviour - should we enforce this?
 204 #        self.assertRaises(IndexError, self.parseForm,
 205 #            {'nosy': '4'}))
 206         self.assertRaises(ValueError, self.parseForm, {'nosy': 'frozzle'},
 207             'issue')
 208         self.assertRaises(ValueError, self.parseForm, {'nosy': '1,frozzle'},
 209             'issue')
 210         self.assertRaises(ValueError, self.parseForm, {'multilink': 'frozzle'})
 211
 212     def testMultilinkAdd(self):
 213         nodeid = self.db.issue.create(nosy=['1'])
 214         # do nothing
 215         self.assertEqual(self.parseForm({':add:nosy': ''}, 'issue', nodeid),
 216             ({('issue', nodeid): {}}, []))
 217
 218         # do something ;)
 219         self.assertEqual(self.parseForm({':add:nosy': '2'}, 'issue', nodeid),
 220             ({('issue', nodeid): {'nosy': ['1','2']}}, []))
 221         self.assertEqual(self.parseForm({':add:nosy': '2,mary'}, 'issue',
 222             nodeid), ({('issue', nodeid): {'nosy': ['1','2','4']}}, []))
 223         self.assertEqual(self.parseForm({':add:nosy': ['2','3']}, 'issue',
 224             nodeid), ({('issue', nodeid): {'nosy': ['1','2','3']}}, []))
 225
 226     def testMultilinkAddNew(self):
 227         self.assertEqual(self.parseForm({':add:nosy': ['2','3']}, 'issue'),
 228             ({('issue', None): {'nosy': ['2','3']}}, []))
 229
 230     def testMultilinkRemove(self):
 231         nodeid = self.db.issue.create(nosy=['1','2'])
 232         # do nothing
 233         self.assertEqual(self.parseForm({':remove:nosy': ''}, 'issue', nodeid),
 234             ({('issue', nodeid): {}}, []))
 235
 236         # do something ;)
 237         self.assertEqual(self.parseForm({':remove:nosy': '1'}, 'issue',
 238             nodeid), ({('issue', nodeid): {'nosy': ['2']}}, []))
 239         self.assertEqual(self.parseForm({':remove:nosy': 'admin,2'},
 240             'issue', nodeid), ({('issue', nodeid): {'nosy': []}}, []))
 241         self.assertEqual(self.parseForm({':remove:nosy': ['1','2']},
 242             'issue', nodeid), ({('issue', nodeid): {'nosy': []}}, []))
 243
 244         # add and remove
 245         self.assertEqual(self.parseForm({':add:nosy': ['3'],
 246             ':remove:nosy': ['1','2']},
 247             'issue', nodeid), ({('issue', nodeid): {'nosy': ['3']}}, []))
 248
 249         # remove one that doesn't exist?
 250         self.assertRaises(ValueError, self.parseForm, {':remove:nosy': '4'},
 251             'issue', nodeid)
 252
 253     def testMultilinkRetired(self):
 254         self.db.user.retire('2')
 255         self.assertEqual(self.parseForm({'nosy': ['2','3']}, 'issue'),
 256             ({('issue', None): {'nosy': ['2','3']}}, []))
 257         nodeid = self.db.issue.create(nosy=['1','2'])
 258         self.assertEqual(self.parseForm({':remove:nosy': '2'}, 'issue',
 259             nodeid), ({('issue', nodeid): {'nosy': ['1']}}, []))
 260         self.assertEqual(self.parseForm({':add:nosy': '3'}, 'issue', nodeid),
 261             ({('issue', nodeid): {'nosy': ['1','2','3']}}, []))
 262
 263     def testAddRemoveNonexistant(self):
 264         self.assertRaises(ValueError, self.parseForm, {':remove:foo': '2'},
 265             'issue')
 266         self.assertRaises(ValueError, self.parseForm, {':add:foo': '2'},
 267             'issue')
 268
 269     #
 270     # Password
 271     #
 272     def testEmptyPassword(self):
 273         self.assertEqual(self.parseForm({'password': ''}, 'user'),
 274             ({('user', None): {}}, []))
 275         self.assertEqual(self.parseForm({'password': ''}, 'user'),
 276             ({('user', None): {}}, []))
 277         self.assertRaises(ValueError, self.parseForm, {'password': ['', '']},
 278             'user')
 279         self.assertRaises(ValueError, self.parseForm, {'password': 'foo',
 280             'password:confirm': ['', '']}, 'user')
 281
 282     def testSetPassword(self):
 283         self.assertEqual(self.parseForm({'password': 'foo',
 284             'password:confirm': 'foo'}, 'user'),
 285             ({('user', None): {'password': 'foo'}}, []))
 286
 287     def testSetPasswordConfirmBad(self):
 288         self.assertRaises(ValueError, self.parseForm, {'password': 'foo'},
 289             'user')
 290         self.assertRaises(ValueError, self.parseForm, {'password': 'foo',
 291             'password:confirm': 'bar'}, 'user')
 292
 293     def testEmptyPasswordNotSet(self):
 294         nodeid = self.db.user.create(username='1',
 295             password=password.Password('foo'))
 296         self.assertEqual(self.parseForm({'password': ''}, 'user', nodeid),
 297             ({('user', nodeid): {}}, []))
 298         nodeid = self.db.user.create(username='2',
 299             password=password.Password('foo'))
 300         self.assertEqual(self.parseForm({'password': '',
 301             'password:confirm': ''}, 'user', nodeid),
 302             ({('user', nodeid): {}}, []))
 303
 304     #
 305     # Boolean
 306     #
 307     def testEmptyBoolean(self):
 308         self.assertEqual(self.parseForm({'boolean': ''}),
 309             ({('test', None): {}}, []))
 310         self.assertEqual(self.parseForm({'boolean': ' '}),
 311             ({('test', None): {}}, []))
 312         self.assertRaises(ValueError, self.parseForm, {'boolean': ['', '']})
 313
 314     def testSetBoolean(self):
 315         self.assertEqual(self.parseForm({'boolean': 'yes'}),
 316             ({('test', None): {'boolean': 1}}, []))
 317         self.assertEqual(self.parseForm({'boolean': 'a\r\nb\r\n'}),
 318             ({('test', None): {'boolean': 0}}, []))
 319         nodeid = self.db.test.create(boolean=1)
 320         self.assertEqual(self.parseForm({'boolean': 'yes'}, 'test', nodeid),
 321             ({('test', nodeid): {}}, []))
 322         nodeid = self.db.test.create(boolean=0)
 323         self.assertEqual(self.parseForm({'boolean': 'no'}, 'test', nodeid),
 324             ({('test', nodeid): {}}, []))
 325
 326     def testEmptyBooleanSet(self):
 327         nodeid = self.db.test.create(boolean=0)
 328         self.assertEqual(self.parseForm({'boolean': ''}, 'test', nodeid),
 329             ({('test', nodeid): {'boolean': None}}, []))
 330         nodeid = self.db.test.create(boolean=1)
 331         self.assertEqual(self.parseForm({'boolean': ' '}, 'test', nodeid),
 332             ({('test', nodeid): {'boolean': None}}, []))
 333
 334     #
 335     # Date
 336     #
 337     def testEmptyDate(self):
 338         self.assertEqual(self.parseForm({'date': ''}),
 339             ({('test', None): {}}, []))
 340         self.assertEqual(self.parseForm({'date': ' '}),
 341             ({('test', None): {}}, []))
 342         self.assertRaises(ValueError, self.parseForm, {'date': ['', '']})
 343
 344     def testSetDate(self):
 345         self.assertEqual(self.parseForm({'date': '2003-01-01'}),
 346             ({('test', None): {'date': date.Date('2003-01-01')}}, []))
 347         nodeid = self.db.test.create(date=date.Date('2003-01-01'))
 348         self.assertEqual(self.parseForm({'date': '2003-01-01'}, 'test',
 349             nodeid), ({('test', nodeid): {}}, []))
 350
 351     def testEmptyDateSet(self):
 352         nodeid = self.db.test.create(date=date.Date('.'))
 353         self.assertEqual(self.parseForm({'date': ''}, 'test', nodeid),
 354             ({('test', nodeid): {'date': None}}, []))
 355         nodeid = self.db.test.create(date=date.Date('1970-01-01.00:00:00'))
 356         self.assertEqual(self.parseForm({'date': ' '}, 'test', nodeid),
 357             ({('test', nodeid): {'date': None}}, []))
 358
 359     #
 360     # Test multiple items in form
 361     #
 362     def testMultiple(self):
 363         self.assertEqual(self.parseForm({'string': 'a', 'issue-1@title': 'b'}),
 364             ({('test', None): {'string': 'a'}, ('issue', '-1'):
 365             {'title': 'b'}}, []))
 366         nodeid = self.db.test.create()
 367         self.assertEqual(self.parseForm({'string': 'a', 'issue-1@title': 'b'},
 368             'test', nodeid), ({('test', nodeid): {'string': 'a'},
 369             ('issue', '-1'): {'title': 'b'}}, []))
 370         self.assertEqual(self.parseForm({
 371             'string': 'a',
 372             'issue-1@:add:nosy': '1',
 373             'issue-2@:link:superseder': 'issue-1',
 374             }),
 375             ({('test', None): {'string': 'a'},
 376               ('issue', '-1'): {'nosy': ['1']},
 377               ('issue', '-2'): {}},
 378               [('issue', '-2', 'superseder',
 379                 [(('issue', '-1'), ('issue', '-1'))])
 380               ]
 381             )
 382         )
 383
 384     def testLinkBadDesignator(self):
 385         self.assertRaises(ValueError, self.parseForm,
 386             {'test-1@:link:link': 'blah'})
 387         self.assertRaises(ValueError, self.parseForm,
 388             {'test-1@:link:link': 'issue'})
 389
 390     def testBackwardsCompat(self):
 391         res = self.parseForm({':note': 'spam'}, 'issue')
 392         date = res[0][('msg', '-1')]['date']
 393         self.assertEqual(res, ({('issue', None): {}, ('msg', '-1'):
 394             {'content': 'spam', 'author': '1', 'date': date}},
 395             [('issue', None, 'messages', [('msg', '-1')])]))
 396         file = FileUpload('foo', 'foo.txt')
 397         self.assertEqual(self.parseForm({':file': file}, 'issue'),
 398             ({('issue', None): {}, ('file', '-1'): {'content': 'foo',
 399             'name': 'foo.txt', 'type': 'text/plain'}},
 400             [('issue', None, 'files', [('file', '-1')])]))
 401
 402 def suite():
 403     l = [unittest.makeSuite(FormTestCase),
 404     ]
 405     return unittest.TestSuite(l)
 406
 407 def run():
 408     runner = unittest.TextTestRunner()
 409     unittest.main(testRunner=runner)
 410
 411 if __name__ == '__main__':
 412     run()
 413
 414 # vim: set filetype=python ts=4 sw=4 et si