#
# Copyright (c) 2001 Richard Jones
# This module is free software, and you may redistribute it and/or modify
# under the same terms as Python, so long as this copyright message and
# disclaimer are retained in their original form.
#
# This module is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#
# $Id: test_htmltemplate.py,v 1.20 2002-08-13 20:16:10 gmcm Exp $
import unittest, cgi, time, os, shutil
from roundup import date, password
from roundup.htmltemplate import IndexTemplate, ItemTemplate
from roundup import template_funcs
tf = template_funcs
from roundup.i18n import _
from roundup.hyperdb import String, Password, Date, Interval, Link, \
Multilink, Boolean, Number
class TestClass:
def get(self, nodeid, attribute, default=None):
if attribute == 'string':
return 'Node %s: I am a string'%nodeid
elif attribute == 'filename':
return 'file.foo'
elif attribute == 'date':
return date.Date('2000-01-01')
elif attribute == 'boolean':
return 0
elif attribute == 'number':
return 1234
elif attribute == 'reldate':
return date.Date() + date.Interval('- 2y 1m')
elif attribute == 'interval':
return date.Interval('-3d')
elif attribute == 'link':
return '1'
elif attribute == 'multilink':
return ['1', '2']
elif attribute == 'password':
return password.Password('sekrit')
elif attribute == 'key':
return 'the key'+nodeid
elif attribute == 'html':
return 'hello, I am HTML'
elif attribute == 'multiline':
return 'hello\nworld'
elif attribute == 'email':
return 'test@foo.domain.example'
def list(self):
return ['1', '2']
def filter(self, search_matches, filterspec, sort, group):
return ['1', '2']
def getprops(self):
return {'string': String(), 'date': Date(), 'interval': Interval(),
'link': Link('other'), 'multilink': Multilink('other'),
'password': Password(), 'html': String(), 'key': String(),
'novalue': String(), 'filename': String(), 'multiline': String(),
'reldate': Date(), 'email': String(), 'boolean': Boolean(),
'number': Number()}
def labelprop(self, default_to_id=0):
return 'key'
class TestDatabase:
classes = {'other': TestClass()}
def getclass(self, name):
return TestClass()
def __getattr(self, name):
return Class()
class TestClient:
def __init__(self):
self.db = None
self.form = None
self.write = None
class FunctionCase(unittest.TestCase):
def setUp(self):
''' Set up the harness for calling the individual tests
'''
client = TestClient()
client.db = TestDatabase()
cl = TestClass()
self.args = (client, 'test_class', cl, cl.getprops(), '1', None)
def call(self, func, *args, **kws):
args = self.args + args
return func(*args, **kws)
# def do_plain(self, property, escape=0):
def testPlain_string(self):
s = 'Node 1: I am a string'
self.assertEqual(self.call(tf.do_plain, 'string'), s)
def testPlain_password(self):
self.assertEqual(self.call(tf.do_plain, 'password'), '*encrypted*')
def testPlain_html(self):
s = 'hello, I am HTML'
self.assertEqual(self.call(tf.do_plain, 'html', escape=0), s)
s = cgi.escape(s)
self.assertEqual(self.call(tf.do_plain, 'html', escape=1), s)
def testPlain_date(self):
self.assertEqual(self.call(tf.do_plain, 'date'), '2000-01-01.00:00:00')
def testPlain_interval(self):
self.assertEqual(self.call(tf.do_plain, 'interval'), '- 3d')
def testPlain_link(self):
self.assertEqual(self.call(tf.do_plain, 'link'), 'the key1')
def testPlain_multilink(self):
self.assertEqual(self.call(tf.do_plain, 'multilink'), 'the key1, the key2')
def testPlain_boolean(self):
self.assertEqual(self.call(tf.do_plain, 'boolean'), 'No')
def testPlain_number(self):
self.assertEqual(self.call(tf.do_plain,'number'), '1234')
# def do_field(self, property, size=None, showid=0):
def testField_string(self):
self.assertEqual(self.call(tf.do_field, 'string'),
'')
self.assertEqual(self.call(tf.do_field, 'string', size=10),
'')
def testField_password(self):
self.assertEqual(self.call(tf.do_field, 'password'),
'')
self.assertEqual(self.call(tf.do_field,'password', size=10),
'')
def testField_html(self):
self.assertEqual(self.call(tf.do_field, 'html'), '')
self.assertEqual(self.call(tf.do_field, 'html', size=10),
'')
def testField_date(self):
self.assertEqual(self.call(tf.do_field, 'date'),
'')
self.assertEqual(self.call(tf.do_field, 'date', size=10),
'')
def testField_interval(self):
self.assertEqual(self.call(tf.do_field,'interval'),
'')
self.assertEqual(self.call(tf.do_field, 'interval', size=10),
'')
def testField_link(self):
self.assertEqual(self.call(tf.do_field, 'link'), '''''')
def testField_multilink(self):
self.assertEqual(self.call(tf.do_field,'multilink'),
'')
self.assertEqual(self.call(tf.do_field, 'multilink', size=10),
'')
def testField_boolean(self):
self.assertEqual(self.call(tf.do_field, 'boolean'),
'YesNo')
def testField_number(self):
self.assertEqual(self.call(tf.do_field, 'number'),
'')
self.assertEqual(self.call(tf.do_field, 'number', size=10),
'')
# def do_multiline(self, property, rows=5, cols=40)
def testMultiline_string(self):
self.assertEqual(self.call(tf.do_multiline, 'multiline'),
'')
self.assertEqual(self.call(tf.do_multiline, 'multiline', rows=10),
'')
self.assertEqual(self.call(tf.do_multiline, 'multiline', cols=10),
'')
def testMultiline_nonstring(self):
s = _('[Multiline: not a string]')
self.assertEqual(self.call(tf.do_multiline, 'date'), s)
self.assertEqual(self.call(tf.do_multiline, 'interval'), s)
self.assertEqual(self.call(tf.do_multiline, 'password'), s)
self.assertEqual(self.call(tf.do_multiline, 'link'), s)
self.assertEqual(self.call(tf.do_multiline, 'multilink'), s)
self.assertEqual(self.call(tf.do_multiline, 'boolean'), s)
self.assertEqual(self.call(tf.do_multiline, 'number'), s)
# def do_menu(self, property, size=None, height=None, showid=0):
def testMenu_nonlinks(self):
s = _('[Menu: not a link]')
self.assertEqual(self.call(tf.do_menu, 'string'), s)
self.assertEqual(self.call(tf.do_menu, 'date'), s)
self.assertEqual(self.call(tf.do_menu, 'interval'), s)
self.assertEqual(self.call(tf.do_menu, 'password'), s)
self.assertEqual(self.call(tf.do_menu, 'boolean'), s)
self.assertEqual(self.call(tf.do_menu, 'number'), s)
def testMenu_link(self):
self.assertEqual(self.call(tf.do_menu, 'link'), '''''')
self.assertEqual(self.call(tf.do_menu, 'link', size=6),
'''''')
self.assertEqual(self.call(tf.do_menu, 'link', showid=1),
'''''')
def testMenu_multilink(self):
self.assertEqual(self.call(tf.do_menu, 'multilink', height=10),
'''''')
self.assertEqual(self.call(tf.do_menu, 'multilink', size=6, height=10),
'''''')
self.assertEqual(self.call(tf.do_menu, 'multilink', showid=1),
'''''')
# def do_link(self, property=None, is_download=0):
def testLink_novalue(self):
self.assertEqual(self.call(tf.do_link, 'novalue'),
_('[no %(propname)s]')%{'propname':'novalue'.capitalize()})
def testLink_string(self):
self.assertEqual(self.call(tf.do_link, 'string'),
'Node 1: I am a string')
def testLink_file(self):
self.assertEqual(self.call(tf.do_link, 'filename', is_download=1),
'file.foo')
def testLink_date(self):
self.assertEqual(self.call(tf.do_link, 'date'),
'2000-01-01.00:00:00')
def testLink_interval(self):
self.assertEqual(self.call(tf.do_link, 'interval'),
'- 3d')
def testLink_link(self):
self.assertEqual(self.call(tf.do_link, 'link'),
'the key1')
def testLink_link_id(self):
self.assertEqual(self.call(tf.do_link, 'link', showid=1),
'1')
def testLink_multilink(self):
self.assertEqual(self.call(tf.do_link, 'multilink'),
'the key1, the key2')
def testLink_multilink_id(self):
self.assertEqual(self.call(tf.do_link, 'multilink', showid=1),
'1, 2')
def testLink_boolean(self):
self.assertEqual(self.call(tf.do_link, 'boolean'),
'No')
def testLink_number(self):
self.assertEqual(self.call(tf.do_link, 'number'),
'1234')
# def do_count(self, property, **args):
def testCount_nonlinks(self):
s = _('[Count: not a Multilink]')
self.assertEqual(self.call(tf.do_count, 'string'), s)
self.assertEqual(self.call(tf.do_count, 'date'), s)
self.assertEqual(self.call(tf.do_count, 'interval'), s)
self.assertEqual(self.call(tf.do_count, 'password'), s)
self.assertEqual(self.call(tf.do_count, 'link'), s)
self.assertEqual(self.call(tf.do_count, 'boolean'), s)
self.assertEqual(self.call(tf.do_count, 'number'), s)
def testCount_multilink(self):
self.assertEqual(self.call(tf.do_count, 'multilink'), '2')
# def do_reldate(self, property, pretty=0):
def testReldate_nondate(self):
s = _('[Reldate: not a Date]')
self.assertEqual(self.call(tf.do_reldate, 'string'), s)
self.assertEqual(self.call(tf.do_reldate, 'interval'), s)
self.assertEqual(self.call(tf.do_reldate, 'password'), s)
self.assertEqual(self.call(tf.do_reldate, 'link'), s)
self.assertEqual(self.call(tf.do_reldate, 'multilink'), s)
self.assertEqual(self.call(tf.do_reldate, 'boolean'), s)
self.assertEqual(self.call(tf.do_reldate, 'number'), s)
def testReldate_date(self):
self.assertEqual(self.call(tf.do_reldate, 'reldate'), '- 2y 1m')
interval = date.Interval('- 2y 1m')
self.assertEqual(self.call(tf.do_reldate, 'reldate', pretty=1),
interval.pretty())
# def do_download(self, property):
def testDownload_novalue(self):
self.assertEqual(self.call(tf.do_download, 'novalue'),
_('[no %(propname)s]')%{'propname':'novalue'.capitalize()})
def testDownload_string(self):
self.assertEqual(self.call(tf.do_download, 'string'),
'Node 1: '
'I am a string')
def testDownload_file(self):
self.assertEqual(self.call(tf.do_download, 'filename', is_download=1),
'file.foo')
def testDownload_date(self):
self.assertEqual(self.call(tf.do_download, 'date'),
'2000-01-01.00:00:00')
def testDownload_interval(self):
self.assertEqual(self.call(tf.do_download, 'interval'),
'- 3d')
def testDownload_link(self):
self.assertEqual(self.call(tf.do_download, 'link'),
'the key1')
def testDownload_multilink(self):
self.assertEqual(self.call(tf.do_download, 'multilink'),
'the key1, '
'the key2')
def testDownload_boolean(self):
self.assertEqual(self.call(tf.do_download, 'boolean'),
'No')
def testDownload_number(self):
self.assertEqual(self.call(tf.do_download, 'number'),
'1234')
# def do_checklist(self, property, reverse=0):
def testChecklist_nonlinks(self):
s = _('[Checklist: not a link]')
self.assertEqual(self.call(tf.do_checklist, 'string'), s)
self.assertEqual(self.call(tf.do_checklist, 'date'), s)
self.assertEqual(self.call(tf.do_checklist, 'interval'), s)
self.assertEqual(self.call(tf.do_checklist, 'password'), s)
self.assertEqual(self.call(tf.do_checklist, 'boolean'), s)
self.assertEqual(self.call(tf.do_checklist, 'number'), s)
def testChecklstk_link(self):
self.assertEqual(self.call(tf.do_checklist, 'link'),
'''the key1:
the key2:
[unselected]:''')
def testChecklink_multilink(self):
self.assertEqual(self.call(tf.do_checklist, 'multilink'),
'''the key1:
the key2:''')
# def do_note(self, rows=5, cols=80):
def testNote(self):
self.assertEqual(self.call(tf.do_note), '')
# def do_list(self, property, reverse=0):
def testList_nonlinks(self):
s = _('[List: not a Multilink]')
self.assertEqual(self.call(tf.do_list, 'string'), s)
self.assertEqual(self.call(tf.do_list, 'date'), s)
self.assertEqual(self.call(tf.do_list, 'interval'), s)
self.assertEqual(self.call(tf.do_list, 'password'), s)
self.assertEqual(self.call(tf.do_list, 'link'), s)
self.assertEqual(self.call(tf.do_list, 'boolean'), s)
self.assertEqual(self.call(tf.do_list, 'number'), s)
def testList_multilink(self):
# TODO: test this (needs to have lots and lots of support!
#self.assertEqual(self.tf.do_list('multilink'),'')
pass
def testClasshelp(self):
self.assertEqual(self.call(tf.do_classhelp, 'theclass', 'prop1,prop2'),
'(?)')
# def do_email(self, property, rows=5, cols=40)
def testEmail_string(self):
self.assertEqual(self.call(tf.do_email, 'email'), 'test at foo domain example')
def testEmail_nonstring(self):
s = _('[Email: not a string]')
self.assertEqual(self.call(tf.do_email, 'date'), s)
self.assertEqual(self.call(tf.do_email, 'interval'), s)
self.assertEqual(self.call(tf.do_email, 'password'), s)
self.assertEqual(self.call(tf.do_email, 'link'), s)
self.assertEqual(self.call(tf.do_email, 'multilink'), s)
self.assertEqual(self.call(tf.do_email, 'boolean'), s)
self.assertEqual(self.call(tf.do_email, 'number'), s)
from test_db import setupSchema, MyTestCase, config
class Client:
user = 'admin'
class IndexTemplateCase(unittest.TestCase):
def setUp(self):
from roundup.backends import anydbm
# remove previous test, ignore errors
if os.path.exists(config.DATABASE):
shutil.rmtree(config.DATABASE)
os.makedirs(config.DATABASE + '/files')
self.db = anydbm.Database(config, 'test')
setupSchema(self.db, 1, anydbm)
client = Client()
client.db = self.db
client.instance = None
self.tf = tf = IndexTemplate(client, '', 'issue')
tf.props = ['title']
# admin user
self.db.user.create(username="admin", roles='Admin')
self.db.user.create(username="anonymous", roles='User')
def testBasic(self):
self.assertEqual(self.tf.execute_template('hello'), 'hello')
def testValue(self):
self.tf.nodeid = self.db.issue.create(title="spam", status='1')
self.assertEqual(self.tf.execute_template(''), 'spam')
def testColumnSelection(self):
self.tf.nodeid = self.db.issue.create(title="spam", status='1')
self.assertEqual(self.tf.execute_template(''
''
'hello'), 'spam')
self.tf.props = ['bar']
self.assertEqual(self.tf.execute_template(''
''
'hello'), 'hello')
def testSecurityPass(self):
self.assertEqual(self.tf.execute_template(
'hellofoo'), 'hello')
def testSecurityPassValue(self):
self.tf.nodeid = self.db.issue.create(title="spam", status='1')
self.assertEqual(self.tf.execute_template(
''
''
'not allowed'), 'spam')
def testSecurityFail(self):
self.tf.client.user = 'anonymous'
self.assertEqual(self.tf.execute_template(
'hellofoo'), 'foo')
def testSecurityFailValue(self):
self.tf.nodeid = self.db.issue.create(title="spam", status='1')
self.tf.client.user = 'anonymous'
self.assertEqual(self.tf.execute_template(
'allowed'
''), 'spam')
def tearDown(self):
if os.path.exists('_test_dir'):
shutil.rmtree('_test_dir')
class ItemTemplateCase(unittest.TestCase):
def setUp(self):
''' Set up the harness for calling the individual tests
'''
from roundup.backends import anydbm
# remove previous test, ignore errors
if os.path.exists(config.DATABASE):
shutil.rmtree(config.DATABASE)
os.makedirs(config.DATABASE + '/files')
self.db = anydbm.Database(config, 'test')
setupSchema(self.db, 1, anydbm)
client = Client()
client.db = self.db
client.instance = None
self.tf = tf = IndexTemplate(client, '', 'issue')
tf.nodeid = self.db.issue.create(title="spam", status='1')
# admin user
self.db.user.create(username="admin", roles='Admin')
self.db.user.create(username="anonymous", roles='User')
def testBasic(self):
self.assertEqual(self.tf.execute_template('hello'), 'hello')
def testValue(self):
self.assertEqual(self.tf.execute_template(''), 'spam')
def testSecurityPass(self):
self.assertEqual(self.tf.execute_template(
'hellofoo'), 'hello')
def testSecurityPassValue(self):
self.assertEqual(self.tf.execute_template(
''
''
'not allowed'), 'spam')
def testSecurityFail(self):
self.tf.client.user = 'anonymous'
self.assertEqual(self.tf.execute_template(
'hellofoo'), 'foo')
def testSecurityFailValue(self):
self.tf.client.user = 'anonymous'
self.assertEqual(self.tf.execute_template(
'allowed'
''), 'spam')
def tearDown(self):
if os.path.exists('_test_dir'):
shutil.rmtree('_test_dir')
def suite():
return unittest.TestSuite([
unittest.makeSuite(FunctionCase, 'test'),
#unittest.makeSuite(IndexTemplateCase, 'test'),
#unittest.makeSuite(ItemTemplateCase, 'test'),
])
#
# $Log: not supported by cvs2svn $
# Revision 1.19 2002/07/26 08:27:00 richard
# Very close now. The cgi and mailgw now use the new security API. The two
# templates have been migrated to that setup. Lots of unit tests. Still some
# issue in the web form for editing Roles assigned to users.
#
# Revision 1.18 2002/07/25 07:14:06 richard
# Bugger it. Here's the current shape of the new security implementation.
# Still to do:
# . call the security funcs from cgi and mailgw
# . change shipped templates to include correct initialisation and remove
# the old config vars
# ... that seems like a lot. The bulk of the work has been done though. Honest :)
#
# Revision 1.17 2002/07/18 23:07:07 richard
# Unit tests and a few fixes.
#
# Revision 1.16 2002/07/09 05:20:09 richard
# . added email display function - mangles email addrs so they're not so easily
# scraped from the web
#
# Revision 1.15 2002/07/08 06:39:00 richard
# Fixed unit test support class so the tests ran again.
#
# Revision 1.14 2002/05/15 06:37:31 richard
# ehem and the unit test
#
# Revision 1.13 2002/04/03 05:54:31 richard
# Fixed serialisation problem by moving the serialisation step out of the
# hyperdb.Class (get, set) into the hyperdb.Database.
#
# Also fixed htmltemplate after the showid changes I made yesterday.
#
# Unit tests for all of the above written.
#
# Revision 1.12 2002/03/29 19:41:48 rochecompaan
# . Fixed display of mutlilink properties when using the template
# functions, menu and plain.
#
# Revision 1.11 2002/02/21 23:11:45 richard
# . fixed some problems in date calculations (calendar.py doesn't handle over-
# and under-flow). Also, hour/minute/second intervals may now be more than
# 99 each.
#
# Revision 1.10 2002/02/21 06:57:39 richard
# . Added popup help for classes using the classhelp html template function.
# - add
# to an item page, and it generates a link to a popup window which displays
# the id, name and description for the priority class. The description
# field won't exist in most installations, but it will be added to the
# default templates.
#
# Revision 1.9 2002/02/15 07:08:45 richard
# . Alternate email addresses are now available for users. See the MIGRATION
# file for info on how to activate the feature.
#
# Revision 1.8 2002/02/06 03:47:16 richard
# . #511586 ] unittest FAIL: testReldate_date
#
# Revision 1.7 2002/01/23 20:09:41 jhermann
# Proper fix for failing test
#
# Revision 1.6 2002/01/23 05:47:57 richard
# more HTML template cleanup and unit tests
#
# Revision 1.5 2002/01/23 05:10:28 richard
# More HTML template cleanup and unit tests.
# - download() now implemented correctly, replacing link(is_download=1) [fixed in the
# templates, but link(is_download=1) will still work for existing templates]
#
# Revision 1.4 2002/01/22 22:46:22 richard
# more htmltemplate cleanups and unit tests
#
# Revision 1.3 2002/01/22 06:35:40 richard
# more htmltemplate tests and cleanup
#
# Revision 1.2 2002/01/22 00:12:07 richard
# Wrote more unit tests for htmltemplate, and while I was at it, I polished
# off the implementation of some of the functions so they behave sanely.
#
# Revision 1.1 2002/01/21 11:05:48 richard
# New tests for htmltemplate (well, it's a beginning)
#
#
#
# vim: set filetype=python ts=4 sw=4 et si