code-e5bd50120b5a/test/README.txt0000644000000000000000000000257115064275501014402 0ustar 00000000000000Getting started: For running the tests, you want to take a look at the documentation in doc/developer.txt, in particular the section "Testing Notes". For a test setup of the database backends, suitable documentation is found in in doc/postgresql.txt for the Postgres backend, in the section titled "Running the PostgreSQL unit tests". For the MySQL backend the file doc/doc/mysql.txt has the documentation in section "Running the MySQL tests". A number of tests uses the infrastructure of db_test_base.py grep "from db_test_base" -l *.py benchmark.py session_common.py test_anydbm.py test_indexer.py test_memorydb.py test_mysql.py test_postgresql.py test_security.py test_sqlite.py test_userauditor.py grep "import db_test_base" -l *.py test_cgi.py test_jinja2.py test_mailgw.py test_xmlrpc.py grep "import memory\|from memory" -l *.py test_mailgw.py test_memorydb.py The remaining lines are an 2001 description from Richard, which probably is outdated: Structure of the tests: 1 Test date classes 1.1 Date 1.2 Interval 2 Set up schema 3 Open with specific backend 3.1 anydbm 4 Create database base set (stati, priority, etc) 5 Perform some actions 6 Perform mail import 6.1 text/plain 6.2 multipart/mixed (with one text/plain) 6.3 text/html 6.4 multipart/alternative (with one text/plain) 6.5 multipart/alternative (with no text/plain) code-e5bd50120b5a/test/__init__.py0000644000000000000000000000003215064275501015003 0ustar 00000000000000# make this dir a package code-e5bd50120b5a/test/benchmark.py0000644000000000000000000001477615064275501015222 0ustar 00000000000000""" Usage: python benchmark.py ["database backend list" | backend1] [backend2] Import the backend (anydbm, sqlite by default) and run some performance tests. Example: test default anypy and sqlite backends python benchmark.py test mysql and sqlite backends python benchmark.py mysql sqlite or python benchmark.py "mysql sqlite" test all backends python benchmark.py anydbm mysql postgresql sqlite """ from __future__ import print_function import sys, os, time import importlib, signal, shutil # --- patch sys.path to make sure 'import roundup' finds correct version import os.path as osp thisdir = osp.dirname(osp.abspath(__file__)) rootdir = osp.dirname(thisdir) if (osp.exists(thisdir + '/benchmark.py') and osp.exists(rootdir + '/roundup/__init__.py')): # the script is located inside roundup source code sys.path.insert(0, rootdir) from roundup.hyperdb import String, Password, Link, Multilink, Date, \ Interval, DatabaseError, Boolean, Number from roundup import date, password from test.db_test_base import config # global for the default signal hander so # my signal handler can reset before it raises signal. int_sig_default_handler = None def setupSchema(db, module): status = module.Class(db, "status", name=String()) status.setkey("name") user = module.Class(db, "user", username=String(), password=Password(), assignable=Boolean(), age=Number(), roles=String()) user.setkey("username") file = module.FileClass(db, "file", name=String(), type=String(), comment=String(indexme="yes")) issue = module.IssueClass(db, "issue", title=String(indexme="yes"), status=Link("status"), nosy=Multilink("user"), deadline=Date(), foo=Interval(), files=Multilink("file"), assignedto=Link('user')) session = module.Class(db, 'session', title=String()) session.disableJournalling() db.post_init() db.commit() def rm_db_on_signal(sig, frame): print("removing incomplete database %s due to interruption." % config.DATABASE) shutil.rmtree(config.DATABASE) signal.signal(signal.SIGINT, int_sig_default_handler) # re-raise the signal so the normal signal handling runs. signal.raise_signal(signal.SIGTERM) def main(backendname, time=time.time, numissues=10): global int_sig_default_handler try: backend = importlib.import_module("roundup.backends.back_%s" % backendname) except ImportError: print("Unable to import %s backend." % backendname) return times = [] config.DATABASE = os.path.join('_benchmark', '%s-%s'%(backendname, numissues)) config.RDBMS_NAME = "rounduptest_%s" % numissues if not os.path.exists(config.DATABASE): int_sig_default_handler = signal.signal(signal.SIGINT, rm_db_on_signal) db = backend.Database(config, 'admin') setupSchema(db, backend) # if we are re-initializing, delete any existing db db.clear() db.commit() # create a whole bunch of stuff db.user.create(**{'username': 'admin', 'roles': 'Admin'}) db.status.create(name="unread") db.status.create(name="in-progress") db.status.create(name="testing") db.status.create(name="resolved") pc = -1 for i in range(numissues): db.user.create(**{'username': 'user %s'%i, 'roles': 'User'}) for j in range(10): db.user.set(str(i+1), assignable=1) db.user.set(str(i+1), assignable=0) db.issue.create(**{'title': 'issue %s'%i}) for j in range(10): db.issue.set(str(i+1), status='2', assignedto='2', nosy=[]) db.issue.set(str(i+1), status='1', assignedto='1', nosy=['1','2']) if (i*100//numissues) != pc and 'INCI' not in os.environ: pc = (i*100//numissues) sys.stdout.write("%d%%\r"%pc) sys.stdout.flush() db.commit() signal.signal(signal.SIGINT, int_sig_default_handler) else: db = backend.Database(config, 'admin') setupSchema(db, backend) sys.stdout.write('%10s: %-6d'%(backendname[:10], numissues)) sys.stdout.flush() times.append(('start', time())) # fetch db.clearCache() for i in db.issue.list(): db.issue.get(i, 'title') times.append(('fetch', time())) # journals db.clearCache() for i in db.issue.list(): db.issue.history(i) times.append(('journal', time())) # "calculated" props db.clearCache() for i in db.issue.list(): db.issue.get(i, 'activity') db.issue.get(i, 'creator') db.issue.get(i, 'creation') times.append(('jprops', time())) # lookup db.clearCache() for i in range(numissues): db.user.lookup('user %s'%i) times.append(('lookup', time())) # filter db.clearCache() for i in range(100): db.issue.filter(None, {'assignedto': '1', 'title':'issue'}, ('+', 'activity'), ('+', 'status')) times.append(('filter', time())) # filter with multilink db.clearCache() for i in range(100): db.issue.filter(None, {'nosy': ['1'], 'assignedto': '1', 'title':'issue'}, ('+', 'activity'), ('+', 'status')) times.append(('filtml', time())) # results last = None for event, stamp in times: if last is None: first = stamp else: sys.stdout.write(' %-6.2f'%(stamp-last)) last = stamp print(' %-6.2f'%(last-first)) sys.stdout.flush() if __name__ == '__main__': if len(sys.argv) == 2: test_databases = sys.argv[1].split() elif len(sys.argv) > 2: test_databases = sys.argv[1:] else: test_databases = ['anydbm', 'sqlite'] # 0 1 2 3 4 5 6 # 01234567890123456789012345678901234567890123456789012345678901234 print('Test name fetch journl jprops lookup filter filtml TOTAL ') for name in test_databases: main(name) for name in test_databases: main(name, numissues=20) for name in test_databases: main(name, numissues=100) # don't even bother benchmarking the dbm backends > 100! try: test_databases.remove('anydbm') except ValueError: # anydbm not present; this is fine pass for name in test_databases: main(name, numissues=1000) for name in test_databases: main(name, numissues=10000) # vim: set et sts=4 sw=4 : code-e5bd50120b5a/test/cmp_helper.py0000644000000000000000000000154115064275501015370 0ustar 00000000000000class StringFragmentCmpHelper: def compareStringFragments(self, s, fragments): """Compare a string agains a list of fragments where a tuple denotes a set of alternatives """ pos = 0 for frag in fragments: if type(frag) != tuple: self.assertEqual(s[pos:pos + len(frag)], frag) pos += len(frag) else: found = False for alt in frag: if s[pos:pos + len(alt)] == alt: pos += len(alt) found = True break if not found: l = max(map(len, frag)) raise AssertionError('%s != %s' % (repr(s[pos:pos + l]), str(frag))) self.assertEqual(s[pos:], '') code-e5bd50120b5a/test/conftest.py0000644000000000000000000000223115064275501015074 0ustar 00000000000000# simple way to see if there are order dependencies in tests # can use if pytest-random-order --random-order mode isn't # usable (e.g. python2). # known issues: # python3 -m pytest -k Whoosh test/test_indexer.py fails starting with # first reversed (so last) test in module # # python3 -m pytest test/test_cgi.py # fails: FormTestCase::testCreatePermission # FormTestCase::testClassPermission # FormTestCase::testCheckAndPropertyPermission # # this failure results in a failure in test_action again with # bad permission application. Something run prior to these # tests is breaking the permission checks. #def pytest_collection_modifyitems(items): # items.reverse() # Add a marker for pg_schema tests. # They duplicate the postgresql tests exactly but uses a named # schema rather than the default 'public' schema. def pytest_configure(config): config.addinivalue_line( "markers", "pg_schema: tests using schema for postgres" ) # try to work around loss of testmon data when ^Cing out of tests. def pytest_unconfigure(config): if hasattr(config, "testmon_data"): config.testmon_data.db.con.close() code-e5bd50120b5a/test/db_test_base.py0000644000000000000000000060076515064275501015705 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. from __future__ import print_function import unittest, os, shutil, errno, sys, time, pprint, os.path try: from base64 import encodebytes as base64_encode # python3 only except ImportError: # python2 and deplricated in 3 from base64 import encodestring as base64_encode import logging from roundup.anypy.cgi_ import cgi from . import gpgmelib from email import message_from_string import pytest try: from StringIO import cStringIO as IOBuff except ImportError: # python 3 from io import BytesIO as IOBuff from roundup.cgi.client import BinaryFieldStorage from roundup.hyperdb import String, Password, Link, Multilink, Date, \ Interval, DatabaseError, Boolean, Number, Node, Integer from roundup.mailer import Mailer from roundup import date, password, init, instance, configuration, \ roundupdb, i18n, hyperdb from roundup.cgi.templating import HTMLItem from roundup.cgi.templating import HTMLProperty, _HTMLItem, anti_csrf_nonce from roundup.cgi import client, actions from roundup.cgi.engine_zopetal import RoundupPageTemplate from roundup.cgi.templating import HTMLItem from roundup.exceptions import UsageError, Reject from roundup.mlink_expr import ExpressionError from roundup.anypy.strings import b2s, bs2b, s2b, u2s from roundup.anypy.cmp_ import NoneAndDictComparable from roundup.anypy.email_ import message_from_bytes from roundup.test.mocknull import MockNull config = configuration.CoreConfig() config.DATABASE = "db" config.RDBMS_NAME = "rounduptest" config.RDBMS_HOST = "localhost" config.RDBMS_USER = "rounduptest" config.RDBMS_PASSWORD = "rounduptest" config.RDBMS_TEMPLATE = "template0" # these TRACKER_WEB and MAIL_DOMAIN values are used in mailgw tests config.MAIL_DOMAIN = "your.tracker.email.domain.example" config.TRACKER_WEB = "http://tracker.example/cgi-bin/roundup.cgi/bugs/" # override number of rounds to reduce CI time #config.PASSWORD_PBKDF2_DEFAULT_ROUNDS = 1000 # uncomment the following to have excessive debug output from test cases # FIXME: tracker logging level should be increased by -v arguments # to 'run_tests.py' script #config.LOGGING_FILENAME = "/tmp/logfile" #config.LOGGING_LEVEL = "DEBUG" config.init_logging() def setupTracker(dirname, backend="anydbm", optimize=False): """Install and initialize new tracker in dirname; return tracker instance. If the directory exists, it is wiped out before the operation. """ global config try: shutil.rmtree(dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise # create the instance init.install(dirname, os.path.join(os.path.dirname(__file__), '..', 'share', 'roundup', 'templates', 'classic')) config.RDBMS_BACKEND = backend config.save(os.path.join(dirname, 'config.ini')) tracker = instance.open(dirname, optimize=optimize) if tracker.exists(): tracker.nuke() tracker.init(password.Password('sekrit')) return tracker def setupSchema(db, create, module): mls = module.Class(db, "mls", name=String()) mls.setkey("name") keyword = module.Class(db, "keyword", name=String(), order=Number()) keyword.setkey("name") status = module.Class(db, "status", name=String(), mls=Multilink("mls")) status.setkey("name") priority = module.Class(db, "priority", name=String(), order=String()) priority.setkey("name") user = module.Class(db, "user", username=String(), password=Password(quiet=True), assignable=Boolean(quiet=True), age=Number(quiet=True), roles=String(), address=String(), rating=Integer(quiet=True), supervisor=Link('user'), realname=String(quiet=True), longnumber=Number(use_double=True)) user.setkey("username") file = module.FileClass(db, "file", name=String(), type=String(), comment=String(indexme="yes"), fooz=Password()) file_nidx = module.FileClass(db, "file_nidx", content=String(indexme='no')) # initialize quiet mode a second way without using Multilink("user", quiet=True) mynosy = Multilink("user", rev_multilink='nosy_issues') mynosy.quiet = True issue = module.IssueClass(db, "issue", title=String(indexme="yes"), status=Link("status"), nosy=mynosy, deadline=Date(quiet=True), foo=Interval(quiet=True, default_value=date.Interval('-1w')), files=Multilink("file"), assignedto=Link('user', quiet=True, rev_multilink='issues'), priority=Link('priority'), spam=Multilink('msg'), feedback=Link('msg'), keywords=Multilink('keyword'), keywords2=Multilink('keyword')) stuff = module.Class(db, "stuff", stuff=String()) session = module.Class(db, 'session', title=String()) msg = module.FileClass(db, "msg", date=Date(), author=Link("user", do_journal='no'), files=Multilink('file'), inreplyto=String(), messageid=String(), recipients=Multilink("user", do_journal='no')) session.disableJournalling() db.post_init() if create: user.create(username="admin", roles='Admin', password=password.Password('sekrit')) user.create(username="fred", roles='User', password=password.Password('sekrit'), address='fred@example.com') u1 = mls.create(name="unread_1") u2 = mls.create(name="unread_2") status.create(name="unread",mls=[u1, u2]) status.create(name="in-progress") status.create(name="testing") status.create(name="resolved") priority.create(name="feature", order="2") priority.create(name="wish", order="3") priority.create(name="bug", order="1") db.commit() # nosy tests require this db.security.addPermissionToRole('User', 'View', 'msg') # quiet journal tests require this # QuietJournal - reference used later in tests v1 = db.security.addPermission(name='View', klass='user', properties=['username', 'supervisor', 'assignable'], description="Prevent users from seeing roles") db.security.addPermissionToRole("User", v1) class MyTestCase(object): def tearDown(self): if hasattr(self, 'db'): if hasattr(self.db, 'session'): self.db.session.db.close() if hasattr(self.db, 'otk'): self.db.otk.db.close() self.db.close() if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) def open_database(self, user='admin'): self.db = self.module.Database(config, user) if 'LOGGING_LEVEL' in os.environ: logger = logging.getLogger('roundup.hyperdb') logger.setLevel(os.environ['LOGGING_LEVEL']) class commonDBTest(MyTestCase): def setUp(self): # remove previous test, ignore errors if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) os.makedirs(config.DATABASE + '/files') self.open_database() setupSchema(self.db, 1, self.module) def iterSetup(self, classname='issue'): cls = getattr(self.db, classname) def filt_iter_list(*args, **kw): """ for checking equivalence of filter and filter_iter """ return list(cls.filter_iter(*args, **kw)) def filter_test_iterator(): """ yield all filter variants with config settings changed appropriately """ self.db.config.RDBMS_SERVERSIDE_CURSOR = False yield (cls.filter) yield (filt_iter_list) self.db.config.RDBMS_SERVERSIDE_CURSOR = True yield (cls.filter) yield (filt_iter_list) return self.assertEqual, filter_test_iterator def filteringSetupTransitiveSearch(self, classname='issue'): u_m = {} k = 30 for user in ( {'username': 'ceo', 'age': 129}, {'username': 'grouplead1', 'age': 29, 'supervisor': '3'}, {'username': 'grouplead2', 'age': 29, 'supervisor': '3'}, {'username': 'worker1', 'age': 25, 'supervisor' : '4'}, {'username': 'worker2', 'age': 24, 'supervisor' : '4'}, {'username': 'worker3', 'age': 23, 'supervisor' : '5'}, {'username': 'worker4', 'age': 22, 'supervisor' : '5'}, {'username': 'worker5', 'age': 21, 'supervisor' : '5'}): u = self.db.user.create(**user) u_m [u] = self.db.msg.create(author = u, content = ' ' , date = date.Date ('2006-01-%s' % k)) k -= 1 i = date.Interval('-1d') for issue in ( {'title': 'ts1', 'status': '2', 'assignedto': '6', 'priority': '3', 'messages' : [u_m ['6']], 'nosy' : ['4']}, {'title': 'ts2', 'status': '1', 'assignedto': '6', 'priority': '3', 'messages' : [u_m ['6']], 'nosy' : ['5']}, {'title': 'ts4', 'status': '2', 'assignedto': '7', 'priority': '3', 'messages' : [u_m ['7']]}, {'title': 'ts5', 'status': '1', 'assignedto': '8', 'priority': '3', 'messages' : [u_m ['8']]}, {'title': 'ts6', 'status': '2', 'assignedto': '9', 'priority': '3', 'messages' : [u_m ['9']]}, {'title': 'ts7', 'status': '1', 'assignedto': '10', 'priority': '3', 'messages' : [u_m ['10']]}, {'title': 'ts8', 'status': '2', 'assignedto': '10', 'priority': '3', 'messages' : [u_m ['10']], 'foo' : i}, {'title': 'ts9', 'status': '1', 'assignedto': '10', 'priority': '3', 'messages' : [u_m ['10'], u_m ['9']]}): self.db.issue.create(**issue) return self.iterSetup(classname) class DBTest(commonDBTest): @pytest.fixture(autouse=True) def inject_fixtures(self, caplog): self._caplog = caplog def testRefresh(self): self.db.refresh_database() def testUpgrade_5_to_6(self): if(self.db.dbtype in ['anydbm', 'memorydb']): self.skipTest('No schema upgrade needed on non rdbms backends') # load the database self.db.issue.create(title="flebble frooz") self.db.commit() if self.db.database_schema['version'] > 6: # make testUpgrades run the downgrade code only. if hasattr(self, "downgrade_only"): # we are being called by an earlier test self.testUpgrade_6_to_7() self.assertEqual(self.db.database_schema['version'], 6) else: # we are being called directly self.downgrade_only = True self.testUpgrade_6_to_7() self.assertEqual(self.db.database_schema['version'], 6) del(self.downgrade_only) elif self.db.database_schema['version'] != 6: self.skipTest("This test only runs for database version 6") if self.db.dbtype == 'mysql': # version 6 has 5 indexes self.db.sql('show indexes from _user;') self.assertEqual(5,len(self.db.cursor.fetchall()), "Database created with wrong number of indexes") self.drop_key_retired_idx() # after dropping (key.__retired__) composite index we have # 3 index entries self.db.sql('show indexes from _user;') self.assertEqual(3,len(self.db.cursor.fetchall())) self.db.database_schema['version'] = 5 if hasattr(self, "downgrade_only"): return # test upgrade adding index self.db.post_init() self.assertEqual(self.db.db_version_updated, True) # they're back self.db.sql('show indexes from _user;') self.assertEqual(5,len(self.db.cursor.fetchall())) # test a database already upgraded from 4 to 5 # so it has the index to enforce key uniqueness self.db.database_schema['version'] = 5 self.db.post_init() # they're still here. self.db.sql('show indexes from _user;') self.assertEqual(5,len(self.db.cursor.fetchall())) else: if hasattr(self, "downgrade_only"): return # this should be a no-op # test upgrade self.db.post_init() # we should be at the current db version self.assertEqual(self.db.database_schema['version'], self.db.current_db_version) def drop_key_retired_idx(self): c = self.db.cursor for cn, klass in self.db.classes.items(): if klass.key: sql = '''drop index _%s_key_retired_idx on _%s''' % (cn, cn) self.db.sql(sql) # # automatic properties (well, the two easy ones anyway) # def testCreatorProperty(self): i = self.db.issue id1 = i.create(title='spam') self.db.journaltag = 'fred' id2 = i.create(title='spam') self.assertNotEqual(id1, id2) self.assertNotEqual(i.get(id1, 'creator'), i.get(id2, 'creator')) def testActorProperty(self): i = self.db.issue id1 = i.create(title='spam') self.db.journaltag = 'fred' i.set(id1, title='asfasd') self.assertNotEqual(i.get(id1, 'creator'), i.get(id1, 'actor')) # ID number controls def testIDGeneration(self): id1 = self.db.issue.create(title="spam", status='1') id2 = self.db.issue.create(title="eggs", status='2') self.assertNotEqual(id1, id2) def testIDSetting(self): # XXX numeric ids self.db.setid('issue', 10) id2 = self.db.issue.create(title="eggs", status='2') self.assertEqual('11', id2) # # basic operations # def testEmptySet(self): id1 = self.db.issue.create(title="spam", status='1') self.db.issue.set(id1) # String def testStringChange(self): for commit in (0,1): # test set & retrieve nid = self.db.issue.create(title="spam", status='1') self.assertEqual(self.db.issue.get(nid, 'title'), 'spam') # change and make sure we retrieve the correct value self.db.issue.set(nid, title='eggs') if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, 'title'), 'eggs') def testStringUnset(self): for commit in (0,1): nid = self.db.issue.create(title="spam", status='1') if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, 'title'), 'spam') # make sure we can unset self.db.issue.set(nid, title=None) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "title"), None) # FileClass "content" property (no unset test) def testFileClassContentChange(self): for commit in (0,1): # test set & retrieve nid = self.db.file.create(content="spam") self.assertEqual(self.db.file.get(nid, 'content'), 'spam') # change and make sure we retrieve the correct value self.db.file.set(nid, content='eggs') if commit: self.db.commit() self.assertEqual(self.db.file.get(nid, 'content'), 'eggs') def testStringUnicode(self): # test set & retrieve ustr = u2s(u'\xe4\xf6\xfc\u20ac') nid = self.db.issue.create(title=ustr, status='1') self.assertEqual(self.db.issue.get(nid, 'title'), ustr) # change and make sure we retrieve the correct value ustr2 = u2s(u'change \u20ac change') self.db.issue.set(nid, title=ustr2) self.db.commit() self.assertEqual(self.db.issue.get(nid, 'title'), ustr2) # test set & retrieve (this time for file contents) nid = self.db.file.create(content=ustr) self.db.commit() self.assertEqual(self.db.file.get(nid, 'content'), ustr) self.assertEqual(self.db.file.get(nid, 'binary_content'), s2b(ustr)) def testStringBinary(self): ''' Create file with binary content that is not able to be interpreted as unicode. Try to cause file module trigger and handle UnicodeDecodeError and get valid output ''' # test set & retrieve bstr = b'\x00\xF0\x34\x33' # random binary data # test set & retrieve (this time for file contents) # Since it has null in it, set it to a binary mime type # so indexer's don't try to index it. nid = self.db.file.create(content=bstr, type="application/octet-stream") print(nid) print(repr(self.db.file.get(nid, 'content'))) print(repr(self.db.file.get(nid, 'binary_content'))) p3val='file1 is not text, retrieve using binary_content property. mdsum: 0e1d1b47e4bd1beab3afc9b79f596c1d' if sys.version_info[0] > 2: # python 3 self.assertEqual(self.db.file.get(nid, 'content'), p3val) self.assertEqual(self.db.file.get(nid, 'binary_content'), bstr) else: # python 2 self.assertEqual(self.db.file.get(nid, 'content'), bstr) self.assertEqual(self.db.file.get(nid, 'binary_content'), bstr) # Link def testLinkChange(self): self.assertRaises(IndexError, self.db.issue.create, title="spam", status='100') for commit in (0,1): nid = self.db.issue.create(title="spam", status='1') if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "status"), '1') self.db.issue.set(nid, status='2') if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "status"), '2') def testLinkUnset(self): for commit in (0,1): nid = self.db.issue.create(title="spam", status='1') if commit: self.db.commit() self.db.issue.set(nid, status=None) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "status"), None) # Multilink def testMultilinkChange(self): for commit in (0,1): self.assertRaises(IndexError, self.db.issue.create, title="spam", nosy=['foo%s'%commit]) u1 = self.db.user.create(username='foo%s'%commit) u2 = self.db.user.create(username='bar%s'%commit) nid = self.db.issue.create(title="spam", nosy=[u1]) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "nosy"), [u1]) self.db.issue.set(nid, nosy=[]) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "nosy"), []) self.db.issue.set(nid, nosy=[u1,u2]) if commit: self.db.commit() l = [u1,u2]; l.sort() m = self.db.issue.get(nid, "nosy"); m.sort() self.assertEqual(l, m) # verify that when we pass None to an Multilink it sets # it to an empty list self.db.issue.set(nid, nosy=None) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "nosy"), []) def testMakeSeveralMultilinkedNodes(self): for commit in (0,1): u1 = self.db.user.create(username='foo%s'%commit) u2 = self.db.user.create(username='bar%s'%commit) u3 = self.db.user.create(username='baz%s'%commit) nid = self.db.issue.create(title="spam", nosy=[u1]) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "nosy"), [u1]) self.db.issue.set(nid, deadline=date.Date('.')) self.db.issue.set(nid, nosy=[u1,u2], title='ta%s'%commit) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "nosy"), [u1,u2]) self.db.issue.set(nid, deadline=date.Date('.')) self.db.issue.set(nid, nosy=[u1,u2,u3], title='tb%s'%commit) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "nosy"), [u1,u2,u3]) def testMultilinkChangeIterable(self): for commit in (0,1): # invalid nosy value assertion self.assertRaises(IndexError, self.db.issue.create, title='spam', nosy=['foo%s'%commit]) # invalid type for nosy create self.assertRaises(TypeError, self.db.issue.create, title='spam', nosy=1) u1 = self.db.user.create(username='foo%s'%commit) u2 = self.db.user.create(username='bar%s'%commit) # try a couple of the built-in iterable types to make # sure that we accept them and handle them properly # try a set as input for the multilink nid = self.db.issue.create(title="spam", nosy=set(u1)) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "nosy"), [u1]) self.assertRaises(TypeError, self.db.issue.set, nid, nosy='invalid type') # test with a tuple self.db.issue.set(nid, nosy=tuple()) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "nosy"), []) # make sure we accept a frozen set self.db.issue.set(nid, nosy=set([u1,u2])) if commit: self.db.commit() l = [u1,u2]; l.sort() m = self.db.issue.get(nid, "nosy"); m.sort() self.assertEqual(l, m) # XXX one day, maybe... def testMultilinkOrdering(self): for i in range(10): self.db.user.create(username='foo%s'%i) i = self.db.issue.create(title="spam", nosy=['5','3','12','4']) self.db.commit() l = self.db.issue.get(i, "nosy") # all backends should return the Multilink numeric-id-sorted self.assertEqual(l, ['3', '4', '5', '12']) # Date def testDateChange(self): self.assertRaises(TypeError, self.db.issue.create, title='spam', deadline=1) for commit in (0,1): nid = self.db.issue.create(title="spam", status='1') self.assertRaises(TypeError, self.db.issue.set, nid, deadline=1) a = self.db.issue.get(nid, "deadline") if commit: self.db.commit() self.db.issue.set(nid, deadline=date.Date()) b = self.db.issue.get(nid, "deadline") if commit: self.db.commit() self.assertNotEqual(a, b) self.assertNotEqual(b, date.Date('1970-1-1.00:00:00')) # The 1970 date will fail for metakit -- it is used # internally for storing NULL. The others would, too # because metakit tries to convert date.timestamp to an int # for storing and fails with an overflow. for d in [date.Date (x) for x in ('2038', '1970', '0033', '9999')]: self.db.issue.set(nid, deadline=d) if commit: self.db.commit() c = self.db.issue.get(nid, "deadline") self.assertEqual(c, d) def testDateLeapYear(self): nid = self.db.issue.create(title='spam', status='1', deadline=date.Date('2008-02-29')) self.assertEqual(str(self.db.issue.get(nid, 'deadline')), '2008-02-29.00:00:00') self.assertEqual(self.db.issue.filter(None, {'deadline': '2008-02-29'}), [nid]) self.assertEqual(list(self.db.issue.filter_iter(None, {'deadline': '2008-02-29'})), [nid]) self.db.issue.set(nid, deadline=date.Date('2008-03-01')) self.assertEqual(str(self.db.issue.get(nid, 'deadline')), '2008-03-01.00:00:00') self.assertEqual(self.db.issue.filter(None, {'deadline': '2008-02-29'}), []) self.assertEqual(list(self.db.issue.filter_iter(None, {'deadline': '2008-02-29'})), []) def testDateUnset(self): for commit in (0,1): nid = self.db.issue.create(title="spam", status='1') self.db.issue.set(nid, deadline=date.Date()) if commit: self.db.commit() self.assertNotEqual(self.db.issue.get(nid, "deadline"), None) self.db.issue.set(nid, deadline=None) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "deadline"), None) def testDateSort(self): d1 = date.Date('.') ae, iiter = self.filteringSetup() nid = self.db.issue.create(title="nodeadline", status='1') self.db.commit() for filt in iiter(): ae(filt(None, {}, ('+','deadline')), ['5', '2', '1', '3', '4']) ae(filt(None, {}, ('+','id'), ('+', 'deadline')), ['5', '2', '1', '3', '4']) ae(filt(None, {}, ('-','id'), ('-', 'deadline')), ['4', '3', '1', '2', '5']) def testDateSortMultilink(self): d1 = date.Date('.') ae, iiter = self.filteringSetup() nid = self.db.issue.create(title="nodeadline", status='1') self.db.commit() ae(sorted(self.db.issue.get('1','nosy')), []) ae(sorted(self.db.issue.get('2','nosy')), []) ae(sorted(self.db.issue.get('3','nosy')), ['1','2']) ae(sorted(self.db.issue.get('4','nosy')), ['1','2','3']) ae(sorted(self.db.issue.get('5','nosy')), []) ae(self.db.user.get('1','username'), 'admin') ae(self.db.user.get('2','username'), 'fred') ae(self.db.user.get('3','username'), 'bleep') # filter_iter currently doesn't work for Multilink sort # so testing only filter for f in iiter(): if f.__name__ != 'filter': continue ae(f(None, {}, ('+', 'id'), ('+','nosy')), ['1', '2', '5', '4', '3']) ae(f(None, {}, ('+','deadline'), ('+', 'nosy')), ['5', '2', '1', '4', '3']) ae(f(None, {}, ('+','nosy'), ('+', 'deadline')), ['5', '2', '1', '3', '4']) # Interval def testIntervalChange(self): self.assertRaises(TypeError, self.db.issue.create, title='spam', foo=1) for commit in (0,1): nid = self.db.issue.create(title="spam", status='1') self.assertRaises(TypeError, self.db.issue.set, nid, foo=1) if commit: self.db.commit() a = self.db.issue.get(nid, "foo") i = date.Interval('-1d') self.db.issue.set(nid, foo=i) if commit: self.db.commit() self.assertNotEqual(self.db.issue.get(nid, "foo"), a) self.assertEqual(i, self.db.issue.get(nid, "foo")) j = date.Interval('1y') self.db.issue.set(nid, foo=j) if commit: self.db.commit() self.assertNotEqual(self.db.issue.get(nid, "foo"), i) self.assertEqual(j, self.db.issue.get(nid, "foo")) def testIntervalUnset(self): for commit in (0,1): nid = self.db.issue.create(title="spam", status='1') self.db.issue.set(nid, foo=date.Interval('-1d')) if commit: self.db.commit() self.assertNotEqual(self.db.issue.get(nid, "foo"), None) self.db.issue.set(nid, foo=None) if commit: self.db.commit() self.assertEqual(self.db.issue.get(nid, "foo"), None) # Boolean def testBooleanSet(self): nid = self.db.user.create(username='one', assignable=1) self.assertEqual(self.db.user.get(nid, "assignable"), 1) nid = self.db.user.create(username='two', assignable=0) self.assertEqual(self.db.user.get(nid, "assignable"), 0) def testBooleanChange(self): userid = self.db.user.create(username='foo', assignable=1) self.assertEqual(1, self.db.user.get(userid, 'assignable')) self.db.user.set(userid, assignable=0) self.assertEqual(self.db.user.get(userid, 'assignable'), 0) self.db.user.set(userid, assignable=1) self.assertEqual(self.db.user.get(userid, 'assignable'), 1) def testBooleanUnset(self): nid = self.db.user.create(username='foo', assignable=1) self.db.user.set(nid, assignable=None) self.assertEqual(self.db.user.get(nid, "assignable"), None) # Number def testNumberChange(self): nid = self.db.user.create(username='foo', age=1) self.assertEqual(1, self.db.user.get(nid, 'age')) self.db.user.set(nid, age=3) self.assertNotEqual(self.db.user.get(nid, 'age'), 1) self.db.user.set(nid, age=1.0) self.assertEqual(self.db.user.get(nid, 'age'), 1) self.db.user.set(nid, age=0) self.assertEqual(self.db.user.get(nid, 'age'), 0) nid = self.db.user.create(username='bar', age=0) self.assertEqual(self.db.user.get(nid, 'age'), 0) def testNumberUnset(self): nid = self.db.user.create(username='foo', age=1) self.db.user.set(nid, age=None) self.assertEqual(self.db.user.get(nid, "age"), None) # Long number def testDoubleChange(self): lnl = 100.12345678 ln = 100.123456789 lng = 100.12345679 nid = self.db.user.create(username='foo', longnumber=ln) self.assertEqual(self.db.user.get(nid, 'longnumber') < lng, True) self.assertEqual(self.db.user.get(nid, 'longnumber') > lnl, True) lnl = 1.0012345678e55 ln = 1.00123456789e55 lng = 1.0012345679e55 self.db.user.set(nid, longnumber=ln) self.assertEqual(self.db.user.get(nid, 'longnumber') < lng, True) self.assertEqual(self.db.user.get(nid, 'longnumber') > lnl, True) self.db.user.set(nid, longnumber=-1) self.assertEqual(self.db.user.get(nid, 'longnumber'), -1) self.db.user.set(nid, longnumber=0) self.assertEqual(self.db.user.get(nid, 'longnumber'), 0) nid = self.db.user.create(username='bar', longnumber=0) self.assertEqual(self.db.user.get(nid, 'longnumber'), 0) def testDoubleUnset(self): nid = self.db.user.create(username='foo', longnumber=1.2345) self.db.user.set(nid, longnumber=None) self.assertEqual(self.db.user.get(nid, "longnumber"), None) # Integer def testIntegerChange(self): nid = self.db.user.create(username='foo', rating=100) self.assertEqual(100, self.db.user.get(nid, 'rating')) self.db.user.set(nid, rating=300) self.assertNotEqual(self.db.user.get(nid, 'rating'), 100) self.db.user.set(nid, rating=-1) self.assertEqual(self.db.user.get(nid, 'rating'), -1) self.db.user.set(nid, rating=0) self.assertEqual(self.db.user.get(nid, 'rating'), 0) nid = self.db.user.create(username='bar', rating=0) self.assertEqual(self.db.user.get(nid, 'rating'), 0) def testIntegerUnset(self): nid = self.db.user.create(username='foo', rating=1) self.db.user.set(nid, rating=None) self.assertEqual(self.db.user.get(nid, "rating"), None) # Password def testPasswordChange(self): x = password.Password('x') userid = self.db.user.create(username='foo', password=x) self.assertEqual(x, self.db.user.get(userid, 'password')) self.assertEqual(self.db.user.get(userid, 'password'), 'x') y = password.Password('y') self.db.user.set(userid, password=y) self.assertEqual(self.db.user.get(userid, 'password'), 'y') self.assertRaises(TypeError, self.db.user.create, userid, username='bar', password='x') self.assertRaises(TypeError, self.db.user.set, userid, password='x') def testPasswordUnset(self): x = password.Password('x') nid = self.db.user.create(username='foo', password=x) self.db.user.set(nid, assignable=None) self.assertEqual(self.db.user.get(nid, "assignable"), None) # key value def testKeyValue(self): self.assertRaises(ValueError, self.db.user.create) newid = self.db.user.create(username="spam") self.assertEqual(self.db.user.lookup('spam'), newid) self.db.commit() self.assertEqual(self.db.user.lookup('spam'), newid) self.db.user.retire(newid) self.assertRaises(KeyError, self.db.user.lookup, 'spam') # use the key again now that the old is retired newid2 = self.db.user.create(username="spam") self.assertNotEqual(newid, newid2) # try to restore old node. this shouldn't succeed! self.assertRaises(KeyError, self.db.user.restore, newid) self.assertRaises(TypeError, self.db.issue.lookup, 'fubar') # label property def testLabelProp(self): # key prop self.assertEqual(self.db.status.labelprop(), 'name') self.assertEqual(self.db.user.labelprop(), 'username') # title self.assertEqual(self.db.issue.labelprop(), 'title') # name self.assertEqual(self.db.file.labelprop(), 'name') # id self.assertEqual(self.db.stuff.labelprop(default_to_id=1), 'id') # retirement def testRetire(self): self.db.issue.create(title="spam", status='1') b = self.db.status.get('1', 'name') a = self.db.status.list() nodeids = self.db.status.getnodeids() self.db.status.retire('1') others = nodeids[:] others.remove('1') self.assertEqual(set(self.db.status.getnodeids()), set(nodeids)) self.assertEqual(set(self.db.status.getnodeids(retired=True)), set(['1'])) self.assertEqual(set(self.db.status.getnodeids(retired=False)), set(others)) self.assertTrue(self.db.status.is_retired('1')) # make sure the list is different self.assertNotEqual(a, self.db.status.list()) # can still access the node if necessary self.assertEqual(self.db.status.get('1', 'name'), b) self.assertRaises(IndexError, self.db.status.set, '1', name='hello') self.db.commit() self.assertTrue(self.db.status.is_retired('1')) self.assertEqual(self.db.status.get('1', 'name'), b) self.assertNotEqual(a, self.db.status.list()) # try to restore retired node self.db.status.restore('1') self.assertTrue(not self.db.status.is_retired('1')) def testCacheCreateSet(self): self.db.issue.create(title="spam", status='1') a = self.db.issue.get('1', 'title') self.assertEqual(a, 'spam') self.db.issue.set('1', title='ham') b = self.db.issue.get('1', 'title') self.assertEqual(b, 'ham') def testSerialisation(self): nid = self.db.issue.create(title="spam", status='1', deadline=date.Date(), foo=date.Interval('-1d')) self.db.commit() assert isinstance(self.db.issue.get(nid, 'deadline'), date.Date) assert isinstance(self.db.issue.get(nid, 'foo'), date.Interval) uid = self.db.user.create(username="fozzy", password=password.Password('t. bear')) self.db.commit() assert isinstance(self.db.user.get(uid, 'password'), password.Password) def testTransactions(self): # remember the number of items we started num_issues = len(self.db.issue.list()) num_files = self.db.numfiles() self.db.issue.create(title="don't commit me!", status='1') self.assertNotEqual(num_issues, len(self.db.issue.list())) self.db.rollback() self.assertEqual(num_issues, len(self.db.issue.list())) self.db.issue.create(title="please commit me!", status='1') self.assertNotEqual(num_issues, len(self.db.issue.list())) self.db.commit() self.assertNotEqual(num_issues, len(self.db.issue.list())) self.db.rollback() self.assertNotEqual(num_issues, len(self.db.issue.list())) self.db.file.create(name="test", type="text/plain", content="hi") self.db.rollback() self.assertEqual(num_files, self.db.numfiles()) for i in range(10): self.db.file.create(name="test", type="text/plain", content="hi %d"%(i)) self.db.commit() num_files2 = self.db.numfiles() self.assertNotEqual(num_files, num_files2) self.db.file.create(name="test", type="text/plain", content="hi") self.db.rollback() self.assertNotEqual(num_files, self.db.numfiles()) self.assertEqual(num_files2, self.db.numfiles()) # rollback / cache interaction name1 = self.db.user.get('1', 'username') self.db.user.set('1', username = name1+name1) # get the prop so the info's forced into the cache (if there is one) self.db.user.get('1', 'username') self.db.rollback() name2 = self.db.user.get('1', 'username') self.assertEqual(name1, name2) def testDestroyBlob(self): # destroy an uncommitted blob f1 = self.db.file.create(content='hello', type="text/plain") self.db.commit() fn = self.db.filename('file', f1) self.db.file.destroy(f1) self.db.commit() self.assertEqual(os.path.exists(fn), False) def testDestroyNoJournalling(self): self.innerTestDestroy(klass=self.db.session) def testDestroyJournalling(self): self.innerTestDestroy(klass=self.db.issue) def innerTestDestroy(self, klass): newid = klass.create(title='Mr Friendly') n = len(klass.list()) self.assertEqual(klass.get(newid, 'title'), 'Mr Friendly') count = klass.count() klass.destroy(newid) self.assertNotEqual(count, klass.count()) self.assertRaises(IndexError, klass.get, newid, 'title') self.assertNotEqual(len(klass.list()), n) if klass.do_journal: self.assertRaises(IndexError, klass.history, newid) # now with a commit newid = klass.create(title='Mr Friendly') n = len(klass.list()) self.assertEqual(klass.get(newid, 'title'), 'Mr Friendly') self.db.commit() count = klass.count() klass.destroy(newid) self.assertNotEqual(count, klass.count()) self.assertRaises(IndexError, klass.get, newid, 'title') self.db.commit() self.assertRaises(IndexError, klass.get, newid, 'title') self.assertNotEqual(len(klass.list()), n) if klass.do_journal: self.assertRaises(IndexError, klass.history, newid) # now with a rollback newid = klass.create(title='Mr Friendly') n = len(klass.list()) self.assertEqual(klass.get(newid, 'title'), 'Mr Friendly') self.db.commit() count = klass.count() klass.destroy(newid) self.assertNotEqual(len(klass.list()), n) self.assertRaises(IndexError, klass.get, newid, 'title') self.db.rollback() self.assertEqual(count, klass.count()) self.assertEqual(klass.get(newid, 'title'), 'Mr Friendly') self.assertEqual(len(klass.list()), n) if klass.do_journal: self.assertNotEqual(klass.history(newid), []) def testExceptions(self): # this tests the exceptions that should be raised ar = self.assertRaises ar(KeyError, self.db.getclass, 'fubar') # # class create # # string property ar(TypeError, self.db.status.create, name=1) # id, creation, creator and activity properties are reserved ar(KeyError, self.db.status.create, id=1) ar(KeyError, self.db.status.create, creation=1) ar(KeyError, self.db.status.create, creator=1) ar(KeyError, self.db.status.create, activity=1) ar(KeyError, self.db.status.create, actor=1) # invalid property name ar(KeyError, self.db.status.create, foo='foo') # key name clash ar(ValueError, self.db.status.create, name='unread') # invalid link index ar(IndexError, self.db.issue.create, title='foo', status='bar') # invalid link value ar(ValueError, self.db.issue.create, title='foo', status=1) # invalid multilink type ar(TypeError, self.db.issue.create, title='foo', status='1', nosy='hello') # invalid multilink index type ar(ValueError, self.db.issue.create, title='foo', status='1', nosy=[1]) # invalid multilink index ar(IndexError, self.db.issue.create, title='foo', status='1', nosy=['10']) # # key property # # key must be a String ar(TypeError, self.db.file.setkey, 'fooz') # key must exist ar(KeyError, self.db.file.setkey, 'fubar') # # class get # # invalid node id ar(IndexError, self.db.issue.get, '99', 'title') # invalid property name ar(KeyError, self.db.status.get, '2', 'foo') # # class set # # invalid node id ar(IndexError, self.db.issue.set, '99', title='foo') # invalid property name ar(KeyError, self.db.status.set, '1', foo='foo') # string property ar(TypeError, self.db.status.set, '1', name=1) # key name clash ar(ValueError, self.db.status.set, '2', name='unread') # set up a valid issue for me to work on id = self.db.issue.create(title="spam", status='1') # invalid link index ar(IndexError, self.db.issue.set, id, title='foo', status='bar') # invalid link value ar(ValueError, self.db.issue.set, id, title='foo', status=1) # invalid multilink type ar(TypeError, self.db.issue.set, id, title='foo', status='1', nosy='hello') # invalid multilink index type ar(ValueError, self.db.issue.set, id, title='foo', status='1', nosy=[1]) # invalid multilink index ar(IndexError, self.db.issue.set, id, title='foo', status='1', nosy=['10']) # NOTE: the following increment the username to avoid problems # within metakit's backend (it creates the node, and then sets the # info, so the create (and by a fluke the username set) go through # before the age/assignable/etc. set, which raises the exception) # invalid number value ar(TypeError, self.db.user.create, username='foo', age='a') # invalid boolean value ar(TypeError, self.db.user.create, username='foo2', assignable='true') nid = self.db.user.create(username='foo3') # invalid number value ar(TypeError, self.db.user.set, nid, age='a') # invalid boolean value ar(TypeError, self.db.user.set, nid, assignable='true') def testAuditors(self): class test: called = False def call(self, *args): self.called = True create = test() self.db.user.audit('create', create.call) self.db.user.create(username="mary") self.assertEqual(create.called, True) set = test() self.db.user.audit('set', set.call) self.db.user.set('1', username="joe") self.assertEqual(set.called, True) retire = test() self.db.user.audit('retire', retire.call) self.db.user.retire('1') self.assertEqual(retire.called, True) def testAuditorTwo(self): class test: n = 0 def a(self, *args): self.call_a = self.n; self.n += 1 def b(self, *args): self.call_b = self.n; self.n += 1 def c(self, *args): self.call_c = self.n; self.n += 1 test = test() self.db.user.audit('create', test.b, 1) self.db.user.audit('create', test.a, 1) self.db.user.audit('create', test.c, 2) self.db.user.create(username="mary") self.assertEqual(test.call_a, 0) self.assertEqual(test.call_b, 1) self.assertEqual(test.call_c, 2) def testDefault_Value(self): new_issue=self.db.issue.create(title="title", deadline=date.Date('2016-6-30.22:39')) # John Rouillard claims this should return the default value of 1 week for foo, # but the hyperdb doesn't assign the default value for missing properties in the # db on creation. result=self.db.issue.get(new_issue, 'foo') # When the defaultis automatically set by the hyperdb, change this to # match the Interval test below. self.assertEqual(result, None) # but verify that the default value is retreivable result=self.db.issue.properties['foo'].get_default_value() self.assertEqual(result, date.Interval('-7d')) def testQuietProperty(self): # make sure that the quiet properties: "assignable" and "age" are not # returned as part of the proplist new_user=self.db.user.create(username="pete", age=10, assignable=False) new_issue=self.db.issue.create(title="title", deadline=date.Date('2016-6-30.22:39')) # change all quiet params. Verify they aren't returned in object. # between this and the issue class every type represented in hyperdb # should be initalized with a quiet parameter. result=self.db.user.set(new_user, username="new", age=20, supervisor='3', assignable=True, password=password.Password("3456"), rating=4, realname="newname") self.assertEqual(result, {'supervisor': '3', 'username': "new"}) result=self.db.user.get(new_user, 'age') self.assertEqual(result, 20) # change all quiet params. Verify they aren't returned in object. result=self.db.issue.set(new_issue, title="title2", deadline=date.Date('2016-7-13.22:39'), assignedto="2", nosy=["3", "2"]) self.assertEqual(result, {'title': 'title2'}) # also test that we can make a property noisy self.db.user.properties['age'].quiet=False result=self.db.user.set(new_user, username="old", age=30, supervisor='2', assignable=False) self.assertEqual(result, {'age': 30, 'supervisor': '2', 'username': "old"}) self.db.user.properties['age'].quiet=True def testQuietChangenote(self): # create user 3 for later use self.db.user.create(username="pete", age=10, assignable=False) new_issue=self.db.issue.create(title="title", deadline=date.Date('2016-6-30.22:39')) # change all quiet params. Verify they aren't returned in CreateNote. result=self.db.issue.set(new_issue, title="title2", deadline=date.Date('2016-6-30.22:39'), assignedto="2", nosy=["3", "2"]) result=self.db.issue.generateCreateNote(new_issue) self.assertEqual(result, '\n----------\ntitle: title2') # also test that we can make a property noisy self.db.issue.properties['nosy'].quiet=False self.db.issue.properties['deadline'].quiet=False result=self.db.issue.set(new_issue, title="title2", deadline=date.Date('2016-7-13.22:39'), assignedto="2", nosy=["1", "2"]) result=self.db.issue.generateCreateNote(new_issue) self.assertEqual(result, '\n----------\ndeadline: 2016-07-13.22:39:00\nnosy: admin, fred\ntitle: title2') self.db.issue.properties['nosy'].quiet=True self.db.issue.properties['deadline'].quiet=True def testViewPremJournal(self): pass def testQuietJournal(self): ## This is an example of how to enable logging module ## and report the results. It uses testfixtures ## that can be installed via pip. ## Uncomment below 2 lines: #import logging #from testfixtures import LogCapture ## then run every call to roundup functions with: #with LogCapture('roundup.hyperdb', level=logging.DEBUG) as l: # result=self.db.user.history('2') #print l ## change 'roundup.hyperdb' to the logging name you want to capture. ## print l just prints the output. Run using: ## python -m pytest --capture=no -k testQuietJournal test/test_anydbm.py # FIXME There should be a test via # template.py::_HTMLItem::history() and verify the output. # not sure how to get there from here. -- rouilj # The Class::history() method now does filtering of quiet # props. Make sure that the quiet properties: "assignable" # and "age" are not returned as part of the journal new_user=self.db.user.create(username="pete", age=10, assignable=False) new_issue=self.db.issue.create(title="title", deadline=date.Date('2016-6-30.22:39')) # change all quiet params. Verify they aren't returned in journal. # between this and the issue class every type represented in hyperdb # should be initalized with a quiet parameter. result=self.db.user.set(new_user, username="new", age=20, supervisor='1', assignable=True, password=password.Password("3456"), rating=4, realname="newname") result=self.db.user.history(new_user, skipquiet=False) ''' [('3', , '1', 'create', {}), ('3', , '1', 'set', {'username': 'pete', 'assignable': False, 'supervisor': None, 'realname': None, 'rating': None, 'age': 10, 'password': None})] ''' expected = {'username': 'pete', 'assignable': False, 'supervisor': None, 'realname': None, 'rating': None, 'age': 10, 'password': None} result.sort() (id, tx_date, user, action, args) = result[-1] # check piecewise ignoring date of transaction self.assertEqual('3', id) self.assertEqual('1', user) self.assertEqual('set', action) self.assertEqual(expected, args) # change all quiet params on issue. result=self.db.issue.set(new_issue, title="title2", deadline=date.Date('2016-07-30.22:39'), assignedto="2", nosy=["3", "2"]) result=self.db.issue.generateCreateNote(new_issue) self.assertEqual(result, '\n----------\ntitle: title2') # check history including quiet properties result=self.db.issue.history(new_issue, skipquiet=False) print(result) ''' output should be like: [ ... ('1', , '1', 'set', {'assignedto': None, 'nosy': (('+', ['3', '2']),), 'deadline': , 'title': 'title'}) ''' expected = {'assignedto': None, 'nosy': (('+', ['3', '2']),), 'deadline': date.Date('2016-06-30.22:39'), 'title': 'title'} result.sort() print("history include quiet props", result[-1]) (id, tx_date, user, action, args) = result[-1] # check piecewise ignoring date of transaction self.assertEqual('1', id) self.assertEqual('1', user) self.assertEqual('set', action) self.assertEqual(expected, args) # check history removing quiet properties result=self.db.issue.history(new_issue) ''' output should be like: [ ... ('1', , '1', 'set', {'title': 'title'}) ''' expected = {'title': 'title'} result.sort() print("history remove quiet props", result[-1]) (id, tx_date, user, action, args) = result[-1] # check piecewise self.assertEqual('1', id) self.assertEqual('1', user) self.assertEqual('set', action) self.assertEqual(expected, args) # also test that we can make a property noisy self.db.issue.properties['nosy'].quiet=False self.db.issue.properties['deadline'].quiet=False # FIXME: mysql use should be fixed or # a different way of checking this should be done. # this sleep is a hack. # mysql transation timestamps are in whole # seconds. To get the history to sort in proper # order by using timestamps we have to sleep 2 seconds # here tomake sure the timestamp between this transaction # and the last transaction is at least 1 second apart. import time; time.sleep(2) result=self.db.issue.set(new_issue, title="title2", deadline=date.Date('2016-7-13.22:39'), assignedto="2", nosy=["1", "2"]) result=self.db.issue.generateCreateNote(new_issue) self.assertEqual(result, '\n----------\ndeadline: 2016-07-13.22:39:00\nnosy: admin, fred\ntitle: title2') # check history removing the current quiet properties result=self.db.issue.history(new_issue) expected = {'nosy': (('+', ['1']), ('-', ['3'])), 'deadline': date.Date("2016-07-30.22:39:00.000")} print("result unquiet", result) (id, tx_date, user, action, args) = result[-1] # check piecewise self.assertEqual('1', id) self.assertEqual('1', user) self.assertEqual('set', action) self.assertEqual(expected, args) result=self.db.user.history('2') result.sort() # result should look like: # [('2', , '1', 'create', {}), # ('2', , '1', 'link', # ('issue', '1', 'nosy')) ] expected2 = ('issue', '1', 'nosy') (id, tx_date, user, action, args) = result[-1] self.assertEqual(len(result),2) self.assertEqual('2', id) self.assertEqual('1', user) self.assertEqual('link', action) self.assertEqual(expected2, args) # reset quiet props self.db.issue.properties['nosy'].quiet=True self.db.issue.properties['deadline'].quiet=True # Change the role for the new_user. # If journal is retrieved by admin this adds the role # change as the last element. If retreived by non-admin # it should not be returned because the user has no # View permissons on role. # FIXME delay by two seconds due to mysql missing # fractional seconds. See sleep above for details time.sleep(2) result=self.db.user.set(new_user, roles="foo, bar") # Verify last journal entry as admin is a role change # from None result=self.db.user.history(new_user, skipquiet=False) ''' result should end like: [ ... ('3', , '1', 'set', {'username': 'pete', 'assignable': False, 'supervisor': None, 'realname': None, 'rating': None, 'age': 10, 'password': None}), ('3', , '1', 'link', ('issue', '1', 'nosy')), ('3', , '1', 'unlink', ('issue', '1', 'nosy')), ('3', , '1', 'set', {'roles': None})] ''' (id, tx_date, user, action, args) = result[-1] expected = {'roles': None } self.assertEqual('3', id) self.assertEqual('1', user) self.assertEqual('set', action) self.assertEqual(expected, args) # set an existing user's role to User so it can # view some props of the user class (search backwards # for QuietJournal to see the properties, they should be: # 'username', 'supervisor', 'assignable' i.e. age is not # one of them. id = self.db.user.lookup("fred") # FIXME mysql timestamp issue see sleeps above time.sleep(2) result=self.db.user.set(id, roles="User") # make the user fred current. self.db.setCurrentUser('fred') self.assertEqual(self.db.getuid(), id) # check history as the user fred # include quiet properties # but require View perms result=self.db.user.history(new_user, skipquiet=False) result.sort() ''' result should look like [('3', , '1', 'create', {}), ('3', , '1', 'set', {'username': 'pete', 'assignable': False, 'supervisor': None, 'age': 10})] ''' # analyze last item (id, tx_date, user, action, args) = result[-1] expected= {'username': 'pete', 'assignable': False, 'supervisor': None} self.assertEqual('3', id) self.assertEqual('1', user) self.assertEqual('set', action) self.assertEqual(expected, args) # reset the user to admin self.db.setCurrentUser('admin') self.assertEqual(self.db.getuid(), '1') # admin is always 1 def testJournals(self): muid = self.db.user.create(username="mary") self.db.user.create(username="pete") self.db.issue.create(title="spam", status='1') self.db.commit() # journal entry for issue create journal = self.db.getjournal('issue', '1') self.assertEqual(1, len(journal)) (nodeid, date_stamp, journaltag, action, params) = journal[0] self.assertEqual(nodeid, '1') self.assertEqual(journaltag, self.db.user.lookup('admin')) self.assertEqual(action, 'create') keys = sorted(params.keys()) self.assertEqual(keys, []) # journal entry for link journal = self.db.getjournal('user', '1') self.assertEqual(1, len(journal)) self.db.issue.set('1', assignedto='1') self.db.commit() journal = self.db.getjournal('user', '1') self.assertEqual(2, len(journal)) (nodeid, date_stamp, journaltag, action, params) = journal[1] self.assertEqual('1', nodeid) self.assertEqual('1', journaltag) self.assertEqual('link', action) self.assertEqual(('issue', '1', 'assignedto'), params) # wait a bit to keep proper order of journal entries time.sleep(0.01) # journal entry for unlink self.db.setCurrentUser('mary') self.db.issue.set('1', assignedto='2') self.db.commit() journal = self.db.getjournal('user', '1') self.assertEqual(3, len(journal)) (nodeid, date_stamp, journaltag, action, params) = journal[2] self.assertEqual('1', nodeid) self.assertEqual(muid, journaltag) self.assertEqual('unlink', action) self.assertEqual(('issue', '1', 'assignedto'), params) # test disabling journalling # ... get the last entry jlen = len(self.db.getjournal('user', '1')) self.db.issue.disableJournalling() self.db.issue.set('1', title='hello world') self.db.commit() # see if the change was journalled when it shouldn't have been self.assertEqual(jlen, len(self.db.getjournal('user', '1'))) jlen = len(self.db.getjournal('issue', '1')) self.db.issue.enableJournalling() self.db.issue.set('1', title='hello world 2') self.db.commit() # see if the change was journalled self.assertNotEqual(jlen, len(self.db.getjournal('issue', '1'))) def testJournalNonexistingProperty(self): # Test for non-existing properties, link/unlink events to # non-existing classes and link/unlink events to non-existing # properties in a class: These all may be the result of a schema # change and should not lead to a traceback. self.db.user.create(username="mary", roles="User") id = self.db.issue.create(title="spam", status='1') # FIXME delay by two seconds due to mysql missing # fractional seconds. This keeps the journal order correct. time.sleep(2) self.db.issue.set(id, title='green eggs') time.sleep(2) self.db.commit() journal = self.db.getjournal('issue', id) now = date.Date('.') sec1 = date.Interval('0:00:01') sec2 = date.Interval('0:00:02') sec3 = date.Interval('0:00:03') jp0 = dict(title = 'spam') # Non-existing property changed jp1 = dict(nonexisting = None) journal.append ((id, now+sec1, '1', 'set', jp1)) # Link from user-class to non-existing property jp2 = ('user', '1', 'xyzzy') journal.append ((id, now+sec2, '1', 'link', jp2)) # Link from non-existing class jp3 = ('frobozz', '1', 'xyzzy') journal.append ((id, now+sec3, '1', 'link', jp3)) self.db.setjournal('issue', id, journal) self.db.commit() result=self.db.issue.history(id) result.sort() # anydbm drops unknown properties during serialisation if self.db.dbtype == 'anydbm': self.assertEqual(len(result), 4) self.assertEqual(result [1][4], jp0) self.assertEqual(result [2][4], jp2) self.assertEqual(result [3][4], jp3) else: self.assertEqual(len(result), 5) self.assertEqual(result [1][4], jp0) print(result) # following test fails sometimes under sqlite # in travis. Looks like an ordering issue # in python 3.5. Print result to debug. # is system runs fast enough, timestamp can # be the same on two journal items. Ordering # in that case is random. self.assertEqual(result [2][4], jp1) self.assertEqual(result [3][4], jp2) self.assertEqual(result [4][4], jp3) self.db.close() # Verify that normal user doesn't see obsolete props/classes self.open_database('mary') setupSchema(self.db, 0, self.module) # allow mary to see issue fields like title self.db.security.addPermissionToRole('User', 'View', 'issue') result=self.db.issue.history(id) self.assertEqual(len(result), 2) self.assertEqual(result [1][4], jp0) def testJournalPreCommit(self): id = self.db.user.create(username="mary") self.assertEqual(len(self.db.getjournal('user', id)), 1) self.db.commit() def testPack(self): id = self.db.issue.create(title="spam", status='1') self.db.commit() time.sleep(1) self.db.issue.set(id, status='2') self.db.commit() # sleep for at least a second, then get a date to pack at time.sleep(1) pack_before = date.Date('.') # wait another second and add one more entry time.sleep(1) self.db.issue.set(id, status='3') self.db.commit() jlen = len(self.db.getjournal('issue', id)) # pack self.db.pack(pack_before) # we should have the create and last set entries now self.assertEqual(jlen-1, len(self.db.getjournal('issue', id))) def testCurrentUserLookup(self): # admin is the default f = self.db.user.lookup('@current_user') self.assertEqual(f, "1") self.db.journaltag = "fred" f = self.db.user.lookup('@current_user') self.assertEqual(f, "2") def testCurrentUserIssueFilterLink(self): # admin is the default user for user in ['admin', 'fred']: self.db.journaltag = user for commit in (0,1): nid = self.db.issue.create( title="spam %s %s" % (user, commit), status='1', nosy=['2'] if commit else ['1']) self.db.commit() self.db.journaltag = 'admin' self.db.issue.set('3', status='2') f = self.db.issue.filter(None, {"creator": '@current_user'}) self.assertEqual(f, ["1", "2"]) f = self.db.issue.filter(None, {"actor": '@current_user'}) self.assertEqual(f, ["1", "2", "3"]) self.db.journaltag = 'fred' f = self.db.issue.filter(None, {"creator": '@current_user'}) self.assertEqual(f, ["3", "4"]) # check not @current_user f = self.db.issue.filter(None, {"creator": ['@current_user', '-2']}) self.assertEqual(f, ["1", "2"]) # check different prop f = self.db.issue.filter(None, {"actor": '@current_user'}) self.assertEqual(f, ["4"]) def testIndexerSearching(self): f1 = self.db.file.create(content='hello', type="text/plain") # content='world' has the wrong content-type and won't be indexed f2 = self.db.file.create(content='world', type="text/frozz", comment='blah blah') i1 = self.db.issue.create(files=[f1, f2], title="flebble plop") i2 = self.db.issue.create(title="flebble the frooz") self.db.commit() self.assertEqual(self.db.indexer.search([], self.db.issue), {}) self.assertEqual(self.db.indexer.search(['hello'], self.db.issue), {i1: {'files': [f1]}}) # content='world' has the wrong content-type and shouldn't be indexed self.assertEqual(self.db.indexer.search(['world'], self.db.issue), {}) self.assertEqual(self.db.indexer.search(['frooz'], self.db.issue), {i2: {}}) self.assertEqual(self.db.indexer.search(['flebble'], self.db.issue), {i1: {}, i2: {}}) # test AND'ing of search terms self.assertEqual(self.db.indexer.search(['frooz', 'flebble'], self.db.issue), {i2: {}}) # unindexed stopword self.assertEqual(self.db.indexer.search(['the'], self.db.issue), {}) def testIndexerSearchingIgnoreProps(self): f1 = self.db.file.create(content='hello', type="text/plain") # content='world' has the wrong content-type and won't be indexed f2 = self.db.file.create(content='world', type="text/frozz", comment='blah blah') i1 = self.db.issue.create(files=[f1, f2], title="flebble plop") i2 = self.db.issue.create(title="flebble the frooz") self.db.commit() # filter out hits that are in the titpe prop of issues self.assertEqual(self.db.indexer.search(['frooz'], self.db.issue, ignore={('issue', 'title'): True}), {}) # filter out hits in the title prop of content. Note the returned # match is in a file not an issue, so ignore has no effect. # also there is no content property for issue. self.assertEqual(self.db.indexer.search(['hello'], self.db.issue, ignore={('issue', 'content'): True}), {f1: {'files': ['1']}}) # filter out file content property hit leaving no results self.assertEqual(self.db.indexer.search(['hello'], self.db.issue, ignore={('file', 'content'): True}), {}) def testIndexerSearchingLink(self): m1 = self.db.msg.create(content="one two") i1 = self.db.issue.create(messages=[m1]) m2 = self.db.msg.create(content="two three") i2 = self.db.issue.create(feedback=m2) self.db.commit() self.assertEqual(self.db.indexer.search(['two'], self.db.issue), {i1: {'messages': [m1]}, i2: {'feedback': [m2]}}) def testIndexerSearchMulti(self): m1 = self.db.msg.create(content="one two") m2 = self.db.msg.create(content="two three") i1 = self.db.issue.create(messages=[m1]) i2 = self.db.issue.create(spam=[m2]) self.db.commit() self.assertEqual(self.db.indexer.search([], self.db.issue), {}) self.assertEqual(self.db.indexer.search(['one'], self.db.issue), {i1: {'messages': [m1]}}) self.assertEqual(self.db.indexer.search(['two'], self.db.issue), {i1: {'messages': [m1]}, i2: {'spam': [m2]}}) self.assertEqual(self.db.indexer.search(['three'], self.db.issue), {i2: {'spam': [m2]}}) def testReindexingChange(self): search = self.db.indexer.search issue = self.db.issue i1 = issue.create(title="flebble plop") i2 = issue.create(title="flebble frooz") self.db.commit() self.assertEqual(search(['plop'], issue), {i1: {}}) self.assertEqual(search(['flebble'], issue), {i1: {}, i2: {}}) # change i1's title issue.set(i1, title="plop") self.db.commit() self.assertEqual(search(['plop'], issue), {i1: {}}) self.assertEqual(search(['flebble'], issue), {i2: {}}) def testReindexingClear(self): search = self.db.indexer.search issue = self.db.issue i1 = issue.create(title="flebble plop") i2 = issue.create(title="flebble frooz") self.db.commit() self.assertEqual(search(['plop'], issue), {i1: {}}) self.assertEqual(search(['flebble'], issue), {i1: {}, i2: {}}) # unset i1's title issue.set(i1, title="") self.db.commit() self.assertEqual(search(['plop'], issue), {}) self.assertEqual(search(['flebble'], issue), {i2: {}}) def testFileClassReindexing(self): f1 = self.db.file.create(content='hello') f2 = self.db.file.create(content='hello, world') i1 = self.db.issue.create(files=[f1, f2]) self.db.commit() d = self.db.indexer.search(['hello'], self.db.issue) self.assertTrue(i1 in d) d[i1]['files'].sort() self.assertEqual(d, {i1: {'files': [f1, f2]}}) self.assertEqual(self.db.indexer.search(['world'], self.db.issue), {i1: {'files': [f2]}}) self.db.file.set(f1, content="world") self.db.commit() d = self.db.indexer.search(['world'], self.db.issue) d[i1]['files'].sort() self.assertEqual(d, {i1: {'files': [f1, f2]}}) self.assertEqual(self.db.indexer.search(['hello'], self.db.issue), {i1: {'files': [f2]}}) def testFileClassIndexingNoNoNo(self): f1 = self.db.file.create(content='hello') self.db.commit() self.assertEqual(self.db.indexer.search(['hello'], self.db.file), {'1': {}}) f1 = self.db.file_nidx.create(content='hello') self.db.commit() self.assertEqual(self.db.indexer.search(['hello'], self.db.file_nidx), {}) def testForcedReindexing(self): self.db.issue.create(title="flebble frooz") self.db.commit() self.assertEqual(self.db.indexer.search(['flebble'], self.db.issue), {'1': {}}) self.db.indexer.quiet = 1 self.db.indexer.force_reindex() self.db.post_init() self.db.indexer.quiet = 9 self.assertEqual(self.db.indexer.search(['flebble'], self.db.issue), {'1': {}}) def testIndexingPropertiesOnImport(self): # import an issue title = 'Bzzt' nodeid = self.db.issue.import_list(['title', 'messages', 'files', 'spam', 'nosy', 'superseder', 'keywords', 'keywords2'], [repr(title), '[]', '[]', '[]', '[]', '[]', '[]', '[]']) self.db.commit() # Content of title attribute is indexed self.assertEqual(self.db.indexer.search([title], self.db.issue), {str(nodeid):{}}) # # searching tests follow # def testFindIncorrectProperty(self): self.assertRaises(TypeError, self.db.issue.find, title='fubar') def _find_test_setup(self): self.db.file.create(content='') self.db.file.create(content='') self.db.user.create(username='') one = self.db.issue.create(status="1", nosy=['1']) two = self.db.issue.create(status="2", nosy=['2'], files=['1'], assignedto='2') three = self.db.issue.create(status="1", nosy=['1','2']) four = self.db.issue.create(status="3", assignedto='1', files=['1','2']) return one, two, three, four def testFindLink(self): one, two, three, four = self._find_test_setup() got = self.db.issue.find(status='1') got.sort() self.assertEqual(got, [one, three]) got = self.db.issue.find(status={'1':1}) got.sort() self.assertEqual(got, [one, three]) def testFindProtectedLink(self): one, two, three, four = self._find_test_setup() got = self.db.issue.find(creator='1') got.sort() self.assertEqual(got, [one, two, three, four]) def testFindRevLinkMultilink(self): ae, dummy = self.filteringSetupTransitiveSearch('user') ni = 'nosy_issues' self.db.issue.set('6', nosy=['3', '4', '5']) self.db.issue.set('7', nosy=['5']) # After this setup we have the following values for nosy: # issue assignedto nosy # 1: 6 4 # 2: 6 5 # 3: 7 # 4: 8 # 5: 9 # 6: 10 3, 4, 5 # 7: 10 5 # 8: 10 # assignedto links back from 'issues' # nosy links back from 'nosy_issues' self.assertEqual(self.db.user.find(issues={'1':1}), ['6']) self.assertEqual(self.db.user.find(issues={'8':1}), ['10']) self.assertEqual(self.db.user.find(issues={'2':1, '5':1}), ['6', '9']) self.assertEqual(self.db.user.find(nosy_issues={'8':1}), []) self.assertEqual(self.db.user.find(nosy_issues={'6':1}), ['3', '4', '5']) self.assertEqual(self.db.user.find(nosy_issues={'3':1, '5':1}), []) self.assertEqual(self.db.user.find(nosy_issues={'2':1, '6':1, '7':1}), ['3', '4', '5']) def testFindLinkFail(self): self._find_test_setup() self.assertEqual(self.db.issue.find(status='4'), []) self.assertEqual(self.db.issue.find(status={'4':1}), []) def testFindLinkUnset(self): one, two, three, four = self._find_test_setup() got = self.db.issue.find(assignedto=None) got.sort() self.assertEqual(got, [one, three]) got = self.db.issue.find(assignedto={None:1}) got.sort() self.assertEqual(got, [one, three]) def testFindMultipleLink(self): one, two, three, four = self._find_test_setup() l = self.db.issue.find(status={'1':1, '3':1}) l.sort() self.assertEqual(l, [one, three, four]) l = self.db.issue.find(status=('1', '3')) l.sort() self.assertEqual(l, [one, three, four]) l = self.db.issue.find(status=['1', '3']) l.sort() self.assertEqual(l, [one, three, four]) l = self.db.issue.find(assignedto={None:1, '1':1}) l.sort() self.assertEqual(l, [one, three, four]) def testFindMultilink(self): one, two, three, four = self._find_test_setup() got = self.db.issue.find(nosy='2') got.sort() self.assertEqual(got, [two, three]) got = self.db.issue.find(nosy={'2':1}) got.sort() self.assertEqual(got, [two, three]) got = self.db.issue.find(nosy={'2':1}, files={}) got.sort() self.assertEqual(got, [two, three]) def testFindMultiMultilink(self): one, two, three, four = self._find_test_setup() got = self.db.issue.find(nosy='2', files='1') got.sort() self.assertEqual(got, [two, three, four]) got = self.db.issue.find(nosy={'2':1}, files={'1':1}) got.sort() self.assertEqual(got, [two, three, four]) def testFindMultilinkFail(self): self._find_test_setup() self.assertEqual(self.db.issue.find(nosy='3'), []) self.assertEqual(self.db.issue.find(nosy={'3':1}), []) def testFindMultilinkUnset(self): self._find_test_setup() self.assertEqual(self.db.issue.find(nosy={}), []) def testFindLinkAndMultilink(self): one, two, three, four = self._find_test_setup() got = self.db.issue.find(status='1', nosy='2') got.sort() self.assertEqual(got, [one, two, three]) got = self.db.issue.find(status={'1':1}, nosy={'2':1}) got.sort() self.assertEqual(got, [one, two, three]) def testFindRetired(self): one, two, three, four = self._find_test_setup() self.assertEqual(len(self.db.issue.find(status='1')), 2) self.db.issue.retire(one) self.assertEqual(len(self.db.issue.find(status='1')), 1) def testStringFind(self): self.assertRaises(TypeError, self.db.issue.stringFind, status='1') ids = [] ids.append(self.db.issue.create(title="spam")) self.db.issue.create(title="not spam") ids.append(self.db.issue.create(title="spam")) ids.sort() got = self.db.issue.stringFind(title='spam') got.sort() self.assertEqual(got, ids) self.assertEqual(self.db.issue.stringFind(title='fubar'), []) # test retiring a node self.db.issue.retire(ids[0]) self.assertEqual(len(self.db.issue.stringFind(title='spam')), 1) def filteringSetup(self, classname='issue'): for user in ( {'username': 'bleep', 'age': 1, 'assignable': True}, {'username': 'blop', 'age': 1.5, 'assignable': True}, {'username': 'blorp', 'age': 2, 'assignable': False}): self.db.user.create(**user) file_content = ''.join([chr(i) for i in range(255)]) f = self.db.file.create(content=file_content) for issue in ( {'title': 'issue one', 'status': '2', 'assignedto': '1', 'foo': date.Interval('1:10'), 'priority': '3', 'deadline': date.Date('2003-02-16.22:50')}, {'title': 'issue two', 'status': '1', 'assignedto': '2', 'foo': date.Interval('1d'), 'priority': '3', 'deadline': date.Date('2003-01-01.00:00')}, {'title': 'issue three', 'status': '1', 'priority': '2', 'nosy': ['1','2'], 'deadline': date.Date('2003-02-18')}, {'title': 'non four', 'status': '3', 'foo': date.Interval('0:10'), 'priority': '2', 'nosy': ['1','2','3'], 'deadline': date.Date('2004-03-08'), 'files': [f]}): self.db.issue.create(**issue) self.db.commit() return self.iterSetup(classname) def testFilteringNone(self): ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, None, ('+','id'), (None,None)), ['1', '2', '3', '4']) def testSortingNone(self): ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {'id': ['1','3','4']}, None, ('-', 'status')), ['3', '4', '1']) def testGroupingNone(self): ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {'title': ['issue']}, [('-', 'id')], None), ['3', '2', '1']) def testFilteringID(self): ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {'id': '1'}, ('+','id'), (None,None)), ['1']) ae(filt(None, {'id': '2'}, ('+','id'), (None,None)), ['2']) ae(filt(None, {'id': '100'}, ('+','id'), (None,None)), []) def testFilteringBoolean(self): ae, iiter = self.filteringSetup('user') a = 'assignable' for filt in iiter(): ae(filt(None, {a: '1'}, ('+','id'), (None,None)), ['3','4']) ae(filt(None, {a: '0'}, ('+','id'), (None,None)), ['5']) ae(filt(None, {a: ['1']}, ('+','id'), (None,None)), ['3','4']) ae(filt(None, {a: ['0']}, ('+','id'), (None,None)), ['5']) ae(filt(None, {a: ['0','1']}, ('+','id'), (None,None)), ['3','4','5']) ae(filt(None, {a: 'True'}, ('+','id'), (None,None)), ['3','4']) ae(filt(None, {a: 'False'}, ('+','id'), (None,None)), ['5']) ae(filt(None, {a: ['True']}, ('+','id'), (None,None)), ['3','4']) ae(filt(None, {a: ['False']}, ('+','id'), (None,None)), ['5']) ae(filt(None, {a: ['False','True']}, ('+','id'), (None,None)), ['3','4','5']) ae(filt(None, {a: True}, ('+','id'), (None,None)), ['3','4']) ae(filt(None, {a: False}, ('+','id'), (None,None)), ['5']) ae(filt(None, {a: 1}, ('+','id'), (None,None)), ['3','4']) ae(filt(None, {a: 0}, ('+','id'), (None,None)), ['5']) ae(filt(None, {a: [1]}, ('+','id'), (None,None)), ['3','4']) ae(filt(None, {a: [0]}, ('+','id'), (None,None)), ['5']) ae(filt(None, {a: [0,1]}, ('+','id'), (None,None)), ['3','4','5']) ae(filt(None, {a: [True]}, ('+','id'), (None,None)), ['3','4']) ae(filt(None, {a: [False]}, ('+','id'), (None,None)), ['5']) ae(filt(None, {a: [False,True]}, ('+','id'), (None,None)), ['3','4','5']) def testFilteringNumber(self): ae, iiter = self.filteringSetup('user') for filt in iiter(): ae(filt(None, {'age': '1'}, ('+','id'), (None,None)), ['3']) ae(filt(None, {'age': '1.5'}, ('+','id'), (None,None)), ['4']) ae(filt(None, {'age': '2'}, ('+','id'), (None,None)), ['5']) ae(filt(None, {'age': ['1','2']}, ('+','id'), (None,None)), ['3','5']) ae(filt(None, {'age': 2}, ('+','id'), (None,None)), ['5']) ae(filt(None, {'age': [1,2]}, ('+','id'), (None,None)), ['3','5']) def testFilteringString(self): ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {'title': ['one']}, ('+','id'), (None,None)), ['1']) ae(filt(None, {'title': ['issue one']}, ('+','id'), (None,None)), ['1']) ae(filt(None, {'title': ['issue', 'one']}, ('+','id'), (None,None)), ['1']) ae(filt(None, {'title': ['issue']}, ('+','id'), (None,None)), ['1','2','3']) ae(filt(None, {'title': ['one', 'two']}, ('+','id'), (None,None)), []) def testFilteringStringCase(self): """ Similar to testFilteringString except the search parameters have different capitalization. """ ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {'title': ['One']}, ('+','id'), (None,None)), ['1']) ae(filt(None, {'title': ['Issue One']}, ('+','id'), (None,None)), ['1']) ae(filt(None, {'title': ['ISSUE', 'ONE']}, ('+','id'), (None,None)), ['1']) ae(filt(None, {'title': ['iSSUE']}, ('+','id'), (None,None)), ['1','2','3']) ae(filt(None, {'title': ['One', 'Two']}, ('+','id'), (None,None)), []) def testFilteringStringExactMatch(self): ae, iiter = self.filteringSetup() # Change title of issue2 to 'issue' so we can test substring # search vs exact search self.db.issue.set('2', title='issue') #self.db.commit() for filt in iiter(): ae(filt(None, {}, exact_match_spec = {'title': ['one']}), []) ae(filt(None, {}, exact_match_spec = {'title': ['issue one']}), ['1']) ae(filt(None, {}, exact_match_spec = {'title': ['issue', 'one']}), []) ae(filt(None, {}, exact_match_spec = {'title': ['issue']}), ['2']) ae(filt(None, {}, exact_match_spec = {'title': ['one', 'two']}), []) ae(filt(None, {}, exact_match_spec = {'title': ['One']}), []) ae(filt(None, {}, exact_match_spec = {'title': ['Issue One']}), []) ae(filt(None, {}, exact_match_spec = {'title': ['ISSUE', 'ONE']}), []) ae(filt(None, {}, exact_match_spec = {'title': ['iSSUE']}), []) ae(filt(None, {}, exact_match_spec = {'title': ['One', 'Two']}), []) ae(filt(None, {}, exact_match_spec = {'title': ['non four']}), ['4']) # Both, filterspec and exact_match_spec on same prop ae(filt(None, {'title': 'iSSUE'}, exact_match_spec = {'title': ['issue']}), ['2']) def testFilteringSpecialChars(self): """ Special characters in SQL search are '%' and '_', some used to lead to a traceback. """ ae, iiter = self.filteringSetup() self.db.issue.set('1', title="With % symbol") self.db.issue.set('2', title="With _ symbol") self.db.issue.set('3', title="With \\ symbol") self.db.issue.set('4', title="With ' symbol") d = dict (status = '1') for filt in iiter(): ae(filt(None, dict(title='%'), ('+','id'), (None,None)), ['1']) ae(filt(None, dict(title='_'), ('+','id'), (None,None)), ['2']) ae(filt(None, dict(title='\\'), ('+','id'), (None,None)), ['3']) ae(filt(None, dict(title="'"), ('+','id'), (None,None)), ['4']) def testFilteringLink(self): ae, iiter = self.filteringSetup() a = 'assignedto' grp = (None, None) for filt in iiter(): ae(filt(None, {'status': '1'}, ('+','id'), grp), ['2','3']) ae(filt(None, {'status': [], 'status.name': 'unread'}), []) ae(filt(None, {a: '-1'}, ('+','id'), grp), ['3','4']) ae(filt(None, {a: None}, ('+','id'), grp), ['3','4']) ae(filt(None, {a: [None]}, ('+','id'), grp), ['3','4']) ae(filt(None, {a: ['-1', None]}, ('+','id'), grp), ['3','4']) ae(filt(None, {a: ['1', None]}, ('+','id'), grp), ['1', '3','4']) def testFilteringBrokenLinkExpression(self): ae, iiter = self.filteringSetup() a = 'assignedto' for filt in iiter(): with self.assertRaises(ExpressionError) as e: filt(None, {a: ['1', '-3']}, ('+','status')) self.assertIn("position 2", str(e.exception)) # verify all tokens are consumed self.assertNotIn("%", str(e.exception)) self.assertNotIn("%", repr(e.exception)) with self.assertRaises(ExpressionError) as e: filt(None, {a: ['0', '1', '2', '3', '-3', '-4']}, ('+','status')) self.assertIn("values on the stack are: [Value 0,", str(e.exception)) self.assertNotIn("%", str(e.exception)) self.assertNotIn("%", repr(e.exception)) with self.assertRaises(ExpressionError) as e: # expression tests _repr_ for every operator and # three values filt(None, {a: ['-1', '1', '2', '3', '-3', '-2', '-4']}, ('+','status')) result = str(e.exception) self.assertIn(" AND ", result) self.assertIn(" OR ", result) self.assertIn("NOT(", result) self.assertIn("ISEMPTY(-1)", result) # trigger a KeyError and verify fallback format # is correct. It includes the template with %(name)s tokens, del(e.exception.context['class']) self.assertIn("values on the stack are: %(stack)s", str(e.exception)) self.assertIn("values on the stack are: %(stack)s", repr(e.exception)) def testFilteringLinkExpression(self): ae, iiter = self.filteringSetup() a = 'assignedto' for filt in iiter(): ae(filt(None, {}, ('+',a)), ['3','4','1','2']) ae(filt(None, {a: '1'}, ('+',a)), ['1']) ae(filt(None, {a: '2'}, ('+',a)), ['2']) ae(filt(None, {a: '-1'}, ('+','status')), ['4','3']) ae(filt(None, {a: []}, ('+','id')), ['3','4']) ae(filt(None, {a: ['-1']}, ('+',a)), ['3','4']) ae(filt(None, {a: []}, ('+',a)), ['3','4']) ae(filt(None, {a: '-1'}, ('+',a)), ['3','4']) ae(filt(None, {a: ['1','-1']}), ['1','3','4']) ae(filt(None, {a: ['1','-1']}, ('+',a)), ['3','4','1']) ae(filt(None, {a: ['2','-1']}, ('+',a)), ['3','4','2']) ae(filt(None, {a: ['2','-1','-4']}, ('+',a)), ['3','4','2']) ae(filt(None, {a: ['2','-1','-4','-2']}, ('+',a)), ['1']) ae(filt(None, {a: ['1','-2']}), ['2','3','4']) ae(filt(None, {a: ['1','-2']}, ('+',a)), ['3','4','2']) ae(filt(None, {a: ['-1','-2']}, ('+',a)), ['1','2']) ae(filt(None, {a: ['1','2','-3']}, ('+',a)), []) ae(filt(None, {a: ['1','2','-4']}, ('+',a)), ['1','2']) ae(filt(None, {a: ['1','-2','2','-2','-3']}, ('+',a)), ['3','4']) ae(filt(None, {a: ['1','-2','2','-2','-4']}, ('+',a)), ['3','4','1','2']) def testFilteringRevLink(self): ae, iiter = self.filteringSetupTransitiveSearch('user') # We have # issue assignedto # 1: 6 # 2: 6 # 3: 7 # 4: 8 # 5: 9 # 6: 10 # 7: 10 # 8: 10 for filt in iiter(): ae(filt(None, {'issues': ['3', '4']}), ['7', '8']) ae(filt(None, {'issues': ['1', '4', '8']}), ['6', '8', '10']) ae(filt(None, {'issues.title': ['ts2']}), ['6']) ae(filt(None, {'issues': ['-1']}), ['1', '2', '3', '4', '5']) ae(filt(None, {'issues': '-1'}), ['1', '2', '3', '4', '5']) def ls(x): return list(sorted(x)) self.assertEqual(ls(self.db.user.get('6', 'issues')), ['1', '2']) self.assertEqual(ls(self.db.user.get('7', 'issues')), ['3']) self.assertEqual(ls(self.db.user.get('10', 'issues')), ['6', '7', '8']) n = self.db.user.getnode('6') self.assertEqual(ls(n.issues), ['1', '2']) # Now retire some linked-to issues and retry self.db.issue.retire('6') self.db.issue.retire('2') self.db.issue.retire('3') self.db.commit() for filt in iiter(): ae(filt(None, {'issues': ['3', '4']}), ['8']) ae(filt(None, {'issues': ['1', '4', '8']}), ['6', '8', '10']) ae(filt(None, {'issues.title': ['ts2']}), []) ae(filt(None, {'issues': ['-1']}), ['1', '2', '3', '4', '5', '7']) ae(filt(None, {'issues': '-1'}), ['1', '2', '3', '4', '5', '7']) self.assertEqual(ls(self.db.user.get('6', 'issues')), ['1']) self.assertEqual(ls(self.db.user.get('7', 'issues')), []) self.assertEqual(ls(self.db.user.get('10', 'issues')), ['7', '8']) def testFilteringRevLinkExpression(self): ae, iiter = self.filteringSetupTransitiveSearch('user') # We have # issue assignedto # 1: 6 # 2: 6 # 3: 7 # 4: 8 # 5: 9 # 6: 10 # 7: 10 # 8: 10 for filt in iiter(): # Explicit 'or' ae(filt(None, {'issues': ['3', '4', '-4']}), ['7', '8']) # Implicit or with '-1' ae(filt(None, {'issues': ['3', '4', '-1']}), ['1', '2', '3', '4', '5', '7', '8']) # Explicit or with '-1': 3 or 4 or empty ae(filt(None, {'issues': ['3', '4', '-4', '-1', '-4']}), ['1', '2', '3', '4', '5', '7', '8']) # '3' and empty ae(filt(None, {'issues': ['3', '-1', '-3']}), []) # '6' and '7' and '8' ae(filt(None, {'issues': ['6', '7', '-3', '8', '-3']}), ['10']) # '6' and '7' or '1' and '2' ae(filt(None, {'issues': ['6', '7', '-3', '1', '2', '-3', '-4']}), ['6', '10']) # '1' or '4' ae(filt(None, {'issues': ['1', '4', '-4']}), ['6', '8']) # Now retire some linked-to issues and retry self.db.issue.retire('6') self.db.issue.retire('2') self.db.issue.retire('3') self.db.commit() # We have now # issue assignedto # 1: 6 # 4: 8 # 5: 9 # 7: 10 # 8: 10 for filt in iiter(): # Explicit 'or' ae(filt(None, {'issues': ['3', '4', '-4']}), ['8']) # Implicit or with '-1' ae(filt(None, {'issues': ['3', '4', '-1']}), ['1', '2', '3', '4', '5', '7', '8']) # Explicit or with '-1': 3 or 4 or empty ae(filt(None, {'issues': ['3', '4', '-4', '-1', '-4']}), ['1', '2', '3', '4', '5', '7', '8']) # '3' and empty ae(filt(None, {'issues': ['3', '-1', '-3']}), []) # '6' and '7' and '8' ae(filt(None, {'issues': ['6', '7', '-3', '8', '-3']}), []) # '7' and '8' ae(filt(None, {'issues': ['7', '8', '-3']}), ['10']) # '6' and '7' or '1' and '2' ae(filt(None, {'issues': ['6', '7', '-3', '1', '2', '-3', '-4']}), []) # '1' or '4' ae(filt(None, {'issues': ['1', '4', '-4']}), ['6', '8']) def testFilteringLinkSortSearchMultilink(self): ae, iiter = self.filteringSetup() a = 'assignedto' grp = (None, None) for filt in iiter(): ae(filt(None, {'status.mls': '1'}, ('+','status')), ['2','3']) ae(filt(None, {'status.mls': '2'}, ('+','status')), ['2','3']) def testFilteringMultilinkAndGroup(self): """testFilteringMultilinkAndGroup: See roundup Bug 1541128: apparently grouping by something and searching a Multilink failed with MySQL 5.0 """ ae, iiter = self.filteringSetup() for f in iiter(): ae(f(None, {'files': '1'}, ('-','activity'), ('+','status')), ['4']) def testFilteringRetired(self): ae, iiter = self.filteringSetup() self.db.issue.retire('2') for f in iiter(): ae(f(None, {'status': '1'}, ('+','id'), (None,None)), ['3']) def testFilteringMultilink(self): ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {'nosy': '3'}, ('+','id'), (None,None)), ['4']) ae(filt(None, {'nosy': '-1'}, ('+','id'), (None,None)), ['1', '2']) ae(filt(None, {'nosy': ['1','2']}, ('+', 'status'), ('-', 'deadline')), ['4', '3']) def testFilteringBrokenMultilinkExpression(self): ae, iiter = self.filteringSetup() kw1 = self.db.keyword.create(name='Key1') kw2 = self.db.keyword.create(name='Key2') kw3 = self.db.keyword.create(name='Key3') kw4 = self.db.keyword.create(name='Key4') self.db.issue.set('1', keywords=[kw1, kw2]) self.db.issue.set('2', keywords=[kw1, kw3]) self.db.issue.set('3', keywords=[kw2, kw3, kw4]) self.db.issue.set('4', keywords=[kw1, kw2, kw4]) self.db.commit() kw = 'keywords' for filt in iiter(): with self.assertRaises(ExpressionError) as e: filt(None, {kw: ['1', '-3']}, ('+','status')) self.assertIn("searching issue by keywords", str(e.exception)) self.assertIn("position 2", str(e.exception)) # verify all tokens are consumed self.assertNotIn("%", str(e.exception)) self.assertNotIn("%", repr(e.exception)) with self.assertRaises(ExpressionError) as e: filt(None, {kw: ['0', '1', '2', '3', '-3', '-4']}, ('+','status')) self.assertIn("searching issue by keywords", str(e.exception)) self.assertIn("values on the stack are: [Value 0,", str(e.exception)) self.assertNotIn("%", str(e.exception)) self.assertNotIn("%", repr(e.exception)) with self.assertRaises(ExpressionError) as e: # expression tests _repr_ for every operator and # three values filt(None, {kw: ['-1', '1', '2', '3', '-3', '-2', '-4']}, ('+','status')) result = str(e.exception) self.assertIn("searching issue by keywords", result) self.assertIn(" AND ", result) self.assertIn(" OR ", result) self.assertIn("NOT(", result) self.assertIn("ISEMPTY(-1)", result) # trigger a KeyError and verify fallback format # is correct. It includes the template with %(name)s tokens, del(e.exception.context['class']) self.assertIn("values on the stack are: %(stack)s", str(e.exception)) self.assertIn("values on the stack are: %(stack)s", repr(e.exception)) def testFilteringMultilinkExpression(self): ae, iiter = self.filteringSetup() kw1 = self.db.keyword.create(name='Key1') kw2 = self.db.keyword.create(name='Key2') kw3 = self.db.keyword.create(name='Key3') kw4 = self.db.keyword.create(name='Key4') self.db.issue.set('1', keywords=[kw1, kw2]) self.db.issue.set('2', keywords=[kw1, kw3]) self.db.issue.set('3', keywords=[kw2, kw3, kw4]) self.db.issue.set('4', keywords=[kw1, kw2, kw4]) self.db.commit() kw = 'keywords' for filt in iiter(): # '1' and '2' ae(filt(None, {kw: ['1', '2', '-3']}), ['1', '4']) # ('2' and '4') and '1' ae(filt(None, {kw: ['1', '2', '4', '-3', '-3']}), ['4']) # not '4' and '3' ae(filt(None, {kw: ['3', '4', '-2', '-3']}), ['2']) # (not '4' and '3') and '2' ae(filt(None, {kw: ['2', '3', '4', '-2', '-3', '-3']}), []) # '1' or '2' without explicit 'or' ae(filt(None, {kw: ['1', '2']}), ['1', '2', '3', '4']) # '1' or '2' with explicit 'or' ae(filt(None, {kw: ['1', '2', '-4']}), ['1', '2', '3', '4']) # '3' or '4' without explicit 'or' ae(filt(None, {kw: ['3', '4']}), ['2', '3', '4']) # '3' or '4' with explicit 'or' ae(filt(None, {kw: ['3', '4', '-4']}), ['2', '3', '4']) # ('3' and '4') or ('1' and '2') ae(filt(None, {kw: ['3', '4', '-3', '1', '2', '-3', '-4']}), ['1', '3', '4']) # '2' and empty ae(filt(None, {kw: ['2', '-1', '-3']}), []) self.db.issue.set('1', keywords=[]) self.db.commit() for filt in iiter(): ae(filt(None, {kw: ['-1']}), ['1']) # '3' or empty (without explicit 'or') ae(filt(None, {kw: ['3', '-1']}), ['1', '2', '3']) # '3' or empty (with explicit 'or') ae(filt(None, {kw: ['3', '-1', '-4']}), ['1', '2', '3']) # empty or '3' (with explicit 'or') ae(filt(None, {kw: ['-1', '3', '-4']}), ['1', '2', '3']) # '3' and empty (should always return empty list) ae(filt(None, {kw: ['3', '-1', '-3']}), []) # empty and '3' (should always return empty list) ae(filt(None, {kw: ['3', '-1', '-3']}), []) # ('4' and empty) or ('3' or empty) ae(filt(None, {kw: ['4', '-1', '-3', '3', '-1', '-4', '-4']}), ['1', '2', '3']) def testFilteringTwoMultilinksExpression(self): ae, iiter = self.filteringSetup() kw1 = self.db.keyword.create(name='Key1', order=10) kw2 = self.db.keyword.create(name='Key2', order=20) kw3 = self.db.keyword.create(name='Key3', order=30) kw4 = self.db.keyword.create(name='Key4', order=40) self.db.issue.set('1', keywords=[kw1, kw2]) self.db.issue.set('2', keywords=[kw1, kw3]) self.db.issue.set('3', keywords=[kw2, kw3, kw4]) self.db.issue.set('4', keywords=[]) self.db.issue.set('1', keywords2=[kw3, kw4]) self.db.issue.set('2', keywords2=[kw2, kw3]) self.db.issue.set('3', keywords2=[kw1, kw3, kw4]) self.db.issue.set('4', keywords2=[]) self.db.commit() kw = 'keywords' kw2 = 'keywords2' for filt in iiter(): # kw: '1' and '3' kw2: '2' and '3' ae(filt(None, {kw: ['1', '3', '-3'], kw2: ['2', '3', '-3']}), ['2']) # kw: empty kw2: empty ae(filt(None, {kw: ['-1'], kw2: ['-1']}), ['4']) # kw: empty kw2: empty ae(filt(None, {kw: [], kw2: []}), ['4']) # look for both keyword name and order ae(filt(None, {'keywords.name': 'y4', 'keywords.order': 40}), ['3']) # look for both keyword and order non-matching ae(filt(None, {kw: '3', 'keywords.order': 40}), []) # look for both keyword and order non-matching with kw and kw2 ae(filt(None, {kw: '3', 'keywords2.order': 40}), ['3']) def testFilteringRevMultilink(self): ae, iiter = self.filteringSetupTransitiveSearch('user') ni = 'nosy_issues' self.db.issue.set('6', nosy=['3', '4', '5']) self.db.issue.set('7', nosy=['5']) # After this setup we have the following values for nosy: # issue nosy # 1: 4 # 2: 5 # 3: # 4: # 5: # 6: 3, 4, 5 # 7: 5 # 8: for filt in iiter(): ae(filt(None, {ni: ['1', '2']}), ['4', '5']) ae(filt(None, {ni: ['6','7']}), ['3', '4', '5']) ae(filt(None, {'nosy_issues.title': ['ts2']}), ['5']) ae(filt(None, {ni: ['-1']}), ['1', '2', '6', '7', '8', '9', '10']) ae(filt(None, {ni: '-1'}), ['1', '2', '6', '7', '8', '9', '10']) def ls(x): return list(sorted(x)) self.assertEqual(ls(self.db.user.get('4', ni)), ['1', '6']) self.assertEqual(ls(self.db.user.get('5', ni)), ['2', '6', '7']) n = self.db.user.getnode('4') self.assertEqual(ls(n.nosy_issues), ['1', '6']) # Now retire some linked-to issues and retry self.db.issue.retire('2') self.db.issue.retire('6') self.db.commit() for filt in iiter(): ae(filt(None, {ni: ['1', '2']}), ['4']) ae(filt(None, {ni: ['6','7']}), ['5']) ae(filt(None, {'nosy_issues.title': ['ts2']}), []) ae(filt(None, {ni: ['-1']}), ['1', '2', '3', '6', '7', '8', '9', '10']) ae(filt(None, {ni: '-1'}), ['1', '2', '3', '6', '7', '8', '9', '10']) self.assertEqual(ls(self.db.user.get('4', ni)), ['1']) self.assertEqual(ls(self.db.user.get('5', ni)), ['7']) def testFilteringRevMultilinkQ2(self): ae, iiter = self.filteringSetupTransitiveSearch('user') ni = 'nosy_issues' nis = 'nosy_issues.status' self.db.issue.set('6', nosy=['3', '4', '5']) self.db.issue.set('7', nosy=['5']) self.db.commit() # After this setup we have the following values for nosy: # The issues '1', '3', '5', '7' have status '2' # issue nosy # 1: 4 # 2: 5 # 3: # 4: # 5: # 6: 3, 4, 5 # 7: 5 # 8: for filt in iiter(): # status of issue is '2' ae(filt(None, {nis: ['2']}), ['4', '5']) # Issue non-empty and status of issue is '2' ae(filt(None, {nis: ['2'], ni:['-1', '-2']}), ['4', '5']) # empty and status '2' # This is the test-case for issue2551119 ae(filt(None, {nis: ['2'], ni:['-1']}), []) def testFilteringRevMultilinkExpression(self): ae, iiter = self.filteringSetupTransitiveSearch('user') ni = 'nosy_issues' self.db.issue.set('6', nosy=['3', '4', '5']) self.db.issue.set('7', nosy=['5']) # After this setup we have the following values for nosy: # issue nosy # 1: 4 # 2: 5 # 3: # 4: # 5: # 6: 3, 4, 5 # 7: 5 # 8: # Retire users '9' and '10' to reduce list self.db.user.retire('9') self.db.user.retire('10') self.db.commit() for filt in iiter(): # not empty ae(filt(None, {ni: ['-1', '-2']}), ['3', '4', '5']) # '1' or '2' ae(filt(None, {ni: ['1', '2', '-4']}), ['4', '5']) # '6' or '7' ae(filt(None, {ni: ['6', '7', '-4']}), ['3', '4', '5']) # '6' and '7' ae(filt(None, {ni: ['6', '7', '-3']}), ['5']) # '6' and not '1' ae(filt(None, {ni: ['6', '1', '-2', '-3']}), ['3', '5']) # '2' or empty (implicit or) ae(filt(None, {ni: ['-1', '2']}), ['1', '2', '5', '6', '7', '8']) # '2' or empty (explicit or) ae(filt(None, {ni: ['-1', '2', '-4']}), ['1', '2', '5', '6', '7', '8']) # empty or '2' (explicit or) ae(filt(None, {ni: ['2', '-1', '-4']}), ['1', '2', '5', '6', '7', '8']) # '2' and empty (should always return empty list) ae(filt(None, {ni: ['-1', '2', '-3']}), []) # empty and '2' (should always return empty list) ae(filt(None, {ni: ['2', '-1', '-3']}), []) # ('4' and empty) or ('2' or empty) ae(filt(None, {ni: ['4', '-1', '-3', '2', '-1', '-4', '-4']}), ['1', '2', '5', '6', '7', '8']) # Retire issues 2, 6 and retry self.db.issue.retire('2') self.db.issue.retire('6') self.db.commit() # After this setup we have the following values for nosy: # issue nosy # 1: 4 # 3: # 4: # 5: # 7: 5 # 8: for filt in iiter(): # not empty ae(filt(None, {ni: ['-1', '-2']}), ['4', '5']) # '1' or '2' (implicit) ae(filt(None, {ni: ['1', '2']}), ['4']) # '1' or '2' ae(filt(None, {ni: ['1', '2', '-4']}), ['4']) # '6' or '7' ae(filt(None, {ni: ['6', '7', '-4']}), ['5']) # '6' and '7' ae(filt(None, {ni: ['6', '7', '-3']}), []) # '6' and not '1' ae(filt(None, {ni: ['6', '1', '-2', '-3']}), []) # not '1' ae(filt(None, {ni: ['1', '-2']}), ['1', '2', '3', '5', '6', '7', '8']) # '2' or empty (implicit or) ae(filt(None, {ni: ['-1', '2']}), ['1', '2', '3', '6', '7', '8']) # '2' or empty (explicit or) ae(filt(None, {ni: ['-1', '2', '-4']}), ['1', '2', '3', '6', '7', '8']) # empty or '2' (explicit or) ae(filt(None, {ni: ['2', '-1', '-4']}), ['1', '2', '3', '6', '7', '8']) # '2' and empty (should always return empty list) ae(filt(None, {ni: ['-1', '2', '-3']}), []) # empty and '2' (should always return empty list) ae(filt(None, {ni: ['2', '-1', '-3']}), []) # ('4' and empty) or ('2' or empty) ae(filt(None, {ni: ['4', '-1', '-3', '2', '-1', '-4', '-4']}), ['1', '2', '3', '6', '7', '8']) def testFilteringMany(self): ae, iiter = self.filteringSetup() for f in iiter(): ae(f(None, {'nosy': '2', 'status': '1'}, ('+','id'), (None,None)), ['3']) def testFilteringRangeBasic(self): ae, iiter = self.filteringSetup() d = 'deadline' for f in iiter(): ae(f(None, {d: 'from 2003-02-10 to 2003-02-23'}), ['1','3']) ae(f(None, {d: '2003-02-10; 2003-02-23'}), ['1','3']) ae(f(None, {d: '; 2003-02-16'}), ['2']) def testFilteringRangeTwoSyntaxes(self): ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {'deadline': 'from 2003-02-16'}), ['1', '3', '4']) ae(filt(None, {'deadline': '2003-02-16;'}), ['1', '3', '4']) def testFilteringRangeYearMonthDay(self): ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {'deadline': '2002'}), []) ae(filt(None, {'deadline': '2003'}), ['1', '2', '3']) ae(filt(None, {'deadline': '2004'}), ['4']) ae(filt(None, {'deadline': '2003-02-16'}), ['1']) ae(filt(None, {'deadline': '2003-02-17'}), []) def testFilteringRangeMonths(self): ae, iiter = self.filteringSetup() for month in range(1, 13): for n in range(1, month+1): i = self.db.issue.create(title='%d.%d'%(month, n), deadline=date.Date('2001-%02d-%02d.00:00'%(month, n))) self.db.commit() for month in range(1, 13): for filt in iiter(): r = filt(None, dict(deadline='2001-%02d'%month)) assert len(r) == month, 'month %d != length %d'%(month, len(r)) def testFilteringDateRangeMulti(self): ae, iiter = self.filteringSetup() self.db.issue.create(title='no deadline') self.db.commit() for filt in iiter(): r = filt (None, dict(deadline='-')) self.assertEqual(r, ['5']) r = filt (None, dict(deadline=';2003-02-01,2004;')) self.assertEqual(r, ['2', '4']) r = filt (None, dict(deadline='-,;2003-02-01,2004;')) self.assertEqual(r, ['2', '4', '5']) def testFilteringRangeInterval(self): ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {'foo': 'from 0:50 to 2:00'}), ['1']) ae(filt(None, {'foo': 'from 0:50 to 1d 2:00'}), ['1', '2']) ae(filt(None, {'foo': 'from 5:50'}), ['2']) ae(filt(None, {'foo': 'to 0:05'}), []) def testFilteringRangeGeekInterval(self): ae, iiter = self.filteringSetup() # Note: When querying, create date one minute later than the # timespan later queried to avoid race conditions where the # creation of the deadline is more than a second ago when # queried -- in that case we wouldn't get the expected result. # By extending the interval by a minute we would need a very # slow machine for this test to fail :-) for issue in ( { 'deadline': date.Date('. -2d') + date.Interval ('00:01')}, { 'deadline': date.Date('. -1d') + date.Interval ('00:01')}, { 'deadline': date.Date('. -8d') + date.Interval ('00:01')}, ): self.db.issue.create(**issue) for filt in iiter(): ae(filt(None, {'deadline': '-2d;'}), ['5', '6']) ae(filt(None, {'deadline': '-1d;'}), ['6']) ae(filt(None, {'deadline': '-1w;'}), ['5', '6']) ae(filt(None, {'deadline': '. -2d;'}), ['5', '6']) ae(filt(None, {'deadline': '. -1d;'}), ['6']) ae(filt(None, {'deadline': '. -1w;'}), ['5', '6']) def testFilteringIntervalSort(self): # 1: '1:10' # 2: '1d' # 3: None # 4: '0:10' ae, iiter = self.filteringSetup() for filt in iiter(): # ascending should sort None, 1:10, 1d ae(filt(None, {}, ('+','foo'), (None,None)), ['3', '4', '1', '2']) # descending should sort 1d, 1:10, None ae(filt(None, {}, ('-','foo'), (None,None)), ['2', '1', '4', '3']) def testFilteringStringSort(self): # 1: 'issue one' # 2: 'issue two' # 3: 'issue three' # 4: 'non four' ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {}, ('+','title')), ['1', '3', '2', '4']) ae(filt(None, {}, ('-','title')), ['4', '2', '3', '1']) # Test string case: For now allow both, w/wo case matching. # 1: 'issue one' # 2: 'issue two' # 3: 'Issue three' # 4: 'non four' self.db.issue.set('3', title='Issue three') for filt in iiter(): ae(filt(None, {}, ('+','title')), ['1', '3', '2', '4']) ae(filt(None, {}, ('-','title')), ['4', '2', '3', '1']) # Obscure bug in anydbm backend trying to convert to number # 1: '1st issue' # 2: '2' # 3: 'Issue three' # 4: 'non four' self.db.issue.set('1', title='1st issue') self.db.issue.set('2', title='2') for filt in iiter(): ae(filt(None, {}, ('+','title')), ['1', '2', '3', '4']) ae(filt(None, {}, ('-','title')), ['4', '3', '2', '1']) def testFilteringMultilinkSort(self): # 1: [] Reverse: 1: [] # 2: [] 2: [] # 3: ['admin','fred'] 3: ['fred','admin'] # 4: ['admin','bleep','fred'] 4: ['fred','bleep','admin'] # Note the sort order for the multilink doen't change when # reversing the sort direction due to the re-sorting of the # multilink! # Note that we don't test filter_iter here, Multilink sort-order # isn't defined for that. ae, iiter = self.filteringSetup() for filt in iiter(): if filt.__name__ != 'filter': continue ae(filt(None, {}, ('+','nosy'), (None,None)), ['1', '2', '4', '3']) ae(filt(None, {}, ('-','nosy'), (None,None)), ['4', '3', '1', '2']) def testFilteringMultilinkSortGroup(self): # 1: status: 2 "in-progress" nosy: [] # 2: status: 1 "unread" nosy: [] # 3: status: 1 "unread" nosy: ['admin','fred'] # 4: status: 3 "testing" nosy: ['admin','bleep','fred'] # Note that we don't test filter_iter here, Multilink sort-order # isn't defined for that. ae, iiter = self.filteringSetup() for filt in iiter(): if filt.__name__ != 'filter': continue ae(filt(None, {}, ('+','nosy'), ('+','status')), ['1', '4', '2', '3']) ae(filt(None, {}, ('-','nosy'), ('+','status')), ['1', '4', '3', '2']) ae(filt(None, {}, ('+','nosy'), ('-','status')), ['2', '3', '4', '1']) ae(filt(None, {}, ('-','nosy'), ('-','status')), ['3', '2', '4', '1']) ae(filt(None, {}, ('+','status'), ('+','nosy')), ['1', '2', '4', '3']) ae(filt(None, {}, ('-','status'), ('+','nosy')), ['2', '1', '4', '3']) ae(filt(None, {}, ('+','status'), ('-','nosy')), ['4', '3', '1', '2']) ae(filt(None, {}, ('-','status'), ('-','nosy')), ['4', '3', '2', '1']) def testFilteringLinkSortGroup(self): # 1: status: 2 -> 'i', priority: 3 -> 1 # 2: status: 1 -> 'u', priority: 3 -> 1 # 3: status: 1 -> 'u', priority: 2 -> 3 # 4: status: 3 -> 't', priority: 2 -> 3 ae, iiter = self.filteringSetup() for filt in iiter(): ae(filt(None, {}, ('+','status'), ('+','priority')), ['1', '2', '4', '3']) ae(filt(None, {'priority':'2'}, ('+','status'), ('+','priority')), ['4', '3']) ae(filt(None, {'priority.order':'3'}, ('+','status'), ('+','priority')), ['4', '3']) ae(filt(None, {'priority':['2','3']}, ('+','priority'), ('+','status')), ['1', '4', '2', '3']) ae(filt(None, {}, ('+','priority'), ('+','status')), ['1', '4', '2', '3']) def testFilteringDateSort(self): # '1': '2003-02-16.22:50' # '2': '2003-01-01.00:00' # '3': '2003-02-18' # '4': '2004-03-08' ae, iiter = self.filteringSetup() for f in iiter(): # ascending ae(f(None, {}, ('+','deadline'), (None,None)), ['2', '1', '3', '4']) # descending ae(f(None, {}, ('-','deadline'), (None,None)), ['4', '3', '1', '2']) def testFilteringDateSortPriorityGroup(self): # '1': '2003-02-16.22:50' 1 => 2 # '2': '2003-01-01.00:00' 3 => 1 # '3': '2003-02-18' 2 => 3 # '4': '2004-03-08' 1 => 2 ae, iiter = self.filteringSetup() for filt in iiter(): # ascending ae(filt(None, {}, ('+','deadline'), ('+','priority')), ['2', '1', '3', '4']) ae(filt(None, {}, ('-','deadline'), ('+','priority')), ['1', '2', '4', '3']) # descending ae(filt(None, {}, ('+','deadline'), ('-','priority')), ['3', '4', '2', '1']) ae(filt(None, {}, ('-','deadline'), ('-','priority')), ['4', '3', '1', '2']) def testFilteringTransitiveLinkUser(self): ae, iiter = self.filteringSetupTransitiveSearch('user') for f in iiter(): ae(f(None, {'supervisor.username': 'ceo'}, ('+','username')), ['4', '5']) ae(f(None, {'supervisor.supervisor.username': 'ceo'}, ('+','username')), ['6', '7', '8', '9', '10']) ae(f(None, {'supervisor.supervisor': '3'}, ('+','username')), ['6', '7', '8', '9', '10']) ae(f(None, {'supervisor.supervisor.id': '3'}, ('+','username')), ['6', '7', '8', '9', '10']) ae(f(None, {'supervisor.username': 'grouplead1'}, ('+','username')), ['6', '7']) ae(f(None, {'supervisor.username': 'grouplead2'}, ('+','username')), ['8', '9', '10']) ae(f(None, {'supervisor.username': 'grouplead2', 'supervisor.supervisor.username': 'ceo'}, ('+','username')), ['8', '9', '10']) ae(f(None, {'supervisor.supervisor': '3', 'supervisor': '4'}, ('+','username')), ['6', '7']) def testFilteringTransitiveLinkUserLimit(self): ae, iiter = self.filteringSetupTransitiveSearch('user') for f in iiter(): ae(f(None, {'supervisor.username': 'ceo'}, ('+','username'), limit=1), ['4']) ae(f(None, {'supervisor.supervisor.username': 'ceo'}, ('+','username'), limit=4), ['6', '7', '8', '9']) ae(f(None, {'supervisor.supervisor': '3'}, ('+','username'), limit=2, offset=2), ['8', '9']) ae(f(None, {'supervisor.supervisor.id': '3'}, ('+','username'), limit=3, offset=1), ['7', '8', '9']) ae(f(None, {'supervisor.username': 'grouplead2'}, ('+','username'), limit=2, offset=2), ['10']) ae(f(None, {'supervisor.username': 'grouplead2', 'supervisor.supervisor.username': 'ceo'}, ('+','username'), limit=4, offset=3), []) ae(f(None, {'supervisor.supervisor': '3', 'supervisor': '4'}, ('+','username'), limit=1, offset=5), []) def testFilteringTransitiveLinkSort(self): ae, iiter = self.filteringSetupTransitiveSearch() ae, uiter = self.iterSetup('user') # Need to make ceo his own (and first two users') supervisor, # otherwise we will depend on sorting order of NULL values. # Leave that to a separate test. self.db.user.set('1', supervisor = '3') self.db.user.set('2', supervisor = '3') self.db.user.set('3', supervisor = '3') for ufilt in uiter(): ae(ufilt(None, {'supervisor':'3'}, []), ['1', '2', '3', '4', '5']) ae(ufilt(None, {}, [('+','supervisor.supervisor.supervisor'), ('+','supervisor.supervisor'), ('+','supervisor'), ('+','username')]), ['1', '3', '2', '4', '5', '6', '7', '8', '9', '10']) ae(ufilt(None, {}, [('+','supervisor.supervisor.supervisor'), ('-','supervisor.supervisor'), ('-','supervisor'), ('+','username')]), ['8', '9', '10', '6', '7', '1', '3', '2', '4', '5']) for f in iiter(): ae(f(None, {}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('+','assignedto.supervisor'), ('+','assignedto')]), ['1', '2', '3', '4', '5', '6', '7', '8']) ae(f(None, {}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('-','assignedto.supervisor'), ('+','assignedto')]), ['4', '5', '6', '7', '8', '1', '2', '3']) ae(f(None, {}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('+','assignedto.supervisor'), ('+','assignedto'), ('-','status')]), ['2', '1', '3', '4', '5', '6', '8', '7']) ae(f(None, {}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('+','assignedto.supervisor'), ('+','assignedto'), ('+','status')]), ['1', '2', '3', '4', '5', '7', '6', '8']) ae(f(None, {}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('-','assignedto.supervisor'), ('+','assignedto'), ('+','status')]), ['4', '5', '7', '6', '8', '1', '2', '3']) ae(f(None, {'assignedto':['6','7','8','9','10']}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('-','assignedto.supervisor'), ('+','assignedto'), ('+','status')]), ['4', '5', '7', '6', '8', '1', '2', '3']) ae(f(None, {'assignedto':['6','7','8','9']}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('-','assignedto.supervisor'), ('+','assignedto'), ('+','status')]), ['4', '5', '1', '2', '3']) def testFilteringTransitiveLinkSortNull(self): """Check sorting of NULL values""" ae, iiter = self.filteringSetupTransitiveSearch() ae, uiter = self.iterSetup('user') for ufilt in uiter(): ae(ufilt(None, {}, [('+','supervisor.supervisor.supervisor'), ('+','supervisor.supervisor'), ('+','supervisor'), ('+','username')]), ['1', '3', '2', '4', '5', '6', '7', '8', '9', '10']) ae(ufilt(None, {}, [('+','supervisor.supervisor.supervisor'), ('-','supervisor.supervisor'), ('-','supervisor'), ('+','username')]), ['8', '9', '10', '6', '7', '4', '5', '1', '3', '2']) for f in iiter(): ae(f(None, {}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('+','assignedto.supervisor'), ('+','assignedto')]), ['1', '2', '3', '4', '5', '6', '7', '8']) ae(f(None, {}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('-','assignedto.supervisor'), ('+','assignedto')]), ['4', '5', '6', '7', '8', '1', '2', '3']) def testFilteringTransitiveLinkIssue(self): ae, iiter = self.filteringSetupTransitiveSearch() for filt in iiter(): ae(filt(None, {'assignedto.supervisor.username': 'grouplead1'}, ('+','id')), ['1', '2', '3']) ae(filt(None, {'assignedto.supervisor.username': 'grouplead2'}, ('+','id')), ['4', '5', '6', '7', '8']) ae(filt(None, {'assignedto.supervisor.username': 'grouplead2', 'status': '1'}, ('+','id')), ['4', '6', '8']) ae(filt(None, {'assignedto.supervisor.username': 'grouplead2', 'status': '2'}, ('+','id')), ['5', '7']) ae(filt(None, {'assignedto.supervisor.username': ['grouplead2'], 'status': '2'}, ('+','id')), ['5', '7']) ae(filt(None, {'assignedto.supervisor': ['4', '5'], 'status': '2'}, ('+','id')), ['1', '3', '5', '7']) def testFilteringTransitiveMultilink(self): ae, iiter = self.filteringSetupTransitiveSearch() for filt in iiter(): ae(filt(None, {'messages.author.username': 'grouplead1'}, ('+','id')), []) ae(filt(None, {'messages.author': '6'}, ('+','id')), ['1', '2']) ae(filt(None, {'messages.author.id': '6'}, ('+','id')), ['1', '2']) ae(filt(None, {'messages.author.username': 'worker1'}, ('+','id')), ['1', '2']) ae(filt(None, {'messages.author': '10'}, ('+','id')), ['6', '7', '8']) ae(filt(None, {'messages.author': '9'}, ('+','id')), ['5', '8']) ae(filt(None, {'messages.author': ['9', '10']}, ('+','id')), ['5', '6', '7', '8']) ae(filt(None, {'messages.author': ['8', '9']}, ('+','id')), ['4', '5', '8']) ae(filt(None, {'messages.author': ['8', '9'], 'status' : '1'}, ('+','id')), ['4', '8']) ae(filt(None, {'messages.author': ['8', '9'], 'status' : '2'}, ('+','id')), ['5']) ae(filt(None, {'messages.author': ['8', '9', '10'], 'messages.date': '2006-01-22.21:00;2006-01-23'}, ('+','id')), ['6', '7', '8']) ae(filt(None, {'nosy.supervisor.username': 'ceo'}, ('+','id')), ['1', '2']) ae(filt(None, {'messages.author': ['6', '9']}, ('+','id')), ['1', '2', '5', '8']) ae(filt(None, {'messages': ['5', '7']}, ('+','id')), ['3', '5', '8']) ae(filt(None, {'messages.author': ['6', '9'], 'messages': ['5', '7']}, ('+','id')), ['5', '8']) def testFilteringTransitiveMultilinkSort(self): # Note that we don't test filter_iter here, Multilink sort-order # isn't defined for that. ae, iiter = self.filteringSetupTransitiveSearch() for filt in iiter(): if filt.__name__ != 'filter': continue ae(filt(None, {}, [('+','messages.author')]), ['1', '2', '3', '4', '5', '8', '6', '7']) ae(filt(None, {}, [('-','messages.author')]), ['8', '6', '7', '5', '4', '3', '1', '2']) ae(filt(None, {}, [('+','messages.date')]), ['6', '7', '8', '5', '4', '3', '1', '2']) ae(filt(None, {}, [('-','messages.date')]), ['1', '2', '3', '4', '8', '5', '6', '7']) ae(filt(None, {}, [('+','messages.author'),('+','messages.date')]), ['1', '2', '3', '4', '5', '8', '6', '7']) ae(filt(None, {}, [('-','messages.author'),('+','messages.date')]), ['8', '6', '7', '5', '4', '3', '1', '2']) ae(filt(None, {}, [('+','messages.author'),('-','messages.date')]), ['1', '2', '3', '4', '5', '8', '6', '7']) ae(filt(None, {}, [('-','messages.author'),('-','messages.date')]), ['8', '6', '7', '5', '4', '3', '1', '2']) ae(filt(None, {}, [('+','messages.author'),('+','assignedto')]), ['1', '2', '3', '4', '5', '8', '6', '7']) ae(filt(None, {}, [('+','messages.author'), ('-','assignedto.supervisor'),('-','assignedto')]), ['1', '2', '3', '4', '5', '8', '6', '7']) ae(filt(None, {}, [('+','messages.author.supervisor.supervisor.supervisor'), ('+','messages.author.supervisor.supervisor'), ('+','messages.author.supervisor'), ('+','messages.author')]), ['1', '2', '3', '4', '5', '6', '7', '8']) self.db.user.setorderprop('age') self.db.msg.setorderprop('date') for filt in iiter(): if filt.__name__ != 'filter': continue ae(filt(None, {}, [('+','messages'), ('+','messages.author')]), ['6', '7', '8', '5', '4', '3', '1', '2']) ae(filt(None, {}, [('+','messages.author'), ('+','messages')]), ['6', '7', '8', '5', '4', '3', '1', '2']) self.db.msg.setorderprop('author') for filt in iiter(): if filt.__name__ != 'filter': continue # Orderprop is a Link/Multilink: # messages are sorted by orderprop().labelprop(), i.e. by # author.username, *not* by author.orderprop() (author.age)! ae(filt(None, {}, [('+','messages')]), ['1', '2', '3', '4', '5', '8', '6', '7']) ae(filt(None, {}, [('+','messages.author'), ('+','messages')]), ['6', '7', '8', '5', '4', '3', '1', '2']) # The following will sort by # author.supervisor.username and then by # author.username # I've resited the tempation to implement recursive orderprop # here: There could even be loops if several classes specify a # Link or Multilink as the orderprop... # msg: 4: worker1 (id 5) : grouplead1 (id 4) ceo (id 3) # msg: 5: worker2 (id 7) : grouplead1 (id 4) ceo (id 3) # msg: 6: worker3 (id 8) : grouplead2 (id 5) ceo (id 3) # msg: 7: worker4 (id 9) : grouplead2 (id 5) ceo (id 3) # msg: 8: worker5 (id 10) : grouplead2 (id 5) ceo (id 3) # issue 1: messages 4 sortkey:[[grouplead1], [worker1], 1] # issue 2: messages 4 sortkey:[[grouplead1], [worker1], 2] # issue 3: messages 5 sortkey:[[grouplead1], [worker2], 3] # issue 4: messages 6 sortkey:[[grouplead2], [worker3], 4] # issue 5: messages 7 sortkey:[[grouplead2], [worker4], 5] # issue 6: messages 8 sortkey:[[grouplead2], [worker5], 6] # issue 7: messages 8 sortkey:[[grouplead2], [worker5], 7] # issue 8: messages 7,8 sortkey:[[grouplead2, grouplead2], ...] self.db.user.setorderprop('supervisor') for filt in iiter(): if filt.__name__ != 'filter': continue ae(filt(None, {}, [('+','messages.author'), ('-','messages')]), ['3', '1', '2', '6', '7', '5', '4', '8']) def testFilteringSortId(self): ae, iiter = self.filteringSetupTransitiveSearch('user') for filt in iiter(): ae(filt(None, {}, ('+','id')), ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10']) def testFilteringRetiredString(self): ae, iiter = self.filteringSetup() self.db.issue.retire('1') self.db.commit() r = { None: (['1'], ['1'], ['1'], ['1', '2', '3'], []) , True: (['1'], ['1'], ['1'], ['1'], []) , False: ([], [], [], ['2', '3'], []) } for filt in iiter(): for retire in True, False, None: ae(filt(None, {'title': ['one']}, ('+','id'), retired=retire), r[retire][0]) ae(filt(None, {'title': ['issue one']}, ('+','id'), retired=retire), r[retire][1]) ae(filt(None, {'title': ['issue', 'one']}, ('+','id'), retired=retire), r[retire][2]) ae(filt(None, {'title': ['issue']}, ('+','id'), retired=retire), r[retire][3]) ae(filt(None, {'title': ['one', 'two']}, ('+','id'), retired=retire), r[retire][4]) def setupQuery(self): self.filteringSetup() self.db.user.set('3', roles='User') self.db.user.set('4', roles='User') self.db.user.set('5', roles='User') self.db.commit() self.db.close() self.open_database('bleep') setupSchema(self.db, 0, self.module) cls = self.module.Class query = cls(self.db, "query", klass=String(), name=String(), private_for=Link("user")) self.db.post_init() # Allow searching query sec = self.db.security p = sec.addPermission(name='Search', klass='query') sec.addPermissionToRole('User', p) # Queries user3 default = dict(klass='issue', private_for='3') self.db.query.create(name='c5', **default) self.db.query.create(name='c4', **default) self.db.query.create(name='b4', **default) self.db.query.create(name='b3', **default) # public queries d = dict(default,private_for=None) self.db.query.create(name='a1', **d) self.db.query.create(name='a2', **d) # Queries user5 d = dict(default,private_for='5') self.db.query.create(name='other_user1', **d) self.db.query.create(name='other_user2', **d) def view_query(db, userid, itemid): q = db.query.getnode(itemid) if q.private_for is None: return True if q.private_for == userid: return True return False return view_query def testFilteringWithoutPermissionCheck(self): view_query = self.setupQuery() filt = self.db.query.filter r = filt(None, {}, sort=[('+', 'name')]) # Gets all queries self.assertEqual(r, ['5', '6', '4', '3', '2', '1', '7', '8']) def testFilteringWithPermissionNoFilterFunction(self): view_query = self.setupQuery() perm = self.db.security.addPermission p = perm(name='View', klass='query', check=view_query) self.db.security.addPermissionToRole("User", p) filt = self.db.query.filter_with_permissions r = filt(None, {}, sort=[('+', 'name')]) # User may see own and public queries self.assertEqual(r, ['5', '6', '4', '3', '2', '1']) def testFilteringWithPermissionFilterFunction(self): view_query = self.setupQuery() def filter(db, userid, klass): return [dict(filterspec = dict(private_for=['-1', userid]))] perm = self.db.security.addPermission p = perm(name='View', klass='query', check=view_query, filter=filter) self.db.security.addPermissionToRole("User", p) filt = self.db.query.filter_with_permissions r = filt(None, {}, sort=[('+', 'name')]) # User may see own and public queries self.assertEqual(r, ['5', '6', '4', '3', '2', '1']) def testFilteringWithPermissionFilterFunctionOff(self): view_query = self.setupQuery() def filter(db, userid, klass): return [dict(filterspec = dict(private_for=['-1', userid]))] perm = self.db.security.addPermission p = perm(name='View', klass='query', check=view_query, filter=filter) self.db.security.addPermissionToRole("User", p) # Turn filtering off self.db.config.RDBMS_DEBUG_FILTER = True filt = self.db.query.filter_with_permissions r = filt(None, {}, sort=[('+', 'name')]) # User may see own and public queries self.assertEqual(r, ['5', '6', '4', '3', '2', '1']) def testFilteringWithManufacturedCheckFunction(self): # We define a permission with a filter function but no check # function. The check function is manufactured automatically. # Then we test the manufactured *check* function only by turning # off the filter function. view_query = self.setupQuery() def filter(db, userid, klass): return [dict(filterspec = dict(private_for=['-1', userid]))] perm = self.db.security.addPermission p = perm(name='View', klass='query', filter=filter) self.db.security.addPermissionToRole("User", p) # Turn filtering off self.db.config.RDBMS_DEBUG_FILTER = True filt = self.db.query.filter_with_permissions r = filt(None, {}, sort=[('+', 'name')]) # User may see own and public queries self.assertEqual(r, ['5', '6', '4', '3', '2', '1']) # XXX add sorting tests for other types # nuke and re-create db for restore def nukeAndCreate(self): # shut down this db and nuke it self.db.close() self.nuke_database() # open a new, empty database os.makedirs(config.DATABASE + '/files') self.db = self.module.Database(config, 'admin') setupSchema(self.db, 0, self.module) def testImportExport(self): # use the filtering setup to create a bunch of items ae, dummy = self.filteringSetup() # Get some stuff into the journal for testing import/export of # journal data: self.db.user.set('4', password = password.Password('xyzzy')) self.db.user.set('4', age = 3) self.db.user.set('4', assignable = True) self.db.issue.set('1', title = 'i1', status = '3') self.db.issue.set('1', deadline = date.Date('2007')) self.db.issue.set('1', foo = date.Interval('1:20')) p = self.db.priority.create(name = 'some_prio_without_order') self.db.commit() self.db.user.set('4', password = password.Password('123xyzzy')) self.db.user.set('4', assignable = False) self.db.priority.set(p, order = '4711') self.db.commit() self.db.user.retire('3') self.db.issue.retire('2') # Key fields must be unique. There can only be one unretired # object with a given key value. When importing verify that # having the unretired object with a key value before a retired # object with the same key value is handled properly. # Since the order of the exported objects is not consistant # across backends, we sort the objects by id (as an int) and # make sure that the active (non-retired) entry sorts before # the retired entry. active_dupe_id = self.db.user.create(username="duplicate", roles='User', password=password.Password('sekrit'), address='dupe1@example.com') self.db.user.retire(active_dupe_id) # allow us to create second dupe retired_dupe_id = self.db.user.create(username="duplicate", roles='User', password=password.Password('sekrit'), address='dupe2@example.com') self.db.user.retire(retired_dupe_id) self.db.user.restore(active_dupe_id) # unretire lower numbered id self.db.commit() # grab snapshot of the current database orig = {} origj = {} for cn,klass in self.db.classes.items(): cl = orig[cn] = {} jn = origj[cn] = {} for id in klass.list(): it = cl[id] = {} jn[id] = self.db.getjournal(cn, id) for name in klass.getprops().keys(): it[name] = klass.get(id, name) os.mkdir('_test_export') try: # grab the export export = {} journals = {} active_dupe_id_first = -1 # -1 unknown, False or True for cn,klass in self.db.classes.items(): names = klass.export_propnames() cl = export[cn] = [names+['is retired']] classname = klass.classname nodeids = klass.getnodeids() # sort to enforce retired/unretired order nodeids.sort(key=int) for id in nodeids: if (classname == 'user' and id == retired_dupe_id and active_dupe_id_first == -1): active_dupe_id_first = False if (classname == 'user' and id == active_dupe_id and active_dupe_id_first == -1): active_dupe_id_first = True cl.append(klass.export_list(names, id)) if hasattr(klass, 'export_files'): klass.export_files('_test_export', id) journals[cn] = klass.export_journals() self.nukeAndCreate() if not active_dupe_id_first: # verify that the test is configured properly to # trigger the exception code to handle uniqueness # failure. self.fail("Setup failure: active user id not first.") # import with self._caplog.at_level(logging.INFO, logger="roundup.hyperdb.backend"): # not supported in python2, so use caplog rather than len(log) # X in log[0] ... # with self.assertLogs('roundup.hyperdb.backend', # level="INFO") as log: for cn, items in export.items(): klass = self.db.classes[cn] names = items[0] maxid = 1 for itemprops in items[1:]: id = int(klass.import_list(names, itemprops)) if hasattr(klass, 'import_files'): klass.import_files('_test_export', str(id)) maxid = max(maxid, id) self.db.setid(cn, str(maxid+1)) klass.import_journals(journals[cn]) if self.db.dbtype not in ['anydbm', 'memorydb']: # no logs or fixup needed under anydbm # postgres requires commits and rollbacks # as part of error recovery, so we get commit # logging that we need to account for log = [] if self.db.dbtype == 'postgres': # remove commit and rollback log messages # so the indexes below work correctly. for i in range(0,len(self._caplog.record_tuples)): if self._caplog.record_tuples[i][2] not in \ ["commit", "rollback"]: log.append(self._caplog.record_tuples[i]) else: log = self._caplog.record_tuples[:] log_count=2 handle_msg_location=0 success_msg_location = handle_msg_location+1 self.assertEqual(log_count, len(log)) self.assertIn('Attempting to handle import exception for id 7:', log[handle_msg_location][2]) self.assertIn('Successfully handled import exception for id 7 ' 'which conflicted with 6', log[success_msg_location][2]) # This is needed, otherwise journals won't be there for anydbm self.db.commit() self.assertEqual(self.db.user.lookup("duplicate"), active_dupe_id) self.assertEqual(self.db.user.is_retired(retired_dupe_id), True) finally: shutil.rmtree('_test_export') # compare with snapshot of the database for cn, items in orig.items(): klass = self.db.classes[cn] propdefs = klass.getprops(1) # ensure retired items are retired :) l = sorted(items.keys()) m = klass.list(); m.sort() ae(l, m, '%s id list wrong %r vs. %r'%(cn, l, m)) for id, props in items.items(): for name, value in props.items(): l = klass.get(id, name) if isinstance(value, type([])): value.sort() l.sort() try: ae(l, value) except AssertionError: if not isinstance(propdefs[name], Date): raise # don't get hung up on rounding errors assert not l.__cmp__(value, int_seconds=1) for jc, items in origj.items(): for id, oj in items.items(): rj = self.db.getjournal(jc, id) # Both mysql and postgresql have some minor issues with # rounded seconds on export/import, so we compare only # the integer part. for j in oj: j[1].second = float(int(j[1].second)) for j in rj: j[1].second = float(int(j[1].second)) oj.sort(key = NoneAndDictComparable) rj.sort(key = NoneAndDictComparable) ae(oj, rj) # make sure the retired items are actually imported ae(self.db.user.get('4', 'username'), 'blop') ae(self.db.issue.get('2', 'title'), 'issue two') # make sure id counters are set correctly maxid = max([int(id) for id in self.db.user.list()]) newid = int(self.db.user.create(username='testing')) self.assertGreater(newid, maxid) # test import/export via admin interface def testAdminImportExport(self): import roundup.admin import csv # use the filtering setup to create a bunch of items ae, dummy = self.filteringSetup() # create large field self.db.priority.create(name = 'X' * 500) self.db.config.CSV_FIELD_SIZE = 400 self.db.commit() output = [] # ugly hack to get stderr output and disable stdout output # during regression test. Depends on roundup.admin not using # anything but stdout/stderr from sys (which is currently the # case) def stderrwrite(s): output.append(s) roundup.admin.sys = MockNull () try: roundup.admin.sys.stderr.write = stderrwrite tool = roundup.admin.AdminTool() home = '.' tool.tracker_home = home tool.db = self.db tool.verbose = False tool.do_export (['_test_export']) self.assertEqual(len(output), 2) self.assertEqual(output [1], '\n') self.assertTrue(output [0].startswith ('Warning: config csv_field_size should be at least')) self.assertTrue(int(output[0].split()[-1]) > 500) if hasattr(roundup.admin.csv, 'field_size_limit'): self.nukeAndCreate() self.db.config.CSV_FIELD_SIZE = 400 tool = roundup.admin.AdminTool() tool.tracker_home = home tool.db = self.db tool.verbose = False self.assertRaises(csv.Error, tool.do_import, ['_test_export']) self.nukeAndCreate() # make sure we have an empty db with self.assertRaises(IndexError) as e: # users 1 and 2 always are created on schema load. # so don't use them. self.db.user.getnode("5").values() self.db.config.CSV_FIELD_SIZE = 3200 tool = roundup.admin.AdminTool() tool.tracker_home = home tool.db = self.db # Force import code to commit when more than 5 # savepoints have been created. tool.settings['savepoint_limit'] = 5 tool.verbose = False tool.do_import(['_test_export']) # verify the data is loaded. self.db.user.getnode("5").values() finally: roundup.admin.sys = sys shutil.rmtree('_test_export') # test props from args parsing def testAdminOtherCommands(self): import roundup.admin # use the filtering setup to create a bunch of items ae, dummy = self.filteringSetup() # create large field self.db.priority.create(name = 'X' * 500) self.db.config.CSV_FIELD_SIZE = 400 self.db.commit() eoutput = [] # stderr output soutput = [] # stdout output def stderrwrite(s): eoutput.append(s) def stdoutwrite(s): soutput.append(s) roundup.admin.sys = MockNull () try: roundup.admin.sys.stderr.write = stderrwrite roundup.admin.sys.stdout.write = stdoutwrite tool = roundup.admin.AdminTool() home = '.' tool.tracker_home = home tool.db = self.db tool.verbose = False tool.separator = "\n" tool.print_designator = True # test props_from_args self.assertRaises(UsageError, tool.props_from_args, "fullname") # invalid propname self.assertEqual(tool.props_from_args("="), {'': None}) # not sure this desired, I'd expect UsageError props = tool.props_from_args(["fullname=robert", "friends=+rouilj,+other", "key="]) self.assertEqual(props, {'fullname': 'robert', 'friends': '+rouilj,+other', 'key': None}) # test get_class() self.assertRaises(UsageError, tool.get_class, "bar") # invalid class # This writes to stdout, need to figure out how to redirect to a variable. # classhandle = tool.get_class("user") # valid class # FIXME there should be some test here issue_class_spec = tool.do_specification(["issue"]) self.assertEqual(sorted (soutput), ['assignedto: \n', 'deadline: \n', 'feedback: \n', 'files: \n', 'foo: \n', 'keywords2: \n', 'keywords: \n', 'messages: \n', 'nosy: \n', 'priority: \n', 'spam: \n', 'status: \n', 'superseder: \n', 'title: \n']) #userclassprop=tool.do_list(["mls"]) #tool.print_designator = False #userclassprop=tool.do_get(["realname","user1"]) # test do_create soutput[:] = [] # empty for next round of output userclass=tool.do_create(["issue", "title='title1 title'", "nosy=1,3"]) # should be issue 5 userclass=tool.do_create(["issue", "title='title2 title'", "nosy=2,3"]) # should be issue 6 self.assertEqual(soutput, ['5\n', '6\n']) # verify nosy setting props=self.db.issue.get('5', "nosy") self.assertEqual(props, ['1','3']) # test do_set using newly created issues # remove user 3 from issues # verifies issue2550572 userclass=tool.do_set(["issue5,issue6", "nosy=-3"]) # verify proper result props=self.db.issue.get('5', "nosy") self.assertEqual(props, ['1']) props=self.db.issue.get('6', "nosy") self.assertEqual(props, ['2']) # basic usage test. TODO add full output verification soutput[:] = [] # empty for next round of output tool.usage(message="Hello World") self.assertTrue(soutput[0].startswith('Problem: Hello World'), None) # check security output soutput[:] = [] # empty for next round of output tool.do_security("Admin") expected = [ 'New Web users get the Role "User"\n', 'New Email users get the Role "User"\n', 'Role "admin":\n', ' User may create everything (Create)\n', ' User may edit everything (Edit)\n', ' User may use the email interface (Email Access)\n', ' User may access the rest interface (Rest Access)\n', ' User may restore everything (Restore)\n', ' User may retire everything (Retire)\n', ' User may view everything (View)\n', ' User may access the web interface (Web Access)\n', ' User may manipulate user Roles through the web (Web Roles)\n', ' User may access the xmlrpc interface (Xmlrpc Access)\n', 'Role "anonymous":\n', 'Role "user":\n', ' User is allowed to access msg (View for "msg" only)\n', ' Prevent users from seeing roles (View for "user": [\'username\', \'supervisor\', \'assignable\'] only)\n'] self.assertEqual(soutput, expected) self.nukeAndCreate() tool = roundup.admin.AdminTool() tool.tracker_home = home tool.db = self.db tool.verbose = False finally: roundup.admin.sys = sys # test duplicate relative tracker home initialisation (issue2550757) def testAdminDuplicateInitialisation(self): import roundup.admin output = [] def stderrwrite(s): output.append(s) roundup.admin.sys = MockNull () t = '_test_initialise' try: roundup.admin.sys.stderr.write = stderrwrite tool = roundup.admin.AdminTool() tool.force = True args = (None, 'classic', 'anydbm', 'MAIL_DOMAIN=%s' % config.MAIL_DOMAIN) tool.do_install(t, args=args) args = (None, 'mypasswd') tool.do_initialise(t, args=args) tool.do_initialise(t, args=args) try: # python >=2.7 self.assertNotIn(t, os.listdir(t)) except AttributeError: self.assertFalse('db' in os.listdir(t)) finally: roundup.admin.sys = sys if os.path.exists(t): shutil.rmtree(t) def testAddProperty(self): self.db.issue.create(title="spam", status='1') self.db.commit() self.db.issue.addprop(fixer=Link("user")) # force any post-init stuff to happen self.db.post_init() props = self.db.issue.getprops() keys = sorted(props.keys()) self.assertEqual(keys, ['activity', 'actor', 'assignedto', 'creation', 'creator', 'deadline', 'feedback', 'files', 'fixer', 'foo', 'id', 'keywords', 'keywords2', 'messages', 'nosy', 'priority', 'spam', 'status', 'superseder', 'title']) self.assertEqual(self.db.issue.get('1', "fixer"), None) def testRemoveProperty(self): self.db.issue.create(title="spam", status='1') self.db.commit() del self.db.issue.properties['title'] self.db.post_init() props = self.db.issue.getprops() keys = sorted(props.keys()) self.assertEqual(keys, ['activity', 'actor', 'assignedto', 'creation', 'creator', 'deadline', 'feedback', 'files', 'foo', 'id', 'keywords', 'keywords2', 'messages', 'nosy', 'priority', 'spam', 'status', 'superseder']) self.assertEqual(self.db.issue.list(), ['1']) def testAddRemoveProperty(self): self.db.issue.create(title="spam", status='1') self.db.commit() self.db.issue.addprop(fixer=Link("user")) del self.db.issue.properties['title'] self.db.post_init() props = self.db.issue.getprops() keys = sorted(props.keys()) self.assertEqual(keys, ['activity', 'actor', 'assignedto', 'creation', 'creator', 'deadline', 'feedback', 'files', 'fixer', 'foo', 'id', 'keywords', 'keywords2', 'messages', 'nosy', 'priority', 'spam', 'status', 'superseder']) self.assertEqual(self.db.issue.list(), ['1']) def testNosyMail(self) : """Creates one issue with two attachments, one smaller and one larger than the set max_attachment_size. """ old_translate_ = roundupdb._ roundupdb._ = i18n.get_translation(language='C').gettext db = self.db db.config.NOSY_MAX_ATTACHMENT_SIZE = 4096 res = dict(mail_to = None, mail_msg = None) def dummy_snd(s, to, msg, res=res) : res["mail_to"], res["mail_msg"] = to, msg backup, Mailer.smtp_send = Mailer.smtp_send, dummy_snd try : f1 = db.file.create(name="test1.txt", content="x" * 20, type="application/octet-stream") f2 = db.file.create(name="test2.txt", content="y" * 5000, type="application/octet-stream") m = db.msg.create(content="one two", author="admin", files = [f1, f2]) i = db.issue.create(title='spam', files = [f1, f2], messages = [m], nosy = [db.user.lookup("fred")]) db.issue.nosymessage(i, m, {}) mail_msg = str(res["mail_msg"]) self.assertEqual(res["mail_to"], ["fred@example.com"]) self.assertTrue("From: admin" in mail_msg) self.assertTrue("Subject: [issue1] spam" in mail_msg) self.assertTrue("New submission from admin" in mail_msg) self.assertTrue("one two" in mail_msg) self.assertTrue("File 'test1.txt' not attached" not in mail_msg) self.assertTrue(b2s(base64_encode(s2b("xxx"))).rstrip() in mail_msg) self.assertTrue("File 'test2.txt' not attached" in mail_msg) self.assertTrue(b2s(base64_encode(s2b("yyy"))).rstrip() not in mail_msg) finally : roundupdb._ = old_translate_ Mailer.smtp_send = backup def testNosyMailTextAndBinary(self) : """Creates one issue with two attachments, one as text and one as binary. """ old_translate_ = roundupdb._ roundupdb._ = i18n.get_translation(language='C').gettext db = self.db res = dict(mail_to = None, mail_msg = None) def dummy_snd(s, to, msg, res=res) : res["mail_to"], res["mail_msg"] = to, msg backup, Mailer.smtp_send = Mailer.smtp_send, dummy_snd try : f1 = db.file.create(name="test1.txt", content="Hello world", type="text/plain") f2 = db.file.create(name="test2.bin", content=b"\x01\x02\x03\xfe\xff", type="application/octet-stream") m = db.msg.create(content="one two", author="admin", files = [f1, f2]) i = db.issue.create(title='spam', files = [f1, f2], messages = [m], nosy = [db.user.lookup("fred")]) db.issue.nosymessage(i, m, {}) mail_msg = str(res["mail_msg"]) self.assertEqual(res["mail_to"], ["fred@example.com"]) self.assertTrue("From: admin" in mail_msg) self.assertTrue("Subject: [issue1] spam" in mail_msg) self.assertTrue("New submission from admin" in mail_msg) self.assertTrue("one two" in mail_msg) self.assertTrue("Hello world" in mail_msg) self.assertTrue(b2s(base64_encode(b"\x01\x02\x03\xfe\xff")).rstrip() in mail_msg) finally : roundupdb._ = old_translate_ Mailer.smtp_send = backup @pytest.mark.skipif(gpgmelib.gpg is None, reason='Skipping PGPNosy test') def testPGPNosyMail(self) : """Creates one issue with two attachments, one smaller and one larger than the set max_attachment_size. Recipients are one with and one without encryption enabled via a gpg group. """ old_translate_ = roundupdb._ roundupdb._ = i18n.get_translation(language='C').gettext db = self.db db.config.NOSY_MAX_ATTACHMENT_SIZE = 4096 db.config['PGP_HOMEDIR'] = gpgmelib.pgphome db.config['PGP_ROLES'] = 'pgp' db.config['PGP_ENABLE'] = True db.config['PGP_ENCRYPT'] = True gpgmelib.setUpPGP() res = [] def dummy_snd(s, to, msg, res=res) : res.append (dict (mail_to = to, mail_msg = msg)) backup, Mailer.smtp_send = Mailer.smtp_send, dummy_snd try : john = db.user.create(username="john", roles='User,pgp', address='john@test.test', realname='John Doe') f1 = db.file.create(name="test1.txt", content="x" * 20, type="application/octet-stream") f2 = db.file.create(name="test2.txt", content="y" * 5000, type="application/octet-stream") m = db.msg.create(content="one two", author="admin", files = [f1, f2]) i = db.issue.create(title='spam', files = [f1, f2], messages = [m], nosy = [db.user.lookup("fred"), john]) db.issue.nosymessage(i, m, {}) res.sort(key=lambda x: x['mail_to']) self.assertEqual(res[0]["mail_to"], ["fred@example.com"]) self.assertEqual(res[1]["mail_to"], ["john@test.test"]) mail_msg = str(res[0]["mail_msg"]) self.assertTrue("From: admin" in mail_msg) self.assertTrue("Subject: [issue1] spam" in mail_msg) self.assertTrue("New submission from admin" in mail_msg) self.assertTrue("one two" in mail_msg) self.assertTrue("File 'test1.txt' not attached" not in mail_msg) self.assertTrue(b2s(base64_encode(s2b("xxx"))).rstrip() in mail_msg) self.assertTrue("File 'test2.txt' not attached" in mail_msg) self.assertTrue(b2s(base64_encode(s2b("yyy"))).rstrip() not in mail_msg) mail_msg = str(res[1]["mail_msg"]) parts = message_from_string(mail_msg).get_payload() self.assertEqual(len(parts),2) self.assertEqual(parts[0].get_payload().strip(), 'Version: 1') crypt = gpgmelib.gpg.core.Data(parts[1].get_payload()) plain = gpgmelib.gpg.core.Data() ctx = gpgmelib.gpg.core.Context() res = ctx.op_decrypt(crypt, plain) self.assertEqual(res, None) plain.seek(0,0) self.assertTrue("From: admin" in mail_msg) self.assertTrue("Subject: [issue1] spam" in mail_msg) mail_msg = str(message_from_bytes(plain.read())) self.assertTrue("New submission from admin" in mail_msg) self.assertTrue("one two" in mail_msg) self.assertTrue("File 'test1.txt' not attached" not in mail_msg) self.assertTrue(b2s(base64_encode(s2b("xxx"))).rstrip() in mail_msg) self.assertTrue("File 'test2.txt' not attached" in mail_msg) self.assertTrue(b2s(base64_encode(s2b("yyy"))).rstrip() not in mail_msg) finally : roundupdb._ = old_translate_ Mailer.smtp_send = backup gpgmelib.tearDownPGP() class ROTest(MyTestCase): def setUp(self): # remove previous test, ignore errors if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) os.makedirs(config.DATABASE + '/files') self.db = self.module.Database(config, 'admin') setupSchema(self.db, 1, self.module) self.db.close() self.db = self.module.Database(config) setupSchema(self.db, 0, self.module) def testExceptions(self): # this tests the exceptions that should be raised ar = self.assertRaises # this tests the exceptions that should be raised ar(DatabaseError, self.db.status.create, name="foo") ar(DatabaseError, self.db.status.set, '1', name="foo") ar(DatabaseError, self.db.status.retire, '1') class SchemaTest(MyTestCase): def setUp(self): # remove previous test, ignore errors if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) os.makedirs(config.DATABASE + '/files') def test_reservedProperties(self): self.open_database() self.assertRaises(ValueError, self.module.Class, self.db, "a", creation=String()) self.assertRaises(ValueError, self.module.Class, self.db, "a", activity=String()) self.assertRaises(ValueError, self.module.Class, self.db, "a", creator=String()) self.assertRaises(ValueError, self.module.Class, self.db, "a", actor=String()) def init_a(self): self.open_database() a = self.module.Class(self.db, "a", name=String()) a.setkey("name") self.db.post_init() def test_fileClassProps(self): self.open_database() a = self.module.FileClass(self.db, 'a') l = sorted(a.getprops().keys()) self.assertTrue(l, ['activity', 'actor', 'content', 'created', 'creation', 'type']) def init_ab(self): self.open_database() a = self.module.Class(self.db, "a", name=String()) a.setkey("name") b = self.module.Class(self.db, "b", name=String(), fooz=Multilink('a')) b.setkey("name") self.db.post_init() def test_splitDesignator(self): from roundup.hyperdb import splitDesignator, DesignatorError self.open_database() # allow setup/shutdown to work to postgres/mysql valid_test_cases = [('zip2py44', ('zip2py', '44')), ('zippy2', ('zippy', '2')), ('a9', ('a', '9')), ('a1234', ('a', '1234')), ('a_1234', ('a_', '1234')), ] invalid_test_cases = ['_zip2py44','1zippy44', 'zippy244a' ] for designator in valid_test_cases: print("Testing %s"%designator[0]) self.assertEqual(splitDesignator(designator[0]), designator[1]) for designator in invalid_test_cases: print("Testing %s"%designator) with self.assertRaises(DesignatorError) as ctx: splitDesignator(designator) error = '"%s" not a node designator' % designator self.assertEqual(str(ctx.exception), error) def test_addNewClass(self): self.init_a() with self.assertRaises(ValueError) as ctx: self.module.Class(self.db, "a", name=String()) error = 'Class "a" already defined.' self.assertEqual(str(ctx.exception), error) aid = self.db.a.create(name='apple') self.db.commit(); self.db.close() # Test permutations of valid/invalid classnames self.init_a() for classname in [ "1badclassname", "badclassname1", "_badclassname", "_", "5" ]: print("testing %s\n" % classname) with self.assertRaises(ValueError) as ctx: self.module.Class(self.db, classname, name=String()) error = ('Class name %s is not valid. It must start ' 'with a letter, end with a letter or "_", and ' 'only have alphanumerics and "_" in the middle.' % (classname,)) self.assertEqual(str(ctx.exception), error) for classname in [ 'cla2ss', 'c_lass', 'CL_2ass', 'Z', 'class2_' ]: print("testing %s\n" % classname) c = self.module.Class(self.db, classname, name=String()) self.assertEqual(str(c), '' % classname) # don't pollute the db with junk valid cases # self.db.commit(); close to discard all changes in this block. self.db.close() # add a new class to the schema and check creation of new items # (and existence of old ones) self.init_ab() bid = self.db.b.create(name='bear', fooz=[aid]) self.assertEqual(self.db.a.get(aid, 'name'), 'apple') self.db.commit() self.db.close() # now check we can recall the added class' items self.init_ab() self.assertEqual(self.db.a.get(aid, 'name'), 'apple') self.assertEqual(self.db.a.lookup('apple'), aid) self.assertEqual(self.db.b.get(bid, 'name'), 'bear') self.assertEqual(self.db.b.get(bid, 'fooz'), [aid]) self.assertEqual(self.db.b.lookup('bear'), bid) # confirm journal's ok self.db.getjournal('a', aid) self.db.getjournal('b', bid) def init_amod(self): self.open_database() a = self.module.Class(self.db, "a", name=String(), newstr=String(), newint=Interval(), newnum=Number(), newbool=Boolean(), newdate=Date()) a.setkey("name") b = self.module.Class(self.db, "b", name=String()) b.setkey("name") self.db.post_init() def test_modifyClass(self): self.init_ab() # add item to user and issue class aid = self.db.a.create(name='apple') bid = self.db.b.create(name='bear') self.db.commit(); self.db.close() # modify "a" schema self.init_amod() self.assertEqual(self.db.a.get(aid, 'name'), 'apple') self.assertEqual(self.db.a.get(aid, 'newstr'), None) self.assertEqual(self.db.a.get(aid, 'newint'), None) # hack - metakit can't return None for missing values, and we're not # really checking for that behavior here anyway self.assertTrue(not self.db.a.get(aid, 'newnum')) self.assertTrue(not self.db.a.get(aid, 'newbool')) self.assertEqual(self.db.a.get(aid, 'newdate'), None) self.assertEqual(self.db.b.get(aid, 'name'), 'bear') aid2 = self.db.a.create(name='aardvark', newstr='booz') self.db.commit(); self.db.close() # test self.init_amod() self.assertEqual(self.db.a.get(aid, 'name'), 'apple') self.assertEqual(self.db.a.get(aid, 'newstr'), None) self.assertEqual(self.db.b.get(aid, 'name'), 'bear') self.assertEqual(self.db.a.get(aid2, 'name'), 'aardvark') self.assertEqual(self.db.a.get(aid2, 'newstr'), 'booz') # confirm journal's ok self.db.getjournal('a', aid) self.db.getjournal('a', aid2) def init_amodkey(self): self.open_database() a = self.module.Class(self.db, "a", name=String(), newstr=String()) a.setkey("newstr") b = self.module.Class(self.db, "b", name=String()) b.setkey("name") self.db.post_init() def test_changeClassKey(self): self.init_amod() aid = self.db.a.create(name='apple') self.assertEqual(self.db.a.lookup('apple'), aid) self.db.commit(); self.db.close() # change the key to newstr on a self.init_amodkey() self.assertEqual(self.db.a.get(aid, 'name'), 'apple') self.assertEqual(self.db.a.get(aid, 'newstr'), None) self.assertRaises(KeyError, self.db.a.lookup, 'apple') aid2 = self.db.a.create(name='aardvark', newstr='booz') self.db.commit(); self.db.close() # check self.init_amodkey() self.assertEqual(self.db.a.lookup('booz'), aid2) # confirm journal's ok self.db.getjournal('a', aid) def test_removeClassKey(self): self.init_amod() aid = self.db.a.create(name='apple') self.assertEqual(self.db.a.lookup('apple'), aid) self.db.commit(); self.db.close() self.db = self.module.Database(config, 'admin') a = self.module.Class(self.db, "a", name=String(), newstr=String()) self.db.post_init() aid2 = self.db.a.create(name='apple', newstr='booz') self.db.commit() def init_amodml(self): self.open_database() a = self.module.Class(self.db, "a", name=String(), newml=Multilink('a')) a.setkey('name') self.db.post_init() def test_makeNewMultilink(self): self.init_a() aid = self.db.a.create(name='apple') self.assertEqual(self.db.a.lookup('apple'), aid) self.db.commit(); self.db.close() # add a multilink prop self.init_amodml() bid = self.db.a.create(name='bear', newml=[aid]) self.assertEqual(self.db.a.find(newml=aid), [bid]) self.assertEqual(self.db.a.lookup('apple'), aid) self.db.commit(); self.db.close() # check self.init_amodml() self.assertEqual(self.db.a.find(newml=aid), [bid]) self.assertEqual(self.db.a.lookup('apple'), aid) self.assertEqual(self.db.a.lookup('bear'), bid) # confirm journal's ok self.db.getjournal('a', aid) self.db.getjournal('a', bid) def test_removeMultilink(self): # add a multilink prop self.init_amodml() aid = self.db.a.create(name='apple') bid = self.db.a.create(name='bear', newml=[aid]) self.assertEqual(self.db.a.find(newml=aid), [bid]) self.assertEqual(self.db.a.lookup('apple'), aid) self.assertEqual(self.db.a.lookup('bear'), bid) self.db.commit(); self.db.close() # remove the multilink self.init_a() self.assertEqual(self.db.a.lookup('apple'), aid) self.assertEqual(self.db.a.lookup('bear'), bid) # confirm journal's ok self.db.getjournal('a', aid) self.db.getjournal('a', bid) def test_removeClass(self): self.init_ab() aid = self.db.a.create(name='apple') bid = self.db.b.create(name='bear') self.db.commit(); self.db.close() # drop the b class self.init_a() self.assertEqual(self.db.a.get(aid, 'name'), 'apple') self.assertEqual(self.db.a.lookup('apple'), aid) self.db.commit(); self.db.close() # now check we can recall the added class' items self.init_a() self.assertEqual(self.db.a.get(aid, 'name'), 'apple') self.assertEqual(self.db.a.lookup('apple'), aid) # confirm journal's ok self.db.getjournal('a', aid) class RDBMSTest: """ tests specific to RDBMS backends """ def test_indexTest(self): self.assertEqual(self.db.sql_index_exists('_issue', '_issue_id_idx'), 1) self.assertEqual(self.db.sql_index_exists('_issue', '_issue_x_idx'), 0) class FilterCacheTest(commonDBTest): def testFilteringTransitiveLinkCache(self): ae, dummy = self.filteringSetupTransitiveSearch() ae, dummy = self.iterSetup('user') # Need to make ceo his own (and first two users') supervisor self.db.user.set('1', supervisor = '3') self.db.user.set('2', supervisor = '3') self.db.user.set('3', supervisor = '3') # test bool value self.db.user.set('4', assignable = True) self.db.user.set('3', assignable = False) filt = self.db.issue.filter_iter ufilt = self.db.user.filter_iter user_result = \ { '1' : {'username': 'admin', 'assignable': None, 'supervisor': '3', 'realname': None, 'roles': 'Admin', 'creator': '1', 'age': None, 'actor': '1', 'address': None} , '2' : {'username': 'fred', 'assignable': None, 'supervisor': '3', 'realname': None, 'roles': 'User', 'creator': '1', 'age': None, 'actor': '1', 'address': 'fred@example.com'} , '3' : {'username': 'ceo', 'assignable': False, 'supervisor': '3', 'realname': None, 'roles': None, 'creator': '1', 'age': 129.0, 'actor': '1', 'address': None} , '4' : {'username': 'grouplead1', 'assignable': True, 'supervisor': '3', 'realname': None, 'roles': None, 'creator': '1', 'age': 29.0, 'actor': '1', 'address': None} , '5' : {'username': 'grouplead2', 'assignable': None, 'supervisor': '3', 'realname': None, 'roles': None, 'creator': '1', 'age': 29.0, 'actor': '1', 'address': None} , '6' : {'username': 'worker1', 'assignable': None, 'supervisor': '4', 'realname': None, 'roles': None, 'creator': '1', 'age': 25.0, 'actor': '1', 'address': None} , '7' : {'username': 'worker2', 'assignable': None, 'supervisor': '4', 'realname': None, 'roles': None, 'creator': '1', 'age': 24.0, 'actor': '1', 'address': None} , '8' : {'username': 'worker3', 'assignable': None, 'supervisor': '5', 'realname': None, 'roles': None, 'creator': '1', 'age': 23.0, 'actor': '1', 'address': None} , '9' : {'username': 'worker4', 'assignable': None, 'supervisor': '5', 'realname': None, 'roles': None, 'creator': '1', 'age': 22.0, 'actor': '1', 'address': None} , '10' : {'username': 'worker5', 'assignable': None, 'supervisor': '5', 'realname': None, 'roles': None, 'creator': '1', 'age': 21.0, 'actor': '1', 'address': None} } foo = date.Interval('-1d') issue_result = \ { '1' : {'title': 'ts1', 'status': '2', 'assignedto': '6', 'priority': '3', 'messages' : ['4'], 'nosy' : ['4']} , '2' : {'title': 'ts2', 'status': '1', 'assignedto': '6', 'priority': '3', 'messages' : ['4'], 'nosy' : ['5']} , '3' : {'title': 'ts4', 'status': '2', 'assignedto': '7', 'priority': '3', 'messages' : ['5']} , '4' : {'title': 'ts5', 'status': '1', 'assignedto': '8', 'priority': '3', 'messages' : ['6']} , '5' : {'title': 'ts6', 'status': '2', 'assignedto': '9', 'priority': '3', 'messages' : ['7']} , '6' : {'title': 'ts7', 'status': '1', 'assignedto': '10', 'priority': '3', 'messages' : ['8'], 'foo' : None} , '7' : {'title': 'ts8', 'status': '2', 'assignedto': '10', 'priority': '3', 'messages' : ['8'], 'foo' : foo} , '8' : {'title': 'ts9', 'status': '1', 'assignedto': '10', 'priority': '3', 'messages' : ['7', '8']} } result = [] self.db.clearCache() for id in ufilt(None, {}, [('+','supervisor.supervisor.supervisor'), ('-','supervisor.supervisor'), ('-','supervisor'), ('+','username')]): result.append(id) nodeid = id # Note in the recent implementation we do not recursively # cache results in filter_iter assert(('user', nodeid) in self.db.cache) n = self.db.user.getnode(nodeid) for k, v in user_result[nodeid].items(): ae((k, n[k]), (k, v)) for k in 'creation', 'activity': assert(n[k]) self.db.clearCache() ae (result, ['8', '9', '10', '6', '7', '1', '3', '2', '4', '5']) result = [] self.db.clearCache() for id in filt(None, {}, [('+','assignedto.supervisor.supervisor.supervisor'), ('+','assignedto.supervisor.supervisor'), ('-','assignedto.supervisor'), ('+','assignedto')]): result.append(id) assert(('issue', id) in self.db.cache) n = self.db.issue.getnode(id) for k, v in issue_result[id].items(): ae((k, n[k]), (k, v)) for k in 'creation', 'activity': assert(n[k]) nodeid = n.assignedto # Note in the recent implementation we do not recursively # cache results in filter_iter n = self.db.user.getnode(nodeid) for k, v in user_result[nodeid].items(): ae((k, n[k]), (k, v)) for k in 'creation', 'activity': assert(n[k]) self.db.clearCache() ae (result, ['4', '5', '6', '7', '8', '1', '2', '3']) class ClassicInitBase(object): count = 0 db = None def setUp(self): ClassicInitBase.count = ClassicInitBase.count + 1 self.dirname = '_test_init_%s'%self.count try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def tearDown(self): if self.db is not None: self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise class ClassicInitTest(ClassicInitBase): def testCreation(self): ae = self.assertEqual # set up and open a tracker tracker = setupTracker(self.dirname, self.backend) # open the database db = self.db = tracker.open('test') # check the basics of the schema and initial data set l = db.priority.list() l.sort() ae(l, ['1', '2', '3', '4', '5']) l = db.status.list() l.sort() ae(l, ['1', '2', '3', '4', '5', '6', '7', '8']) l = db.keyword.list() ae(l, []) l = db.user.list() l.sort() ae(l, ['1', '2']) l = db.msg.list() ae(l, []) l = db.file.list() ae(l, []) l = db.issue.list() ae(l, []) class ConcurrentDBTest(ClassicInitBase): def testConcurrency(self): # The idea here is a read-modify-update cycle in the presence of # a cache that has to be properly handled. The same applies if # we extend a String or otherwise modify something that depends # on the previous value. # set up and open a tracker tracker = setupTracker(self.dirname, self.backend) # open the database self.db = tracker.open('admin') prio = '1' self.assertEqual(self.db.priority.get(prio, 'order'), 1.0) def inc(db): db.priority.set(prio, order=db.priority.get(prio, 'order') + 1) inc(self.db) db2 = tracker.open("admin") self.assertEqual(db2.priority.get(prio, 'order'), 1.0) db2.commit() self.db.commit() self.assertEqual(self.db.priority.get(prio, 'order'), 2.0) inc(db2) db2.commit() db2.clearCache() self.assertEqual(db2.priority.get(prio, 'order'), 3.0) db2.close() class HTMLItemTest(ClassicInitBase): class Request : """ Fake html request """ rfile = None def start_response (self, a, b) : pass # end def start_response # end class Request def setUp(self): super(HTMLItemTest, self).setUp() self.tracker = tracker = setupTracker(self.dirname, self.backend) db = self.db = tracker.open('admin') req = self.Request() env = dict (PATH_INFO='', REQUEST_METHOD='GET', QUERY_STRING='') self.client = self.tracker.Client(self.tracker, req, env, None) self.client.db = db self.client.language = None self.client.userid = db.getuid() self.client.classname = 'issue' user = {'username': 'worker5', 'realname': 'Worker', 'roles': 'User'} u = self.db.user.create(**user) u_m = self.db.msg.create(author = u, content = 'bla' , date = date.Date ('2006-01-01')) issue = {'title': 'ts1', 'status': '2', 'assignedto': '3', 'priority': '3', 'messages' : [u_m], 'nosy' : ['3']} self.db.issue.create(**issue) issue = {'title': 'ts2', 'status': '2', 'messages' : [u_m], 'nosy' : ['3']} self.db.issue.create(**issue) def testHTMLItemAttributes(self): issue = HTMLItem(self.client, 'issue', '1') ae = self.assertEqual ae(issue.title.plain(),'ts1') ae(issue ['title'].plain(),'ts1') ae(issue.status.plain(),'deferred') ae(issue ['status'].plain(),'deferred') ae(issue.assignedto.plain(),'worker5') ae(issue ['assignedto'].plain(),'worker5') ae(issue.priority.plain(),'bug') ae(issue ['priority'].plain(),'bug') ae(issue.messages.plain(),'1') ae(issue ['messages'].plain(),'1') ae(issue.nosy.plain(),'worker5') ae(issue ['nosy'].plain(),'worker5') ae(len(issue.messages),1) ae(len(issue ['messages']),1) ae(len(issue.nosy),1) ae(len(issue ['nosy']),1) def testHTMLItemDereference(self): issue = HTMLItem(self.client, 'issue', '1') ae = self.assertEqual ae(str(issue.priority.name),'bug') ae(str(issue.priority['name']),'bug') ae(str(issue ['priority']['name']),'bug') ae(str(issue ['priority'].name),'bug') ae(str(issue.assignedto.username),'worker5') ae(str(issue.assignedto['username']),'worker5') ae(str(issue ['assignedto']['username']),'worker5') ae(str(issue ['assignedto'].username),'worker5') for n in issue.nosy: ae(n.username.plain(),'worker5') ae(n['username'].plain(),'worker5') for n in issue.messages: ae(n.author.username.plain(),'worker5') ae(n.author['username'].plain(),'worker5') ae(n['author'].username.plain(),'worker5') ae(n['author']['username'].plain(),'worker5') def testHTMLItemDerefFail(self): issue = HTMLItem(self.client, 'issue', '2') ae = self.assertEqual ae(issue.assignedto.plain(),'') ae(issue ['assignedto'].plain(),'') ae(issue.priority.plain(),'') ae(issue ['priority'].plain(),'') m = '[Attempt to look up %s on a missing value]' ae(str(issue.priority.name),m%'name') ae(str(issue ['priority'].name),m%'name') ae(str(issue.assignedto.username),m%'username') ae(str(issue ['assignedto'].username),m%'username') ae(bool(issue ['assignedto']['username']),False) ae(bool(issue ['priority']['name']),False) def makeForm(args): """ Takes a dict of form elements or a FieldStorage. FieldStorage is just returned so you can pass the result from makeFormFromString through it cleanly. """ if isinstance(args, cgi.FieldStorage): return args form = cgi.FieldStorage() for k,v in args.items(): if type(v) is type([]): [form.list.append(cgi.MiniFieldStorage(k, x)) for x in v] elif isinstance(v, FileUpload): x = cgi.MiniFieldStorage(k, v.content) x.filename = v.filename form.list.append(x) else: form.list.append(cgi.MiniFieldStorage(k, v)) return form def makeFormFromString(bstring, env=None): """used for generating a form that looks like a rest or xmlrpc payload. Takes a binary or regular string and stores it in a FieldStorage object. :param: bstring - binary or regular string :param" env - dict of environment variables. Names/keys must be uppercase. e.g. {"REQUEST_METHOD": "DELETE"} Ideally this would be part of makeForm, but the env dict is needed here to allow FieldStorage to properly define the resulting object. """ rfile=IOBuff(bs2b(bstring)) # base headers required for BinaryFieldStorage/FieldStorage e = {'REQUEST_METHOD':'POST', 'CONTENT_TYPE': 'text/xml', 'CONTENT_LENGTH': str(len(bs2b(bstring))) } if env: e.update(env) form = BinaryFieldStorage(fp=rfile, environ=e) return form class FileUpload: def __init__(self, content, filename): self.content = content self.filename = filename class FormTestParent(object): backend = "anydbm" def setupDetectors(self): pass def setUp(self): self.dirname = '_test_cgi_form' # set up and open a tracker self.instance = setupTracker(self.dirname, backend = self.backend) # We may want to register separate detectors self.setupDetectors() # open the database self.db = self.instance.open('admin') self.db.Otk = MockNull() self.db.Otk.data = {} self.db.Otk.getall = self.data_get self.db.Otk.set = self.data_set self.db.tx_Source = "web" self.db.user.create(username='Chef', address='chef@bork.bork.bork', realname='Bork, Chef', roles='User') self.db.user.create(username='mary', address='mary@test.test', roles='User', realname='Contrary, Mary') self.db.issue.addprop(tx_Source=hyperdb.String()) self.db.msg.addprop(tx_Source=hyperdb.String()) self.db.post_init() def setupClient(self, form, classname, nodeid=None, template='item', env_addon=None): cl = client.Client(self.instance, None, {'PATH_INFO':'/', 'REQUEST_METHOD':'POST'}, makeForm(form)) cl.classname = classname cl.base = 'http://whoami.com/path/' cl.nodeid = nodeid cl.language = ('en',) cl.userid = '1' cl.db = self.db cl.user = 'admin' cl.template = template if env_addon is not None: cl.env.update(env_addon) return cl def data_get(self, key): return self.db.Otk.data[key] def data_set(self, key, **value): self.db.Otk.data[key] = value def parseForm(self, form, classname='test', nodeid=None): cl = self.setupClient(form, classname, nodeid) return cl.parsePropsFromForm(create=1) def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise class SpecialAction(actions.EditItemAction): x = False def handle(self): self.__class__.x = True cl = self.db.getclass(self.classname) cl.set(self.nodeid, status='2') cl.set(self.nodeid, title="Just a test") assert 0, "not reached" self.db.commit() def reject_title(db, cl, nodeid, newvalues): if 'title' in newvalues: raise Reject ("REJECT TITLE CHANGE") def init_reject(db): db.issue.audit("set", reject_title) def get_extensions(self, what): """ For monkey-patch of instance.get_extensions: The old method is kept as _get_extensions, we use the new method to return our own auditors/reactors. """ if what == 'detectors': return [init_reject] return self._get_extensions(what) class SpecialActionTest(FormTestParent): def setupDetectors(self): self.instance._get_extensions = self.instance.get_extensions def ge(what): return get_extensions(self.instance, what) self.instance.get_extensions = ge def setUp(self): FormTestParent.setUp(self) self.instance.registerAction('special', SpecialAction) self.issue = self.db.issue.create (title = "hello", status='1') self.db.commit () if 'SENDMAILDEBUG' not in os.environ: os.environ['SENDMAILDEBUG'] = 'mail-test2.log' self.SENDMAILDEBUG = os.environ['SENDMAILDEBUG'] page_template = """

""".strip () self.form = {':action': 'special'} cl = self.setupClient(self.form, 'issue', self.issue) pt = RoundupPageTemplate() pt.pt_edit(page_template, 'text/html') self.out = [] def wh(s): self.out.append(s) cl.write_html = wh def load_template(x): return pt cl.instance.templates.load = load_template cl.selectTemplate = MockNull() cl.determine_context = MockNull () def hasPermission(s, p, classname=None, d=None, e=None, **kw): return True self.hasPermission = actions.Action.hasPermission actions.Action.hasPermission = hasPermission self.e1 = _HTMLItem.is_edit_ok _HTMLItem.is_edit_ok = lambda x : True self.e2 = HTMLProperty.is_edit_ok HTMLProperty.is_edit_ok = lambda x : True # Make sure header check passes cl.env['HTTP_REFERER'] = 'http://whoami.com/path/' self.client = cl def tearDown(self): FormTestParent.tearDown(self) # Remove monkey-patches self.instance.get_extensions = self.instance._get_extensions del self.instance._get_extensions actions.Action.hasPermission = self.hasPermission _HTMLItem.is_edit_ok = self.e1 HTMLProperty.is_edit_ok = self.e2 if os.path.exists(self.SENDMAILDEBUG): #os.remove(self.SENDMAILDEBUG) pass def testInnerMain(self): cl = self.client cl.session_api = MockNull(_sid="1234567890") self.form ['@nonce'] = anti_csrf_nonce(cl) cl.form = makeForm(self.form) # inner_main will re-open the database! # Note that in the template above, the rendering of the # context/submit button will also call anti_csrf_nonce which # does a commit of the otk to the database. cl.inner_main() cl.db.close() print(self.out) # Make sure the action was called self.assertEqual(SpecialAction.x, True) # Check that the Reject worked: self.assertNotEqual(-1, self.out[0].index('REJECT TITLE CHANGE')) # Re-open db self.db.close() self.db = self.instance.open ('admin') # We shouldn't see any changes self.assertEqual(self.db.issue.get(self.issue, 'title'), 'hello') self.assertEqual(self.db.issue.get(self.issue, 'status'), '1') # vim: set et sts=4 sw=4 : code-e5bd50120b5a/test/gpgmelib.py0000644000000000000000000001556315064275501015051 0ustar 00000000000000# -*- encoding: utf-8 -*- # # Copyright (c) 2011 Ralf Schlatterbeck, rsc@runtux.com. # 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. import shutil, os try: import gpg, gpg.core except ImportError: gpg = None pgp_test_key = """ -----BEGIN PGP PRIVATE KEY BLOCK----- Version: GnuPG v1.4.10 (GNU/Linux) lQOYBE6NqtsBCADG3UUMYxjwUOpDDVvr0Y8qkvKsgdF79en1zfHtRYlmZc+EJxg8 53CCFGReQWJwOjyP3/SLJwJqfiPR7MAYAqJsm/4U2lxF7sIlEnlrRpFuvB625KOQ oedCkI4nLa+4QAXHxVX2qLx7es3r2JAoitZLX7ZtUB7qGSRh98DmdAgCY3CFN7iZ w6xpvIU+LNbsHSo1sf8VP6z7NHQFacgrVvLyRJ4C5lTPU42iM5E6HKxYFExNV3Rn +2G0bsuiifHV6nJQD73onjwcC6tU97W779dllHlhG3SSP0KlnwmCCvPMlQvROk0A rLyzKWcUpZwK1aLRYByjFMH9WYXRkhf08bkDABEBAAEAB/9dcmSb6YUyiBNM5t4m 9hZcXykBvw79PRVvmBLy+BYUtArLgsN0+xx3Q7XWRMtJCVSkFw0GxpHwEM4sOyAZ KEPC3ZqLmgB6LDO2z/OWYVa9vlCAiPgDYtEVCnCCIInN/ue4dBZtDeVj8NUK2n0D UBpa2OMUgu3D+4SJNK7EnAmXdOaP6yfe6SXwcQfti8UoSFMJRkQkbY1rm/6iPfON t2RBAc7jW4eRzdciWCfvJfMSj9cqxTBQWz5vVadeY9Bm/IKw1HiKNBrJratq2v+D VGr0EkE9oOa5zbgZt2CFvknE4YhGmv81xFdK5GXr8L7nluZrePMblWbkI2ICTbV0 RKLhBADYLvyDFX3cCoFzWmCl5L32G6LLfTt0yU0eUHcAzXd7QjOZN289HWYEmdVi kpxQPDxhWz+m8qt0HJGFl2+BKpZJBaT/L5AcqTBODxarxCSBTIVhCjD/46XvLY0h b2ZnG8HSLyFdRj07vk+qTvcF58qUuYFSLIF2t2imTCR/PwR/LwQA632vn2/7KIHj DR0O+G9eccTtAfX4TN4Q4Ua3WByClLZu/LSAenCLZ1CHVABEH6dwwjEARLeNUdLi Xy5KKlpr2vkoh96fnw0r2yg7dlBXq4yQKjJBXwNaKpuvqgzd8en0zJGLXxzt0NT3 H+QNIP2WZMJSDQcDh3HhQrH0IeNdDm0D/iyJgSMXvqjm+KhYIa3xiloQsCRlDNm+ XC7Eo5hsjvBaIKba6o9oL9oEiSVUFryPWKWIpi0P7/F5voJL6KFSZTor3x3o9CcC qHyqMHfNL23EAVJulySfPYLC7S3QB+tCBLXmKxb/YXCSLVi/UDzVgvWN6KIknZg2 6uDLUzPbzDGjOZ20K1JvdW5kdXAgVGVzdGtleSA8cm91bmR1cC1hZG1pbkBleGFt cGxlLmNvbT6JATgEEwECACIFAk6NqtsCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4B AheAAAoJEFrc/VYxw4dBG7oIAMCU9sRjK0dS7z/IGJ8KcCOQNN674AooJLn+J9Ew BT6/WxMY13nm/iK0uX2sOGnnXdg1PJ15IvD8zB5wXLbe25t6oRl5G58vmeKEyjc8 QTB43/c8EsqY1ob7EVcuhrJCSS/JM8ApzQyXrh2QNmS+mBCJcx74MeipE6mNVT9j VscizixdFjqvJLkbW1kGac3Wj+c3ICNUIp0lbwb+Ve2rXlU+iXHEDqaVJDMEppme gDiZl+bKYrqljhZkH9Slv55uqqXUSg1SmTm/2orHUdAmDc6Y6azKNqQEqD2B0JyT jTJQJVMl5Oln63aZDCTxHkoqn8q06OjLJRD4on7jlanZEladA5gETo2q2wEIALEF poVkZrnqme2M8FObrQyVB+ZYT2mox56WLyInbxVFDg20qqIvQfVE0P69Yuf1OXkj q7bNI03Jvo+uzxpztOKPDo7tnbQ7bXbOmq3n4wUoN29NMrYNg6tF1ubEv1WwYUMw 7LfF4BLMETXpT0JElV1+awfP9rrGiyWkH4enG612HT+1OoA0R0nNH0kslD6OhdoR VDqkyiCmdY9x176EhzhL3vCoN6ywRVTfFbAJiMv9UDzxs0SStmVOK/l5XLfWQO6f 9boAHihpnxEfPIJhsD+FpVKVf3g85qWAjh2BfuzdW79vjLBdTHJQxg4HdhliWbXg PjjrVEgWEFVc+NDlNb0AEQEAAQAH/A1a6sbniI8q3DVoIP19zN7FI5UaQSuB2Jrl +Q+vlUQv3dvk2cwQmqj2vyRo2gcRS3u7LYpGDGLNqfshv22JyzId2YWo9vE7sTTP E4EJRz8CsLlMmVsoxoVBE0cnvXOpMef6z0ZyFEdMGVmi4iA9bQi3r+V6qBehQQA0 U034VTCPN4yvWyq6TWsABesOx48nkQ5TlduIq2ZGNCR8Vd1fe6vGM7YXyQWxy5ke guqmph73H2bOB6hSuUnyBFKtinrF9MbCGA0PqheUVqy0p7og6x/pEoAVkKBJ9Ki+ ePuQtBl5h9e3SbiN+r7aa6T0Ygx/7igl4eWPfvJYIXYXc4aKiwEEANEa5rBoN7Ta ED+R47Rg9w/EW3VDQ6R3Szy1rvIKjC6JlDyKlGgTeWEFjDeTwCB4xU7YtxVpt6bk b7RBtDkRck2+DwnscutA7Uxn267UxzNUd1IxhUccRFRfRS7OEnmlVmaLUnOeHHwe OrZyRSiNVnh0QABEJnwNjX4m139v6YD9BADYuM5XCawI63pYa3/l7UX9H5EH95OZ G9Hw7pXQ/YJYerSxRx+2q0+koRcdoby1TVaRrdDC+kOm3PI7e66S5rnaZ1FZeYQP nVYzyGqNnsvncs24kYBL8DYaDDfdm7vfzSEqia0VNqZ4TMbwJLk5f5Ys4WOF791G LPJgrAPG1jgDwQQAovKbw0u6blIUKsUYOLsviaLCyFC9DwaHqIZwjy8omnh7MaKE 7+MXxJpfcVqFifj3CmqMdSmTfkgbKQPAI46Q1OKWvkvUxEvi7WATo4taEXupRFL5 jnL8c4h46z8UpMX2CMwWU0k1Et/zlBoYy7gNON7tF2/uuN18zWFBlD72HuM9HIkB HwQYAQIACQUCTo2q2wIbDAAKCRBa3P1WMcOHQYI+CACDXJf1e695LpcsrVxKgiQr 9fTbNJYB+tjbnd9vas92Gz1wZcQV9RjLkYQeEbOpWQud/1UeLRsFECMj7kbgAEqz 7fIO4SeN8hFEvvZ+lI0AoBi4XvuUcCm5kvAodvmF8M9kQiUzF1gm+R9QQeJFDLpW 8Gg7J3V3qM+N0FuXrypYcsEv7n/RJ1n+lhTW5hFzKBlNL4WrAhY/QsXEbmdsa478 tzuHlETtjMm4g4DgppUdlCMegcpjjC9zKsN5xFOQmNMTO/6rPFUqk3k3T6I0LV4O zm4xNC+wwAA69ibnbrY1NR019et7RYW+qBudGbpJB1ABzkf/NsaCj6aTaubt7PZP =3uFZ -----END PGP PRIVATE KEY BLOCK----- """ john_doe_key = """ -----BEGIN PGP PRIVATE KEY BLOCK----- Version: GnuPG v1.4.10 (GNU/Linux) lQHYBE6NwvABBACxg7QqV2qHywwM3wae6HAHJVEo7EeYA6Lv0pZlW3Aw4CCCnpgJ jA7CekGFcmGmoCaN9ezuVAPTgUlK4yt8a7P6cT0vw1q341Om9IEKAu59RpNZN/H9 6GfZ95bU51W/hdTFysH1DRwbCR3MowvLeA6Pk4cZlPsYHD0SD3De2i1BewARAQAB AAP+IRi4L6jKwPS3k3LFrj0SHhL0Fdgv5QTQjTxLNCyfN02iYhglqqoFWncm3jWc RU/YwGEYwrrBV97kBmVihzkhfgFRsxynE9PMGKKEAuRcAl21RPJDFA6Dlnp6M2No rR6eoAhrlZ8+KsK9JaXSMalzO/Yh4u3mOinq3f3XL96wAEkCAMAxeZMF5pnXARNR Y7u2clhNNnLuf+BzpENCFMaWzWPyTcvbf4xNK7ZHPxFVZpX5/qAPJ8rnTaOTHxnN 5PgqbO8CAOxyrTw/muakTJLg+FXdn8BgxZGJXMT7KmkU9SReefjo7c1WlnZxKIAy 6vLIG8WMGpdfCFDve0YLr/GGyDtOjDUB/RN3gn6qnAJThBnVk2wESZVx41fihbIF ACCKc9heFskzwurtvvp+bunM3quwrSH1hWvxiWJlDmGSn8zQFypGChifgLQZSm9o biBEb2UgPGpvaG5AdGVzdC50ZXN0Poi4BBMBAgAiBQJOjcLwAhsDBgsJCAcDAgYV CAIJCgsEFgIDAQIeAQIXgAAKCRC/z7qg+FujnPWiA/9T5SOGraRNIVVIyvJvYwkG OTAfQ0K3QMlLoQMPmaEbx9Q+isF15M9sOMcl1XGO4UNWuCPIIN8z/y/OLgAB0ZuL GlnAPPOOZ+MlaUXiMYo8oi416QZrMDf2H/Nkc10csiXm+zMl8RqeIQBEeljNyJ+t MG1EWn/PHTwFTd/VePuQdJ0B2AROjcLwAQQApw+72jKy0/wqg5SAtnVSkA1F3Jna /OG+ufz5dX57jkMFRvFoksWIWqHmiCjdE5QV8j+XTnjElhLsmrgjl7aAFveb30R6 ImmcpKMN31vAp4RZlnyYbYUCY4IXFuz3n1CaUL+mRx5yNJykrZNfpWNf2pwozkZq lcDI69ymIW5acXUAEQEAAQAD/R7Jdf98l1scngMYo228ikYUxBqm2eX/fiQNXDWM ZR2u+TJ9O53MvFejfXX7Pd6lTDQUBwDFncjgXO0YYSrMzabhqpqoKLqOIpZmBuWC Hh1lvcFoIYoDR2LkiJ9EPBUEVUBDsUO8ajkILEE3G+DDpCaf9Vo82lCVyhDESqyt v4lxAgDOLpoq1Whv5Ejr6FifTWytCiQjH2P1SmePlQmy6oEJRUYA1t4zYrzCJUX8 VAvPjh9JXilP6mhDbyQArWllewV9AgDPbVOf75ktRwfhje26tZsukqWYJCc1XvoH 3PTzA7vH1HZZq7dvxa87PiSnkOLEsIAsI+4jpeMxpPlQRxUvHf1ZAf9rK3v3HMJ/ 2xVzwK24Oaj+g2O7D/fdqtLFGe5S5JobnTyp9xArDAhaZ/AKfDMYjUIKMP+bdNAf y8fQUtuawFltm1GInwQYAQIACQUCTo3C8AIbDAAKCRC/z7qg+FujnDzYA/9EU6Pv Ci1+DCtxjnq7IOvOjqExhFNGvN9Dw17Tl8HcyW3if9v5RxeSWYKl0DhzVdzMQgH/ 78q4F4W1q2IkB7SCpXizHLIc3eh8iZkbWZE+CGPvTpqyF03Yi16qhxpAbkGs2Yhq jTx5oJ4CL5fybBOZLg+BTlK4HIee6xEcbNoq+A== =ZKBW -----END PGP PRIVATE KEY BLOCK----- """ ownertrust = """ 723762CD5A5FECB76DC72DF85ADCFD5631C38741:6: 2940C247A1FBAD508A1AF24BBFCFBAA0F85BA39C:6: """ pgphome = 'pgp-test-home' def setUpPGP(): # prevent test from failing if left over from earlier run: if os.path.exists(pgphome): shutil.rmtree(pgphome) os.mkdir(pgphome) os.environ['GNUPGHOME'] = pgphome # gpgme_check_version() must have been called once in a programm # to initialise some subsystems of gpgme. See roundup/roundupdb.py. ctx = gpg.core.Context() key = gpg.core.Data(pgp_test_key) ctx.op_import(key) key = gpg.core.Data(john_doe_key) ctx.op_import(key) # trust-modelling with pyme isn't working in 0.8.1 # based on libgpgme11 1.2.0, also tried in C -- same thing. otrust = os.popen ('gpg --import-ownertrust 2> /dev/null', 'w') otrust.write(ownertrust) otrust.close() def tearDownPGP(): if os.path.exists(pgphome): shutil.rmtree(pgphome, True) # ignore errors # vim: set filetype=python sts=4 sw=4 et si : code-e5bd50120b5a/test/html_norm.py0000644000000000000000000001027715064275501015257 0ustar 00000000000000"""Minimal html parser/normalizer for use in test_templating. When testing markdown -> html conversion libraries, there are gratuitous whitespace changes in generated output that break the tests. Use this to try to normalize the generated HTML into something that tries to preserve the semantic meaning allowing tests to stop breaking. This is not a complete parsing engine. It supports the Roundup issue tracker unit tests so that no third party libraries are needed to run the tests. If you find it useful enjoy. Ideally this would be done by hijacking in some way lxml.html.usedoctest to get a liberal parser that will ignore whitespace. But that means the user has to install lxml to run the tests. Similarly BeautifulSoup could be used to pretty print the html but again, BeautifulSoup would need to be installed to run the tests. """ try: from html.parser import HTMLParser except ImportError: from HTMLParser import HTMLParser # python2 try: from htmlentitydefs import name2codepoint except ImportError: pass # assume running under python3, name2codepoint predefined class NormalizingHtmlParser(HTMLParser): """Handle start/end tags and normalize whitespace in data. Strip doctype, comments when passed in. Implements normalize method that takes input html and returns a normalized string leaving the instance ready for another call to normalize for another string. Note that using this rewrites all attributes parsed by HTMLParser into attr="value" form even though HTMLParser accepts other attribute specification forms. """ debug = False # set to true to enable more verbose output current_normalized_string = "" # accumulate result string preserve_data = False # if inside pre preserve whitespace def handle_starttag(self, tag, attrs): """put tag on new line with attributes. Note valid attributes according to HTMLParser: attrs='single_quote' attrs=noquote attrs="double_quote" """ if self.debug: print("Start tag:", tag) self.current_normalized_string += "\n<%s" % tag for attr in attrs: if self.debug: print(" attr:", attr) self.current_normalized_string += ' %s="%s"' % attr self.current_normalized_string += ">\n" if tag == 'pre': self.preserve_data = True def handle_endtag(self, tag): if self.debug: print("End tag :", tag) self.current_normalized_string += "\n" % tag if tag == 'pre': self.preserve_data = False def handle_data(self, data): if self.debug: print("Data :", data) if not self.preserve_data: # normalize whitespace remove leading/trailing data = " ".join(data.strip().split()) if data: self.current_normalized_string += "%s" % data def handle_comment(self, data): print("Comment :", data) def handle_decl(self, data): print("Decl :", data) def reset(self): """wrapper around reset with clearing of csef.current_normalized_string and reset of self.preserve_data """ HTMLParser.reset(self) self.current_normalized_string = "" self.preserve_data = False def normalize(self, html): self.feed(html) result = self.current_normalized_string self.reset() return result if __name__ == "__main__": parser = NormalizingHtmlParser() parser.feed('

paragraph text with whitespace\n and more space 

text more text
') print("\n\ntest1", parser.current_normalized_string) parser.reset() parser.feed('''

paragraph text with whitespace\n and more space 

text \n more text
''') print("\n\ntest2", parser.current_normalized_string) parser.reset() print("\n\nnormalize", parser.normalize('''

paragraph text with whitespace\n and more space 

text \n more text <
''')) code-e5bd50120b5a/test/pg_service.conf0000644000000000000000000000063315064275501015676 0ustar 00000000000000[roundup_test_db] host=127.0.0.1 port=5432 user=rounduptest password=rounduptest dbname=rounduptest [roundup_test_schema] host=127.0.0.1 port=5432 user=rounduptest_schema password=rounduptest dbname=rounduptest_schema options=-c search_path=roundup_service_dev [roundup_test_schema_bad] host=127.0.0.1 port=5432 user=rounduptest_schema password=rounduptest dbname=rounduptest_schema options=-c search_path= code-e5bd50120b5a/test/pytest_patcher.py0000644000000000000000000000234715064275501016315 0ustar 00000000000000""" The following code was taken from: https://github.com/pytest-dev/pytest/issues/568#issuecomment-216569420 to resolve a bug with using pytest.mark.skip(). Once the bug is resolved in pytest this file can be removed along with all the wrapper mark_class() references in the other test files. """ import types def mark_class(marker): '''Workaround for https://github.com/pytest-dev/pytest/issues/568''' def copy_func(f): try: return types.FunctionType(f.__code__, f.__globals__, name=f.__name__, argdefs=f.__defaults__, closure=f.__closure__) except AttributeError: return types.FunctionType(f.func_code, f.func_globals, name=f.func_name, argdefs=f.func_defaults, closure=f.func_closure) def mark(cls): if isinstance(cls, types.FunctionType): return marker(copy_func(cls)) for method in dir(cls): if method.startswith('test'): f = copy_func(getattr(cls, method)) setattr(cls, method, marker(f)) return cls return mark code-e5bd50120b5a/test/rest_common.py0000644000000000000000000064571315064275501015616 0ustar 00000000000000import pytest import unittest import shutil import sys import errno import logging from time import sleep from datetime import datetime, timedelta from roundup.anypy.cgi_ import cgi from roundup.anypy.datetime_ import utcnow from roundup.date import Date from roundup.exceptions import UsageError from roundup.test.tx_Source_detector import init as tx_Source_init try: from datetime import timezone myutc = timezone.utc except ImportError: # python 2 from datetime import tzinfo ZERO = timedelta(0) class UTC(tzinfo): """UTC""" def utcoffset(self, dt): return ZERO def tzname(self, dt): return "UTC" def dst(self, dt): return ZERO myutc = UTC() from roundup.cgi.exceptions import * from roundup.hyperdb import HyperdbValueError from roundup.exceptions import * from roundup import password, hyperdb from roundup.rest import RestfulInstance, calculate_etag from roundup.cgi import client from roundup.anypy.strings import b2s, s2b, us2u import random from roundup.backends.sessions_dbm import OneTimeKeys from roundup.anypy.dbm_ import whichdb from .db_test_base import setupTracker from roundup.test.mocknull import MockNull from io import BytesIO import json from copy import copy try: import jwt skip_jwt = lambda func, *args, **kwargs: func except ImportError: from .pytest_patcher import mark_class jwt = None skip_jwt = mark_class(pytest.mark.skip( reason='Skipping JWT tests: jwt library not available')) if sys.version_info[0] > 2: skip_on_py2 = lambda func, *args, **kwargs: func else: from .pytest_patcher import mark_class skip_on_py2 =mark_class(pytest.mark.skip( reason='Skipping test on Python 2')) NEEDS_INSTANCE = 1 class TestCase(): @pytest.fixture(autouse=True) def inject_fixtures(self, caplog): self._caplog = caplog backend = None url_pfx = 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/' def setUp(self): from packaging import version self.dirname = '_test_rest' # set up and open a tracker # Set optimize=True as code under test (Client.main()::determine_user) # will close and re-open the database on user changes. This wipes # out additions to the schema needed for testing. self.instance = setupTracker(self.dirname, self.backend, optimize=True) # open the database self.db = self.instance.open('admin') # Create the Otk db. # This allows a test later on to open the existing db and # set a class attribute to test the open retry loop # just as though this process was using a pre-existing db # rather then the new one we create. otk = OneTimeKeys(self.db) otk.set('key', key="value") # Get user id (user4 maybe). Used later to get data from db. self.joeid = self.db.user.create( username='joe', password=password.Password('random'), address='random@home.org', realname='Joe Random', roles='User' ) self.db.user.set('1', address="admin@admin.com") self.db.user.set('2', address="anon@admin.com") # set up some more stuff for testing self.db.msg.create( author="1", date=Date(), summary="stuff", content="abcdefghi\njklmnop", type="text/markdown" ) self.db.msg.create( author="1", date=Date(), summary="stuff", content="abcdefghi\njklmnop", ) self.db.file.create( name="afile", content="PNG\x01abcdefghi\njklmnop", type="image/png" ) self.db.commit() self.db.close() self.db = self.instance.open('joe') # Allow joe to retire p = self.db.security.addPermission(name='Retire', klass='issue') self.db.security.addPermissionToRole('User', p) # add set of roles for testing jwt's. self.db.security.addRole(name="User:email", description="allow email by jwt") # allow the jwt to access everybody's email addresses. # this makes it easier to differentiate between User and # User:email roles by accessing the /rest/data/user # endpoint jwt_perms = self.db.security.addPermission( name='View', klass='user', properties=('id', 'realname', 'address', 'username'), description="Allow jwt access to email", props_only=False) self.db.security.addPermissionToRole("User:email", jwt_perms) self.db.security.addPermissionToRole("User:email", "Rest Access") # add set of roles for testing jwt's. # this is like the user:email role, but it missing access to the rest endpoint. self.db.security.addRole(name="User:emailnorest", description="allow email by jwt") jwt_perms = self.db.security.addPermission( name='View', klass='user', properties=('id', 'realname', 'address', 'username'), description="Allow jwt access to email but forget to allow rest", props_only=False) self.db.security.addPermissionToRole("User:emailnorest", jwt_perms) if jwt: # must be 32 chars in length minimum (I think this is at least # 256 bits of data) self.old_secret = "TestingTheJwtSecretTestingTheJwtSecret" self.new_secret = "TestingTheNEW JwtSecretTestingTheNEWJwtSecret" self.db.config['WEB_JWT_SECRET'] = self.old_secret # generate all timestamps in UTC. base_datetime = datetime(1970, 1, 1, tzinfo=myutc) # A UTC timestamp for now. dt = datetime.now(myutc) now_ts = int((dt - base_datetime).total_seconds()) # one good for a minute dt = dt + timedelta(seconds=60) plus1min_ts = int((dt - base_datetime).total_seconds()) # one that expired a minute ago dt = dt - timedelta(seconds=120) expired_ts = int((dt - base_datetime).total_seconds()) # claims match what cgi/client.py::determine_user # is looking for claim = {'sub': self.db.getuid(), 'iss': self.db.config.TRACKER_WEB, 'aud': self.db.config.TRACKER_WEB, 'roles': ['User'], 'iat': now_ts, 'exp': plus1min_ts} # in version 2.0.0 and newer jwt.encode returns string # not bytestring. So we have to skip b2s conversion if version.parse(jwt.__version__) >= version.parse('2.0.0'): tostr = lambda x: x else: tostr = b2s self.jwt = {} self.claim = {} # generate invalid claim with expired timestamp self.claim['expired'] = copy(claim) self.claim['expired']['exp'] = expired_ts self.jwt['expired'] = tostr(jwt.encode( self.claim['expired'], self.old_secret, algorithm='HS256')) # generate valid claim with user role self.claim['user'] = copy(claim) self.claim['user']['exp'] = plus1min_ts self.jwt['user'] = tostr(jwt.encode( self.claim['user'], self.old_secret, algorithm='HS256')) # generate valid claim with user role and new secret self.claim['user_new_secret'] = copy(claim) self.claim['user_new_secret']['exp'] = plus1min_ts self.jwt['user_new_secret'] = tostr(jwt.encode( self.claim['user'], self.new_secret, algorithm='HS256')) # generate invalid claim bad issuer self.claim['badiss'] = copy(claim) self.claim['badiss']['iss'] = "http://someissuer/bugs" self.jwt['badiss'] = tostr(jwt.encode( self.claim['badiss'], self.old_secret, algorithm='HS256')) # generate invalid claim bad aud(ience) self.claim['badaud'] = copy(claim) self.claim['badaud']['aud'] = "http://someaudience/bugs" self.jwt['badaud'] = tostr(jwt.encode( self.claim['badaud'], self.old_secret, algorithm='HS256')) # generate invalid claim bad sub(ject) self.claim['badsub'] = copy(claim) self.claim['badsub']['sub'] = str("99") self.jwt['badsub'] = tostr( jwt.encode(self.claim['badsub'], self.old_secret, algorithm='HS256')) # generate invalid claim bad roles self.claim['badroles'] = copy(claim) self.claim['badroles']['roles'] = ["badrole1", "badrole2"] self.jwt['badroles'] = tostr(jwt.encode( self.claim['badroles'], self.old_secret, algorithm='HS256')) # generate valid claim with limited user:email role self.claim['user:email'] = copy(claim) self.claim['user:email']['roles'] = ["user:email"] self.jwt['user:email'] = tostr(jwt.encode( self.claim['user:email'], self.old_secret, algorithm='HS256')) # generate valid claim with limited user:emailnorest role self.claim['user:emailnorest'] = copy(claim) self.claim['user:emailnorest']['roles'] = ["user:emailnorest"] self.jwt['user:emailnorest'] = tostr(jwt.encode( self.claim['user:emailnorest'], self.old_secret, algorithm='HS256')) self.db.tx_Source = 'web' self.db.issue.addprop(tx_Source=hyperdb.String()) self.db.issue.addprop(anint=hyperdb.Integer()) self.db.issue.addprop(afloat=hyperdb.Number()) self.db.issue.addprop(abool=hyperdb.Boolean()) self.db.issue.addprop(requireme=hyperdb.String(required=True)) self.db.user.addprop(issue=hyperdb.Link('issue')) self.db.msg.addprop(tx_Source=hyperdb.String()) self.db.post_init() tx_Source_init(self.db) self.client_env = { 'PATH_INFO': 'http://localhost/rounduptest/rest/', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', 'HTTP_ORIGIN': 'http://tracker.example' } self.dummy_client = client.Client(self.instance, MockNull(), self.client_env, cgi.FieldStorage(), None) self.dummy_client.request.headers.get = self.get_header self.dummy_client.db = self.db self.empty_form = cgi.FieldStorage() # under python2 invoking: # python2 -m pytest --durations=20 # loads the form with: # FieldStorage(None, None, [MiniFieldStorage('--durations', '2')]) # Invoking it as: python2 -m pytest -v --durations=20 # results in an empty list. In any case, force it to be empty. self.empty_form.list = [] self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.server = RestfulInstance(self.dummy_client, self.db) self.db.Otk = self.db.getOTKManager() self.db.config['WEB_SECRET_KEY'] = "XyzzykrnKm45Sd" def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def get_header(self, header, not_found=None): try: return self.headers[header.lower()] except (AttributeError, KeyError, TypeError): if header.upper() in self.client_env: return self.client_env[header.upper()] return not_found def create_stati(self): try: self.db.status.create(name='open', order='9') except ValueError: pass try: self.db.status.create(name='closed', order='91') except ValueError: pass try: self.db.priority.create(name='normal') except ValueError: pass try: self.db.priority.create(name='critical') except ValueError: pass def create_sampledata(self, data_max=3): """ Create sample data common to some test cases """ self.create_stati() self.db.issue.create( title='foo1', status=self.db.status.lookup('open'), priority=self.db.priority.lookup('normal'), nosy=["1", "2"] ) issue_open_norm = self.db.issue.create( title='foo2', status=self.db.status.lookup('open'), priority=self.db.priority.lookup('normal'), assignedto="3" ) issue_open_crit = self.db.issue.create( title='foo5', status=self.db.status.lookup('open'), priority=self.db.priority.lookup('critical') ) if data_max > 10: raise ValueError('data_max must be less than 10') if data_max == 3: return sample_data = [ ["foo6", "normal", "closed"], ["foo7", "critical", "open"], ["foo8", "normal", "open"], ["foo9", "critical", "open"], ["foo10", "normal", "closed"], ["foo11", "critical", "open"], ["foo12", "normal", "closed"], ["foo13", "normal", "open"], ] for title, priority, status in sample_data: new_issue = self.db.issue.create( title=title, status=self.db.status.lookup(status), priority=self.db.priority.lookup(priority) ) if int(new_issue) == data_max: break def test_no_next_link_on_full_last_page(self): """Make sure that there is no next link on the last page where the total number of entries is a multiple of the page size. """ self.server.client.env.update({'REQUEST_METHOD': 'GET'}) # Retrieve third user of the total of 3. form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_index', '3'), cgi.MiniFieldStorage('@page_size', '1'), ] results = self.server.get_collection('user', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), 1) self.assertEqual(results['data']['collection'][0]['id'], "3") self.assertEqual(results['data']['@total_size'], 3) print(self.dummy_client.additional_headers["X-Count-Total"]) self.assertEqual( self.dummy_client.additional_headers["X-Count-Total"], "3" ) self.assertNotIn('next', results['data']['@links']) self.dummy_client.additional_headers.clear() # Retrieve first user of the total of 3. form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_index', '1'), cgi.MiniFieldStorage('@page_size', '1'), ] results = self.server.get_collection('user', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), 1) self.assertEqual(results['data']['collection'][0]['id'], "1") self.assertEqual(results['data']['@total_size'], 3) print(self.dummy_client.additional_headers["X-Count-Total"]) self.assertEqual( self.dummy_client.additional_headers["X-Count-Total"], "3" ) self.assertIn('next', results['data']['@links']) self.dummy_client.additional_headers.clear() def testTotal_size(self): """Make sure that total_size is properly set if @page_size is specified. Also test for the cases: @page_size >= the max number of retreivable rows. raises UsageError (and error code 400) @page_size < max retreivable rows, but the amount of matching rows is > max retreivable rows. total_size/X-Count-Total should be -1 no @page_size and limit < total results returns limit size and -1 for total. Check: http response code length of collection An expected id at end of collection @total_size in payload X-Count-Total in http headers """ from roundup.rest import RestfulInstance self.server.client.env.update({'REQUEST_METHOD': 'GET'}) # Retrieve one user of the total of 3. limit 10M+1 form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_index', '1'), cgi.MiniFieldStorage('@page_size', '1'), ] results = self.server.get_collection('user', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), 1) self.assertEqual(results['data']['collection'][0]['id'], "1") self.assertEqual(results['data']['@total_size'], 3) print(self.dummy_client.additional_headers["X-Count-Total"]) self.assertEqual( self.dummy_client.additional_headers["X-Count-Total"], "3" ) self.dummy_client.additional_headers.clear() # set max number of returned rows self.stored_max = RestfulInstance.max_response_row_size RestfulInstance.max_response_row_size = 2 # Retrieve whole class (no @page_*) with max rows restricted. form = cgi.FieldStorage() results = self.server.get_collection('user', self.empty_form) # reset so changes don't affect other tests if any assetion fails. RestfulInstance.max_response_row_size = self.stored_max self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), 2) self.assertEqual(results['data']['collection'][1]['id'], "2") self.assertEqual(results['data']['@total_size'], -1) print(self.dummy_client.additional_headers["X-Count-Total"]) self.assertEqual( self.dummy_client.additional_headers["X-Count-Total"], "-1" ) self.dummy_client.additional_headers.clear() # Make sure we can access items that are returned # in rows RestfulInstance.max_response_row_size + 1. # so can we access item 2 form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_index', '2'), cgi.MiniFieldStorage('@page_size', '1'), ] RestfulInstance.max_response_row_size = 2 results = self.server.get_collection('user', form) RestfulInstance.max_response_row_size = self.stored_max self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), 1) self.assertEqual(results['data']['collection'][0]['id'], "2") self.assertEqual(results['data']['@total_size'], -1) print(self.dummy_client.additional_headers["X-Count-Total"]) self.assertEqual( self.dummy_client.additional_headers["X-Count-Total"], "-1" ) self.dummy_client.additional_headers.clear() # Same as above, but access item 3 form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_index', '3'), cgi.MiniFieldStorage('@page_size', '1'), ] RestfulInstance.max_response_row_size = 2 results = self.server.get_collection('user', form) RestfulInstance.max_response_row_size = self.stored_max self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), 1) self.assertEqual(results['data']['collection'][0]['id'], "3") self.assertEqual(results['data']['@total_size'], 3) print(self.dummy_client.additional_headers["X-Count-Total"]) self.assertEqual( self.dummy_client.additional_headers["X-Count-Total"], "3" ) self.dummy_client.additional_headers.clear() # Retrieve one user but max number of rows is set to 2, # and we retrieve two users from the db. # So we don't know how many total users there are. form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_index', '1'), cgi.MiniFieldStorage('@page_size', '1'), ] RestfulInstance.max_response_row_size = 2 results = self.server.get_collection('user', form) RestfulInstance.max_response_row_size = self.stored_max self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), 1) self.assertEqual(results['data']['collection'][0]['id'], "1") self.assertEqual(results['data']['@total_size'], -1) print(self.dummy_client.additional_headers["X-Count-Total"]) self.assertEqual( self.dummy_client.additional_headers["X-Count-Total"], "-1" ) self.dummy_client.additional_headers.clear() # Set the page size to be >= the max number of rows returned. # and verify the exception returned. form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_index', '2'), cgi.MiniFieldStorage('@page_size', '2'), ] RestfulInstance.max_response_row_size = 2 results = self.server.get_collection('user', form) RestfulInstance.max_response_row_size = self.stored_max self.assertEqual(self.dummy_client.response_code, 400) self.assertEqual(results['error']['status'], 400) self.assertTrue(isinstance(results['error']['msg'], UsageError)) self.assertEqual(results['error']['msg'].args[0], "Page size 2 must be less than " "admin limit on query result size: 2.") self.assertTrue('@total_size' not in results) self.assertTrue('@data' not in results) self.assertTrue("X-Count-Total" not in self.dummy_client.additional_headers) # reset environment just in case I forgot a reset above. RestfulInstance.max_response_row_size = self.stored_max def testGet(self): """ Retrieve all three users obtain data for 'joe' """ self.server.client.env.update({'REQUEST_METHOD': 'GET'}) # Retrieve all three users. results = self.server.get_collection('user', self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), 3) self.assertEqual(results['data']['@total_size'], 3) print(self.dummy_client.additional_headers["X-Count-Total"]) self.assertEqual( self.dummy_client.additional_headers["X-Count-Total"], "3" ) # Obtain data for 'joe'. results = self.server.get_element('user', self.joeid, self.empty_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['attributes']['username'], 'joe') self.assertEqual(results['attributes']['realname'], 'Joe Random') # Obtain data for 'joe' via username lookup. results = self.server.get_element('user', 'joe', self.empty_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['attributes']['username'], 'joe') self.assertEqual(results['attributes']['realname'], 'Joe Random') # Obtain data for 'joe' via username lookup (long form). key = 'username=joe' results = self.server.get_element('user', key, self.empty_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['attributes']['username'], 'joe') self.assertEqual(results['attributes']['realname'], 'Joe Random') # Obtain data for 'joe'. results = self.server.get_attribute( 'user', self.joeid, 'username', self.empty_form ) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['data'], 'joe') def testGetTransitive(self): """ Retrieve all issues with an 'o' in status sort by status.name (not order) """ base_path = self.db.config['TRACKER_WEB'] + 'rest/data/' # self.maxDiff=None self.create_sampledata() self.db.issue.set('2', status=self.db.status.lookup('closed')) self.db.issue.set('3', status=self.db.status.lookup('chatting')) expected = {'data': {'@total_size': 2, 'collection': [ {'id': '2', 'link': base_path + 'issue/2', 'assignedto.issue': None, 'status': {'id': '10', 'link': base_path + 'status/10' } }, {'id': '1', 'link': base_path + 'issue/1', 'assignedto.issue': None, 'status': {'id': '9', 'link': base_path + 'status/9' } }, ]} } form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status.name', 'o'), cgi.MiniFieldStorage('@fields', 'status,assignedto.issue'), cgi.MiniFieldStorage('@sort', 'status.name'), ] results = self.server.get_collection('issue', form) self.assertDictEqual(expected, results) def testGetBadTransitive(self): """ Mess up the names of various properties and make sure we get a 400 and a somewhat useful error message. """ base_path = self.db.config['TRACKER_WEB'] + 'rest/data/' # self.maxDiff=None self.create_sampledata() self.db.issue.set('2', status=self.db.status.lookup('closed')) self.db.issue.set('3', status=self.db.status.lookup('chatting')) expected = [ {'error': {'msg': KeyError('Unknown property: assignedto.isse',), 'status': 400}}, {'error': {'msg': KeyError('Unknown property: stat',), 'status': 400}}, {'error': {'msg': KeyError('Unknown property: status.nam',), 'status': 400}}, ] ## test invalid transitive property in @fields form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status.name', 'o'), cgi.MiniFieldStorage('@fields', 'status,assignedto.isse'), cgi.MiniFieldStorage('@sort', 'status.name'), ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 400) self.assertEqual(repr(expected[0]['error']['msg']), repr(results['error']['msg'])) self.assertEqual(expected[0]['error']['status'], results['error']['status']) ## test invalid property in @fields form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status.name', 'o'), cgi.MiniFieldStorage('@fields', 'stat,assignedto.isuse'), cgi.MiniFieldStorage('@sort', 'status.name'), ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 400) self.assertEqual(repr(expected[1]['error']['msg']), repr(results['error']['msg'])) self.assertEqual(expected[1]['error']['status'], results['error']['status']) ## test invalid transitive property in filter TODO form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status.nam', 'o'), cgi.MiniFieldStorage('@fields', 'status,assignedto.isuse'), cgi.MiniFieldStorage('@sort', 'status.name'), ] results = self.server.get_collection('issue', form) # is currently 403 not 400 self.assertEqual(self.dummy_client.response_code, 400) self.assertEqual(repr(expected[2]['error']['msg']), repr(results['error']['msg'])) self.assertEqual(expected[2]['error']['status'], results['error']['status']) def testGetExactMatch(self): """ Retrieve all issues with an exact title """ base_path = self.db.config['TRACKER_WEB'] + 'rest/data/' # self.maxDiff=None self.create_sampledata() self.db.issue.set('2', title='This is an exact match') self.db.issue.set('3', title='This is an exact match') self.db.issue.set('1', title='This is AN exact match') expected = {'data': {'@total_size': 2, 'collection': [ {'id': '2', 'link': base_path + 'issue/2', }, {'id': '3', 'link': base_path + 'issue/3', }, ]} } form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('title:', 'This is an exact match'), cgi.MiniFieldStorage('@sort', 'status.name'), ] results = self.server.get_collection('issue', form) self.assertDictEqual(expected, results) def testOutputFormat(self): """ test of @fields and @verbose implementation """ self.maxDiff = 4000 self.create_sampledata() base_path = self.db.config['TRACKER_WEB'] + 'rest/data/issue/' # Check formating for issues status=open; @fields and verbose tests form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status', 'open'), cgi.MiniFieldStorage('@fields', 'nosy,status,creator'), cgi.MiniFieldStorage('@verbose', '2') ] expected = {'data': {'@total_size': 3, 'collection': [ { 'creator': {'id': '3', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/3', 'username': 'joe'}, 'status': {'id': '9', 'name': 'open', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/status/9'}, 'id': '1', 'nosy': [ {'username': 'admin', 'id': '1', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/1'}, {'username': 'anonymous', 'id': '2', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/2'} ], 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/1', 'title': 'foo1' }, { 'creator': {'id': '3', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/3', 'username': 'joe'}, 'status': { 'id': '9', 'name': 'open', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/status/9' }, 'id': '2', 'nosy': [ {'username': 'joe', 'id': '3', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/3'} ], 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/2', 'title': 'foo2'}, {'creator': {'id': '3', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/3', 'username': 'joe'}, 'status': { 'id': '9', 'name': 'open', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/status/9'}, 'id': '3', 'nosy': [], 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/3', 'title': 'foo5'} ]}} results = self.server.get_collection('issue', form) self.assertDictEqual(expected, results) # Check formating for issues status=open; @fields and verbose tests form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status', 'open') # default cgi.MiniFieldStorage('@verbose', '1') ] expected={'data': {'@total_size': 3, 'collection': [ {'id': '1', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/1',}, { 'id': '2', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/2'}, {'id': '3', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/3'} ]}} results = self.server.get_collection('issue', form) self.assertDictEqual(expected, results) # Generate failure case, unknown field. form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status', 'open'), cgi.MiniFieldStorage('@fields', 'title,foo') ] expected={'error': { 'msg': UsageError("Failed to find property 'foo' " "for class issue.",), 'status': 400}} results = self.server.get_collection('issue', form) # I tried assertDictEqual but seems it can't handle # the exception value of 'msg'. So I am using repr to check. self.assertEqual(repr(sorted(expected['error'])), repr(sorted(results['error'])) ) # Check formating for issues status=open; @fields and verbose tests form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status', 'open'), cgi.MiniFieldStorage('@fields', 'nosy,status,assignedto'), cgi.MiniFieldStorage('@verbose', '0') ] expected={'data': { '@total_size': 3, 'collection': [ {'assignedto': None, 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/1', 'status': '9', 'nosy': ['1', '2'], 'id': '1'}, {'assignedto': '3', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/2', 'status': '9', 'nosy': ['3'], 'id': '2'}, {'assignedto': None, 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/3', 'status': '9', 'nosy': [], 'id': '3'}]}} results = self.server.get_collection('issue', form) print(results) self.assertDictEqual(expected, results) # check users form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@fields', 'username,queries,password'), cgi.MiniFieldStorage('@verbose', '0') ] # note this is done as user joe, so we only get queries # and password for joe. expected = {'data': {'collection': [ {'id': '1', 'username': 'admin', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/1'}, {'id': '2', 'username': 'anonymous', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/2'}, {'password': '[password hidden scheme PBKDF2S5]', 'id': '3', 'queries': [], 'username': 'joe', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/3'}], '@total_size': 3}} results = self.server.get_collection('user', form) self.assertDictEqual(expected, results) ## Start testing get_element form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@fields', 'queries,password,creator'), cgi.MiniFieldStorage('@verbose', '2') ] expected = {'data': { 'id': '3', 'type': 'user', '@etag': '', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/3', 'attributes': { 'creator': {'id': '1', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/1', 'username': 'admin'}, 'password': '[password hidden scheme PBKDF2S5]', 'queries': [], 'username': 'joe' } }} results = self.server.get_element('user', self.joeid, form) results['data']['@etag'] = '' # etag depends on date, set to empty self.assertDictEqual(expected,results) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@fields', 'status:priority'), cgi.MiniFieldStorage('@verbose', '1') ] expected = {'data': { 'type': 'issue', 'id': '3', 'attributes': { 'status': { 'id': '9', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/status/9'}, 'priority': { 'id': '1', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/priority/1'}}, '@etag': '', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/3'}} results = self.server.get_element('issue', "3", form) results['data']['@etag'] = '' # etag depends on date, set to empty self.assertDictEqual(expected,results) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@fields', 'status,priority'), cgi.MiniFieldStorage('@verbose', '0') ] expected = {'data': { 'type': 'issue', 'id': '3', 'attributes': { 'status': '9', 'priority': '1'}, '@etag': '', 'link': 'http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/3'}} results = self.server.get_element('issue', "3", form) results['data']['@etag'] = '' # etag depends on date, set to empty self.assertDictEqual(expected,results) def testSorting(self): self.maxDiff = 4000 self.create_sampledata() self.db.issue.set('1', status='7') self.db.issue.set('2', status='2') self.db.issue.set('3', status='2') self.db.commit() base_path = self.db.config['TRACKER_WEB'] + 'rest/data/issue/' # change some data for sorting on later form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@fields', 'status'), cgi.MiniFieldStorage('@sort', 'status,-id'), cgi.MiniFieldStorage('@verbose', '0') ] # status is sorted by orderprop (property 'order') # which provides the same ordering as the status ID expected={'data': { '@total_size': 3, 'collection': [ {'link': base_path + '3', 'status': '2', 'id': '3'}, {'link': base_path + '2', 'status': '2', 'id': '2'}, {'link': base_path + '1', 'status': '7', 'id': '1'}]}} results = self.server.get_collection('issue', form) self.assertDictEqual(expected, results) def testGrouping(self): self.maxDiff = 4000 self.create_sampledata(data_max=5) self.db.issue.set('1', status='7', priority='4') self.db.issue.set('2', status='2', priority='4') self.db.issue.set('3', status='2', priority='4') self.db.issue.set('4', status='2', priority='2') self.db.issue.set('5', status='2', priority='2') self.db.commit() base_path = self.db.config['TRACKER_WEB'] + 'rest/data/issue/' # change some data for sorting on later form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@fields', 'status,priority'), cgi.MiniFieldStorage('@sort', '-id'), cgi.MiniFieldStorage('@group', '-status,priority'), cgi.MiniFieldStorage('@verbose', '0') ] # status is sorted by orderprop (property 'order') expected={'data': { '@total_size': 5, 'collection': [ {'link': base_path + '1', 'priority': '4', 'status': '7', 'id': '1'}, {'link': base_path + '5', 'priority': '2', 'status': '2', 'id': '5'}, {'link': base_path + '4', 'priority': '2', 'status': '2', 'id': '4'}, {'link': base_path + '3', 'priority': '4', 'status': '2', 'id': '3'}, {'link': base_path + '2', 'priority': '4', 'status': '2', 'id': '2'}, ] }} results = self.server.get_collection('issue', form) print(results) self.assertDictEqual(expected, results) def testTransitiveField(self): """ Test a transitive property in @fields """ base_path = self.db.config['TRACKER_WEB'] + 'rest/data/' # create sample data self.create_stati() self.db.issue.create( title='foo4', status=self.db.status.lookup('closed'), priority=self.db.priority.lookup('critical') ) # Retrieve all issue @fields=status.name form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@fields', 'status.name') ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) exp = [ {'link': base_path + 'issue/1', 'id': '1', 'status.name': 'closed'}] self.assertEqual(results['data']['collection'], exp) def testFilter(self): """ Retrieve all three users obtain data for 'joe' """ # create sample data self.create_stati() self.db.issue.create( title='foo4', status=self.db.status.lookup('closed'), priority=self.db.priority.lookup('critical') ) self.db.issue.create( title='foo1', status=self.db.status.lookup('open'), priority=self.db.priority.lookup('normal') ) issue_open_norm = self.db.issue.create( title='foo2 normal', status=self.db.status.lookup('open'), priority=self.db.priority.lookup('normal') ) issue_closed_norm = self.db.issue.create( title='foo3 closed normal', status=self.db.status.lookup('closed'), priority=self.db.priority.lookup('normal') ) issue_closed_crit = self.db.issue.create( title='foo4 closed', status=self.db.status.lookup('closed'), priority=self.db.priority.lookup('critical') ) issue_open_crit = self.db.issue.create( title='foo5', status=self.db.status.lookup('open'), priority=self.db.priority.lookup('critical') ) base_path = self.db.config['TRACKER_WEB'] + 'rest/data/issue/' # Retrieve all issue status=open form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status', 'open') ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertIn(get_obj(base_path, issue_open_norm), results['data']['collection']) self.assertIn(get_obj(base_path, issue_open_crit), results['data']['collection']) self.assertNotIn( get_obj(base_path, issue_closed_norm), results['data']['collection'] ) # Retrieve all issue status=closed and priority=critical form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status', 'closed'), cgi.MiniFieldStorage('priority', 'critical') ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertIn(get_obj(base_path, issue_closed_crit), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_crit), results['data']['collection']) self.assertNotIn( get_obj(base_path, issue_closed_norm), results['data']['collection'] ) # Retrieve all issue status=closed and priority=normal,critical form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status', 'closed'), cgi.MiniFieldStorage('priority', 'normal,critical') ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertIn(get_obj(base_path, issue_closed_crit), results['data']['collection']) self.assertIn(get_obj(base_path, issue_closed_norm), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_crit), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_norm), results['data']['collection']) # Retrieve all issue status=closed and priority=normal,critical # using duplicate priority key's. form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('status', 'closed'), cgi.MiniFieldStorage('priority', 'normal'), cgi.MiniFieldStorage('priority', 'critical') ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertIn(get_obj(base_path, issue_closed_crit), results['data']['collection']) self.assertIn(get_obj(base_path, issue_closed_norm), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_crit), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_norm), results['data']['collection']) # Retrieve all issues with title containing # closed, normal and 3 using duplicate title filterkeys form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('title', 'closed'), cgi.MiniFieldStorage('title', 'normal'), cgi.MiniFieldStorage('title', '3') ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertNotIn(get_obj(base_path, issue_closed_crit), results['data']['collection']) self.assertIn(get_obj(base_path, issue_closed_norm), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_crit), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_norm), results['data']['collection']) self.assertEqual(len(results['data']['collection']), 1) # Retrieve all issues (no hits) with title containing # closed, normal and foo3 in this order using title filter form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('title', 'closed normal foo3') ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertNotIn(get_obj(base_path, issue_closed_crit), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_closed_norm), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_crit), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_norm), results['data']['collection']) self.assertEqual(len(results['data']['collection']), 0) # Retrieve all issues with title containing # foo3, closed and normal in this order using title filter form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('title', 'foo3 closed normal') ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertNotIn(get_obj(base_path, issue_closed_crit), results['data']['collection']) self.assertIn(get_obj(base_path, issue_closed_norm), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_crit), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_norm), results['data']['collection']) self.assertEqual(len(results['data']['collection']), 1) # Retrieve all issues with word closed in title form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('title', 'closed'), ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertIn(get_obj(base_path, issue_closed_crit), results['data']['collection']) self.assertIn(get_obj(base_path, issue_closed_norm), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_crit), results['data']['collection']) self.assertNotIn(get_obj(base_path, issue_open_norm), results['data']['collection']) self.assertEqual(len(results['data']['collection']), 2) def testPagination(self): """ Test pagination. page_size is required and is an integer starting at 1. page_index is optional and is an integer starting at 1. Verify that pagination links are present if paging, @total_size and X-Count-Total header match number of items. """ # create sample data for i in range(0, random.randint(8,15)): self.db.issue.create(title='foo' + str(i)) # Retrieving all the issues results = self.server.get_collection('issue', self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) total_length = len(results['data']['collection']) # Verify no pagination links if paging not used self.assertFalse('@links' in results['data']) self.assertEqual(results['data']['@total_size'], total_length) self.assertEqual( self.dummy_client.additional_headers["X-Count-Total"], str(total_length) ) # Pagination will be 45% of the total result # So 2 full pages and 1 partial page. page_size = total_length * 45 // 100 page_one_expected = page_size page_two_expected = page_size page_three_expected = total_length - (2*page_one_expected) base_url="http://tracker.example/cgi-bin/roundup.cgi/" \ "bugs/rest/data/issue" # Retrieve page 1 form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_size', page_size), cgi.MiniFieldStorage('@page_index', 1) ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), page_one_expected) self.assertTrue('@links' in results['data']) self.assertTrue('self' in results['data']['@links']) self.assertTrue('next' in results['data']['@links']) self.assertFalse('prev' in results['data']['@links']) self.assertEqual(results['data']['@links']['self'][0]['uri'], "%s?@page_index=1&@page_size=%s"%(base_url,page_size)) self.assertEqual(results['data']['@links']['next'][0]['uri'], "%s?@page_index=2&@page_size=%s"%(base_url,page_size)) page_one_results = results # save this for later # Retrieve page 2 form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_size', page_size), cgi.MiniFieldStorage('@page_index', 2) ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), page_two_expected) self.assertTrue('@links' in results['data']) self.assertTrue('self' in results['data']['@links']) self.assertTrue('next' in results['data']['@links']) self.assertTrue('prev' in results['data']['@links']) self.assertEqual(results['data']['@links']['self'][0]['uri'], "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue?@page_index=2&@page_size=%s"%page_size) self.assertEqual(results['data']['@links']['next'][0]['uri'], "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue?@page_index=3&@page_size=%s"%page_size) self.assertEqual(results['data']['@links']['prev'][0]['uri'], "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue?@page_index=1&@page_size=%s"%page_size) self.assertEqual(results['data']['@links']['self'][0]['rel'], 'self') self.assertEqual(results['data']['@links']['next'][0]['rel'], 'next') self.assertEqual(results['data']['@links']['prev'][0]['rel'], 'prev') # Retrieve page 3 form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_size', page_size), cgi.MiniFieldStorage('@page_index', 3) ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), page_three_expected) self.assertTrue('@links' in results['data']) self.assertTrue('self' in results['data']['@links']) self.assertFalse('next' in results['data']['@links']) self.assertTrue('prev' in results['data']['@links']) self.assertEqual(results['data']['@links']['self'][0]['uri'], "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue?@page_index=3&@page_size=%s"%page_size) self.assertEqual(results['data']['@links']['prev'][0]['uri'], "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue?@page_index=2&@page_size=%s"%page_size) # Verify that page_index is optional # Should start at page 1 form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@page_size', page_size), ] results = self.server.get_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['data']['collection']), page_size) self.assertTrue('@links' in results['data']) self.assertTrue('self' in results['data']['@links']) self.assertTrue('next' in results['data']['@links']) self.assertFalse('prev' in results['data']['@links']) self.assertEqual(page_one_results, results) # FIXME add tests for out of range once we decide what response # is needed to: # page_size < 0 # page_index < 0 def testRestRateLimit(self): calls_per_interval = 20 interval_sec = 60 wait_time_str = str(int(interval_sec/calls_per_interval)) self.db.config['WEB_API_CALLS_PER_INTERVAL'] = calls_per_interval self.db.config['WEB_API_INTERVAL_IN_SEC'] = interval_sec # Otk code never passes through the # retry loop. Not sure why but I can force it # through the loop by setting the internal _db_type # setting once the db is created by the previous command. try: self.db.Otk._db_type = whichdb("%s/%s"%(self.db.Otk.dir, self.db.Otk.name)) except AttributeError: # if dir attribute doesn't exist the primary db is not # sqlite or anydbm. So don't need to exercise code. pass start_time = utcnow() # don't set an accept header; json should be the default # use up all our allowed api calls for i in range(calls_per_interval): # i is 0 ... calls_per_interval self.client_error_message = [] self.server.client.env.update({'REQUEST_METHOD': 'GET'}) results = self.server.dispatch('GET', "/rest/data/user/%s/realname"%self.joeid, self.empty_form) loop_time = utcnow() self.assertLess((loop_time-start_time).total_seconds(), int(wait_time_str), "Test system is too slow to complete test as configured") # is successful self.assertEqual(self.server.client.response_code, 200) # does not have Retry-After header as we have # suceeded with this query self.assertFalse("Retry-After" in self.server.client.additional_headers) # remaining count is correct self.assertEqual( self.server.client.additional_headers["X-RateLimit-Remaining"], str(self.db.config['WEB_API_CALLS_PER_INTERVAL'] -1 - i) ) # trip limit self.server.client.additional_headers.clear() results = self.server.dispatch('GET', "/rest/data/user/%s/realname"%self.joeid, self.empty_form) print(results) self.assertEqual(self.server.client.response_code, 429) self.assertEqual( self.server.client.additional_headers["X-RateLimit-Limit"], str(self.db.config['WEB_API_CALLS_PER_INTERVAL'])) self.assertEqual( self.server.client.additional_headers["X-RateLimit-Limit-Period"], str(self.db.config['WEB_API_INTERVAL_IN_SEC'])) self.assertEqual( self.server.client.additional_headers["X-RateLimit-Remaining"], '0') # value will be almost 60. Allow 1-2 seconds for all 20 rounds. self.assertAlmostEqual( float(self.server.client.additional_headers["X-RateLimit-Reset"]), 59, delta=5) self.assertEqual( str(self.server.client.additional_headers["Retry-After"]), wait_time_str) # check as string print("Reset:", self.server.client.additional_headers["X-RateLimit-Reset"]) print("Now realtime pre-sleep:", utcnow()) # sleep as requested so we can do another login sleep(float(wait_time_str) + 0.1) print("Now realtime post-sleep:", utcnow()) # this should succeed self.server.client.additional_headers.clear() results = self.server.dispatch('GET', "/rest/data/user/%s/realname"%self.joeid, self.empty_form) print(results) print("Reset:", self.server.client.additional_headers["X-RateLimit-Reset-date"]) print("Now realtime:", utcnow()) print("Now ts header:", self.server.client.additional_headers["Now"]) print("Now date header:", self.server.client.additional_headers["Now-date"]) self.assertEqual(self.server.client.response_code, 200) self.assertEqual( self.server.client.additional_headers["X-RateLimit-Limit"], str(self.db.config['WEB_API_CALLS_PER_INTERVAL'])) self.assertEqual( self.server.client.additional_headers["X-RateLimit-Limit-Period"], str(self.db.config['WEB_API_INTERVAL_IN_SEC'])) self.assertEqual( self.server.client.additional_headers["X-RateLimit-Remaining"], '0') self.assertFalse("Retry-After" in self.server.client.additional_headers) # we still need to wait a minute for everything to clear self.assertAlmostEqual( float(self.server.client.additional_headers["X-RateLimit-Reset"]), 59, delta=5) # and make sure we need to wait another three seconds # as we consumed the last api call results = self.server.dispatch('GET', "/rest/data/user/%s/realname"%self.joeid, self.empty_form) self.assertEqual(self.server.client.response_code, 429) self.assertEqual( str(self.server.client.additional_headers["Retry-After"]), wait_time_str) # check as string json_dict = json.loads(b2s(results)) self.assertEqual( json_dict['error']['msg'], "Api rate limits exceeded. Please wait: %s seconds." % wait_time_str) # reset rest params self.db.config['WEB_API_CALLS_PER_INTERVAL'] = 0 self.db.config['WEB_API_INTERVAL_IN_SEC'] = 3600 def testEtagGeneration(self): ''' Make sure etag generation is stable This mocks date.Date() when creating the target to be etagged. Differing dates make this test impossible. ''' from roundup import date originalDate = date.Date dummy=date.Date('2000-06-26.00:34:02.0') # is a closure the best way to return a static Date object?? def dummyDate(adate=None): def dummyClosure(adate=None, translator=None): return dummy return dummyClosure date.Date = dummyDate() try: newuser = self.db.user.create( username='john', password=password.Password('random1', scheme='plaintext'), address='random1@home.org', realname='JohnRandom', roles='User,Admin' ) # verify etag matches what we calculated in the past node = self.db.user.getnode(newuser) etag = calculate_etag(node, self.db.config['WEB_SECRET_KEY']) items = node.items(protected=True) # include every item print(repr(sorted(items))) print(etag) self.assertEqual(etag, '"07c3a7f214d394cf46220e294a5a53c8"') # modify key and verify we have a different etag etag = calculate_etag(node, self.db.config['WEB_SECRET_KEY'] + "a") items = node.items(protected=True) # include every item print(repr(sorted(items))) print(etag) self.assertNotEqual(etag, '"07c3a7f214d394cf46220e294a5a53c8"') # change data and verify we have a different etag node.username="Paul" etag = calculate_etag(node, self.db.config['WEB_SECRET_KEY']) items = node.items(protected=True) # include every item print(repr(sorted(items))) print(etag) self.assertEqual(etag, '"d655801d3a6d51e32891531b06ccecfa"') finally: date.Date = originalDate def testEtagProcessing(self): ''' Etags can come from two places: If-Match http header @etags value posted in the form Both will be checked if availble. If either one fails, the etag check will fail. Run over header only, etag in form only, both, each one broke and no etag. Use the put command to trigger the etag checking code. ''' for mode in ('header', 'header-gzip', 'etag', 'etag-br', 'both', 'brokenheader', 'brokenetag', 'none'): try: # clean up any old header del(self.headers) except AttributeError: pass form = cgi.FieldStorage() etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('data', 'Joe Doe Doe'), ] if mode == 'header': print("Mode = %s"%mode) self.headers = {'if-match': etag} elif mode == 'header-gzip': print("Mode = %s"%mode) gzip_etag = etag[:-1] + "-gzip" + etag[-1:] self.headers = {'if-match': gzip_etag} elif mode == 'etag': print("Mode = %s"%mode) form.list.append(cgi.MiniFieldStorage('@etag', etag)) elif mode == 'etag-br': print("Mode = %s"%mode) br_etag = etag[:-1] + "-br" + etag[-1:] form.list.append(cgi.MiniFieldStorage('@etag', br_etag)) elif mode == 'both': print("Mode = %s"%mode) self.headers = {'etag': etag} form.list.append(cgi.MiniFieldStorage('@etag', etag)) elif mode == 'brokenheader': print("Mode = %s"%mode) self.headers = {'if-match': 'bad'} form.list.append(cgi.MiniFieldStorage('@etag', etag)) elif mode == 'brokenetag': print("Mode = %s"%mode) self.headers = {'if-match': etag} form.list.append(cgi.MiniFieldStorage('@etag', 'bad')) elif mode == 'none': print( "Mode = %s"%mode) else: self.fail("unknown mode '%s' found"%mode) results = self.server.put_attribute( 'user', self.joeid, 'realname', form ) if mode not in ('brokenheader', 'brokenetag', 'none'): self.assertEqual(self.dummy_client.response_code, 200) else: self.assertEqual(self.dummy_client.response_code, 412) def testBinaryFieldStorage(self): ''' attempt to exercise all paths in the BinaryFieldStorage class ''' expected={ "data": { "link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/1", "id": "1" } } body=b'{ "title": "Joe Doe has problems", \ "nosy": [ "1", "3" ], \ "assignedto": "2", \ "abool": true, \ "afloat": 2.3, \ "anint": 567890 \ }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/json; version=1", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue", form) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict,expected) def testDispatchGet(self): self.create_sampledata() form = cgi.FieldStorage() self.server.client.request.headers.get=self.get_header for item in [ "55", "issue1", "1" ]: print("test item: '%s'" % item) results = self.server.dispatch("GET", "/rest/data/issue/%s" % item, form) json_dict = json.loads(b2s(results)) try: self.assertEqual(json_dict['error']['status'], 404) except KeyError as e: if e.args[0] == "error" and item == "1": pass else: self.assertTrue(False) def testDispatchPost(self): """ run POST through rest dispatch(). This also tests sending json payload through code as dispatch is the code that changes json payload into something we can process. """ # TEST #0 # POST: issue make joe assignee and admin and demo as # nosy # simulate: /rest/data/issue body=b'{ "title": "Joe Doe has problems", \ "nosy": [ "1", "3" ], \ "assignedto": "2", \ "abool": true, \ "afloat": 2.3, \ "anint": 567890 \ }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/json; version=1", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue", form) print(results) self.assertEqual(self.server.client.response_code, 201) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['data']['link'], "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/1") self.assertEqual(json_dict['data']['id'], "1") self.server.client.env.update({'REQUEST_METHOD': 'GET'}) results = self.server.dispatch('GET', "/rest/data/issue/1", self.empty_form) print(results) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['data']['link'], "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/1") self.assertEqual(json_dict['data']['attributes']['abool'], True) self.assertEqual(json_dict['data']['attributes']['afloat'], 2.3) self.assertEqual(json_dict['data']['attributes']['anint'], 567890) self.assertEqual(len(json_dict['data']['attributes']['nosy']), 3) self.assertEqual(json_dict['data']['attributes']\ ['assignedto']['link'], "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user/2") def testDispatchDelete(self): """ run Delete through rest dispatch(). """ # TEST #0 # Delete class raises unauthorized error # simulate: /rest/data/issue env = { "REQUEST_METHOD": "DELETE" } self.server.client.env.update(env) headers={"accept": "application/json; version=1", } self.headers=headers self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue", self.empty_form) print(results) self.assertEqual(self.server.client.response_code, 403) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['error']['msg'], "Deletion of a whole class disabled") def testDispatchBadContent(self): """ runthrough rest dispatch() with bad content_type patterns. """ # simulate: /rest/data/issue body=b'{ "title": "Joe Doe has problems", \ "nosy": [ "1", "3" ], \ "assignedto": "2", \ "abool": true, \ "afloat": 2.3, \ "anint": 567890 \ }' env = { "CONTENT_TYPE": "application/jzot", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/json; version=1", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue", form) print(results) self.assertEqual(self.server.client.response_code, 415) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['error']['msg'], "Unable to process input of type application/jzot") self.assertNotIn("Accept-Patch", self.server.client.additional_headers) self.server.client.additional_headers = {} # test with PATCH verb to verify Accept-Patch is correct results = self.server.dispatch("PATCH", "/rest/data/issue", form) self.assertEqual(self.server.client.response_code, 415) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['error']['msg'], "Unable to process input of type application/jzot") self.assertIn("Accept-Patch", self.server.client.additional_headers) self.assertEqual(self.server.client.additional_headers["Accept-Patch"], "application/json, application/x-www-form-urlencoded" ) self.server.client.additional_headers = {} # Test GET as well. I am not sure if this should pass or not. # Arguably GET doesn't use any form/json input but.... results = self.server.dispatch('GET', "/rest/data/issue", form) print(results) self.assertEqual(self.server.client.response_code, 415) self.assertNotIn("Accept-Patch", self.server.client.additional_headers) self.server.client.additional_headers = {} def testdetermine_output_formatBadAccept(self): dof = self.server.determine_output_format # simulate: /rest/data/issue expect failure unknown accept settings body=b'{ "title": "Joe Doe has problems", \ "nosy": [ "1", "3" ], \ "assignedto": "2", \ "abool": true, \ "afloat": 2.3, \ "anint": 567890 \ }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/zot; version=1; q=0.5", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header (output_type, uri, error) = dof("/rest/data/issue") self.assertEqual(self.server.client.response_code, 406) self.assertIn(b"Requested content type(s) 'application/zot; version=1; q=0.5' not available.\nAcceptable mime types are: */*, application/json", s2b(error['error']['msg'])) # simulate: /rest/data/issue works, multiple acceptable output, one # is valid self.server.client.response_code = "" env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/zot; version=1; q=0.75, " "application/json; version=1; q=0.5", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header (output_type, uri, error) = dof("/rest/data/issue") self.assertEqual(self.server.client.response_code, "") self.assertEqual(output_type, "json") self.assertEqual(uri, "/rest/data/issue") self.assertEqual(error, None) # test 3 accept is empty. This triggers */* so passes self.server.client.response_code = "" headers={"accept": "", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header (output_type, uri, error) = dof("/rest/data/issue") self.assertEqual(self.server.client.response_code, "") self.assertEqual(output_type, "json") self.assertEqual(uri, "/rest/data/issue") self.assertEqual(error, None) # test 4 accept is random junk. headers={"accept": "Xyzzy I am not a mime, type;", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header (output_type, uri, error) = dof("/rest/data/issue") self.assertEqual(self.server.client.response_code, 400) self.assertEqual(output_type, None) self.assertEqual(uri, "/rest/data/issue") self.assertIn('Unable to parse Accept Header. Invalid media type: Xyzzy I am not a mime. Acceptable types: */*, application/json', error['error']['msg']) # test 5 accept mimetype is ok, param is not headers={"accept": "*/*; foo", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header (output_type, uri, error) = dof("/rest/data/issue") self.assertEqual(self.server.client.response_code, 400) self.assertEqual(output_type, None) self.assertEqual(uri, "/rest/data/issue") self.assertIn('Unable to parse Accept Header. Invalid param: foo. Acceptable types: */*, application/json', error['error']['msg']) # test 6: test paths: # test_suite = [ (# use binary_content on a class that doesn't support it {"path": "/rest/data/issue/1/binary_content", "accept": "", "response_code": "", "output_type": None, "uri": "/rest/data/issue/1/binary_content", "error": None }), (# use invalid class {"path": "/rest/data/notissue/1/binary_content", "accept": "", "response_code": "", "output_type": None, "uri": "/rest/data/notissue/1/binary_content", "error": None }), (# use invalid id {"path": "/rest/data/issue/99/binary_content", "accept": "", "response_code": "", "output_type": None, "uri": "/rest/data/issue/99/binary_content", "error": None }), ] for test in test_suite: self.server.client.response_code = "" env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "GET" } self.server.client.env.update(env) headers={"accept": test["accept"] or "application/zot; version=1; q=0.75, " "application/json; version=1; q=0.5", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage( body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header (output_type, uri, error) = dof(test["path"]) self.assertEqual(self.server.client.response_code, test["response_code"]) self.assertEqual(output_type, test["output_type"]) self.assertEqual(uri, test["uri"]) self.assertEqual(error, test["error"]) # test 7: test paths: # test_suite = [ (# use wildcard accept on item and get back json output {"path": "/rest/data/file/1", "accept": "*/*", "response_code": "", "output_type": "json", "uri": "/rest/data/file/1", "error": None, "has_nosniff": False, }), (# use wildcard accept and get back file's actual mime type {"path": "/rest/data/file/1/binary_content", "accept": "*/*", "response_code": "", "output_type": "image/png", "uri": "/rest/data/file/1/binary_content", "error": None, "has_nosniff": True, }), (# use json accept and get back json {"path": "/rest/data/file/1/binary_content", "accept": "application/json", "response_code": "", "output_type": "json", "uri": "/rest/data/file/1/binary_content", "error": None, "has_nosniff": False, }), (# use json accept with invalid number version and get back error {"path": "/rest/data/file/1/binary_content", "accept": "application/json; q=0.5; version=22", "response_code": 406, "output_type": None, "uri": "/rest/data/file/1/binary_content", "error": {'error': {'status': 406, 'msg': 'Unrecognized api version: 22. See /rest without specifying api version for supported versions.'}}, "has_nosniff": False, }), (# use json accept with invalid string version and get back error {"path": "/rest/data/file/1/binary_content", "accept": "application/json; q=0.5; version=z", "response_code": 406, "output_type": None, "uri": "/rest/data/file/1/binary_content", "error": {'error': {'status': 406, 'msg': 'Unrecognized api version: z. See /rest without specifying api version for supported versions.'}}, "has_nosniff": False, }), (# use octet-stream accept and get back octet-stream mime type {"path": "/rest/data/file/1/binary_content", "accept": "application/octet-stream; q=0.9, */*; q=0.5", "response_code": "", "output_type": "application/octet-stream", "uri": "/rest/data/file/1/binary_content", "error": None, "has_nosniff": True, }), (# use image/png accept and get back image/png mime type {"path": "/rest/data/file/1/binary_content", "accept": "application/octet-stream; q=0.9, image/png", "response_code": "", "output_type": "image/png", "uri": "/rest/data/file/1/binary_content", "error": None, "has_nosniff": True, }), (# use invalid accept and get back error {"path": "/rest/data/file/1/binary_content", "accept": "image/svg+html", "response_code": 406, "output_type": None, "uri": "/rest/data/file/1/binary_content", "error": {'error': {'status': 406, 'msg': "Requested content type(s) 'image/svg+html' not available.\nAcceptable mime types are: */*, application/octet-stream, image/png"}}, "has_nosniff": False, }), (# use wildcard accept and get back msg's actual mime type {"path": "/rest/data/msg/1/binary_content", "accept": "*/*", "response_code": "", "output_type": "text/markdown", "uri": "/rest/data/msg/1/binary_content", "error": None, "has_nosniff": True, }), (# use octet-stream accept and get back octet-stream mime type {"path": "/rest/data/msg/1/binary_content", "accept": "application/octet-stream; q=0.9, */*; q=0.5", "response_code": "", "output_type": "application/octet-stream", "uri": "/rest/data/msg/1/binary_content", "error": None, "has_nosniff": True, }), (# use wildcard text accept and get back msg's actual mime type {"path": "/rest/data/msg/1/binary_content", "accept": "text/*", "response_code": "", "output_type": "text/markdown", "uri": "/rest/data/msg/1/binary_content", "error": None, "has_nosniff": True, }), (# use wildcard text accept and get back file's actual mime type {"path": "/rest/data/msg/1/binary_content", "accept": "text/markdown", "response_code": "", "output_type": "text/markdown", "uri": "/rest/data/msg/1/binary_content", "error": None, "has_nosniff": True, }), (# use text/plain accept and get back test/plain {"path": "/rest/data/msg/1/binary_content", "accept": "text/plain", "response_code": 406, "output_type": None, "uri": "/rest/data/msg/1/binary_content", "error": {'error': {'status': 406, 'msg': "Requested content type(s) 'text/plain' not available.\nAcceptable mime types are: */*, application/octet-stream, text/*, text/markdown"}}, "has_nosniff": False, }), (# use wildcard accept and get back default msg mime type {"path": "/rest/data/msg/2/binary_content", "accept": "*/*", "response_code": "", "output_type": "text/*", "uri": "/rest/data/msg/2/binary_content", "error": None, "has_nosniff": True, }), (# use text/* and get back text/* {"path": "/rest/data/msg/2/binary_content", "accept": "text/*", "response_code": "", "output_type": "text/*", "uri": "/rest/data/msg/2/binary_content", "error": None, "has_nosniff": True, }), (# use text/markdown and get back error {"path": "/rest/data/msg/2/binary_content", "accept": "text/markdown", "response_code": 406, "output_type": None, "uri": "/rest/data/msg/2/binary_content", "error": {'error': {'status': 406, 'msg': "Requested content type(s) 'text/markdown' not available.\nAcceptable mime types are: */*, application/octet-stream, text/*"}}, "has_nosniff": False, }), (# use error accept and get back error {"path": "/rest/data/msg/1/binary_content", "accept": "text/markdown, q=2", "response_code": 400, "output_type": None, "uri": "/rest/data/msg/1/binary_content", "error": {'error': {'status': 400, 'msg': 'Unable to parse Accept Header. Invalid media type: q=2. Acceptable types: */*, application/json'}}, "has_nosniff": False, }), (# use text/* but override with extension of .json get back json {"path": "/rest/data/msg/2/binary_content.json", "accept": "text/*", "response_code": "", "output_type": "json", "uri": "/rest/data/msg/2/binary_content", "error": None, "has_nosniff": False, }), (# use text/* but override with extension of .jon get back error {"path": "/rest/data/msg/2/binary_content.jon", "accept": "text/*", "response_code": 406, "output_type": None, "uri": "/rest/data/msg/2/binary_content.jon", "error": {'error': {'status': 406, 'msg': "Content type 'jon' requested in URL is not available.\nAcceptable types: json\n"}}, "has_nosniff": False, }), ] for test in test_suite: print(test) self.server.client.response_code = "" self.server.client.additional_headers = {} env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "GET" } self.server.client.env.update(env) headers={"accept": test["accept"] or "application/zot; version=1; q=0.75, " "application/json; version=1; q=0.5", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage( body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header (output_type, uri, error) = dof(test["path"]) self.assertEqual(self.server.client.response_code, test["response_code"]) self.assertEqual(output_type, test["output_type"]) self.assertEqual(uri, test["uri"]) print(error) self.assertEqual(error, test["error"]) if test["has_nosniff"]: self.assertIn("X-Content-Type-Options", self.server.client.additional_headers) self.assertEqual("nosniff", self.server.client.additional_headers['X-Content-Type-Options']) else: self.assertNotIn("X-Content-Type-Options", self.server.client.additional_headers) def testBadFormAttributeErrorException(self): env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } with self._caplog.at_level(logging.ERROR, logger="roundup"): with self.assertRaises(AttributeError) as exc: self.dummy_client = client.Client( self.instance, MockNull(), env, [], None) self.assertEqual(exc.exception.args[0], "'list' object has no attribute 'list'") # log should look like (with string not broken into parts): # [('roundup', 40, # 'Invalid self.form found (please report to the ' # 'roundup-users mailing list): []')] log = self._caplog.record_tuples[:] self.assertIn("Invalid self.form found", log[0][2]) def testDispatchBadAccept(self): # simulate: /rest/data/issue expect failure unknown accept settings body=b'{ "title": "Joe Doe has problems", \ "nosy": [ "1", "3" ], \ "assignedto": "2", \ "abool": true, \ "afloat": 2.3, \ "anint": 567890 \ }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/zot; version=1; q=0.5", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue", form) print(results) json_dict = json.loads(b2s(results)) self.assertEqual(self.server.client.response_code, 406) self.assertIn("Requested content type(s) 'application/zot; version=1; q=0.5' not available.\nAcceptable mime types are: */*, application/json", json_dict['error']['msg']) # simulate: /rest/data/issue works, multiple acceptable output, one # is valid env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/zot; version=1; q=0.75, " "application/json; version=1; q=0.5", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue", form) print(results) self.assertEqual(self.server.client.response_code, 201) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['data']['id'], "1") # test 3 accept is empty. This triggers */* so passes headers={"accept": "", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue", form) print(results) self.assertEqual(self.server.client.response_code, 201) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['data']['id'], "2") # test 4 accept is random junk. headers={"accept": "Xyzzy I am not a mime, type;", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue", form) print(results) self.assertEqual(self.server.client.response_code, 400) json_dict = json.loads(b2s(results)) self.assertIn('Unable to parse Accept Header. Invalid media type: Xyzzy I am not a mime. Acceptable types: */*, application/json', json_dict['error']['msg']) # test 5 accept mimetype is ok, param is not headers={"accept": "*/*; foo", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue", form) print(results) self.assertEqual(self.server.client.response_code, 400) json_dict = json.loads(b2s(results)) self.assertIn('Unable to parse Accept Header. Invalid param: foo. Acceptable types: */*, application/json', json_dict['error']['msg']) @skip_on_py2 def testBadJson(self): '''Run some JSON we don't accept through the wringer ''' body=b'{ "title": "Joe Doe has problems", \ "nosy": [ "1", "3" ], \ "assignedto": "2", \ "abool": true, \ "afloat": 2.3, \ "anint": Infinity }' expected={ "error": {"status": 400, "msg": ("Unacceptable number: Infinity. JSON is: " + b2s(body)), } } env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "PUT" } self.server.client.env.update(env) headers={"accept": "application/zot; version=1; q=0.5", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue/1", form) self.assertEqual(json.loads(results), expected) body=b'{ "title": "Joe Doe has problems", \ nosy: [ "1", "3" ], \ "assignedto": "2", \ "abool": true, \ "afloat": 2.3, \ "anint": Infinity }' self.maxDiff = None expected={ "error": {"status": 400, "msg": ("Expecting property name enclosed in double " "quotes: line 1 column 53 (char 52). JSON is: " + b2s(body)), } } env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "PUT" } self.server.client.env.update(env) headers={"accept": "application/zot; version=1; q=0.5", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch(env["REQUEST_METHOD"], "/rest/data/issue/1", form) self.assertEqual(json.loads(results), expected) def testStatsGen(self): # check stats being returned by put and get ops # using dispatch which parses the @stats query param # find correct py2/py3 list comparison ignoring order try: list_test = self.assertCountEqual # py3 except AttributeError: list_test = self.assertItemsEqual # py2.7+ # get stats form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@stats', 'True'), ] results = self.server.dispatch('GET', "/rest/data/user/1/realname", form) self.assertEqual(self.dummy_client.response_code, 200) json_dict = json.loads(b2s(results)) # check that @stats are defined self.assertTrue( '@stats' in json_dict['data'] ) # check that the keys are present # not validating values as that changes valid_fields= [ us2u('elapsed'), us2u('cache_hits'), us2u('cache_misses'), us2u('get_items'), us2u('filtering') ] list_test(valid_fields,json_dict['data']['@stats'].keys()) # Make sure false value works to suppress @stats form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@stats', 'False'), ] self.server.client.env.update({'REQUEST_METHOD': 'GET'}) results = self.server.dispatch('GET', "/rest/data/user/1/realname", form) self.assertEqual(self.dummy_client.response_code, 200) json_dict = json.loads(b2s(results)) print(results) # check that @stats are not defined self.assertTrue( '@stats' not in json_dict['data'] ) # Make sure non-true value works to suppress @stats # false will always work form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@stats', 'random'), ] results = self.server.dispatch('GET', "/rest/data/user/1/realname", form) self.assertEqual(self.dummy_client.response_code, 200) json_dict = json.loads(b2s(results)) print(results) # check that @stats are not defined self.assertTrue( '@stats' not in json_dict['data'] ) # if @stats is not defined there should be no stats results = self.server.dispatch('GET', "/rest/data/user/1/realname", self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) json_dict = json.loads(b2s(results)) # check that @stats are not defined self.assertTrue( '@stats' not in json_dict['data'] ) # change admin's realname via a normal web form # This generates a FieldStorage that looks like: # FieldStorage(None, None, []) # use etag from header # # Also use GET on the uri via the dispatch to retrieve # the results from the db. etag = calculate_etag(self.db.user.getnode('1'), self.db.config['WEB_SECRET_KEY']) headers={"if-match": etag, "accept": "application/vnd.json.test-v1+json", } form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('data', 'Joe Doe'), cgi.MiniFieldStorage('@apiver', '1'), cgi.MiniFieldStorage('@stats', 'true'), ] self.headers = headers self.server.client.request.headers.get = self.get_header self.db.setCurrentUser('admin') # must be admin to change user self.server.client.env.update({'REQUEST_METHOD': 'PUT'}) results = self.server.dispatch('PUT', "/rest/data/user/1/realname", form) self.assertEqual(self.dummy_client.response_code, 200) json_dict = json.loads(b2s(results)) list_test(valid_fields,json_dict['data']['@stats'].keys()) def testDispatch(self): """ run changes through rest dispatch(). This also tests sending json payload through code as dispatch is the code that changes json payload into something we can process. """ # TEST #1 # PUT: joe's 'realname' using json data. # simulate: /rest/data/user//realname # use etag in header etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) body=b'{ "data": "Joe Doe 1" }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "PUT", "HTTP_ORIGIN": "https://invalid.origin" } self.server.client.env.update(env) headers={"accept": "application/json; version=1", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], "if-match": etag } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('PUT', "/rest/data/user/%s/realname"%self.joeid, form) # invalid origin, no credentials allowed. self.assertNotIn("Access-Control-Allow-Credentials", self.server.client.additional_headers) self.assertEqual(self.server.client.response_code, 200) results = self.server.get_element('user', self.joeid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['realname'], 'Joe Doe 1') # substitute the version with an unacceptable version # and verify it returns 400 code. self.headers["accept"] = "application/json; version=1.1" body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('PUT', "/rest/data/user/%s/realname"%self.joeid, form) self.assertEqual(self.server.client.response_code, 406) del(self.headers) # TEST #2 # Set joe's 'realname' using json data. # simulate: /rest/data/user//realname # use etag in payload etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) etagb = etag.strip ('"') body=s2b('{ "@etag": "\\"%s\\"", "data": "Joe Doe 2" }'%etagb) env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "PUT", } self.headers=None # have FieldStorage get len from env. body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=None, environ=env) self.server.client.request.headers.get=self.get_header headers={"accept": "application/json", "content-type": env['CONTENT_TYPE'], "if-match": etag } self.headers=headers # set for dispatch results = self.server.dispatch('PUT', "/rest/data/user/%s/realname"%self.joeid, form) self.assertEqual(self.server.client.response_code, 200) results = self.server.get_element('user', self.joeid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['realname'], 'Joe Doe 2') del(self.headers) # TEST #3 # change Joe's realname via a normal web form # This generates a FieldStorage that looks like: # FieldStorage(None, None, []) # use etag from header # # Also use GET on the uri via the dispatch to retrieve # the results from the db. etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) headers={"if-match": etag, "accept": "application/vnd.json.test-v1+json", } form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('data', 'Joe Doe'), cgi.MiniFieldStorage('@apiver', '1'), ] self.headers = headers self.server.client.request.headers.get = self.get_header results = self.server.dispatch('PUT', "/rest/data/user/%s/realname"%self.joeid, form) self.assertEqual(self.dummy_client.response_code, 200) self.server.client.env.update({'REQUEST_METHOD': "GET"}) results = self.server.dispatch('GET', "/rest/data/user/%s/realname"%self.joeid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['data']['data'], 'Joe Doe') self.assertEqual(json_dict['data']['link'], "http://tracker.example/cgi-bin/" "roundup.cgi/bugs/rest/data/user/3/realname") self.assertIn(json_dict['data']['type'], ("", "")) self.assertEqual(json_dict['data']["id"], "3") del(self.headers) # TEST #4 # PATCH: joe's email address with json # save address so we can use it later stored_results = self.server.get_element('user', self.joeid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) etagb = etag.strip ('"') body=s2b('{ "address": "demo2@example.com", "@etag": "\\"%s\\""}'%etagb) env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "PATCH" } self.server.client.env.update(env) headers={"accept": "application/json", "content-type": env['CONTENT_TYPE'], "content-length": len(body) } self.headers=headers body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('PATCH', "/rest/data/user/%s"%self.joeid, form) self.assertEqual(self.server.client.response_code, 200) results = self.server.get_element('user', self.joeid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['address'], 'demo2@example.com') # and set it back reusing env and headers from last test etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) etagb = etag.strip ('"') body=s2b('{ "address": "%s", "@etag": "\\"%s\\""}'%( stored_results['data']['attributes']['address'], etagb)) # reuse env and headers from prior test. body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('PATCH', "/rest/data/user/%s"%self.joeid, form) self.assertEqual(self.server.client.response_code, 200) results = self.server.get_element('user', self.joeid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['address'], 'random@home.org') del(self.headers) # TEST #5 # POST: create new issue # no etag needed etag = "not needed" body=b'{ "title": "foo bar", "priority": "critical" }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/json", "content-type": env['CONTENT_TYPE'], "content-length": len(body) } self.headers=headers body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', "/rest/data/issue", form) self.assertEqual(self.server.client.response_code, 201) json_dict = json.loads(b2s(results)) issue_id=json_dict['data']['id'] results = self.server.get_element('issue', str(issue_id), # must be a string not unicode self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['title'], 'foo bar') # TEST #6 # POST: an invalid class # no etag needed etag = "not needed" body=b'{ "title": "foo bar", "priority": "critical" }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/json", "content-type": env['CONTENT_TYPE'], "content-length": len(body) } self.headers=headers body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', "/rest/data/nonissue", form) self.assertEqual(self.server.client.response_code, 404) json_dict = json.loads(b2s(results)) status=json_dict['error']['status'] msg=json_dict['error']['msg'] self.assertEqual(status, 404) self.assertEqual(msg, 'Class nonissue not found') # TEST #7 # POST: status without key field of name # also test that version spec in accept header is accepted # no etag needed etag = "not needed" body=b'{ "order": 5 }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/json; version=1", "content-type": env['CONTENT_TYPE'], "content-length": len(body) } self.headers=headers body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header self.db.setCurrentUser('admin') # must be admin to create status results = self.server.dispatch('POST', "/rest/data/status", form) self.server.client.env.update(env) self.assertEqual(self.server.client.response_code, 400) json_dict = json.loads(b2s(results)) status=json_dict['error']['status'] msg=json_dict['error']['msg'] self.assertEqual(status, 400) self.assertEqual(msg, "Must provide the 'name' property.") # TEST #8 # DELETE: delete issue 1 also test return type by extension # test bogus extension as well. etag = calculate_etag(self.db.issue.getnode("1"), self.db.config['WEB_SECRET_KEY']) etagb = etag.strip ('"') env = {"REQUEST_METHOD": "DELETE" } self.server.client.env.update(env) # use text/plain header and request json output by appending # .json to the url. headers={"accept": "text/plain", "if-match": '"%s"'%etagb, "content-length": 0, } self.headers=headers self.server.client.request.headers.get=self.get_header self.db.setCurrentUser('admin') # must be admin to delete issue results = self.server.dispatch('DELETE', "/rest/data/issue/1.json", self.empty_form) self.assertEqual(self.server.client.response_code, 200) print(results) json_dict = json.loads(b2s(results)) status=json_dict['data']['status'] self.assertEqual(status, 'ok') self.server.client.env.update({'REQUEST_METHOD': 'GET'}) results = self.server.dispatch('GET', "/rest/data/issuetitle:=asdf.jon", form) self.assertEqual(self.server.client.response_code, 406) print(results) try: # only verify local copy not system installed copy from roundup.dicttoxml import dicttoxml includexml = ', xml' except ImportError: includexml = '' json_dict = json.loads(b2s(results)) response= ("Content type 'jon' requested in URL is not available.\n" "Acceptable types: json%s\n") % includexml self.assertEqual(json_dict['error']['msg'], response) # TEST #9 # GET: test that version can be set with accept: # ... ; version=z # or # application/vnd.x.y-vz+json # or # @apiver # simulate: /rest/data/issue form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@apiver', 'L'), ] self.server.client.env.update({'REQUEST_METHOD': 'GET'}) headers={"accept": "application/json; notversion=z" } self.headers=headers self.server.client.request.headers.get=self.get_header results = self.server.dispatch('GET', "/rest/data/issue/1", form) print("9a: " + b2s(results)) json_dict = json.loads(b2s(results)) # note bad @apiver returns 400 not 406. self.assertEqual(json_dict['error']['status'], 406) self.assertEqual(json_dict['error']['msg'], "Unrecognized api version: L. See /rest without " "specifying api version for supported versions.") headers={"accept": "application/json; version=z" } self.headers=headers self.server.client.request.headers.get=self.get_header results = self.server.dispatch('GET', "/rest/data/issue/1", form) print("9b: " + b2s(results)) json_dict = json.loads(b2s(results)) self.assertEqual(self.server.client.response_code, 406) self.assertEqual(json_dict['error']['status'], 406) self.assertEqual(json_dict['error']['msg'], "Unrecognized api version: z. See /rest without " "specifying api version for supported versions.") headers={"accept": "application/vnd.roundup.test-vz+json" } self.headers=headers self.server.client.request.headers.get=self.get_header results = self.server.dispatch('GET', "/rest/data/issue/1", self.empty_form) print("9c:" + b2s(results)) self.assertEqual(self.server.client.response_code, 406) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['error']['status'], 406) self.assertEqual(json_dict['error']['msg'], "Unrecognized api version: z. See /rest without " "specifying api version for supported versions.") # verify that version priority is correct; should be version=... headers={"accept": "application/vnd.roundup.test-vz+json; version=a" } self.headers=headers self.server.client.request.headers.get=self.get_header results = self.server.dispatch('GET', "/rest/data/issue/1", self.empty_form) print("9d: " + b2s(results)) self.assertEqual(self.server.client.response_code, 406) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['error']['status'], 406) self.assertEqual(json_dict['error']['msg'], "Unrecognized api version: a. See /rest without " "specifying api version for supported versions.") # TEST #10 # check /rest and /rest/summary and /rest/notthere expected_rest = { "data": { "supported_versions": [ 1 ], "default_version": 1, "links": [ { "rel": "self", "uri": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest" }, { "rel": "data", "uri": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data" }, { "rel": "summary", "uri": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/summary" } ] } } self.headers={} results = self.server.dispatch('GET', "/rest", self.empty_form) print("10a: " + b2s(results)) self.assertEqual(self.server.client.response_code, 200) results_dict = json.loads(b2s(results)) self.assertEqual(results_dict, expected_rest) results = self.server.dispatch('GET', "/rest/", self.empty_form) print("10b: " + b2s(results)) self.assertEqual(self.server.client.response_code, 200) results_dict = json.loads(b2s(results)) self.assertEqual(results_dict, expected_rest) results = self.server.dispatch('GET', "/rest/summary", self.empty_form) print("10c: " + b2s(results)) self.assertEqual(self.server.client.response_code, 200) results = self.server.dispatch('GET', "/rest/summary/", self.empty_form) print("10d: " + b2s(results)) self.assertEqual(self.server.client.response_code, 200) expected_data = { "data": { "issue": { "link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue" }, "priority": { "link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/priority" }, "user": { "link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/user" }, "query": { "link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/query" }, "status": { "link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/status" }, "keyword": { "link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/keyword" }, "msg": { "link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/msg" }, "file": { "link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/file" } } } results = self.server.dispatch('GET', "/rest/data", self.empty_form) print("10e: " + b2s(results)) self.assertEqual(self.server.client.response_code, 200) results_dict = json.loads(b2s(results)) self.assertEqual(results_dict, expected_data) results = self.server.dispatch('GET', "/rest/data/", self.empty_form) print("10f: " + b2s(results)) self.assertEqual(self.server.client.response_code, 200) results_dict = json.loads(b2s(results)) self.assertEqual(results_dict, expected_data) results = self.server.dispatch('GET', "/rest/notthere", self.empty_form) self.assertEqual(self.server.client.response_code, 404) results = self.server.dispatch('GET', "/rest/notthere/", self.empty_form) self.assertEqual(self.server.client.response_code, 404) del(self.headers) # TEST #11 # GET: test that /binary_content can be downloaded form = cgi.FieldStorage() self.server.client.env.update({'REQUEST_METHOD': 'GET'}) headers={"accept": "*/*" } self.headers=headers self.server.client.request.headers.get=self.get_header results = self.server.dispatch('GET', "/rest/data/file/1/binary_content", form) self.assertEqual(results, b'PNG\x01abcdefghi\njklmnop') self.assertEqual(self.server.client.additional_headers['Content-Type'], 'image/png') self.assertNotIn("ETag", self.server.client.additional_headers) self.assertEqual( self.server.client.additional_headers["X-Content-Type-Options"], "nosniff") print("11: " + b2s(results)) def testAcceptHeaderParsing(self): self.server.client.env['REQUEST_METHOD'] = 'GET' # TEST #1 # json highest priority self.server.client.request.headers.get=self.get_header headers={"accept": "application/json; version=1," "application/xml; q=0.5; version=2," "text/plain; q=0.75; version=2" } self.headers=headers results = self.server.dispatch('GET', "/rest/data/status/1", self.empty_form) print(results) self.assertEqual(self.server.client.response_code, 200) self.assertEqual(self.server.client.additional_headers['Content-Type'], "application/json") # TEST #2 # text highest priority headers={"accept": "application/json; q=0.5; version=1," "application/xml; q=0.25; version=2," "text/plain; q=1.0; version=3" } self.headers=headers results = self.server.dispatch('GET', "/rest/data/status/1", self.empty_form) print(results) self.assertEqual(self.server.client.response_code, 200) self.assertEqual(self.server.client.additional_headers['Content-Type'], "application/json") # TEST #3 # no acceptable type headers={"accept": "text/plain; q=1.0; version=2" } self.headers=headers results = self.server.dispatch('GET', "/rest/data/status/1", self.empty_form) print(results) self.assertEqual(self.server.client.response_code, 406) self.assertEqual(self.server.client.additional_headers['Content-Type'], "application/json") # TEST #4 # no accept header, should use default json headers={} self.headers=headers results = self.server.dispatch('GET', "/rest/data/status/1", self.empty_form) print(results) self.assertEqual(self.server.client.response_code, 200) self.assertEqual(self.server.client.additional_headers['Content-Type'], "application/json") # TEST #5 # wildcard accept header, should use default json headers={ "accept": "*/*"} self.headers=headers results = self.server.dispatch('GET', "/rest/data/status/1", self.empty_form) print(results) self.assertEqual(self.server.client.response_code, 200) self.assertEqual(self.server.client.additional_headers['Content-Type'], "application/json") # TEST #6 # invalid q factor if not ignored/demoted # application/json is selected with invalid version # and errors. # this ends up choosing */* which triggers json. self.server.client.request.headers.get=self.get_header headers={"accept": "application/json; q=1.5; version=99," "*/*; q=0.9; version=1," "text/plain; q=3.75; version=2" } self.headers=headers results = self.server.dispatch('GET', "/rest/data/status/1", self.empty_form) print(results) self.assertEqual(self.server.client.response_code, 200) self.assertEqual(self.server.client.additional_headers['Content-Type'], "application/json") ''' # only works if dicttoxml.py is installed. # not installed for testing # TEST #7 # xml wins headers={"accept": "application/json; q=0.5; version=2," "application/xml; q=0.75; version=1," "text/plain; q=1.0; version=2" } self.headers=headers results = self.server.dispatch('GET', "/rest/data/status/1", self.empty_form) print(results) self.assertEqual(self.server.client.response_code, 200) self.assertEqual(self.server.client.additional_headers['Content-Type'], "application/xml") ''' # TEST #8 # invalid api version # application/json is selected with invalid version self.server.client.request.headers.get=self.get_header headers={"accept": "application/json; version=99" } self.headers=headers results = self.server.dispatch('GET', "/rest/data/status/1", self.empty_form) print(results) json_dict = json.loads(b2s(results)) self.assertEqual(self.server.client.response_code, 406) self.assertEqual(self.server.client.additional_headers['Content-Type'], "application/json") self.assertEqual(json_dict['error']['msg'], "Unrecognized api version: 99. See /rest " "without specifying api version for " "supported versions.") def testMethodOverride(self): # TEST #1 # Use GET, PUT, PATCH to tunnel DELETE expect error body=b'{ "order": 5 }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.request.headers.get=self.get_header for method in ( "GET", "PUT", "PATCH" ): headers={"accept": "application/json; version=1", "content-type": env['CONTENT_TYPE'], "content-length": len(body), "x-http-method-override": "DElETE", } body_file=BytesIO(body) # FieldStorage needs a file self.headers=headers form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.db.setCurrentUser('admin') # must be admin to create status self.server.client.env.update({'REQUEST_METHOD': method}) results = self.server.dispatch(method, "/rest/data/status", form) self.assertEqual(self.server.client.response_code, 400) json_dict = json.loads(b2s(results)) status=json_dict['error']['status'] msg=json_dict['error']['msg'] self.assertEqual(status, 400) self.assertEqual(msg, "X-HTTP-Method-Override: DElETE must be " "used with POST method not %s."%method) # TEST #2 # DELETE: delete issue 1 via post tunnel self.assertFalse(self.db.status.is_retired("1")) etag = calculate_etag(self.db.status.getnode("1"), self.db.config['WEB_SECRET_KEY']) etagb = etag.strip ('"') headers={"accept": "application/json; q=1.0, application/xml; q=0.75", "if-match": '"%s"'%etagb, "content-length": 0, "x-http-method-override": "DElETE" } self.headers=headers body_file=BytesIO(b'') # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header self.db.setCurrentUser('admin') # must be admin to delete issue self.server.client.env.update({'REQUEST_METHOD': 'POST'}) results = self.server.dispatch('POST', "/rest/data/status/1", form) print(results) self.assertEqual(self.server.client.response_code, 200) json_dict = json.loads(b2s(results)) status=json_dict['data']['status'] self.assertEqual(status, 'ok') self.assertTrue(self.db.status.is_retired("1")) def testPostPOE(self): ''' test post once exactly: get POE url, create issue using POE url. Use dispatch entry point. ''' import time # setup environment etag = "not needed" empty_body=b'' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(empty_body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/json", "content-type": env['CONTENT_TYPE'], "content-length": len(empty_body) } self.headers=headers # use empty_body to test code path for missing/empty json body_file=BytesIO(empty_body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) ## Obtain the POE url. self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', "/rest/data/issue/@poe", form) self.assertEqual(self.server.client.response_code, 200) json_dict = json.loads(b2s(results)) url=json_dict['data']['link'] # strip tracker web prefix leaving leading /. url = url[len(self.db.config['TRACKER_WEB'])-1:] ## create an issue using poe url. body=b'{ "title": "foo bar", "priority": "critical" }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "POST" } self.server.client.env.update(env) headers={"accept": "application/json", "content-type": env['CONTENT_TYPE'], "content-length": len(body) } self.headers=headers body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', url, form) self.assertEqual(self.server.client.response_code, 201) json_dict = json.loads(b2s(results)) issue_id=json_dict['data']['id'] results = self.server.get_element('issue', str(issue_id), # must be a string not unicode self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['title'], 'foo bar') ## Reuse POE url. It will fail. self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', url, form) # get the last component stripping the trailing / poe=url[url.rindex('/')+1:] self.assertEqual(self.server.client.response_code, 400) results = json.loads(b2s(results)) self.assertEqual(results['error']['status'], 400) self.assertEqual(results['error']['msg'], "POE token \'%s\' not valid."%poe) ## Try using GET on POE url. Should fail with method not ## allowed (405) self.server.client.env.update({'REQUEST_METHOD': 'GET'}) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('GET', "/rest/data/issue/@poe", form) self.assertEqual(self.server.client.response_code, 405) ## Try creating generic POE url. body_poe=b'{"generic": "null", "lifetime": "100" }' body_file=BytesIO(body_poe) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header self.server.client.env.update({'REQUEST_METHOD': 'POST'}) results = self.server.dispatch('POST', "/rest/data/issue/@poe", form) json_dict = json.loads(b2s(results)) url=json_dict['data']['link'] # strip tracker web prefix leaving leading /. url = url[len(self.db.config['TRACKER_WEB'])-1:] url = url.replace('/issue/', '/keyword/') body_keyword=b'{"name": "keyword"}' body_file=BytesIO(body_keyword) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) results = self.server.dispatch('POST', url, form) self.assertEqual(self.server.client.response_code, 201) json_dict = json.loads(b2s(results)) url=json_dict['data']['link'] id=json_dict['data']['id'] self.assertEqual(id, "1") self.assertEqual(url, "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/keyword/1") ## Create issue POE url and try to use for keyword. ## This should fail. body_poe=b'{"lifetime": "100" }' body_file=BytesIO(body_poe) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', "/rest/data/issue/@poe", form) json_dict = json.loads(b2s(results)) url=json_dict['data']['link'] # strip tracker web prefix leaving leading /. url = url[len(self.db.config['TRACKER_WEB'])-1:] url = url.replace('/issue/', '/keyword/') body_keyword=b'{"name": "keyword"}' body_file=BytesIO(body_keyword) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) results = self.server.dispatch('POST', url, form) poe=url[url.rindex('/')+1:] self.assertEqual(self.server.client.response_code, 400) json_dict = json.loads(b2s(results)) stat=json_dict['error']['status'] msg=json_dict['error']['msg'] self.assertEqual(stat, 400) self.assertEqual(msg, "POE token '%s' not valid for keyword, was generated for class issue"%poe) ## Create POE with 10 minute lifetime and verify ## expires is within 10 minutes. body_poe=b'{"lifetime": "30" }' body_file=BytesIO(body_poe) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', "/rest/data/issue/@poe", form) json_dict = json.loads(b2s(results)) expires=int(json_dict['data']['expires']) # allow up to 3 seconds between time stamp creation # done under dispatch and this point. expected=int(time.time() + 30) print("expected=%d, expires=%d"%(expected,expires)) self.assertTrue((expected - expires) < 3 and (expected - expires) >= 0) ## Use a token created above as joe by a different user. self.db.setCurrentUser('admin') url=json_dict['data']['link'] # strip tracker web prefix leaving leading /. url = url[len(self.db.config['TRACKER_WEB'])-1:] body_file=BytesIO(body_keyword) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) results = self.server.dispatch('POST', url, form) print(results) self.assertEqual(self.server.client.response_code, 400) json_dict = json.loads(b2s(results)) # get the last component stripping the trailing / poe=url[url.rindex('/')+1:] self.assertEqual(json_dict['error']['msg'], "POE token '%s' not valid."%poe) ## Create POE with bogus lifetime body_poe=b'{"lifetime": "10.2" }' body_file=BytesIO(body_poe) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', "/rest/data/issue/@poe", form) self.assertEqual(self.server.client.response_code, 400) print(results) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['error']['msg'], "Value \'lifetime\' must be an integer specify " "lifetime in seconds. Got 10.2.") ## Create POE with lifetime > 1 hour body_poe=b'{"lifetime": "3700" }' body_file=BytesIO(body_poe) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', "/rest/data/issue/@poe", form) self.assertEqual(self.server.client.response_code, 400) print(results) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['error']['msg'], "Value 'lifetime' must be between 1 second and 1 " "hour (3600 seconds). Got 3700.") ## Create POE with lifetime < 1 second body_poe=b'{"lifetime": "-1" }' body_file=BytesIO(body_poe) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) self.server.client.request.headers.get=self.get_header results = self.server.dispatch('POST', "/rest/data/issue/@poe", form) self.assertEqual(self.server.client.response_code, 400) print(results) json_dict = json.loads(b2s(results)) self.assertEqual(json_dict['error']['msg'], "Value 'lifetime' must be between 1 second and 1 " "hour (3600 seconds). Got -1.") del(self.headers) def testPutElement(self): """ Change joe's 'realname' Check if we can't change admin's detail """ # fail to change Joe's realname via attribute uri # no etag form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('data', 'Joe Doe Doe') ] results = self.server.put_attribute( 'user', self.joeid, 'realname', form ) self.assertEqual(self.dummy_client.response_code, 412) results = self.server.get_attribute( 'user', self.joeid, 'realname', self.empty_form ) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['data'], 'Joe Random') # change Joe's realname via attribute uri - etag in header form = cgi.FieldStorage() etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('data', 'Joe Doe Doe'), ] self.headers = {'if-match': etag } # use etag in header results = self.server.put_attribute( 'user', self.joeid, 'realname', form ) self.assertEqual(self.dummy_client.response_code, 200) results = self.server.get_attribute( 'user', self.joeid, 'realname', self.empty_form ) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['data'], 'Joe Doe Doe') del(self.headers) # Reset joe's 'realname'. etag in body # Also try to set protected items. The protected items should # be ignored on put_element to make it easy to get the item # with all fields, change one field and put the result without # having to filter out protected items. form = cgi.FieldStorage() etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('creator', '3'), cgi.MiniFieldStorage('realname', 'Joe Doe'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.put_element('user', self.joeid, form) self.assertEqual(self.dummy_client.response_code, 200) results = self.server.get_element('user', self.joeid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['realname'], 'Joe Doe') # We are joe, so check we can't change admin's details results = self.server.put_element('user', '1', form) self.assertEqual(self.dummy_client.response_code, 403) self.assertEqual(results['error']['status'], 403) # Try to reset joe's 'realname' and add a broken prop. # This should result in no change to the name and # a 400 UsageError stating prop does not exist. form = cgi.FieldStorage() etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('JustKidding', '3'), cgi.MiniFieldStorage('realname', 'Joe Doe'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.put_element('user', self.joeid, form) expected= {'error': {'status': 400, 'msg': UsageError('Property JustKidding not ' 'found in class user')}} self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 400) results = self.server.get_element('user', self.joeid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['realname'], 'Joe Doe') def testPutAttribute(self): # put protected property # make sure we don't have permission issues self.db.setCurrentUser('admin') form = cgi.FieldStorage() etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('data', '3'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.put_attribute( 'user', self.joeid, 'creator', form ) expected= {'error': {'status': 405, 'msg': AttributeError('\'"creator", "actor", "creation" and ' '"activity" are reserved\'')}} print(results) self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 405) # put invalid property # make sure we don't have permission issues self.db.setCurrentUser('admin') form = cgi.FieldStorage() etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('data', '3'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.put_attribute( 'user', self.joeid, 'youMustBeKiddingMe', form ) expected= {'error': {'status': 400, 'msg': UsageError("'youMustBeKiddingMe' " "is not a property of user")}} print(results) self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 400) def testPost(self): """ Post a new issue with title: foo Verify the information of the created issue """ form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('title', 'foo') ] results = self.server.post_collection('issue', form) self.assertEqual(self.dummy_client.response_code, 201) issueid = results['data']['id'] results = self.server.get_element('issue', issueid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['title'], 'foo') self.assertEqual(self.db.issue.get(issueid, "tx_Source"), 'web') def testPostFile(self): """ Post a new file with content: hello\r\nthere Verify the information of the created file """ form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('content', 'hello\r\nthere') ] results = self.server.post_collection('file', form) self.assertEqual(self.dummy_client.response_code, 201) fileid = results['data']['id'] results = self.server.get_element('file', fileid, self.empty_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertIn("link", results['attributes']['content']) # File content is only shown with verbose=3 form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@verbose', '3'), cgi.MiniFieldStorage('@protected', 'true') ] results = self.server.get_element('file', fileid, form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['attributes']['content'], 'hello\r\nthere') self.assertIn('creator', results['attributes']) # added by @protected self.assertEqual(results['attributes']['creator']['username'], "joe") def testAuthDeniedPut(self): """ Test unauthorized PUT request """ # Wrong permissions (caught by roundup security module). form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('realname', 'someone') ] results = self.server.put_element('user', '1', form) self.assertEqual(self.dummy_client.response_code, 403) self.assertEqual(results['error']['status'], 403) def testAuthDeniedPost(self): """ Test unauthorized POST request """ form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('username', 'blah') ] results = self.server.post_collection('user', form) self.assertEqual(self.dummy_client.response_code, 403) self.assertEqual(results['error']['status'], 403) def testAuthAllowedPut(self): """ Test authorized PUT request """ self.db.setCurrentUser('admin') form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('realname', 'someone') ] try: self.server.put_element('user', '2', form) except Unauthorised as err: self.fail('raised %s' % err) finally: self.db.setCurrentUser('joe') def testAuthAllowedPost(self): """ Test authorized POST request """ self.db.setCurrentUser('admin') form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('username', 'blah') ] try: self.server.post_collection('user', form) except Unauthorised as err: self.fail('raised %s' % err) finally: self.db.setCurrentUser('joe') def testDeleteAttributeUri(self): """ Test Delete an attribute """ self.maxDiff = 4000 # create a new issue with userid 1 in the nosy list issue_id = self.db.issue.create(title='foo', nosy=['1']) # No etag, so this should return 412 - Precondition Failed # With no changes results = self.server.delete_attribute( 'issue', issue_id, 'nosy', self.empty_form ) self.assertEqual(self.dummy_client.response_code, 412) results = self.server.get_element('issue', issue_id, self.empty_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['attributes']['nosy']), 1) self.assertListEqual(results['attributes']['nosy'], [{'id': '1', 'link': self.url_pfx + 'user/1'}]) form = cgi.FieldStorage() etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list.append(cgi.MiniFieldStorage('@etag', etag)) # remove the title and nosy results = self.server.delete_attribute( 'issue', issue_id, 'title', form ) self.assertEqual(self.dummy_client.response_code, 200) del(form.list[-1]) etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list.append(cgi.MiniFieldStorage('@etag', etag)) results = self.server.delete_attribute( 'issue', issue_id, 'nosy', form ) self.assertEqual(self.dummy_client.response_code, 200) # verify the result results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['attributes']['nosy']), 0) self.assertListEqual(results['attributes']['nosy'], []) self.assertEqual(results['attributes']['title'], None) # delete protected property etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list.append(cgi.MiniFieldStorage('@etag', etag)) results = self.server.delete_attribute( 'issue', issue_id, 'creator', form ) expected= {'error': { 'status': 405, 'msg': AttributeError("Attribute 'creator' can not be updated for class issue.") }} self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 405) # delete required property etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list.append(cgi.MiniFieldStorage('@etag', etag)) results = self.server.delete_attribute( 'issue', issue_id, 'requireme', form ) expected= {'error': {'status': 400, 'msg': UsageError("Attribute 'requireme' is " "required by class issue and can not be deleted.")}} print(results) self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(str(results['error']['msg']), str(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 400) # delete bogus property etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list.append(cgi.MiniFieldStorage('@etag', etag)) results = self.server.delete_attribute( 'issue', issue_id, 'nosuchprop', form ) expected= {'error': {'status': 400, 'msg': UsageError("Attribute 'nosuchprop' not valid " "for class issue.")}} print(results) self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(str(results['error']['msg']), str(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 400) def testPatchAdd(self): """ Test Patch op 'Add' """ # create a new issue with userid 1 in the nosy list issue_id = self.db.issue.create(title='foo', nosy=['1']) # fail to add userid 2 to the nosy list # no etag form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'add'), cgi.MiniFieldStorage('nosy', '2') ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 412) etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'add'), cgi.MiniFieldStorage('nosy', '2'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertListEqual(results['attributes']['nosy'], ['1', '2']) etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'add'), cgi.MiniFieldStorage('data', '3'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_attribute('issue', issue_id, 'nosy', form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertListEqual(results['attributes']['nosy'], ['1', '2', '3']) # patch with no new_val/data etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'add'), cgi.MiniFieldStorage('data', ''), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_attribute('issue', issue_id, 'nosy', form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertListEqual(results['attributes']['nosy'], ['1', '2', '3']) # patch invalid property etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'add'), cgi.MiniFieldStorage('data', '3'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_attribute('issue', issue_id, 'notGoingToWork', form) self.assertEqual(self.dummy_client.response_code, 400) print(results) expected={'error': {'status': 400, 'msg': UsageError( HyperdbValueError( "'notGoingToWork' is not a property of issue",),)}} self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(str(results['error']['msg']), str(expected['error']['msg'])) def testPatchReplace(self): """ Test Patch op 'Replace' """ # create a new issue with userid 1 in the nosy list and status = 1 issue_id = self.db.issue.create(title='foo', nosy=['1'], status='1') # fail to replace userid 2 to the nosy list and status = 3 # no etag. form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'replace'), cgi.MiniFieldStorage('nosy', '2'), cgi.MiniFieldStorage('status', '3') ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 412) results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['attributes']['status'], '1') self.assertListEqual(results['attributes']['nosy'], ['1']) # replace userid 2 to the nosy list and status = 3 etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'replace'), cgi.MiniFieldStorage('nosy', '2'), cgi.MiniFieldStorage('status', '3'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['attributes']['status'], '3') self.assertListEqual(results['attributes']['nosy'], ['2']) # replace status = 2 using status attribute etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'replace'), cgi.MiniFieldStorage('data', '2'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_attribute('issue', issue_id, 'status', form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['attributes']['status'], '2') # try to set a protected prop. It should fail. etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'replace'), cgi.MiniFieldStorage('creator', '2'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) expected= {'error': {'status': 400, 'msg': KeyError('"creator", "actor", "creation" and "activity" are reserved',)}} print(results) self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(str(results['error']['msg']), str(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 400) # try to set a protected prop using patch_attribute. It should # fail with a 405 bad/unsupported method. etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'replace'), cgi.MiniFieldStorage('data', '2'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_attribute('issue', issue_id, 'creator', form) expected= {'error': {'status': 405, 'msg': AttributeError("Attribute 'creator' can not be updated for class issue.",)}} print(results) self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(str(results['error']['msg']), str(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 405) def testPatchRemoveAll(self): """ Test Patch Action 'Remove' """ # create a new issue with userid 1 and 2 in the nosy list issue_id = self.db.issue.create(title='foo', nosy=['1', '2']) # fail to remove the nosy list and the title # no etag form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'remove'), cgi.MiniFieldStorage('nosy', ''), cgi.MiniFieldStorage('title', '') ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 412) results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['attributes']['title'], 'foo') self.assertEqual(len(results['attributes']['nosy']), 2) self.assertEqual(results['attributes']['nosy'], ['1', '2']) # remove the nosy list and the title form = cgi.FieldStorage() etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('@op', 'remove'), cgi.MiniFieldStorage('nosy', ''), cgi.MiniFieldStorage('title', ''), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['attributes']['title'], None) self.assertEqual(len(results['attributes']['nosy']), 0) self.assertEqual(results['attributes']['nosy'], []) # try to remove a protected prop. It should fail. etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'remove'), cgi.MiniFieldStorage('creator', '2'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) expected= {'error': {'status': 400, 'msg': KeyError('"creator", "actor", "creation" and "activity" are reserved',)}} print(results) self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(str(results['error']['msg']), str(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 400) # try to remove a required prop. it should fail etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('@op', 'remove'), cgi.MiniFieldStorage('requireme', ''), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) expected= {'error': {'status': 400, 'msg': UsageError("Attribute 'requireme' is required by class issue and can not be removed.") }} print(results) self.assertEqual(results['error']['status'], expected['error']['status']) self.assertEqual(type(results['error']['msg']), type(expected['error']['msg'])) self.assertEqual(str(results['error']['msg']), str(expected['error']['msg'])) self.assertEqual(self.dummy_client.response_code, 400) def testPatchAction(self): """ Test Patch Action 'Action' """ # create a new issue with userid 1 and 2 in the nosy list issue_id = self.db.issue.create(title='foo') # fail to execute action retire # no etag form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'action'), cgi.MiniFieldStorage('@action_name', 'retire') ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 412) self.assertFalse(self.db.issue.is_retired(issue_id)) # execute action retire form = cgi.FieldStorage() etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('@op', 'action'), cgi.MiniFieldStorage('@action_name', 'retire'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result self.assertTrue(self.db.issue.is_retired(issue_id)) # execute action restore form = cgi.FieldStorage() etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('@op', 'action'), cgi.MiniFieldStorage('@action_name', 'restore'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result self.assertTrue(not self.db.issue.is_retired(issue_id)) def testPatchBadAction(self): """ Test Patch Action 'Unknown' """ # create a new issue with userid 1 and 2 in the nosy list issue_id = self.db.issue.create(title='foo') # execute action retire form = cgi.FieldStorage() etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('@op', 'action'), cgi.MiniFieldStorage('@action_name', 'unknown'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 400) # verify the result, note order of allowed elements changes # for python2/3 so just check prefix. self.assertIn('action "unknown" is not supported, allowed: ', results['error']['msg'].args[0]) def testPatchRemove(self): """ Test Patch Action 'Remove' only some element from a list """ # create a new issue with userid 1, 2, 3 in the nosy list issue_id = self.db.issue.create(title='foo', nosy=['1', '2', '3']) # fail to remove the nosy list and the title # no etag form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'remove'), cgi.MiniFieldStorage('nosy', '1, 2'), ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 412) results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['attributes']['nosy']), 3) self.assertEqual(results['attributes']['nosy'], ['1', '2', '3']) # remove 1 and 2 from the nosy list form = cgi.FieldStorage() etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form.list = [ cgi.MiniFieldStorage('@op', 'remove'), cgi.MiniFieldStorage('nosy', '1, 2'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_element('issue', issue_id, form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['attributes']['nosy']), 1) self.assertEqual(results['attributes']['nosy'], ['3']) # delete last element: 3 etag = calculate_etag(self.db.issue.getnode(issue_id), self.db.config['WEB_SECRET_KEY']) form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('@op', 'remove'), cgi.MiniFieldStorage('data', '3'), cgi.MiniFieldStorage('@etag', etag) ] results = self.server.patch_attribute('issue', issue_id, 'nosy', form) self.assertEqual(self.dummy_client.response_code, 200) # verify the result results = self.server.get_element('issue', issue_id, self.terse_form) results = results['data'] self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(len(results['attributes']['nosy']), 0) self.assertListEqual(results['attributes']['nosy'], []) def testRestExposeHeaders(self): local_client = self.server.client body = b'{ "data": "Joe Doe 1" }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "PUT", "HTTP_ORIGIN": "http://tracker.example" } local_client.env.update(env) local_client.db.config["WEB_ALLOWED_API_ORIGINS"] = " * " headers={"accept": "application/json; version=1", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], "origin": env['HTTP_ORIGIN'] } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) local_client.request.headers.get=self.get_header results = self.server.dispatch('PUT', "/rest/data/user/%s/realname"%self.joeid, form) for header in [ "X-RateLimit-Limit", "X-RateLimit-Remaining", "X-RateLimit-Reset", "X-RateLimit-Limit-Period", "Retry-After", "Sunset", "Allow", ]: self.assertIn( header, self.server.client.additional_headers[ "Access-Control-Expose-Headers"]) def testRestMatchWildcardOrigin(self): # cribbed from testDispatch #1 # PUT: joe's 'realname' using json data. # simulate: /rest/data/user//realname # use etag in header # verify that credential header is missing, valid allow origin # header and vary includes origin. local_client = self.server.client etag = calculate_etag(self.db.user.getnode(self.joeid), self.db.config['WEB_SECRET_KEY']) body = b'{ "data": "Joe Doe 1" }' env = { "CONTENT_TYPE": "application/json", "CONTENT_LENGTH": len(body), "REQUEST_METHOD": "PUT", "HTTP_ORIGIN": "https://bad.origin" } local_client.env.update(env) local_client.db.config["WEB_ALLOWED_API_ORIGINS"] = " * " headers={"accept": "application/json; version=1", "content-type": env['CONTENT_TYPE'], "content-length": env['CONTENT_LENGTH'], "if-match": etag, "origin": env['HTTP_ORIGIN'] } self.headers=headers # we need to generate a FieldStorage the looks like # FieldStorage(None, None, 'string') rather than # FieldStorage(None, None, []) body_file=BytesIO(body) # FieldStorage needs a file form = client.BinaryFieldStorage(body_file, headers=headers, environ=env) local_client.request.headers.get=self.get_header results = self.server.dispatch('PUT', "/rest/data/user/%s/realname"%self.joeid, form) self.assertNotIn("Access-Control-Allow-Credentials", local_client.additional_headers) self.assertIn("Access-Control-Allow-Origin", local_client.additional_headers) self.assertEqual( headers['origin'], local_client.additional_headers["Access-Control-Allow-Origin"]) self.assertIn("Vary", local_client.additional_headers) self.assertIn("Origin", local_client.additional_headers['Vary']) self.assertEqual(local_client.response_code, 200) results = self.server.get_element('user', self.joeid, self.empty_form) self.assertEqual(self.dummy_client.response_code, 200) self.assertEqual(results['data']['attributes']['realname'], 'Joe Doe 1') @skip_jwt def test_expired_jwt(self): # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) secret = self.db.config.WEB_JWT_SECRET[0] # verify library and tokens are correct self.assertRaises(jwt.exceptions.InvalidTokenError, jwt.decode, self.jwt['expired'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) result = jwt.decode(self.jwt['user'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user'],result) result = jwt.decode(self.jwt['user:email'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user:email'],result) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh # set up for expired token first env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['expired'] self.dummy_client.main() # this will be the admin still as auth failed self.assertEqual('1', self.db.getuid()) self.assertEqual(out[0], b'Invalid Login - Signature has expired') del(out[0]) @skip_jwt def test_user_jwt_key_rotation_mutlisig(self): # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) # verify library and tokens are correct self.assertRaises(jwt.exceptions.InvalidTokenError, jwt.decode, self.jwt['expired'], self.old_secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) result = jwt.decode(self.jwt['user_new_secret'], self.new_secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user'],result) result = jwt.decode(self.jwt['user:email'], self.old_secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user:email'],result) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } # test case where rotation key is used, # add spaces after ',' to test config system self.db.config['WEB_JWT_SECRET'] = "%s, %s, " % ( self.new_secret, self.old_secret ) self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh # set up for standard user role token env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['user'] self.dummy_client.main() print(out[0]) json_dict = json.loads(b2s(out[0])) print(json_dict) # user will be joe id 3 as auth works self.assertTrue('3', self.db.getuid()) # there should be three items in the collection admin, anon, and joe self.assertEqual(3, len(json_dict['data']['collection'])) # since this token has no access to email addresses, only joe # should have email addresses. Order is by id by default. self.assertFalse('address' in json_dict['data']['collection'][0]) self.assertFalse('address' in json_dict['data']['collection'][1]) self.assertTrue('address' in json_dict['data']['collection'][2]) del(out[0]) self.db.setCurrentUser('admin') @skip_jwt def test_user_jwt_key_rotation_sig_failure(self): # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) # verify library and tokens are correct self.assertRaises(jwt.exceptions.InvalidTokenError, jwt.decode, self.jwt['expired'], self.old_secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) result = jwt.decode(self.jwt['user_new_secret'], self.new_secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user'],result) result = jwt.decode(self.jwt['user:email'], self.old_secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user:email'],result) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh # test case where new json secret is in place self.db.config['WEB_JWT_SECRET'] = self.new_secret # set up for standard user role token env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['user'] self.dummy_client.main() print(out[0]) self.assertEqual(out[0], b'Invalid Login - Signature verification failed') del(out[0]) self.db.setCurrentUser('admin') @skip_jwt def test_user_jwt(self): # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) secret = self.db.config.WEB_JWT_SECRET[0] # verify library and tokens are correct self.assertRaises(jwt.exceptions.InvalidTokenError, jwt.decode, self.jwt['expired'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) result = jwt.decode(self.jwt['user'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user'],result) result = jwt.decode(self.jwt['user:email'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user:email'],result) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh # set up for standard user role token env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['user'] self.dummy_client.main() print(out[0]) json_dict = json.loads(b2s(out[0])) print(json_dict) # user will be joe id 3 as auth works self.assertTrue('3', self.db.getuid()) # there should be three items in the collection admin, anon, and joe self.assertEqual(3, len(json_dict['data']['collection'])) # since this token has no access to email addresses, only joe # should have email addresses. Order is by id by default. self.assertFalse('address' in json_dict['data']['collection'][0]) self.assertFalse('address' in json_dict['data']['collection'][1]) self.assertTrue('address' in json_dict['data']['collection'][2]) del(out[0]) self.db.setCurrentUser('admin') @skip_jwt def test_user_email_jwt(self): '''tests "Rest Access" permission present case''' # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) secret = self.db.config.WEB_JWT_SECRET[0] # verify library and tokens are correct self.assertRaises(jwt.exceptions.InvalidTokenError, jwt.decode, self.jwt['expired'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) result = jwt.decode(self.jwt['user'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user'],result) result = jwt.decode(self.jwt['user:email'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user:email'],result) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh # set up for limited user:email role token env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['user:email'] self.dummy_client.main() json_dict = json.loads(b2s(out[0])) print(json_dict) # user will be joe id 3 as auth works self.assertTrue('3', self.db.getuid()) # there should be three items in the collection admin, anon, and joe self.assertEqual(3, len(json_dict['data']['collection'])) # However this token has access to email addresses, so all three # should have email addresses. Order is by id by default. self.assertTrue('address' in json_dict['data']['collection'][0]) self.assertTrue('address' in json_dict['data']['collection'][1]) self.assertTrue('address' in json_dict['data']['collection'][2]) @skip_jwt def test_user_emailnorest_jwt(self): '''tests "Rest Access" permission missing case''' # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) secret = self.db.config.WEB_JWT_SECRET[0] # verify library and tokens are correct self.assertRaises(jwt.exceptions.InvalidTokenError, jwt.decode, self.jwt['expired'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) result = jwt.decode(self.jwt['user'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user'],result) result = jwt.decode(self.jwt['user:email'], secret, algorithms=['HS256'], audience=self.db.config.TRACKER_WEB, issuer=self.db.config.TRACKER_WEB) self.assertEqual(self.claim['user:email'],result) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh # set up for limited user:email role token env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['user:emailnorest'] self.dummy_client.main() json_dict = json.loads(b2s(out[0])) # user will be joe id 3 as auth works self.assertTrue('1', self.db.getuid()) { "error": { "status": 403, "msg": "Forbidden." } } self.assertTrue('error' in json_dict) self.assertTrue(json_dict['error']['status'], 403) self.assertTrue(json_dict['error']['msg'], "Forbidden.") @skip_jwt def test_admin_disabled_jwt(self): # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh # disable jwt validation by making secret too short # use the default value for this in configure.py. self.db.config['WEB_JWT_SECRET'] = "disabled" env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['user'] self.dummy_client.main() # user will be 1 as there is no auth self.assertTrue('1', self.db.getuid()) self.assertEqual(out[0], b'Invalid Login - Support for jwt disabled by admin.') @skip_jwt def test_bad_issue_jwt(self): # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['badiss'] self.dummy_client.main() # user will be 1 as there is no auth self.assertTrue('1', self.db.getuid()) self.assertEqual(out[0], b'Invalid Login - Invalid issuer') @skip_jwt def test_bad_audience_jwt(self): # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['badaud'] self.dummy_client.main() # user will be 1 as there is no auth self.assertTrue('1', self.db.getuid()) self.assertIn(out[0], [b'Invalid Login - Invalid audience', b"Invalid Login - Audience doesn't match"]) @skip_jwt def test_bad_roles_jwt(self): # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['badroles'] self.dummy_client.main() # user will be 1 as there is no auth self.assertTrue('1', self.db.getuid()) self.assertEqual(out[0], b'Invalid Login - Token roles are invalid.') @skip_jwt def test_bad_subject_jwt(self): # self.dummy_client.main() closes database, so # we need a new test with setup called for each test out = [] def wh(s): out.append(s) # set environment for all jwt tests env = { 'PATH_INFO': 'rest/data/user', 'HTTP_HOST': 'localhost', 'TRACKER_NAME': 'rounduptest', "REQUEST_METHOD": "GET" } self.dummy_client = client.Client(self.instance, MockNull(), env, cgi.FieldStorage(), None) self.dummy_client.db = self.db self.dummy_client.request.headers.get = self.get_header self.empty_form = cgi.FieldStorage() self.terse_form = cgi.FieldStorage() self.terse_form.list = [ cgi.MiniFieldStorage('@verbose', '0'), ] self.dummy_client.form = cgi.FieldStorage() self.dummy_client.form.list = [ cgi.MiniFieldStorage('@fields', 'username,address'), ] # accumulate json output for further analysis self.dummy_client.write = wh env['HTTP_AUTHORIZATION'] = 'bearer %s'%self.jwt['badsub'] self.dummy_client.main() # user will be 1 as there is no auth self.assertTrue('1', self.db.getuid()) self.assertEqual(out[0], b'Invalid Login - Token subject is invalid.') def get_obj(path, id): return { 'id': id, 'link': path + id } if __name__ == '__main__': runner = unittest.TextTestRunner() unittest.main(testRunner=runner) code-e5bd50120b5a/test/session_common.py0000644000000000000000000002526615064275501016317 0ustar 00000000000000import os, shutil, time, unittest from .db_test_base import config """ here are three different impementations for these. I am trying to fix them so they all act the same. set with invalid timestamp: session_dbm/memorydb - sets to invalid timestamp if new or existing item. session_rdbms - sets to time.time if new item, keeps original if item exists. (note that the timestamp is a separate column, the timestamp embedded in the value object in the db has the bad __timestamp. reconciled: set to time.time for new item, keeps original time of existing item. Also updateTimestamp does not update the marshalled values idea of __timestamp. So get(item, '__timestamp') will not work as expected for rdbms backends, need a sql query to get the timestamp column. FIXME need to add getTimestamp method to sessions_rdbms.py and sessions_dbm.py. """ import pytest, sys _py3 = sys.version_info[0] > 2 if _py3: skip_py2 = lambda func, *args, **kwargs: func else: from .pytest_patcher import mark_class skip_py2 = mark_class(pytest.mark.skip( reason="Skipping log test, test doesn't work on python2")) class SessionTest(object): def setUp(self): # remove previous test, ignore errors if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) os.makedirs(config.DATABASE + '/files') self.db = self.module.Database(config, 'admin') self.sessions = self.db.getSessionManager() self.otks = self.db.getOTKManager() def tearDown(self): if hasattr(self, 'sessions'): if not hasattr(self.sessions, 'conn'): # only do this for file based databases that do not # have a conn(ection). If they have a connection # mysql throws an error when closing self.db. self.sessions.close() if hasattr(self, 'otks'): if not hasattr(self.otks, 'conn'): # only do this for file based databases that do not # have a conn(ection). If they have a connection # mysql throws an error when closing self.db. self.otks.close() if hasattr(self, 'db'): self.db.close() if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) def testList(self): '''Under dbm/memory sessions store, keys are returned as byte strings. self.s2b converts string to byte under those backends but is a no-op for rdbms based backends. Unknown why keys can be strings not bytes for get/set and work correctly. ''' self.sessions.list() self.sessions.set('random_key', text='hello, world!') self.sessions.set('random_key2', text='hello, world!') self.assertEqual(self.sessions.list().sort(), [self.s2b('random_key'), self.s2b('random_key2')].sort()) def testGetGetAllMissingKey(self): self.assertEqual(self.sessions.get('badc_key', 'text', 'default_val'), 'default_val') with self.assertRaises(KeyError) as e: self.sessions.get('badc_key', 'text') with self.assertRaises(KeyError) as e: self.sessions.getall('badc_key') def testGetAll(self): self.sessions.set('random_key', text='hello, world!', otherval='bar') self.assertEqual(self.sessions.getall('random_key'), {'text': 'hello, world!', 'otherval': 'bar'}) def testDestroy(self): self.sessions.set('random_key', text='hello, world!') self.assertEqual(self.sessions.getall('random_key'), {'text': 'hello, world!'}) self.sessions.destroy('random_key') self.assertRaises(KeyError, self.sessions.getall, 'random_key') def testClear(self): self.sessions.set('random_key', text='hello, world!') self.sessions.set('random_key2', text='hello, world!') self.sessions.set('random_key3', text='hello, world!') self.assertEqual(self.sessions.getall('random_key3'), {'text': 'hello, world!'}) self.assertEqual(len(self.sessions.list()), 3) self.sessions.clear() self.assertEqual(len(self.sessions.list()), 0) def testSetSession(self): self.sessions.set('random_key', text='hello, world!', otherval='bar') self.assertEqual(self.sessions.get('random_key', 'text'), 'hello, world!') self.assertEqual(self.sessions.get('random_key', 'otherval'), 'bar') def testUpdateSession(self): self.sessions.set('random_key', text='hello, world!') self.assertEqual(self.sessions.get('random_key', 'text'), 'hello, world!') self.sessions.set('random_key', text='nope') self.assertEqual(self.sessions.get('random_key', 'text'), 'nope') def testBadTimestamp(self): self.sessions.set('random_key', text='hello, world!', __timestamp='not a timestamp') ts = self.sessions.get('random_key', '__timestamp') self.assertNotEqual(ts, 'not a timestamp') # use {1,7} because db's don't pad the fraction to 7 digits. ts_re=r'^[0-9]{10,16}\.[0-9]{1,7}$' try: self.assertRegex(str(ts), ts_re) except AttributeError: # 2.7 version import warnings with warnings.catch_warnings(): warnings.filterwarnings("ignore",category=DeprecationWarning) self.assertRegexpMatches(str(ts), ts_re) # now update with a bad timestamp, original timestamp should # be kept. self.sessions.set('random_key', text='hello, world2!', __timestamp='not a timestamp') item = self.sessions.get('random_key', "text") item_ts = self.sessions.get('random_key', "__timestamp") self.assertEqual(item, 'hello, world2!') self.assertAlmostEqual(ts, item_ts, 2) # overridden in test_memory def testUpdateTimestamp(self): # make sure timestamp is older than one minute so update # will apply timestamp = time.time() - 62 self.sessions.set('random_session', text='hello, world!', __timestamp=timestamp) self.sessions.updateTimestamp('random_session') # this doesn't work as the rdbms backends have a # session_time, otk_time column and the timestamp in the # session marshalled payload isn't updated. The dbm # backend does update the __timestamp value so it works # for dbm. #self.assertNotEqual (self.sessions.get('random_session', # '__timestamp'), # timestamp) # use 61 to allow a 1 second delay in test self.assertGreater(self.get_ts()[0] - timestamp, 61) # overridden in test_anydbm def get_ts(self, key="random_session"): sql = '''select %(name)s_time from %(name)ss where %(name)s_key = '%(session)s';'''% \ {'name': self.sessions.name, 'session': key} self.sessions.cursor.execute(sql) db_tstamp = self.sessions.cursor.fetchone() return db_tstamp def testDataTypes(self): """make sure all data survives a round trip through the session database including data types. Found this was a problem when trying to store the data using a redis hash that has no native data types for booleans and numbers get returned by redis module as strings. """ in_data = {"text": 'hello, world!', "integer": 56, "float": 3.1425, "list": [ 1, "Two", 3.0, "Four" ], "boolean": True, "tuple": ("f", 4), } self.sessions.set('random_data', **in_data) out_data = self.sessions.getall('random_data') self.assertEqual(in_data, out_data) def testLifetime(self): ts = self.sessions.lifetime(300) week_ago = time.time() - 60*60*24*7 self.assertGreater(week_ago + 302, ts) self.assertLess(week_ago + 298, ts) def testGetUniqueKey(self): # 40 bytes of randomness gets larger when encoded key = self.sessions.getUniqueKey() self.assertEqual(len(key), 54) # length is bytes of randomness key = self.sessions.getUniqueKey(length=23) self.assertEqual(len(key), 31) key = self.sessions.getUniqueKey(length=200) self.assertEqual(len(key), 267) def testget_logger(self): logger = self.sessions.get_logger() # why do rdbms session use session/otk as the table name # while dbm uses sessions/otks? In any case check both. self.assertIn(logger.name, ["roundup.hyperdb.backends.sessions", "roundup.hyperdb.backends.session"]) logger = self.otks.get_logger() self.assertIn(logger.name, ["roundup.hyperdb.backends.otks", "roundup.hyperdb.backends.otk"]) def testget_logger_name_test(self): self.sessions.name="otks" logger = self.sessions.get_logger() self.assertEqual(logger.name, "roundup.hyperdb.backends.otks") @skip_py2 def test_log_warning(self): """Only python3 pytest has the right context handler for this, so skip this on python2. """ self.sessions.name = "newdb" with self.assertLogs(logger="roundup.hyperdb.backends.newdb") as logs: self.sessions.log_warning("hello world") self.assertEqual(len(logs.records), 1) self.assertEqual(logs.records[0].levelname, "WARNING") @skip_py2 def test_log_info(self): """Only python3 pytest has the right context handler for this, so skip this on python2. """ self.sessions.name = "newdb" with self.assertLogs(logger="roundup.hyperdb.backends.newdb") as logs: self.sessions.log_info("hello world") self.assertEqual(len(logs.records), 1) self.assertEqual(logs.records[0].levelname, "INFO") @skip_py2 def test_log_debug(self): """Only python3 pytest has the right context handler for this, so skip this on python2. """ self.sessions.name = "newdb" with self.assertLogs(logger="roundup.hyperdb.backends.newdb", level='DEBUG') as logs: self.sessions.log_debug("hello world") self.assertEqual(len(logs.records), 1) self.assertEqual(logs.records[0].levelname, "DEBUG") code-e5bd50120b5a/test/test_actions.py0000644000000000000000000006044415064275501015760 0ustar 00000000000000from __future__ import print_function import unittest, copy from roundup import hyperdb from roundup.date import Date, Interval from roundup.cgi.actions import * from roundup.cgi.client import add_message from roundup.cgi.exceptions import RateLimitExceeded, Redirect, Unauthorised, SeriousError, FormError from roundup.exceptions import Reject from roundup.anypy.cgi_ import FieldStorage, MiniFieldStorage from roundup.anypy.cmp_ import NoneAndDictComparable from time import sleep from datetime import datetime from roundup.test.mocknull import MockNull def true(*args, **kwargs): return 1 class ActionTestCase(unittest.TestCase): def setUp(self): self.form = FieldStorage(environ={'QUERY_STRING': ''}) self.client = MockNull() self.client.db.Otk = MockNull() self.client.db.Otk.data = {} self.client.db.Otk.getall = self.data_get self.client.db.Otk.set = self.data_set self.client.db.config.WEB_LOGIN_ATTEMPTS_MIN = 20 self.client.db.config.WEB_LOGIN_EMPTY_PASSWORDS = 0 self.client._ok_message = [] self.client._error_message = [] self.client.add_error_message = lambda x, escape=True: add_message( self.client._error_message, x, escape=escape) self.client.add_ok_message = lambda x : add_message( self.client._ok_message, x) self.client.form = self.form self.client.base = "http://whoami.com/path/" class TemplatingUtils: pass self.client.instance.interfaces.TemplatingUtils = TemplatingUtils def data_get(self, key): return self.client.db.Otk.data[key] def data_set(self, key, **value): self.client.db.Otk.data[key] = value class ShowActionTestCase(ActionTestCase): def assertRaisesMessage(self, exception, callable, message, *args, **kwargs): """An extension of assertRaises, which also checks the exception message. We need this because we rely on exception messages when redirecting. """ try: callable(*args, **kwargs) except exception as msg: self.assertEqual(str(msg), message) else: if hasattr(exception, '__name__'): excName = exception.__name__ else: excName = str(exception) raise self.failureException(excName) def testShowAction(self): self.client.base = 'BASE/' action = ShowAction(self.client) self.assertRaises(ValueError, action.handle) self.form.value.append(MiniFieldStorage('@type', 'issue')) self.assertRaises(SeriousError, action.handle) self.form.value.append(MiniFieldStorage('@number', '1')) self.assertRaisesMessage(Redirect, action.handle, 'BASE/issue1') def testShowActionNoType(self): action = ShowAction(self.client) self.assertRaises(ValueError, action.handle) self.form.value.append(MiniFieldStorage('@number', '1')) self.assertRaisesMessage(ValueError, action.handle, 'No type specified') def testShowActionBadNumber(self): action = ShowAction(self.client) self.assertRaises(ValueError, action.handle) self.form.value.append(MiniFieldStorage('@number', 'A')) self.form.value.append(MiniFieldStorage('@type', 'issue')) with self.assertRaises(SeriousError) as ctx: action.handle() self.assertEqual('"A" is not an ID (issue ID required)', ctx.exception.args[0]) class RetireActionTestCase(ActionTestCase): def testRetireAction(self): self.client.db.security.hasPermission = true self.client._ok_message = [] RetireAction(self.client).handle() self.assertTrue(len(self.client._ok_message) == 1) self.assertTrue(not self.client.nodeid == None) self.client.template = 'index' self.client._ok_message = [] RetireAction(self.client).handle() self.assertTrue(len(self.client._ok_message) == 1) self.assertTrue(self.client.nodeid == None) self.client.env={} self.client.env['REQUEST_METHOD'] = 'GET' self.client._ok_message = [] self.assertRaises(Reject, RetireAction(self.client).execute) def testNoPermission(self): self.client.classname='user' self.assertRaises(Unauthorised, RetireAction(self.client).execute) def testDontRetireAdminOrAnonymous(self): self.client.db.security.hasPermission=true # look up the user class self.client.classname = 'user' # but always look up admin, regardless of nodeid self.client.db.user.get = lambda a,b: 'admin' self.assertRaises(ValueError, RetireAction(self.client).handle) # .. or anonymous self.client.db.user.get = lambda a,b: 'anonymous' self.assertRaises(ValueError, RetireAction(self.client).handle) class RestoreActionTestCase(ActionTestCase): # This is a copy of the RetireActionTestCase. But what do these # actually test? I see no actual db or retire call or # class id. Testing db level restore is covered in the # db_test_base as part of retire. def testRestoreAction(self): self.client.db.security.hasPermission = true self.client._ok_message = [] RestoreAction(self.client).handle() self.assertTrue(len(self.client._ok_message) == 1) self.assertTrue(not self.client.nodeid == None) self.client.template = 'index' self.client._ok_message = [] RestoreAction(self.client).handle() self.assertTrue(len(self.client._ok_message) == 1) self.assertTrue(self.client.nodeid == None) self.client.env={} self.client.env['REQUEST_METHOD'] = 'GET' self.client._ok_message = [] self.assertRaises(Reject, RestoreAction(self.client).execute) def testNoPermission(self): self.assertRaises(Unauthorised, RestoreAction(self.client).execute) class SearchActionTestCase(ActionTestCase): def setUp(self): ActionTestCase.setUp(self) self.action = SearchAction(self.client) class StandardSearchActionTestCase(SearchActionTestCase): def testNoPermission(self): self.assertRaises(Unauthorised, self.action.execute) def testQueryName(self): self.assertEqual(self.action.getQueryName(), '') self.form.value.append(MiniFieldStorage('@queryname', 'foo')) self.assertEqual(self.action.getQueryName(), 'foo') class FakeFilterVarsTestCase(SearchActionTestCase): def setUp(self): SearchActionTestCase.setUp(self) self.client.db.classes.get_transitive_prop = lambda x: \ hyperdb.Multilink('foo') def assertFilterEquals(self, expected): self.action.fakeFilterVars() self.assertEqual(self.form.getvalue('@filter'), expected) def testEmptyMultilink(self): self.form.value.append(MiniFieldStorage('foo', '')) self.form.value.append(MiniFieldStorage('foo', '')) self.assertFilterEquals(None) def testNonEmptyMultilink(self): self.form.value.append(MiniFieldStorage('foo', '')) self.form.value.append(MiniFieldStorage('foo', '1')) self.assertFilterEquals('foo') def testEmptyKey(self): self.form.value.append(MiniFieldStorage('foo', '')) self.assertFilterEquals(None) def testStandardKey(self): self.form.value.append(MiniFieldStorage('foo', '1')) self.assertFilterEquals('foo') def testStringKey(self): self.client.db.classes.getprops = lambda: {'foo': hyperdb.String()} self.form.value.append(MiniFieldStorage('foo', 'hello')) self.assertFilterEquals('foo') def testNumKey(self): # testing patch: http://hg.python.org/tracker/roundup/rev/98508a47c126 for val in [ "-1000a", "test", "o0.9999", "o0", "1.00/10" ]: print("testing ", val) self.client.db.classes.get_transitive_prop = lambda x: hyperdb.Number() self.form.value.append(MiniFieldStorage('foo', val)) # invalid numbers self.assertRaises(FormError, self.action.fakeFilterVars) del self.form.value[:] for val in [ "-1000.7738", "-556", "-0.9999", "-.456", "-5E-5", "0.00", "0", "1.00", "0556", "7.56E2", "1000.7738"]: self.form.value.append(MiniFieldStorage('foo', val)) self.action.fakeFilterVars() # this should run and return. No errors, nothing to check. del self.form.value[:] def testIntKey(self): # testing patch: http://hg.python.org/tracker/roundup/rev/98508a47c126 for val in [ "-1000a", "test", "-5E-5", "0.9999", "0.0", "1.000", "0456", "1E4" ]: print("testing ", val) self.client.db.classes.get_transitive_prop = lambda x: hyperdb.Integer() self.form.value.append(MiniFieldStorage('foo', val)) self.assertRaises(FormError, self.action.fakeFilterVars) del self.form.value[:] for val in [ "-1000", "-512", "0", "1", "100", "248" ]: # no scientific notation apparently self.client.db.classes.get_transitive_prop = lambda x: hyperdb.Integer() self.form.value.append(MiniFieldStorage('foo', val)) self.action.fakeFilterVars() # this should run and return. No errors, nothing to check. del self.form.value[:] def testTokenizedStringKey(self): self.client.db.classes.get_transitive_prop = lambda x: hyperdb.String() self.form.value.append(MiniFieldStorage('foo', 'hello world')) self.assertFilterEquals('foo') # The single value gets replaced with the tokenized list. self.assertEqual([x.value for x in self.form['foo']], ['hello', 'world']) class CollisionDetectionTestCase(ActionTestCase): def setUp(self): ActionTestCase.setUp(self) self.action = EditItemAction(self.client) self.now = Date('.') # round off for testing self.now.second = int(self.now.second) def testLastUserActivityAt(self): self.assertEqual(self.action.lastUserActivity(), None) # test @ special variable form self.client.form.value.append( MiniFieldStorage('@lastactivity', str(self.now))) self.assertEqual(self.action.lastUserActivity(), self.now) def testLastUserActivityColon(self): self.assertEqual(self.action.lastUserActivity(), None) # test : special variable form self.client.form.value.append( MiniFieldStorage(':lastactivity', str(self.now))) self.assertEqual(self.action.lastUserActivity(), self.now) def testLastNodeActivity(self): self.action.classname = 'issue' self.action.nodeid = '1' def get(nodeid, propname): self.assertEqual(nodeid, '1') self.assertEqual(propname, 'activity') return self.now self.client.db.issue.get = get self.assertEqual(self.action.lastNodeActivity(), self.now) def testCollision(self): # fake up an actual change self.action.classname = 'test' self.action.nodeid = '1' self.client.parsePropsFromForm = lambda: ( {('test','1'):{"prop1":"1"}}, []) props = self.action.detectCollision(self.now, self.now + Interval("1d")) self.assertTrue(props) self.action.handleCollision(props) self.assertEqual(self.client._error_message[0], 'Edit Error: someone else has edited this test ' '(prop1). View their ' 'changes in a new window.') self.assertFalse(self.action.detectCollision(self.now, self.now - Interval("1d"))) self.assertFalse(self.action.detectCollision(None, self.now)) class LoginTestCase(ActionTestCase): def setUp(self): ActionTestCase.setUp(self) self.client._error_message = [] # set the db password to 'right' self.client.db.user.get = lambda a,b: 'right' # unless explicitly overridden, we should never get here self.client.opendb = lambda a: self.fail( "Logged in, but we shouldn't be.") def assertRaisesMessage(self, exception, callable, message, *args, **kwargs): """An extension of assertRaises, which also checks the exception message. We need this because we rely on exception messages when redirecting. """ try: callable(*args, **kwargs) except exception as msg: self.assertEqual(str(msg), message) else: if hasattr(exception, '__name__'): excName = exception.__name__ else: excName = str(exception) raise self.failureException(excName) def assertLoginLeavesMessages(self, messages, username=None, password=None): if username is not None: self.form.value.append(MiniFieldStorage('__login_name', username)) if password is not None: self.form.value.append( MiniFieldStorage('__login_password', password)) LoginAction(self.client).handle() self.assertEqual(self.client._error_message, messages) def assertLoginRaisesRedirect(self, message, username=None, password=None, came_from=None): if username is not None: self.form.value.append(MiniFieldStorage('__login_name', username)) if password is not None: self.form.value.append( MiniFieldStorage('__login_password', password)) if came_from is not None: self.form.value.append( MiniFieldStorage('__came_from', came_from)) self.assertRaisesMessage(Redirect, LoginAction(self.client).handle, message) def testNoUsername(self): self.assertLoginLeavesMessages(['Username required']) def testInvalidUsername(self): def raiseKeyError(a): raise KeyError self.client.db.user.lookup = raiseKeyError self.assertLoginLeavesMessages(['Invalid login'], 'foo') def testInvalidPassword(self): self.assertLoginLeavesMessages(['Invalid login'], 'foo', 'wrong') def testNoWebAccess(self): self.assertLoginLeavesMessages(['You do not have permission to login'], 'foo', 'right') def testCorrectLogin(self): self.client.db.security.hasPermission = lambda *args, **kwargs: True def opendb(username): self.assertEqual(username, 'foo') self.client.opendb = opendb self.assertLoginLeavesMessages([], 'foo', 'right') def testBlankPasswordLogin(self): self.client.db.security.hasPermission = lambda *args, **kwargs: True self.client.db.user.get = lambda a,b: None def opendb(username): self.assertEqual(username, 'blank') self.client.opendb = opendb self.assertEqual(self.client.db.config.WEB_LOGIN_EMPTY_PASSWORDS, 0) self.assertLoginLeavesMessages(['Invalid login'], 'blank', '' ) self.client.db.config.WEB_LOGIN_EMPTY_PASSWORDS = 1 self.form.value[:] = [] # reset form self.client._error_message = [] # reset errors self.assertLoginLeavesMessages([], 'blank', '' ) # reset self.client.db.user.get = lambda a,b: 'right' self.client.db.config.WEB_LOGIN_EMPTY_PASSWORDS = 0 def testCorrectLoginRedirect(self): self.client.db.security.hasPermission = lambda *args, **kwargs: True def opendb(username): self.assertEqual(username, 'foo') self.client.opendb = opendb # basic test with query self.assertLoginRaisesRedirect("http://whoami.com/path/issue?%40action=search&%40ok_message=Welcome+foo%21", 'foo', 'right', "http://whoami.com/path/issue?@action=search") # test that old messages are removed self.form.value[:] = [] # clear out last test's setup values self.assertLoginRaisesRedirect("http://whoami.com/path/issue?%40action=search&%40ok_message=Welcome+foo%21", 'foo', 'right', "http://whoami.com/path/issue?@action=search&@ok_messagehurrah+we+win&@error_message=blam") # test when there is no query self.form.value[:] = [] # clear out last test's setup values self.assertLoginRaisesRedirect("http://whoami.com/path/issue255?%40ok_message=Welcome+foo%21", 'foo', 'right', "http://whoami.com/path/issue255") # test if we are logged out; should kill the @action=logout self.form.value[:] = [] # clear out last test's setup values self.assertLoginRaisesRedirect("http://whoami.com/path/issue39?%40ok_message=Welcome+foo%21&%40pagesize=50&%40startwith=0", 'foo', 'right', "http://whoami.com/path/issue39?@action=logout&@pagesize=50&@startwith=0") def testInvalidLoginRedirect(self): self.client.db.security.hasPermission = lambda *args, **kwargs: True def opendb(username): self.assertEqual(username, 'foo') self.client.opendb = opendb # basic test with query self.assertLoginRaisesRedirect("http://whoami.com/path/issue?%40action=search&%40error_message=Invalid+login", 'foo', 'wrong', "http://whoami.com/path/issue?@action=search") # test that old messages are removed self.form.value[:] = [] # clear out last test's setup values self.assertLoginRaisesRedirect("http://whoami.com/path/issue?%40action=search&%40error_message=Invalid+login", 'foo', 'wrong', "http://whoami.com/path/issue?@action=search&@ok_messagehurrah+we+win&@error_message=blam") # test when there is no __came_from specified self.form.value[:] = [] # clear out last test's setup values # I am not sure why this produces three copies of the same error. # only one copy of the error is displayed to the user in the web interface. self.assertLoginLeavesMessages(['Invalid login', 'Invalid login', 'Invalid login'], 'foo', 'wrong') # test when there is no query self.form.value[:] = [] # clear out last test's setup values self.assertLoginRaisesRedirect("http://whoami.com/path/issue255?%40error_message=Invalid+login", 'foo', 'wrong', "http://whoami.com/path/issue255") def testLoginRateLimit(self): ''' Set number of logins in setup to 20 per minute. Three second delay between login attempts doesn't trip rate limit. Default limit is 3/min, but that means we sleep for 20 seconds so I override the default limit to speed this up. ''' # Do the first login setting an invalid login name self.assertLoginLeavesMessages(['Invalid login'], 'nouser') # use up the rest of the 20 login attempts. Login name # persists. for i in range(19): self.client._error_message = [] self.assertLoginLeavesMessages(['Invalid login']) self.assertRaisesMessage(RateLimitExceeded, LoginAction(self.client).handle, 'Logins occurring too fast. Please wait: 3 seconds.') sleep(3) # sleep as requested so we can do another login self.client._error_message = [] self.assertLoginLeavesMessages(['Invalid login']) # this is expected # and make sure we need to wait another three seconds self.assertRaisesMessage(RateLimitExceeded, LoginAction(self.client).handle, 'Logins occurring too fast. Please wait: 3 seconds.') def testLoginRateLimitOff(self): ''' Set number of logins to 0 per minute. Verify that we can do 1000 which for manual login might as well be off. ''' self.client.db.config.WEB_LOGIN_ATTEMPTS_MIN = 0 # Do the first login setting an invalid login name self.assertLoginLeavesMessages(['Invalid login'], 'nouser') for i in range(1000): self.client._error_message = [] self.assertLoginLeavesMessages(['Invalid login']) class EditItemActionTestCase(ActionTestCase): def setUp(self): ActionTestCase.setUp(self) self.result = [] self.new_id = 16 class AppendResult: def __init__(inner_self, name): inner_self.name = name def __call__(inner_self, *args, **kw): self.result.append((inner_self.name, args, kw)) if inner_self.name == 'set': return kw self.new_id+=1 return str(self.new_id) self.client.db.security.hasPermission = true self.client.classname = 'issue' self.client.base = 'http://tracker/' self.client.nodeid = '4711' self.client.template = 'item' self.client.db.classes.create = AppendResult('create') self.client.db.classes.set = AppendResult('set') self.client.db.classes.getprops = lambda: \ ({'messages':hyperdb.Multilink('msg') ,'content':hyperdb.String() ,'files':hyperdb.Multilink('file') ,'msg':hyperdb.Link('msg') }) self.action = EditItemAction(self.client) def testMessageAttach(self): expect = \ [ ('create',(),{'content':'t'}) , ('set',('4711',), {'messages':['23','42','17']}) ] self.client.db.classes.get = lambda a, b:['23','42'] self.client.parsePropsFromForm = lambda: \ ( {('msg','-1'):{'content':'t'},('issue','4711'):{}} , [('issue','4711','messages',[('msg','-1')])] ) try : self.action.handle() except Redirect as msg: pass self.assertEqual(expect, self.result) def testMessageMultiAttach(self): expect = \ [ ('create',(),{'content':'t2'}) , ('create',(),{'content':'t'}) , ('set',('4711',), {'messages':['23','42','17','18']}) ] self.client.db.classes.get = lambda a, b:['23','42'] self.client.parsePropsFromForm = lambda: \ ( {('msg','-1'):{'content':'t'},('msg','-2'):{'content':'t2'} , ('issue','4711'):{}} , [('issue','4711','messages',[('msg','-1'),('msg','-2')])] ) try : self.action.handle() except Redirect as msg: pass self.assertEqual(sorted(expect, key=NoneAndDictComparable), sorted(self.result, key=NoneAndDictComparable)) def testFileAttach(self): expect = \ [('create',(),{'content':'t','type':'text/plain','name':'t.txt'}) ,('set',('4711',),{'files':['23','42','17']}) ] self.client.db.classes.get = lambda a, b:['23','42'] self.client.parsePropsFromForm = lambda: \ ( {('file','-1'):{'content':'t','type':'text/plain','name':'t.txt'} ,('issue','4711'):{} } , [('issue','4711','messages',[('msg','-1')]) ,('issue','4711','files',[('file','-1')]) ,('msg','-1','files',[('file','-1')]) ] ) try : self.action.handle() except Redirect as msg: pass self.assertEqual(expect, self.result) def testLinkExisting(self): expect = [('set',('4711',),{'messages':['23','42','1']})] self.client.db.classes.get = lambda a, b:['23','42'] self.client.parsePropsFromForm = lambda: \ ( {('issue','4711'):{},('msg','1'):{}} , [('issue','4711','messages',[('msg','1')])] ) try : self.action.handle() except Redirect as msg: pass self.assertEqual(expect, self.result) def testLinkNewToExisting(self): expect = [('create',(),{'msg':'1','title':'TEST'})] self.client.db.classes.get = lambda a, b:['23','42'] self.client.parsePropsFromForm = lambda: \ ( {('issue','-1'):{'title':'TEST'},('msg','1'):{}} , [('issue','-1','msg',[('msg','1')])] ) try : self.action.handle() except Redirect as msg: pass self.assertEqual(expect, self.result) # vim: set et sts=4 sw=4 : code-e5bd50120b5a/test/test_admin.py0000644000000000000000000026510115064275501015405 0ustar 00000000000000# # Copyright (C) 2007 Stefan Seefeld # All rights reserved. # For license terms see the file COPYING.txt. # from __future__ import print_function import difflib import errno import fileinput import io import os import platform import pytest import re import shutil import sys import unittest from roundup.admin import AdminTool from .test_mysql import skip_mysql from .test_postgresql import skip_postgresql #from roundup import instance # https://stackoverflow.com/questions/4219717/how-to-assert-output-with-nosetest-unittest-in-python # lightly modified from contextlib import contextmanager _py3 = sys.version_info[0] > 2 if _py3: from io import StringIO # py3 else: from StringIO import StringIO # py2 @contextmanager def captured_output(): new_out, new_err = StringIO(), StringIO() old_out, old_err = sys.stdout, sys.stderr try: sys.stdout, sys.stderr = new_out, new_err yield sys.stdout, sys.stderr finally: sys.stdout, sys.stderr = old_out, old_err def normalize_file(filename, skiplines = [ None ]): # https://stackoverflow.com/questions/4710067/using-python-for-deleting-a-specific-line-in-a-file with open(filename, "r+") as f: d = f.readlines() f.seek(0) for i in d: for skip in skiplines: if skip not in i: f.write(i) f.truncate() def replace_in_file(filename, original, replacement): """replace text in a file. All occurances of original will be replaced by replacement""" for line in fileinput.input(filename, inplace = 1): print(line.replace(original, replacement)) fileinput.close() def find_in_file(filename, regexp): """search for regexp in file. If not found return false. If found return match. """ with open(filename) as f: contents = f.read() try: # handle text files with \r\n line endings contents.index("\r", 0, 100) contents = contents.replace("\r\n", "\n") except ValueError: pass m = re.search(regexp, contents, re.MULTILINE) if not m: return False return m.group(0) class AdminTest(object): backend = None def setUp(self): self.dirname = '_test_admin' @pytest.fixture(autouse=True) def inject_fixtures(self, monkeypatch): self._monkeypatch = monkeypatch def tearDown(self): try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def install_init(self, type="classic", settings="mail_domain=example.com," + "mail_host=localhost," + "tracker_web=http://test/," + "rdbms_name=rounduptest," + "rdbms_user=rounduptest," + "rdbms_password=rounduptest," + "rdbms_template=template0" ): ''' install tracker with settings for required config.ini settings. ''' admin=AdminTool() admin.force = True # force it to nuke existing tracker # Run under context manager to suppress output of help text. with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'install', type, self.backend, settings ] ret = admin.main() self.assertEqual(ret, 0) # nuke any existing database (mysql/postgreql) # possible method in case admin.force doesn't work #tracker = instance.open(self.dirname) #if tracker.exists(): # tracker.nuke() # initialize tracker with initial_data.py. Put password # on cli so I don't have to respond to prompting. sys.argv=['main', '-i', self.dirname, 'initialise', 'admin'] admin.force = True # force it to nuke existing database ret = admin.main() self.assertEqual(ret, 0) def testBasicInteractive(self): # first command is an error that should be handled inputs = iter(["'quit", "quit"]) orig_input = AdminTool.my_input AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 # set history_features to disable loading/saving history # and loading rc file. Otherwise file gets large and # breaks testing or overwrites the users history file. sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip() print(ret) self.assertTrue(ret == 0) expected = 'ready for input.\nType "help" for help.' # back up by 30 to make sure 'ready for input' in slice. self.assertIn(expected, "\n".join(out.split('\n')[-3:-1])) inputs = iter(["list user", "q"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip() print(ret) self.assertTrue(ret == 0) expected = ' 1: admin\n 2: anonymous' self.assertEqual(expected, "\n".join(out.split('\n')[-2:])) AdminTool.my_input = orig_input # test EOF exit inputs = ["help"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) # preserve directory self.install_init() self.admin=AdminTool() # disable all features self.admin.settings['history_features'] = 7 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) # 4 includes 2 commands in saved history expected = 'roundup> exit...' self.assertIn(expected, out) def testGet(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.install_init() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="foo bar"', 'assignedto=admin' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '1') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="bar foo bar"', 'assignedto=anonymous', 'superseder=1'] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() print(out) self.assertEqual(out, '2') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="bar foo bar"', 'assignedto=admin', 'superseder=1,2'] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() print(out) self.assertEqual(out, '3') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'get', 'assignedto', 'issue2' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, '2') self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-d', 'get', 'assignedto', 'issue2' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, 'user2') self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-d', '-S', ':', 'get', 'assignedto', 'issue2' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, 'user2') self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'get', 'superseder', 'issue2' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, "['1']") self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'get', 'superseder', 'issue3' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, "['1', '2']") self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-d', 'get', 'superseder', 'issue3' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, "issue1\nissue2") self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-c', '-d', 'get', 'superseder', 'issue3' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, "issue1,issue2") self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-d', 'get', 'title', 'issue3' ] ret = self.admin.main() self.assertEqual(ret, 1) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out.split('\n')[0], "Error: property title is not of type Multilink or Link so -d flag does not apply.") self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'get', 'title', 'issue1'] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, '"foo bar"') ## why is capture inserting "?? self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'get', 'tile', 'issue1'] ret = self.admin.main() expected_err = 'Error: no such issue property "tile"' self.assertEqual(ret, 1) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out.index(expected_err), 0) self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'get', 'title', 'issue'] ret = self.admin.main() expected_err = 'Error: "issue" not a node designator' self.assertEqual(ret, 1) out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out.index(expected_err), 0) self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'get', 'title', 'issue500'] ret = self.admin.main() expected_err = 'Error: no such issue node "500"' self.assertEqual(ret, 1) out = out.getvalue().strip() err = err.getvalue().strip() print(out) self.assertEqual(out.index(expected_err), 0) self.assertEqual(len(err), 0) def testInit(self): self.admin=AdminTool() sys.argv=['main', '-i', self.dirname, 'install', 'classic', self.backend] ret = self.admin.main() print(ret) self.assertTrue(ret == 0) self.assertTrue(os.path.isfile(self.dirname + "/config.ini")) self.assertTrue(os.path.isfile(self.dirname + "/schema.py")) nopath= '/tmp/noSuchDirectory/nodir' norealpath = os.path.realpath(nopath + "/..") self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', nopath, 'install', 'classic', self.backend] ret = self.admin.main() out = out.getvalue().strip() print(ret) print(out) self.assertEqual(ret, 1) self.assertIn('Error: Instance home parent directory ' '"%s" does not exist' % norealpath, out) def testInitWithConfig_ini(self): from roundup.configuration import CoreConfig self.admin=AdminTool() sys.argv=['main', '-i', self.dirname, 'install', 'classic', self.backend] # create a config_ini.ini file in classic template templates=self.admin.listTemplates() config_ini_content = "[mail]\n# comment\ndebug = SendMail.LOG\n" config_ini_path = templates['classic']['path'] + '/config_ini.ini' config_ini_file = open(config_ini_path, "w") config_ini_file.write(config_ini_content) config_ini_file.close() try: ret = self.admin.main() finally: try: # ignore file not found os.remove(config_ini_path) except OSError as e: # FileNotFound exception under py3 if e.errno == 2: pass else: raise print(ret) self.assertTrue(ret == 0) self.assertTrue(os.path.isfile(self.dirname + "/config.ini")) self.assertTrue(os.path.isfile(self.dirname + "/schema.py")) config=CoreConfig(self.dirname) self.assertEqual(config['MAIL_DEBUG'], os.path.normpath(self.dirname + "/SendMail.LOG")) def testList(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.install_init() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'list', 'user', 'username' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() print(out) self.assertEqual(out, '1: admin\n 2: anonymous') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-c', 'list', 'user' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() print(out) self.assertEqual(out, '1,2') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-c', 'list', 'user', 'username' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() print(out) self.assertEqual(out, 'admin,anonymous') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-c', 'list', 'user', 'roles' ] ret = self.admin.main() self.assertEqual(ret, 0) out = out.getvalue().strip() print(out) self.assertEqual(out, 'Admin,Anonymous') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'list', 'user', 'foo' ] ret = self.admin.main() self.assertEqual(ret, 1) out = out.getvalue().strip() print(out) self.assertEqual(out.split('\n')[0], 'Error: user has no property "foo"') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-c', 'list', 'user', 'bar' ] ret = self.admin.main() self.assertEqual(ret, 1) out = out.getvalue().strip() print(out) self.assertEqual(out.split('\n')[0], 'Error: user has no property "bar"') def testFind(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.admin=AdminTool() self.install_init() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="foo bar"', 'assignedto=admin' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '1') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="bar foo bar"', 'assignedto=anonymous' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '2') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'find', 'issue', 'assignedto=1'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, "['1']") # Reopen the db closed by previous filter call self.admin=AdminTool() with captured_output() as (out, err): ''' 1,2 should return all entries that have assignedto either admin or anonymous ''' sys.argv=['main', '-i', self.dirname, 'find', 'issue', 'assignedto=1,2'] ret = self.admin.main() out = out.getvalue().strip() print(out) # out can be "['2', '1']" or "['1', '2']" # so eval to real list so Equal can do a list compare self.assertEqual(sorted(eval(out)), ['1', '2']) # Reopen the db closed by previous filter call self.admin=AdminTool() with captured_output() as (out, err): ''' 1,2 should return all entries that have assignedto either admin or anonymous ''' sys.argv=['main', '-i', self.dirname, 'find', 'issue', 'assignedto=admin,anonymous'] ret = self.admin.main() out = out.getvalue().strip() print(out) # out can be "['2', '1']" or "['1', '2']" # so eval to real list so Equal can do a list compare self.assertEqual(sorted(eval(out)), ['1', '2']) # Reopen the db closed by previous filter call self.admin=AdminTool() with captured_output() as (out, err): ''' 1,2 should return all entries that have assignedto either admin or anonymous ''' sys.argv=['main', '-i', self.dirname, '-c', '-d', 'find', 'issue', 'assignedto=admin,anonymous'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, "issue1,issue2") # Reopen the db closed by previous filter call self.admin=AdminTool() with captured_output() as (out, err): ''' 1,2 should return all entries that have assignedto either admin or anonymous ''' sys.argv=['main', '-i', self.dirname, '-S', ':', 'find', 'issue', 'assignedto=admin,anonymous'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, "1:2") def testGenconfigUpdate(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' import filecmp self.admin=AdminTool() self.install_init() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'genconfig'] ret = self.admin.main() out = out.getvalue().strip() print(out) expected = "Not enough arguments supplied" self.assertTrue(expected in out) # Reopen the db closed by previous call self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'genconfig', self.dirname + "/config2.ini"] ret = self.admin.main() out = out.getvalue().strip() print(out) # FIXME get better successful test later. expected = "" self.assertTrue(expected in out) self.assertTrue(os.path.isfile(self.dirname + "/config2.ini")) # Files aren't the same. Lines need to be removed. # like user, web, backend etc. Genconfig generates a file # to be customized. #self.assertTrue(filecmp.cmp(self.dirname + "/config2.ini", # self.dirname + "/config.ini")) # Reopen the db closed by previous call self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'update', self.dirname + "/foo2.ini"] ret = self.admin.main() out = out.getvalue().strip() print(out) # FIXME get better successful test later. expected = "" self.assertTrue(expected in out) self.assertTrue(os.path.isfile(self.dirname + "/foo2.ini")) # Autogenerated date header is different. Remove it # so filecmp passes. normalize_file(self.dirname + "/foo2.ini", [ '# Autogenerated at' ]) normalize_file(self.dirname + "/config.ini", [ '# Autogenerated at' ]) self.assertTrue(filecmp.cmp(self.dirname + "/config.ini", self.dirname + "/foo2.ini")) def testUpdateconfigPbkdf2(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' import filecmp self.admin=AdminTool() self.install_init() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'updateconfig', self.dirname + "/config2.ini"] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, "") self.assertTrue(os.path.isfile(self.dirname + "/config2.ini")) # Autogenerated date header is different. Remove it # so filecmp passes. normalize_file(self.dirname + "/config2.ini", [ '# Autogenerated at' ]) normalize_file(self.dirname + "/config.ini", [ '# Autogenerated at' ]) self.assertTrue(filecmp.cmp(self.dirname + "/config.ini", self.dirname + "/config2.ini")) # Reopen the db closed by previous call self.admin=AdminTool() ### test replacement of old default value replace_in_file(self.dirname + "/config.ini", "= 250000", "= 10000") with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'update', self.dirname + "/config2.ini"] ret = self.admin.main() out = out.getvalue().strip() print(out) expected = "from old default of 10000 to new default of 250000." self.assertIn(expected, out) self.assertTrue(os.path.isfile(self.dirname + "/config2.ini")) self.assertEqual(find_in_file(self.dirname + "/config2.ini", "^password_.*= 250000$"), "password_pbkdf2_default_rounds = 250000") # Reopen the db closed by previous call self.admin=AdminTool() ### test replacement of too small value replace_in_file(self.dirname + "/config.ini", "= 10000", "= 10001") with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'update', self.dirname + "/config2.ini"] ret = self.admin.main() out = out.getvalue().strip() print(out) expected = ("Update 'password_pbkdf2_default_rounds' to a number " "equal to or larger\n than 250000.") self.assertIn(expected, out) self.assertTrue(os.path.isfile(self.dirname + "/config2.ini")) self.assertEqual(find_in_file(self.dirname + "/config2.ini", "^password_.*= 10001$"), "password_pbkdf2_default_rounds = 10001") # Reopen the db closed by previous call self.admin=AdminTool() ### test no action if value is large enough replace_in_file(self.dirname + "/config.ini", "= 10001", "= 2000001") with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'update', self.dirname + "/config2.ini"] ret = self.admin.main() out = out.getvalue().strip() print(out) expected = "" self.assertEqual(expected, out) self.assertTrue(os.path.isfile(self.dirname + "/config2.ini")) self.assertEqual(find_in_file(self.dirname + "/config2.ini", "^password_.*= 2000001$"), "password_pbkdf2_default_rounds = 2000001") def testCliParse(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.admin=AdminTool() self.install_init() # test partial command lookup fin -> calls find with captured_output() as (out, err): ''' assignedto is not a valid property=value, so report error. ''' sys.argv=['main', '-i', self.dirname, 'fin', 'issue', 'assignedto=1'] ret = self.admin.main() out = out.getvalue().strip() print(out) expected="[ '1' ]" self.assertTrue(expected, out) # Reopen the db closed by previous call self.admin=AdminTool() # test multiple matches with captured_output() as (out, err): ''' assignedto is not a valid property=value, so report error. ''' sys.argv=['main', '-i', self.dirname, 'f', 'issue', 'assignedto'] ret = self.admin.main() out = out.getvalue().strip() print(out) expected='Multiple commands match "f": filter, find' self.assertEqual(expected, out) # Reopen the db closed by previous call self.admin=AdminTool() # test broken command lookup xyzzy is not a valid command with captured_output() as (out, err): ''' assignedto is not a valid property=value, so report error. ''' sys.argv=['main', '-i', self.dirname, 'xyzzy', 'issue', 'assignedto'] ret = self.admin.main() out = out.getvalue().strip() print(out) expected=('Unknown command "xyzzy" ' '("help commands" for a list)') self.assertEqual(expected, out) # Reopen the db closed by previous call self.admin=AdminTool() # test for keyword=value check with captured_output() as (out, err): ''' assignedto is not a valid property=value, so report error. ''' sys.argv=['main', '-i', self.dirname, 'find', 'issue', 'assignedto'] ret = self.admin.main() out = out.getvalue().strip() print(out) expected='Error: argument "assignedto" not propname=value' self.assertTrue(expected in out) def testFilter(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.admin=AdminTool() self.install_init() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="foo bar"', 'assignedto=admin' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '1') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="bar foo bar"', 'assignedto=anonymous' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '2') # Reopen the db closed by previous filter call # test string - one results, one value, substring self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'filter', 'user', 'username=admin'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, "['1']") # Reopen the db closed by previous filter call # test string - two results, two values, substring self.admin=AdminTool() with captured_output() as (out, err): ''' a,n should return all entries that have an a and n so admin or anonymous ''' sys.argv=['main', '-i', self.dirname, 'filter', 'user', 'username=a,n'] ret = self.admin.main() out = out.getvalue().strip() print(out) # out can be "['2', '1']" or "['1', '2']" # so eval to real list so Equal can do a list compare self.assertEqual(sorted(eval(out)), ['1', '2']) # Reopen the db closed by previous filter call # test string - one result, two values, substring self.admin=AdminTool() with captured_output() as (out, err): ''' a,y should return all entries that have an a and y so anonymous ''' sys.argv=['main', '-i', self.dirname, 'filter', 'user', 'username=a,y'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, "['2']") # Reopen the db closed by previous filter call # test string - no results self.admin=AdminTool() with captured_output() as (out, err): ''' will return empty set as admin!=anonymous ''' sys.argv=['main', '-i', self.dirname, 'filter', 'user', 'username=admin,anonymous'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, "[]") # Reopen the db closed by previous filter call # test link using ids self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'filter', 'issue', 'assignedto=1,2'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(sorted(eval(out)), ['1', '2']) # Reopen the db closed by previous filter call # test link using names self.admin=AdminTool() with captured_output() as (out, err): ''' will return empty set as admin!=anonymous ''' sys.argv=['main', '-i', self.dirname, 'filter', 'issue', 'assignedto=admin,anonymous'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(sorted(eval(out)), ['1', '2']) # Reopen the db closed by previous filter call # # case: transitive property valid match self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'filter', 'issue', 'assignedto.roles=Anonymous'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, "['2']") # Reopen the db closed by previous filter call # self.admin=AdminTool() # case: transitive propery invalid prop self.admin=AdminTool() with captured_output() as (out, err): ''' assignedto is not a valid property=value, so report error. ''' sys.argv=['main', '-i', self.dirname, 'filter', 'issue', 'assignedto.badprop=Admin'] ret = self.admin.main() out = out.getvalue().strip() expected='Error: Class user has no property badprop in assignedto.badprop.' print(out[0:len(expected)]) self.assertEqual(expected, out[0:len(expected)]) # Reopen the db closed by previous filter call # # case: transitive property invalid match self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'filter', 'issue', 'assignedto.username=NoNAme'] ret = self.admin.main() out = out.getvalue().strip() print("me: " + out) print(err.getvalue().strip()) self.assertEqual(out, "[]") # Reopen the db closed by previous filter call # # case: transitive property invalid match self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-c', 'filter', 'issue', 'assignedto.username=NoNAme'] ret = self.admin.main() out = out.getvalue().strip() print("me: " + out) print(err.getvalue().strip()) self.assertEqual(out, "") # Reopen the db closed by previous filter call # # case: transitive property invalid match self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-c', 'filter', 'issue', 'assignedto.username=A'] ret = self.admin.main() out = out.getvalue().strip() print("me: " + out) print(err.getvalue().strip()) self.assertEqual(out, "1,2") # Reopen the db closed by previous filter call # # case: transitive property invalid match self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-s', 'filter', 'issue', 'assignedto.username=A'] ret = self.admin.main() out = out.getvalue().strip() print("me: " + out) print(err.getvalue().strip()) self.assertEqual(out, "1 2") # Reopen the db closed by previous filter call # # case: transitive property invalid match self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-S', ':', '-d', 'filter', 'issue', 'assignedto.username=A'] ret = self.admin.main() out = out.getvalue().strip() print("me: " + out) print(err.getvalue().strip()) self.assertEqual(out, "issue1:issue2") # Reopen the db closed by previous filter call # # case: transitive property invalid match self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-d', 'filter', 'issue', 'assignedto.username=A'] ret = self.admin.main() out = out.getvalue().strip() print("me: " + out) print(err.getvalue().strip()) self.assertEqual(out, "['issue1', 'issue2']") def testPragma_reopen_tracker(self): """test that _reopen_tracker works. """ if self.backend not in ['anydbm']: self.skipTest("For speed only run test with anydbm.") orig_input = AdminTool.my_input # must set verbose to see _reopen_tracker hidden setting. # and to get "Reopening tracker" verbose log output inputs = iter(["pragma verbose=true", "pragma list", "exit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = ' _reopen_tracker=False' self.assertIn(expected, out) self.assertIn('descriptions...', out[-1]) self.assertNotIn('Reopening tracker', out) # ----- inputs = iter(["pragma verbose=true", "pragma _reopen_tracker=True", "pragma list", "quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) self.assertEqual('Reopening tracker', out[3]) expected = ' _reopen_tracker=True' self.assertIn(expected, out) # ----- AdminTool.my_input = orig_input def testPragma(self): """Uses interactive mode since pragmas only apply when using multiple commands. """ if self.backend not in ['anydbm']: self.skipTest("For speed only run test with anydbm.") orig_input = AdminTool.my_input for i in ["oN", "1", "yeS", "True"]: inputs = iter(["pragma verbose=%s" % i, "pragma list", "quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = ' verbose=True' self.assertIn(expected, out) self.assertIn('descriptions...', out[-1]) # ----- for i in ["oFf", "0", "NO", "FalSe"]: inputs = iter(["pragma verbose=true", "pragma verbose=%s" % i, "pragma list", "quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = ' verbose=False' self.assertIn(expected, out) # ----- test syntax errors inputs = iter(["pragma", "pragma arg", "pragma foo=3","quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = 'Error: Not enough arguments supplied' self.assertIn(expected, out) expected = 'Error: Argument must be setting=value, was given: arg.' self.assertIn(expected, out) expected = 'Error: Unknown setting foo. Try "pragma list".' self.assertIn(expected, out) # ----- inputs = iter(["pragma verbose=foo", "quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = 'Error: Incorrect value for boolean setting verbose: foo.' self.assertIn(expected, out) # ----- inputs = iter(["pragma verbose=on", "pragma _inttest=5", "pragma list", "quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = ' _inttest=5' self.assertIn(expected, out) self.assertIn('descriptions...', out[-1]) # ----- inputs = iter(["pragma verbose=on", "pragma _inttest=fred", "pragma list", "quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = 'Error: Incorrect value for integer setting _inttest: fred.' self.assertIn(expected, out) self.assertIn('descriptions...', out[-1]) # ----- inputs = iter(["pragma indexer_backend=whoosh", "pragma list", "quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) expected = ' indexer_backend=whoosh' self.assertIn(expected, out) # ----- inputs = iter(["pragma _floattest=4.5", "quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) expected = 'Error: Internal error: pragma can not handle values of type: float' self.assertIn(expected, out) # ----- inputs = iter(["pragma display_protected=yes", "display user1", "quit"]) AdminTool.my_input = lambda _self, _prompt: next(inputs) self.install_init() self.admin=AdminTool() self.admin.settings['history_features'] = 2 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip() print(ret) expected = '\n*creation: ' self.assertIn(expected, out) # ----- AdminTool.my_input = orig_input def testReindex(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.install_init() # create an issue self.admin=AdminTool() sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="foo bar"', 'assignedto=admin' ] ret = self.admin.main() # reindex everything self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'reindex'] ret = self.admin.main() out = out.getvalue().strip() print(len(out)) print(repr(out)) # make sure priority is being reindexed self.assertIn('Reindex priority 40%', out) # reindex whole class self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'reindex', 'issue'] ret = self.admin.main() out = out.getvalue().strip() print(len(out)) print(repr(out)) self.assertEqual(out, 'Reindex issue 0% \rReindex issue 100% \rReindex issue done') self.assertEqual(len(out), 170) # reindex one item self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'reindex', 'issue1'] ret = self.admin.main() out = out.getvalue().strip() print(len(out)) print(repr(out)) # no output when reindexing just one item self.assertEqual(out, '') # reindex range self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'reindex', 'issue:1-4'] ret = self.admin.main() out = out.getvalue().strip() print(repr(out)) self.assertIn('no such item "issue3"', out) # reindex bad class self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'reindex', 'issue1-4'] ret = self.admin.main() out = out.getvalue().strip() print(repr(out)) self.assertIn('Error: no such class "issue1-4"', out) # reindex bad item self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'reindex', 'issue14'] ret = self.admin.main() out = out.getvalue().strip() print(repr(out)) self.assertIn('Error: no such item "issue14"', out) def disabletestHelpInitopts(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.install_init() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'help', 'initopts'] ret = self.admin.main() out = out.getvalue().strip() expected = [ 'Templates: minimal, jinja2, classic, responsive, devel', 'Back ends: anydbm, sqlite' ] print(out) self.assertTrue(expected[0] in out) self.assertTrue("Back ends:" in out) def testSecurityListOne(self): self.install_init() self.admin=AdminTool() with captured_output() as (out, err): # make sure UsEr returns result for user. Roles are # lower cased interally sys.argv=['main', '-i', self.dirname, 'security', "user" ] ret = self.admin.main() result = """Role "user": User may use the email interface (Email Access) User may access the rest interface (Rest Access) User may access the web interface (Web Access) User may access the xmlrpc interface (Xmlrpc Access) User is allowed to create file (Create for "file" only) User is allowed to edit file (Edit for "file" only) User is allowed to access file (View for "file" only) User is allowed to create issue (Create for "issue" only) User is allowed to edit issue (Edit for "issue" only) User is allowed to access issue (View for "issue" only) User is allowed to create keyword (Create for "keyword" only) User is allowed to edit keyword (Edit for "keyword" only) User is allowed to access keyword (View for "keyword" only) User is allowed to create msg (Create for "msg" only) User is allowed to edit msg (Edit for "msg" only) User is allowed to access msg (View for "msg" only) User is allowed to access priority (View for "priority" only) User is allowed to create queries (Create for "query" only) User is allowed to edit their queries (Edit for "query" only) User is allowed to restore their queries (Restore for "query" only) User is allowed to retire their queries (Retire for "query" only) (Search for "query" only) User is allowed to view their own and public queries (View for "query" only) User is allowed to access status (View for "status" only) User is allowed to edit their own user details (Edit for "user": ('username', 'password', 'address', 'realname', 'phone', 'organisation', 'alternate_addresses', 'queries', 'timezone') only) (View for "user": ('id', 'organisation', 'phone', 'realname', 'timezone', 'username') only) User is allowed to view their own user details (View for "user" only) """ print(out.getvalue()) self.assertEqual(result, out.getvalue()) self.assertEqual(ret, 0) # test 2 all role names are lower case, make sure # any role name is correctly lower cased self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'security', "UsEr" ] ret = self.admin.main() print(out.getvalue()) self.assertEqual(result, out.getvalue()) self.assertEqual(ret, 0) # test 3 Check error if role does not exist self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'security', "NoSuch Role" ] ret = self.admin.main() result='No such Role "NoSuch Role"\n' print('>', out.getvalue()) self.assertEqual(result, out.getvalue()) self.assertEqual(ret, 1) def testSecurityListAll(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.install_init() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'security' ] ret = self.admin.main() result = """New Web users get the Role "User" New Email users get the Role "User" Role "admin": User may create everything (Create) User may edit everything (Edit) User may use the email interface (Email Access) User may access the rest interface (Rest Access) User may restore everything (Restore) User may retire everything (Retire) User may view everything (View) User may access the web interface (Web Access) User may manipulate user Roles through the web (Web Roles) User may access the xmlrpc interface (Xmlrpc Access) Role "anonymous": User may access the web interface (Web Access) User is allowed to access file (View for "file" only) User is allowed to access issue (View for "issue" only) User is allowed to access keyword (View for "keyword" only) User is allowed to access msg (View for "msg" only) User is allowed to access priority (View for "priority" only) User is allowed to access status (View for "status" only) User is allowed to register new user (Register for "user" only) (Search for "user" only) Role "user": User may use the email interface (Email Access) User may access the rest interface (Rest Access) User may access the web interface (Web Access) User may access the xmlrpc interface (Xmlrpc Access) User is allowed to create file (Create for "file" only) User is allowed to edit file (Edit for "file" only) User is allowed to access file (View for "file" only) User is allowed to create issue (Create for "issue" only) User is allowed to edit issue (Edit for "issue" only) User is allowed to access issue (View for "issue" only) User is allowed to create keyword (Create for "keyword" only) User is allowed to edit keyword (Edit for "keyword" only) User is allowed to access keyword (View for "keyword" only) User is allowed to create msg (Create for "msg" only) User is allowed to edit msg (Edit for "msg" only) User is allowed to access msg (View for "msg" only) User is allowed to access priority (View for "priority" only) User is allowed to create queries (Create for "query" only) User is allowed to edit their queries (Edit for "query" only) User is allowed to restore their queries (Restore for "query" only) User is allowed to retire their queries (Retire for "query" only) (Search for "query" only) User is allowed to view their own and public queries (View for "query" only) User is allowed to access status (View for "status" only) User is allowed to edit their own user details (Edit for "user": ('username', 'password', 'address', 'realname', 'phone', 'organisation', 'alternate_addresses', 'queries', 'timezone') only) (View for "user": ('id', 'organisation', 'phone', 'realname', 'timezone', 'username') only) User is allowed to view their own user details (View for "user" only) """ print(out.getvalue()) self.assertEqual(result, out.getvalue()) self.assertEqual(ret, 0) def testSecurityInvalidAttribute(self): ''' Test with an invalid attribute. Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.maxDiff = None # we want full diff self.install_init() # edit in an invalid attribute/property with open(self.dirname + "/schema.py", "r+") as f: d = f.readlines() f.seek(0) for i in d: if "organisation" in i: i = i.replace("'id', 'organisation'","'id', 'organization'") f.write(i) f.truncate() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'security' ] ret = self.admin.main() result = """New Web users get the Role "User" New Email users get the Role "User" Role "admin": User may create everything (Create) User may edit everything (Edit) User may use the email interface (Email Access) User may access the rest interface (Rest Access) User may restore everything (Restore) User may retire everything (Retire) User may view everything (View) User may access the web interface (Web Access) User may manipulate user Roles through the web (Web Roles) User may access the xmlrpc interface (Xmlrpc Access) Role "anonymous": User may access the web interface (Web Access) User is allowed to access file (View for "file" only) User is allowed to access issue (View for "issue" only) User is allowed to access keyword (View for "keyword" only) User is allowed to access msg (View for "msg" only) User is allowed to access priority (View for "priority" only) User is allowed to access status (View for "status" only) User is allowed to register new user (Register for "user" only) (Search for "user" only) Role "user": User may use the email interface (Email Access) User may access the rest interface (Rest Access) User may access the web interface (Web Access) User may access the xmlrpc interface (Xmlrpc Access) User is allowed to create file (Create for "file" only) User is allowed to edit file (Edit for "file" only) User is allowed to access file (View for "file" only) User is allowed to create issue (Create for "issue" only) User is allowed to edit issue (Edit for "issue" only) User is allowed to access issue (View for "issue" only) User is allowed to create keyword (Create for "keyword" only) User is allowed to edit keyword (Edit for "keyword" only) User is allowed to access keyword (View for "keyword" only) User is allowed to create msg (Create for "msg" only) User is allowed to edit msg (Edit for "msg" only) User is allowed to access msg (View for "msg" only) User is allowed to access priority (View for "priority" only) User is allowed to create queries (Create for "query" only) User is allowed to edit their queries (Edit for "query" only) User is allowed to restore their queries (Restore for "query" only) User is allowed to retire their queries (Retire for "query" only) (Search for "query" only) User is allowed to view their own and public queries (View for "query" only) User is allowed to access status (View for "status" only) User is allowed to edit their own user details (Edit for "user": ('username', 'password', 'address', 'realname', 'phone', 'organisation', 'alternate_addresses', 'queries', 'timezone') only) (View for "user": ('id', 'organization', 'phone', 'realname', 'timezone', 'username') only) **Invalid properties for user: ['organization'] """ print(out.getvalue()) self.assertEqual(result, out.getvalue()) self.assertEqual(ret, 1) def testSet(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.install_init() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="foo bar"', 'assignedto=admin' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '1') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="bar foo bar"', 'assignedto=anonymous' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '2') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'set', 'issue2', 'title="new title"'] ret = self.admin.main() out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, '') self.assertEqual(err, '') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'set', 'issue2', 'tile="new title"'] ret = self.admin.main() expected_err = "Error: 'tile' is not a property of issue" out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out.index(expected_err), 0) self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'set', 'issue2'] ret = self.admin.main() expected_err = "Error: Not enough arguments supplied" out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out.index(expected_err), 0) self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'set', 'issue2,issue1,issue', "status=1" ] ret = self.admin.main() expected_err = 'Error: "issue" not a node designator' out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out.index(expected_err), 0) self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'set', 'issue2,issue1,user2', "status=1" ] ret = self.admin.main() expected_err = "Error: 'status' is not a property of user" out = out.getvalue().strip() err = err.getvalue().strip() print(out) print(expected_err) print(err) self.assertEqual(out.index(expected_err), 0) self.assertEqual(len(err), 0) self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'set', 'issue2,issue1,issue1000', "status=1" ] ret = self.admin.main() expected_err = 'Error: no such issue 1000' out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out.index(expected_err), 0) self.assertEqual(len(err), 0) def testSetOnClass(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.install_init() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="foo bar"', 'assignedto=admin' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '1') self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'issue', 'title="bar foo bar"', 'assignedto=anonymous' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '2') # Run this test in a separate test. # It can cause a database timeout/resource # unavailable error for anydbm when run with other tests. # Not sure why. # Set assignedto=2 for all issues ## verify that issue 1 and 2 are assigned to user1 and user2 self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'table', 'issue', 'assignedto'] ret = self.admin.main() expected = "Assignedto\n1 \n2" out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, expected) self.assertEqual(len(err), 0) self.admin=AdminTool() # do the set with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'set', 'issue', 'assignedto=2'] ret = self.admin.main() expected_err = "" out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, '') self.assertEqual(err, '') ## verify that issue 1 and 2 are assigned to user2 and user2 self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'table', 'issue', 'assignedto'] ret = self.admin.main() expected = "Assignedto\n2 \n2" out = out.getvalue().strip() err = err.getvalue().strip() self.assertEqual(out, expected) self.assertEqual(len(err), 0) def testReadline(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' '''history didn't work when testing. The commands being executed aren't being sent into the history buffer. Failed under both windows and linux. Explicitly using: readline.set_auto_history(True) in roundup-admin setup had no effect. Looks like monkeypatching stdin is the issue since: printf... | roundup-admin | tee doesn't work either when printf uses "readline vi\nreadline emacs\nreadline history\nquit\n" Added explicit readline.add_history() if stdin or stdout are not a tty to admin.py:interactive(). Still no way to drive editing with control/escape chars to verify editing mode, check keybindings. Need to trick Admintool to believe it's running on a tty/pty/con in linux/windows to remove my hack. ''' # Put the init file in the tracker test directory so # we don't clobber user's actual init file. original_home = None if 'HOME' in os.environ: original_home = os.environ['HOME'] os.environ['HOME'] = self.dirname # same but for windows. original_userprofile = None if 'USERPROFILE' in os.environ: # windows original_userprofile = os.environ['USERPROFILE'] os.environ['USERPROFILE'] = self.dirname inputs = ["readline vi", "readline emacs", "readline reload", "quit"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) self.install_init() self.admin=AdminTool() # disable loading and saving history self.admin.settings['history_features'] = 3 # verify correct init file is being self.assertIn(os.path.join(os.path.expanduser("~"), ".roundup_admin_rlrc"), self.admin.get_readline_init_file()) # No exception is raised for missing file # under pyreadline3. Detect pyreadline3 looking for: # readline.Readline pyreadline = hasattr(self.admin.readline, "Readline") sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = 'roundup> Enabled vi mode.' self.assertIn(expected, out) expected = 'roundup> Enabled emacs mode.' self.assertIn(expected, out) if not pyreadline: expected = ('roundup> Init file %s ' 'not found.' % self.admin.get_readline_init_file()) self.assertIn(expected, out) # --- test 2 inputs = ["readline reload", "q"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) self.install_init() self.admin=AdminTool() with open(self.admin.get_readline_init_file(), "w") as config_file: # there is no config line that works for all # pyreadline3 (windows), readline(*nix), or editline # (mac). So write empty file. config_file.write("") # disable loading and saving history self.admin.settings['history_features'] = 3 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = ('roundup> File %s reloaded.' % self.admin.get_readline_init_file()) self.assertIn(expected, out) # --- test 3,4 - make sure readline gets history_length pragma. # test CLI and interactive. inputs = ["pragma list", "q"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) self.install_init() self.admin=AdminTool() # disable all config/history self.admin.settings['history_features'] = 7 sys.argv=['main', '-i', self.dirname, '-P', 'history_length=11'] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) self.assertEqual(self.admin.readline.get_history_length(), 11) # 4 inputs = ["pragma history_length=17", "q"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) self.install_init() self.admin=AdminTool() # disable all config/history self.admin.settings['history_features'] = 7 # keep pragma in CLI. Make sure it's overridden by interactive sys.argv=['main', '-i', self.dirname, '-P', 'history_length=11'] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) # should not be 11. self.assertEqual(self.admin.readline.get_history_length(), 17) # --- test 5 invalid single word parameter inputs = ["readline nosuchdirective", "q"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) self.install_init() self.admin=AdminTool() # disable loading and saving history self.admin.settings['history_features'] = 3 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = ('roundup> Unknown readline parameter nosuchdirective') self.assertIn(expected, out) # --- test 6 set keystroke command. # FIXME: unable to test key binding/setting actually works. # # No errors seem to come back from readline or # pyreadline3 even when the keybinding makes no # sense. Errors are only reported when reading # from init file. Using "set answer 42" does print # 'readline: answer: unknown variable name' when # attached to tty/pty and interactive, but not # inside test case. Pyreadline3 doesn't # report errors at all. # # Even if I set a keybidning, I can't invoke it # because I am not running inside a pty, so # editing is disabled and I have no way to # simulate keyboard keystrokes for readline to act # upon. inputs = ['readline set meaning 42', "q"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) self.install_init() self.admin=AdminTool() # disable loading and saving history self.admin.settings['history_features'] = 3 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) # === cleanup if original_home: os.environ['HOME'] = original_home if original_userprofile: os.environ['USERPROFILE'] = original_userprofile def test_admin_history_save_load(self): # To prevent overwriting/reading user's actual history, # change HOME enviroment var. original_home = None if 'HOME' in os.environ: original_home = os.environ['HOME'] os.environ['HOME'] = self.dirname os.environ['HOME'] = self.dirname # same idea but windows original_userprofile = None if 'USERPROFILE' in os.environ: # windows original_userprofile = os.environ['USERPROFILE'] os.environ['USERPROFILE'] = self.dirname # -- history test inputs = ["readline history", "q"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) self.install_init() self.admin=AdminTool() # use defaults load/save history self.admin.settings['history_features'] = 0 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = 'roundup> history size 1' self.assertIn(expected, out) expected = ' 1 readline history' self.assertIn(expected, out) # -- history test 3 reruns readline vi inputs = ["readline vi", "readline history", "!3", "readline history", "!23s", "q"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) # preserve directory self.install_init() self.admin=AdminTool() # default use all features #self.admin.settings['history_features'] = 3 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) # 4 includes 2 commands in saved history expected = 'roundup> history size 4' self.assertIn(expected, out) expected = ' 4 readline history' self.assertIn(expected, out) # Shouldn't work on windows. if platform.system() != "Windows": expected = ' 5 readline vi' self.assertIn(expected, out) else: # PYREADLINE UNDER WINDOWS # py3readline on windows can't replace # command strings in history when connected # to a console. (Console triggers autosave and # I have to turn !3 into it's substituted value.) # but in testing autosave is disabled so # I don't get the !number but the actual command # It should have # # expected = ' 5 !3' # # but it is the same as the unix case. expected = ' 5 readline vi' self.assertIn(expected, out) expected = ('roundup> Unknown command "!23s" ("help commands" ' 'for a list)') self.assertIn(expected, out) print(out) # can't test !#:p mode as readline editing doesn't work # if not in a tty. # === cleanup if original_home: os.environ['HOME'] = original_home if original_userprofile: os.environ['USERPROFILE'] = original_userprofile def test_admin_readline_history(self): original_home = os.environ['HOME'] # To prevent overwriting/reading user's actual history, # change HOME enviroment var. os.environ['HOME'] = self.dirname original_userprofile = None if 'USERPROFILE' in os.environ: # windows original_userprofile = os.environ['USERPROFILE'] os.environ['USERPROFILE'] = self.dirname # -- history test inputs = ["readline history", "q"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) self.install_init() self.admin=AdminTool() # disable loading, but save history self.admin.settings['history_features'] = 3 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = 'roundup> history size 1' self.assertIn(expected, out) expected = ' 1 readline history' self.assertIn(expected, out) # -- history test inputs = ["readline vi", "readline history", "!1", "!2", "q"] self._monkeypatch.setattr( 'sys.stdin', io.StringIO("\n".join(inputs))) self.install_init() self.admin=AdminTool() # disable loading, but save history self.admin.settings['history_features'] = 3 sys.argv=['main', '-i', self.dirname] with captured_output() as (out, err): ret = self.admin.main() out = out.getvalue().strip().split('\n') print(ret) self.assertTrue(ret == 0) expected = 'roundup> history size 2' self.assertIn(expected, out) expected = ' 2 readline history' self.assertIn(expected, out) # doesn't work on windows. if platform.system() != "Windows": expected = ' 4 readline history' self.assertIn(expected, out) else: # See # PYREADLINE UNDER WINDOWS # elsewhere in this file for why I am not checking for # expected = ' 4 !2' expected = ' 4 readline history' self.assertIn(expected, out) # can't test !#:p mode as readline editing doesn't work # if not in a tty. # === cleanup os.environ['HOME'] = original_home if original_userprofile: os.environ['USERPROFILE'] = original_userprofile def testSpecification(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.install_init() self.admin=AdminTool() spec= [ 'username: (key property)', 'alternate_addresses: ', 'realname: ', 'roles: ', 'organisation: ', 'queries: ', 'phone: ', 'address: ', 'timezone: ', 'password: ', ] with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'specification', 'user'] ret = self.admin.main() outlist = out.getvalue().strip().split("\n") print(outlist) self.assertEqual(sorted(outlist), sorted(spec)) # ----- self.install_init() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-P', 'display_protected=1', 'specification', 'user'] ret = self.admin.main() outlist = out.getvalue().strip().split('\n') protected = [ 'id: ', 'creation: ', 'activity: ', 'creator: ', 'actor: '] print(outlist) self.assertEqual(sorted(outlist), sorted(spec + protected)) def testRetireRestore(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' # create user1 at id 3 self.install_init() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'user', 'username=user1', 'address=user1' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '3') # retire user1 at id 3 self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'retire', 'user3'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '') # create new user1 at id 4 - note need unique address to succeed. self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'create', 'user', 'username=user1', 'address=user1a' ] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '4') # fail to restore old user1 at id 3 self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'restore', 'user3'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertIn('Error: Key property (username) of retired node clashes with existing one (user1)', out) # verify that user4 is listed self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'list', 'user'] ret = self.admin.main() out = out.getvalue().strip() print(out) expected="1: admin\n 2: anonymous\n 4: user1" self.assertEqual(out, expected) # retire user4 self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'retire', 'user4'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '') # now we can restore user3 self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'restore', 'user3'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertEqual(out, '') # verify that user3 is listed self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'list', 'user'] ret = self.admin.main() out = out.getvalue().strip() print(out) expected="1: admin\n 2: anonymous\n 3: user1" self.assertEqual(out, expected) # test show_retired pragma three cases: # no - no retired items # only - only retired items # both - all items # verify that user4 only is listed self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-P', 'show_retired=only', 'list', 'user'] ret = self.admin.main() out = out.getvalue().strip() print(out) expected="4: user1" self.assertEqual(out, expected) # verify that all users are shown self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-P', 'show_retired=both', 'list', 'user'] ret = self.admin.main() out_list = sorted(out.getvalue().strip().split("\n")) print(out) expected_list=sorted("1: admin\n 2: anonymous\n 3: user1\n 4: user1".split("\n")) self.assertEqual(out_list, expected_list) # verify that active users are shown self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-P', 'show_retired=no', 'list', 'user'] ret = self.admin.main() out = out.getvalue().strip() print(out) expected="1: admin\n 2: anonymous\n 3: user1" self.assertEqual(out, expected) # test display headers for retired/active self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, '-P', 'display_header=yes', 'display', 'user3,user4'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertIn("[user3 (active)]\n", out) self.assertIn( "[user4 (retired)]\n", out) # test that there are no headers self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'display', 'user3,user4'] ret = self.admin.main() out = out.getvalue().strip() print(out) self.assertNotIn("user3", out) self.assertNotIn("user4", out) def testTable(self): ''' Note the tests will fail if you run this under pdb. the context managers capture the pdb prompts and this screws up the stdout strings with (pdb) prefixed to the line. ''' self.install_init() self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'table' ] ret = self.admin.main() expected = 'Error: Not enough arguments supplied' out = out.getvalue().strip() print(out) print(expected) self.assertTrue(expected in out) #### self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'table', 'id,realname,username' ] ret = self.admin.main() expected = 'Error: no such class "id,realname,username"' out = out.getvalue().strip() print(out) print(expected) self.assertTrue(expected in out) #### self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'table', 'user', 'id,realname,username:4:3' ] ret = self.admin.main() expected = 'Error: "username:4:3" not name:width' out = out.getvalue().strip() print(out) print(expected) self.assertTrue(expected in out) #### self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'table', 'user', 'id,realname,title:4' ] ret = self.admin.main() expected = 'Error: user has no property "title"' out = out.getvalue().strip() print(out) print(expected) self.assertTrue(expected in out) #### self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'table', 'user', 'id,realname,username:' ] ret = self.admin.main() # note whitespace matters. trailing spaces on lines 1 and 2 expected = """Id Realname Username 1 None admin 2 None anonymou""" out = out.getvalue().strip() print(out) print(expected) self.assertEqual(out, expected) #### self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'table', 'user', 'id,realname,username' ] ret = self.admin.main() # note whitespace matters. trailing spaces on lines 1 and 2 expected = """Id Realname Username 1 None admin 2 None anonymous""" out = out.getvalue().strip() print(out) print(expected) self.assertEqual(out, expected) #### self.admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'table', 'user', 'id:4,realname:2,username:3' ] ret = self.admin.main() # note whitespace matters. trailing spaces on lines 1 and 2 expected = """Id Realname Username 1 No adm 2 No ano""" out = out.getvalue().strip() print(out) print(expected) self.assertEqual(out, expected) def testTemplates(self): self.install_init() self.admin=AdminTool() with captured_output() as (out, err): # command does not require a tracker home. use missing zZzZ # directory to cause error if that changes sys.argv=['main', '-i', "zZzZ", 'templates' ] ret = self.admin.main() out = out.getvalue().strip() # all 5 standard trackers should be found for tracker in ['Name: classic\nPath:', 'Name: devel\nPath:', 'Name: jinja2\nPath:', 'Name: minimal\nPath:', 'Name: responsive\nPath:']: self.assertIn(tracker, out) with captured_output() as (out, err): # command does not require a tracker home. use missing zZzZ # directory to cause error if that changes sys.argv=['main', '-i', "zZzZ", 'templates', 'trace_search' ] ret = self.admin.main() out = out.getvalue().strip() expected = "/*\n" self.assertIn(expected, out) class anydbmAdminTest(AdminTest, unittest.TestCase): backend = 'anydbm' @skip_mysql class mysqlAdminTest(AdminTest, unittest.TestCase): backend = 'mysql' class sqliteAdminTest(AdminTest, unittest.TestCase): backend = 'sqlite' @skip_postgresql class postgresqlAdminTest(AdminTest, unittest.TestCase): backend = 'postgresql' code-e5bd50120b5a/test/test_anydbm.py0000644000000000000000000000451715064275501015571 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import unittest, os, shutil, time from roundup.backends import get_backend from .db_test_base import DBTest, ROTest, SchemaTest, ClassicInitTest, config from .db_test_base import HTMLItemTest, SpecialActionTest from .rest_common import TestCase as RestTestCase from roundup.anypy import strings class anydbmOpener: module = get_backend('anydbm') def nuke_database(self): shutil.rmtree(config.DATABASE) class anydbmDBTest(anydbmOpener, DBTest, unittest.TestCase): pass class anydbmROTest(anydbmOpener, ROTest, unittest.TestCase): pass class anydbmSchemaTest(anydbmOpener, SchemaTest, unittest.TestCase): pass class anydbmClassicInitTest(ClassicInitTest, unittest.TestCase): backend = 'anydbm' class anydbmHTMLItemTest(HTMLItemTest, unittest.TestCase): backend = 'anydbm' from .session_common import SessionTest class anydbmSessionTest(anydbmOpener, SessionTest, unittest.TestCase): s2b = lambda x,y: strings.s2b(y) def get_ts(self): return (self.sessions.get('random_session', '__timestamp'),) def testDbType(self): self.assertIn("back_anydbm", repr(self.db)) self.assertIn("roundup.backends.sessions_dbm.Sessions", repr(self.db.Session)) class anydbmSpecialActionTestCase(anydbmOpener, SpecialActionTest, unittest.TestCase): backend = 'anydbm' class anydbmRestTest (RestTestCase, unittest.TestCase): backend = 'anydbm' # vim: set filetype=python ts=4 sw=4 et si code-e5bd50120b5a/test/test_anypy.py0000644000000000000000000000425015064275501015451 0ustar 00000000000000"""Random tests for anypy modules""" import unittest from roundup.anypy.strings import repr_export, eval_import from roundup.anypy.cmp_ import _test import sys _py3 = sys.version_info[0] > 2 class StringsTest(unittest.TestCase): def test_import_params(self): """ issue2551170 - handle long int in history/journal params tuple """ # python2 export with id as number val = eval_import("('issue', 2345L, 'status')") self.assertSequenceEqual(val, ('issue', 2345, 'status')) # eval a tuple e.g. date representation val = eval_import("(2022, 9, 6, 3, 58, 4.776, 0, 0, 0)") self.assertSequenceEqual(val, (2022, 9, 6, 3, 58, 4.776, 0, 0, 0)) # eval a boolean val = eval_import("False") self.assertEqual(val, False) val = eval_import("True") self.assertEqual(val, True) # check syntax error for testcase in ['true', '(2004, 10, 20', "2000, 10, 22)", "test'", '"test']: with self.assertRaises(ValueError) as m: val = eval_import(testcase) print(m.exception) # python3 export with id as number val = eval_import("('issue', 2345, 'status')") self.assertSequenceEqual(val, ('issue', 2345, 'status')) # python2 or python3 export with id as string val = eval_import("('issue', '2345', 'status')") self.assertSequenceEqual(val, ('issue', '2345', 'status')) def test_export_params(self): """ issue2551170 - handle long int in history/journal params tuple """ # python2 export with id as number if _py3: val = repr_export(('issue', 2345, 'status')) self.assertEqual(val, "('issue', 2345, 'status')") else: val = repr_export(('issue', long(2345), 'status')) self.assertEqual(val, "('issue', 2345L, 'status')") # python2 or python3 export with id as string val = repr_export(('issue', '2345', 'status')) self.assertEqual(val, "('issue', '2345', 'status')") class MiscTest(unittest.TestCase): def test_cmp_(self): _test() code-e5bd50120b5a/test/test_cgi.py0000644000000000000000000047416415064275501015072 0ustar 00000000000000# # Copyright (c) 2003 Richard Jones, rjones@ekit-inc.com # 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. from __future__ import print_function import unittest, os, shutil, errno, sys, difflib, re, io import pytest import copy from os.path import normpath from roundup.anypy.cgi_ import cgi from roundup.cgi import client, actions, exceptions from roundup.cgi.exceptions import FormError, NotFound, Redirect, NotModified from roundup.exceptions import UsageError, Reject from roundup.cgi.templating import HTMLItem, HTMLRequest, NoTemplate from roundup.cgi.templating import HTMLProperty, _HTMLItem, anti_csrf_nonce from roundup.cgi.templating import TemplatingUtils from roundup.cgi.form_parser import FormParser from roundup import init, instance, password, hyperdb, date from roundup.anypy.strings import u2s, b2s, s2b from roundup.test.tx_Source_detector import init as tx_Source_init from time import sleep # For testing very simple rendering from roundup.cgi.engine_zopetal import RoundupPageTemplate from roundup.test.mocknull import MockNull from . import db_test_base from .db_test_base import FormTestParent, setupTracker, FileUpload from .cmp_helper import StringFragmentCmpHelper from .test_postgresql import skip_postgresql from .test_mysql import skip_mysql class FileList: def __init__(self, name, *files): self.name = name self.files = files def items (self): for f in self.files: yield (self.name, f) class testFtsQuery(object): def testRenderContextFtsQuery(self): self.db.issue.create(title='i1 is found', status="chatting") self.client.form=db_test_base.makeForm( { "@ok_message": "ok message", "@template": "index", "@search_text": "found"}) self.client.path = 'issue' self.client.determine_context() result = self.client.renderContext() expected = '">i1 is found' self.assertIn(expected, result) self.assertEqual(self.client.response_code, 200) cm = client.add_message class MessageTestCase(unittest.TestCase): # Note: Escaping is now handled on a message-by-message basis at a # point where we still know what generates a message. In this way we # can decide when to escape and when not. We test the add_message # routine here. # Of course we won't catch errors in judgement when to escape here # -- but at the time of this change only one message is not escaped. def testAddMessageOK(self): self.assertEqual(cm([],'a\nb'), ['a
\nb']) self.assertEqual(cm([],'a\nb\nc\n'), ['a
\nb
\nc
\n']) def testAddMessageBAD(self): self.assertEqual(cm([],''), ['<script>x</script>']) self.assertEqual(cm([],''), ['<iframe>x</iframe>']) self.assertEqual(cm([],'<>'), ['<<script >>alert(42);5<</script >>']) self.assertEqual(cm([],'x'), ['<a href="y">x</a>']) self.assertEqual(cm([],'x'), ['<a href="<y>">x</a>']) self.assertEqual(cm([],'x'), ['<A HREF="y">x</A>']) self.assertEqual(cm([],'
x
'), ['<br>x<br />']) self.assertEqual(cm([],'x'), ['<i>x</i>']) self.assertEqual(cm([],'x'), ['<b>x</b>']) self.assertEqual(cm([],'
x
'), ['<BR>x<BR />']) self.assertEqual(cm([],'x'), ['<I>x</I>']) self.assertEqual(cm([],'x'), ['<B>x</B>']) def testAddMessageNoEscape(self): self.assertEqual(cm([],'x',False), ['x']) self.assertEqual(cm([],'x\nx',False), ['x
\nx']) class testCsvExport(object): def testCSVExportBase(self): cl = self._make_client( {'@columns': 'id,title,status,keyword,assignedto,nosy,creation'}, nodeid=None, userid='1') cl.classname = 'issue' demo_id=self.db.user.create(username='demo', address='demo@test.test', roles='User', realname='demo') key_id1=self.db.keyword.create(name='keyword1') key_id2=self.db.keyword.create(name='keyword2') originalDate = date.Date dummy=date.Date('2000-06-26.00:34:02.0') # is a closure the best way to return a static Date object?? def dummyDate(adate=None): def dummyClosure(adate=None, translator=None): return dummy return dummyClosure date.Date = dummyDate() self.db.issue.create(title='foo1', status='2', assignedto='4', nosy=['3',demo_id]) self.db.issue.create(title='bar2', status='1', assignedto='3', keyword=[key_id1,key_id2]) self.db.issue.create(title='baz32', status='4') output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # call export version that outputs names actions.ExportCSVAction(cl).handle() should_be=(s2b('"id","title","status","keyword","assignedto","nosy","creation"\r\n' '"1","foo1","deferred","","Contrary, Mary","Bork, Chef;Contrary, Mary;demo","2000-06-26 00:34"\r\n' '"2","bar2","unread","keyword1;keyword2","Bork, Chef","Bork, Chef","2000-06-26 00:34"\r\n' '"3","baz32","need-eg","","","","2000-06-26 00:34"\r\n')) #print(should_be) #print(output.getvalue()) self.assertEqual(output.getvalue(), should_be) output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # call export version that outputs id numbers actions.ExportCSVWithIdAction(cl).handle() should_be = s2b('"id","title","status","keyword","assignedto","nosy","creation"\r\n' '''"1","foo1","2","[]","4","['3', '4', '5']","2000-06-26.00:34:02"\r\n''' '''"2","bar2","1","['1', '2']","3","['3']","2000-06-26.00:34:02"\r\n''' '''"3","baz32","4","[]","None","[]","2000-06-26.00:34:02"\r\n''') #print(should_be) #print(output.getvalue()) self.assertEqual(output.getvalue(), should_be) # reset the real date command date.Date = originalDate # test full text search # call export version that outputs names cl = self._make_client( {'@columns': 'id,title,status,keyword,assignedto,nosy', "@search_text": "bar2"}, nodeid=None, userid='1') cl.classname = 'issue' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output actions.ExportCSVAction(cl).handle() should_be=(s2b('"id","title","status","keyword","assignedto","nosy"\r\n' '"2","bar2","unread","keyword1;keyword2","Bork, Chef","Bork, Chef"\r\n')) self.assertEqual(output.getvalue(), should_be) # call export version that outputs id numbers output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output actions.ExportCSVWithIdAction(cl).handle() should_be = s2b('"id","title","status","keyword","assignedto","nosy"\r\n' "\"2\",\"bar2\",\"1\",\"['1', '2']\",\"3\",\"['3']\"\r\n") self.assertEqual(output.getvalue(), should_be) class FormTestCase(FormTestParent, StringFragmentCmpHelper, testCsvExport, unittest.TestCase): def setUp(self): FormTestParent.setUp(self) tx_Source_init(self.db) test = self.instance.backend.Class(self.db, "test", string=hyperdb.String(), number=hyperdb.Number(), intval=hyperdb.Integer(), boolean=hyperdb.Boolean(), link=hyperdb.Link('test'), multilink=hyperdb.Multilink('test'), date=hyperdb.Date(), messages=hyperdb.Multilink('msg'), interval=hyperdb.Interval(), pw=hyperdb.Password() ) # compile the labels re classes = '|'.join(self.db.classes.keys()) self.FV_SPECIAL = re.compile(FormParser.FV_LABELS%classes, re.VERBOSE) # # form label extraction # def tl(self, s, c, i, a, p): m = self.FV_SPECIAL.match(s) self.assertNotEqual(m, None) d = m.groupdict() self.assertEqual(d['classname'], c) self.assertEqual(d['id'], i) for action in 'required add remove link note file'.split(): if a == action: self.assertNotEqual(d[action], None) else: self.assertEqual(d[action], None) self.assertEqual(d['propname'], p) def testLabelMatching(self): self.tl('', None, None, None, '') self.tl(':required', None, None, 'required', None) self.tl(':confirm:', None, None, 'confirm', '') self.tl(':add:', None, None, 'add', '') self.tl(':remove:', None, None, 'remove', '') self.tl(':link:', None, None, 'link', '') self.tl('test1:', 'test', '1', None, '') self.tl('test1:required', 'test', '1', 'required', None) self.tl('test1:add:', 'test', '1', 'add', '') self.tl('test1:remove:', 'test', '1', 'remove', '') self.tl('test1:link:', 'test', '1', 'link', '') self.tl('test1:confirm:', 'test', '1', 'confirm', '') self.tl('test-1:', 'test', '-1', None, '') self.tl('test-1:required', 'test', '-1', 'required', None) self.tl('test-1:add:', 'test', '-1', 'add', '') self.tl('test-1:remove:', 'test', '-1', 'remove', '') self.tl('test-1:link:', 'test', '-1', 'link', '') self.tl('test-1:confirm:', 'test', '-1', 'confirm', '') self.tl(':note', None, None, 'note', None) self.tl(':file', None, None, 'file', None) # # Empty form # def testNothing(self): self.assertEqual(self.parseForm({}), ({('test', None): {}}, [])) def testNothingWithRequired(self): self.assertRaises(FormError, self.parseForm, {':required': 'string'}) self.assertRaises(FormError, self.parseForm, {':required': 'title,status', 'status':'1'}, 'issue') self.assertRaises(FormError, self.parseForm, {':required': ['title','status'], 'status':'1'}, 'issue') self.assertRaises(FormError, self.parseForm, {':required': 'status', 'status':''}, 'issue') self.assertRaises(FormError, self.parseForm, {':required': 'nosy', 'nosy':''}, 'issue') self.assertRaises(FormError, self.parseForm, {':required': 'msg-1@content', 'msg-1@content':''}, 'issue') self.assertRaises(FormError, self.parseForm, {':required': 'msg-1@content'}, 'issue') # # Nonexistant edit # def testEditNonexistant(self): self.assertRaises(FormError, self.parseForm, {'boolean': ''}, 'test', '1') # # String # def testEmptyString(self): self.assertEqual(self.parseForm({'string': ''}), ({('test', None): {}}, [])) self.assertEqual(self.parseForm({'string': ' '}), ({('test', None): {}}, [])) self.assertRaises(FormError, self.parseForm, {'string': ['', '']}) def testSetString(self): self.assertEqual(self.parseForm({'string': 'foo'}), ({('test', None): {'string': 'foo'}}, [])) self.assertEqual(self.parseForm({'string': 'a\r\nb\r\n'}), ({('test', None): {'string': 'a\nb'}}, [])) nodeid = self.db.issue.create(title='foo') self.assertEqual(self.parseForm({'title': 'foo'}, 'issue', nodeid), ({('issue', nodeid): {}}, [])) def testEmptyStringSet(self): nodeid = self.db.issue.create(title='foo') self.assertEqual(self.parseForm({'title': ''}, 'issue', nodeid), ({('issue', nodeid): {'title': None}}, [])) nodeid = self.db.issue.create(title='foo') self.assertEqual(self.parseForm({'title': ' '}, 'issue', nodeid), ({('issue', nodeid): {'title': None}}, [])) def testStringLinkId(self): self.db.status.set('1', name='2') self.db.status.set('2', name='1') issue = self.db.issue.create(title='i1-status1', status='1') self.assertEqual(self.db.issue.get(issue,'status'),'1') self.assertEqual(self.db.status.lookup('1'),'2') self.assertEqual(self.db.status.lookup('2'),'1') self.assertEqual(self.db.issue.get('1','tx_Source'),'web') form = cgi.FieldStorage() cl = client.Client(self.instance, None, {'PATH_INFO':'/'}, form) cl.classname = 'issue' cl.nodeid = issue cl.db = self.db cl.language = ('en',) item = HTMLItem(cl, 'issue', issue) self.assertEqual(item.status.id, '1') self.assertEqual(item.status.name, '2') def testStringMultilinkId(self): id = self.db.keyword.create(name='2') self.assertEqual(id,'1') id = self.db.keyword.create(name='1') self.assertEqual(id,'2') issue = self.db.issue.create(title='i1-status1', keyword=['1']) self.assertEqual(self.db.issue.get(issue,'keyword'),['1']) self.assertEqual(self.db.keyword.lookup('1'),'2') self.assertEqual(self.db.keyword.lookup('2'),'1') self.assertEqual(self.db.issue.get(issue,'tx_Source'),'web') form = cgi.FieldStorage() cl = client.Client(self.instance, None, {'PATH_INFO':'/'}, form) cl.classname = 'issue' cl.nodeid = issue cl.db = self.db cl.language = ('en',) cl.userid = '1' item = HTMLItem(cl, 'issue', issue) for keyword in item.keyword: self.assertEqual(keyword.id, '1') self.assertEqual(keyword.name, '2') def testFileUpload(self): file = FileUpload('foo', 'foo.txt') self.assertEqual(self.parseForm({'content': file}, 'file'), ({('file', None): {'content': 'foo', 'name': 'foo.txt', 'type': 'text/plain'}}, [])) def testSingleFileUpload(self): file = FileUpload('foo', 'foo.txt') self.assertEqual(self.parseForm({'@file': file}, 'issue'), ({('file', '-1'): {'content': 'foo', 'name': 'foo.txt', 'type': 'text/plain'}, ('issue', None): {}}, [('issue', None, 'files', [('file', '-1')])])) def testMultipleFileUpload(self): f1 = FileUpload('foo', 'foo.txt') f2 = FileUpload('bar', 'bar.txt') f3 = FileUpload('baz', 'baz.txt') files = FileList('@file', f1, f2, f3) self.assertEqual(self.parseForm(files, 'issue'), ({('file', '-1'): {'content': 'foo', 'name': 'foo.txt', 'type': 'text/plain'}, ('file', '-2'): {'content': 'bar', 'name': 'bar.txt', 'type': 'text/plain'}, ('file', '-3'): {'content': 'baz', 'name': 'baz.txt', 'type': 'text/plain'}, ('issue', None): {}}, [ ('issue', None, 'files', [('file', '-1')]) , ('issue', None, 'files', [('file', '-2')]) , ('issue', None, 'files', [('file', '-3')]) ])) def testEditFileClassAttributes(self): self.assertEqual(self.parseForm({'name': 'foo.txt', 'type': 'application/octet-stream'}, 'file'), ({('file', None): {'name': 'foo.txt', 'type': 'application/octet-stream'}},[])) # # Link # def testEmptyLink(self): self.assertEqual(self.parseForm({'link': ''}), ({('test', None): {}}, [])) self.assertEqual(self.parseForm({'link': ' '}), ({('test', None): {}}, [])) self.assertRaises(FormError, self.parseForm, {'link': ['', '']}) self.assertEqual(self.parseForm({'link': '-1'}), ({('test', None): {}}, [])) def testSetLink(self): self.assertEqual(self.parseForm({'status': 'unread'}, 'issue'), ({('issue', None): {'status': '1'}}, [])) self.assertEqual(self.parseForm({'status': '1'}, 'issue'), ({('issue', None): {'status': '1'}}, [])) nodeid = self.db.issue.create(status='unread') self.assertEqual(self.parseForm({'status': 'unread'}, 'issue', nodeid), ({('issue', nodeid): {}}, [])) self.assertEqual(self.db.issue.get(nodeid,'tx_Source'),'web') def testUnsetLink(self): nodeid = self.db.issue.create(status='unread') self.assertEqual(self.parseForm({'status': '-1'}, 'issue', nodeid), ({('issue', nodeid): {'status': None}}, [])) self.assertEqual(self.db.issue.get(nodeid,'tx_Source'),'web') def testInvalidLinkValue(self): # XXX This is not the current behaviour - should we enforce this? # self.assertRaises(IndexError, self.parseForm, # {'status': '4'})) self.assertRaises(FormError, self.parseForm, {'link': 'frozzle'}) self.assertRaises(FormError, self.parseForm, {'status': 'frozzle'}, 'issue') # # Multilink # def testEmptyMultilink(self): self.assertEqual(self.parseForm({'nosy': ''}), ({('test', None): {}}, [])) self.assertEqual(self.parseForm({'nosy': ' '}), ({('test', None): {}}, [])) def testSetMultilink(self): self.assertEqual(self.parseForm({'nosy': '1'}, 'issue'), ({('issue', None): {'nosy': ['1']}}, [])) self.assertEqual(self.parseForm({'nosy': 'admin'}, 'issue'), ({('issue', None): {'nosy': ['1']}}, [])) self.assertEqual(self.parseForm({'nosy': ['1','2']}, 'issue'), ({('issue', None): {'nosy': ['1','2']}}, [])) self.assertEqual(self.parseForm({'nosy': '1,2'}, 'issue'), ({('issue', None): {'nosy': ['1','2']}}, [])) self.assertEqual(self.parseForm({'nosy': 'admin,2'}, 'issue'), ({('issue', None): {'nosy': ['1','2']}}, [])) def testMixedMultilink(self): form = cgi.FieldStorage() form.list.append(cgi.MiniFieldStorage('nosy', '1,2')) form.list.append(cgi.MiniFieldStorage('nosy', '3')) cl = client.Client(self.instance, None, {'PATH_INFO':'/'}, form) cl.classname = 'issue' cl.nodeid = None cl.db = self.db cl.language = ('en',) self.assertEqual(cl.parsePropsFromForm(create=1), ({('issue', None): {'nosy': ['1','2', '3']}}, [])) def testEmptyMultilinkSet(self): nodeid = self.db.issue.create(nosy=['1','2']) self.assertEqual(self.parseForm({'nosy': ''}, 'issue', nodeid), ({('issue', nodeid): {'nosy': []}}, [])) nodeid = self.db.issue.create(nosy=['1','2']) self.assertEqual(self.parseForm({'nosy': ' '}, 'issue', nodeid), ({('issue', nodeid): {'nosy': []}}, [])) self.assertEqual(self.parseForm({'nosy': '1,2'}, 'issue', nodeid), ({('issue', nodeid): {}}, [])) def testInvalidMultilinkValue(self): # XXX This is not the current behaviour - should we enforce this? # self.assertRaises(IndexError, self.parseForm, # {'nosy': '4'})) self.assertRaises(FormError, self.parseForm, {'nosy': 'frozzle'}, 'issue') self.assertRaises(FormError, self.parseForm, {'nosy': '1,frozzle'}, 'issue') self.assertRaises(FormError, self.parseForm, {'multilink': 'frozzle'}) def testMultilinkAdd(self): nodeid = self.db.issue.create(nosy=['1']) # do nothing self.assertEqual(self.parseForm({':add:nosy': ''}, 'issue', nodeid), ({('issue', nodeid): {}}, [])) # do something ;) self.assertEqual(self.parseForm({':add:nosy': '2'}, 'issue', nodeid), ({('issue', nodeid): {'nosy': ['1','2']}}, [])) self.assertEqual(self.parseForm({':add:nosy': '2,mary'}, 'issue', nodeid), ({('issue', nodeid): {'nosy': ['1','2','4']}}, [])) self.assertEqual(self.parseForm({':add:nosy': ['2','3']}, 'issue', nodeid), ({('issue', nodeid): {'nosy': ['1','2','3']}}, [])) def testMultilinkAddNew(self): self.assertEqual(self.parseForm({':add:nosy': ['2','3']}, 'issue'), ({('issue', None): {'nosy': ['2','3']}}, [])) def testMultilinkRemove(self): nodeid = self.db.issue.create(nosy=['1','2']) # do nothing self.assertEqual(self.parseForm({':remove:nosy': ''}, 'issue', nodeid), ({('issue', nodeid): {}}, [])) # do something ;) self.assertEqual(self.parseForm({':remove:nosy': '1'}, 'issue', nodeid), ({('issue', nodeid): {'nosy': ['2']}}, [])) self.assertEqual(self.parseForm({':remove:nosy': 'admin,2'}, 'issue', nodeid), ({('issue', nodeid): {'nosy': []}}, [])) self.assertEqual(self.parseForm({':remove:nosy': ['1','2']}, 'issue', nodeid), ({('issue', nodeid): {'nosy': []}}, [])) # add and remove self.assertEqual(self.parseForm({':add:nosy': ['3'], ':remove:nosy': ['1','2']}, 'issue', nodeid), ({('issue', nodeid): {'nosy': ['3']}}, [])) # remove one that doesn't exist? self.assertRaises(FormError, self.parseForm, {':remove:nosy': '4'}, 'issue', nodeid) def testMultilinkRetired(self): self.db.user.retire('2') self.assertEqual(self.parseForm({'nosy': ['2','3']}, 'issue'), ({('issue', None): {'nosy': ['2','3']}}, [])) nodeid = self.db.issue.create(nosy=['1','2']) self.assertEqual(self.parseForm({':remove:nosy': '2'}, 'issue', nodeid), ({('issue', nodeid): {'nosy': ['1']}}, [])) self.assertEqual(self.parseForm({':add:nosy': '3'}, 'issue', nodeid), ({('issue', nodeid): {'nosy': ['1','2','3']}}, [])) def testAddRemoveNonexistant(self): self.assertRaises(FormError, self.parseForm, {':remove:foo': '2'}, 'issue') self.assertRaises(FormError, self.parseForm, {':add:foo': '2'}, 'issue') # # Password # def testEmptyPassword(self): self.assertEqual(self.parseForm({'password': ''}, 'user'), ({('user', None): {}}, [])) self.assertEqual(self.parseForm({'password': ''}, 'user'), ({('user', None): {}}, [])) self.assertRaises(FormError, self.parseForm, {'password': ['', '']}, 'user') self.assertRaises(FormError, self.parseForm, {'password': 'foo', ':confirm:password': ['', '']}, 'user') def testSetPassword(self): self.assertEqual(self.parseForm({'password': 'foo', ':confirm:password': 'foo'}, 'user'), ({('user', None): {'password': 'foo'}}, [])) def testSetPasswordConfirmBad(self): self.assertRaises(FormError, self.parseForm, {'password': 'foo'}, 'user') self.assertRaises(FormError, self.parseForm, {'password': 'foo', ':confirm:password': 'bar'}, 'user') def testEmptyPasswordNotSet(self): nodeid = self.db.user.create(username='1', password=password.Password('foo')) self.assertEqual(self.parseForm({'password': ''}, 'user', nodeid), ({('user', nodeid): {}}, [])) nodeid = self.db.user.create(username='2', password=password.Password('foo')) self.assertEqual(self.parseForm({'password': '', ':confirm:password': ''}, 'user', nodeid), ({('user', nodeid): {}}, [])) def testPasswordMigration(self): chef = self.db.user.lookup('Chef') form = dict(__login_name='Chef', __login_password='foo') cl = self._make_client(form) # assume that the "best" algorithm is the first one and doesn't # need migration, all others should be migrated. cl.db.config.WEB_LOGIN_ATTEMPTS_MIN = 200 cl.db.config.PASSWORD_PBKDF2_DEFAULT_ROUNDS = 10000 # The third item always fails. Regardless of what is there. # ['plaintext', 'SHA', 'crypt', 'MD5']: print(password.Password.deprecated_schemes) for scheme in password.Password.deprecated_schemes: print(scheme) cl.db.Otk = self.db.Otk if scheme == 'crypt' and os.name == 'nt': continue # crypt is not available on Windows pw1 = password.Password('foo', scheme=scheme) print(pw1) self.assertEqual(pw1.needs_migration(config=cl.db.config), True) self.db.user.set(chef, password=pw1) self.db.commit() actions.LoginAction(cl).handle() pw = cl.db.user.get(chef, 'password') print(pw) self.assertEqual(pw, 'foo') self.assertEqual(pw.needs_migration(config=cl.db.config), False) cl.db.Otk = self.db.Otk pw1 = pw self.assertEqual(pw1.needs_migration(config=cl.db.config), False) scheme = password.Password.known_schemes[0] self.assertEqual(scheme, pw1.scheme) actions.LoginAction(cl).handle() pw = cl.db.user.get(chef, 'password') self.assertEqual(pw, 'foo') self.assertEqual(pw, pw1) # migrate if rounds has increased above rounds was 10000 # below will be 100000 cl.db.Otk = self.db.Otk pw1 = pw # do not use the production number of PBKDF2 os.environ["PYTEST_USE_CONFIG"] = "True" cl.db.config.PASSWORD_PBKDF2_DEFAULT_ROUNDS = 100000 self.assertEqual(pw1.needs_migration(config=cl.db.config), True) scheme = password.Password.known_schemes[0] self.assertEqual(scheme, pw1.scheme) actions.LoginAction(cl).handle() pw = cl.db.user.get(chef, 'password') self.assertEqual(pw, 'foo') del(os.environ["PYTEST_USE_CONFIG"]) # do not assert self.assertEqual(pw, pw1) as pw is a 100,000 # cycle while pw1 is only 10,000. They won't compare equally. cl.db.close() def testPasswordConfigOption(self): chef = self.db.user.lookup('Chef') form = dict(__login_name='Chef', __login_password='foo') cl = self._make_client(form) self.db.config.PASSWORD_PBKDF2_DEFAULT_ROUNDS = 1000 pw1 = password.Password('foo', scheme='MD5') self.assertEqual(pw1.needs_migration(config=cl.db.config), True) self.db.user.set(chef, password=pw1) self.db.commit() actions.LoginAction(cl).handle() pw = self.db.user.get(chef, 'password') self.assertEqual('PBKDF2S5', pw.scheme) self.assertEqual(1000, password.pbkdf2_unpack(pw.password)[0]) cl.db.close() # # Boolean # def testEmptyBoolean(self): self.assertEqual(self.parseForm({'boolean': ''}), ({('test', None): {}}, [])) self.assertEqual(self.parseForm({'boolean': ' '}), ({('test', None): {}}, [])) self.assertRaises(FormError, self.parseForm, {'boolean': ['', '']}) def testSetBoolean(self): self.assertEqual(self.parseForm({'boolean': 'yes'}), ({('test', None): {'boolean': 1}}, [])) self.assertEqual(self.parseForm({'boolean': 'a\r\nb\r\n'}), ({('test', None): {'boolean': 0}}, [])) nodeid = self.db.test.create(boolean=1) self.assertEqual(self.parseForm({'boolean': 'yes'}, 'test', nodeid), ({('test', nodeid): {}}, [])) nodeid = self.db.test.create(boolean=0) self.assertEqual(self.parseForm({'boolean': 'no'}, 'test', nodeid), ({('test', nodeid): {}}, [])) def testEmptyBooleanSet(self): nodeid = self.db.test.create(boolean=0) self.assertEqual(self.parseForm({'boolean': ''}, 'test', nodeid), ({('test', nodeid): {'boolean': None}}, [])) nodeid = self.db.test.create(boolean=1) self.assertEqual(self.parseForm({'boolean': ' '}, 'test', nodeid), ({('test', nodeid): {'boolean': None}}, [])) def testRequiredBoolean(self): self.assertRaises(FormError, self.parseForm, {'boolean': '', ':required': 'boolean'}) try: self.parseForm({'boolean': 'no', ':required': 'boolean'}) except FormError: self.fail('boolean "no" raised "required missing"') # # Number # def testEmptyNumber(self): self.assertEqual(self.parseForm({'number': ''}), ({('test', None): {}}, [])) self.assertEqual(self.parseForm({'number': ' '}), ({('test', None): {}}, [])) self.assertRaises(FormError, self.parseForm, {'number': ['', '']}) def testInvalidNumber(self): self.assertRaises(FormError, self.parseForm, {'number': 'hi, mum!'}) def testSetNumber(self): self.assertEqual(self.parseForm({'number': '1'}), ({('test', None): {'number': 1}}, [])) self.assertEqual(self.parseForm({'number': '0'}), ({('test', None): {'number': 0}}, [])) self.assertEqual(self.parseForm({'number': '\n0\n'}), ({('test', None): {'number': 0}}, [])) def testSetNumberReplaceOne(self): nodeid = self.db.test.create(number=1) self.assertEqual(self.parseForm({'number': '1'}, 'test', nodeid), ({('test', nodeid): {}}, [])) self.assertEqual(self.parseForm({'number': '0'}, 'test', nodeid), ({('test', nodeid): {'number': 0}}, [])) def testSetNumberReplaceZero(self): nodeid = self.db.test.create(number=0) self.assertEqual(self.parseForm({'number': '0'}, 'test', nodeid), ({('test', nodeid): {}}, [])) def testSetNumberReplaceNone(self): nodeid = self.db.test.create() self.assertEqual(self.parseForm({'number': '0'}, 'test', nodeid), ({('test', nodeid): {'number': 0}}, [])) self.assertEqual(self.parseForm({'number': '1'}, 'test', nodeid), ({('test', nodeid): {'number': 1}}, [])) def testEmptyNumberSet(self): nodeid = self.db.test.create(number=0) self.assertEqual(self.parseForm({'number': ''}, 'test', nodeid), ({('test', nodeid): {'number': None}}, [])) nodeid = self.db.test.create(number=1) self.assertEqual(self.parseForm({'number': ' '}, 'test', nodeid), ({('test', nodeid): {'number': None}}, [])) def testRequiredNumber(self): self.assertRaises(FormError, self.parseForm, {'number': '', ':required': 'number'}) try: self.parseForm({'number': '0', ':required': 'number'}) except FormError: self.fail('number "no" raised "required missing"') # # Integer # def testEmptyInteger(self): self.assertEqual(self.parseForm({'intval': ''}), ({('test', None): {}}, [])) self.assertEqual(self.parseForm({'intval': ' '}), ({('test', None): {}}, [])) self.assertRaises(FormError, self.parseForm, {'intval': ['', '']}) def testInvalidInteger(self): self.assertRaises(FormError, self.parseForm, {'intval': 'hi, mum!'}) def testSetInteger(self): self.assertEqual(self.parseForm({'intval': '1'}), ({('test', None): {'intval': 1}}, [])) self.assertEqual(self.parseForm({'intval': '0'}), ({('test', None): {'intval': 0}}, [])) self.assertEqual(self.parseForm({'intval': '\n0\n'}), ({('test', None): {'intval': 0}}, [])) def testSetIntegerReplaceOne(self): nodeid = self.db.test.create(intval=1) self.assertEqual(self.parseForm({'intval': '1'}, 'test', nodeid), ({('test', nodeid): {}}, [])) self.assertEqual(self.parseForm({'intval': '0'}, 'test', nodeid), ({('test', nodeid): {'intval': 0}}, [])) def testSetIntegerReplaceZero(self): nodeid = self.db.test.create(intval=0) self.assertEqual(self.parseForm({'intval': '0'}, 'test', nodeid), ({('test', nodeid): {}}, [])) def testSetIntegerReplaceNone(self): nodeid = self.db.test.create() self.assertEqual(self.parseForm({'intval': '0'}, 'test', nodeid), ({('test', nodeid): {'intval': 0}}, [])) self.assertEqual(self.parseForm({'intval': '1'}, 'test', nodeid), ({('test', nodeid): {'intval': 1}}, [])) def testEmptyIntegerSet(self): nodeid = self.db.test.create(intval=0) self.assertEqual(self.parseForm({'intval': ''}, 'test', nodeid), ({('test', nodeid): {'intval': None}}, [])) nodeid = self.db.test.create(intval=1) self.assertEqual(self.parseForm({'intval': ' '}, 'test', nodeid), ({('test', nodeid): {'intval': None}}, [])) def testRequiredInteger(self): self.assertRaises(FormError, self.parseForm, {'intval': '', ':required': 'intval'}) try: self.parseForm({'intval': '0', ':required': 'intval'}) except FormError: self.fail('intval "no" raised "required missing"') # # Date # def testEmptyDate(self): self.assertEqual(self.parseForm({'date': ''}), ({('test', None): {}}, [])) self.assertEqual(self.parseForm({'date': ' '}), ({('test', None): {}}, [])) self.assertRaises(FormError, self.parseForm, {'date': ['', '']}) def testInvalidDate(self): self.assertRaises(FormError, self.parseForm, {'date': '12'}) def testSetDate(self): self.assertEqual(self.parseForm({'date': '2003-01-01'}), ({('test', None): {'date': date.Date('2003-01-01')}}, [])) nodeid = self.db.test.create(date=date.Date('2003-01-01')) self.assertEqual(self.parseForm({'date': '2003-01-01'}, 'test', nodeid), ({('test', nodeid): {}}, [])) def testEmptyDateSet(self): nodeid = self.db.test.create(date=date.Date('.')) self.assertEqual(self.parseForm({'date': ''}, 'test', nodeid), ({('test', nodeid): {'date': None}}, [])) nodeid = self.db.test.create(date=date.Date('1970-01-01.00:00:00')) self.assertEqual(self.parseForm({'date': ' '}, 'test', nodeid), ({('test', nodeid): {'date': None}}, [])) # # Test multiple items in form # def testMultiple(self): self.assertEqual(self.parseForm({'string': 'a', 'issue-1@title': 'b'}), ({('test', None): {'string': 'a'}, ('issue', '-1'): {'title': 'b'} }, [])) def testMultipleExistingContext(self): nodeid = self.db.test.create() self.assertEqual(self.parseForm({'string': 'a', 'issue-1@title': 'b'}, 'test', nodeid),({('test', nodeid): {'string': 'a'}, ('issue', '-1'): {'title': 'b'}}, [])) def testLinking(self): self.assertEqual(self.parseForm({ 'string': 'a', 'issue-1@add@nosy': '1', 'issue-2@link@superseder': 'issue-1', }), ({('test', None): {'string': 'a'}, ('issue', '-1'): {'nosy': ['1']}, }, [('issue', '-2', 'superseder', [('issue', '-1')]) ] ) ) def testMessages(self): self.assertEqual(self.parseForm({ 'msg-1@content': 'asdf', 'msg-2@content': 'qwer', '@link@messages': 'msg-1, msg-2'}), ({('test', None): {}, ('msg', '-2'): {'content': 'qwer'}, ('msg', '-1'): {'content': 'asdf'}}, [('test', None, 'messages', [('msg', '-1'), ('msg', '-2')])] ) ) def testLinkBadDesignator(self): self.assertRaises(FormError, self.parseForm, {'test-1@link@link': 'blah'}) self.assertRaises(FormError, self.parseForm, {'test-1@link@link': 'issue'}) def testLinkNotLink(self): self.assertRaises(FormError, self.parseForm, {'test-1@link@boolean': 'issue-1'}) self.assertRaises(FormError, self.parseForm, {'test-1@link@string': 'issue-1'}) def testBackwardsCompat(self): res = self.parseForm({':note': 'spam'}, 'issue') date = res[0][('msg', '-1')]['date'] self.assertEqual(res, ({('issue', None): {}, ('msg', '-1'): {'content': 'spam', 'author': '1', 'date': date}}, [('issue', None, 'messages', [('msg', '-1')])])) file = FileUpload('foo', 'foo.txt') self.assertEqual(self.parseForm({':file': file}, 'issue'), ({('issue', None): {}, ('file', '-1'): {'content': 'foo', 'name': 'foo.txt', 'type': 'text/plain'}}, [('issue', None, 'files', [('file', '-1')])])) def testErrorForBadTemplate(self): form = {} cl = self.setupClient(form, 'issue', '1', template="broken", env_addon = {'HTTP_REFERER': 'http://whoami.com/path/'}) out = [] out = cl.renderContext() self.assertEqual(out, 'No template file exists for templating "issue" with template "broken" (neither "issue.broken" nor "_generic.broken")') self.assertEqual(cl.response_code, 400) def testFormValuePreserveOnError(self): page_template = """

""".strip () self.db.keyword.create (name = 'key1') self.db.keyword.create (name = 'key2') nodeid = self.db.issue.create (title = 'Title', priority = '1', status = '1', nosy = ['1'], keyword = ['1']) self.db.commit () form = {':note': 'msg-content', 'title': 'New title', 'priority': '2', 'status': '2', 'nosy': '1,2', 'keyword': '', 'superseder': '5000', ':action': 'edit'} cl = self.setupClient(form, 'issue', '1', env_addon = {'HTTP_REFERER': 'http://whoami.com/path/'}) pt = RoundupPageTemplate() pt.pt_edit(page_template, 'text/html') out = [] def wh(s): out.append(s) cl.write_html = wh # Enable the following if we get a templating error: #def send_error (*args, **kw): # import pdb; pdb.set_trace() #cl.send_error_to_admin = send_error # Need to rollback the database on error -- this usually happens # in web-interface (and for other databases) anyway, need it for # testing that the form values are really used, not the database! # We do this together with the setup of the easy template above def load_template(x): cl.db.rollback() return pt cl.instance.templates.load = load_template cl.selectTemplate = MockNull() cl.determine_context = MockNull () def hasPermission(s, p, classname=None, d=None, e=None, **kw): return True actions.Action.hasPermission = hasPermission e1 = _HTMLItem.is_edit_ok _HTMLItem.is_edit_ok = lambda x : True e2 = HTMLProperty.is_edit_ok HTMLProperty.is_edit_ok = lambda x : True cl.inner_main() # The original self.db has been changed. Assign the new # cl.db to self.db so it gets closed at the end of the test. self.db = cl.db _HTMLItem.is_edit_ok = e1 HTMLProperty.is_edit_ok = e2 self.assertEqual(len(out), 1) self.assertEqual(out [0].strip (), """

Edit Error: issue has no node 5000

New title

urgent

deferred

admin, anonymous

""".strip ()) def testXMLTemplate(self): page_template = """""" pt = RoundupPageTemplate() pt.pt_edit(page_template, 'application/xml') cl = self.setupClient({ }, 'issue', env_addon = {'HTTP_REFERER': 'http://whoami.com/path/'}) out = pt.render(cl, 'issue', MockNull()) self.assertEqual(out, '\n') def testHttpProxyStrip(self): os.environ['HTTP_PROXY'] = 'http://bad.news/here/' cl = self.setupClient({ }, 'issue', env_addon = {'HTTP_PROXY': 'http://bad.news/here/'}) out = [] def wh(s): out.append(s) cl.write_html = wh cl.main() self.db = cl.db # to close new db handle from main() at tearDown self.assertFalse('HTTP_PROXY' in cl.env) self.assertFalse('HTTP_PROXY' in os.environ) def testCsrfProtectionHtml(self): # need to set SENDMAILDEBUG to prevent # downstream issue when email is sent on successful # issue creation. Also delete the file afterwards # just to make sure that some other test looking for # SENDMAILDEBUG won't trip over ours. if 'SENDMAILDEBUG' not in os.environ: os.environ['SENDMAILDEBUG'] = 'mail-test1.log' SENDMAILDEBUG = os.environ['SENDMAILDEBUG'] page_template = """

""".strip () self.db.keyword.create (name = 'key1') self.db.keyword.create (name = 'key2') nodeid = self.db.issue.create (title = 'Title', priority = '1', status = '1', nosy = ['1'], keyword = ['1']) self.db.commit () form = {':note': 'msg-content', 'title': 'New title', 'priority': '2', 'status': '2', 'nosy': '1,2', 'keyword': '', ':action': 'edit'} cl = self.setupClient(form, 'issue', '1') pt = RoundupPageTemplate() pt.pt_edit(page_template, 'text/html') out = [] def wh(s): out.append(s) cl.write_html = wh # Enable the following if we get a templating error: #def send_error (*args, **kw): # import pdb; pdb.set_trace() #cl.send_error_to_admin = send_error # Need to rollback the database on error -- this usually happens # in web-interface (and for other databases) anyway, need it for # testing that the form values are really used, not the database! # We do this together with the setup of the easy template above def load_template(x): cl.db.rollback() return pt cl.instance.templates.load = load_template cl.selectTemplate = MockNull() cl.determine_context = MockNull () def hasPermission(s, p, classname=None, d=None, e=None, **kw): return True actions.Action.hasPermission = hasPermission orig_HTMLItem_is_edit_ok = _HTMLItem.is_edit_ok e1 = _HTMLItem.is_edit_ok _HTMLItem.is_edit_ok = lambda x : True e2 = HTMLProperty.is_edit_ok orig_HTMLProperty_is_edit_ok = HTMLProperty.is_edit_ok HTMLProperty.is_edit_ok = lambda x : True # test with no headers. Default config requires that 1 header # is present and passes checks. cl.main() match_at=out[0].find('Unable to verify sufficient headers') print("result of subtest 1:", out[0]) self.assertNotEqual(match_at, -1) del(out[0]) # all the rest of these allow at least one header to pass # and the edit happens with a redirect back to issue 1 cl.env['HTTP_REFERER'] = 'http://whoami.com/path/' cl.main() match_at=out[0].find('Redirecting to ') match_encoded_at=out[0].find('<script>') print("\n\nresult of subtest 2a:", out[0]) self.assertEqual(match_at, -1) # must not find unencoded script tag self.assertEqual(match_encoded_at, 53) # must find encoded script tag del(cl.env['HTTP_REFERER']) del(out[0]) cl.env['HTTP_ORIGIN'] = 'http://whoami.com' cl.main() match_at=out[0].find('Redirecting to We can't validate your session (csrf failure). Re-enter any unsaved data and try again.

") print("result of subtest 6a:", out[0], match_at) self.assertEqual(match_at, 33) del(out[0]) cl.db.config['WEB_CSRF_ENFORCE_TOKEN'] = 'yes' form2 = copy.copy(form) form2.update({'@csrf': 'booogus'}) # add a bogus csrf field to the form and rerun main cl.form = db_test_base.makeForm(form2) cl.main() match_at=out[0].find("We can't validate your session (csrf failure). Re-enter any unsaved data and try again.") print("result of subtest 7:", out[0]) self.assertEqual(match_at, 36) del(out[0]) form2 = copy.copy(form) nonce = anti_csrf_nonce(cl) # verify that we can see the nonce otks = cl.db.getOTKManager() isitthere = otks.exists(nonce) print("result of subtest 8:", isitthere) print("otks: user, session", otks.get(nonce, 'uid', default=None), otks.get(nonce, 'session', default=None)) self.assertEqual(isitthere, True) form2.update({'@csrf': nonce}) # add a real csrf field to the form and rerun main cl.form = db_test_base.makeForm(form2) cl.main() # csrf passes and redirects to the new issue. match_at=out[0].find('Redirecting to Invalid request

') print("result of subtest 11:", out[0]) self.assertEqual(match_at, 33) del(out[0]) # the token should be gone isitthere = otks.exists(nonce) print("result of subtest 12:", isitthere) self.assertEqual(isitthere, False) # change to post and should fail w/ invalid csrf # since get deleted the token. cl.env.update({'REQUEST_METHOD': 'POST'}) print(cl.env) cl.main() match_at=out[0].find("We can't validate your session (csrf failure). Re-enter any unsaved data and try again.") print("post failure after get", out[0]) print("result of subtest 13:", out[0]) self.assertEqual(match_at, 36) del(out[0]) del(cl.env['HTTP_REFERER']) # test by setting allowed api origins to * # this should not redirect as it is not an API call. cl.db.config.WEB_ALLOWED_API_ORIGINS = " * " cl.env['HTTP_ORIGIN'] = 'https://baz.edu' cl.main() match_at=out[0].find('Invalid Origin https://baz.edu') print("result of subtest invalid origin:", out[0]) self.assertEqual(match_at, 36) del(cl.env['HTTP_ORIGIN']) cl.db.config.WEB_ALLOWED_API_ORIGINS = "" del(out[0]) # test by setting allowed api origins to * # this should not redirect as it is not an API call. cl.db.config.WEB_ALLOWED_API_ORIGINS = " * " cl.env['HTTP_ORIGIN'] = 'http://whoami.com' cl.env['HTTP_REFERER'] = 'https://baz.edu/path/' cl.main() match_at=out[0].find('Invalid Referer: https://baz.edu/path/') print("result of subtest invalid referer:", out[0]) self.assertEqual(match_at, 36) del(cl.env['HTTP_ORIGIN']) del(cl.env['HTTP_REFERER']) cl.db.config.WEB_ALLOWED_API_ORIGINS = "" del(out[0]) # clean up from email log if os.path.exists(SENDMAILDEBUG): os.remove(SENDMAILDEBUG) #raise ValueError # Undo monkey patching _HTMLItem.is_edit_ok = orig_HTMLItem_is_edit_ok HTMLProperty.is_edit_ok = orig_HTMLProperty_is_edit_ok def testRestOriginValidationCredentials(self): import json # set the password for admin so we can log in. passwd=password.Password('admin') self.db.user.set('1', password=passwd) self.db.commit() out = [] def wh(s): out.append(s) # rest has no form content form = cgi.FieldStorage() # origin set to allowed value cl = client.Client(self.instance, None, {'REQUEST_METHOD':'GET', 'PATH_INFO':'rest/data/issue', 'HTTP_ORIGIN': 'http://whoami.com', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://whoami.com/path/', 'HTTP_ACCEPT': "application/json;version=1", 'HTTP_X_REQUESTED_WITH': 'rest', }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json;version=1', 'origin': 'http://whoami.com', } cl.request.headers = MockNull(**h) cl.write = wh # capture output cl.handle_rest() self.db = cl.db # to close new db handle from main() at tearDown print(b2s(out[0])) expected=""" { "data": { "collection": [], "@total_size": 0 } }""" self.assertEqual(json.loads(b2s(out[0])),json.loads(expected)) self.assertIn('Access-Control-Allow-Credentials', cl.additional_headers) self.assertEqual( cl.additional_headers['Access-Control-Allow-Credentials'], 'true' ) self.assertEqual( cl.additional_headers['Access-Control-Allow-Origin'], 'http://whoami.com' ) del(out[0]) # Origin not set. AKA same origin GET request. # Should be like valid origin. # Because of HTTP_X_REQUESTED_WITH header it should be # preflighted. cl = client.Client(self.instance, None, {'REQUEST_METHOD':'GET', 'PATH_INFO':'rest/data/issue', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://whoami.com/path/', 'HTTP_ACCEPT': "application/json;version=1", 'HTTP_X_REQUESTED_WITH': 'rest', }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # Should return explanation because content type is text/plain # and not text/xml cl.handle_rest() self.db = cl.db # to close new db handle from main() at tearDown self.assertIn('Access-Control-Allow-Credentials', cl.additional_headers) self.assertEqual(json.loads(b2s(out[0])),json.loads(expected)) del(out[0]) cl = client.Client(self.instance, None, {'REQUEST_METHOD':'OPTIONS', 'HTTP_ORIGIN': 'http://invalid.com', 'PATH_INFO':'rest/data/issue', 'Access-Control-Request-Headers': 'Authorization', 'Access-Control-Request-Method': 'GET', }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json', 'access-control-request-headers': 'Authorization', 'access-control-request-method': 'GET', } cl.request.headers = MockNull(**h) cl.write = wh # capture output # Should return explanation because content type is text/plain # and not text/xml cl.handle_rest() self.db = cl.db # to close new db handle from main() at tearDown self.assertNotIn('Access-Control-Allow-Credentials', cl.additional_headers) self.assertNotIn('Access-Control-Allow-Origin', cl.additional_headers ) self.assertEqual(cl.response_code, 403) del(out[0]) # origin not set to allowed value # prevents authenticated request like this from # being shared with the requestor because # Access-Control-Allow-Credentials is not # set in response cl.db.config.WEB_ALLOWED_API_ORIGINS = " * " cl = client.Client(self.instance, None, {'REQUEST_METHOD':'GET', 'PATH_INFO':'rest/data/issue', 'HTTP_ORIGIN': 'http://invalid.com', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://invalid.com/path/', 'HTTP_ACCEPT': "application/json;version=1", 'HTTP_X_REQUESTED_WITH': 'rest', }, form) cl.db = self.db self.db = cl.db # to close new db handle from main() at tearDown cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json;version=1', 'origin': 'http://invalid.com', } cl.request.headers = MockNull(**h) cl.write = wh # capture output cl.handle_rest() self.db = cl.db # to close new db handle from main() at tearDown self.assertEqual(json.loads(b2s(out[0])), json.loads(expected) ) self.assertNotIn('Access-Control-Allow-Credentials', cl.additional_headers) self.assertIn('Access-Control-Allow-Origin', cl.additional_headers) self.assertEqual( h['origin'], cl.additional_headers['Access-Control-Allow-Origin'] ) self.assertIn('Content-Length', cl.additional_headers) del(out[0]) # CORS Same rules as for invalid origin cl = client.Client(self.instance, None, {'REQUEST_METHOD':'GET', 'PATH_INFO':'rest/data/issue', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://whoami.com/path/', 'HTTP_ACCEPT': "application/json;version=1", 'HTTP_X_REQUESTED_WITH': 'rest', }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # Should return explanation because content type is text/plain # and not text/xml cl.handle_rest() self.db = cl.db # to close new db handle from main() at tearDown self.assertIn('Access-Control-Allow-Credentials', cl.additional_headers) self.assertEqual(json.loads(b2s(out[0])),json.loads(expected)) del(out[0]) # origin set to special "null" value. Same rules as for # invalid origin cl = client.Client(self.instance, None, {'REQUEST_METHOD':'GET', 'PATH_INFO':'rest/data/issue', 'HTTP_ORIGIN': 'null', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://whoami.com/path/', 'HTTP_ACCEPT': "application/json;version=1", 'HTTP_X_REQUESTED_WITH': 'rest', }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json', 'origin': 'null' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # Should return explanation because content type is text/plain # and not text/xml cl.handle_rest() self.db = cl.db # to close new db handle from main() at tearDown self.assertNotIn('Access-Control-Allow-Credentials', cl.additional_headers) self.assertEqual(json.loads(b2s(out[0])),json.loads(expected)) del(out[0]) def testRestOptionsBadAttribute(self): import json out = [] def wh(s): out.append(s) # rest has no form content form = cgi.FieldStorage() cl = client.Client(self.instance, None, {'REQUEST_METHOD':'OPTIONS', 'HTTP_ORIGIN': 'http://whoami.com', 'PATH_INFO':'rest/data/user/1/zot', 'HTTP_REFERER': 'http://whoami.com/path/', 'content-type': "" }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'origin': 'http://whoami.com', 'access-control-request-headers': 'x-requested-with', 'access-control-request-method': 'GET', 'referer': 'http://whoami.com/path', 'content-type': "", } cl.request.headers = MockNull(**h) cl.write = wh # capture output cl.handle_rest() self.db = cl.db # to close new db handle from handle_rest at tearDown _py3 = sys.version_info[0] > 2 expected_headers = { 'Access-Control-Allow-Credentials': 'true', 'Access-Control-Allow-Headers': 'Content-Type, Authorization, ' 'X-Requested-With, X-HTTP-Method-Override', 'Access-Control-Allow-Methods': 'HEAD, OPTIONS, GET, POST, PUT, DELETE, PATCH', 'Access-Control-Expose-Headers': 'X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-RateLimit-Limit-Period, Retry-After, Sunset, Allow', 'Access-Control-Allow-Origin': 'http://whoami.com', 'Access-Control-Max-Age': '86400', 'Allow': 'OPTIONS, GET, POST, PUT, DELETE, PATCH', # string representation under python2 has an extra space. 'Content-Length': '104' if _py3 else '105', 'Content-Type': 'application/json', 'Vary': 'Origin' } expected_body = b'{\n "error": {\n "status": 404,\n "msg": "Attribute zot not valid for Class user"\n }\n}\n' self.assertEqual(cl.response_code, 404) # json payload string representation differs. Compare as objects. self.assertEqual(json.loads(b2s(out[0])), json.loads(expected_body)) self.assertEqual(cl.additional_headers, expected_headers) del(out[0]) def testRestOptionsRequestGood(self): import json out = [] def wh(s): out.append(s) # OPTIONS/CORS preflight has no credentials # rest has no form content form = cgi.FieldStorage() cl = client.Client(self.instance, None, {'REQUEST_METHOD':'OPTIONS', 'HTTP_ORIGIN': 'http://whoami.com', 'PATH_INFO':'rest/data/issue', 'HTTP_REFERER': 'http://whoami.com/path/', 'Access-Control-Request-Headers': 'Authorization', 'Access-Control-Request-Method': 'POST', }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'origin': 'http://whoami.com', 'access-control-request-headers': 'Authorization', 'access-control-request-method': 'POST', 'referer': 'http://whoami.com/path', } cl.request.headers = MockNull(**h) cl.write = wh # capture output cl.handle_rest() self.db = cl.db # to close new db handle from handle_rest at tearDown self.assertEqual(out[0], '') # 204 options returns no data expected_headers = { 'Access-Control-Allow-Credentials': 'true', 'Access-Control-Allow-Headers': 'Content-Type, Authorization, ' 'X-Requested-With, X-HTTP-Method-Override', 'Access-Control-Allow-Methods': 'OPTIONS, GET, POST', 'Access-Control-Expose-Headers': 'X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-RateLimit-Limit-Period, Retry-After, Sunset, Allow', 'Access-Control-Allow-Origin': 'http://whoami.com', 'Access-Control-Max-Age': '86400', 'Allow': 'OPTIONS, GET, POST', 'Content-Type': 'application/json', 'Vary': 'Origin' } self.assertEqual(cl.additional_headers, expected_headers) del(out[0]) def testRestOptionsRequestBad(self): import json out = [] def wh(s): out.append(s) # OPTIONS/CORS preflight has no credentials # rest has no form content form = cgi.FieldStorage() cl = client.Client(self.instance, None, {'REQUEST_METHOD':'OPTIONS', 'HTTP_ORIGIN': 'http://invalid.com', 'PATH_INFO':'rest/data/issue', 'HTTP_REFERER': 'http://invalid.com/path/', 'Access-Control-Request-Headers': 'Authorization', 'Access-Control-Request-Method': 'POST', }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'origin': 'http://invalid.com', 'access-control-request-headers': 'Authorization', 'access-control-request-method': 'POST', 'referer': 'http://invalid.com/path', } cl.request.headers = MockNull(**h) cl.write = wh # capture output cl.handle_rest() self.db = cl.db # to close new db handle from handle_rest at tearDown self.assertEqual(cl.response_code, 400) del(out[0]) def testRestCsrfProtection(self): import json # set the password for admin so we can log in. passwd=password.Password('admin') self.db.user.set('1', password=passwd) out = [] def wh(s): out.append(s) # rest has no form content form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('title', 'A new issue'), cgi.MiniFieldStorage('status', '1'), cgi.MiniFieldStorage('@pretty', 'false'), cgi.MiniFieldStorage('@apiver', '1'), ] cl = client.Client(self.instance, None, {'REQUEST_METHOD':'POST', 'PATH_INFO':'rest/data/issue', 'CONTENT_TYPE': 'application/x-www-form-urlencoded', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://whoami.com/path/', 'HTTP_ACCEPT': "application/json;version=1" }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json;version=1' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # Should return explanation because content type is text/plain # and not text/xml cl.handle_rest() self.assertEqual(b2s(out[0]), '{ "error": { "status": 400, ' '"msg": "Required Header Missing" } }') del(out[0]) cl = client.Client(self.instance, None, {'REQUEST_METHOD':'POST', 'PATH_INFO':'rest/data/issue', 'CONTENT_TYPE': 'application/x-www-form-urlencoded', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://whoami.com/path/', 'HTTP_X_REQUESTED_WITH': 'rest', 'HTTP_ACCEPT': "application/json;version=1", 'HTTP_ORIGIN': 'http://whoami.com', }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json;version=1' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # Should work as all required headers are present. cl.handle_rest() answer='{"data": {"link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/1", "id": "1"}}\n' # check length to see if pretty is turned off. self.assertEqual(len(out[0]), 99) # compare as dicts not strings due to different key ordering # between python versions. response=json.loads(b2s(out[0])) expected=json.loads(answer) self.assertEqual(response,expected) del(out[0]) # rest has no form content cl.db.config.WEB_ALLOWED_API_ORIGINS = "https://bar.edu http://bar.edu" form = cgi.FieldStorage() form.list = [ cgi.MiniFieldStorage('title', 'A new issue'), cgi.MiniFieldStorage('status', '1'), cgi.MiniFieldStorage('@pretty', 'false'), cgi.MiniFieldStorage('@apiver', '1'), ] cl = client.Client(self.instance, None, {'REQUEST_METHOD':'POST', 'PATH_INFO':'rest/data/issue', 'CONTENT_TYPE': 'application/x-www-form-urlencoded', 'HTTP_ORIGIN': 'https://bar.edu', 'HTTP_X_REQUESTED_WITH': 'rest', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://whoami.com/path/', 'HTTP_ACCEPT': "application/json;version=1" }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # Should return explanation because content type is text/plain # and not text/xml cl.handle_rest() answer='{"data": {"link": "http://tracker.example/cgi-bin/roundup.cgi/bugs/rest/data/issue/2", "id": "2"}}\n' # check length to see if pretty is turned off. self.assertEqual(len(out[0]), 99) # compare as dicts not strings due to different key ordering # between python versions. response=json.loads(b2s(out[0])) expected=json.loads(answer) self.assertEqual(response,expected) del(out[0]) ##### cl = client.Client(self.instance, None, {'REQUEST_METHOD':'POST', 'PATH_INFO':'rest/data/issue', 'CONTENT_TYPE': 'application/x-www-form-urlencoded', 'HTTP_ORIGIN': 'httxs://bar.edu', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://whoami.com/path/', 'HTTP_ACCEPT': "application/json;version=1" }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # Should return explanation because content type is text/plain # and not text/xml cl.handle_rest() self.assertEqual(b2s(out[0]), '{ "error": { "status": 400, "msg": "Client is not allowed to use Rest Interface." } }') del(out[0]) cl.db.config.WEB_ALLOWED_API_ORIGINS = " * " cl = client.Client(self.instance, None, {'REQUEST_METHOD':'POST', 'PATH_INFO':'rest/data/issue', 'CONTENT_TYPE': 'application/x-www-form-urlencoded', 'HTTP_ORIGIN': 'httxs://bar.edu', 'HTTP_X_REQUESTED_WITH': 'rest', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'httxp://bar.edu/path/', 'HTTP_ACCEPT': "application/json;version=1" }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # create fourth issue cl.handle_rest() self.assertIn('"id": "3"', b2s(out[0])) del(out[0]) cl.db.config.WEB_ALLOWED_API_ORIGINS = "httxs://bar.foo.edu httxs://bar.edu" for referer in [ 'httxs://bar.edu/path/foo', 'httxs://bar.edu/path/foo?g=zz', 'httxs://bar.edu']: cl = client.Client(self.instance, None, {'REQUEST_METHOD':'POST', 'PATH_INFO':'rest/data/issue', 'CONTENT_TYPE': 'application/x-www-form-urlencoded', 'HTTP_ORIGIN': 'httxs://bar.edu', 'HTTP_X_REQUESTED_WITH': 'rest', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': referer, 'HTTP_ACCEPT': "application/json;version=1" }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # create fourth issue cl.handle_rest() self.assertIn('"id": "', b2s(out[0])) del(out[0]) cl.db.config.WEB_ALLOWED_API_ORIGINS = "httxs://bar.foo.edu httxs://bar.edu" cl = client.Client(self.instance, None, {'REQUEST_METHOD':'POST', 'PATH_INFO':'rest/data/issue', 'CONTENT_TYPE': 'application/x-www-form-urlencoded', 'HTTP_ORIGIN': 'httxs://bar.edu', 'HTTP_X_REQUESTED_WITH': 'rest', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'httxp://bar.edu/path/', 'HTTP_ACCEPT': "application/json;version=1" }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() h = { 'content-type': 'application/json', 'accept': 'application/json' } cl.request.headers = MockNull(**h) cl.write = wh # capture output # create fourth issue cl.handle_rest() self.assertEqual(b2s(out[0]), '{ "error": { "status": 400, "msg": "Invalid Referer: httxp://bar.edu/path/"}}') del(out[0]) def testXmlrpcCsrfProtection(self): # set the password for admin so we can log in. passwd=password.Password('admin') self.db.user.set('1', password=passwd) out = [] def wh(s): out.append(s) # create form for xmlrpc from string form = db_test_base.makeFormFromString('xyzzy', {"REQUEST_METHOD": "POST", "CONTENT_TYPE": "text/json"}) cl = client.Client(self.instance, None, {'REQUEST_METHOD':'POST', 'PATH_INFO':'xmlrpc', 'CONTENT_TYPE': 'text/plain', 'HTTP_AUTHORIZATION': 'Basic YWRtaW46YWRtaW4=', 'HTTP_REFERER': 'http://whoami.com/path/', 'HTTP_X_REQUESTED_WITH': "XMLHttpRequest" }, form) cl.db = self.db cl.base = 'http://whoami.com/path/' cl._socket_op = lambda *x : True cl._error_message = [] cl.request = MockNull() cl.write = wh # capture output # Should return explanation because content type is text/plain # and not text/xml cl.handle_xmlrpc() self.assertEqual(out[0], b"This is the endpoint of Roundup XML-RPC interface.") del(out[0]) # Should return admin user indicating auth works and # header checks succeed (REFERER and X-REQUESTED-WITH) cl.env['CONTENT_TYPE'] = "text/xml" # ship the form with the value holding the xml value. # I have no clue why this works but .... cl.form = MockNull(file = True, value = "\n\ndisplay\n\n\nuser1\n\n\nusername\n\n\n\n" ) answer = b"\n\n\n\n\n\nusername\nadmin\n\n\n\n\n\n" cl.handle_xmlrpc() print(out) self.assertEqual(out[0], answer) del(out[0]) # remove the X-REQUESTED-WITH header and get an xmlrpc fault returned del(cl.env['HTTP_X_REQUESTED_WITH']) cl.handle_xmlrpc() frag_faultCode = "\nfaultCode\n1\n\n" frag_faultString = "\nfaultString\n<class 'roundup.exceptions.UsageError'>:Required Header Missing\n\n" output_fragments = ["\n", "\n", "\n", "\n", (frag_faultCode + frag_faultString, frag_faultString + frag_faultCode), "\n", "\n", "\n"] print(out[0]) self.compareStringFragments(out[0], output_fragments) del(out[0]) # change config to not require X-REQUESTED-WITH header cl.db.config['WEB_CSRF_ENFORCE_HEADER_X-REQUESTED-WITH'] = 'logfailure' cl.handle_xmlrpc() print(out) self.assertEqual(out[0], answer) del(out[0]) # # SECURITY # # XXX test all default permissions def _make_client(self, form, classname='user', nodeid='1', userid='2', template='item'): cl = client.Client(self.instance, None, {'PATH_INFO':'/', 'REQUEST_METHOD':'POST'}, db_test_base.makeForm(form)) cl.classname = classname if nodeid is not None: cl.nodeid = nodeid cl.db = self.db cl.request = MockNull() cl.db.Otk = cl.db.getOTKManager() #cl.db.Otk = MockNull() #cl.db.Otk.data = {} #cl.db.Otk.getall = self.data_get #cl.db.Otk.set = self.data_set cl.userid = userid cl.language = ('en',) cl._error_message = [] cl._ok_message = [] cl.template = template return cl def data_get(self, key): return self.db.Otk.data[key] def data_set(self, key, **value): self.db.Otk.data[key] = value def testClassPermission(self): cl = self._make_client(dict(username='bob')) self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) cl.nodeid = '1' self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) def testCheckAndPropertyPermission(self): self.db.security.permissions = {} def own_record(db, userid, itemid): return userid == itemid p = self.db.security.addPermission(name='Edit', klass='user', check=own_record, properties=("password", )) self.db.security.addPermissionToRole('User', p) cl = self._make_client(dict(username='bob')) self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) cl = self._make_client(dict(roles='User,Admin'), userid='4', nodeid='4') self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) cl = self._make_client(dict(roles='User,Admin'), userid='4') self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) cl = self._make_client(dict(roles='User,Admin')) self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) # working example, mary may change her pw cl = self._make_client({'password':'ob', '@confirm@password':'ob'}, nodeid='4', userid='4') self.assertRaises(exceptions.Redirect, actions.EditItemAction(cl).handle) cl = self._make_client({'password':'bob', '@confirm@password':'bob'}) self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) def testCreatePermission(self): # this checks if we properly differentiate between create and # edit permissions self.db.security.permissions = {} self.db.security.addRole(name='UserAdd') # Don't allow roles p = self.db.security.addPermission(name='Create', klass='user', properties=("username", "password", "address", "alternate_address", "realname", "phone", "organisation", "timezone")) self.db.security.addPermissionToRole('UserAdd', p) # Don't allow roles *and* don't allow username p = self.db.security.addPermission(name='Edit', klass='user', properties=("password", "address", "alternate_address", "realname", "phone", "organisation", "timezone")) self.db.security.addPermissionToRole('UserAdd', p) self.db.user.set('4', roles='UserAdd') # anonymous may not cl = self._make_client({'username':'new_user', 'password':'secret', '@confirm@password':'secret', 'address':'new_user@bork.bork', 'roles':'Admin'}, nodeid=None, userid='2') self.assertRaises(exceptions.Unauthorised, actions.NewItemAction(cl).handle) # Don't allow creating new user with roles cl = self._make_client({'username':'new_user', 'password':'secret', '@confirm@password':'secret', 'address':'new_user@bork.bork', 'roles':'Admin'}, nodeid=None, userid='4') self.assertRaises(exceptions.Unauthorised, actions.NewItemAction(cl).handle) self.assertEqual(cl._error_message,[]) # this should work cl = self._make_client({'username':'new_user', 'password':'secret', '@confirm@password':'secret', 'address':'new_user@bork.bork'}, nodeid=None, userid='4') self.assertRaises(exceptions.Redirect, actions.NewItemAction(cl).handle) self.assertEqual(cl._error_message,[]) # don't allow changing (my own) username (in this example) cl = self._make_client(dict(username='new_user42'), userid='4') self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) cl = self._make_client(dict(username='new_user42'), userid='4', nodeid='4') self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) # don't allow changing (my own) roles cl = self._make_client(dict(roles='User,Admin'), userid='4', nodeid='4') self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) cl = self._make_client(dict(roles='User,Admin'), userid='4') self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) cl = self._make_client(dict(roles='User,Admin')) self.assertRaises(exceptions.Unauthorised, actions.EditItemAction(cl).handle) def testSearchPermission(self): # this checks if we properly check for search permissions self.db.security.permissions = {} self.db.security.addRole(name='User') self.db.security.addRole(name='Project') self.db.security.addPermissionToRole('User', 'Web Access') self.db.security.addPermissionToRole('Project', 'Web Access') # Allow viewing department p = self.db.security.addPermission(name='View', klass='department') self.db.security.addPermissionToRole('User', p) # Allow viewing interesting things (but not department) on iss # But users might only view issues where they are on nosy # (so in the real world the check method would be better) p = self.db.security.addPermission(name='View', klass='iss', properties=("title", "status"), check=lambda x,y,z: True) self.db.security.addPermissionToRole('User', p) # Allow all relevant roles access to stat p = self.db.security.addPermission(name='View', klass='stat') self.db.security.addPermissionToRole('User', p) self.db.security.addPermissionToRole('Project', p) # Allow role "Project" access to whole iss p = self.db.security.addPermission(name='View', klass='iss') self.db.security.addPermissionToRole('Project', p) department = self.instance.backend.Class(self.db, "department", name=hyperdb.String()) status = self.instance.backend.Class(self.db, "stat", name=hyperdb.String()) issue = self.instance.backend.Class(self.db, "iss", title=hyperdb.String(), status=hyperdb.Link('stat'), department=hyperdb.Link('department')) d1 = department.create(name='d1') d2 = department.create(name='d2') open = status.create(name='open') closed = status.create(name='closed') issue.create(title='i1', status=open, department=d2) issue.create(title='i2', status=open, department=d1) issue.create(title='i2', status=closed, department=d1) chef = self.db.user.lookup('Chef') mary = self.db.user.lookup('mary') self.db.user.set(chef, roles = 'User, Project') perm = self.db.security.hasPermission search = self.db.security.hasSearchPermission self.assertTrue(perm('View', chef, 'iss', 'department', '1')) self.assertTrue(perm('View', chef, 'iss', 'department', '2')) self.assertTrue(perm('View', chef, 'iss', 'department', '3')) self.assertTrue(search(chef, 'iss', 'department')) self.assertTrue(not perm('View', mary, 'iss', 'department')) self.assertTrue(perm('View', mary, 'iss', 'status')) # Conditionally allow view of whole iss (check is False here, # this might check for department owner in the real world) p = self.db.security.addPermission(name='View', klass='iss', check=lambda x,y,z: False) self.db.security.addPermissionToRole('User', p) self.assertTrue(perm('View', mary, 'iss', 'department')) self.assertTrue(not perm('View', mary, 'iss', 'department', '1')) self.assertTrue(not search(mary, 'iss', 'department')) self.assertTrue(perm('View', mary, 'iss', 'status')) self.assertTrue(not search(mary, 'iss', 'status')) # Allow user to search for iss.status p = self.db.security.addPermission(name='Search', klass='iss', properties=("status",)) self.db.security.addPermissionToRole('User', p) self.assertTrue(search(mary, 'iss', 'status')) dep = {'@action':'search','columns':'id','@filter':'department', 'department':'1'} stat = {'@action':'search','columns':'id','@filter':'status', 'status':'1'} depsort = {'@action':'search','columns':'id','@sort':'department'} depgrp = {'@action':'search','columns':'id','@group':'department'} # Filter on department ignored for role 'User': cl = self._make_client(dep, classname='iss', nodeid=None, userid=mary, template='index') h = HTMLRequest(cl) self.assertEqual([x.id for x in h.batch()],['1', '2', '3']) # Filter on department works for role 'Project': cl = self._make_client(dep, classname='iss', nodeid=None, userid=chef, template='index') h = HTMLRequest(cl) self.assertEqual([x.id for x in h.batch()],['2', '3']) # Filter on status works for all: cl = self._make_client(stat, classname='iss', nodeid=None, userid=mary, template='index') h = HTMLRequest(cl) self.assertEqual([x.id for x in h.batch()],['1', '2']) cl = self._make_client(stat, classname='iss', nodeid=None, userid=chef, template='index') h = HTMLRequest(cl) self.assertEqual([x.id for x in h.batch()],['1', '2']) # Sorting and grouping for class Project works: cl = self._make_client(depsort, classname='iss', nodeid=None, userid=chef, template='index') h = HTMLRequest(cl) self.assertEqual([x.id for x in h.batch()],['2', '3', '1']) self.assertEqual(cl._error_message, []) # test for empty _error_message when sort is valid self.assertEqual(cl._ok_message, []) # test for empty _ok_message when sort is valid # Test for correct _error_message for invalid sort/group properties baddepsort = {'@action':'search','columns':'id','@sort':'dep'} baddepgrp = {'@action':'search','columns':'id','@group':'dep'} cl = self._make_client(baddepsort, classname='iss', nodeid=None, userid=chef, template='index') h = HTMLRequest(cl) self.assertEqual(cl._error_message, ['Unknown sort property dep']) cl = self._make_client(baddepgrp, classname='iss', nodeid=None, userid=chef, template='index') h = HTMLRequest(cl) self.assertEqual(cl._error_message, ['Unknown group property dep']) cl = self._make_client(depgrp, classname='iss', nodeid=None, userid=chef, template='index') h = HTMLRequest(cl) self.assertEqual([x.id for x in h.batch()],['2', '3', '1']) # Sorting and grouping for class User fails: cl = self._make_client(depsort, classname='iss', nodeid=None, userid=mary, template='index') h = HTMLRequest(cl) self.assertEqual([x.id for x in h.batch()],['1', '2', '3']) cl = self._make_client(depgrp, classname='iss', nodeid=None, userid=mary, template='index') h = HTMLRequest(cl) self.assertEqual([x.id for x in h.batch()],['1', '2', '3']) def testEditCSVKeyword(self): form = dict(rows='id,name\n1,newkey') cl = self._make_client(form, userid='1', classname='keyword') cl._ok_message = [] actions.EditCSVAction(cl).handle() self.assertEqual(cl._ok_message, ['Items edited OK']) k = self.db.keyword.getnode('1') self.assertEqual(k.name, 'newkey') form = dict(rows=u2s(u'id,name\n1,\xe4\xf6\xfc')) cl = self._make_client(form, userid='1', classname='keyword') cl._ok_message = [] actions.EditCSVAction(cl).handle() self.assertEqual(cl._ok_message, ['Items edited OK']) k = self.db.keyword.getnode('1') self.assertEqual(k.name, u2s(u'\xe4\xf6\xfc')) form = dict(rows='id,name\n1,newkey\n\n2,newerkey\n\n') cl = self._make_client(form, userid='1', classname='keyword') cl._ok_message = [] actions.EditCSVAction(cl).handle() self.assertEqual(cl._ok_message, ['Items edited OK']) k = self.db.keyword.getnode('1') self.assertEqual(k.name, 'newkey') k = self.db.keyword.getnode('2') self.assertEqual(k.name, 'newerkey') def testEditCSVTest(self): form = dict(rows='\nid,boolean,date,interval,intval,link,messages,multilink,number,pw,string\n1,true,2019-02-10,2d,4,,,,3.4,pass,foo\n2,no,2017-02-10,1d,-9,1,,1,-2.4,poof,bar\n3,no,2017-02-10,1d,-9,2,,1:2,-2.4,ping,bar') cl = self._make_client(form, userid='1', classname='test') cl._ok_message = [] actions.EditCSVAction(cl).handle() self.assertEqual(cl._ok_message, ['Items edited OK']) t = self.db.test.getnode('1') self.assertEqual(t.string, 'foo') self.assertEqual(t['string'], 'foo') self.assertEqual(t.boolean, True) t = self.db.test.getnode('3') self.assertEqual(t.multilink, [ "1", "2" ]) # now edit existing row and delete row form = dict(rows='\nid,boolean,date,interval,intval,link,messages,multilink,number,pw,string\n1,false,2019-03-10,1d,3,1,,1:2,2.2,pass,bar\n2,,,,,1,,1,,,bar') cl = self._make_client(form, userid='1', classname='test') cl._ok_message = [] actions.EditCSVAction(cl).handle() self.assertEqual(cl._ok_message, ['Items edited OK']) t = self.db.test.getnode('1') self.assertEqual(t.string, 'bar') self.assertEqual(t['string'], 'bar') self.assertEqual(t.boolean, False) self.assertEqual(t.multilink, [ "1", "2" ]) self.assertEqual(t.link, "1") t = self.db.test.getnode('3') self.assertTrue(t.cl.is_retired('3')) def testEditCSVTestBadRow(self): form = dict(rows='\nid,boolean,date,interval,intval,link,messages,multilink,number,pw,string\n1,2019-02-10,2d,4,,,,3.4,pass,foo') cl = self._make_client(form, userid='1', classname='test') cl._ok_message = [] cl._error_message = [] actions.EditCSVAction(cl).handle() print(cl._error_message) self.assertEqual(cl._error_message, ['Not enough values on line 3']) def testEditCSVRestore(self): form = dict(rows='id,name\n1,key1\n2,key2') cl = self._make_client(form, userid='1', classname='keyword') cl._ok_message = [] actions.EditCSVAction(cl).handle() self.assertEqual(cl._ok_message, ['Items edited OK']) k = self.db.keyword.getnode('1') self.assertEqual(k.name, 'key1') k = self.db.keyword.getnode('2') self.assertEqual(k.name, 'key2') form = dict(rows='id,name\n1,key1') cl = self._make_client(form, userid='1', classname='keyword') cl._ok_message = [] actions.EditCSVAction(cl).handle() self.assertEqual(cl._ok_message, ['Items edited OK']) k = self.db.keyword.getnode('1') self.assertEqual(k.name, 'key1') self.assertEqual(self.db.keyword.is_retired('2'), True) form = dict(rows='id,name\n1,newkey1\n2,newkey2') cl = self._make_client(form, userid='1', classname='keyword') cl._ok_message = [] actions.EditCSVAction(cl).handle() self.assertEqual(cl._ok_message, ['Items edited OK']) k = self.db.keyword.getnode('1') self.assertEqual(k.name, 'newkey1') k = self.db.keyword.getnode('2') self.assertEqual(k.name, 'newkey2') def testRegisterActionDelay(self): from roundup.cgi.timestamp import pack_timestamp # need to set SENDMAILDEBUG to prevent # downstream issue when email is sent on successful # issue creation. Also delete the file afterwards # just to make sure that some other test looking for # SENDMAILDEBUG won't trip over ours. if 'SENDMAILDEBUG' not in os.environ: os.environ['SENDMAILDEBUG'] = 'mail-test1.log' SENDMAILDEBUG = os.environ['SENDMAILDEBUG'] # missing opaqueregister cl = self._make_client({'username':'new_user1', 'password':'secret', '@confirm@password':'secret', 'address':'new_user@bork.bork'}, nodeid=None, userid='2') with self.assertRaises(FormError) as cm: actions.RegisterAction(cl).handle() self.assertEqual(cm.exception.args, ('Form is corrupted, missing: opaqueregister.',)) # broken/invalid opaqueregister # strings chosen to generate: # binascii.Error Incorrect padding # struct.error requires a string argument of length 4 cl = self._make_client({'username':'new_user1', 'password':'secret', '@confirm@password':'secret', 'address':'new_user@bork.bork', 'opaqueregister': 'zzz' }, nodeid=None, userid='2') with self.assertRaises(FormError) as cm: actions.RegisterAction(cl).handle() self.assertEqual(cm.exception.args, ('Form is corrupted.',)) cl = self._make_client({'username':'new_user1', 'password':'secret', '@confirm@password':'secret', 'address':'new_user@bork.bork', 'opaqueregister': 'xyzzyzl=' }, nodeid=None, userid='2') with self.assertRaises(FormError) as cm: actions.RegisterAction(cl).handle() self.assertEqual(cm.exception.args, ('Form is corrupted.',)) # valid opaqueregister cl = self._make_client({'username':'new_user1', 'password':'secret', '@confirm@password':'secret', 'address':'new_user@bork.bork', 'opaqueregister': pack_timestamp() }, nodeid=None, userid='2') # submitted too fast, so raises error with self.assertRaises(FormError) as cm: actions.RegisterAction(cl).handle() self.assertEqual(cm.exception.args, ('Responding to form too quickly.',)) sleep(4.1) # sleep as requested so submit will take long enough self.assertRaises(Redirect, actions.RegisterAction(cl).handle) # FIXME check that email output makes sense at some point # clean up from email log if os.path.exists(SENDMAILDEBUG): os.remove(SENDMAILDEBUG) def testRegisterActionUnusedUserCheck(self): # need to set SENDMAILDEBUG to prevent # downstream issue when email is sent on successful # issue creation. Also delete the file afterwards # just to make sure that some other test looking for # SENDMAILDEBUG won't trip over ours. if 'SENDMAILDEBUG' not in os.environ: os.environ['SENDMAILDEBUG'] = 'mail-test1.log' SENDMAILDEBUG = os.environ['SENDMAILDEBUG'] nodeid = self.db.user.create(username='iexist', password=password.Password('foo')) # enable check and remove delay time self.db.config.WEB_REGISTRATION_PREVALIDATE_USERNAME = 1 self.db.config.WEB_REGISTRATION_DELAY = 0 # Make a request with existing user. Use iexist. # do not need opaqueregister as we have disabled the delay check cl = self._make_client({'username':'iexist', 'password':'secret', '@confirm@password':'secret', 'address':'iexist@bork.bork'}, nodeid=None, userid='2') with self.assertRaises(Reject) as cm: actions.RegisterAction(cl).handle() self.assertEqual(cm.exception.args, ("Username 'iexist' is already used.",)) cl = self._make_client({'username':'i-do@not.exist', 'password':'secret', '@confirm@password':'secret', 'address':'iexist@bork.bork'}, nodeid=None, userid='2') self.assertRaises(Redirect, actions.RegisterAction(cl).handle) # clean up from email log if os.path.exists(SENDMAILDEBUG): os.remove(SENDMAILDEBUG) def testserve_static_files_cache_headers(self): """Note for headers the real headers class is case insensitive. """ # make a client instance cl = self._make_client({}) # Make local copy in cl to not modify value in class cl.Cache_Control = copy.copy (cl.Cache_Control) # TEMPLATES dir is searched by default. So this file exists. # Check the returned values. cl.serve_static_file("style.css") # gather the conditional request headers from the 200 response inm = cl.additional_headers['ETag'] ims = cl.additional_headers['Last-Modified'] # loop over all header value possibilities that will # result in not modified. for headers in [ {'if-none-match' : inm}, {'if-modified-since' : ims}, {'if-none-match' : inm, 'if-modified-since' : ims }, {'if-none-match' : inm, 'if-modified-since' : "fake" }, {'if-none-match' : "fake", 'if-modified-since' : ims }, ]: print(headers) # Request same file with if-modified-since header # expect NotModified with same ETag and Last-Modified headers. cl.request.headers = headers cl.response_code = None cl.additional_headers = {} with self.assertRaises(NotModified) as cm: cl.serve_static_file("style.css") self.assertEqual(cm.exception.args, ()) self.assertEqual(cl.response_code, None) self.assertEqual(cl.additional_headers['ETag'], inm) self.assertEqual(cl.additional_headers['Last-Modified'], ims) ## run two cases that should not return NotModified for headers in [ {}, {'if-none-match' : "fake", 'if-modified-since' : "fake" }, ]: cl.request.headers = headers cl.response_code = None cl.additional_headers = {} cl.serve_static_file("style.css") self.assertEqual(cl.response_code, None) self.assertEqual(cl.additional_headers['ETag'], inm) self.assertEqual(cl.additional_headers['Last-Modified'], ims) ## test pure cgi case # headers attribute does not exist cl.request = None cl.response_code = None cl.additional_headers = {} cl.env["HTTP_IF_MODIFIED_SINCE"] = ims with self.assertRaises(NotModified) as cm: cl.serve_static_file("style.css") self.assertEqual(cm.exception.args, ()) self.assertEqual(cl.response_code, None) self.assertEqual(cl.additional_headers['ETag'], inm) self.assertEqual(cl.additional_headers['Last-Modified'], ims) def testserve_static_files(self): # make a client instance cl = self._make_client({}) # Make local copy in cl to not modify value in class cl.Cache_Control = copy.copy (cl.Cache_Control) # hijack _serve_file so I can see what is found output = [] def my_serve_file(a, b, c, d, e): output.append((a,b,c,d,e)) cl._serve_file = my_serve_file # check case where file is not found. self.assertRaises(NotFound, cl.serve_static_file,"missing.css") # TEMPLATES dir is searched by default. So this file exists. # Check the returned values. cl.serve_static_file("issue.index.html") print(output) self.assertEqual(output[0][2], "text/html") self.assertEqual(output[0][4], normpath('_test_cgi_form/html/issue.index.html')) del output[0] # reset output buffer # stop searching TEMPLATES for the files. cl.instance.config['STATIC_FILES'] = '-' # previously found file should not be found self.assertRaises(NotFound, cl.serve_static_file,"issue.index.html") # explicitly allow html directory cl.instance.config['STATIC_FILES'] = 'html -' cl.serve_static_file("issue.index.html") self.assertEqual(output[0][2], "text/html") self.assertEqual(output[0][4], normpath('_test_cgi_form/html/issue.index.html')) del output[0] # reset output buffer # set the list of files and do not look at the templates directory cl.instance.config['STATIC_FILES'] = 'detectors extensions - ' # find file in first directory cl.serve_static_file("messagesummary.py") self.assertEqual(output[0][2], "text/x-python") self.assertEqual(output[0][4], normpath( "_test_cgi_form/detectors/messagesummary.py")) del output[0] # reset output buffer # find file in second directory cl.serve_static_file("README.txt") self.assertEqual(output[0][2], "text/plain") self.assertEqual(output[0][4], normpath("_test_cgi_form/extensions/README.txt")) del output[0] # reset output buffer # make sure an embedded - ends the searching. cl.instance.config['STATIC_FILES'] = ' detectors - extensions ' self.assertRaises(NotFound, cl.serve_static_file, "README.txt") cl.instance.config['STATIC_FILES'] = ' detectors - extensions ' self.assertRaises(NotFound, cl.serve_static_file, "issue.index.html") # create an empty README.txt in the first directory f = open('_test_cgi_form/detectors/README.txt', 'a').close() # find file now in first directory cl.serve_static_file("README.txt") self.assertEqual(output[0][2], "text/plain") self.assertEqual(output[0][4], normpath("_test_cgi_form/detectors/README.txt")) del output[0] # reset output buffer cl.instance.config['STATIC_FILES'] = ' detectors extensions ' # make sure lack of trailing - allows searching TEMPLATES cl.serve_static_file("issue.index.html") self.assertEqual(output[0][2], "text/html") self.assertEqual(output[0][4], normpath("_test_cgi_form/html/issue.index.html")) del output[0] # reset output buffer # Make STATIC_FILES a single element. cl.instance.config['STATIC_FILES'] = 'detectors' # find file now in first directory cl.serve_static_file("messagesummary.py") self.assertEqual(output[0][2], "text/x-python") self.assertEqual(output[0][4], normpath("_test_cgi_form/detectors/messagesummary.py")) del output[0] # reset output buffer # make sure files found in subdirectory os.mkdir('_test_cgi_form/detectors/css') f = open('_test_cgi_form/detectors/css/README.css', 'a').close() # use subdir in filename cl.serve_static_file("css/README.css") self.assertEqual(output[0][2], "text/css") self.assertEqual(output[0][4], normpath("_test_cgi_form/detectors/css/README.css")) del output[0] # reset output buffer cl.Cache_Control['text/css'] = 'public, max-age=3600' # use subdir in static files path cl.instance.config['STATIC_FILES'] = 'detectors html/css' os.mkdir('_test_cgi_form/html/css') f = open('_test_cgi_form/html/css/README1.css', 'a').close() cl.serve_static_file("README1.css") self.assertEqual(output[0][2], "text/css") self.assertEqual(output[0][4], normpath("_test_cgi_form/html/css/README1.css")) self.assertTrue( "Cache-Control" in cl.additional_headers ) self.assertEqual( cl.additional_headers, {'Cache-Control': 'public, max-age=3600'} ) print(cl.additional_headers) del output[0] # reset output buffer cl.Cache_Control['README1.css'] = 'public, max-age=60' cl.serve_static_file("README1.css") self.assertEqual(output[0][2], "text/css") self.assertEqual(output[0][4], normpath("_test_cgi_form/html/css/README1.css")) self.assertTrue( "Cache-Control" in cl.additional_headers ) self.assertEqual( cl.additional_headers, {'Cache-Control': 'public, max-age=60'} ) del output[0] # reset output buffer def testRoles(self): cl = self._make_client({}) self.db.user.set('1', roles='aDmin, uSer') item = HTMLItem(cl, 'user', '1') self.assertTrue(item.hasRole('Admin')) self.assertTrue(item.hasRole('User')) self.assertTrue(item.hasRole('AdmiN')) self.assertTrue(item.hasRole('UseR')) self.assertTrue(item.hasRole('UseR','Admin')) self.assertTrue(item.hasRole('UseR','somethingelse')) self.assertTrue(item.hasRole('somethingelse','Admin')) self.assertTrue(not item.hasRole('userr')) self.assertTrue(not item.hasRole('adminn')) self.assertTrue(not item.hasRole('')) self.assertTrue(not item.hasRole(' ')) self.db.user.set('1', roles='') self.assertTrue(not item.hasRole('')) def testCSVExportCharset(self): cl = self._make_client( {'@columns': 'id,title,status,keyword,assignedto,nosy'}, nodeid=None, userid='1') cl.classname = 'issue' demo_id=self.db.user.create(username='demo', address='demo@test.test', roles='User', realname='demo') self.db.issue.create(title=b2s(b'foo1\xc3\xa4'), status='2', assignedto='4', nosy=['3',demo_id]) output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # call export version that outputs names actions.ExportCSVAction(cl).handle() should_be=(b'"id","title","status","keyword","assignedto","nosy"\r\n' b'"1","foo1\xc3\xa4","deferred","","Contrary, Mary","Bork, Chef;Contrary, Mary;demo"\r\n') self.assertEqual(output.getvalue(), should_be) output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # call export version that outputs id numbers actions.ExportCSVWithIdAction(cl).handle() print(output.getvalue()) self.assertEqual(b'"id","title","status","keyword","assignedto","nosy"\r\n' b"\"1\",\"foo1\xc3\xa4\",\"2\",\"[]\",\"4\",\"['3', '4', '5']\"\r\n", output.getvalue()) # again with ISO-8859-1 client charset cl.charset = 'iso8859-1' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # call export version that outputs names actions.ExportCSVAction(cl).handle() should_be=(b'"id","title","status","keyword","assignedto","nosy"\r\n' b'"1","foo1\xe4","deferred","","Contrary, Mary","Bork, Chef;Contrary, Mary;demo"\r\n') self.assertEqual(output.getvalue(), should_be) output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # call export version that outputs id numbers actions.ExportCSVWithIdAction(cl).handle() print(output.getvalue()) self.assertEqual(b'"id","title","status","keyword","assignedto","nosy"\r\n' b"\"1\",\"foo1\xe4\",\"2\",\"[]\",\"4\",\"['3', '4', '5']\"\r\n", output.getvalue()) def testCSVExportBadColumnName(self): cl = self._make_client({'@columns': 'falseid,name'}, nodeid=None, userid='1') cl.classname = 'status' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output self.assertRaises(exceptions.NotFound, actions.ExportCSVAction(cl).handle) def testCSVExportFailPermissionBadColumn(self): cl = self._make_client({'@columns': 'id,email,password'}, nodeid=None, userid='2') cl.classname = 'user' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # used to be self.assertRaises(exceptions.Unauthorised, # but not acting like the column name is not found # see issue2550755 - should this return Unauthorised? # The unauthorised user should never get to the point where # they can determine if the column name is valid or not. self.assertRaises(exceptions.NotFound, actions.ExportCSVAction(cl).handle) def testCSVExportFailPermissionValidColumn(self): passwd=password.Password('foo') demo_id=self.db.user.create(username='demo', address='demo@test.test', roles='User', realname='demo', password=passwd) cl = self._make_client({'@columns': 'id,username,address,password'}, nodeid=None, userid=demo_id) cl.classname = 'user' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # used to be self.assertRaises(exceptions.Unauthorised, # but not acting like the column name is not found actions.ExportCSVAction(cl).handle() #print(output.getvalue()) self.assertEqual(s2b('"id","username","address","password"\r\n' '"1","admin","[hidden]","[hidden]"\r\n' '"2","anonymous","[hidden]","[hidden]"\r\n' '"3","Chef","[hidden]","[hidden]"\r\n' '"4","mary","[hidden]","[hidden]"\r\n' '"5","demo","demo@test.test","%s"\r\n'%(passwd)), output.getvalue()) def testCSVExportWithId(self): cl = self._make_client({'@columns': 'id,name'}, nodeid=None, userid='1') cl.classname = 'status' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output actions.ExportCSVWithIdAction(cl).handle() self.assertEqual(s2b('"id","name"\r\n"1","unread"\r\n"2","deferred"\r\n"3","chatting"\r\n' '"4","need-eg"\r\n"5","in-progress"\r\n"6","testing"\r\n"7","done-cbb"\r\n' '"8","resolved"\r\n'), output.getvalue()) def testCSVExportWithIdBadColumnName(self): cl = self._make_client({'@columns': 'falseid,name'}, nodeid=None, userid='1') cl.classname = 'status' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output self.assertRaises(exceptions.NotFound, actions.ExportCSVWithIdAction(cl).handle) def testCSVExportWithIdFailPermissionBadColumn(self): cl = self._make_client({'@columns': 'id,email,password'}, nodeid=None, userid='2') cl.classname = 'user' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # used to be self.assertRaises(exceptions.Unauthorised, # but not acting like the column name is not found # see issue2550755 - should this return Unauthorised? # The unauthorised user should never get to the point where # they can determine if the column name is valid or not. self.assertRaises(exceptions.NotFound, actions.ExportCSVWithIdAction(cl).handle) def testCSVExportWithIdFailPermissionValidColumn(self): cl = self._make_client({'@columns': 'id,address,password'}, nodeid=None, userid='2') cl.classname = 'user' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # used to be self.assertRaises(exceptions.Unauthorised, # but not acting like the column name is not found self.assertRaises(exceptions.Unauthorised, actions.ExportCSVWithIdAction(cl).handle) class TemplateHtmlRendering(unittest.TestCase, testFtsQuery): ''' try to test the rendering code for tal ''' def setUp(self): self.dirname = '_test_template' # set up and open a tracker self.instance = setupTracker(self.dirname) # open the database self.db = self.instance.open('admin') self.db.tx_Source = "web" self.db.user.create(username='Chef', address='chef@bork.bork.bork', realname='Bork, Chef', roles='User') self.db.user.create(username='mary', address='mary@test.test', roles='User', realname='Contrary, Mary') self.db.post_init() # create a client instance and hijack write_html self.client = client.Client(self.instance, "user", {'PATH_INFO':'/user', 'REQUEST_METHOD':'POST'}, form=db_test_base.makeForm({"@template": "item"})) self.client._error_message = [] self.client._ok_message = [] self.client.db = self.db self.client.userid = '1' self.client.language = ('en',) self.client.session_api = MockNull(_sid="1234567890") self.output = [] # ugly hack to get html_write to return data here. def html_write(s): self.output.append(s) # hijack html_write self.client.write_html = html_write self.db.issue.create(title='foo') def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def testrenderFrontPage(self): self.client.renderFrontPage("hello world RaNdOmJunk") # make sure we can find the "hello world RaNdOmJunk" # message in the output. self.assertNotEqual(-1, self.output[0].index('

hello world RaNdOmJunk

')) # make sure we can find issue 1 title foo in the output self.assertNotEqual(-1, self.output[0].index('foo')) # make sure we can find the last SHA1 sum line at the end of the # page self.assertNotEqual(-1, self.output[0].index('')) def testRenderError(self): # set up the client; # run determine_context to set the required client attributes # run renderError(); check result for proper page self.client.form=db_test_base.makeForm({}) self.client.path = '' self.client.determine_context() error = "Houston, we have a problem" # template rendering will fail and return fallback html out = self.client.renderError(error, 404) expected_fallback = ( '\nRoundup issue tracker: ' 'An error has occurred\n' ' \n' '\n' '\n' '

Houston, we have a problem

\n' '\n') self.assertEqual(out, expected_fallback) self.assertIn(error, self.client._error_message) self.assertEqual(self.client.response_code, 404) ### next test # Set this so template rendering works. self.client.classname = 'issue' out = self.client.renderError("Houston, we have a problem", 404) # match hard coded line in 404 template expected = ('There is no issue with id') self.assertIn(expected, out) self.assertEqual(self.client.response_code, 404) ### next test # disable template use get fallback out = self.client.renderError("Houston, we have a problem", 404, use_template=False) self.assertEqual(out, expected_fallback) self.assertEqual(self.client.response_code, 404) ### next test # no 400 template (default 2nd param) so we get fallback out = self.client.renderError("Houston, we have a problem") self.assertEqual(out, expected_fallback) self.assertIn(error, self.client._error_message) self.assertEqual(self.client.response_code, 400) def testrenderContext(self): # set up the client; # run determine_context to set the required client attributes # run renderContext(); check result for proper page # this will generate the default home page like # testrenderFrontPage self.client.form=db_test_base.makeForm({}) self.client.path = '' self.client.determine_context() self.assertEqual((self.client.classname, self.client.template, self.client.nodeid), (None, '', None)) self.assertEqual(self.client._ok_message, []) result = self.client.renderContext() self.assertNotEqual(-1, result.index('')) # now look at the user index page self.client.form=db_test_base.makeForm( { "@ok_message": "ok message", "@template": "index"}) self.client.path = 'user' self.client.determine_context() self.assertEqual((self.client.classname, self.client.template, self.client.nodeid), ('user', 'index', None)) self.assertEqual(self.client._ok_message, ['ok message']) result = self.client.renderContext() self.assertNotEqual(-1, result.index('User listing - Roundup issue tracker')) self.assertNotEqual(-1, result.index('ok message')) # print result def testRenderAltTemplates(self): # check that right page is returned when rendering # @template=oktempl|errortmpl # set up the client; # run determine_context to set the required client attributes # run renderContext(); check result for proper page # Test ok state template that uses user.forgotten.html self.client.form=db_test_base.makeForm({"@template": "forgotten|item"}) self.client.path = 'user' self.client.determine_context() self.client.session_api = MockNull(_sid="1234567890") self.assertEqual( (self.client.classname, self.client.template, self.client.nodeid), ('user', 'forgotten|item', None)) self.assertEqual(self.client._ok_message, []) result = self.client.renderContext() print(result) # sha1sum of classic tracker user.forgotten.template must be found sha1sum = '' self.assertNotEqual(-1, result.index(sha1sum)) # now set an error in the form to get error template user.item.html self.client.form=db_test_base.makeForm({"@template": "forgotten|item", "@error_message": "this is an error"}) self.client.path = 'user' self.client.determine_context() self.assertEqual( (self.client.classname, self.client.template, self.client.nodeid), ('user', 'forgotten|item', None)) self.assertEqual(self.client._ok_message, []) self.assertEqual(self.client._error_message, ["this is an error"]) result = self.client.renderContext() print(result) # sha1sum of classic tracker user.item.template must be found sha1sum = '' self.assertNotEqual(-1, result.index(sha1sum)) def testRenderAltTemplatesError(self): # check that an error is reported to user when rendering using # @template=oktempl|errortmpl|oops|foo # template names can not include | # set up the client; # run determine_context to set the required client attributes # run renderContext(); check result for proper page # Test ok state template that uses user.forgotten.html self.client.form=db_test_base.makeForm({"@template": "forgotten|item|oops|foo"}) self.client.path = 'user' self.client.determine_context() self.client.session_api = MockNull(_sid="1234567890") self.assertEqual( (self.client.classname, self.client.template, self.client.nodeid), ('user', 'forgotten|item|oops|foo', None)) self.assertEqual(self.client._ok_message, []) result = self.client.renderContext() print(result) # sha1sum of classic tracker user.forgotten.template must be found sha1sum = '' self.assertNotEqual(-1, result.index(sha1sum)) # now set an error in the form to get error template user.item.html self.client.form=db_test_base.makeForm({"@template": "forgotten|item|oops|foo", "@error_message": "this is an error"}) self.client.path = 'user' self.client.determine_context() result = self.client.renderContext() self.assertEqual(result, 'No template file exists for templating "user" with template "item|oops|foo" (neither "user.item|oops|foo" nor "_generic.item|oops|foo")') def testexamine_url(self): ''' test the examine_url function ''' def te(url, exception, raises=ValueError): with self.assertRaises(raises) as cm: examine_url(url) self.assertEqual(cm.exception.args, (exception,)) action = actions.Action(self.client) examine_url = action.examine_url # Christmas tree url: test of every component that passes self.assertEqual( examine_url("http://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue"), 'http://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue') # allow replacing http with https if base is http self.assertEqual( examine_url("https://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue"), 'https://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue') # change base to use https and make sure we don't redirect to http saved_base = action.base action.base = "https://tracker.example/cgi-bin/roundup.cgi/bugs/" te("http://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue", 'Base url https://tracker.example/cgi-bin/roundup.cgi/bugs/ requires https. Redirect url http://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue uses http.') action.base = saved_base # url doesn't have to be valid to roundup, just has to be contained # inside of roundup. No zoik class is defined self.assertEqual(examine_url("http://tracker.example/cgi-bin/roundup.cgi/bugs/zoik7;parm=bar?@template=foo&parm=(zot)#issue"), "http://tracker.example/cgi-bin/roundup.cgi/bugs/zoik7;parm=bar?@template=foo&parm=(zot)#issue") # test with wonky schemes te("email://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue", 'Unrecognized scheme in email://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue') te("http%3a//tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue", 'Unrecognized scheme in http%3a//tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue') # test different netloc/path prefix # assert port te("http://tracker.example:1025/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue",'Net location in http://tracker.example:1025/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue does not match base: tracker.example') #assert user te("http://user@tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue", 'Net location in http://user@tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue does not match base: tracker.example') #assert user:password te("http://user:pass@tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue", 'Net location in http://user:pass@tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue does not match base: tracker.example') # try localhost http scheme te("http://localhost/cgi-bin/roundup.cgi/bugs/user3", 'Net location in http://localhost/cgi-bin/roundup.cgi/bugs/user3 does not match base: tracker.example') # try localhost https scheme te("https://localhost/cgi-bin/roundup.cgi/bugs/user3", 'Net location in https://localhost/cgi-bin/roundup.cgi/bugs/user3 does not match base: tracker.example') # try different host te("http://bad.guys.are.us/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue", 'Net location in http://bad.guys.are.us/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#issue does not match base: tracker.example') # change the base path to .../bug from .../bugs te("http://tracker.example/cgi-bin/roundup.cgi/bug/user3;parm=bar?@template=foo&parm=(zot)#issue", 'Base path /cgi-bin/roundup.cgi/bugs/ is not a prefix for url http://tracker.example/cgi-bin/roundup.cgi/bug/user3;parm=bar?@template=foo&parm=(zot)#issue') # change the base path eliminate - in cgi-bin te("http://tracker.example/cgibin/roundup.cgi/bug/user3;parm=bar?@template=foo&parm=(zot)#issue",'Base path /cgi-bin/roundup.cgi/bugs/ is not a prefix for url http://tracker.example/cgibin/roundup.cgi/bug/user3;parm=bar?@template=foo&parm=(zot)#issue') # scan for unencoded characters # we skip schema and net location since unencoded character # are allowed only by an explicit match to a reference. # # break components with unescaped character '<' # path component te("http://tracker.example/cgi-bin/roundup.cgi/bugs/&parm=(zot)#issue", 'Query component (@template=&parm=(zot)) in http://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=&parm=(zot)#issue is not properly escaped') # fragment component te("http://tracker.example/cgi-bin/roundup.cgi/bugs/user3;parm=bar?@template=foo&parm=(zot)#iss""" ), }, ] for file_spec in testfiles: file_path = "%s/html/%s" % (self.dirname, file_spec['name']) with open(file_path, "w") as f: f.write(file_spec['content']) # get the client instance The form is needed to initialize, # but not used since I call selectTemplate directly. t = client.Client(self.instance, "user", {'PATH_INFO':'/user', 'REQUEST_METHOD':'POST'}, form=db_test_base.makeForm({"@template": "readfile_success"})) tu = TemplatingUtils(t) # testcase 1 - file exists r = tu.readfile("file_to_read.js") self.assertEqual(r, 'hello world') r = None # testcase 2 - file does not exist with self.assertRaises(NoTemplate) as e: r = tu.readfile("no_file_to_read.js") self.assertEqual( e.exception.args[0], "Unable to read or expand file 'no_file_to_read.js' " "in template 'home'.") r = None # testcase 3 - file does not exist - optional = True r = tu.readfile("no_file_to_read.js", optional=True) self.assertEqual(r, '') # make sure a created template is found # note that the extension is not included just the basename self.assertEqual("_generic.readfile_success", t.selectTemplate("", "readfile_success")) def testExpandfile(self): # test for templates in subdirectories # remove when no longer supporting python 2 if not hasattr(self, 'assertRegex'): self.assertRegex = self.assertRegexpMatches # make the directory subdir = self.dirname + "/html/subdir" os.mkdir(subdir) # create new files in html dir testfiles = [ { "name": "file_to_read.js", "content": ('hello world'), }, { "name": "file_no_content.js", "content": '', }, { "name": "file_to_expand.js", "content": ('hello world %(base)s'), }, { "name": "file_with_broken_expand_type.js", "content": ('hello world %(base)'), }, { "name": "file_with_odd_token.js", "content": ('hello world %(base)s, %(No,token)s'), }, { "name": "file_with_missing.js", "content": ('hello world %(base)s, %(idontexist)s'), }, { "name": "file_with_bare_%.js", "content": ('expr = 3 % 5 + (var1+var2)'), }, { "name": "subdir/file_to_read.js", "content": ('hello world from subdir'), }, { # for future test expanding TAL "name": "_generic.expandfile_success.html", "content": ( '''""" ), }, ] for file_spec in testfiles: file_path = "%s/html/%s" % (self.dirname, file_spec['name']) with open(file_path, "w") as f: f.write(file_spec['content']) # get the client instance The form is needed to initialize, # but not used since I call selectTemplate directly. t = client.Client(self.instance, "user", {'PATH_INFO':'/user', 'REQUEST_METHOD':'POST'}, form=db_test_base.makeForm({"@template": "readfile_success"})) t.db = MockNull() t.db.config = MockNull() t.db.config.TRACKER_WEB = '_tracker_template' tu = TemplatingUtils(t) # testcase 1 - file exists r = tu.expandfile("file_to_read.js") self.assertEqual(r, 'hello world') r = None # testcase 2 - file does not exist with self.assertRaises(NoTemplate) as e: r = tu.expandfile("no_file_to_read.js") self.assertEqual( e.exception.args[0], "Unable to read or expand file 'no_file_to_read.js' " "in template 'home'.") r = None # testcase 3 - file does not exist - optional = True r = tu.expandfile("no_file_to_read.js", optional=True) self.assertEqual(r, '') r = None # testcase 4 - file is empty r = tu.expandfile("file_no_content.js") self.assertEqual(r, '') r = None # testcase 5 - behave like readfile (values = None) r = tu.expandfile("file_to_expand.js") self.assertEqual(r, "hello world %(base)s") r = None # testcase 6 - expand predefined r = tu.expandfile("file_to_expand.js", {}) self.assertEqual(r, "hello world _tracker_template") r = None # testcase 7 - missing trailing type specifier r = tu.expandfile("file_with_broken_expand_type.js", {}) self.assertEqual(r, "") # self._caplog.record_tuples[0] - without line breaks # ('roundup.template', 40, "Found an incorrect token when # expandfile applied string subsitution on # '/home/roundup/_test_template/html/file_with_broken_expand_type.js. # ValueError('incomplete format') was raised. Check the format # of your named conversion specifiers." # name used for logging self.assertEqual(self._caplog.record_tuples[0][0], 'roundup.template') # severity ERROR = 40 self.assertEqual(self._caplog.record_tuples[0][1], 40, msg="logging level != 40 (ERROR)") # message. It includes a full path to the problem file, so Regex # match the changable filename directory self.assertRegex(self._caplog.record_tuples[0][2], ( r"^Found an incorrect token when expandfile applied " r"string subsitution on " r"'[^']*[\\/]_test_template[\\/]html[\\/]file_with_broken_expand_type.js'. " r"ValueError\('incomplete format'\) was raised. Check the format " r"of your named conversion specifiers.")) self._caplog.clear() r = None # testcase 8 - odd token. Apparently names are not identifiers r = tu.expandfile("file_with_odd_token.js", {'No,token': 'NT'}) self.assertEqual(r, "hello world _tracker_template, NT") # self._caplog.record_tuples[0] - without line breaks # ('roundup.template', 40, "Found an incorrect token when # expandfile applied string subsitution on # '/home/roundup/_test_template/html/file_with_broken_expand_type.js. # ValueError('incomplete format') was raised. Check the format # of your named conversion specifiers." # no logs should be present self.assertEqual(self._caplog.text, '') r = None # testcase 9 - key missing from values r = tu.expandfile("file_with_missing.js", {}) self.assertEqual(r, "") # self._caplog.record_tuples[0] - without line breaks # ('roundup.template', 40, "Found an incorrect token when # expandfile applied string subsitution on # '/home/roundup/_test_template/html/file_with_broken_expand_type.js. # ValueError('incomplete format') was raised. Check the format # of your named conversion specifiers." # name used for logging self.assertEqual(self._caplog.record_tuples[0][0], 'roundup.template') # severity ERROR = 40 self.assertEqual(self._caplog.record_tuples[0][1], 40, msg="logging level != 40 (ERROR)") # message. It includes a full path to the problem file, so Regex # match the changable filename directory self.assertRegex(self._caplog.record_tuples[0][2], ( r"When running " r"expandfile\('[^']*[\\/]_test_template[\\/]html[\\/]file_with_missing.js'\) " r"in 'home' there was no value for token: 'idontexist'.")) self._caplog.clear() r = None # testcase 10 - set key missing from values in test 8 r = tu.expandfile("file_with_missing.js", {'idontexist': 'I do exist'}) self.assertEqual(r, "hello world _tracker_template, I do exist") # no logging self.assertEqual(self._caplog.text, '') self._caplog.clear() # testcase 11 - handle a file with a bare % that raises TypeError r = tu.expandfile("file_with_bare_%.js", {"var1": "bar"}) self.assertEqual(r, '') # self._caplog.record_tuples[0] - without line breaks # ('roundup.template', 40, "Found an incorrect token when # expandfile applied string subsitution on # '/home/roundup/_test_template/html/file_with_broken_expand_type.js. # ValueError('incomplete format') was raised. Check the format # of your named conversion specifiers." # name used for logging self.assertEqual(self._caplog.record_tuples[0][0], 'roundup.template') # severity ERROR = 40 self.assertEqual(self._caplog.record_tuples[0][1], 40, msg="logging level != 40 (ERROR)") # message. It includes a full path to the problem file, so Regex # match the changable filename directory self.assertRegex(self._caplog.record_tuples[0][2], ( r"^Found an incorrect token when expandfile applied " r"string subsitution on " r"'[^']*[\\/]_test_template[\\/]html[\\/]file_with_bare_%.js'. " r"ValueError\(" r"'unsupported format character ' ' \(0x20\) at index 12'\) was " r"raised. Check the format " r"of your named conversion specifiers.")) self._caplog.clear() r = None # testcase 12 - file exists in subdir r = tu.expandfile("subdir/file_to_read.js") self.assertEqual(r, 'hello world from subdir') r = None # make sure a created template is found # note that the extension is not included just the basename self.assertEqual("_generic.expandfile_success", t.selectTemplate("", "expandfile_success")) class SqliteNativeFtsCgiTest(unittest.TestCase, testFtsQuery, testCsvExport): """All of the rest of the tests use anydbm as the backend. In addtion to normal fts test, this class tests renderError when renderContext fails. Triggering this error requires the native-fts backend for the sqlite db. """ def setUp(self): self.dirname = '_test_template' # set up and open a tracker self.instance = setupTracker(self.dirname, backend="sqlite") self.instance.config.INDEXER = "native-fts" # open the database self.db = self.instance.open('admin') self.db.tx_Source = "web" self.db.user.create(username='Chef', address='chef@bork.bork.bork', realname='Bork, Chef', roles='User') self.db.user.create(username='mary', address='mary@test.test', roles='User', realname='Contrary, Mary') self.db.post_init() # create a client instance and hijack write_html self.client = client.Client(self.instance, "user", {'PATH_INFO':'/user', 'REQUEST_METHOD':'POST'}, form=db_test_base.makeForm({"@template": "item"})) self.client._error_message = [] self.client._ok_message = [] self.client.db = self.db self.client.userid = '1' self.client.language = ('en',) self.client.session_api = MockNull(_sid="1234567890") self.output = [] # ugly hack to get html_write to return data here. def html_write(s): self.output.append(s) # hijack html_write self.client.write_html = html_write def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def testRenderContextBadFtsQuery(self): # only test for sqlite if self.db.dbtype not in [ "sqlite" ]: pytest.skip("Not tested for backends without native FTS") # generate a bad fts query self.client.form=db_test_base.makeForm( { "@ok_message": "ok message", "@template": "index", "@search_text": "foo-bar"}) self.client.path = 'issue' self.client.determine_context() result = self.client.renderContext() expected = '\nRoundup issue tracker: An error has occurred\n \n\n\n

Search failed. Try quoting any terms that include a \'-\' and retry the search.

\n\n' self.assertEqual(result, expected) self.assertEqual(self.client.response_code, 400) # handle outstanding commits since we are not using the # standard entry points. self.db.commit() # # SECURITY # # XXX test all default permissions def _make_client(self, form, classname='user', nodeid='1', userid='2', template='item'): cl = client.Client(self.instance, None, {'PATH_INFO':'/', 'REQUEST_METHOD':'POST'}, db_test_base.makeForm(form)) cl.classname = classname if nodeid is not None: cl.nodeid = nodeid cl.db = self.db cl.db.Otk = cl.db.getOTKManager() #cl.db.Otk = MockNull() #cl.db.Otk.data = {} #cl.db.Otk.getall = self.data_get #cl.db.Otk.set = self.data_set cl.userid = userid cl.language = ('en',) cl._error_message = [] cl._ok_message = [] cl.template = template return cl def testCSVExportSearchError(self): # test full text search cl = self._make_client( {'@columns': 'id,title,status,keyword,assignedto,nosy', "@search_text": "foo + ^bar2"}, nodeid=None, userid='1') cl.classname = 'issue' output = io.BytesIO() cl.request = MockNull() cl.request.wfile = output # note NotFound isn't quite right. however this exception # passes up the stack to where it is handled with a suitable # display of the error. # call export version that outputs names with self.assertRaises(NotFound) as cm: actions.ExportCSVAction(cl).handle() # call export version that outputs id numbers with self.assertRaises(NotFound) as cm: actions.ExportCSVWithIdAction(cl).handle() # commit changes so db can be properly closed on windows. # because we are testing the backend method and not using # cl.main() that handles db commit/close, we need to do this. cl.db.commit() class SqliteNativeCgiTest(unittest.TestCase, testFtsQuery): """All of the rest of the tests use anydbm as the backend. This class tests renderContext for fulltext search. Run with sqlite and native indexer. """ def setUp(self): self.dirname = '_test_template' # set up and open a tracker self.instance = setupTracker(self.dirname, backend="sqlite") self.instance.config.INDEXER = "native" # open the database self.db = self.instance.open('admin') self.db.tx_Source = "web" # create a client instance and hijack write_html self.client = client.Client(self.instance, "user", {'PATH_INFO':'/user', 'REQUEST_METHOD':'POST'}, form=db_test_base.makeForm({"@template": "item"})) self.client._error_message = [] self.client._ok_message = [] self.client.db = self.db self.client.userid = '1' self.client.language = ('en',) self.client.session_api = MockNull(_sid="1234567890") self.output = [] # ugly hack to get html_write to return data here. def html_write(s): self.output.append(s) # hijack html_write self.client.write_html = html_write def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise @skip_postgresql class PostgresqlNativeCgiTest(unittest.TestCase, testFtsQuery): """All of the rest of the tests use anydbm as the backend. This class tests renderContext for fulltext search. Run with postgresql and native indexer. """ def setUp(self): self.dirname = '_test_template' # set up and open a tracker self.instance = setupTracker(self.dirname, backend="postgresql") self.instance.config.INDEXER = "native" # open the database self.db = self.instance.open('admin') self.db.tx_Source = "web" # create a client instance and hijack write_html self.client = client.Client(self.instance, "user", {'PATH_INFO':'/user', 'REQUEST_METHOD':'POST'}, form=db_test_base.makeForm({"@template": "item"})) self.client._error_message = [] self.client._ok_message = [] self.client.db = self.db self.client.userid = '1' self.client.language = ('en',) self.client.session_api = MockNull(_sid="1234567890") self.output = [] # ugly hack to get html_write to return data here. def html_write(s): self.output.append(s) # hijack html_write self.client.write_html = html_write def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise @skip_mysql class MysqlNativeCgiTest(unittest.TestCase, testFtsQuery): """All of the rest of the tests use anydbm as the backend. This class tests renderContext for fulltext search. Run with mysql and native indexer. """ def setUp(self): self.dirname = '_test_template' # set up and open a tracker self.instance = setupTracker(self.dirname, backend="mysql") self.instance.config.INDEXER = "native" # open the database self.db = self.instance.open('admin') self.db.tx_Source = "web" # create a client instance and hijack write_html self.client = client.Client(self.instance, "user", {'PATH_INFO':'/user', 'REQUEST_METHOD':'POST'}, form=db_test_base.makeForm({"@template": "item"})) self.client._error_message = [] self.client._ok_message = [] self.client.db = self.db self.client.userid = '1' self.client.language = ('en',) self.client.session_api = MockNull(_sid="1234567890") self.output = [] # ugly hack to get html_write to return data here. def html_write(s): self.output.append(s) # hijack html_write self.client.write_html = html_write def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise # vim: set filetype=python sts=4 sw=4 et si : code-e5bd50120b5a/test/test_config.py0000644000000000000000000020453615064275501015567 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import configparser import errno import fileinput import logging import os import pytest import re import shutil import sys import unittest from os.path import normpath from textwrap import dedent from roundup import configuration from roundup.backends import get_backend, have_backend from roundup.hyperdb import DatabaseError from .db_test_base import config if not have_backend('postgresql'): # FIX: workaround for a bug in pytest.mark.skip(): # https://github.com/pytest-dev/pytest/issues/568 from .pytest_patcher import mark_class skip_postgresql = mark_class(pytest.mark.skip( reason='Skipping PostgreSQL tests: backend not available')) else: try: from roundup.backends.back_postgresql import psycopg2, db_command,\ get_database_schema_names db_command(config, 'select 1') skip_postgresql = lambda func, *args, **kwargs: func except( DatabaseError ) as msg: from .pytest_patcher import mark_class skip_postgresql = mark_class(pytest.mark.skip( reason='Skipping PostgreSQL tests: database not available')) try: import xapian skip_xapian = lambda func, *args, **kwargs: func from .pytest_patcher import mark_class include_no_xapian = mark_class(pytest.mark.skip( "Skipping missing Xapian indexer tests: 'xapian' is installed")) except ImportError: # FIX: workaround for a bug in pytest.mark.skip(): # https://github.com/pytest-dev/pytest/issues/568 from .pytest_patcher import mark_class skip_xapian = mark_class(pytest.mark.skip( "Skipping Xapian indexer tests: 'xapian' not installed")) include_no_xapian = lambda func, *args, **kwargs: func try: import redis skip_redis = lambda func, *args, **kwargs: func except ImportError: # FIX: workaround for a bug in pytest.mark.skip(): # https://github.com/pytest-dev/pytest/issues/568 from .pytest_patcher import mark_class skip_redis = mark_class(pytest.mark.skip( "Skipping redis tests: 'redis' not installed")) _py3 = sys.version_info[0] > 2 if _py3: skip_py2 = lambda func, *args, **kwargs: func else: # FIX: workaround for a bug in pytest.mark.skip(): # https://github.com/pytest-dev/pytest/issues/568 from .pytest_patcher import mark_class skip_py2 = mark_class(pytest.mark.skip( reason='Skipping test under python2.')) config = configuration.CoreConfig() config.DATABASE = "db" config.RDBMS_NAME = "rounduptest" config.RDBMS_HOST = "localhost" config.RDBMS_USER = "rounduptest" config.RDBMS_PASSWORD = "rounduptest" config.RDBMS_TEMPLATE = "template0" # these TRACKER_WEB and MAIL_DOMAIN values are used in mailgw tests config.MAIL_DOMAIN = "your.tracker.email.domain.example" config.TRACKER_WEB = "http://tracker.example/cgi-bin/roundup.cgi/bugs/" # uncomment the following to have excessive debug output from test cases # FIXME: tracker logging level should be increased by -v arguments # to 'run_tests.py' script #config.LOGGING_FILENAME = "/tmp/logfile" #config.LOGGING_LEVEL = "DEBUG" config.init_logging() config.options['FOO'] = "value" # for TrackerConfig test class from roundup import instance from . import db_test_base class ConfigTest(unittest.TestCase): def test_badConfigKeyword(self): """Run configure tests looking for invalid option name """ self.assertRaises(configuration.InvalidOptionError, config._get_option, "BadOptionName") def test_validConfigKeyword(self): """Run configure tests looking for invalid option name """ self.assertEqual(config._get_option("FOO"), "value") def testTrackerWeb(self): config = configuration.CoreConfig() self.assertEqual(None, config._get_option('TRACKER_WEB').set("http://foo.example/bar/")) self.assertEqual(None, config._get_option('TRACKER_WEB').set("https://foo.example/bar/")) self.assertRaises(configuration.OptionValueError, config._get_option('TRACKER_WEB').set, "https://foo.example/bar") self.assertRaises(configuration.OptionValueError, config._get_option('TRACKER_WEB').set, "htt://foo.example/bar/") self.assertRaises(configuration.OptionValueError, config._get_option('TRACKER_WEB').set, "htt://foo.example/bar") self.assertRaises(configuration.OptionValueError, config._get_option('TRACKER_WEB').set, "") def testRedis_Url(self): config = configuration.CoreConfig() with self.assertRaises(configuration.OptionValueError) as cm: config._get_option('SESSIONDB_REDIS_URL').set( "redis://foo.example/bar?decode_responses=False") self.assertIn('decode_responses', cm.exception.__str__()) config._get_option('SESSIONDB_REDIS_URL').set( "redis://localhost:6379/0?health_check_interval=2") def testLoginAttemptsMin(self): config = configuration.CoreConfig() self.assertEqual(None, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set("0")) self.assertEqual(None, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set("200")) self.assertRaises(configuration.OptionValueError, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set, "fred") self.assertRaises(configuration.OptionValueError, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set, "-1") self.assertRaises(configuration.OptionValueError, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set, "") def testTimeZone(self): config = configuration.CoreConfig() self.assertEqual(None, config._get_option('TIMEZONE').set("0")) # not a valid timezone self.assertRaises(configuration.OptionValueError, config._get_option('TIMEZONE').set, "Zot") # 25 is not a valid UTC offset: -12 - +14 is range # possibly +/- 1 for DST. But roundup.date doesn't # constrain to this range. #self.assertRaises(configuration.OptionValueError, # config._get_option('TIMEZONE').set, "25") try: import pytz self.assertEqual(None, config._get_option('TIMEZONE').set("UTC")) self.assertEqual(None, config._get_option('TIMEZONE').set("America/New_York")) self.assertEqual(None, config._get_option('TIMEZONE').set("EST")) self.assertRaises(configuration.OptionValueError, config._get_option('TIMEZONE').set, "Zool/Zot") except ImportError: # UTC is a known offset of 0 coded into roundup.date # so it works even without pytz. self.assertEqual(None, config._get_option('TIMEZONE').set("UTC")) # same with EST known timeone offset of 5 self.assertEqual(None, config._get_option('TIMEZONE').set("EST")) self.assertRaises(configuration.OptionValueError, config._get_option('TIMEZONE').set, "America/New_York") def testWebSecretKey(self): config = configuration.CoreConfig() self.assertEqual(None, config._get_option('WEB_SECRET_KEY').set("skskskd")) self.assertRaises(configuration.OptionValueError, config._get_option('WEB_SECRET_KEY').set, "") def testStaticFiles(self): config = configuration.CoreConfig() if ("/tmp/bar" == normpath("/tmp/bar/")): result_list = ["./foo", "/tmp/bar"] else: result_list = [".\\foo", "\\tmp\\bar"] self.assertEqual(None, config._get_option('STATIC_FILES').set("foo /tmp/bar")) print(config.STATIC_FILES) self.assertEqual(config.STATIC_FILES, result_list) def testIsolationLevel(self): config = configuration.CoreConfig() self.assertEqual(None, config._get_option('RDBMS_ISOLATION_LEVEL').set("read uncommitted")) self.assertEqual(None, config._get_option('RDBMS_ISOLATION_LEVEL').set("read committed")) self.assertEqual(None, config._get_option('RDBMS_ISOLATION_LEVEL').set("repeatable read")) self.assertRaises(configuration.OptionValueError, config._get_option('RDBMS_ISOLATION_LEVEL').set, "not a level") def testConfigSave(self): config = configuration.CoreConfig() # make scratch directory to create files in self.startdir = os.getcwd() self.dirname = os.getcwd() + '/_test_config' os.mkdir(self.dirname) try: os.chdir(self.dirname) self.assertFalse(os.access("config.ini", os.F_OK)) self.assertFalse(os.access("config.bak", os.F_OK)) config.save() config.save() # creates .bak file self.assertTrue(os.access("config.ini", os.F_OK)) self.assertTrue(os.access("config.bak", os.F_OK)) config.save() # trigger delete of old .bak file # FIXME: this should test to see if a new .bak # was created. For now verify .bak still exists self.assertTrue(os.access("config.bak", os.F_OK)) self.assertFalse(os.access("foo.bar", os.F_OK)) self.assertFalse(os.access("foo.bak", os.F_OK)) config.save("foo.bar") config.save("foo.bar") # creates .bak file self.assertTrue(os.access("foo.bar", os.F_OK)) self.assertTrue(os.access("foo.bak", os.F_OK)) finally: # cleanup scratch directory and files try: os.chdir(self.startdir) shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def testFloatAndInt_with_update_option(self): config = configuration.CoreConfig() # Update existing IntegerNumberGeqZeroOption to IntegerNumberOption config.update_option('WEB_LOGIN_ATTEMPTS_MIN', configuration.IntegerNumberOption, "0", description="new desc") # -1 is allowed now that it is an int. self.assertEqual(None, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set("-1")) # but can't float this self.assertRaises(configuration.OptionValueError, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set, "2.4") # but fred is still an issue self.assertRaises(configuration.OptionValueError, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set, "fred") # Update existing IntegerNumberOption to FloatNumberOption config.update_option('WEB_LOGIN_ATTEMPTS_MIN', configuration.FloatNumberOption, "0.0") self.assertEqual(config['WEB_LOGIN_ATTEMPTS_MIN'], -1) # can float this self.assertEqual(None, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set("3.1415926")) # but fred is still an issue self.assertRaises(configuration.OptionValueError, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set, "fred") self.assertAlmostEqual(config['WEB_LOGIN_ATTEMPTS_MIN'], 3.1415926, places=6) # test removal of .0 on floats that are integers self.assertEqual(None, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set("3.0")) self.assertEqual("3", config._get_option('WEB_LOGIN_ATTEMPTS_MIN')._value2str(3.00)) def testIntegerNumberGtZeroOption(self): config = configuration.CoreConfig() # Update existing IntegerNumberGeqZeroOption to IntegerNumberOption config.update_option('WEB_LOGIN_ATTEMPTS_MIN', configuration.IntegerNumberGtZeroOption, "1", description="new desc") self.assertEqual(None, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set("1")) # -1 is not allowed self.assertRaises(configuration.OptionValueError, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set, "-1") # but can't float this self.assertRaises(configuration.OptionValueError, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set, "2.4") # but can't float this self.assertRaises(configuration.OptionValueError, config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set, "0.5") def testOriginHeader(self): config = configuration.CoreConfig() with self.assertRaises(configuration.OptionValueError) as cm: config._get_option('WEB_ALLOWED_API_ORIGINS').set("https://foo.edu *") config._get_option('WEB_ALLOWED_API_ORIGINS').set("* https://foo.edu HTTP://baR.edu") self.assertEqual(config['WEB_ALLOWED_API_ORIGINS'][0], '*') self.assertEqual(config['WEB_ALLOWED_API_ORIGINS'][1], 'https://foo.edu') self.assertEqual(config['WEB_ALLOWED_API_ORIGINS'][2], 'HTTP://baR.edu') def testOptionAsString(self): config = configuration.CoreConfig() config._get_option('WEB_LOGIN_ATTEMPTS_MIN').set("2552") v = config._get_option('WEB_LOGIN_ATTEMPTS_MIN').__str__() print(v) self.assertIn("55", v) v = config._get_option('WEB_LOGIN_ATTEMPTS_MIN').__repr__() print(v) self.assertIn("55", v) def testBooleanOption(self): config = configuration.CoreConfig() with self.assertRaises(configuration.OptionValueError) as cm: config._get_option('INSTANT_REGISTRATION').set("3") # test multiple boolean representations for b in [ "yes", "1", "true", "TRUE", "tRue", "on", "oN", 1, True ]: self.assertEqual(None, config._get_option('INSTANT_REGISTRATION').set(b)) self.assertEqual(1, config._get_option('INSTANT_REGISTRATION').get()) for b in ["no", "0", "false", "FALSE", "fAlse", "off", "oFf", 0, False]: self.assertEqual(None, config._get_option('INSTANT_REGISTRATION').set(b)) self.assertEqual(0, config._get_option('INSTANT_REGISTRATION').get()) def testOctalNumberOption(self): config = configuration.CoreConfig() with self.assertRaises(configuration.OptionValueError) as cm: config._get_option('UMASK').set("xyzzy") print(type(config._get_option('UMASK'))) @pytest.mark.usefixtures("save_restore_logging") class TrackerConfig(unittest.TestCase): @pytest.fixture(autouse=True) def inject_fixtures(self, caplog): self._caplog = caplog @pytest.fixture(autouse=True) def save_restore_logging(self): """Save logger state and try to restore it after each test has finished. The primary test is testDictLoggerConfigViaJson which can change the loggers and break tests that depend on caplog """ # Save logger state for root and roundup top level logger loggernames = ("", "roundup") # The state attributes to save. Lists are shallow copied state_to_save = ("filters", "handlers", "level", "propagate") logger_state = {} for name in loggernames: logger_state[name] = {} roundup_logger = logging.getLogger(name) for i in state_to_save: attr = getattr(roundup_logger, i) if isinstance(attr, list): logger_state[name][i] = attr.copy() else: logger_state[name][i] = getattr(roundup_logger, i) # run all class tests here yield # rip down all the loggers leaving the root logger reporting # to stdout. # otherwise logger config is leaking to other tests roundup_loggers = [logging.getLogger(name) for name in logging.root.manager.loggerDict if name.startswith("roundup")] # cribbed from configuration.py:init_loggers hdlr = logging.StreamHandler(sys.stdout) formatter = logging.Formatter( '%(asctime)s %(trace_id)s %(levelname)s %(message)s') hdlr.setFormatter(formatter) for logger in roundup_loggers: # no logging API to remove all existing handlers!?! for h in logger.handlers: h.close() logger.removeHandler(h) logger.handlers = [hdlr] logger.setLevel("WARNING") logger.propagate = True # important as caplog requires this # Restore the info we stored before running tests for name in loggernames: local_logger = logging.getLogger(name) for attr in logger_state[name]: setattr(local_logger, attr, logger_state[name][attr]) # reset logging as well from importlib import reload logging.shutdown() reload(logging) def reset_logging(self): """https://til.tafkas.net/posts/-resetting-python-logging-before-running-tests/""" loggers = [logging.getLogger(name) for name in logging.root.manager.loggerDict] loggers.append(logging.getLogger()) for logger in loggers: handlers = logger.handlers[:] for handler in handlers: logger.removeHandler(handler) handler.close() logger.setLevel(logging.NOTSET) logger.propagate = True backend = 'anydbm' def setUp(self): self.dirname = '_test_instance' # set up and open a tracker self.instance = db_test_base.setupTracker(self.dirname, self.backend) # open the database self.db = self.instance.open('admin') self.db.commit() self.db.close() def tearDown(self): if self.db: self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def munge_configini(self, mods = None, section=None): """ modify config.ini to meet testing requirements mods is a list of tuples: [ ( "a = ", "b" ), ("c = ", None), ("d = ", "b", "z = ") ] Match line with first tuple element e.g. "a = ". Note specify trailing "=" and space to delimit keyword and properly format replacement line. If there are two elements in the tuple, and the first element matches, the line is replaced with the concatenation of the first and second elements. If second element is None ("" doesn't work), the line will be deleted. If there are three elements in the tuple, the line is replaced with the contcatentation of the third and second elements (used to replace commented out parameters). Note if the key/first element of tuple is not unique in config.ini, you must set the section to match the bracketed section name. """ if mods is None: return # if section is defined, the tests in the loop will turn # it off on [main] if section != '[main]'. in_section = True for line in fileinput.input(os.path.join(self.dirname, "config.ini"), inplace=True): if section: if line.startswith('['): in_section = False if line.startswith(section): in_section = True if in_section: for rule in mods: if len(rule) == 3: match, value, repl = rule else: match, value = rule repl = None if line.startswith(match): if value is not None: if repl: print(repl + value) else: print(match + value) break else: print(line[:-1]) # remove trailing \n else: print(line[:-1]) # remove trailing \n def testNoDBInConfig(self): """Arguably this should be tested in test_instance since it is triggered by instance.open. But it raises an error in the configuration module with a missing required param in config.ini. """ # remove the backend key in config.ini self.munge_configini(mods=[ ("backend = ", None) ]) # this should fail as backend isn't defined. with self.assertRaises(configuration.OptionUnsetError) as cm: instance.open(self.dirname) self.assertEqual("RDBMS_BACKEND is not set" " and has no default", cm.exception.__str__()) def testUnsetMailPassword_with_set_username(self): """ Set [mail] username but don't set the [mail] password. Should get an OptionValueError. """ # SETUP: set mail username self.munge_configini(mods=[ ("username = ", "foo"), ], section="[mail]") config = configuration.CoreConfig() with self.assertRaises(configuration.OptionValueError) as cm: config.load(self.dirname) print(cm.exception) # test repr. The type is right since it passed assertRaises. self.assertIn("OptionValueError", repr(cm.exception)) # look for 'not defined' self.assertEqual("not defined", cm.exception.args[1]) def testUnsetMailPassword_with_unset_username(self): """ Set [mail] username but don't set the [mail] password. Should get an OptionValueError. """ config = configuration.CoreConfig() config.load(self.dirname) self.assertEqual(config['MAIL_USERNAME'], '') with self.assertRaises(configuration.OptionUnsetError) as cm: self.assertEqual(config['MAIL_PASSWORD'], 'NO DEFAULT') def testSecretMandatory_missing_file(self): # SETUP: self.munge_configini(mods=[ ("secret_key = ", "file://secret_key"), ]) config = configuration.CoreConfig() with self.assertRaises(configuration.OptionValueError) as cm: config.load(self.dirname) print(cm.exception) self.assertEqual(cm.exception.args[0].setting, "secret_key") def testSecretMandatory_load_from_file(self): # SETUP: self.munge_configini(mods=[ ("secret_key = ", "file://secret_key"), ]) secret = "ASDQWEZXCRFVBGTYHNMJU" with open(self.dirname + "/secret_key", "w") as f: f.write(secret + "\n") config = configuration.CoreConfig() config.load(self.dirname) self.assertEqual(config['WEB_SECRET_KEY'], secret) def testSecretMandatory_load_from_abs_file(self): abs_file = "/tmp/secret_key.%s"%os.getpid() # SETUP: self.munge_configini(mods=[ ("secret_key = ", "file://%s"%abs_file), ]) secret = "ASDQWEZXCRFVBGTYHNMJU" with open(abs_file, "w") as f: f.write(secret + "\n") config = configuration.CoreConfig() config.load(self.dirname) self.assertEqual(config['WEB_SECRET_KEY'], secret) os.remove(abs_file) def testSecretMandatory_empty_file(self): self.munge_configini(mods=[ ("secret_key = ", "file:// secret_key"), ]) # file with no value just newline. with open(self.dirname + "/secret_key", "w") as f: f.write("\n") config = configuration.CoreConfig() with self.assertRaises(configuration.OptionValueError) as cm: config.load(self.dirname) print(cm.exception.args) self.assertEqual(cm.exception.args[2],"Value must not be empty.") def testNullableSecret_empty_file(self): self.munge_configini(mods=[ ("password = ", "file://db_password"), ]) # file with no value just newline. with open(self.dirname + "/db_password", "w") as f: f.write("\n") config = configuration.CoreConfig() config.load(self.dirname) v = config['RDBMS_PASSWORD'] self.assertEqual(v, None) def testNullableSecret_with_file_value(self): self.munge_configini(mods=[ ("password = ", "file://db_password"), ]) # file with no value just newline. with open(self.dirname + "/db_password", "w") as f: f.write("test\n") config = configuration.CoreConfig() config.load(self.dirname) v = config['RDBMS_PASSWORD'] self.assertEqual(v, "test") def testNullableSecret_with_value(self): self.munge_configini(mods=[ ("password = ", "test"), ]) config = configuration.CoreConfig() config.load(self.dirname) v = config['RDBMS_PASSWORD'] self.assertEqual(v, "test") def testListSecret_for_jwt_invalid_secret(self): """A jwt_secret is made of ',' separated strings. If the first string is < 32 characters (like the default value of disabled) then jwt is disabled and no harm done. If any other secrets are <32 characters we raise a red flag on startup to prevent them from being used. """ self.munge_configini(mods=[ ("jwt_secret = ", "disable, test"), ]) config = configuration.CoreConfig() with self.assertRaises(configuration.OptionValueError) as cm: config.load(self.dirname) print(cm.exception.args) self.assertEqual( cm.exception.args[2], "One or more secrets less then 32 characters in length\nfound: test") def testSetMailPassword_with_set_username(self): """ Set [mail] username and set the password. Should have both values set. """ # SETUP: set mail username self.munge_configini(mods=[ ("username = ", "foo"), ("#password = ", "passwordfoo", "password = ") ], section="[mail]") config = configuration.CoreConfig() config.load(self.dirname) self.assertEqual(config['MAIL_USERNAME'], 'foo') self.assertEqual(config['MAIL_PASSWORD'], 'passwordfoo') def testSetMailPassword_from_file(self): """ Set [mail] username and set the password. Should have both values set. """ # SETUP: set mail username self.munge_configini(mods=[ ("username = ", "foo"), ("#password = ", "file://password", "password = ") ], section="[mail]") with open(self.dirname + "/password", "w") as f: f.write("passwordfoo\n") config = configuration.CoreConfig() config.load(self.dirname) self.assertEqual(config['MAIL_USERNAME'], 'foo') self.assertEqual(config['MAIL_PASSWORD'], 'passwordfoo') @skip_xapian def testInvalidIndexerLanguage_w_empty(self): """ make sure we have a reasonable error message if invalid indexer language is specified. This uses default search path for indexers. """ # SETUP: set indexer_language value to an invalid value. self.munge_configini(mods=[ ("indexer = ", ""), ("indexer_language = ", "NO_LANG") ]) config = configuration.CoreConfig() with self.assertRaises(configuration.OptionValueError) as cm: config.load(self.dirname) print(cm.exception) # test repr. The type is right since it passed assertRaises. self.assertIn("OptionValueError", repr(cm.exception)) # look for failing language self.assertIn("NO_LANG", cm.exception.args[1]) # look for supported language self.assertIn("english", cm.exception.args[2]) @include_no_xapian def testInvalidIndexerLanguage_w_empty_no_xapian(self): """ Test case for empty indexer if xapian really isn't installed This should behave like testInvalidIndexerLanguage_xapian_missing but without all the sys.modules mangling. """ print("Testing when xapian is not installed") # SETUP: set indexer_language value to an invalid value. self.munge_configini(mods=[ ("indexer = ", ""), ("indexer_language = ", "NO_LANG") ]) config = configuration.CoreConfig() config.load(self.dirname) self.assertEqual(config['INDEXER_LANGUAGE'], 'NO_LANG') def testInvalidIndexerLanguage_xapian_missing(self): """Using default path for indexers, make import of xapian fail and prevent exception from happening even though the indexer_language would be invalid for xapian. """ print("Testing xapian not loadable") # SETUP: same as testInvalidIndexerLanguage_w_empty self.munge_configini(mods=[ ("indexer = ", ""), ("indexer_language = ", "NO_LANG") ]) import sys # Set module to Non to prevent xapian from loading sys.modules['xapian'] = None config.load(self.dirname) # need to delete both to make python2 not error finding _xapian del(sys.modules['xapian']) if 'xapian._xapian' in sys.modules: del(sys.modules['xapian._xapian']) self.assertEqual(config['INDEXER_LANGUAGE'], 'NO_LANG') # do a reset here to test reset rather than wasting cycles # to do setup in a different test config.reset() self.assertEqual(config['INDEXER_LANGUAGE'], 'english') def testInvalidIndexerLanguage_w_native(self): """indexer_language is invalid but indexer is not "" or xapian Config load should succeed without exception. """ print("Testing indexer = native") self.munge_configini(mods = [ ("indexer = ", "native"), ("indexer_language = ", "NO_LANG") ]) config.load(self.dirname) self.assertEqual(config['HTML_VERSION'], 'html4') self.assertEqual(config['INDEXER_LANGUAGE'], 'NO_LANG') @skip_xapian def testInvalidIndexerLanguage_w_xapian(self): """ Use explicit xapian indexer. Verify exception is generated. """ print("Testing explicit xapian") self.munge_configini(mods=[ ("indexer = ", "xapian"), ("indexer_language = ", "NO_LANG") ]) with self.assertRaises(configuration.OptionValueError) as cm: config.load(self.dirname) # don't test exception content. Done in # testInvalidIndexerLanguage_w_empty # if exception not generated assertRaises # will generate failure. def testInvalidIndexerLanguage_w_native_fts(self): """ Use explicit native-fts indexer. Verify exception is generated. """ self.munge_configini(mods=[ ("indexer = ", "native-fts"), ("indexer_language = ", "NO_LANG") ]) with self.assertRaises(configuration.OptionValueError) as cm: config.load(self.dirname) # test repr. The type is right since it passed assertRaises. self.assertIn("OptionValueError", repr(cm.exception)) # look for failing language self.assertIn("NO_LANG", cm.exception.args[1]) # look for supported language self.assertIn("basque", cm.exception.args[2]) @skip_redis def testLoadSessionDbRedisCompatible(self): """ run load to validate config """ config = configuration.CoreConfig() # compatible pair config.RDBMS_BACKEND = "sqlite" config.SESSIONDB_BACKEND = "redis" config.validator(config.options) # compatible pair config.RDBMS_BACKEND = "anydbm" config.SESSIONDB_BACKEND = "redis" config.validator(config.options) @skip_redis @skip_postgresql def testLoadSessionDbRedisIncompatible(self): """ run load to validate config """ # incompatible pair config.RDBMS_BACKEND = "postgresql" config.SESSIONDB_BACKEND = "redis" with self.assertRaises(configuration.OptionValueError) as cm: config.validator(config.options) self.assertIn(" db type: redis with postgresql", cm.exception.__str__()) def testLoadSessionDb(self): """ run load to validate config """ config = configuration.CoreConfig() # incompatible pair config.RDBMS_BACKEND = "sqlite" config.SESSIONDB_BACKEND = "foo" with self.assertRaises(configuration.OptionValueError) as cm: config.validator(config.options) self.assertIn(" db type: foo with sqlite", cm.exception.__str__()) # compatible pair config.RDBMS_BACKEND = "sqlite" config.SESSIONDB_BACKEND = "" config.validator(config.options) # any exception will fail test config.RDBMS_BACKEND = "sqlite" config.SESSIONDB_BACKEND = "anydbm" config.validator(config.options) # any exception will fail test config.RDBMS_BACKEND = "anydbm" config.SESSIONDB_BACKEND = "redis" # make it looks like redis is not available try: del(sys.modules['redis']) except KeyError: # redis is not available anyway. pass sys.modules['redis'] = None with self.assertRaises(configuration.OptionValueError) as cm: config.validator(config.options) del(sys.modules['redis']) self.assertIn("Unable to load redis module", cm.exception.__str__()) def testLoadConfig(self): """ run load to validate config """ config = configuration.CoreConfig() config.load(self.dirname) # test various ways of accessing config data with self.assertRaises(configuration.InvalidOptionError) as cm: # using lower case name fails c = config['indexer_language'] print(cm.exception) self.assertIn("indexer_language", repr(cm.exception)) # uppercase name passes as does tuple index for setting in main self.assertEqual(config['HTML_VERSION'], 'html4') self.assertEqual(config[('main', 'html_version')], 'html4') # uppercase name passes as does tuple index for setting in web self.assertEqual(config['WEB_COOKIE_TAKES_PRECEDENCE'], 0) self.assertEqual(config[('web','cookie_takes_precedence')], 0) def testLoadConfigNoConfig(self): """ run load on a directory missing config.ini """ c = os.path.join(self.dirname, configuration.Config.INI_FILE) if os.path.exists(c): os.remove(c) else: self.assertFalse("setup failed missing config.ini") config = configuration.CoreConfig() with self.assertRaises(configuration.NoConfigError) as cm: config.load(self.dirname) print(cm.exception) self.assertEqual(cm.exception.args[0], self.dirname) def testFormattedLogging(self): """Depends on using default logging format with %(trace_id)""" def find_file_occurances(string): return len(re.findall(r'\bFile\b', string)) config = configuration.CoreConfig(settings={"LOGGING_LEVEL": "DEBUG"}) # format the record and verify the logformat/trace_id. config._logging_test(None, msg="message") tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertEqual("message", tuple[2]) logger = logging.getLogger('roundup') hdlr = logger.handlers[0] log = hdlr.format(self._caplog.records[0]) # verify that %(trace_id) was set and substituted # Note: trace_id is not initialized in this test case log_parts = log.split() # testing len(shorten_int_uuid(uuid.uuid4().int)) # for 20000 tests gives range [19,22] self.assertRegex(log_parts[2], r'^[A-Za-z0-9]{19,22}') self._caplog.clear() # the rest check various values of sinfo and msg formating. # sinfo = 1 - one line of stack starting with log call config._logging_test(1) tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertIn("test a_var\n File", tuple[2]) self.assertIn("in _logging_test", tuple[2]) self.assertIn("logger.info(msg, extra=", tuple[2]) self.assertEqual(find_file_occurances(tuple[2]), 1) self._caplog.clear() # sinfo = None - 5 lines of stack starting with log call config._logging_test(None) tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertIn("test a_var\n File", tuple[2]) self.assertIn("in _logging_test", tuple[2]) self.assertIn("logger.info(msg, extra=", tuple[2]) self.assertEqual(find_file_occurances(tuple[2]), 5) self._caplog.clear() # sinfo = 0 - whole stack starting with log call config._logging_test(0) tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertIn("test a_var\n File", tuple[2]) self.assertIn("in _logging_test", tuple[2]) self.assertIn("logger.info(msg, extra=", tuple[2]) # A file in 'pytest' directory should be at the top of stack. self.assertIn("pytest", tuple[2]) # no idea how deep the actual stack is, could change with python # versions, but 3.12 is 33 so .... self.assertTrue(find_file_occurances(tuple[2]) > 10) self._caplog.clear() # sinfo = -1 - one line of stack starting with extract_stack() config._logging_test(-1) tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertIn("test a_var\n File", tuple[2]) # The call to extract_stack should be included as the frame # at bottom of stack. self.assertIn("extract_stack()", tuple[2]) # only one frame included self.assertEqual(find_file_occurances(tuple[2]), 1) self._caplog.clear() # sinfo = 1000 - whole stack starting with log call 1000>stack size config._logging_test(1000) tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertIn("test a_var\n File", tuple[2]) self.assertIn("in _logging_test", tuple[2]) self.assertIn("logger.info(msg, extra=", tuple[2]) # A file in 'pytest' directory should be at the top of stack. self.assertIn("pytest", tuple[2]) # no idea how deep the actual stack is, could change with python # versions, but 3.12 is 33 so .... self.assertTrue(find_file_occurances(tuple[2]) > 10) self._caplog.clear() # sinfo = -1000 - whole stack starting with extract_stack config._logging_test(-1000) tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertIn("test a_var\n File", tuple[2]) self.assertIn("in _logging_test", tuple[2]) self.assertIn("logger.info(msg, extra=", tuple[2]) # The call to extract_stack should be included as the frame # at bottom of stack. self.assertIn("extract_stack()", tuple[2]) # A file in 'pytest' directory should be at the top of stack. # no idea how deep the actual stack is, could change with python # versions, but 3.12 is 33 so .... self.assertTrue(find_file_occurances(tuple[2]) > 10) self.assertIn("pytest", tuple[2]) self._caplog.clear() # pass args and compatible message config._logging_test(None, args=(1,2,3), msg="one: %s, two: %s, three: %s" ) tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertEqual('one: 1, two: 2, three: 3', tuple[2]) self._caplog.clear() # error case for incorrect placeholder config._logging_test(None, msg="%(a)") tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertEqual("%(a)", tuple[2]) self._caplog.clear() # error case for incompatible format record is the first argument # and it can't be turned into floating point. config._logging_test(None, msg="%f") tuple = self._caplog.record_tuples[0] self.assertEqual(tuple[1], 20) self.assertEqual("%f", tuple[2]) self._caplog.clear() def testXhtmlRaisesOptionError(self): self.munge_configini(mods=[ ("html_version = ", "xhtml") ]) config = configuration.CoreConfig() # verify config is initalized to defaults self.assertEqual(config['HTML_VERSION'], 'html4') with self.assertRaises(configuration.OptionValueError) as cm: # load config config.load(self.dirname) print(cm.exception) self.assertEqual(str(cm.exception), "Invalid value for HTML_VERSION: 'xhtml'\n" "Allowed values: html4") def testCopyConfig(self): self.munge_configini(mods=[ ("static_files = ", "html2") ]) config = configuration.CoreConfig() # verify config is initalized to defaults self.assertEqual(config['STATIC_FILES'], None) # load config STATIC_FILES = os.path.join(self.dirname, "html2") config.load(self.dirname) self.assertEqual(config['STATIC_FILES'], [ STATIC_FILES ]) # copy config config_copy = config.copy() # this should work self.assertEqual(config_copy['STATIC_FILES'], [STATIC_FILES]) @skip_py2 def testConfigValueInterpolateError(self): ''' error is not raised using ConfigParser under Python 2. Unknown cause, so skip it if running python 2. ''' self.munge_configini(mods=[ ("admin_email = ", "a bare % is invalid") ]) config = configuration.CoreConfig() # load config generates: ''' E roundup.configuration.ParsingOptionError: Error in _test_instance/config.ini with section [main] at option admin_email: '%' must be followed by '%' or '(', found: '% is invalid' ''' with self.assertRaises(configuration.ParsingOptionError) as cm: config.load(self.dirname) print(cm.exception) self.assertIn("'%' must be followed by '%' or '(', found: '% is invalid'", cm.exception.args[0]) self.assertIn(normpath("_test_instance/config.ini") + " with section [main] at option admin_email", cm.exception.args[0]) from roundup.admin import AdminTool from .test_admin import captured_output admin=AdminTool() with captured_output() as (out, err): sys.argv=['main', '-i', self.dirname, 'get', 'tile', 'issue1'] ret = admin.main() expected_err = ("Error in " + normpath("_test_instance/config.ini") + " with section [main] at option admin_email: '%' " "must be followed by '%' or '(', found: " "'% is invalid'") self.assertEqual(ret, 1) out = out.getvalue().strip() self.assertEqual(out, expected_err) def testInvalidIndexerValue(self): """ Mistype native indexer. Verify exception is generated. """ print("Testing indexer nati") self.munge_configini(mods=[ ("indexer = ", "nati") ]) with self.assertRaises(configuration.OptionValueError) as cm: config.load(self.dirname) self.assertIn("OptionValueError", repr(cm.exception)) # look for failing value self.assertEqual("nati", cm.exception.args[1]) # look for supported values self.assertIn("'whoosh'", cm.exception.args[2]) # verify that args show up in string representaton string_rep = cm.exception.__str__() print(string_rep) self.assertIn("nati", string_rep) self.assertIn("'whoosh'", string_rep) def testLoggerFormat(self): config = configuration.CoreConfig() # verify config is initalized to defaults self.assertEqual(config['LOGGING_FORMAT'], '%(asctime)s %(trace_id)s %(levelname)s %(message)s') # load config config.load(self.dirname) self.assertEqual(config['LOGGING_FORMAT'], '%(asctime)s %(trace_id)s %(levelname)s %(message)s') # break config using an incomplete format specifier (no trailing 's') self.munge_configini(mods=[ ("format = ", "%%(asctime)s %%(trace_id)s %%(levelname) %%(message)s") ], section="[logging]") # load config with self.assertRaises(configuration.OptionValueError) as cm: config.load(self.dirname) self.assertIn('Unrecognized use of %(...) in: %(levelname)', cm.exception.args[2]) # break config by not doubling % sign to quote it from configparser self.munge_configini(mods=[ ("format = ", "%(asctime)s %%(trace_id)s %%(levelname) %%(message)s") ], section="[logging]") with self.assertRaises( configuration.ParsingOptionError) as cm: config.load(self.dirname) ini_path = os.path.join(self.dirname, "config.ini") self.assertEqual(cm.exception.args[0],( f"Error in {ini_path} with section " "[logging] at option format: Bad value substitution: " "option 'format' in section 'logging' contains an " "interpolation key 'asctime' which is not a valid " "option name. Raw value: '%(asctime)s %%(trace_id)s " "%%(levelname) %%(message)s'")) def testDictLoggerConfigViaJson(self): # good base test case config1 = dedent(""" { "version": 1, // only supported version "disable_existing_loggers": false, // keep the wsgi loggers "formatters": { // standard Roundup formatter including context id. "standard": { "format": "%(asctime)s %(levelname)s %(name)s:%(module)s %(msg)s" }, // used for waitress wsgi server to produce httpd style logs "http": { "format": "%(message)s" } }, "handlers": { // create an access.log style http log file "access": { "level": "INFO", "formatter": "http", "class": "logging.FileHandler", "filename": "_test_instance/access.log" }, // logging for roundup.* loggers "roundup": { "level": "DEBUG", "formatter": "standard", "class": "logging.FileHandler", "filename": "_test_instance/roundup.log" }, // print to stdout - fall through for other logging "default": { "level": "DEBUG", "formatter": "standard", "class": "logging.StreamHandler", "stream": "ext://sys.stdout" } }, "loggers": { "": { "handlers": [ "default" // used by wsgi/usgi ], "level": "DEBUG", "propagate": false }, // used by roundup.* loggers "roundup": { "handlers": [ "roundup" ], "level": "DEBUG", "propagate": false // note pytest testing with caplog requires // this to be true }, "roundup.hyperdb": { "handlers": [ "roundup" ], "level": "INFO", // can be a little noisy INFO for production "propagate": false }, "roundup.wsgi": { // using the waitress framework "handlers": [ "roundup" ], "level": "DEBUG", "propagate": false }, "roundup.wsgi.translogger": { // httpd style logging "handlers": [ "access" ], "level": "DEBUG", "propagate": false }, "root": { "handlers": [ "default" ], "level": "DEBUG", "propagate": false } } } """) log_config_filename = os.path.join(self.instance.tracker_home, "_test_log_config.json") # happy path with open(log_config_filename, "w") as log_config_file: log_config_file.write(config1) config = self.db.config.load_config_dict_from_json_file( log_config_filename) self.assertIn("version", config) self.assertEqual(config['version'], 1) # broken inline comment misformatted test_config = config1.replace(": 1, //", ": 1, //") with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.load_config_dict_from_json_file( log_config_filename) self.assertEqual( cm.exception.args[0], ('Error parsing json logging dict ' '(%s) near \n\n ' '"version": 1, // only supported version\n\nExpecting ' 'property name enclosed in double quotes: line 3 column 18.\n' 'Maybe bad inline comment, 3 spaces needed before //.' % log_config_filename) ) # broken trailing , on last dict element test_config = config1.replace(' "ext://sys.stdout"', ' "ext://sys.stdout",' ) with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.load_config_dict_from_json_file( log_config_filename) #pre 3.12?? # FIXME check/remove when 3.13. is min supported version if "property name" in cm.exception.args[0]: self.assertEqual( cm.exception.args[0], ('Error parsing json logging dict ' '(%s) near \n\n' ' }\n\n' 'Expecting property name enclosed in double ' 'quotes: line 37 column 6.' % log_config_filename) ) # 3.13+ diags FIXME print('FINDME') print(cm.exception.args[0]) _junk = ''' if "property name" not in cm.exception.args[0]: self.assertEqual( cm.exception.args[0], ('Error parsing json logging dict ' '(%s) near \n\n' ' "stream": "ext://sys.stdout"\n\n' 'Expecting property name enclosed in double ' 'quotes: line 37 column 6.' % log_config_filename) ) ''' # happy path for init_logging() # verify preconditions logger = logging.getLogger("roundup") self.assertEqual(logger.level, 40) # error default from config.ini self.assertEqual(logger.filters, []) with open(log_config_filename, "w") as log_config_file: log_config_file.write(config1) # file is made relative to tracker dir. self.db.config["LOGGING_CONFIG"] = '_test_log_config.json' config = self.db.config.init_logging() self.assertIs(config, None) logger = logging.getLogger("roundup") self.assertEqual(logger.level, 10) # debug self.assertEqual(logger.filters, []) # broken invalid format type (int not str) test_config = config1.replace('"format": "%(message)s"', '"format": 1234',) with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) # file is made relative to tracker dir. self.db.config["LOGGING_CONFIG"] = '_test_log_config.json' # different versions of python have different errors # (or no error for this case in 3.7) # FIXME remove version check post 3.7 as minimum version if sys.version_info >= (3, 8, 0): with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.init_logging() # mangle args[0] to add got 'int' # FIXME: remove mangle after 3.12 min version self.assertEqual( cm.exception.args[0].replace( "object\n", "object, got 'int'\n"), ('Error loading logging dict from ' '%s.\n' "ValueError: Unable to configure formatter 'http'\n" "expected string or bytes-like object, got 'int'\n" % log_config_filename) ) # broken invalid level MANGO test_config = config1.replace( ': "INFO", // can', ': "MANGO", // can') with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) # file is made relative to tracker dir. self.db.config["LOGGING_CONFIG"] = '_test_log_config.json' with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.init_logging() self.assertEqual( cm.exception.args[0], ("Error loading logging dict from " "%s.\nValueError: " "Unable to configure logger 'roundup.hyperdb'\nUnknown level: " "'MANGO'\n" % log_config_filename) ) # broken invalid output directory test_config = config1.replace( ' "_test_instance/access.log"', ' "not_a_test_instance/access.log"') access_filename = os.path.join("not_a_test_instance", "access.log") with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) # file is made relative to tracker dir. self.db.config["LOGGING_CONFIG"] = '_test_log_config.json' with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.init_logging() # error includes full path which is different on different # CI and dev platforms. So munge the path using re.sub and # replace. Windows needs replace as the full path for windows # to the file has '\\\\' not '\\' when taken from __context__. # E.G. # ("Error loading logging dict from ' # '_test_instance\\_test_log_config.json.\nValueError: ' # "Unable to configure handler 'access'\n[Errno 2] No such file " # "or directory: " # "'C:\\\\tracker\\\\path\\\\not_a_test_instance\\\\access.log'\n") # sigh..... output = re.sub("directory: \'.*not_a", 'directory: not_a' , cm.exception.args[0].replace(r'\\','\\')) target = ("Error loading logging dict from " "%s.\n" "ValueError: Unable to configure handler 'access'\n" "[Errno 2] No such file or directory: " "%s'\n" % (log_config_filename, access_filename)) self.assertEqual(output, target) # mess up '}' so json file block isn't properly closed. test_config = config1.replace( ' }', ' ') with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) # file is made relative to tracker dir. self.db.config["LOGGING_CONFIG"] = '_test_log_config.json' with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.init_logging() output = cm.exception.args[0].replace(r'\\','\\') target = ("Error parsing json logging dict " "(%s) near \n\n" " Error found at end of file. Maybe missing a " "block closing '}'.\n\n" "Expecting ',' delimiter: line 86 column 1." % (log_config_filename,)) self.assertEqual(output, target) def testIniFileLoggerConfig(self): # good base test case config1 = dedent(""" [loggers] keys=root,roundup,roundup.http,roundup.hyperdb,actions,schema,extension,detector [logger_root] #DEBUG, INFO, WARNING, ERROR, CRITICAL #also for root only NOTSET (all) level=DEBUG handlers=basic [logger_roundup] #DEBUG, INFO, WARNING, ERROR, CRITICAL #also for root only NOTSET (all) level=DEBUG handlers=rotate qualname=roundup propagate=0 [logger_roundup.http] level=INFO handlers=rotate_weblog qualname=roundup.http propagate=0 [logger_roundup.hyperdb] level=WARNING handlers=rotate qualname=roundup.hyperdb propagate=0 [logger_actions] #DEBUG, INFO, WARNING, ERROR, CRITICAL #also for root only NOTSET (all) level=DEBUG handlers=rotate qualname=actions propagate=0 [logger_detector] #DEBUG, INFO, WARNING, ERROR, CRITICAL #also for root only NOTSET (all) level=DEBUG handlers=rotate qualname=detector propagate=0 [logger_schema] level=DEBUG handlers=rotate qualname=schema propagate=0 [logger_extension] level=DEBUG handlers=rotate qualname=extension propagate=0 [handlers] keys=basic,rotate,rotate_weblog [handler_basic] class=StreamHandler args=(sys.stderr,) formatter=basic [handler_rotate] class=logging.handlers.RotatingFileHandler args=('roundup.log','a', 512000, 2) formatter=basic [handler_rotate_weblog] class=logging.handlers.RotatingFileHandler args=('httpd.log','a', 512000, 2) formatter=plain [formatters] keys=basic,plain [formatter_basic] format=%(asctime)s %(name)s:%(module)s.%(funcName)s,%(levelname)s: %(message)s datefmt=%Y-%m-%d %H:%M:%S [formatter_plain] format=%(message)s """) log_config_filename = os.path.join(self.instance.tracker_home, "_test_log_config.ini") # happy path with open(log_config_filename, "w") as log_config_file: log_config_file.write(config1) self.db.config.LOGGING_CONFIG = "_test_log_config.ini" # verify we have a clean environment self.assertEqual(len(logging.getLogger('roundup.http').handlers), 0) # always returns None self.db.config.init_logging() # verify that logging loaded and handler is set # default log config doesn't define handlers for roundup.http self.assertEqual(len(logging.getLogger('roundup.http').handlers), 1) self.reset_logging() # use undefined enumeration test_config = config1.replace("=DEBUG\n", "=DEBUF\n") with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.init_logging() # verify that logging was reset # default log config doesn't define handlers for roundup.http self.assertEqual(len(logging.getLogger('roundup.http').handlers), 0) self.assertEqual( cm.exception.args[0].replace(r'\\','\\'), ('Error loading logging config from %s.\n\n' " Unknown level: 'DEBUF'\n\n" 'Inappropriate argument value (of correct type).\n' % log_config_filename) ) self.reset_logging() # add a syntax error "= foo" test_config = config1.replace("=DEBUG\n", "=DEBUG\n=foo\n", 1) with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.init_logging() # verify that logging was reset # default log config doesn't define handlers for roundup.http self.assertEqual(len(logging.getLogger('roundup.http').handlers), 0) self.assertEqual( cm.exception.args[0].replace(r'\\','\\'), ("Error loading logging config from %(filename)s.\n\n" " %(filename)s is invalid: Source contains parsing errors: " "'%(filename)s'\n\t[line 9]: '=foo\\n'\n\n" "Source contains parsing errors: '%(filename)s'\n" "\t[line 9]: '=foo\\n' Unspecified run-time error.\n" % {"filename": log_config_filename}) ) self.reset_logging() # handler = basic to handler = basi test_config = config1.replace("handlers=basic\n", "handlers=basi\n", 1) with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.init_logging() # verify that logging was reset # default log config doesn't define handlers for roundup.http self.assertEqual(len(logging.getLogger('roundup.http').handlers), 0) self.assertEqual( cm.exception.args[0].replace(r'\\','\\'), ("Error loading logging config from %(filename)s.\n\n" " basi\n\n" "Mapping key not found. No section found with this name.\n" % {"filename": log_config_filename}) ) self.reset_logging() # Change class to missing class test_config = config1.replace("class=StreamHandler\n", "class=SHAndler\n", 1) with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) with self.assertRaises(configuration.LoggingConfigError) as cm: config = self.db.config.init_logging() # verify that logging was reset # default log config doesn't define handlers for roundup.http self.assertEqual(len(logging.getLogger('roundup.http').handlers), 0) self.assertEqual( cm.exception.args[0].replace(r'\\','\\'), ("Error loading logging config from %(filename)s.\n\n" " No module named 'SHAndler'\n\n" "name 'SHAndler' is not defined Module not found.\n" % {"filename": log_config_filename}) ) self.reset_logging() # remove section to cause duplicate option definition test_config = config1.replace("[logger_roundup.http]\n", "\n", 1) with open(log_config_filename, "w") as log_config_file: log_config_file.write(test_config) with self.assertRaises(configparser.DuplicateOptionError) as cm: config = self.db.config.init_logging() # verify that logging was reset # default log config doesn't define handlers for roundup.http self.assertEqual(len(logging.getLogger('roundup.http').handlers), 0) self.assertEqual( str(cm.exception).replace(r'\\','\\'), ("While reading from '%(filename)s' [line 20]: " "option 'level' in section 'logger_roundup' already exists" % {"filename": log_config_filename}) ) self.reset_logging() def test_missing_logging_config_file(self): saved_config = self.db.config['LOGGING_CONFIG'] for logging_file in ["logging.json", "logging.ini", "logging.foobar"]: self.db.config['LOGGING_CONFIG'] = logging_file with self.assertRaises(configuration.OptionValueError) as cm: self.db.config.init_logging() logging_configfile = os.path.join(self.dirname, logging_file) self.assertEqual(cm.exception.args[1], logging_configfile) self.assertEqual(cm.exception.args[2], "Unable to find logging config file.") self.db.config['LOGGING_CONFIG'] = saved_config def test_unknown_logging_config_file_type(self): saved_config = self.db.config['LOGGING_CONFIG'] self.db.config['LOGGING_CONFIG'] = 'schema.py' with self.assertRaises(configuration.OptionValueError) as cm: self.db.config.init_logging() logging_configfile = os.path.join(self.dirname, "schema.py") self.assertEqual(cm.exception.args[1], logging_configfile) self.assertEqual(cm.exception.args[2], "Unable to load logging config file. " "File extension must be '.ini' or '.json'.\n") self.db.config['LOGGING_CONFIG'] = saved_config code-e5bd50120b5a/test/test_dates.py0000644000000000000000000005511415064275501015416 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. # import unittest import time import datetime import calendar import pytest from roundup import date, i18n from roundup.date import Date, Interval, Range, fixTimeOverflow, \ get_timezone try: import pytz skip_pytz = lambda func, *args, **kwargs: func except ImportError: # FIX: workaround for a bug in pytest.mark.skip(): # https://github.com/pytest-dev/pytest/issues/568 from .pytest_patcher import mark_class skip_pytz = mark_class(pytest.mark.skip(reason="'pytz' not installed")) class DateTestCase(unittest.TestCase): def setUp(self): # force use of local locale directory. System locale dir # doesn't have the locale files installed, and without wiping # the default the .mo file sometimes isn't found. self.backup_domain = i18n.DOMAIN i18n.DOMAIN = '' self.backup_locale_dirs = i18n.LOCALE_DIRS i18n.LOCALE_DIRS=["locale"] self.old_gettext_ = i18n.gettext self.old_ngettext_ = i18n.ngettext i18n.gettext = i18n.get_translation( language='C', tracker_home=".").gettext i18n.degettext = i18n.get_translation( language='de', tracker_home=".").gettext i18n.ngettext = i18n.get_translation( language='C', tracker_home=".").ngettext i18n.dengettext = i18n.get_translation( language='de', tracker_home=".").ngettext def tearDown(self): i18n.gettext = self.old_gettext_ i18n.ngettext = self.old_ngettext_ i18n.LOCALE_DIRS = self.backup_locale_dirs i18n.DOMAIN = self.backup_domain def testDateInterval(self): ae = self.assertEqual date = Date("2000-06-26.00:34:02 + 2d") ae(str(date), '2000-06-28.00:34:02') date = Date("2000-02-27 + 2d") ae(str(date), '2000-02-29.00:00:00') date = Date("2001-02-27 + 2d") ae(str(date), '2001-03-01.00:00:00') date = Date("2009", add_granularity=True) self.assertRaises(ValueError, Date, ". +30d", add_granularity=True) def testDate(self): ae = self.assertEqual date = Date("2000-04-17") ae(str(date), '2000-04-17.00:00:00') date = Date("2000/04/17") ae(str(date), '2000-04-17.00:00:00') date = Date("2000-4-7") ae(str(date), '2000-04-07.00:00:00') date = Date("2000-4-17") ae(str(date), '2000-04-17.00:00:00') date = Date("01-25") y, m, d, x, x, x, x, x, x = time.gmtime(time.time()) ae(str(date), '%s-01-25.00:00:00'%y) date = Date("2000-04-17.03:45") ae(str(date), '2000-04-17.03:45:00') date = Date("2000/04/17.03:45") ae(str(date), '2000-04-17.03:45:00') date = Date("08-13.22:13") ae(str(date), '%s-08-13.22:13:00'%y) date = Date("11-07.09:32:43") ae(str(date), '%s-11-07.09:32:43'%y) date = Date("14:25") ae(str(date), '%s-%02d-%02d.14:25:00'%(y, m, d)) date = Date("8:47:11") ae(str(date), '%s-%02d-%02d.08:47:11'%(y, m, d)) ae(str(Date('2003')), '2003-01-01.00:00:00') ae(str(Date('2004-06')), '2004-06-01.00:00:00') ae(str(Date('1900-02-01')), '1900-02-01.00:00:00') ae(str(Date('1800-07-15')), '1800-07-15.00:00:00') def testLeapYear(self): self.assertEqual(str(Date('2008-02-29')), '2008-02-29.00:00:00') def testDateError(self): self.assertRaises(ValueError, Date, "12") # Date cannot handle dates before year 1 self.assertRaises(ValueError, Date, (0, 1, 1, 0, 0, 0.0, 0, 1, -1)) self.assertRaises(ValueError, Date, "1/1/06") def testOffset(self): ae = self.assertEqual date = Date("2000-04-17", -5) ae(str(date), '2000-04-17.05:00:00') date = Date("01-25", -5) y, m, d, x, x, x, x, x, x = time.gmtime(time.time()) ae(str(date), '%s-01-25.05:00:00'%y) date = Date("2000-04-17.03:45", -5) ae(str(date), '2000-04-17.08:45:00') date = Date("08-13.22:13", -5) ae(str(date), '%s-08-14.03:13:00'%y) date = Date("11-07.09:32:43", -5) ae(str(date), '%s-11-07.14:32:43'%y) date = Date("14:25", -5) ae(str(date), '%s-%02d-%02d.19:25:00'%(y, m, d)) date = Date("8:47:11", -5) ae(str(date), '%s-%02d-%02d.13:47:11'%(y, m, d)) # just make sure we parse these, m'kay? date = Date('-1d') date = Date('-1w') date = Date('-1m') date = Date('-1y') def testOffsetRandom(self): ae = self.assertEqual # XXX unsure of the usefulness of these, they're pretty random date = Date('2000-01-01') + Interval('- 2y 2m') ae(str(date), '1997-11-01.00:00:00') date = Date('2000-01-01 - 2y 2m') ae(str(date), '1997-11-01.00:00:00') date = Date('2000-01-01') + Interval('2m') ae(str(date), '2000-03-01.00:00:00') date = Date('2000-01-01 + 2m') ae(str(date), '2000-03-01.00:00:00') date = Date('2000-01-01') + Interval('60d') ae(str(date), '2000-03-01.00:00:00') date = Date('2001-01-01') + Interval('60d') ae(str(date), '2001-03-02.00:00:00') def testOffsetAdd(self): ae = self.assertEqual date = Date('2000-02-28.23:59:59') + Interval('00:00:01') ae(str(date), '2000-02-29.00:00:00') date = Date('2001-02-28.23:59:59') + Interval('00:00:01') ae(str(date), '2001-03-01.00:00:00') date = Date('2000-02-28.23:58:59') + Interval('00:01:01') ae(str(date), '2000-02-29.00:00:00') date = Date('2001-02-28.23:58:59') + Interval('00:01:01') ae(str(date), '2001-03-01.00:00:00') date = Date('2000-02-28.22:58:59') + Interval('01:01:01') ae(str(date), '2000-02-29.00:00:00') date = Date('2001-02-28.22:58:59') + Interval('01:01:01') ae(str(date), '2001-03-01.00:00:00') date = Date('2000-02-28.22:58:59') + Interval('00:00:3661') ae(str(date), '2000-02-29.00:00:00') date = Date('2001-02-28.22:58:59') + Interval('00:00:3661') ae(str(date), '2001-03-01.00:00:00') date = Date('2001-03-01.00:00:00') + Interval('150y') ae(str(date), '2151-03-01.00:00:00') def testOffsetSub(self): ae = self.assertEqual date = Date('2000-12-01') - Interval('- 1d') date = Date('2000-01-01') - Interval('- 2y 2m') ae(str(date), '2002-03-01.00:00:00') date = Date('2000-01-01') - Interval('2m') ae(str(date), '1999-11-01.00:00:00') date = Date('2000-03-01') - Interval('60d') ae(str(date), '2000-01-01.00:00:00') date = Date('2001-03-02') - Interval('60d') ae(str(date), '2001-01-01.00:00:00') date = Date('2000-02-29.00:00:00') - Interval('00:00:01') ae(str(date), '2000-02-28.23:59:59') date = Date('2001-03-01.00:00:00') - Interval('00:00:01') ae(str(date), '2001-02-28.23:59:59') date = Date('2000-02-29.00:00:00') - Interval('00:01:01') ae(str(date), '2000-02-28.23:58:59') date = Date('2001-03-01.00:00:00') - Interval('00:01:01') ae(str(date), '2001-02-28.23:58:59') date = Date('2000-02-29.00:00:00') - Interval('01:01:01') ae(str(date), '2000-02-28.22:58:59') date = Date('2001-03-01.00:00:00') - Interval('01:01:01') ae(str(date), '2001-02-28.22:58:59') date = Date('2000-02-29.00:00:00') - Interval('00:00:3661') ae(str(date), '2000-02-28.22:58:59') date = Date('2001-03-01.00:00:00') - Interval('00:00:3661') ae(str(date), '2001-02-28.22:58:59') date = Date('2001-03-01.00:00:00') - Interval('150y') ae(str(date), '1851-03-01.00:00:00') def testDateLocal(self): ae = self.assertEqual date = Date("02:42:20") date = date.local(10) y, m, d, x, x, x, x, x, x = time.gmtime(time.time()) ae(str(date), '%s-%02d-%02d.12:42:20'%(y, m, d)) def testIntervalInit(self): ae = self.assertEqual ae(str(Interval('3y')), '+ 3y') ae(str(Interval('2 y 1 m')), '+ 2y 1m') ae(str(Interval('1m 25d')), '+ 1m 25d') ae(str(Interval('-2w 3 d ')), '- 17d') ae(str(Interval(' - 1 d 2:50 ')), '- 1d 2:50') ae(str(Interval(' 14:00 ')), '+ 14:00') ae(str(Interval(' 0:04:33 ')), '+ 0:04:33') ae(str(Interval(8.*3600)), '+ 8:00') def testIntervalInitDate(self): ae = self.assertEqual now = Date('.') now.hour = now.minute = now.second = 0 then = now + Interval('2d') ae((Interval(str(then))), Interval('- 2d')) then = now - Interval('2d') ae(Interval(str(then)), Interval('+ 2d')) def testIntervalAddMonthBoundary(self): # force the transition over a month boundary now = Date('2003-10-30.00:00:00') then = now + Interval('2d') self.assertEqual(str(then), '2003-11-01.00:00:00') now = Date('2004-02-28.00:00:00') then = now + Interval('1d') self.assertEqual(str(then), '2004-02-29.00:00:00') now = Date('2003-02-28.00:00:00') then = now + Interval('1d') self.assertEqual(str(then), '2003-03-01.00:00:00') now = Date('2003-01-01.00:00:00') then = now + Interval('59d') self.assertEqual(str(then), '2003-03-01.00:00:00') now = Date('2004-01-01.00:00:00') then = now + Interval('59d') self.assertEqual(str(then), '2004-02-29.00:00:00') def testIntervalSubtractMonthBoundary(self): # force the transition over a month boundary now = Date('2003-11-01.00:00:00') then = now - Interval('2d') self.assertEqual(str(then), '2003-10-30.00:00:00') now = Date('2004-02-29.00:00:00') then = now - Interval('1d') self.assertEqual(str(then), '2004-02-28.00:00:00') now = Date('2003-03-01.00:00:00') then = now - Interval('1d') self.assertEqual(str(then), '2003-02-28.00:00:00') now = Date('2003-03-01.00:00:00') then = now - Interval('59d') self.assertEqual(str(then), '2003-01-01.00:00:00') now = Date('2004-02-29.00:00:00') then = now - Interval('59d') self.assertEqual(str(then), '2004-01-01.00:00:00') def testIntervalAddYearBoundary(self): # force the transition over a year boundary now = Date('2003-12-30.00:00:00') then = now + Interval('2d') self.assertEqual(str(then), '2004-01-01.00:00:00') now = Date('2003-01-01.00:00:00') then = now + Interval('365d') self.assertEqual(str(then), '2004-01-01.00:00:00') now = Date('2004-01-01.00:00:00') then = now + Interval('366d') self.assertEqual(str(then), '2005-01-01.00:00:00') def testIntervalSubtractYearBoundary(self): # force the transition over a year boundary now = Date('2003-01-01.00:00:00') then = now - Interval('2d') self.assertEqual(str(then), '2002-12-30.00:00:00') now = Date('2004-02-01.00:00:00') then = now - Interval('365d') self.assertEqual(str(then), '2003-02-01.00:00:00') now = Date('2005-02-01.00:00:00') then = now - Interval('365d') self.assertEqual(str(then), '2004-02-02.00:00:00') def testDateSubtract(self): # These are thoroughly broken right now. i = Date('2003-03-15.00:00:00') - Date('2003-03-10.00:00:00') self.assertEqual(i, Interval('5d')) i = Date('2003-02-01.00:00:00') - Date('2003-03-01.00:00:00') self.assertEqual(i, Interval('-28d')) i = Date('2003-03-01.00:00:00') - Date('2003-02-01.00:00:00') self.assertEqual(i, Interval('28d')) i = Date('2003-03-03.00:00:00') - Date('2003-02-01.00:00:00') self.assertEqual(i, Interval('30d')) i = Date('2003-03-03.00:00:00') - Date('2002-02-01.00:00:00') self.assertEqual(i, Interval('395d')) i = Date('2003-03-03.00:00:00') - Date('2003-04-01.00:00:00') self.assertEqual(i, Interval('-29d')) i = Date('2003-03-01.00:00:00') - Date('2003-02-01.00:00:00') self.assertEqual(i, Interval('28d')) # force the transition over a year boundary i = Date('2003-01-01.00:00:00') - Date('2002-01-01.00:00:00') self.assertEqual(i, Interval('365d')) i = Date('1952-01-01') - Date('1953-01-01') self.assertEqual(i, Interval('-366d')) i = Date('1953-01-01') - Date('1952-01-01') self.assertEqual(i, Interval('366d')) def testIntervalAdd(self): ae = self.assertEqual ae(str(Interval('1y') + Interval('1y')), '+ 2y') ae(str(Interval('1y') + Interval('1m')), '+ 1y 1m') ae(str(Interval('1y') + Interval('2:40')), '+ 1y 2:40') ae(str(Interval('1y') + Interval('- 1y')), '00:00') ae(str(Interval('- 1y') + Interval('1y')), '00:00') ae(str(Interval('- 1y') + Interval('- 1y')), '- 2y') ae(str(Interval('1y') + Interval('- 1m')), '+ 11m') ae(str(Interval('1:00') + Interval('1:00')), '+ 2:00') ae(str(Interval('0:50') + Interval('0:50')), '+ 1:40') ae(str(Interval('1:50') + Interval('- 1:50')), '00:00') ae(str(Interval('- 1:50') + Interval('1:50')), '00:00') ae(str(Interval('- 1:50') + Interval('- 1:50')), '- 3:40') ae(str(Interval('1:59:59') + Interval('00:00:01')), '+ 2:00') ae(str(Interval('2:00') + Interval('- 00:00:01')), '+ 1:59:59') def testIntervalSub(self): ae = self.assertEqual ae(str(Interval('1y') - Interval('- 1y')), '+ 2y') ae(str(Interval('1y') - Interval('- 1m')), '+ 1y 1m') ae(str(Interval('1y') - Interval('- 2:40')), '+ 1y 2:40') ae(str(Interval('1y') - Interval('1y')), '00:00') ae(str(Interval('1y') - Interval('1m')), '+ 11m') ae(str(Interval('1:00') - Interval('- 1:00')), '+ 2:00') ae(str(Interval('0:50') - Interval('- 0:50')), '+ 1:40') ae(str(Interval('1:50') - Interval('1:50')), '00:00') ae(str(Interval('1:59:59') - Interval('- 00:00:01')), '+ 2:00') ae(str(Interval('2:00') - Interval('00:00:01')), '+ 1:59:59') def testOverflow(self): ae = self.assertEqual ae(fixTimeOverflow((1,0,0,0, 0, 0, 60)), (1,0,0,0, 0, 1, 0)) ae(fixTimeOverflow((1,0,0,0, 0, 0, 100)), (1,0,0,0, 0, 1, 40)) ae(fixTimeOverflow((1,0,0,0, 0, 0, 60*60)), (1,0,0,0, 1, 0, 0)) ae(fixTimeOverflow((1,0,0,0, 0, 0, 24*60*60)), (1,0,0,1, 0, 0, 0)) ae(fixTimeOverflow((1,0,0,0, 0, 0, -1)), (-1,0,0,0, 0, 0, 1)) ae(fixTimeOverflow((1,0,0,0, 0, 0, -100)), (-1,0,0,0, 0, 1, 40)) ae(fixTimeOverflow((1,0,0,0, 0, 0, -60*60)), (-1,0,0,0, 1, 0, 0)) ae(fixTimeOverflow((1,0,0,0, 0, 0, -24*60*60)), (-1,0,0,1, 0, 0, 0)) ae(fixTimeOverflow((-1,0,0,0, 0, 0, 1)), (-1,0,0,0, 0, 0, 1)) ae(fixTimeOverflow((-1,0,0,0, 0, 0, 100)), (-1,0,0,0, 0, 1, 40)) ae(fixTimeOverflow((-1,0,0,0, 0, 0, 60*60)), (-1,0,0,0, 1, 0, 0)) ae(fixTimeOverflow((-1,0,0,0, 0, 0, 24*60*60)), (-1,0,0,1, 0, 0, 0)) def testDivision(self): ae = self.assertEqual ae(str(Interval('1y')/2), '+ 6m') ae(str(Interval('1:00')/2), '+ 0:30') ae(str(Interval('00:01')/2), '+ 0:00:30') def testSorting(self): ae = self.assertEqual i1 = Interval('1y') i2 = Interval('1d') l = [i1, i2]; l.sort() ae(l, [i2, i1]) l = [i2, i1]; l.sort() ae(l, [i2, i1]) i1 = Interval('- 2d') i2 = Interval('1d') l = [i1, i2]; l.sort() ae(l, [i1, i2]) i1 = Interval("1:20") i2 = Interval("2d") i3 = Interval("3:30") l = [i1, i2, i3]; l.sort() ae(l, [i1, i3, i2]) def testGranularity(self): ae = self.assertEqual ae(str(Date('2003-2-12', add_granularity=1)), '2003-02-12.23:59:59') ae(str(Date('2003-1-1.23:00', add_granularity=1)), '2003-01-01.23:00:59') ae(str(Date('2003', add_granularity=1)), '2003-12-31.23:59:59') ae(str(Date('2003-5', add_granularity=1)), '2003-05-31.23:59:59') ae(str(Date('2003-12', add_granularity=1)), '2003-12-31.23:59:59') ae(str(Interval('+1w', add_granularity=1)), '+ 14d') ae(str(Interval('-2m 3w', add_granularity=1)), '- 2m 14d') def testIntervalPretty(self): def ae(spec, pretty): self.assertEqual(Interval(spec).pretty(), pretty) ae('2y', 'in 2 years') ae('1y', 'in 1 year') ae('2m', 'in 2 months') ae('1m 30d', 'in 2 months') ae('60d', 'in 2 months') ae('59d', 'in 1 month') ae('1m', 'in 1 month') ae('29d', 'in 1 month') ae('28d', 'in 4 weeks') ae('8d', 'in 1 week') ae('7d', 'in 7 days') ae('1w', 'in 7 days') ae('2d', 'in 2 days') ae('1d', 'tomorrow') ae('02:00:00', 'in 2 hours') ae('01:59:00', 'in 1 3/4 hours') ae('01:45:00', 'in 1 3/4 hours') ae('01:30:00', 'in 1 1/2 hours') ae('01:29:00', 'in 1 1/4 hours') ae('01:00:00', 'in an hour') ae('00:30:00', 'in 1/2 an hour') ae('00:15:00', 'in 1/4 hour') ae('00:02:00', 'in 2 minutes') ae('00:01:00', 'in 1 minute') ae('00:00:30', 'in a moment') ae('-00:00:30', 'just now') ae('-1d', 'yesterday') ae('-1y', '1 year ago') ae('-2y', '2 years ago') def testIntervalPrettyDe(self): gettext = i18n.gettext ngettext = i18n.ngettext i18n.gettext = i18n.degettext i18n.ngettext = i18n.dengettext def ae(spec, pretty): self.assertEqual(Interval(spec).pretty(), pretty) ae('2y', 'in 2 Jahren') ae('1y', 'in 1 Jahr') ae('2m', 'in 2 Monaten') ae('59d', 'in 1 Monat') ae('1m', 'in 1 Monat') '''ae('29d', 'in 1 month') ae('28d', 'in 4 weeks') ae('8d', 'in 1 week') ae('7d', 'in 7 days') ae('1w', 'in 7 days') ae('2d', 'in 2 days') ae('1d', 'tomorrow') ae('02:00:00', 'in 2 hours') ae('01:59:00', 'in 1 3/4 hours') ae('01:45:00', 'in 1 3/4 hours') ae('01:30:00', 'in 1 1/2 hours') ae('01:29:00', 'in 1 1/4 hours') ae('01:00:00', 'in an hour') ae('00:30:00', 'in 1/2 an hour') ae('00:15:00', 'in 1/4 hour') ae('00:02:00', 'in 2 minutes') ae('00:01:00', 'in 1 minute') ae('00:00:30', 'in a moment') ae('-00:00:30', 'just now') ae('-1d', 'yesterday') ae('-1y', '1 year ago') ae('-2y', '2 years ago')''' i18n.gettext = gettext i18n.ngettext = ngettext def testPyDatetime(self): d = datetime.datetime.now() Date(d) toomuch = datetime.MAXYEAR + 1 self.assertRaises(ValueError, Date, (toomuch, 1, 1, 0, 0, 0, 0, 1, -1)) def testRfc3339Form(self): ae = self.assertEqual d = Date('2003-11-01T00:00:00') self.assertEqual(str(d), '2003-11-01.00:00:00') def testSimpleTZ(self): ae = self.assertEqual # local to utc date = Date('2006-04-04.12:00:00', 2) ae(str(date), '2006-04-04.10:00:00') # utc to local date = Date('2006-04-04.10:00:00') date = date.local(2) ae(str(date), '2006-04-04.12:00:00') # from Date instance date = Date('2006-04-04.12:00:00') date = Date(date, 2) ae(str(date), '2006-04-04.10:00:00') def testTimestamp(self): ae = self.assertEqual date = Date('2038') ae(date.timestamp(), 2145916800) date = Date('1902') ae(date.timestamp(), -2145916800) date = Date(time.gmtime(0)) ae(date.timestamp(), 0) ae(str(date), '1970-01-01.00:00:00') date = Date(time.gmtime(0x7FFFFFFF)) ae(date.timestamp(), 2147483647) ae(str(date), '2038-01-19.03:14:07') date = Date('1901-12-13.20:45:52') ae(date.timestamp(), -0x80000000) ae(str(date), '1901-12-13.20:45:52') date = Date('9999') ae (date.timestamp(), 253370764800.0) date = Date('0033') ae (date.timestamp(), -61125753600.0) ae(str(date), '0033-01-01.00:00:00') @skip_pytz class TimezoneTestCase(unittest.TestCase): def testTZ(self): ae = self.assertEqual tz = 'Europe/Warsaw' # local to utc, DST date = Date('2006-04-04.12:00:00', tz) ae(str(date), '2006-04-04.10:00:00') # local to utc, no DST date = Date('2006-01-01.12:00:00', tz) ae(str(date), '2006-01-01.11:00:00') # utc to local, DST date = Date('2006-04-04.10:00:00') date = date.local(tz) ae(str(date), '2006-04-04.12:00:00') # utc to local, no DST date = Date('2006-01-01.10:00:00') date = date.local(tz) ae(str(date), '2006-01-01.11:00:00') date = Date('2006-04-04.12:00:00') date = Date(date, tz) ae(str(date), '2006-04-04.10:00:00') date = Date('2006-01-01.12:00:00') date = Date(date, tz) ae(str(date), '2006-01-01.11:00:00') def testUnrecognizedTimezone(self): '''Unrecognize timezone should raise key error''' # unrecognized timezone tz = 'Zoot' with self.assertRaises(KeyError) as cm: date = Date('2006-04-04.12:00:00', tz) self.assertEqual(cm.exception.args, ('Zoot',)) class RangeTestCase(unittest.TestCase): def testRange(self): ae = self.assertEqual r = Range('2006', Date) ae(str(r.from_value), '2006-01-01.00:00:00') ae(str(r.to_value), '2006-12-31.23:59:59') for i in range(1, 13): r = Range('2006-%02d'%i, Date) ae(str(r.from_value), '2006-%02d-01.00:00:00'%i) ae(str(r.to_value), '2006-%02d-%02d.23:59:59'%(i, calendar.mdays[i])) # vim: set filetype=python sts=4 sw=4 et si : code-e5bd50120b5a/test/test_demo.py0000644000000000000000000001334215064275501015237 0ustar 00000000000000import pytest import unittest import os, sys, shutil from os.path import normpath from roundup.demo import install_demo, run_demo import roundup.scripts.roundup_server # https://stackoverflow.com/questions/4219717/how-to-assert-output-with-nosetest-unittest-in-python # lightly modified from contextlib import contextmanager _py3 = sys.version_info[0] > 2 if _py3: from io import StringIO # py3 else: from StringIO import StringIO # py2 @contextmanager def captured_output(): new_out, new_err = StringIO(), StringIO() old_out, old_err = sys.stdout, sys.stderr try: sys.stdout, sys.stderr = new_out, new_err yield sys.stdout, sys.stderr finally: sys.stdout, sys.stderr = old_out, old_err try: import jinja2 skip_jinja2 = lambda func, *args, **kwargs: func except ImportError: from .pytest_patcher import mark_class skip_jinja2 = mark_class(pytest.mark.skip( reason='Skipping Jinja2 tests: jinja2 library not available')) class TestDemo(unittest.TestCase): def setUp(self): self.home = os.path.abspath('_test_demo') def tearDown(self): try: shutil.rmtree(self.home) except FileNotFoundError: pass def run_install_demo(self, template, db="anydbm"): with captured_output() as (out, err): install_demo(self.home, db, template) output = out.getvalue().strip() print(output) # verify that db was set properly by reading config with open(self.home + "/config.ini", "r") as f: config_lines = f.read().replace("\r\n", "\n") try: # handle text files with \r\n line endings config_lines.index("\r", 0, 100) config_lines = config_lines.replace("\r\n", "\n") except ValueError: pass self.assertIn("backend = %s\n"%db, config_lines) # dummy up the return of get_server so the serve_forever method # raises keyboard interrupt exiting the server so the test exits. gs = roundup.scripts.roundup_server.ServerConfig.get_server def raise_KeyboardInterrupt(): raise KeyboardInterrupt def test_get_server(self): httpd = gs(self) httpd.serve_forever = raise_KeyboardInterrupt return httpd roundup.scripts.roundup_server.ServerConfig.get_server = test_get_server # Run under context manager to capture output of startup text. with captured_output() as (out, err): run_demo(self.home) output = out.getvalue().strip() print(output) # if the server installed and started this will be the # last line in the output. self.assertIn("Keyboard Interrupt: exiting", output.split('\n')) def testDemoClassic(self): with captured_output() as (out, err): self.run_install_demo("classic") self.assertIn("http://localhost:8917/demo/", out.getvalue()) # verify the default anydbm db is created db_file = self.home + normpath("/db/nodes.user") db_file2 = db_file + '.db' db_file_dumbdbm = self.home + normpath("/db/nodes.user.dir") self.assertTrue(os.path.isfile(db_file) or os.path.isfile(db_file2) or os.path.isfile(db_file_dumbdbm), "expected db file %s[.db] or %s does not exist" % ( db_file, db_file_dumbdbm )) # verify requested template was used with open(self.home + "/TEMPLATE-INFO.txt", "r") as f: info_lines = f.read() try: # handle text files with \r\n line endings info_lines.index("\r", 0, 100) info_lines = info_lines.replace("\r\n", "\n") except ValueError: pass self.assertIn("Name: classic-_test_demo\n", info_lines) def testDemoMinimal(self): # test explicit path to template as others test template # search path. with captured_output() as (out, err): self.run_install_demo('../templates/minimal', db="sqlite") self.assertIn("http://localhost:8917/demo/", out.getvalue()) # verify the requested sqlite db file is created db_file = self.home + "/db/db" self.assertTrue(os.path.isfile(db_file), "expected db file %s does not exist" % db_file) # verify requested template was used with open(self.home + "/TEMPLATE-INFO.txt", "r") as f: info_lines = f.read() try: # handle text files with \r\n line endings info_lines.index("\r", 0, 100) info_lines = info_lines.replace("\r\n", "\n") except ValueError: pass self.assertIn("Name: minimal-_test_demo\n", info_lines) @skip_jinja2 def testDemoJinja(self): with captured_output() as (out, err): self.run_install_demo('jinja2', db="anydbm") self.assertIn("http://localhost:8917/demo/", out.getvalue()) # verify the requested anydbm db file is created db_file = self.home + "/db/nodes.user" db_file2 = db_file + '.db' self.assertTrue(os.path.isfile(db_file) or os.path.isfile(db_file2), "expected db file %s[.db] does not exist" % db_file) # verify that template was set to jinja2 by reading config with open(self.home + "/config.ini", "r") as f: config_lines = f.read() try: # handle text files with \r\n line endings config_lines.index("\r", 0, 100) config_lines = config_lines.replace("\r\n", "\n") except ValueError: pass self.assertIn("template_engine = jinja2\n", config_lines) code-e5bd50120b5a/test/test_hyperdbvals.py0000644000000000000000000002056315064275501016641 0ustar 00000000000000# # Copyright (c) 2003 Richard Jones, richard@commonground.com.au # 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. import unittest, os, shutil, errno, sys, difflib, re from hashlib import sha1 try: from unittest.mock import Mock except ImportError: # python 2.7 from mock import Mock from roundup import init, instance, password, hyperdb, date class TestClass: def getprops(self): return { 'string': hyperdb.String(), 'number': hyperdb.Number(), 'integer': hyperdb.Integer(), 'boolean': hyperdb.Boolean(), 'password': hyperdb.Password(), 'date': hyperdb.Date(), 'interval': hyperdb.Interval(), 'link': hyperdb.Link('test'), 'linkkeyonly': hyperdb.Link('test', try_id_parsing='no'), 'link2': hyperdb.Link('test2'), 'multilink': hyperdb.Multilink('test'), 'multilink2': hyperdb.Multilink('test2'), 'multilink3': hyperdb.Multilink('test', try_id_parsing='no'), } def getkey(self): return 'string' def lookup(self, value): if value == 'valid': return '1' if value == '2valid': return '2' raise KeyError def get(self, nodeid, propname): assert propname.startswith('multilink') assert nodeid is not None return ['2', '3'] class TestClass2: def properties(self): return { 'string': hyperdb.String(), } def getkey(self): return None def labelprop(self, default_to_id=1): return 'id' class TestDatabase: classes = {'test': TestClass(), 'test2': TestClass2()} def getUserTimezone(self): return 0 config = Mock(PASSWORD_PBKDF2_DEFAULT_ROUNDS = 1000) class RawToHyperdbTest(unittest.TestCase): def _test(self, propname, value, itemid=None): return hyperdb.rawToHyperdb(TestDatabase(), TestClass(), itemid, propname, value) def testString(self): self.assertEqual(self._test('password', ''), None) self.assertEqual(self._test('string', ' a string '), 'a string') def testNumber(self): self.assertEqual(self._test('password', ''), None) self.assertEqual(self._test('number', ' 10 '), 10) self.assertEqual(self._test('number', ' 1.5 '), 1.5) self.assertEqual(self._test('number', ' -1022.5 '), -1022.5) def testInteger(self): self.assertEqual(self._test('integer', ' 100 '), 100) self.assertEqual(self._test('integer', ' 0 '), 0) self.assertEqual(self._test('integer', ' -100 '), -100) # make sure error raised on string self.assertRaises(hyperdb.HyperdbValueError, self._test, 'integer', 'a string', 'a string') # make sure error raised on real number self.assertRaises(hyperdb.HyperdbValueError, self._test, 'integer', ' -100.2 ') def testBoolean(self): self.assertEqual(self._test('password', ''), None) for true in 'yes true on 1'.split(): self.assertEqual(self._test('boolean', ' %s '%true), 1) for false in 'no false off 0'.split(): self.assertEqual(self._test('boolean', ' %s '%false), 0) def testPassword(self): self.assertEqual(self._test('password', ''), None) self.assertEqual(self._test('password', ' a string '), 'a string') val = self._test('password', ' a string ') self.assertTrue(isinstance(val, password.Password)) val = self._test('password', '{plaintext}a string') self.assertTrue(isinstance(val, password.Password)) try: import crypt val = self._test('password', '{crypt}a string') self.assertTrue(isinstance(val, password.Password)) except ImportError: pass s = sha1(b'a string').hexdigest() val = self._test('password', '{SHA}'+s) self.assertTrue(isinstance(val, password.Password)) self.assertEqual(val, 'a string') self.assertRaises(hyperdb.HyperdbValueError, self._test, 'password', '{fubar}a string') def testDate(self): self.assertEqual(self._test('password', ''), None) val = self._test('date', ' 2003-01-01 ') self.assertTrue(isinstance(val, date.Date)) val = self._test('date', ' 2003/01/01 ') self.assertTrue(isinstance(val, date.Date)) val = self._test('date', ' 2003/1/1 ') self.assertTrue(isinstance(val, date.Date)) val = self._test('date', ' 2003-1-1 ') self.assertTrue(isinstance(val, date.Date)) self.assertRaises(hyperdb.HyperdbValueError, self._test, 'date', 'fubar') def testInterval(self): self.assertEqual(self._test('password', ''), None) val = self._test('interval', ' +1d ') self.assertTrue(isinstance(val, date.Interval)) self.assertRaises(hyperdb.HyperdbValueError, self._test, 'interval', 'fubar') def testLink(self): self.assertEqual(self._test('link', '1'), '1') self.assertEqual(self._test('link', 'valid'), '1') self.assertEqual(self._test('linkkeyonly', 'valid'), '1') self.assertRaises(hyperdb.HyperdbValueError, self._test, 'link', 'invalid') self.assertRaises(hyperdb.HyperdbValueError, self._test, 'linkkeyonly', '1') self.assertRaises(hyperdb.HyperdbValueError, self._test, 'linkkeyonly', 'invalid') def testMultilink(self): self.assertEqual(self._test('multilink', '', '1'), []) self.assertEqual(self._test('multilink', '1', '1'), ['1']) self.assertEqual(self._test('multilink', 'valid', '1'), ['1']) self.assertRaises(hyperdb.HyperdbValueError, self._test, 'multilink', 'invalid', '1') self.assertEqual(self._test('multilink', '+1', '1'), ['1', '2', '3']) self.assertEqual(self._test('multilink', '+valid', '1'), ['1', '2', '3']) self.assertEqual(self._test('multilink', '+1,-2', '1'), ['1', '3']) self.assertEqual(self._test('multilink', '+valid,-3', '1'), ['1', '2']) self.assertEqual(self._test('multilink', '+1', None), ['1']) self.assertEqual(self._test('multilink', '+valid', None), ['1']) self.assertEqual(self._test('multilink', '', None), []) def testMultilink3(self): # note that all +1, -2 type references will fail with exceptions # '+1' is an id and try_id_parsing is set to no for multilink3 # and the 'name/key' 1 or 2 doesn't exist. self.assertEqual(self._test('multilink3', '', '1'), []) with self.assertRaises(hyperdb.HyperdbValueError) as cm: self._test('multilink3', '1', '1') self.assertEqual(cm.exception.args, ("property multilink3: '1' is not a test.",)) self.assertEqual(self._test('multilink3', 'valid', '1'), ['1']) self.assertRaises(hyperdb.HyperdbValueError, self._test, 'multilink3', 'invalid', '1') with self.assertRaises(hyperdb.HyperdbValueError) as cm: self._test('multilink3', '+1', '1') self.assertEqual(cm.exception.args, ("property multilink3: '1' is not a test.",)) self.assertEqual(self._test('multilink3', '+valid', '1'), ['1', '2', '3']) with self.assertRaises(hyperdb.HyperdbValueError) as cm: self._test('multilink3', '+1,-2', '1') self.assertEqual(cm.exception.args, ("property multilink3: '1' is not a test.",)) with self.assertRaises(hyperdb.HyperdbValueError) as cm: self._test('multilink3', '+valid,-2', '1') self.assertEqual(cm.exception.args, ("property multilink3: '2' is not a test.",)) self.assertEqual(self._test('multilink3', '+valid,-2valid', '1'), ['1', '3']) self.assertEqual(self._test('multilink3', '+valid', None), ['1']) self.assertEqual(self._test('multilink3', '', None), []) self.assertEqual(self._test('multilink3', '-valid', None), []) # vim: set filetype=python ts=4 sw=4 et si code-e5bd50120b5a/test/test_hypothesis.py0000644000000000000000000000730215064275501016511 0ustar 00000000000000import unittest import pytest pytest.importorskip("hypothesis") # ruff: noqa: E402 from hypothesis import example, given, settings from hypothesis.strategies import binary, none, one_of, sampled_from, text from roundup.anypy.strings import b2s, s2b, s2u, u2s # ruff: noqa: I001 - yes I know I am using \ to continue the line... from roundup.password import PasswordValueError, encodePassword, \ h64decode, h64encode from roundup.password import crypt as crypt_method def Identity(x): return x _max_examples = 1000 class HypoTestStrings(unittest.TestCase): @given(text()) @settings(max_examples=_max_examples) def test_b2s(self, utf8_bytes): self.assertEqual(b2s(utf8_bytes.encode("utf-8")), utf8_bytes) @given(text()) @settings(max_examples=_max_examples) def test_s2b(self, s): self.assertTrue(isinstance(s2b(s), bytes)) @given(text()) @settings(max_examples=_max_examples) @example("\U0001F600 hi there") # smiley face emoji def test_s2u_u2s_invertable(self, s): self.assertEqual(u2s(s2u(s)), s) class HypoTestPassword(unittest.TestCase): @given(binary()) @example(b"") @settings(max_examples=_max_examples) def test_h64encode_h64decode(self, s): self.assertEqual(h64decode(h64encode(s)), s) crypt_modes = ["PBKDF2S5", "PBKDF2", "SSHA", "SHA", "MD5", "plaintext", "zot"] if crypt_method: crypt_modes.append("crypt") @given(one_of(none(), text()), sampled_from(crypt_modes)) @example("asd\x00df", "crypt") @settings(max_examples=_max_examples) # deadline=None for debugging def test_encodePassword(self, password, scheme): if scheme == "crypt" and password and "\x00" in password: with self.assertRaises(ValueError) as e: encodePassword(password, scheme) if crypt_method: self.assertEqual(e.exception.args[0], "embedded null character") else: self.assertEqual(e.exception.args[0], "Unsupported encryption scheme 'crypt'") elif scheme == "plaintext": if password is not None: self.assertEqual(encodePassword(password, scheme), password) else: self.assertEqual(encodePassword(password, scheme), "") elif scheme == "zot": with self.assertRaises(PasswordValueError) as e: encodePassword(password, scheme) self.assertEqual(e.exception.args[0], "Unknown encryption scheme 'zot'") else: # it shouldn't throw anything. pw = encodePassword(password, scheme) # verify format if scheme in ["PBKDF2S5", "PBKDF2"]: # 1000$XbSsijELEQbZZb1LlD7CFuotF/8$DdtssSlm.e self.assertRegex(pw, r"^\d{4,8}\$.{27}\$.*") elif scheme == "SSHA": # vqDbjvs8rhrS1AJxHYEGGXQW3x7STAPgo7uCtnw4GYgU7FN5VYbZxccQYCC0eXOxSipLbtgBudH1vDRMNlG0uw== self.assertRegex(pw, r"^[^=]*={0,3}$") elif scheme == "SHA": # da39a3ee5e6b4b0d3255bfef95601890afd80709' self.assertRegex(pw, r"^[a-z0-9]{40}$") elif scheme == "MD5": # d41d8cd98f00b204e9800998ecf8427e' self.assertRegex(pw, r"^[a-z0-9]{32}$") elif scheme == "crypt": # crypt_method is None if crypt is unknown if crypt_method: # WqzFDzhi8MmoU self.assertRegex(pw, r"^[A-Za-z0-9./]{13}$") else: self.assertFalse("Unknown scheme: %s, val: %s" % (scheme, pw)) code-e5bd50120b5a/test/test_indexer.py0000644000000000000000000010304515064275501015751 0ustar 00000000000000# Copyright (c) 2002 ekit.com Inc (http://www.ekit-inc.com/) # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. import os, sys, unittest, shutil import pytest from roundup.backends import get_backend, have_backend from roundup.backends.indexer_rdbms import Indexer from roundup.backends.indexer_common import get_indexer from roundup.cgi.exceptions import IndexerQueryError # borrow from other tests from .db_test_base import setupSchema, config from .test_postgresql import postgresqlOpener, skip_postgresql from .test_mysql import mysqlOpener, skip_mysql from .test_sqlite import sqliteOpener from .test_anydbm import anydbmOpener try: from unittest import mock except ImportError: import mock try: import xapian skip_xapian = lambda func, *args, **kwargs: func except ImportError: # FIX: workaround for a bug in pytest.mark.skip(): # https://github.com/pytest-dev/pytest/issues/568 from .pytest_patcher import mark_class skip_xapian = mark_class(pytest.mark.skip( "Skipping Xapian indexer tests: 'xapian' not installed")) try: import whoosh skip_whoosh = lambda func, *args, **kwargs: func except ImportError: # FIX: workaround for a bug in pytest.mark.skip(): # https://github.com/pytest-dev/pytest/issues/568 from .pytest_patcher import mark_class skip_whoosh = mark_class(pytest.mark.skip( "Skipping Whoosh indexer tests: 'whoosh' not installed")) class db: class config(dict): DATABASE = 'test-index' config = config() config[('main', 'indexer_stopwords')] = [] config[('main', 'indexer_language')] = "english" class IndexerTest(anydbmOpener, unittest.TestCase): indexer_name = "native" def setUp(self): # remove previous test, ignore errors if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) self.db = self.module.Database(config, 'admin') if os.path.exists('test-index'): shutil.rmtree('test-index') os.mkdir('test-index') os.mkdir('test-index/files') from roundup.backends.indexer_dbm import Indexer self.dex = Indexer(db) self.dex.load_index() def assertSeqEqual(self, s1, s2): # First argument is the db result we're testing, second is the # desired result. Some db results don't have iterable rows, so we # have to work around that. # Also work around some dbs not returning items in the expected # order. s1 = list([tuple([r[n] for n in range(len(r))]) for r in s1]) s1.sort() if s1 != s2: self.fail('contents of %r != %r'%(s1, s2)) def test_basics(self): self.dex.add_text(('test', '1', 'foo'), 'a the hello world') self.dex.add_text(('test', '2', 'foo'), 'blah blah the world') self.assertSeqEqual(self.dex.find(['world']), [('test', '1', 'foo'), ('test', '2', 'foo')]) self.assertSeqEqual(self.dex.find(['blah']), [('test', '2', 'foo')]) self.assertSeqEqual(self.dex.find(['blah', 'hello']), []) self.assertSeqEqual(self.dex.find([]), []) def test_save_load(self): # only run for anydbm test if ( not type(self) is IndexerTest ): pytest.skip("test_save_load tested only for anydbm backend") self.dex.add_text(('test', '1', 'foo'), 'b the hello world') self.assertSeqEqual(self.dex.find(['hello']), [('test', '1', 'foo')]) self.dex.save_index() # reopen saved db. from roundup.backends.indexer_dbm import Indexer self.dex = Indexer(db) # verify index is unloaded self.assertEqual(self.dex.index_loaded(), False) # add also calls load_index(), so it should load the first item. self.dex.add_text(('test', '2', 'foo'), 'b the olleh world') # note find also does a load_index() if not loaded. self.assertSeqEqual(self.dex.find(['hello']), [('test', '1', 'foo')]) self.assertSeqEqual(self.dex.find(['olleh']), [('test', '2', 'foo')]) def test_change(self): self.dex.add_text(('test', '1', 'foo'), 'a the hello world') self.dex.add_text(('test', '2', 'foo'), 'blah blah the world') self.assertSeqEqual(self.dex.find(['world']), [('test', '1', 'foo'), ('test', '2', 'foo')]) self.dex.add_text(('test', '1', 'foo'), 'a the hello') self.assertSeqEqual(self.dex.find(['world']), [('test', '2', 'foo')]) def test_clear(self): self.dex.add_text(('test', '1', 'foo'), 'a the hello world') self.dex.add_text(('test', '2', 'foo'), 'blah blah the world') self.assertSeqEqual(self.dex.find(['world']), [('test', '1', 'foo'), ('test', '2', 'foo')]) self.dex.add_text(('test', '1', 'foo'), '') self.assertSeqEqual(self.dex.find(['world']), [('test', '2', 'foo')]) def test_get_indexer_specified(self): """Specify an indexer back end and make sure it's returned""" def class_name_of(object): """ take and object and return just the class name. So in: return the class name before "at". """ return(str(object).split()[0]) old_indexer = self.db.config['INDEXER'] self.db.config['INDEXER'] = self.indexer_name self.assertEqual(class_name_of(self.dex), class_name_of(get_indexer(self.db.config, self.db))) self.db.config['INDEXER'] = old_indexer def test_stopwords(self): """Test that we can find a text with a stopword in it.""" stopword = "with" self.assertTrue(self.dex.is_stopword(stopword.upper())) self.dex.add_text(('test', '1', 'bar'), '%s hello world' % stopword) self.dex.add_text(('test', '2', 'bar'), 'blah a %s world' % stopword) self.dex.add_text(('test', '3', 'bar'), 'blah Blub river') self.dex.add_text(('test', '4', 'bar'), 'blah river %s' % stopword) self.assertSeqEqual(self.dex.find(['with','world']), [('test', '1', 'bar'), ('test', '2', 'bar')]) def test_extremewords(self): """Testing too short or too long words.""" # skip this for FTS test if ( isinstance(self,sqliteFtsIndexerTest) or isinstance(self,postgresqlFtsIndexerTest)): pytest.skip("extremewords not tested for native FTS backends") short = "b" long = "abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz" self.dex.add_text(('test', '1', 'a'), '%s hello world' % short) self.dex.add_text(('test', '2', 'a'), 'blah a %s world' % short) self.dex.add_text(('test', '3', 'a'), 'blah Blub river') self.dex.add_text(('test', '4', 'a'), 'blah river %s %s' % (short, long)) self.assertSeqEqual(self.dex.find([short,'world', long, short]), [('test', '1', 'a'), ('test', '2', 'a')]) self.assertSeqEqual(self.dex.find([long]),[]) # special test because some faulty code indexed length(word)>=2 # but only considered length(word)>=3 to be significant self.dex.add_text(('test', '5', 'a'), 'blah py %s %s' % (short, long)) self.assertSeqEqual(self.dex.find(["py"]), [('test', '5', 'a')]) def test_casesensitivity(self): """Test if searches are case-in-sensitive.""" self.dex.add_text(('test', '1', 'a'), 'aaaa bbbb') self.dex.add_text(('test', '2', 'a'), 'aAaa BBBB') self.assertSeqEqual(self.dex.find(['aaaa']), [('test', '1', 'a'), ('test', '2', 'a')]) self.assertSeqEqual(self.dex.find(['BBBB']), [('test', '1', 'a'), ('test', '2', 'a')]) def test_wordsplitting(self): """Test if word splitting works.""" self.dex.add_text(('test', '1', 'a'), 'aaaa-aaa bbbb*bbb') self.dex.add_text(('test', '2', 'a'), 'aaaA-aaa BBBB*BBB') for k in 'aaaa', 'aaa', 'bbbb', 'bbb': self.assertSeqEqual(self.dex.find([k]), [('test', '1', 'a'), ('test', '2', 'a')]) def test_manyresults(self): """Test if searches find many results.""" for i in range(123): self.dex.add_text(('test', str(i), 'many'), 'many') self.assertEqual(len(self.dex.find(['many'])), 123) def test_unicode(self): """Test with unicode words. see: https://issues.roundup-tracker.org/issue1344046""" russian=u'\u0440\u0443\u0441\u0441\u043a\u0438\u0439 \u0442\u0435\u043a\u0441\u0442Spr\xfcnge' german=u'Spr\xfcnge' self.dex.add_text(('test', '1', 'a'), german ) self.dex.add_text(('test', '2', 'a'), russian + u' ' + german ) self.assertSeqEqual(self.dex.find([ u'Spr\xfcnge']), [('test', '1', 'a'), ('test', '2', 'a')]) self.assertSeqEqual(self.dex.find([u'\u0440\u0443\u0441\u0441\u043a\u0438\u0439']), [('test', '2', 'a')]) def testNullChar(self): """Test with null char in string. Postgres FTS will not index it will just ignore string for now. """ string="\x00\x01fred\x255" self.dex.add_text(('test', '1', 'a'), string) self.assertSeqEqual(self.dex.find(string), []) def tearDown(self): shutil.rmtree('test-index') if hasattr(self, 'db'): self.db.close() if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) @skip_whoosh class WhooshIndexerTest(IndexerTest): indexer_name = "whoosh" def setUp(self): IndexerTest.setUp(self) if os.path.exists('test-index'): shutil.rmtree('test-index') os.mkdir('test-index') from roundup.backends.indexer_whoosh import Indexer self.dex = Indexer(db) def tearDown(self): IndexerTest.tearDown(self) @skip_xapian class XapianIndexerTest(IndexerTest): indexer_name = "xapian" def setUp(self): IndexerTest.setUp(self) if os.path.exists('test-index'): shutil.rmtree('test-index') os.mkdir('test-index') from roundup.backends.indexer_xapian import Indexer self.dex = Indexer(db) def tearDown(self): IndexerTest.tearDown(self) class Get_IndexerTest(anydbmOpener, unittest.TestCase): def setUp(self): # remove previous test, ignore errors if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) self.db = self.module.Database(config, 'admin') # this is the default, but set it in case default # changes in future self.db.config['INDEXER'] = '' def tearDown(self): if hasattr(self, 'db'): self.db.close() if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) @skip_xapian def test_xapian_autoselect(self): indexer = get_indexer(self.db.config, self.db) self.assertIn('roundup.backends.indexer_xapian.Indexer', str(indexer)) @skip_whoosh def test_whoosh_autoselect(self): with mock.patch.dict('sys.modules', {'roundup.backends.indexer_xapian': None}): indexer = get_indexer(self.db.config, self.db) self.assertIn('roundup.backends.indexer_whoosh.Indexer', str(indexer)) def test_native_autoselect(self): with mock.patch.dict('sys.modules', {'roundup.backends.indexer_xapian': None, 'roundup.backends.indexer_whoosh': None}): indexer = get_indexer(self.db.config, self.db) self.assertIn('roundup.backends.indexer_dbm.Indexer', str(indexer)) def test_invalid_indexer(self): """There is code at the end of indexer_common::get_indexer() to raise an AssertionError if the indexer name is invalid. This should never be triggered. If it is, it means that the code in configure.py that validates indexer names allows a name through that get_indexer can't handle. Simulate that failure and make sure that the AssertionError is raised. """ with self.assertRaises(ValueError) as cm: self.db.config['INDEXER'] = 'no_such_indexer' # mangle things so we can test AssertionError at end # get_indexer() from roundup.configuration import IndexerOption io_orig = IndexerOption.allowed io = list(io_orig) io.append("unrecognized_indexer") IndexerOption.allowed = tuple(io) self.db.config['INDEXER'] = "unrecognized_indexer" with self.assertRaises(AssertionError) as cm: indexer = get_indexer(self.db.config, self.db) # unmangle state IndexerOption.allowed = io_orig self.assertNotIn("unrecognized_indexer", IndexerOption.allowed) self.db.config['INDEXER'] = "" def test_unsupported_by_db(self): """This requires that the db associated with the test is not sqlite or postgres. anydbm works fine to trigger the error. """ self.db.config['INDEXER'] = 'native-fts' with self.assertRaises(AssertionError) as cm: get_indexer(self.db.config, self.db) self.assertIn("native-fts", cm.exception.args[0]) self.db.config['INDEXER'] = '' class RDBMSIndexerTest(object): def setUp(self): # remove previous test, ignore errors if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) self.db = self.module.Database(config, 'admin') self.dex = Indexer(self.db) def tearDown(self): if hasattr(self, 'db'): # commit any outstanding cursors. # close() doesn't actually close file handle on # windows unless commit() is called. self.db.commit() self.db.close() if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) @skip_postgresql class postgresqlIndexerTest(postgresqlOpener, RDBMSIndexerTest, IndexerTest): def setUp(self): postgresqlOpener.setUp(self) RDBMSIndexerTest.setUp(self) def tearDown(self): RDBMSIndexerTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql class postgresqlFtsIndexerTest(postgresqlOpener, RDBMSIndexerTest, IndexerTest): indexer_name = "native-fts" def setUp(self): postgresqlOpener.setUp(self) RDBMSIndexerTest.setUp(self) from roundup.backends.indexer_postgresql_fts import Indexer self.dex = Indexer(self.db) self.dex.db = self.db def tearDown(self): RDBMSIndexerTest.tearDown(self) postgresqlOpener.tearDown(self) def test_websearch_syntax(self): """Test searches using websearch_to_tsquery. These never throw errors regardless of how wacky the input. """ self.dex.add_text(('test', '1', 'foo'), 'a the hello world') self.dex.add_text(('test', '2', 'foo'), 'helh blah blah the world') self.dex.add_text(('test', '3', 'foo'), 'blah hello the world') self.dex.add_text(('test', '4', 'foo'), 'hello blah blech the world') self.dex.add_text(('test', '5', 'foo'), 'a car drove') self.dex.add_text(('test', '6', 'foo'), 'a car driving itself') self.dex.add_text(('test', '7', 'foo'), "let's drive in the car") self.dex.add_text(('test', '8', 'foo'), 'a drive-in movie') # test two separate words for sanity self.assertSeqEqual(self.dex.find(['"hello" "world"']), [('test', '1', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo') ]) # now check the phrase self.assertSeqEqual(self.dex.find(['"hello world"']), [('test', '1', 'foo'), ]) # test negation self.assertSeqEqual(self.dex.find(['hello world -blech']), [('test', '1', 'foo'), ('test', '3', 'foo'), ]) # phrase negation self.assertSeqEqual(self.dex.find(['hello world -"blah hello"']), [('test', '1', 'foo'), ('test', '4', 'foo'), ]) # test without or self.assertSeqEqual(self.dex.find(['blah blech']), [('test', '4', 'foo'), ]) # test with or self.assertSeqEqual(self.dex.find(['blah or blech']), [ ('test', '2', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo'), ]) # stemmer test for english self.assertSeqEqual(self.dex.find(['ts:drive']), [('test', '6', 'foo'), ('test', '7', 'foo'), ('test', '8', 'foo') ]) # stemmer is not disabled by quotes 8-( self.assertSeqEqual(self.dex.find(['ts:"drive"']), [('test', '6', 'foo'), ('test', '7', 'foo'), ('test', '8', 'foo') ]) # this is missing ts: at the start, so uses the websearch # parser. We search for operator characters and wanr the user # Otherwise "hello <-> world" is the same as "hello world" # and is not a phrase search. with self.assertRaises(IndexerQueryError) as ctx: self.dex.find(['hello <-> world']) self.assertIn('do a tsquery search', ctx.exception.args[0]) def test_tsquery_syntax(self): """Because websearch_to_tsquery doesn't allow prefix searches, near searches with any value except 1 (phrase search), allow use of to_tsquery by prefixing the search term wih ts:. However, unlike websearch_to_tsquery, this will throw a psycopg2.errors.SyntaxError on bad input. SyntaxError is re-raised as IndexerQueryError. But it makes a bunch of useful expert functionality available. """ self.dex.add_text(('test', '1', 'foo'), 'a the hello world') self.dex.add_text(('test', '2', 'foo'), 'helh blah blah the world') self.dex.add_text(('test', '3', 'foo'), 'blah hello the world') self.dex.add_text(('test', '4', 'foo'), 'hello blah blech the world') self.dex.add_text(('test', '5', 'foo'), 'a car drove') self.dex.add_text(('test', '6', 'foo'), 'a car driving itself') self.dex.add_text(('test', '7', 'foo'), "let's drive in the car") self.dex.add_text(('test', '8', 'foo'), 'a drive-in movie') self.dex.db.commit() # test two separate words for sanity self.assertSeqEqual(self.dex.find(['ts:hello & world']), [('test', '1', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo') ]) # now check the phrase self.assertSeqEqual(self.dex.find(['ts:hello <-> world']), [('test', '1', 'foo'), ]) # test negation self.assertSeqEqual(self.dex.find(['ts:hello & world & !blech']), [('test', '1', 'foo'), ('test', '3', 'foo'), ]) self.assertSeqEqual(self.dex.find( ['ts:hello & world & !(blah <-> hello)']), [('test', '1', 'foo'), ('test', '4', 'foo'), ]) # test without or self.assertSeqEqual(self.dex.find(['ts:blah & blech']), [('test', '4', 'foo'), ]) # test with or self.assertSeqEqual(self.dex.find(['ts:blah | blech']), [ ('test', '2', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo'), ]) # stemmer test for english self.assertSeqEqual(self.dex.find(['ts:drive']), [('test', '6', 'foo'), ('test', '7', 'foo'), ('test', '8', 'foo') ]) # stemmer is not disabled by quotes 8-( self.assertSeqEqual(self.dex.find(['ts:"drive"']), [('test', '6', 'foo'), ('test', '7', 'foo'), ('test', '8', 'foo') ]) # test with syntax error with self.assertRaises(IndexerQueryError) as ctx: self.dex.find(['ts:blah blech']) self.assertEqual(ctx.exception.args[0], 'syntax error in tsquery: "blah blech"\n') # now check the phrase Note unlike sqlite, order matters, # hello must come first. self.assertSeqEqual(self.dex.find(['ts:hello <-> world']), [('test', '1', 'foo'), ]) # now check the phrase with explicitly 1 intervening item self.assertSeqEqual(self.dex.find(['ts:hello <2> world']), [('test', '3', 'foo'), ]) # now check the phrase with near explicitly 1 or 3 intervening items self.assertSeqEqual(self.dex.find([ 'ts:(hello <4> world) | (hello<2>world)']), [('test', '3', 'foo'), ('test', '4', 'foo'), ]) # now check the phrase with near explicitly 3 intervening item # with prefix for world. self.assertSeqEqual(self.dex.find(['ts:hello <4> wor:*']), [('test', '4', 'foo'), ]) def test_invalid_language(self): import psycopg2 from roundup.configuration import IndexerOption io_orig = IndexerOption.valid_langs io = list(io_orig) io.append("foo") self.db.config["INDEXER_LANGUAGE"] = "foo" with self.assertRaises(psycopg2.errors.UndefinedObject) as ctx: # psycopg2.errors.UndefinedObject: text search configuration # "foo" does not exist self.dex.add_text(('test', '1', 'foo'), 'a the hello world') self.assertIn('search configuration "foo" does', ctx.exception.args[0]) self.db.rollback() with self.assertRaises(ValueError) as ctx: self.dex.find(['"hello" "world"']) self.assertIn('search configuration "foo" does', ctx.exception.args[0]) self.db.rollback() self.db.config["INDEXER_LANGUAGE"] = "english" IndexerOption.valid_langs = io_orig def testNullChar(self): """Test with null char in string. Postgres FTS throws a ValueError on indexing which we ignore. This could happen when indexing a binary file with a bad mime type. On find, it throws a ProgrammingError that we remap to IndexerQueryError and pass up. If a null gets to that level on search somebody entered it (not sure how you could actually do that) but we want a crash in that case as the person is probably up to "no good" (R) (TM). """ import psycopg2 string="\x00\x01fred\x255" self.dex.add_text(('test', '1', 'a'), string) with self.assertRaises(IndexerQueryError) as ctx: self.assertSeqEqual(self.dex.find(string), []) self.assertIn("null", ctx.exception.args[0]) @skip_mysql class mysqlIndexerTest(mysqlOpener, RDBMSIndexerTest, IndexerTest): def setUp(self): mysqlOpener.setUp(self) RDBMSIndexerTest.setUp(self) def tearDown(self): RDBMSIndexerTest.tearDown(self) mysqlOpener.tearDown(self) class sqliteIndexerTest(sqliteOpener, RDBMSIndexerTest, IndexerTest): pass class sqliteFtsIndexerTest(sqliteOpener, RDBMSIndexerTest, IndexerTest): indexer_name = "native-fts" def setUp(self): RDBMSIndexerTest.setUp(self) from roundup.backends.indexer_sqlite_fts import Indexer self.dex = Indexer(self.db) self.dex.db = self.db def test_phrase_and_near(self): self.dex.add_text(('test', '1', 'foo'), 'a the hello world') self.dex.add_text(('test', '2', 'foo'), 'helh blah blah the world') self.dex.add_text(('test', '3', 'foo'), 'blah hello the world') self.dex.add_text(('test', '4', 'foo'), 'hello blah blech the world') # test two separate words for sanity self.assertSeqEqual(self.dex.find(['"hello" "world"']), [('test', '1', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo') ]) # now check the phrase self.assertSeqEqual(self.dex.find(['"hello world"']), [('test', '1', 'foo'), ]) # now check the phrase with near explicitly 0 intervening items self.assertSeqEqual(self.dex.find(['NEAR(hello world, 0)']), [('test', '1', 'foo'), ]) # now check the phrase with near explicitly 1 intervening item self.assertSeqEqual(self.dex.find(['NEAR(hello world, 1)']), [('test', '1', 'foo'), ('test', '3', 'foo'), ]) # now check the phrase with near explicitly 3 intervening item self.assertSeqEqual(self.dex.find(['NEAR(hello world, 3)']), [('test', '1', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo'), ]) def test_prefix(self): self.dex.add_text(('test', '1', 'foo'), 'a the hello world') self.dex.add_text(('test', '2', 'foo'), 'helh blah blah the world') self.dex.add_text(('test', '3', 'foo'), 'blah hello the world') self.dex.add_text(('test', '4', 'foo'), 'hello blah blech the world') self.assertSeqEqual(self.dex.find(['hel*']), [('test', '1', 'foo'), ('test', '2', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo') ]) def test_bool_start(self): self.dex.add_text(('test', '1', 'foo'), 'a the hello world') self.dex.add_text(('test', '2', 'foo'), 'helh blah blah the world') self.dex.add_text(('test', '3', 'foo'), 'blah hello the world') self.dex.add_text(('test', '4', 'foo'), 'hello blah blech the world') self.assertSeqEqual(self.dex.find(['hel* NOT helh NOT blech']), [('test', '1', 'foo'), ('test', '3', 'foo'), ]) self.assertSeqEqual(self.dex.find(['hel* NOT helh NOT blech OR the']), [('test', '1', 'foo'), ('test', '2', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo'), ]) self.assertSeqEqual(self.dex.find(['helh OR hello']), [('test', '1', 'foo'), ('test', '2', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo'), ]) self.assertSeqEqual(self.dex.find(['helh AND hello']), []) # matches if line starts with hello self.assertSeqEqual(self.dex.find(['^hello']), [ ('test', '4', 'foo'), ]) self.assertSeqEqual(self.dex.find(['hello']), [ ('test', '1', 'foo'), ('test', '3', 'foo'), ('test', '4', 'foo'), ]) def test_query_errors(self): """test query phrases that generate an error. Also test the correction""" self.dex.add_text(('test', '1', 'foo'), 'a the hello-world') self.dex.add_text(('test', '2', 'foo'), 'helh blah blah the world') self.dex.add_text(('test', '3', 'foo'), 'blah hello the world') self.dex.add_text(('test', '4', 'foo'), 'hello blah blech the world') # handle known error that roundup recognizes and tries to diagnose with self.assertRaises(IndexerQueryError) as ctx: self.dex.find(['the hello-world']) error = ( "Search failed. Try quoting any terms that include a '-' " "and retry the search.") self.assertEqual(str(ctx.exception), error) self.assertSeqEqual(self.dex.find(['the "hello-world"']), [('test', '1', 'foo'), ]) # handle known error that roundup recognizes and tries to diagnose with self.assertRaises(IndexerQueryError) as ctx: self.dex.find(['hello world + ^the']) error = 'Query error: syntax error near "^"' self.assertEqual(str(ctx.exception), error) def testNullChar(self): """Test with null char in string. FTS will throw an error on null. """ string="\x00\x01fred\x255" self.dex.add_text(('test', '1', 'a'), string) with self.assertRaises(IndexerQueryError) as cm: self.assertSeqEqual(self.dex.find(string), []) # vim: set filetype=python ts=4 sw=4 et si code-e5bd50120b5a/test/test_init.py0000644000000000000000000000175515064275501015263 0ustar 00000000000000#-*- encoding: utf-8 -*- import unittest, os, pprint, difflib, textwrap from roundup.init import loadTemplateInfo class TemplateInfoTestCase(unittest.TestCase): def testLoadTemplateInfo(self): path = os.path.join(os.path.dirname(__file__), '../share/roundup/templates/classic') self.maxDiff = None self.assertEqual( loadTemplateInfo(path), { 'description': textwrap.dedent('''\ This is a generic issue tracker that may be used to track bugs, feature requests, project issues or any number of other types of issues. Most users of Roundup will find that this template suits them, with perhaps a few customisations.'''), 'intended-for': 'All first-time Roundup users', 'name': 'classic', 'path': path } ) # vim: set et sts=4 sw=4 : code-e5bd50120b5a/test/test_instance.py0000644000000000000000000000227615064275501016123 0ustar 00000000000000# # Copyright (C) 2020 John Rouillard # All rights reserved. # For license terms see the file COPYING.txt. # from __future__ import print_function import unittest, os, shutil, errno, sys, difflib from roundup import instance from roundup.instance import TrackerError try: # python2 import pathlib2 as pathlib except ImportError: # python3 import pathlib from . import db_test_base class InstanceTest(unittest.TestCase): backend = 'anydbm' def setUp(self): self.dirname = '_test_instance' # set up and open a tracker self.instance = db_test_base.setupTracker(self.dirname, self.backend) # open the database self.db = self.instance.open('admin') self.db.commit() self.db.close() def tearDown(self): if self.db: self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def testOpenOldStyle(self): pathlib.Path(os.path.join(self.dirname, "dbinit.py")).touch() # no longer support old style tracker configs self.assertRaises(TrackerError, instance.open, self.dirname) code-e5bd50120b5a/test/test_jinja2.py0000644000000000000000000000336015064275501015467 0ustar 00000000000000#-*- encoding: utf-8 -*- """ Testing the jinja2 templating engine of roundup-tracker. Copyright: 2016 Intevation GmbH. Author: Bernhard E. Reiter This module is Free Software under the Roundup licensing of 1.5, see the COPYING.txt file coming with Roundup. Just a test file template for now. """ import shutil # only, needed for tearDown. TODO: Remove when refactored. import unittest from . import db_test_base TESTSUITE_IDENTIFIER='jinja2' class TestCase_Zero(unittest.TestCase): def test_zero(self): self.assertEqual(True, True) class Jinja2Test(object): """Sets up and tears down an instance with database contents. Setup and teardown modelled after the use of db_test_base by several modules like test_xmlrpc and test_userauditor. TODO: Should probably be moved to a base case in db_test_base.py. """ backend = None # can be used to create tests per backend, see test_xmlrpc def setUp(self): self.dirname = '_test_' + TESTSUITE_IDENTIFIER self.instance = db_test_base.setupTracker(self.dirname, self.backend) self.db = self.instance.open('admin') def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def test_zero(self): """Do nothing just make sure that setup and teardown works.""" pass # only using one database backend for now, not sure if doing all # backends will keep the test focussed enough to be useful for the used # computing time. Would be okay to change in the future. class anydbmJinja2Test(Jinja2Test, unittest.TestCase): backend = 'anydbm' # vim: ts=4 et sts=4 sw=4 ai : code-e5bd50120b5a/test/test_liveserver.py0000644000000000000000000026111115064275501016500 0ustar 00000000000000# -*- coding: utf-8 -*- import shutil, errno, pytest, json, gzip, mimetypes, os, re from roundup import date as rdate from roundup import i18n from roundup import password from roundup.anypy.strings import b2s, s2b from roundup.cgi.wsgi_handler import RequestDispatcher from .wsgi_liveserver import LiveServerTestCase from . import db_test_base from textwrap import dedent from time import sleep from .test_postgresql import skip_postgresql from wsgiref.validate import validator try: import requests skip_requests = lambda func, *args, **kwargs: func except ImportError: from .pytest_patcher import mark_class skip_requests = mark_class(pytest.mark.skip( reason='Skipping liveserver tests: requests library not available')) try: import hypothesis skip_hypothesis = lambda func, *args, **kwargs: func # ruff: noqa: E402 from hypothesis import example, given, reproduce_failure, settings from hypothesis.strategies import binary, characters, emails, none, one_of, sampled_from, text except ImportError: from .pytest_patcher import mark_class skip_hypothesis = mark_class(pytest.mark.skip( reason='Skipping hypothesis liveserver tests: hypothesis library not available')) # define a dummy decorator that can take args def noop_decorators_with_args(*args, **kwargs): def noop_decorators(func): def internal(): pass return internal return noop_decorators # define a dummy strategy def noop_strategy(*args, **kwargs): pass # define the decorator functions example = given = reproduce_failure = settings = noop_decorators_with_args # and stratgies using in decorators binary = characters = emails = none = one_of = sampled_from = text = noop_strategy try: import brotli skip_brotli = lambda func, *args, **kwargs: func except ImportError: from .pytest_patcher import mark_class skip_brotli = mark_class(pytest.mark.skip( reason='Skipping brotli tests: brotli library not available')) brotli = None try: import zstd skip_zstd = lambda func, *args, **kwargs: func except ImportError: from .pytest_patcher import mark_class skip_zstd = mark_class(pytest.mark.skip( reason='Skipping zstd tests: zstd library not available')) import sys _py3 = sys.version_info[0] > 2 @skip_requests class WsgiSetup(LiveServerTestCase): # have chicken and egg issue here. Need to encode the base_url # in the config file but we don't know it until after # the server is started and has read the config.ini. # Probe for an unused port and set the port range to # include only that port. tracker_port = LiveServerTestCase.probe_ports(8080, 8100) if tracker_port is None: pytest.skip("Unable to find available port for server: 8080-8100", allow_module_level=True) port_range = (tracker_port, tracker_port) # set a couple of properties to use for URL generation in # expected output or use to set TRACKER_WEB in config.ini. tracker_web = "http://localhost:%d/" % tracker_port # tracker_web_base should be the same as self.base_url() tracker_web_base = "http://localhost:%d" % tracker_port dirname = '_test_instance' backend = 'anydbm' js_mime_type = mimetypes.guess_type("utils.js")[0] @classmethod def setup_class(cls): '''All tests in this class use the same roundup instance. This instance persists across all tests. Create the tracker dir here so that it is ready for the create_app() method to be called. ''' # tests in this class. # set up and open a tracker cls.instance = db_test_base.setupTracker(cls.dirname, cls.backend) # add an auditor that triggers a Reauth with open("%s/detectors/reauth.py" % cls.dirname, "w") as f: auditor = dedent(""" from roundup.cgi.exceptions import Reauth def trigger_reauth(db, cl, nodeid, newvalues): if 'realname' in newvalues and not hasattr(db, 'reauth_done'): raise Reauth('Add an optional message to the user') def init(db): db.user.audit('set', trigger_reauth, priority=110) """) f.write(auditor) # open the database cls.db = cls.instance.open('admin') # add a user without edit access for status. cls.db.user.create(username="fred", roles='User', password=password.Password('sekrit'), address='fred@example.com') # add a user for reauth tests cls.db.user.create(username="reauth", realname="reauth test user", password=password.Password("reauth"), address="reauth@example.com", roles="User") # set the url the test instance will run at. cls.db.config['TRACKER_WEB'] = cls.tracker_web # set up mailhost so errors get reported to debuging capture file cls.db.config.MAILHOST = "localhost" cls.db.config.MAIL_HOST = "localhost" cls.db.config.MAIL_DEBUG = "../_test_tracker_mail.log" # also report it in the web. cls.db.config.WEB_DEBUG = "yes" # added to enable csrf forgeries/CORS to be tested cls.db.config.WEB_CSRF_ENFORCE_HEADER_ORIGIN = "required" cls.db.config.WEB_ALLOWED_API_ORIGINS = "https://client.com" cls.db.config['WEB_CSRF_ENFORCE_HEADER_X-REQUESTED-WITH'] = "required" # disable web login rate limiting. The fast rate of tests # causes them to trip the rate limit and fail. cls.db.config.WEB_LOGIN_ATTEMPTS_MIN = 0 # enable static precompressed files cls.db.config.WEB_USE_PRECOMPRESSED_FILES = 1 cls.db.config.save() # add an issue to allow testing retrieval. # also used for text searching. result = cls.db.issue.create(title="foo bar RESULT") # add a message to allow retrieval result = cls.db.msg.create(author = "1", content = "a message foo bar RESULT", date=rdate.Date(), messageid="test-msg-id") # add a query using @current_user result = cls.db.query.create( klass="issue", name="I created", private_for=None, url=("@columns=title,id,activity,status,assignedto&" "@sort=activity&@group=priority&@filter=creator&" "@pagesize=50&@startwith=0&creator=%40current_user") ) cls.db.commit() cls.db.close() # Force locale config to find locales in checkout not in # installed directories cls.backup_domain = i18n.DOMAIN cls.backup_locale_dirs = i18n.LOCALE_DIRS i18n.LOCALE_DIRS = ['locale'] i18n.DOMAIN = '' @classmethod def teardown_class(cls): '''Close the database and delete the tracker directory now that the app should be exiting. ''' if cls.db: cls.db.close() try: shutil.rmtree(cls.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise i18n.LOCALE_DIRS = cls.backup_locale_dirs i18n.DOMAIN = cls.backup_domain def create_app(self): '''The wsgi app to start - no feature_flags set. Post 2.3.0 this enables the cache_tracker feature. ''' if _py3: return validator(RequestDispatcher(self.dirname)) else: # wsgiref/validator.py InputWrapper::readline is broke and # doesn't support the max bytes to read argument. return RequestDispatcher(self.dirname) class ClientSetup(): """ Utility programs for the client querying a server. Just a login session at the moment but more to come I am sure. """ def create_login_session(self, username="admin", password="sekrit", return_response=True, expect_login_ok=True): # Set up session to manage cookies session = requests.Session() session.headers.update({'Origin': self.tracker_web_base}) # login using form to get cookie login = {"__login_name": username, '__login_password': password, "@action": "login"} response = session.post(self.url_base()+'/', data=login) if expect_login_ok: # verify we have a cookie self.assertIn('roundup_session_Roundupissuetracker', session.cookies) if not return_response: return session return session, response @skip_hypothesis class FuzzGetUrls(WsgiSetup, ClientSetup): _max_examples = 100 # Timeout for each fuzz test in ms. Use env variable in local # pytest.ini if your dev environment can't complete in the default # 10 seconds. fuzz_deadline = int(os.environ.get('pytest_fuzz_timeout', 0)) or 10000 @given(sampled_from(['@verbose', '@page_size', '@page_index']), text(min_size=1)) @example("@verbose", "0\r#") @example("@verbose", "1#") @example("@verbose", "#1stuff") @example("@verbose", "0 #stuff") @settings(max_examples=_max_examples, deadline=fuzz_deadline) # in ms def test_class_url_param_accepting_integer_values(self, param, value): """Tests all integer args for rest url. @page_* is the same code for all *. """ session, _response = self.create_login_session() url = '%s/rest/data/status' % (self.url_base()) query = '%s=%s' % (param, value) f = session.get(url, params=query) try: # test case '0 #', '0#', '12345#stuff' '12345&stuff' # Normalize like a server does by breaking value at # # or & as these mark a fragment or subsequent # query arg and are not part of the value. match = re.match(r'^(.*)[#&]', value) if match is not None: value = match[1] # parameter is ignored by server if empty. # so set it to 0 to force 200 status code. if value == "": value = "0" if int(value) >= 0: self.assertEqual(f.status_code, 200) except ValueError: # test case '#' '#0', '&', '&anything here really' if value[0] in ('#', '&'): self.assertEqual(f.status_code, 200) else: # invalid value for param self.assertEqual(f.status_code, 400) @given(sampled_from(['@verbose']), text(min_size=1)) @example("@verbose", "0\r#") @example("@verbose", "10#") @example("@verbose", u'Ø\U000dd990') @settings(max_examples=_max_examples, deadline=fuzz_deadline) # in ms def test_element_url_param_accepting_integer_values(self, param, value): """Tests args accepting int for rest url. """ session, _response = self.create_login_session() url = '%s/rest/data/status/1' % (self.url_base()) query = '%s=%s' % (param, value) f = session.get(url, params=query) try: # test case '0#' '12345#stuff' '12345&stuff' # Normalize like a server does by breaking value at # # or & as these mark a fragment or subsequent # query arg and are not part of the value. match = re.match(r'^(.*)[#&]', value) if match is not None: value = match[1] # parameter is ignored by server if empty. # so set it to 0 to force 200 status code. if value == "": value = "0" if int(value) >= 0: self.assertEqual(f.status_code, 200) except ValueError: # test case '#' '#0', '&', '&anything here really' if value[0] in ('#', '&'): self.assertEqual(f.status_code, 200) else: # invalid value for param self.assertEqual(f.status_code, 400) @skip_hypothesis class FuzzTestSettingData(WsgiSetup, ClientSetup): _max_examples = 100 # Timeout for each fuzz test in ms. Use env variable in local # pytest.ini if your dev environment can't complete in the default # 10 seconds. fuzz_deadline = int(os.environ.get('pytest_fuzz_timeout', 0)) or 10000 @given(emails()) @settings(max_examples=_max_examples, deadline=fuzz_deadline) # in ms def test_setting_email_param(self,email): session, _response = self.create_login_session() url = '%s/rest/data/user/1/address' % (self.url_base()) headers = {"Accept": "application/json", "Content-Type": "application/json", "x-requested-with": "rest", "Origin": self.url_base(), "Referer": self.url_base() } #--header 'If-Match: "e2e6cc43c3475a4a3d9e5343617c11c3"' \ f = session.get(url) stored_email = f.json()['data']['data'] headers['If-Match'] = f.headers['etag'] payload = {'data': email} f = session.put(url, json=payload, headers=headers) self.assertEqual(f.status_code, 200) if stored_email == email: # if the email we are setting is the same as present, we # don't make a change so the attribute dict is empty aka false. self.assertEqual(f.json()['data']['attribute'], {}) else: self.assertEqual(f.json()['data']['attribute']['address'], email) @skip_requests class BaseTestCases(WsgiSetup, ClientSetup): """Class with all tests to run against wsgi server. Is reused when wsgi server is started with various feature flags """ def test_reauth_workflow(self): """as admin user: change reauth user realname include all fields on the form also add a dummy file to the submitted request. get back a reauth page/template (look for id="reauth_form") verify hidden input for realname verify hidden input for roles verify the base 64 file content are on the page. submit form with bad password verify error reported verify hidden input for realname (note the file contents will be gone because preserving that requires javascript) enter good password verify on user page (look for "(the default is" hint for timezone) verify new name present verify success banner """ from html.parser import HTMLParser class HTMLExtractForm(HTMLParser): """Custom parser to extract input fields from a form. Set the form_label to extract inputs only inside a form with a name or id matching form_label. Default is "reauth_form". Set names to a tuple/list/set with the names of the inputs you are interested in. Defalt is None which extracts all inputs on the page with a name property. """ def __init__(self, names=None, form_label="reauth_form"): super().__init__() self.fields = {} self.names = names self.form_label = form_label self._inside_form = False def handle_starttag(self, tag, attrs): if tag == 'form': for attr, value in attrs: if attr in ('id', 'name') and value == self.form_label: self._inside_form = True return if not self._inside_form: return if tag == 'input': field_name = None field_value = None for attr, value in attrs: if attr == 'name': field_name = value if attr == 'value': field_value = value # skip input type="submit" without name if not field_name: return if self.names is None: self.fields[field_name] = field_value elif field_name in self.names: self.fields[field_name] = field_value def handle_endtag(self, tag): if tag == "form": self._inside_form = False def get_fields(self): return self.fields # for some reason the lookup works with anydbm but # returns a cursor closed error under postgresql. # adding setup/teardown to TestPostgresWsgiServer # with self.db = self.instance.open('admin') looks like # it caused the wsgi server to hang. So hardcode the id. # self.db.user.lookup('reauth') reauth_id = '4' user_url = "%s/user%s" % (self.url_base(), reauth_id) session, _response = self.create_login_session() user_page = session.get(user_url) self.assertEqual(user_page.status_code, 200) self.assertTrue(b'reauth' in user_page.content) parser = HTMLExtractForm(('@lastactivity', '@csrf'), 'itemSynopsis') parser.feed(user_page.text) change = {"realname": "reauth1", "username": "reauth", "password": "", "@confirm@password": "", "phone": "", "organisation": "", "roles": "User", "timezone": "", "address": "reauth@example.com", "alternate_addresses": "", "@template": "item", "@required": "username,address", "@submit_button": "Submit Changes", "@action": "edit", **parser.get_fields() } lastactivity = parser.get_fields()['@lastactivity'] # make the simple name/value dict into a name/tuple dict # setting tuple[0] to None to indicate pulre string # value. Then we use change2 with file to trigger # multipart/form-data form encoding which preserves fields # with empty values. application/x-www-form-urlencoded forms # have fields with empty values dropped by cgi by default. userpage_change = {key: (None, value) for key, value in change.items()} userpage_change.update({"@file": ("filename.txt", "this is some text")}) on_reauth = session.post(user_url, files=userpage_change) self.assertIn(b'id="reauth_form"', on_reauth.content) self.assertIn(b'Please enter your password to continue with', on_reauth.content) # make sure the base64 encoded content for @file is present on # the page. Because we are not running a javascript capable # browser, it is not converted into an actual file input. # But this check shows that a file generated by reauth is trying # to maintain the file input. self.assertIn(b'dGhpcyBpcyBzb21lIHRleHQ=', on_reauth.content) parser = HTMLExtractForm() parser.feed(on_reauth.text) fields = parser.get_fields() self.assertEqual(fields["@lastactivity"], lastactivity) self.assertEqual(fields["@next_action"], "edit") self.assertEqual(fields["@action"], "reauth") self.assertEqual(fields["address"], "reauth@example.com") self.assertEqual(fields["phone"], "") self.assertEqual(fields["roles"], "User") self.assertEqual(fields["realname"], "reauth1") reauth_fields = { "@reauth_password": (None, "sekret not right"), "submit": (None, " Authorize Change "), } reauth_submit = {key: (None, value) for key, value in fields.items()} reauth_submit.update(reauth_fields) fail_reauth = session.post(user_url, files=reauth_submit) self.assertIn(b'id="reauth_form"', fail_reauth.content) self.assertIn(b'Please enter your password to continue with', fail_reauth.content) self.assertIn(b'Password incorrect', fail_reauth.content) parser = HTMLExtractForm(('@csrf',)) parser.feed(fail_reauth.text) # remeber we are logged in as admin - use admin pw. reauth_submit.update({"@reauth_password": (None, "sekrit"), "@csrf": (None, parser.get_fields()['@csrf'])}) pass_reauth = session.post(user_url, files=reauth_submit) self.assertNotIn(b'id="reauth_form"', pass_reauth.content) self.assertNotIn(b'Please enter your password to continue with', pass_reauth.content) self.assertIn(b'user %s realname edited ok' % s2b(reauth_id), pass_reauth.content) self.assertIn(b'(the default is', pass_reauth.content) def test_cookie_attributes(self): session, _response = self.create_login_session() cookie_box = session.cookies._cookies['localhost.local']['/'] cookie = cookie_box['roundup_session_Roundupissuetracker'] # check cookie attributes. This is an http session, so # we can't check secure or see cookie with __Secure- prefix 8-(. self.assertEqual(cookie.name, 'roundup_session_Roundupissuetracker') self.assertEqual(cookie.expires, None) # session cookie self.assertEqual(cookie._rest['HttpOnly'], None) # flag is present self.assertEqual(cookie._rest['SameSite'], 'Lax') def test_bad_post_data(self): """issue2551387 - bad post data causes TypeError: not indexable """ session, _response = self.create_login_session() h = {"Content-Type": "text/plain"} response = session.post(self.url_base()+'/', headers=h, data="test") print(response.status_code) print(response.headers) print(response.text) self.assertEqual(response.status_code, 200) def test_query(self): current_user_query = ( "@columns=title,id,activity,status,assignedto&" "@sort=activity&@group=priority&@filter=creator&" "@pagesize=50&@startwith=0&creator=%40current_user&" "@dispname=Test1") session, _response = self.create_login_session() f = session.get(self.url_base()+'/issue?' + current_user_query) # verify the query has run by looking for the query name self.assertIn('List of issues\n - Test1', f.text) # find title of issue 1 self.assertIn('foo bar RESULT', f.text) # match footer "1..1 out of 1" if issue is found self.assertIn('out of', f.text) # logout f = session.get(self.url_base()+'/?@action=logout') # set up for another user session, _response = self.create_login_session(username="fred") f = session.get(self.url_base()+'/issue?' + current_user_query) # verify the query has run self.assertIn('List of issues\n - Test1', f.text) # We should have no rows, so verify the static part # of the footer is missing. self.assertNotIn('out of', f.text) def test_broken_query(self): # query link item current_user_query = ( "@columns=title,id,activity,status,assignedto&" "@sort=activity&@group=priority&@filter=creator&" "@pagesize=50&@startwith=0&creator=-2&" "@dispname=Test1") session, _response = self.create_login_session() f = session.get(self.url_base()+'/issue?' + current_user_query) # verify the query has run by looking for the query name # print(f.text) self.assertIn('There was an error searching issue by creator using: ' '[-2]. The operator -2 (not) at position 1 has ' 'too few arguments.', f.text) self.assertEqual(f.status_code, 200) def test_broken_multiink_query(self): # query multilink item current_user_query = ( "@columns=title,id,activity,status,assignedto" "&keyword=-3&@sort=activity&@group=priority" "&@pagesize=50&@startwith=0&@template=index|search" "&@action=search") session, _response = self.create_login_session() f = session.get(self.url_base()+'/issue?' + current_user_query) # verify the query has run by looking for the query name print(f.text) self.assertIn('There was an error searching issue by keyword using: ' '[-3]. The operator -3 (and) at position 1 has ' 'too few arguments.', f.text) self.assertEqual(f.status_code, 200) def test_start_page(self): """ simple test that verifies that the server can serve a start page. """ f = requests.get(self.url_base()) self.assertEqual(f.status_code, 200) self.assertTrue(b'Roundup' in f.content) self.assertTrue(b'Creator' in f.content) def test_start_in_german(self): """ simple test that verifies that the server can serve a start page and translate text to german. Use page title and remeber login checkbox label as translation test points.. use: url parameter @language cookie set by param set @language to none and verify language cookie is unset """ # test url parameter f = requests.get(self.url_base() + "?@language=de") self.assertEqual(f.status_code, 200) print(f.content) self.assertTrue(b'Roundup' in f.content) self.assertTrue(b'Aufgabenliste' in f.content) self.assertTrue(b'dauerhaft anmelden?' in f.content) # test language cookie - should still be german bluemonster = f.cookies f = requests.get(self.url_base(), cookies=bluemonster) self.assertEqual(f.status_code, 200) print(f.content) self.assertTrue(b'Roundup' in f.content) self.assertTrue(b'Aufgabenliste' in f.content) self.assertTrue(b'dauerhaft anmelden?' in f.content) # unset language cookie, should be english f = requests.get(self.url_base() + "?@language=none") self.assertEqual(f.status_code, 200) print(f.content) self.assertTrue(b'Roundup' in f.content) self.assertFalse(b'Aufgabenliste' in f.content) self.assertFalse(b'dauerhaft anmelden?' in f.content) with self.assertRaises(KeyError): l = f.cookies['roundup_language'] # check with Accept-Language header alh = {"Accept-Language": "fr;q=0.2, en;q=0.8, de;q=0.9, *;q=0.5"} f = requests.get(self.url_base(), headers=alh) self.assertEqual(f.status_code, 200) print(f.content) self.assertTrue(b'Roundup' in f.content) self.assertTrue(b'Aufgabenliste' in f.content) self.assertTrue(b'dauerhaft anmelden?' in f.content) def test_classhelper_reflection(self): """ simple test that verifies that the generic classhelper is escaping the url params correctly. """ f = requests.get(self.url_base() + "/keyword?@startwith=0&@template=help&properties=name&property=keyword&form=itemSynopsis\n", f.content) def test_byte_Ranges(self): """ Roundup only handles one simple two number range, or a single number to start from: Range: 10-20 Range: 10- The following is not supported. Range: 10-20, 25-30 Range: -10 Also If-Range only supports strong etags not dates or weak etags. """ # get whole file uncompressed. Extract content length and etag # for future use f = requests.get(self.url_base() + "/@@file/style.css", headers = {"Accept-Encoding": "identity"}) # store etag for condition range testing etag = f.headers['etag'] expected_length = f.headers['content-length'] # get first 11 bytes unconditionally (0 index really??) hdrs = {"Range": "bytes=0-10"} f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 206) self.assertEqual(f.content, b"/* main pag") # compression disabled for length < 100, so we can use 11 here self.assertEqual(f.headers['content-length'], '11') self.assertEqual(f.headers['content-range'], "bytes 0-10/%s"%expected_length) # get bytes 11-21 unconditionally (0 index really??) hdrs = {"Range": "bytes=10-20"} f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 206) self.assertEqual(f.content, b"ge styles *") # compression disabled for length < 100, so we can use 11 here self.assertEqual(f.headers['content-length'], '11') self.assertEqual(f.headers['content-range'], "bytes 10-20/%s"%expected_length) # get all bytes starting from 11 hdrs = {"Range": "bytes=11-"} f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 206) self.assertEqual(f.headers['content-range'], "bytes 11-%s/%s"%(int(expected_length) - 1, expected_length)) self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # conditional request 11 bytes since etag matches 206 code hdrs = {"Range": "bytes=0-10"} hdrs['If-Range'] = etag f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 206) self.assertEqual(f.content, b"/* main pag") # compression disabled for length < 100, so we can use 11 here self.assertEqual(f.headers['content-length'], '11') self.assertEqual(f.headers['content-range'], "bytes 0-10/%s"%expected_length) # conditional request returns all bytes as etag isn't correct 200 code hdrs['If-Range'] = etag[2:] # bad tag f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) # not checking content length since it could be compressed self.assertNotIn('content-range', f.headers, 'content-range should not be present') # range is too large, but etag is bad also, return whole file 200 code hdrs['Range'] = "0-99999" # too large hdrs['If-Range'] = '"' + etag[2:] # start bad tag with " f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) # note f.content has content-encoding (compression) undone. self.assertEqual(len(f.content), int(expected_length)) self.assertNotIn('content-range', f.headers, 'content-range should not be present') # range is too large, but etag is specified so return whole file # 200 code hdrs['Range'] = "bytes=0-99999" # too large hdrs['If-Range'] = etag # any tag works f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) # not checking content length since it could be compressed self.assertNotIn('content-range', f.headers, 'content-range should not be present') # range too large, not if-range so error code 416 hdrs['Range'] = "bytes=0-99999" # too large del(hdrs['If-Range']) print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 416) self.assertEqual(f.headers['content-range'], "bytes */%s"%expected_length) # invalid range multiple ranges hdrs['Range'] = "bytes=0-10, 20-45" print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) self.assertNotIn('content-range', f.headers, 'content-range should not be present') self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # invalid range is single number not number followed by - hdrs['Range'] = "bytes=1" print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) self.assertNotIn('content-range', f.headers, 'content-range should not be present') self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # range is invalid first number not a number hdrs['Range'] = "bytes=boom-99" # bad first value print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) self.assertNotIn('content-range', f.headers, 'content-range should not be present') self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # range is invalid last number not a number hdrs['Range'] = "bytes=1-boom" # bad last value print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) self.assertNotIn('content-range', f.headers, 'content-range should not be present') self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # range is invalid first position empty hdrs['Range'] = "bytes=-11" # missing first value print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) self.assertNotIn('content-range', f.headers, 'content-range should not be present') self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # range is invalid #2 < #1 hdrs['Range'] = "bytes=11-1" # inverted range print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) self.assertNotIn('content-range', f.headers, 'content-range should not be present') self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # range is invalid negative first number hdrs['Range'] = "bytes=-1-11" # negative first number print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) self.assertNotIn('content-range', f.headers, 'content-range should not be present') self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # range is invalid negative second number hdrs['Range'] = "bytes=1--11" # negative second number print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) self.assertNotIn('content-range', f.headers, 'content-range should not be present') self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # range is unsupported units hdrs['Range'] = "badunits=1-11" print(hdrs) f = requests.get(self.url_base() + "/@@file/style.css", headers=hdrs) self.assertEqual(f.status_code, 200) self.assertNotIn('content-range', f.headers, 'content-range should not be present') self.assertIn(b"SHA:", f.content) # detect sha sum at end of file # valid range, invalid file hdrs['Range'] = "bytes=0-11" print(hdrs) f = requests.get(self.url_base() + "/@@file/style_nope.css", headers=hdrs) self.assertEqual(f.status_code, 404) self.assertNotIn('content-range', f.headers, 'content-range should not be present') def test_rest_preflight_collection(self): # no auth for rest csrf preflight f = requests.options(self.url_base() + '/rest/data/user', headers = {'content-type': "", 'x-requested-with': "rest", 'Access-Control-Request-Headers': "x-requested-with", 'Access-Control-Request-Method': "PUT", 'Origin': "https://client.com"}) print(f.status_code) print(f.headers) print(f.content) self.assertEqual(f.status_code, 204) expected = { 'Access-Control-Allow-Origin': 'https://client.com', 'Access-Control-Allow-Headers': 'Content-Type, Authorization, X-Requested-With, X-HTTP-Method-Override', 'Allow': 'OPTIONS, GET, POST', 'Access-Control-Allow-Methods': 'OPTIONS, GET, POST', 'Access-Control-Allow-Credentials': 'true', } # use dict comprehension to filter headers to the ones we want to check self.assertEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # use invalid Origin f = requests.options(self.url_base() + '/rest/data/user', headers = {'content-type': "application/json", 'x-requested-with': "rest", 'Access-Control-Request-Headers': "x-requested-with", 'Access-Control-Request-Method': "PUT", 'Origin': "ZZZ"}) self.assertEqual(f.status_code, 400) expected = '{ "error": { "status": 400, "msg": "Client is not ' \ 'allowed to use Rest Interface." } }' self.assertEqual(b2s(f.content), expected) # Test when Origin is not sent. f = requests.options(self.url_base() + '/rest/data/user', headers = {'content-type': "application/json", 'x-requested-with': "rest", 'Access-Control-Request-Headers': "x-requested-with", 'Access-Control-Request-Method': "PUT",}) self.assertEqual(f.status_code, 403) expected = ('{ "error": { "status": 403, "msg": "Forbidden." } }') self.assertEqual(b2s(f.content), expected) def test_rest_invalid_method_collection(self): # use basic auth for rest endpoint f = requests.put(self.url_base() + '/rest/data/user', auth=('admin', 'sekrit'), headers = {'content-type': "", 'X-Requested-With': "rest", 'Origin': "https://client.com"}) print(f.status_code) print(f.headers) print(f.content) self.assertEqual(f.status_code, 405) expected = { 'Access-Control-Allow-Origin': 'https://client.com', 'Access-Control-Allow-Credentials': 'true', 'Allow': 'DELETE, GET, OPTIONS, POST', } print(f.headers) # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) content = json.loads(f.content) exp_content = "Method PUT not allowed. Allowed: DELETE, GET, OPTIONS, POST" self.assertEqual(exp_content, content['error']['msg']) def test_http_options(self): """ options returns an unimplemented error for this case.""" # do not send content-type header for options f = requests.options(self.url_base() + '/', headers = {'content-type': ""}) # options is not implemented for the non-rest interface. self.assertEqual(f.status_code, 501) def test_rest_endpoint_root_options(self): # use basic auth for rest endpoint f = requests.options(self.url_base() + '/rest', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Origin': self.tracker_web_base, }) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 204) expected = { 'Access-Control-Allow-Origin': self.tracker_web_base, 'Access-Control-Allow-Headers': 'Content-Type, Authorization, X-Requested-With, X-HTTP-Method-Override', 'Allow': 'OPTIONS, GET', 'Access-Control-Allow-Credentials': 'true', 'Access-Control-Allow-Methods': 'OPTIONS, GET', 'Access-Control-Allow-Credentials': 'true', } # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) def test_rest_endpoint_data_options(self): # use basic auth for rest endpoint f = requests.options(self.url_base() + '/rest/data', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Origin': self.tracker_web_base, }) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 204) expected = { 'Access-Control-Allow-Origin': self.tracker_web_base, 'Access-Control-Allow-Headers': 'Content-Type, Authorization, X-Requested-With, X-HTTP-Method-Override', 'Allow': 'OPTIONS, GET', 'Access-Control-Allow-Methods': 'OPTIONS, GET', 'Access-Control-Allow-Credentials': 'true', } # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) def test_rest_endpoint_collection_options(self): # use basic auth for rest endpoint f = requests.options(self.url_base() + '/rest/data/user', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Origin': self.tracker_web_base, }) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 204) expected = { 'Access-Control-Allow-Origin': self.tracker_web_base, 'Access-Control-Allow-Headers': 'Content-Type, Authorization, X-Requested-With, X-HTTP-Method-Override', 'Allow': 'OPTIONS, GET, POST', 'Access-Control-Allow-Methods': 'OPTIONS, GET, POST', 'Access-Control-Allow-Credentials': 'true', } # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) def test_rest_endpoint_item_options(self): f = requests.options(self.url_base() + '/rest/data/user/1', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Origin': self.tracker_web_base, }) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 204) expected = { 'Access-Control-Allow-Origin': self.tracker_web_base, 'Access-Control-Allow-Headers': 'Content-Type, Authorization, X-Requested-With, X-HTTP-Method-Override', 'Allow': 'OPTIONS, GET, PUT, DELETE, PATCH', 'Access-Control-Allow-Methods': 'OPTIONS, GET, PUT, DELETE, PATCH', 'Access-Control-Allow-Credentials': 'true', } # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) def test_rest_endpoint_attribute_options(self): # use basic auth for rest endpoint f = requests.options(self.url_base() + '/rest/data/user/1/username', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Origin': self.tracker_web_base, }) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 204) expected = { 'Access-Control-Allow-Origin': self.tracker_web_base, 'Access-Control-Allow-Headers': 'Content-Type, Authorization, X-Requested-With, X-HTTP-Method-Override', 'Allow': 'OPTIONS, GET, PUT, DELETE, PATCH', 'Access-Control-Allow-Methods': 'OPTIONS, GET, PUT, DELETE, PATCH', 'Access-Control-Allow-Credentials': 'true', } # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) ## test a read only property. f = requests.options(self.url_base() + '/rest/data/user/1/creator', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Origin': self.tracker_web_base, }) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 204) expected1 = dict(expected) expected1['Allow'] = 'OPTIONS, GET' expected1['Access-Control-Allow-Methods'] = 'OPTIONS, GET' # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected1) ## test a property that doesn't exist f = requests.options(self.url_base() + '/rest/data/user/1/zot', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Origin': self.tracker_web_base,}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 404) def test_rest_endpoint_user_roles(self): # use basic auth for rest endpoint f = requests.get(self.url_base() + '/rest/data/user/roles', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Origin': self.tracker_web_base, }) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Access-Control-Expose-Headers': 'X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-RateLimit-Limit-Period, Retry-After, Sunset, Allow', 'Access-Control-Allow-Credentials': 'true', 'Allow': 'GET', } # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) content = json.loads(f.content) self.assertEqual(3, len(json.loads(f.content)['data']['collection'])) def test_inm(self): '''retrieve the user_utils.js file without an if-none-match etag header, a bad if-none-match header and valid single and multiple values. ''' f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': 'gzip, foo', 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': self.js_mime_type, 'Content-Encoding': 'gzip', 'Vary': 'Accept-Encoding', } # use dict comprehension to remove fields like date, # etag etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # use etag in previous response etag = f.headers['etag'] f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': 'gzip, foo', 'If-None-Match': etag, 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 304) expected = { 'Vary': 'Accept-Encoding', 'Content-Length': '0', 'ETag': etag, 'Vary': 'Accept-Encoding' } # use dict comprehension to remove fields like date, server, # etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # test again with etag supplied w/o content-encoding # and multiple etags self.assertTrue(etag.endswith('-gzip"')) # keep etag intact. Used below. base_etag = etag[:-6] + '"' all_etags = ( '"a41932-8b5-664ce93d", %s", "a41932-8b5-664ce93d-br"' % base_etag ) f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': 'gzip, foo', 'If-None-Match': base_etag, 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 304) expected = { 'Vary': 'Accept-Encoding', 'Content-Length': '0', 'ETag': base_etag, 'Vary': 'Accept-Encoding' } # use dict comprehension to remove fields like date, server, # etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # test with bad etag f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': 'gzip, foo', 'If-None-Match': '"a41932-8b5-664ce93d"', 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': self.js_mime_type, 'ETag': etag, 'Content-Encoding': 'gzip', 'Vary': 'Accept-Encoding', } # use dict comprehension to remove fields like date, server, # etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) def test_ims(self): ''' retrieve the user_utils.js file with old and new if-modified-since timestamps. ''' from datetime import datetime f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': 'gzip, foo', 'If-Modified-Since': 'Sun, 13 Jul 1986 01:20:00', 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': self.js_mime_type, 'Content-Encoding': 'gzip', 'Vary': 'Accept-Encoding', } # use dict comprehension to remove fields like date, # etag etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # now use today's date a_few_seconds_ago = datetime.now().strftime('%a, %d %b %Y %H:%M:%S GMT') f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': 'gzip, foo', 'If-Modified-Since': a_few_seconds_ago, 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 304) expected = { 'Vary': 'Accept-Encoding', 'Content-Length': '0', } # use dict comprehension to remove fields like date, etag # etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) def test_load_issue1(self): for tail in [ '/issue1', # normal url '/issue00001', # leading 0's should be stripped from id '/issue1>' # surprise this works too, should it?? ]: f = requests.get(self.url_base() + tail, headers = { 'Accept-Encoding': 'gzip', 'Accept': '*/*'}) self.assertIn(b'foo bar RESULT', f.content) self.assertEqual(f.status_code, 200) def test_load_msg1(self): # leading 0's should be stripped from id f = requests.get(self.url_base() + '/msg0001', headers = { 'Accept-Encoding': 'gzip', 'Accept': '*/*'}) self.assertIn(b'foo bar RESULT', f.content) self.assertEqual(f.status_code, 200) def test_bad_path(self): f = requests.get(self.url_base() + '/_bad>', headers = { 'Accept-Encoding': 'gzip, foo', 'Accept': '*/*'}) # test that returned text is encoded. self.assertEqual(f.content, b'Not found: _bad>') self.assertEqual(f.status_code, 404) def test_compression_gzipfile(self): '''Get the compressed dummy file''' # create a user_utils.js.gz file to test pre-compressed # file serving code. Has custom contents to verify # that I get the compressed one. gzfile = "%s/html/user_utils.js.gzip"%self.dirname test_text= b"Custom text for user_utils.js\n" with gzip.open(gzfile, 'wb') as f: bytes_written = f.write(test_text) self.assertEqual(bytes_written, 30) # test file x-fer f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': 'gzip, foo', 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': self.js_mime_type, 'Content-Encoding': 'gzip', 'Vary': 'Accept-Encoding', 'Content-Length': '69', } # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # check content - verify it's the .gz file not the real file. self.assertEqual(f.content, test_text) '''# verify that a different encoding request returns on the fly # test file x-fer using br, so we get runtime compression f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': 'br, foo', 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': self.js_mime_type, 'Content-Encoding': 'br', 'Vary': 'Accept-Encoding', 'Content-Length': '960', } # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) try: from urllib3.response import BrotliDecoder # requests has decoded br to text for me data = f.content except ImportError: # I need to decode data = brotli.decompress(f.content) self.assertEqual(b2s(data)[0:25], '// User Editing Utilities') ''' # re-request file, but now make .gzip out of date. So we get the # real file compressed on the fly, not our test file. os.utime(gzfile, (0,0)) # use 1970/01/01 or os base time f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': 'gzip, foo', 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': self.js_mime_type, 'Content-Encoding': 'gzip', 'Vary': 'Accept-Encoding', } # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # check content - verify it's the real file, not crafted .gz. self.assertEqual(b2s(f.content)[0:25], '// User Editing Utilities') # cleanup os.remove(gzfile) def test_compression_none_etag(self): # use basic auth for rest endpoint f = requests.get(self.url_base() + '/rest/data/user/1/username', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Accept-Encoding': "", 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': 'application/json', 'Access-Control-Allow-Credentials': 'true', 'Allow': 'OPTIONS, GET, POST, PUT, DELETE, PATCH', } content_str = '''{ "data": { "id": "1", "link": "%s/rest/data/user/1/username", "data": "admin" } }''' % self.tracker_web_base content = json.loads(content_str) if (type("") == type(f.content)): json_dict = json.loads(f.content) else: json_dict = json.loads(b2s(f.content)) # etag wil not match, creation date different del(json_dict['data']['@etag']) # type is "class 'str'" under py3, "type 'str'" py2 # just skip comparing it. del(json_dict['data']['type']) self.assertDictEqual(json_dict, content) # verify that ETag header has no - delimiter print(f.headers['ETag']) with self.assertRaises(ValueError): f.headers['ETag'].index('-') # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) def test_compression_gzip(self, method='gzip'): if method == 'gzip': decompressor = None elif method == 'br': decompressor = brotli.decompress elif method == 'zstd': decompressor = zstd.decompress # use basic auth for rest endpoint f = requests.get(self.url_base() + '/rest/data/user/1/username', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Accept-Encoding': '%s, foo'%method, 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': 'application/json', 'Access-Control-Allow-Credentials': 'true', 'Allow': 'OPTIONS, GET, POST, PUT, DELETE, PATCH', 'Content-Encoding': method, 'Vary': 'Origin, Accept-Encoding', } content_str = '''{ "data": { "id": "1", "link": "%s/rest/data/user/1/username", "data": "admin" } }''' % self.tracker_web_base content = json.loads(content_str) print(f.content) print(type(f.content)) try: if (type("") == type(f.content)): json_dict = json.loads(f.content) else: json_dict = json.loads(b2s(f.content)) except (ValueError, UnicodeDecodeError): # Handle error from trying to load compressed data as only # gzip gets decompressed automatically # ValueError - raised by loads on compressed content python2 # UnicodeDecodeError - raised by loads on compressed content # python3 json_dict = json.loads(b2s(decompressor(f.content))) # etag will not match, creation date different del(json_dict['data']['@etag']) # type is "class 'str'" under py3, "type 'str'" py2 # just skip comparing it. del(json_dict['data']['type']) self.assertDictEqual(json_dict, content) # verify that ETag header ends with - try: self.assertRegex(f.headers['ETag'], r'^"[0-9a-f]{32}-%s"$'%method) except AttributeError: # python2 no assertRegex so try substring match self.assertEqual(33, f.headers['ETag'].rindex('-' + method)) # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # use basic auth for rest endpoint, error case, bad attribute f = requests.get(self.url_base() + '/rest/data/user/1/foo', auth=('admin', 'sekrit'), headers = {'content-type': "", 'Accept-Encoding': '%s, foo'%method, 'Accept': '*/*', 'Origin': 'https://client.com'}) print(f.status_code) print(f.headers) # NOTE: not compressed payload too small self.assertEqual(f.status_code, 400) expected = { 'Content-Type': 'application/json', 'Access-Control-Allow-Credentials': 'true', 'Access-Control-Allow-Origin': 'https://client.com', 'Allow': 'OPTIONS, GET, POST, PUT, DELETE, PATCH', 'Vary': 'Origin' } content = { "error": { "status": 400, "msg": "Invalid attribute foo" } } json_dict = json.loads(b2s(f.content)) self.assertDictEqual(json_dict, content) # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # test file x-fer f = requests.get(self.url_base() + '/@@file/user_utils.js', headers = { 'Accept-Encoding': '%s, foo'%method, 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': self.js_mime_type, 'Content-Encoding': method, 'Vary': 'Accept-Encoding', } # compare to byte string as f.content may be compressed. # so running b2s on it will throw a UnicodeError if f.content[0:25] == b'// User Editing Utilities': # no need to decompress, urlib3.response did it for gzip and br data = f.content else: # I need to decode data = decompressor(f.content) # check first few bytes. self.assertEqual(b2s(data)[0:25], '// User Editing Utilities') # use dict comprehension to remove fields like date, # content-length etc. from f.headers. self.assertDictEqual({ key: value for (key, value) in f.headers.items() if key in expected }, expected) # test file x-fer f = requests.get(self.url_base() + '/user1', headers = { 'Accept-Encoding': '%s, foo'%method, 'Accept': '*/*'}) print(f.status_code) print(f.headers) self.assertEqual(f.status_code, 200) expected = { 'Content-Type': 'text/html; charset=utf-8', 'Content-Encoding': method, 'Vary': 'Accept-Encoding', } if f.content[0:25] == b'

Hi Richard,

I suppose this isn't the exact message = that was sent but is a resend of one of my trial messages that = failed.  For your benefit I changed the subject line and am adding = these words to the message body.  Should still be as problematic, = but if you like I can resend an exact copy of a failed message changing = nothing except putting your address instead of our tracker.

Thanks very much for taking time to = look into this.  Much appreciated.


<<battery = backup>>

------_=_NextPart_002_01CACA65.40A51CBC-- ------_=_NextPart_001_01CACA65.40A51CBC Content-Type: message/rfc822 Content-Transfer-Encoding: 7bit X-MimeOLE: Produced By Microsoft Exchange V6.5 MIME-Version: 1.0 Content-Type: multipart/alternative; boundary="----_=_NextPart_003_01CAC15A.29717800" X-OriginalArrivalTime: 11 Mar 2010 20:33:51.0249 (UTC) FILETIME=[28FEE010:01CAC15A] Content-class: urn:content-classes:message Subject: battery backup Date: Thu, 11 Mar 2010 13:33:43 -0700 Message-ID: X-MS-Has-Attach: X-MS-TNEF-Correlator: Thread-Topic: battery backup Thread-Index: AcrBWimtulTrSvBdQ2CcfZ8lyQdxmQ== From: "Jerry" To: "Hugh" This is a multi-part message in MIME format. ------_=_NextPart_003_01CAC15A.29717800 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Dear Hugh, A car batter has an energy capacity of ~ 500Wh. A UPS=20 battery is worse than this. if we need to provied 100kW for 30 minutes that will take 100 car=20 batteries. This seems like an awful lot of batteries. Of course I like your idea of making the time 1 minute, so we get to=20 a more modest number of batteries Jerry ------_=_NextPart_003_01CAC15A.29717800 Content-Type: text/html; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable battery backup

Dear Hugh,
        A car = batter has an energy capacity of ~ 500Wh.  A UPS
battery is worse than this.

if we need to provied 100kW for 30 minutes that will = take 100 car
batteries.  This seems like an awful lot of = batteries.

Of course I like your idea of making the time 1 = minute, so we get to
a more modest number of batteries

Jerry

------_=_NextPart_003_01CAC15A.29717800-- ------_=_NextPart_001_01CACA65.40A51CBC-- ''' nodeid = self._handle_mail(message) assert not os.path.exists(SENDMAILDEBUG) msgid = self.db.issue.get(nodeid, 'messages')[0] self.assertTrue(self.db.msg.get(msgid, 'content').startswith('Hi Richard')) self.assertEqual(self.db.msg.get(msgid, 'files'), ['1', '2']) fileid = self.db.msg.get(msgid, 'files')[0] self.assertEqual(self.db.file.get(fileid, 'type'), 'text/html') fileid = self.db.msg.get(msgid, 'files')[1] self.assertEqual(self.db.file.get(fileid, 'type'), 'message/rfc822') def testForwardedMessageAttachment(self): message = '''Return-Path: Received: from localhost(127.0.0.1), claiming to be "[115.130.26.69]" via SMTP by localhost, id smtpdAAApLaWrq; Tue Apr 13 23:10:05 2010 Message-ID: <4BC4F9C7.50409@test.test> Date: Wed, 14 Apr 2010 09:09:59 +1000 From: Rupert Goldie User-Agent: Thunderbird 2.0.0.24 (Windows/20100228) MIME-Version: 1.0 To: ekit issues Subject: [Fwd: PHP ERROR (fb)] post limit reached Content-Type: multipart/mixed; boundary="------------000807090608060304010403" This is a multi-part message in MIME format. --------------000807090608060304010403 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Catch this exception and log it without emailing. --------------000807090608060304010403 Content-Type: message/rfc822; name="PHP ERROR (fb).eml" Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="PHP ERROR (fb).eml" Return-Path: X-Sieve: CMU Sieve 2.2 via SMTP by crown.off.ekorp.com, id smtpdAAA1JaW1o; Tue Apr 13 23:01:04 2010 X-Virus-Scanned: by amavisd-new at ekit.com To: facebook-errors@test.test From: ektravj@test.test Subject: PHP ERROR (fb) Message-Id: <20100413230100.D601D27E84@mail2.elax3.ekorp.com> Date: Tue, 13 Apr 2010 23:01:00 +0000 (UTC) [13-Apr-2010 22:49:02] PHP Fatal error: Uncaught exception 'Exception' with message 'Facebook Error Message: Feed action request limit reached' in /app/01/www/virtual/fb.ekit.com/htdocs/includes/functions.php:280 Stack trace: #0 /app/01/www/virtual/fb.ekit.com/htdocs/gateway/ekit/feed/index.php(178): fb_exceptions(Object(FacebookRestClientException)) #1 {main} thrown in /app/01/www/virtual/fb.ekit.com/htdocs/includes/functions.php on line 280 --------------000807090608060304010403-- ''' nodeid = self._handle_mail(message) assert not os.path.exists(SENDMAILDEBUG) msgid = self.db.issue.get(nodeid, 'messages')[0] self.assertEqual(self.db.msg.get(msgid, 'content'), 'Catch this exception and log it without emailing.') self.assertEqual(self.db.msg.get(msgid, 'files'), ['1']) fileid = self.db.msg.get(msgid, 'files')[0] self.assertEqual(self.db.file.get(fileid, 'type'), 'message/rfc822') def testStandardMsg(self): self.instance.config['MAIL_DOMAIN'] = 'example.com' name = u'Accented chars \xe4\xf6\xfc\xc4\xd6\xdc\xdf' # Python2 wants an UTF-8 string in first component of adr and content # while Python3 wants a String # It *may* be a bug that the subject can be Unicode in python2. # But it doesn't hurt if the encoding happens to be utf-8 if sys.version_info[0] <= 2: name = name.encode('utf-8') adr = 'someone@example.com' to = [adr] adr = (name, adr) mailer = roundupdb.Mailer(self.db.config) mailer.standard_message(to, subject=name, content=name, author=adr) assert os.path.exists(SENDMAILDEBUG) self.compareMessages(self._get_mail(), ''' FROM: roundup-admin@example.com TO: someone@example.com From: =?utf-8?b?QWNjZW50ZWQgY2hhcnMgw6TDtsO8w4TDlsOcw58=?= To: someone@example.com MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Subject: =?utf-8?b?QWNjZW50ZWQgY2hhcnMgw6TDtsO8w4TDlsOcw58=?= X-Roundup-Name: Roundup issue tracker X-Roundup-Loop: hello Content-Transfer-Encoding: base64 QWNjZW50ZWQgY2hhcnMgw6TDtsO8w4TDlsOcw58= ''') @skip_pgp class MailgwPGPTestCase(MailgwTestAbstractBase, unittest.TestCase): pgphome = gpgmelib.pgphome def setUp(self): MailgwTestAbstractBase.setUp(self) self.db.security.addRole(name = 'pgp', description = 'PGP Role') self.instance.config['PGP_HOMEDIR'] = self.pgphome self.instance.config['PGP_ROLES'] = 'pgp' self.instance.config['PGP_ENABLE'] = True self.instance.config['MAIL_DOMAIN'] = 'example.com' self.instance.config['ADMIN_EMAIL'] = 'roundup-admin@example.com' self.db.user.set(self.john_id, roles='User,pgp') gpgmelib.setUpPGP() def tearDown(self): MailgwTestAbstractBase.tearDown(self) gpgmelib.tearDownPGP() def testPGPUnsignedMessage(self): self.assertRaises(MailUsageError, self._handle_mail, '''Content-Type: text/plain; charset="iso-8859-1" From: John Doe To: issue_tracker@your.tracker.email.domain.example Message-Id: Subject: [issue] Testing non-signed message... This is no pgp signed message. ''') signed_msg = '''Content-Disposition: inline From: John Doe To: issue_tracker@your.tracker.email.domain.example Subject: [issue] Testing signed message... Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="cWoXeonUoKmBZSoM" --cWoXeonUoKmBZSoM Content-Type: text/plain; charset=us-ascii Content-Disposition: inline This is a pgp signed message. --cWoXeonUoKmBZSoM Content-Type: application/pgp-signature; name="signature.asc" Content-Description: Digital signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.10 (GNU/Linux) iJwEAQECAAYFAk6N4A4ACgkQv8+6oPhbo5x5nAP/d7R7SxTvLoVESI+1r7eDXp1J LvBVU2EF3YFYKBHMLcWmjG92fNjnHX6NENTEhTeBynba5IPEwUfITC+7PmgPmQkA VXnFZnwraHxsYgyFsVFN1kkTSbwRUlWl9+nTEsr0yBLTpZN0QSIDcwu+i/xVcg+t ZQ4K6R3m3AOw7BLdvZs= =wpYk -----END PGP SIGNATURE----- --cWoXeonUoKmBZSoM-- ''' def testPGPSignedMessage(self): nodeid = self._handle_mail(self.signed_msg) m = self.db.issue.get(nodeid, 'messages')[0] self.assertEqual(self.db.msg.get(m, 'content'), 'This is a pgp signed message.') # check that the message has the right source code l = self.db.msg.get(m, 'tx_Source') self.assertEqual(l, 'email-sig-openpgp') def testPGPSignedMessageFail(self): # require both, signing and encryption self.instance.config['PGP_REQUIRE_INCOMING'] = 'both' self.assertRaises(MailUsageError, self._handle_mail, self.signed_msg) encrypted_msg = '''Content-Disposition: inline From: John Doe To: roundup-admin@example.com Subject: [issue] Testing encrypted message... Content-Type: multipart/encrypted; protocol="application/pgp-encrypted"; boundary="d6Gm4EdcadzBjdND" --d6Gm4EdcadzBjdND Content-Type: application/pgp-encrypted Content-Disposition: attachment Version: 1 --d6Gm4EdcadzBjdND Content-Type: application/octet-stream Content-Disposition: inline; filename="msg.asc" -----BEGIN PGP MESSAGE----- Version: GnuPG v1.4.10 (GNU/Linux) hQEMAzfeQttq+Q2YAQf9FxCtZVgC7jAy6UkeAJ1imCpnh9DgKA5w40OFtrY4mVAp cL7kCkvGvJCW7uQZrmSgIiYaZGLI3GS42XutORC6E6PzBEW0fJUMIXYmoSd0OFeY 3H2+854qu37W/uCOWM9OnPFIH8g8q8DgYy88i0goM+Ot9Q96yFfJ7QymanOZJgVa MNC+oKDiIZKiE3PCwtGr+8CHZN/9J6O4FeJijBlr09C5LXc+Nif5T0R0nt17MAns 9g2UvGxW8U24NAS1mOg868U05hquLPIcFz9jGZGknJu7HBpOkQ9GjKqkzN8pgZVN VbN8IdDqi0QtRKE44jtWQlyNlESMjv6GtC2V9F6qKNK8AfHtBexDhyv4G9cPFFNO afQ6e4dPi89RYIQyydtwiqao8fj6jlAy2Z1cbr7YxwBG7BeUZv9yis7ShaAIo78S 82MrCYpSjfHNwKiSfC5yITw22Uv4wWgixVdAsaSdtBqEKXJPG9LNey18ArsBjSM1 P81iDOWUp/uyIe5ZfvNI38BBxEYslPTUlDk2GB8J2Vun7IWHoj9a4tY3IotC9jBr 5Qnigzqrt7cJZX6OrN0c+wnOjXbMGYXmgSs4jeM= =XX5Q -----END PGP MESSAGE----- --d6Gm4EdcadzBjdND-- ''' def testPGPEncryptedUnsignedMessageError(self): self.assertRaises(MailUsageError, self._handle_mail, self.encrypted_msg) def testPGPEncryptedUnsignedMessage(self): # no error if we don't require a signature: self.instance.config['PGP_REQUIRE_INCOMING'] = 'encrypted' nodeid = self._handle_mail (self.encrypted_msg) m = self.db.issue.get(nodeid, 'messages')[0] self.assertEqual(self.db.msg.get(m, 'content'), 'This is the text to be encrypted') # check that the message has the right source code l = self.db.msg.get(m, 'tx_Source') self.assertEqual(l, 'email') def testPGPEncryptedUnsignedMessageFromNonPGPUser(self): msg = self.encrypted_msg.replace('John Doe ', '"Contrary, Mary" ') nodeid = self._handle_mail (msg) m = self.db.issue.get(nodeid, 'messages')[0] self.assertEqual(self.db.msg.get(m, 'content'), 'This is the text to be encrypted') self.assertEqual(self.db.msg.get(m, 'author'), self.mary_id) # check that the message has the right source code l = self.db.msg.get(m, 'tx_Source') self.assertEqual(l, 'email') # check that a bounce-message that is triggered *after* # decrypting is properly encrypted: def testPGPEncryptedUnsignedMessageCheckBounce(self): # allow non-signed msg self.instance.config['PGP_REQUIRE_INCOMING'] = 'encrypted' # don't allow creation of message, trigger error *after* decrypt self.db.user.set(self.john_id, roles='pgp') self.db.security.addPermissionToRole('pgp', 'Email Access') self.db.security.addPermissionToRole('pgp', 'Create', 'issue') # trap_exc=1: we want a bounce message: self._handle_mail(self.encrypted_msg, trap_exc=1) m = self._get_mail() parts = email.message_from_string(m).get_payload() self.assertEqual(len(parts),2) self.assertEqual(parts[0].get_payload().strip(), 'Version: 1') crypt = gpg.core.Data(parts[1].get_payload()) plain = gpg.core.Data() ctx = gpg.core.Context() res = ctx.op_decrypt(crypt, plain) self.assertEqual(res, None) plain.seek(0,0) parts = message_from_bytes(plain.read()).get_payload() self.assertEqual(len(parts),2) self.assertEqual(parts[0].get_payload().strip(), 'You are not permitted to create messages.') self.assertEqual(parts[1].get_payload().strip(), '''Content-Type: text/plain; charset=us-ascii Content-Disposition: inline This is the text to be encrypted''') def testPGPEncryptedSignedMessage(self): # require both, signing and encryption self.instance.config['PGP_REQUIRE_INCOMING'] = 'both' nodeid = self._handle_mail('''Content-Disposition: inline From: John Doe To: roundup-admin@example.com Subject: Testing encrypted and signed message MIME-Version: 1.0 Content-Type: multipart/encrypted; protocol="application/pgp-encrypted"; boundary="ReaqsoxgOBHFXBhH" --ReaqsoxgOBHFXBhH Content-Type: application/pgp-encrypted Content-Disposition: attachment Version: 1 --ReaqsoxgOBHFXBhH Content-Type: application/octet-stream Content-Disposition: inline; filename="msg.asc" -----BEGIN PGP MESSAGE----- Version: GnuPG v1.4.10 (GNU/Linux) hQEMAzfeQttq+Q2YAQf+NaC3r8qBURQqxHH9IAP4vg0QAP2yj3n0v6guo1lRf5BA EUfTQ3jc3chxLvzTgoUIuMOvhlNroqR1lgLwhfSTCyuKWDZa+aVNiSgsB2MD44Xd mAkKKmnmOGLmfbICbPQZxl4xNhCMTHiAy1xQE6mTj/+pEAq5XxjJUwn/gJ3O1Wmd NyWtJY2N+TRbxUVB2WhG1j9J1D2sjhG26TciE8JeuLDZzaiVNOW9YlX2Lw5KtlkR Hkgw6Xme06G0XXZUcm9JuBU/7oFP/tSrC1tBsnVlq1pZYf6AygIBdXWb9gD/WmXh 7Eu/xCKrw4RFnXnTgmBz/NHRfVDkfdSscZqexnG1D9LAwQHSuVf8sxDPNesv0W+8 e49loVjvU+Y0BCFQAbWSW4iOEUYZpW/ITRE4+wIqMXZbAraeBV0KPZ4hAa3qSmf+ oZBRcbzssL163Odx/OHRuK2J2CHC654+crrlTBnxd/RUKgRbSUKwrZzB2G6OPcGv wfiqXsY+XvSZtTbWuvUJxePh8vhhhjpuo1JtlrYc3hZ9OYgoCoV1JiLl5c60U5Es oUT9GDl1Qsgb4dF4TJ1IBj+riYiocYpJxPhxzsy6liSLNy2OA6VEjG0FGk53+Ok9 7UzOA+WaHJHSXafZzrdP1TWJUFlOMA+dOgTKpH69eL1+IRfywOjEwp1UNSbLnJpc D0QQLwIFttplKvYkn0DZByJCVnIlGkl4s5LM5rnc8iecX8Jad0iRIlPV6CVM+Nso WdARUfyJfXAmz8uk4f2sVfeMu1gdMySdjvxwlgHDJdBPIG51r2b8L/NCTiC57YjF zGhS06FLl3V1xx6gBlpqQHjut3efrAGpXGBVpnTJMOcgYAk= =jt/n -----END PGP MESSAGE----- --ReaqsoxgOBHFXBhH-- ''') m = self.db.issue.get(nodeid, 'messages')[0] self.assertEqual(self.db.msg.get(m, 'content'), 'This is the text of a signed and encrypted email.') # check that the message has the right source code l = self.db.msg.get(m, 'tx_Source') self.assertEqual(l, 'email-sig-openpgp') # vim: set filetype=python sts=4 sw=4 et : code-e5bd50120b5a/test/test_mailgw_roundupmessage.py0000644000000000000000000003422015064275501020712 0ustar 00000000000000# -*- coding: utf-8 -*- import email import textwrap from unittest import TestCase from roundup.mailgw import RoundupMessage PART_TYPES = { 'multipart/signed': ' boundary="boundary-{indent}";\n', 'multipart/mixed': ' boundary="boundary-{indent}";\n', 'multipart/alternative': ' boundary="boundary-{indent}";\n', 'text/plain': ' name="foo.txt"\n\nfoo\n', 'text/plain_2': ' name="foo2.txt"\n\nfoo2\n', 'text/plain_3': ' name="foo3.txt"\n\nfoo3\n', 'text/html': ' name="foo.html"\n\nfoo\n', 'application/pgp-signature': ' name="foo.gpg"\nfoo\n', 'application/pdf': ' name="foo.pdf"\nfoo\n', 'application/pdf_2': ' name="foo2.pdf"\nfoo2\n', 'message/rfc822': '\nSubject: foo\n\nfoo\n', } def message_from_string(msg): return email.message_from_string( textwrap.dedent(msg).lstrip(), RoundupMessage) def construct_message(spec, depth=0): parts = [] for content_type in spec: if isinstance(content_type, list): parts.extend(construct_message(content_type, depth=(depth + 1))) parts.append('\n--boundary-{0}--\n'.format(depth + 1)) else: if depth > 0: parts.append('\n--boundary-{0}\n'.format(depth)) parts.append( 'Content-Type: {0};\n'.format(content_type.split('_')[0])) parts.append(PART_TYPES[content_type].format(indent=(depth + 1))) if depth == 0: return email.message_from_string(''.join(parts), RoundupMessage) else: return parts class FlattenRoundupMessageTests(TestCase): def test_flatten_with_from(self): msg_string = textwrap.dedent(""" From: Some User To: issue_tracker@example.com Message-Id: Subject: Test line start with from From here to there! """).lstrip() msg = email.message_from_string(msg_string, RoundupMessage) self.assertEqual(msg.flatten(), msg_string) class HeaderRoundupMessageTests(TestCase): msg = message_from_string(""" Content-Type: text/plain; charset="iso-8859-1" From: =?utf8?b?SOKCrGxsbw==?= To: Issue Tracker Cc: =?utf8?b?SOKCrGxsbw==?= , Some User Message-Id: Subject: [issue] Testing... This is a test submission of a new issue. """) # From line has a null/empty encoding spec # to trigger failure in mailgw.py:RoundupMessage::_decode_header bad_msg_utf8 = message_from_string(""" Content-Type: text/plain; charset="iso-8859-1" From: =??b?SOKCrGxsbw=====?= To: Issue Tracker Cc: =?utf8?b?SOKCrGxsbw==?= , Some User Message-Id: Subject: [issue] Testing... This is a test submission of a new issue. """) bad_msg_iso_8859_1 = message_from_string(""" Content-Type: text/plain; charset="iso-8859-1" From: =??q?\x80SOKCrGxsbw=====?= To: Issue Tracker Cc: =?utf8?b?SOKCrGxsbw==?= , Some User Message-Id: Subject: [issue] Testing... This is a test submission of a new issue. """) def test_get_plain_header(self): self.assertEqual( self.msg.get_header('to'), 'Issue Tracker ') def test_get_encoded_header(self): self.assertEqual( self.msg.get_header('from'), 'H€llo ') # issue2551008 null encoding causes crash. self.assertEqual( self.bad_msg_utf8.get_header('from'), 'H€llo ') # the decoded value is not what the user wanted, # but they should have created a valid header # if they wanted the right outcome... self.assertIn( self.bad_msg_iso_8859_1.get_header('from'), ( '\xc2\x80SOKCrGxsbw===== ', # python 2 '\x80SOKCrGxsbw===== ' # python 3 )) def test_get_address_list(self): self.assertEqual(self.msg.get_address_list('cc'), [ ('H€llo', 'hello@example.com'), ('Some User', 'some.user@example.com'), ]) class BodyRoundupMessageTests(TestCase): def test_get_body_iso_8859_1(self): msg = message_from_string(""" Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable A message with encoding (encoded oe =F6) """) self.assertEqual( msg.get_body(), 'A message with encoding (encoded oe ö)\n') def test_get_body_utf_8(self): msg = message_from_string(""" Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable A message with encoding (encoded oe =C3=B6) """) self.assertEqual( msg.get_body(), 'A message with encoding (encoded oe ö)\n') def test_get_body_base64(self): msg = message_from_string(""" Content-Type: application/octet-stream Content-Disposition: attachment; filename="message.dat" Content-Transfer-Encoding: base64 dGVzdCBlbmNvZGVkIG1lc3NhZ2U= """) self.assertEqual(msg.get_body(), b'test encoded message') class AsAttachmentRoundupMessageTests(TestCase): def test_text_plain(self): msg = message_from_string(""" Content-Type: text/plain; charset="iso-8859-1 Plain text message """) self.assertEqual( msg.as_attachment(), (None, 'text/plain', 'Plain text message\n')) def test_octet_stream(self): msg = message_from_string(""" Content-Type: application/octet-stream Content-Disposition: attachment; filename="message.dat" Content-Transfer-Encoding: base64 dGVzdCBlbmNvZGVkIG1lc3NhZ2U= """) self.assertEqual( msg.as_attachment(), ('message.dat', 'application/octet-stream', b'test encoded message')) def test_rfc822(self): msg = message_from_string(""" Content-Type: message/rfc822 Subject: foo foo """) self.assertEqual( msg.as_attachment(), ('foo.eml', 'message/rfc822', 'Subject: foo\n\nfoo\n')) def test_rfc822_no_subject(self): msg = message_from_string(""" Content-Type: message/rfc822 X-No-Headers: nope foo """) self.assertEqual( msg.as_attachment(), (None, 'message/rfc822', 'X-No-Headers: nope\n\nfoo\n')) def test_rfc822_no_payload(self): msg = message_from_string("""\ Content-Type: message/rfc822 """) self.assertEqual( msg.as_attachment(), (None, 'message/rfc822', '\n')) class ExtractContentRoundupMessageTests(TestCase): def test_text_plain(self): msg = construct_message(['text/plain']) self.assertEqual(msg.extract_content(), ('foo\n', [], False)) def test_attached_text_plain(self): msg = construct_message([ 'multipart/mixed', [ 'text/plain', 'text/plain', ], ]) self.assertEqual(msg.extract_content(), ( 'foo\n', [('foo.txt', 'text/plain', 'foo\n')], False )) def test_multipart_mixed(self): msg = construct_message([ 'multipart/mixed', [ 'text/plain', 'application/pdf', ], ]) self.assertEqual(msg.extract_content(), ( 'foo\n', [('foo.pdf', 'application/pdf', b'foo\n')], False )) def test_multipart_alternative(self): msg = construct_message([ 'multipart/alternative', [ 'text/plain', 'text/html', ], ]) self.assertEqual(msg.extract_content(), ( 'foo\n', [('foo.html', 'text/html', 'foo\n')], False )) def test_deep_multipart_alternative(self): msg = construct_message([ 'multipart/mixed', [ 'multipart/alternative', [ 'text/plain', 'application/pdf', 'text/plain_2', 'text/html', ], 'multipart/alternative', [ 'text/plain_3', 'application/pdf_2', ], ], ]) self.assertEqual(msg.extract_content(), ( 'foo2\n', [ ('foo.pdf', 'application/pdf', b'foo\n'), ('foo.txt', 'text/plain', 'foo\n'), ('foo.html', 'text/html', 'foo\n'), ('foo3.txt', 'text/plain', 'foo3\n'), ('foo2.pdf', 'application/pdf', b'foo2\n'), ], False )) def test_deep_multipart_alternative_ignore(self): msg = construct_message([ 'multipart/mixed', [ 'multipart/alternative', [ 'text/plain', 'application/pdf', 'text/plain_2', 'text/html', ], 'multipart/alternative', [ 'text/plain_3', 'application/pdf_2', ], ], ]) msg.extract_content(ignore_alternatives=True) self.assertEqual(msg.extract_content(ignore_alternatives=True), ( 'foo2\n', [ ('foo3.txt', 'text/plain', 'foo3\n'), ('foo2.pdf', 'application/pdf', b'foo2\n'), ], False )) def test_signed_text(self): msg = construct_message([ 'multipart/signed', [ 'text/plain', 'application/pgp-signature', ], ]) self.assertEqual(msg.extract_content(), ('foo\n', [], False)) def test_signed_attachemts(self): msg = construct_message([ 'multipart/signed', [ 'multipart/mixed', [ 'text/plain', 'application/pdf', ], 'application/pgp-signature', ], ]) self.assertEqual(msg.extract_content(), ( 'foo\n', [('foo.pdf', 'application/pdf', b'foo\n')], False )) def test_attached_signature(self): msg = construct_message([ 'multipart/mixed', [ 'text/plain', 'application/pgp-signature', ], ]) self.assertEqual(msg.extract_content(), ( 'foo\n', [('foo.gpg', 'application/pgp-signature', b'foo\n')], False )) def test_rfc822_message(self): msg = construct_message([ 'multipart/mixed', [ 'message/rfc822', ], ]) self.assertEqual(msg.extract_content(), ( None, [('foo.eml', 'message/rfc822', 'Subject: foo\n\nfoo\n')], False )) def test_rfc822_message_unpack(self): msg = construct_message([ 'multipart/mixed', [ 'text/plain', 'message/rfc822', ], ]) self.assertEqual(msg.extract_content(unpack_rfc822=True), ( 'foo\n', [(None, 'text/plain', 'foo\n')], False )) class PgpDetectRoundupMessageTests(TestCase): def test_pgp_message_signed(self): msg = message_from_string(""" Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature" Fake Body """) self.assertTrue(msg.pgp_signed()) def test_pgp_message_not_signed(self): msg = message_from_string(""" Content-Type: text/plain Fake Body """) self.assertFalse(msg.pgp_signed()) def test_pgp_message_signed_protocol_missing(self): msg = message_from_string(""" Content-Type: multipart/signed; micalg=pgp-sha1 Fake Body """) self.assertFalse(msg.pgp_signed()) def test_pgp_message_signed_protocol_invalid(self): msg = message_from_string(""" Content-Type: multipart/signed; protocol="application/not-pgp-signature" Fake Body """) self.assertFalse(msg.pgp_signed()) def test_pgp_message_encrypted(self): msg = message_from_string(""" Content-Type: multipart/encrypted; protocol="application/pgp-encrypted" Fake Body """) self.assertTrue(msg.pgp_encrypted()) def test_pgp_message_not_encrypted(self): msg = message_from_string(""" Content-Type: text/plain Fake Body """) self.assertFalse(msg.pgp_encrypted()) def test_pgp_message_encrypted_protocol_missing(self): msg = message_from_string(""" Content-Type: multipart/encrypted Fake Body """) self.assertFalse(msg.pgp_encrypted()) def test_pgp_message_encrypted_protocol_invalid(self): msg = message_from_string(""" Content-Type: multipart/encrypted; protocol="application/not-pgp-encrypted" Fake Body """) self.assertFalse(msg.pgp_encrypted()) # TODO: testing of the verify_signature() and decrypt() RoundupMessage methods. # The whole PGP testing stuff seems a bit messy, so we will rely on the tests # in test_mailgw for the time being code-e5bd50120b5a/test/test_mailsplit.py0000644000000000000000000002051515064275501016311 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import unittest from roundup.mailgw import parseContent class MailsplitTestCase(unittest.TestCase): def testPreComment(self): s = ''' blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ -- blah blah blah signature userfoo@foo.com ''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah') self.assertEqual(content, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah\nblah blah blah blah blah blah blah blah blah blah blah!') def testPostComment(self): s = ''' issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah > blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah > blah > blah blah blah blah blah blah blah... blah blah blah blah. blah > blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! -- blah blah blah signature userfoo@foo.com ''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah') self.assertEqual(content, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah\nblah blah blah blah blah blah blah blah blah blah blah!') def testKeepCitation(self): s = ''' blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ -- blah blah blah signature userfoo@foo.com ''' summary, content = parseContent(s, 1, 0) self.assertEqual(summary, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah') self.assertEqual(content, '''\ blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/''') def testKeepBody(self): s = ''' blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ -- blah blah blah signature userfoo@foo.com ''' summary, content = parseContent(s, 0, 1) self.assertEqual(summary, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah') self.assertEqual(content, ''' blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ -- blah blah blah signature userfoo@foo.com ''') def testAllQuoted(self): s = '\nissue_tracker@foo.com wrote:\n> testing\n' summary, content = parseContent(s, 0, 1) self.assertEqual(summary, '') self.assertEqual(content, s) def testSimple(self): s = '''testing''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'testing') self.assertEqual(content, 'testing') def testParagraphs(self): s = '''testing\n\ntesting\n\ntesting''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'testing') self.assertEqual(content, 'testing\n\ntesting\n\ntesting') def testSimpleFollowup(self): s = '''>hello\ntesting''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'testing') self.assertEqual(content, 'testing') def testSimpleFollowupParas(self): s = '''>hello\ntesting\n\ntesting\n\ntesting''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'testing') self.assertEqual(content, 'testing\n\ntesting\n\ntesting') def testEmpty(self): s = '' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, '') self.assertEqual(content, '') def testIndentationSummary(self): s = ' Four space indent.\n\n Four space indent.\nNo indent.' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, ' Four space indent.') def testIndentationContent(self): s = ' Four space indent.\n\n Four space indent.\nNo indent.' summary, content = parseContent(s, 0, 0) self.assertEqual(content, s) def testMultilineSummary(self): s = 'This is a long sentence that would normally\nbe split. More words.' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'This is a long sentence that would ' 'normally\nbe split.') def testKeepMultipleHyphens(self): body = '''Testing, testing. ---- Testing, testing.''' summary, content = parseContent(body, 1, 0) self.assertEqual(body, content) # vim: set filetype=python ts=4 sw=4 et si code-e5bd50120b5a/test/test_memorydb.py0000644000000000000000000000375515064275501016140 0ustar 00000000000000import unittest, os, shutil, time from roundup import hyperdb from .db_test_base import DBTest, ROTest, SchemaTest, config, setupSchema from roundup.test import memorydb from roundup.anypy import strings class memorydbOpener: module = memorydb def nuke_database(self): # really kill it memorydb.db_nuke('') self.db = None db = None def open_database(self, user='admin'): if self.db: self.db.close() self.db = self.module.Database(config, user) return self.db def setUp(self): self.open_database() setupSchema(self.db, 1, self.module) def tearDown(self): if self.db is not None: self.db.close() self.db = None self.nuke_database() # nuke and re-create db for restore def nukeAndCreate(self): self.db.close() self.nuke_database() self.db = self.module.Database(config, 'admin') setupSchema(self.db, 0, self.module) class memorydbDBTest(memorydbOpener, DBTest, unittest.TestCase): pass class memorydbROTest(memorydbOpener, ROTest, unittest.TestCase): def setUp(self): self.db = self.module.Database(config) setupSchema(self.db, 0, self.module) class memorydbSchemaTest(memorydbOpener, SchemaTest, unittest.TestCase): pass from .session_common import SessionTest class memorydbSessionTest(memorydbOpener, SessionTest, unittest.TestCase): s2b = lambda x,y: strings.s2b(y) def setUp(self): self.db = self.module.Database(config, 'admin') setupSchema(self.db, 1, self.module) self.sessions = self.db.sessions self.db.Session = self.sessions self.otks = self.db.otks self.db.Otk = self.otks def get_ts(self): return (self.sessions.get('random_session', '__timestamp'),) def testDbType(self): self.assertIn("memorydb", repr(self.db)) self.assertIn("{}", repr(self.db.Session)) # vim: set filetype=python ts=4 sw=4 et si code-e5bd50120b5a/test/test_misc.py0000644000000000000000000003127415064275501015252 0ustar 00000000000000# misc tests import pytest import re import sys import time import unittest import roundup.anypy.cmp_ from roundup.anypy.strings import StringIO # define StringIO from roundup.cgi import cgitb from roundup.cgi.accept_language import parse from roundup.support import PrioList, Progress, TruthDict class AcceptLanguageTest(unittest.TestCase): def testParse(self): self.assertEqual(parse("da, en-gb;q=0.8, en;q=0.7"), ['da', 'en_gb', 'en']) self.assertEqual(parse("da, en-gb;q=0.7, en;q=0.8"), ['da', 'en', 'en_gb']) self.assertEqual(parse("en;q=0.2, fr;q=1"), ['fr', 'en']) self.assertEqual(parse("zn; q = 0.2 ,pt-br;q =1"), ['pt_br', 'zn']) self.assertEqual(parse("pt-br;q =1, zn; q = 0.2"), ['pt_br', 'zn']) self.assertEqual(parse("pt-br,zn;q= 0.1, en-US;q=0.5"), ['pt_br', 'en_US', 'zn']) # verify that items with q=1.0 are in same output order as input self.assertEqual(parse("pt-br,en-US; q=0.5, zn;q= 1.0" ), ['pt_br', 'zn', 'en_US']) self.assertEqual(parse("zn;q=1.0;q= 1.0,pt-br,en-US; q=0.5" ), ['zn', 'pt_br', 'en_US']) self.assertEqual(parse("es-AR"), ['es_AR']) self.assertEqual(parse("es-es-cat"), ['es_es_cat']) self.assertEqual(parse(""), []) self.assertEqual(parse(None),[]) self.assertEqual(parse(" "), []) self.assertEqual(parse("en,"), ['en']) class CmpTest(unittest.TestCase): def testCmp(self): roundup.anypy.cmp_._test() class PrioListTest(unittest.TestCase): def testPL(self): start_data = [(3, 33), (1, -2), (2, 10)] pl = PrioList(key=lambda x: x[1]) for i in start_data: pl.append(i) l = [x for x in pl] self.assertEqual(l, [(1, -2), (2, 10), (3, 33)]) pl = PrioList() for i in start_data: pl.append(i) l = [x for x in pl] self.assertEqual(l, [(1, -2), (2, 10), (3, 33)]) class ProgressTest(unittest.TestCase): @pytest.fixture(autouse=True) def inject_fixtures(self, capsys): self._capsys = capsys def testProgress(self): for x in Progress("5 Items@2 sec:", [1,2,3,4,5]): time.sleep(2) captured = self._capsys.readouterr() split_capture = captured.out.split('\r') # lines padded to 75 characters test should be long enough to # get an ETA printed at 100%, 80% and 60% hopefully this # doesn't become a flakey test on different hardware. self.assertIn("5 Items@2 sec: 0%".ljust(75), split_capture) self.assertIn("5 Items@2 sec: 60% (ETA 00:00:02)".ljust(75), split_capture) self.assertIn("5 Items@2 sec: 100% (ETA 00:00:00)".ljust(75), split_capture) print(captured.err) class TruthDictTest(unittest.TestCase): def testTD(self): td = TruthDict([]) # empty TruthDict always returns True. self.assertTrue(td['a']) self.assertTrue(td['z']) self.assertTrue(td['']) self.assertTrue(td[None]) td = TruthDict(['a', 'b', 'c']) self.assertTrue(td['a']) self.assertFalse(td['z']) class VersionCheck(unittest.TestCase): def test_Version_Check(self): # test for valid versions from roundup.version_check import VERSION_NEEDED self.assertEqual((2, 7), VERSION_NEEDED) del(sys.modules['roundup.version_check']) # fake an invalid version real_ver = sys.version_info sys.version_info = (2, 1) # exit is called on failure, but that breaks testing so # just return and discard the exit code. real_exit = sys.exit sys.exit = lambda code: code # error case uses print(), capture and check capturedOutput = StringIO() sys.stdout = capturedOutput from roundup.version_check import VERSION_NEEDED sys.stdout = sys.__stdout__ self.assertIn("Roundup requires Python 2.7", capturedOutput.getvalue()) # reset to valid values for future tests sys.exit = real_exit sys.version_info = real_ver class CgiTbCheck(unittest.TestCase): def test_NiceDict(self): d = cgitb.niceDict(" ", { "two": "three", "four": "five" }) expected = ( "four'five'\n" "two'three'" ) self.assertEqual(expected, d) def test_breaker(self): b = cgitb.breaker() expected = ('' ' > ') self.assertEqual(expected, b) def test_pt_html(self): """ templating error """ try: f = 5 d = a + 4 except Exception: p = cgitb.pt_html(context=2) expected2 = """

Templating Error

<type 'exceptions.NameError'>: global name 'a' is not defined

Debugging information follows

Full traceback:
Traceback (most recent call last):
  File "XX/test/test_misc.py", line XX, in test_pt_html
    d = a + 4
NameError: global name 'a' is not defined

 

""" expected3 = """

Templating Error

<class 'NameError'>: name 'a' is not defined

Debugging information follows

Full traceback:
Traceback (most recent call last):
  File "XX/test/test_misc.py", line XX, in test_pt_html
    d = a + 4
NameError: name 'a' is not defined

 

""" expected3_11 = """

Templating Error

<class 'NameError'>: name 'a' is not defined

Debugging information follows

Full traceback:
Traceback (most recent call last):
  File "XX/test/test_misc.py", line XX, in test_pt_html
    d = a + 4
        ^
NameError: name 'a' is not defined

 

""" # allow file directory prefix and line number to change p = re.sub(r'\\',r'/', p) # support windows \ => / # [A-Z]?:? optional drive spec on windows p = re.sub(r'(File ")[A-Z]?:?/.*/(test/test_misc.py",)', r'\1XX/\2', p) p = re.sub(r'(", line )\d*,', r'\1XX,', p) print(p) if sys.version_info > (3, 11, 0): self.assertEqual(expected3_11, p) elif sys.version_info > (3, 0, 0): self.assertEqual(expected3, p) else: self.assertEqual(expected2, p) def test_html(self): """ templating error """ # enabiling this will cause the test to fail as the variable # is included in the live output but not in expected. # self.maxDiff = None try: f = 5 d = a + 4 except Exception: h = cgitb.html(context=2) expected2 = """
 
 
NameError: global name 'a' is not defined		Python XX

A problem occurred while running a Python script. Here is the sequence of function calls leading up to the error, with the most recent (innermost) call first. The exception attributes are:
      __class__ = <type 'exceptions.NameError'>
      __delattr__ = <method-wrapper '__delattr__' of exceptions.NameError object>
      __dict__ = {}
      __doc__ = 'Name not found globally.'
      __format__ = <built-in method __format__ of exceptions.NameError object>
      __getattribute__ = <method-wrapper '__getattribute__' of exceptions.NameError object>
      __getitem__ = <method-wrapper '__getitem__' of exceptions.NameError object>
      __getslice__ = <method-wrapper '__getslice__' of exceptions.NameError object>
      __hash__ = <method-wrapper '__hash__' of exceptions.NameError object>
      __init__ = <method-wrapper '__init__' of exceptions.NameError object>
      __new__ = <built-in method __new__ of type object>
      __reduce__ = <built-in method __reduce__ of exceptions.NameError object>
      __reduce_ex__ = <built-in method __reduce_ex__ of exceptions.NameError object>
      __repr__ = <method-wrapper '__repr__' of exceptions.NameError object>
      __setattr__ = <method-wrapper '__setattr__' of exceptions.NameError object>
      __setstate__ = <built-in method __setstate__ of exceptions.NameError object>
      __sizeof__ = <built-in method __sizeof__ of exceptions.NameError object>
      __str__ = <method-wrapper '__str__' of exceptions.NameError object>
      __subclasshook__ = <built-in method __subclasshook__ of type object>
      __unicode__ = <built-in method __unicode__ of exceptions.NameError object>
      args = ("global name 'a' is not defined",)
      message = "global name 'a' is not defined"

XX/test/test_misc.py in test_html(self=<test.test_misc.CgiTbCheck testMethod=test_html>)
  XX             f = 5
  XX             d = a + 4
      d = undefined, global a = undefined

 

""" expected1_3 ="""NameError""" expected2_3 =""": name \'a\' is not defined""" expected3_3 ="""built-in method __dir__ of NameError object>""" # strip file path prefix from href and text # /home/user/develop/roundup/test/test_misc.py in test_html h = re.sub(r'(file:)/.*/(test/test_misc.py")', r'\1XX/\2', h) h = re.sub(r'(/test_misc.py">)/.*/(test/test_misc.py)', r'\1XX/\2', h) # replace code line numbers with XX h = re.sub(r'( )\d*()', r'\1XX\2', h) # normalize out python version/path h = re.sub(r'(Python )[\d.]*
[^<]*/python[23]?', r'\1XX', h) print(h) if sys.version_info > (3, 0, 0): self.assertIn(expected1_3, h) self.assertIn(expected2_3, h) self.assertIn(expected3_3, h) else: self.assertEqual(expected2, h) code-e5bd50120b5a/test/test_multipart.py0000644000000000000000000002647015064275501016342 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import email import unittest from roundup.anypy.strings import StringIO from roundup.mailgw import RoundupMessage def gen_message(spec): """Create a basic MIME message according to 'spec'. Each line of a spec has one content-type, which is optionally indented. The indentation signifies how deep in the MIME hierarchy the content-type is. """ def getIndent(line): """Get the current line's indentation, using four-space indents.""" count = 0 for char in line: if char != ' ': break count += 1 return count // 4 # A note on message/rfc822: The content of such an attachment is an # email with at least one header line. RFC2046 tells us: """ A # media type of "message/rfc822" indicates that the body contains an # encapsulated message, with the syntax of an RFC 822 message. # However, unlike top-level RFC 822 messages, the restriction that # each "message/rfc822" body must include a "From", "Date", and at # least one destination header is removed and replaced with the # requirement that at least one of "From", "Subject", or "Date" must # be present.""" # This means we have to add a newline after the mime-header before # the subject, otherwise the subject is part of the mime header not # part of the email header. table = {'multipart/signed': ' boundary="boundary-%(indent)s";\n', 'multipart/mixed': ' boundary="boundary-%(indent)s";\n', 'multipart/alternative': ' boundary="boundary-%(indent)s";\n', 'text/plain': ' name="foo.txt"\nfoo\n', 'text/html': ' name="bar.html"\nbar >\n', 'application/pgp-signature': ' name="foo.gpg"\nfoo\n', 'application/pdf': ' name="foo.pdf"\nfoo\n', 'message/rfc822': '\nSubject: foo\n\nfoo\n'} parts = [] for line in spec.splitlines(): content_type = line.strip() if not content_type: continue indent = getIndent(line) if indent: parts.append('\n--boundary-%s\n' % indent) parts.append('Content-type: %s;\n' % content_type) parts.append(table[content_type] % {'indent': indent + 1}) for i in range(indent, 0, -1): parts.append('\n--boundary-%s--\n' % i) return email.message_from_file(StringIO(''.join(parts)), RoundupMessage) class MultipartTestCase(unittest.TestCase): def setUp(self): self.fp = StringIO() w = self.fp.write w('Content-Type: multipart/mixed; boundary="foo"\r\n\r\n') w('This is a multipart message. Ignore this bit.\r\n') w('\r\n--foo\r\n') w('Content-Type: text/plain\r\n\r\n') w('Hello, world!\r\n') w('\r\n') w('Blah blah\r\n') w('foo\r\n') w('-foo\r\n') w('\r\n--foo\r\n') w('Content-Type: multipart/alternative; boundary="bar"\r\n\r\n') w('This is a multipart message. Ignore this bit.\r\n') w('\r\n--bar\r\n') w('Content-Type: text/plain\r\n\r\n') w('Hello, world!\r\n') w('\r\n') w('Blah blah\r\n') w('\r\n--bar\r\n') w('Content-Type: text/html\r\n\r\n') w('Hello, world!\r\n') w('\r\n--bar--\r\n') w('\r\n--foo\r\n') w('Content-Type: text/plain\r\n\r\n') w('Last bit\n') w('\r\n--foo--\r\n') self.fp.seek(0) def testMultipart(self): m = email.message_from_file(self.fp, RoundupMessage) self.assertTrue(m is not None) it = iter(m.get_payload()) # first text/plain p = next(it, None) self.assertTrue(p is not None) self.assertEqual(p.get_content_type(), 'text/plain') self.assertEqual(p.get_payload(), 'Hello, world!\r\n\r\nBlah blah\r\nfoo\r\n-foo\r\n') # sub-multipart p = next(it, None) self.assertTrue(p is not None) self.assertEqual(p.get_content_type(), 'multipart/alternative') # sub-multipart text/plain qit = iter(p.get_payload()) q = next(qit, None) self.assertTrue(q is not None) self.assertEqual(q.get_content_type(), 'text/plain') self.assertEqual(q.get_payload(), 'Hello, world!\r\n\r\nBlah blah\r\n') # sub-multipart text/html q = next(qit, None) self.assertTrue(q is not None) self.assertEqual(q.get_content_type(), 'text/html') self.assertEqual(q.get_payload(), 'Hello, world!\r\n') # sub-multipart end q = next(qit, None) self.assertTrue(q is None) # final text/plain p = next(it, None) self.assertTrue(p is not None) self.assertEqual(p.get_content_type(), 'text/plain') self.assertEqual(p.get_payload(), 'Last bit\n') # end p = next(it, None) self.assertTrue(p is None) def TestExtraction(self, spec, expected, convert_html_with=False): if convert_html_with: from roundup.dehtml import dehtml html2text=dehtml(convert_html_with).html2text else: html2text=None self.assertEqual(gen_message(spec).extract_content( html2text=html2text), expected) def testTextPlain(self): self.TestExtraction('text/plain', ('foo\n', [], False)) def testAttachedTextPlain(self): self.TestExtraction(""" multipart/mixed text/plain text/plain""", ('foo\n', [('foo.txt', 'text/plain', 'foo\n')], False)) def testMultipartMixed(self): self.TestExtraction(""" multipart/mixed text/plain application/pdf""", ('foo\n', [('foo.pdf', 'application/pdf', b'foo\n')], False)) def testMultipartMixedHtml(self): # test with html conversion enabled self.TestExtraction(""" multipart/mixed text/html application/pdf""", ('bar >\n', [('bar.html', 'text/html', 'bar >\n'), ('foo.pdf', 'application/pdf', b'foo\n')], False), convert_html_with='dehtml') # test with html conversion disabled self.TestExtraction(""" multipart/mixed text/html application/pdf""", (None, [('bar.html', 'text/html', 'bar >\n'), ('foo.pdf', 'application/pdf', b'foo\n')], False), convert_html_with=False) def testMultipartAlternative(self): self.TestExtraction(""" multipart/alternative text/plain application/pdf """, ('foo\n', [('foo.pdf', 'application/pdf', b'foo\n')], False)) def testMultipartAlternativeHtml(self): self.TestExtraction(""" multipart/alternative text/html application/pdf""", ('bar >\n', [('bar.html', 'text/html', 'bar >\n'), ('foo.pdf', 'application/pdf', b'foo\n')], False), convert_html_with='dehtml') self.TestExtraction(""" multipart/alternative text/html application/pdf""", (None, [('bar.html', 'text/html', 'bar >\n'), ('foo.pdf', 'application/pdf', b'foo\n')], False), convert_html_with=False) def testMultipartAlternativeHtmlText(self): # text should take priority over html when html is first self.TestExtraction(""" multipart/alternative text/html text/plain application/pdf""", ('foo\n', [('bar.html', 'text/html', 'bar >\n'), ('foo.pdf', 'application/pdf', b'foo\n')], False), convert_html_with='dehtml') # text should take priority over html when text is first self.TestExtraction(""" multipart/alternative text/plain text/html application/pdf""", ('foo\n', [('bar.html', 'text/html', 'bar >\n'), ('foo.pdf', 'application/pdf', b'foo\n')], False), convert_html_with='dehtml') # text should take priority over html when text is second and # html is disabled self.TestExtraction(""" multipart/alternative text/html text/plain application/pdf""", ('foo\n', [('bar.html', 'text/html', 'bar >\n'), ('foo.pdf', 'application/pdf', b'foo\n')], False), convert_html_with=False) # text should take priority over html when text is first and # html is disabled self.TestExtraction(""" multipart/alternative text/plain text/html application/pdf""", ('foo\n', [('bar.html', 'text/html', 'bar >\n'), ('foo.pdf', 'application/pdf', b'foo\n')], False), convert_html_with=False) def testDeepMultipartAlternative(self): self.TestExtraction(""" multipart/mixed multipart/alternative text/plain application/pdf """, ('foo\n', [('foo.pdf', 'application/pdf', b'foo\n')], False)) def testSignedText(self): self.TestExtraction(""" multipart/signed text/plain application/pgp-signature""", ('foo\n', [], False)) def testSignedAttachments(self): self.TestExtraction(""" multipart/signed multipart/mixed text/plain application/pdf application/pgp-signature""", ('foo\n', [('foo.pdf', 'application/pdf', b'foo\n')], False)) def testAttachedSignature(self): self.TestExtraction(""" multipart/mixed text/plain application/pgp-signature""", ('foo\n', [('foo.gpg', 'application/pgp-signature', b'foo\n')], False)) def testMessageRfc822(self): self.TestExtraction(""" multipart/mixed message/rfc822""", (None, [('foo.eml', 'message/rfc822', 'Subject: foo\n\nfoo\n')], False)) # vim: set filetype=python ts=4 sw=4 et si code-e5bd50120b5a/test/test_mysql.py0000644000000000000000000002201515064275501015455 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import unittest, os, shutil, time import pytest from roundup.hyperdb import DatabaseError from roundup.backends import get_backend, have_backend from .db_test_base import DBTest, ROTest, config, SchemaTest, ClassicInitTest from .db_test_base import ConcurrentDBTest, HTMLItemTest, FilterCacheTest from .db_test_base import SpecialActionTest from .rest_common import TestCase as RestTestCase class mysqlOpener: if have_backend('mysql'): module = get_backend('mysql') def setUp(self): self.module.db_nuke(config) def tearDown(self): self.db.close() self.nuke_database() def nuke_database(self): self.module.db_nuke(config) # FIX: workaround for a bug in pytest.mark.skip(): # https://github.com/pytest-dev/pytest/issues/568 from .pytest_patcher import mark_class if not have_backend('mysql'): skip_mysql = mark_class(pytest.mark.skip( reason='Skipping MySQL tests: backend not available')) else: try: import MySQLdb mysqlOpener.module.db_exists(config) skip_mysql = lambda func, *args, **kwargs: func except (MySQLdb.MySQLError, DatabaseError) as msg: skip_mysql = mark_class(pytest.mark.skip( reason='Skipping MySQL tests: %s' % str(msg))) @skip_mysql class mysqlDBTest(mysqlOpener, DBTest, unittest.TestCase): def setUp(self): mysqlOpener.setUp(self) DBTest.setUp(self) def testUpgrade_6_to_7(self): # load the database self.db.issue.create(title="flebble frooz") self.db.commit() if self.db.database_schema['version'] > 7: # make testUpgrades run the downgrade code only. if hasattr(self, "downgrade_only"): # we are being called by an earlier test self.testUpgrade_7_to_8() self.assertEqual(self.db.database_schema['version'], 7) else: # we are being called directly self.downgrade_only = True self.testUpgrade_7_to_8() self.assertEqual(self.db.database_schema['version'], 7) del(self.downgrade_only) elif self.db.database_schema['version'] != 7: self.skipTest("This test only runs for database version 7") # test by shrinking _words and trying to insert a long value # it should fail. # run post-init # same test should succeed. self.db.sql("alter table __words change column " "_word _word varchar(10)") long_string = "a" * (self.db.indexer.maxlength + 5) with self.assertRaises(MySQLdb.DataError) as ctx: # DataError : Data too long for column '_word' at row 1 self.db.sql("insert into __words VALUES('%s',1)" % long_string) self.assertIn("Data too long for column '_word'", ctx.exception.args[1]) self.db.database_schema['version'] = 6 if hasattr(self,"downgrade_only"): return # test upgrade altering row self.db.post_init() self.assertEqual(self.db.db_version_updated, True) # This insert with text of expected column size should succeed self.db.sql("insert into __words VALUES('%s',1)" % long_string) # Verify it fails at one more than the expected column size too_long_string = "a" * (self.db.indexer.maxlength + 6) with self.assertRaises(MySQLdb.DataError) as ctx: self.db.sql("insert into __words VALUES('%s',1)" % too_long_string) self.assertEqual(self.db.database_schema['version'], self.db.current_db_version) def testUpgrade_7_to_8(self): # load the database self.db.issue.create(title="flebble frooz") self.db.commit() if self.db.database_schema['version'] != 8: self.skipTest("This test only runs for database version 8") # change otk and session db's _time value to their original types sql = "alter table sessions modify session_time float;" self.db.sql(sql) sql = "alter table otks modify otk_time float;" self.db.sql(sql) # verify they truncate long ints. test_double = 1658718284.7616878 for tablename in ['otk', 'session']: self.db.sql( 'insert %(name)ss(%(name)s_key, %(name)s_time, %(name)s_value) ' 'values("foo", %(double)s, "value");'%{'name': tablename, 'double': test_double} ) self.db.cursor.execute('select %(name)s_time from %(name)ss ' 'where %(name)s_key = "foo"'%{'name': tablename}) self.assertNotAlmostEqual(self.db.cursor.fetchone()[0], test_double, -1) # cleanup or else the inserts after the upgrade will not # work. self.db.sql("delete from %(name)ss where %(name)s_key='foo'"%{ 'name': tablename} ) self.db.database_schema['version'] = 7 if hasattr(self,"downgrade_only"): return # test upgrade self.db.post_init() self.assertEqual(self.db.db_version_updated, True) # verify they keep all signifcant digits before the decimal point for tablename in ['otk', 'session']: self.db.sql( 'insert %(name)ss(%(name)s_key, %(name)s_time, %(name)s_value) ' 'values("foo", %(double)s, "value");'%{'name': tablename, 'double': test_double} ) self.db.cursor.execute('select %(name)s_time from %(name)ss ' 'where %(name)s_key = "foo"'%{'name': tablename}) # -1 compares just the integer part. No fractions. self.assertAlmostEqual(self.db.cursor.fetchone()[0], test_double, -1) self.assertEqual(self.db.database_schema['version'], 8) @skip_mysql class mysqlROTest(mysqlOpener, ROTest, unittest.TestCase): def setUp(self): mysqlOpener.setUp(self) ROTest.setUp(self) @skip_mysql class mysqlSchemaTest(mysqlOpener, SchemaTest, unittest.TestCase): def setUp(self): mysqlOpener.setUp(self) SchemaTest.setUp(self) @skip_mysql class mysqlClassicInitTest(mysqlOpener, ClassicInitTest, unittest.TestCase): backend = 'mysql' def setUp(self): mysqlOpener.setUp(self) ClassicInitTest.setUp(self) def tearDown(self): ClassicInitTest.tearDown(self) self.nuke_database() @skip_mysql class mysqlConcurrencyTest(mysqlOpener, ConcurrentDBTest, unittest.TestCase): backend = 'mysql' def setUp(self): mysqlOpener.setUp(self) ConcurrentDBTest.setUp(self) def tearDown(self): ConcurrentDBTest.tearDown(self) self.nuke_database() @skip_mysql class mysqlHTMLItemTest(mysqlOpener, HTMLItemTest, unittest.TestCase): backend = 'mysql' def setUp(self): mysqlOpener.setUp(self) HTMLItemTest.setUp(self) def tearDown(self): HTMLItemTest.tearDown(self) self.nuke_database() @skip_mysql class mysqlFilterCacheTest(mysqlOpener, FilterCacheTest, unittest.TestCase): backend = 'mysql' def setUp(self): mysqlOpener.setUp(self) FilterCacheTest.setUp(self) def tearDown(self): FilterCacheTest.tearDown(self) self.nuke_database() from .session_common import SessionTest @skip_mysql class mysqlSessionTest(mysqlOpener, SessionTest, unittest.TestCase): s2b = lambda x,y : y def setUp(self): mysqlOpener.setUp(self) SessionTest.setUp(self) def tearDown(self): SessionTest.tearDown(self) mysqlOpener.tearDown(self) @skip_mysql class mysqlSpecialActionTestCase(mysqlOpener, SpecialActionTest, unittest.TestCase): backend = 'mysql' def setUp(self): mysqlOpener.setUp(self) SpecialActionTest.setUp(self) def tearDown(self): SpecialActionTest.tearDown(self) mysqlOpener.tearDown(self) @skip_mysql class mysqlRestTest (RestTestCase, unittest.TestCase): backend = 'mysql' # vim: set et sts=4 sw=4 : code-e5bd50120b5a/test/test_postgresql.py0000644000000000000000000006567615064275501016537 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import os import unittest import pytest from roundup.hyperdb import DatabaseError from roundup.backends import get_backend, have_backend from .db_test_base import DBTest, ROTest, config, SchemaTest, ClassicInitTest from .db_test_base import ConcurrentDBTest, HTMLItemTest, FilterCacheTest from .db_test_base import ClassicInitBase, setupTracker, SpecialActionTest from .rest_common import TestCase as RestTestCase if not have_backend('postgresql'): # FIX: workaround for a bug in pytest.mark.skip(): # https://github.com/pytest-dev/pytest/issues/568 from .pytest_patcher import mark_class skip_postgresql = mark_class(pytest.mark.skip( reason='Skipping PostgreSQL tests: backend not available')) else: try: from roundup.backends.back_postgresql import psycopg2, db_command,\ get_database_schema_names db_command(config, 'select 1') skip_postgresql = lambda func, *args, **kwargs: func except( DatabaseError ) as msg: from .pytest_patcher import mark_class skip_postgresql = mark_class(pytest.mark.skip( reason='Skipping PostgreSQL tests: database not available')) @skip_postgresql class postgresqlOpener: if have_backend('postgresql'): module = get_backend('postgresql') def setup_class(cls): # nuke the db once for the class. Handles the case # where an aborted test run (^C during setUp for example) # leaves the database in an unusable, partly configured state. try: cls.nuke_database() except Exception as m: # ignore failure to nuke the database if it doesn't exist. # otherwise abort if str(m.args[0]) == ( 'database "%s" does not exist' % config.RDBMS_NAME): pass else: raise def setUp(self): pass def tearDown(self): self.nuke_database() @classmethod def nuke_database(self): # clear out the database - easiest way is to nuke and re-create it self.module.db_nuke(config) @skip_postgresql class postgresqlSchemaOpener: RDBMS_NAME="rounduptest_schema.rounduptest" RDBMS_USER="rounduptest_schema" if have_backend('postgresql'): module = get_backend('postgresql') def setup_class(cls): # nuke the schema for the class. Handles the case # where an aborted test run (^C during setUp for example) # leaves the database in an unusable, partly configured state. config.RDBMS_NAME=cls.RDBMS_NAME config.RDBMS_USER=cls.RDBMS_USER database, schema = get_database_schema_names(config) try: cls.nuke_database() except Exception as m: # ignore failure to nuke the database if it doesn't exist. # otherwise abort if str(m.args[0]) == ( 'schema "%s" does not exist' % schema): pass else: raise def setUp(self): # make sure to override the rdbms settings. # before every test. config.RDBMS_NAME=self.RDBMS_NAME config.RDBMS_USER=self.RDBMS_USER def tearDown(self): self.nuke_database() config.RDBMS_NAME="rounduptest" config.RDBMS_USER="rounduptest" @classmethod def nuke_database(self): # clear out the database - easiest way is to nuke and re-create it self.module.db_nuke(config) @skip_postgresql class postgresqlServiceOpener: """Test finding db and schema using pg_service.conf file.""" PG_SERVICE="test/pg_service.conf" # look at the shipped pg_service file. # default use db; overridden in test for schema RDBMS_SERVICE="roundup_test_db" if have_backend('postgresql'): module = get_backend('postgresql') def setup_class(cls): # nuke the schema for the class. Handles the case # where an aborted test run (^C during setUp for example) # leaves the database in an unusable, partly configured state. config.RDBMS_NAME="" config.RDBMS_USER="" config.RDBMS_PASSWORD="" config.RDBMS_SERVICE=cls.RDBMS_SERVICE os.environ['PGSERVICEFILE'] = cls.PG_SERVICE # this is bad. but short of creating a new opener it works. if cls.RDBMS_SERVICE == "roundup_test_schema_bad": return database, schema = get_database_schema_names(config) try: cls.nuke_database() except Exception as m: # ignore failure to nuke the database if it doesn't exist. if str(m.args[0]) == ( 'database "%s" does not exist' % database) \ and not schema: pass # ignore failure to nuke the schema if it doesn't exist. elif str(m.args[0]) == ( 'schema "%s" does not exist' % schema) and schema: pass else: raise def setUp(self): # make sure to override the rdbms settings. # before every test. config.RDBMS_NAME="" config.RDBMS_USER="" config.RDBMS_PASSWORD="" config.RDBMS_SERVICE=self.RDBMS_SERVICE os.environ['PGSERVICEFILE'] = self.PG_SERVICE def tearDown(self): # this is bad. but short of creating a new opener it works. if self.RDBMS_SERVICE != "roundup_test_schema_bad": self.nuke_database() config.RDBMS_NAME="rounduptest" config.RDBMS_USER="rounduptest" config.RDBMS_PASSWORD="rounduptest" config.RDBMS_SERVICE="" del(os.environ['PGSERVICEFILE']) @classmethod def nuke_database(self): # clear out the database - easiest way is to nuke and re-create it self.module.db_nuke(config) @skip_postgresql class postgresqlPrecreatedSchemaDbOpener: """Open the db where the user has only schema create rights. The test tries to nuke the db and should result in an exception. RDBMS_NAME should not have the .schema on it as we want to operate on the db itself with db_nuke. """ RDBMS_NAME="rounduptest_schema" RDBMS_USER="rounduptest_schema" if have_backend('postgresql'): module = get_backend('postgresql') def setup_class(cls): # nuke the schema for the class. Handles the case # where an aborted test run (^C during setUp for example) # leaves the database in an unusable, partly configured state. config.RDBMS_NAME=cls.RDBMS_NAME config.RDBMS_USER=cls.RDBMS_USER def setUp(self): # make sure to override the rdbms settings. # before every test. config.RDBMS_NAME=self.RDBMS_NAME config.RDBMS_USER=self.RDBMS_USER def tearDown(self): config.RDBMS_NAME="rounduptest" config.RDBMS_USER="rounduptest" @classmethod def nuke_database(self): # clear out the database - easiest way is to nuke and re-create it self.module.db_nuke(config) @skip_postgresql class postgresqlAdditionalDBTest(): def testUpgrade_6_to_7(self): # load the database self.db.issue.create(title="flebble frooz") self.db.commit() if self.db.database_schema['version'] > 7: # make testUpgrades run the downgrade code only. if hasattr(self, "downgrade_only"): # we are being called by an earlier test self.testUpgrade_7_to_8() self.assertEqual(self.db.database_schema['version'], 7) else: # we are being called directly self.downgrade_only = True self.testUpgrade_7_to_8() self.assertEqual(self.db.database_schema['version'], 7) del(self.downgrade_only) elif self.db.database_schema['version'] != 7: self.skipTest("This test only runs for database version 7") # remove __fts table/index; shrink length of __words._words # trying to insert a long word in __words._words should fail. # trying to select from __fts should fail # looking for the index should fail # run post-init # tests should succeed. self.db.sql("drop table __fts") # also drops __fts_idx self.db.sql("alter table __words ALTER column _word type varchar(10)") self.db.commit() self.db.database_schema['version'] = 6 long_string = "a" * (self.db.indexer.maxlength + 5) with self.assertRaises(psycopg2.DataError) as ctx: # DataError : value too long for type character varying(10) self.db.sql("insert into __words VALUES('%s',1)" % long_string) self.assertIn("varying(10)", ctx.exception.args[0]) self.db.rollback() # clear cursor error so db.sql can be used again with self.assertRaises(psycopg2.errors.UndefinedTable) as ctx: self.db.sql("select * from _fts") self.db.rollback() self.assertFalse(self.db.sql_index_exists('__fts', '__fts_idx')) if hasattr(self, "downgrade_only"): return # test upgrade path self.db.post_init() self.assertEqual(self.db.db_version_updated, True) # This insert with text of expected column size should succeed self.db.sql("insert into __words VALUES('%s',1)" % long_string) # verify it fails at one more than the expected column size too_long_string = "a" * (self.db.indexer.maxlength + 6) with self.assertRaises(psycopg2.DataError) as ctx: self.db.sql("insert into __words VALUES('%s',1)" % too_long_string) # clean db handle self.db.rollback() self.assertTrue(self.db.sql_index_exists('__fts', '__fts_idx')) self.db.sql("select * from __fts") self.assertEqual(self.db.database_schema['version'], self.db.current_db_version) def testUpgrade_7_to_8(self): """ change _time fields in BasicDatabases to double """ # load the database self.db.issue.create(title="flebble frooz") self.db.commit() if self.db.database_schema['version'] != 8: self.skipTest("This test only runs for database version 8") # change otk and session db's _time value to their original types sql = "alter table sessions alter column session_time type REAL;" self.db.sql(sql) sql = "alter table otks alter column otk_time type REAL;" self.db.sql(sql) # verify they truncate long ints. test_double = 1658718284.7616878 for tablename in ['otk', 'session']: self.db.sql( 'insert into %(name)ss(%(name)s_key, %(name)s_time, %(name)s_value) ' "values ('foo', %(double)s, 'value');"%{'name': tablename, 'double': test_double} ) self.db.cursor.execute('select %(name)s_time from %(name)ss ' "where %(name)s_key = 'foo'"%{'name': tablename}) self.assertNotAlmostEqual(self.db.cursor.fetchone()[0], test_double, -1) # cleanup or else the inserts after the upgrade will not # work. self.db.sql("delete from %(name)ss where %(name)s_key='foo'"%{ 'name': tablename} ) self.db.database_schema['version'] = 7 if hasattr(self,"downgrade_only"): return # test upgrade altering row self.db.post_init() self.assertEqual(self.db.db_version_updated, True) # verify they keep all signifcant digits before the decimal point for tablename in ['otk', 'session']: self.db.sql( 'insert into %(name)ss(%(name)s_key, %(name)s_time, %(name)s_value) ' "values ('foo', %(double)s, 'value');"%{'name': tablename, 'double': test_double} ) self.db.cursor.execute('select %(name)s_time from %(name)ss ' "where %(name)s_key = 'foo'"%{'name': tablename}) self.assertAlmostEqual(self.db.cursor.fetchone()[0], test_double, -1) self.assertEqual(self.db.database_schema['version'], 8) @skip_postgresql class postgresqlDBTest(postgresqlOpener, DBTest, postgresqlAdditionalDBTest, unittest.TestCase): def setUp(self): # set for manual integration testing of 'native-fts' # It is unset in tearDown so it doesn't leak into other tests. # FIXME extract test methods in DBTest that hit the indexer # into a new class (DBTestIndexer). Add DBTestIndexer # to this class. # Then create a new class in this file: # postgresqlDBTestIndexerNative_FTS # that imports from DBestIndexer to test native-fts. # config['INDEXER'] = 'native-fts' postgresqlOpener.setUp(self) DBTest.setUp(self) def tearDown(self): # clean up config to prevent leak if native-fts is tested config['INDEXER'] = '' DBTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlDBTestSchema(postgresqlSchemaOpener, DBTest, postgresqlAdditionalDBTest, unittest.TestCase): def setUp(self): # set for manual integration testing of 'native-fts' # It is unset in tearDown so it doesn't leak into other tests. # FIXME extract test methods in DBTest that hit the indexer # into a new class (DBTestIndexer). Add DBTestIndexer # to this class. # Then create a new class in this file: # postgresqlDBTestIndexerNative_FTS # that imports from DBestIndexer to test native-fts. # config['INDEXER'] = 'native-fts' postgresqlSchemaOpener.setUp(self) DBTest.setUp(self) def tearDown(self): # clean up config to prevent leak if native-fts is tested config['INDEXER'] = '' DBTest.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql class postgresqlROTest(postgresqlOpener, ROTest, unittest.TestCase): def setUp(self): postgresqlOpener.setUp(self) ROTest.setUp(self) def tearDown(self): ROTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlROTestSchema(postgresqlSchemaOpener, ROTest, unittest.TestCase): def setUp(self): postgresqlSchemaOpener.setUp(self) ROTest.setUp(self) def tearDown(self): ROTest.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql class postgresqlServiceTest(postgresqlServiceOpener, ROTest, unittest.TestCase): """Test using pg_service.conf using the db to make sure connection happens properly. Reuses ROTest because it's a short test. """ def setUp(self): postgresqlServiceOpener.setUp(self) ROTest.setUp(self) def tearDown(self): ROTest.tearDown(self) postgresqlServiceOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlServiceSchema(postgresqlServiceOpener, ROTest, unittest.TestCase): """Test using pg_service.conf using a schema to make sure connection happens properly. Reuses ROTest because it's a short test. """ RDBMS_SERVICE="roundup_test_schema" def setUp(self): postgresqlServiceOpener.setUp(self) ROTest.setUp(self) def tearDown(self): ROTest.tearDown(self) postgresqlServiceOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlServiceSchemaBad(postgresqlServiceOpener, unittest.TestCase): """Test using pg_service.conf with incorrectly defined schema. Check error message. No need for database. FIXME: postgresqlServiceOpener.{setUp,tearDown} are written to behave differently if cls.RDBMS_SERVICE="roundup_test_schema_bad". I wanted the test, but I couldn't figure out a different way to do this without creating a new opener and I didn't want to 8-). """ RDBMS_SERVICE="roundup_test_schema_bad" def setUp(self): postgresqlServiceOpener.setUp(self) def tearDown(self): postgresqlServiceOpener.tearDown(self) def test_bad_Schema_in_pg_service(self): with self.assertRaises(ValueError) as m: get_database_schema_names(config) print(m.exception.args[0]) self.assertEqual(m.exception.args[0], 'Unable to get schema for service: "roundup_test_schema_bad" from options: "-c search_path="') @skip_postgresql class postgresqlConcurrencyTest(postgresqlOpener, ConcurrentDBTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlOpener.setUp(self) ConcurrentDBTest.setUp(self) def tearDown(self): ConcurrentDBTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlConcurrencyTestSchema(postgresqlSchemaOpener, ConcurrentDBTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlSchemaOpener.setUp(self) ConcurrentDBTest.setUp(self) def tearDown(self): ConcurrentDBTest.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql class postgresqlAdditionalJournalTest(): def _test_journal(self, expected_journal): id = self.id db1 = self.db1 = self.tracker.open('admin') db2 = self.db2 = self.tracker.open('admin') t1 = db1.issue.get(id, 'title') t2 = db2.issue.get(id, 'title') db1.issue.set (id, title='t1') db1.commit() db1.close() # Test testConcurrentRepeatableRead is expected to raise # an error when the db2.issue.set() call is executed. try: db2.issue.set (id, title='t2') db2.commit() finally: # Make sure that the db2 connection is closed, even when # an error is raised. db2.close() self.db = self.tracker.open('admin') journal = self.db.getjournal('issue', id) for n, line in enumerate(journal): self.assertEqual(line[4], expected_journal[n]) def testConcurrentReadCommitted(self): expected_journal = [ {}, {'title': 'initial value'}, {'title': 'initial value'} ] self._test_journal(expected_journal) def testConcurrentRepeatableRead(self): self.tracker.config.RDBMS_ISOLATION_LEVEL='repeatable read' exc = self.module.TransactionRollbackError self.assertRaises(exc, self._test_journal, []) @skip_postgresql class postgresqlJournalTest(postgresqlOpener, ClassicInitBase, postgresqlAdditionalJournalTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlOpener.setUp(self) ClassicInitBase.setUp(self) self.tracker = setupTracker(self.dirname, self.backend) db = self.tracker.open('admin') self.id = db.issue.create(title='initial value') db.commit() db.close() def tearDown(self): try: self.db1.close() self.db2.close() except psycopg2.InterfaceError as exc: if 'connection already closed' in str(exc): pass else: raise ClassicInitBase.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlJournalTestSchema(postgresqlSchemaOpener, ClassicInitBase, postgresqlAdditionalJournalTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlSchemaOpener.setUp(self) ClassicInitBase.setUp(self) self.tracker = setupTracker(self.dirname, self.backend) db = self.tracker.open('admin') self.id = db.issue.create(title='initial value') db.commit() db.close() def tearDown(self): try: self.db1.close() self.db2.close() except psycopg2.InterfaceError as exc: if 'connection already closed' in str(exc): pass else: raise ClassicInitBase.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql class postgresqlHTMLItemTest(postgresqlOpener, HTMLItemTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlOpener.setUp(self) HTMLItemTest.setUp(self) def tearDown(self): HTMLItemTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlHTMLItemTestSchema(postgresqlSchemaOpener, HTMLItemTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlSchemaOpener.setUp(self) HTMLItemTest.setUp(self) def tearDown(self): HTMLItemTest.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql class postgresqlFilterCacheTest(postgresqlOpener, FilterCacheTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlOpener.setUp(self) FilterCacheTest.setUp(self) def tearDown(self): FilterCacheTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlFilterCacheTestSchema(postgresqlSchemaOpener, FilterCacheTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlSchemaOpener.setUp(self) FilterCacheTest.setUp(self) def tearDown(self): FilterCacheTest.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql class postgresqlSchemaTest(postgresqlOpener, SchemaTest, unittest.TestCase): def setUp(self): postgresqlOpener.setUp(self) SchemaTest.setUp(self) def tearDown(self): SchemaTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlSchemaTestSchema(postgresqlSchemaOpener, SchemaTest, unittest.TestCase): def setUp(self): postgresqlSchemaOpener.setUp(self) SchemaTest.setUp(self) def tearDown(self): SchemaTest.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql class postgresqlClassicInitTest(postgresqlOpener, ClassicInitTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlOpener.setUp(self) ClassicInitTest.setUp(self) def tearDown(self): ClassicInitTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlClassicInitTestSchema(postgresqlSchemaOpener, ClassicInitTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlSchemaOpener.setUp(self) ClassicInitTest.setUp(self) def tearDown(self): ClassicInitTest.tearDown(self) postgresqlSchemaOpener.tearDown(self) from .session_common import SessionTest @skip_postgresql class postgresqlSessionTest(postgresqlOpener, SessionTest, unittest.TestCase): s2b = lambda x,y : y def setUp(self): postgresqlOpener.setUp(self) SessionTest.setUp(self) def tearDown(self): SessionTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlSessionTestSchema(postgresqlSchemaOpener, SessionTest, unittest.TestCase): s2b = lambda x,y : y def setUp(self): postgresqlSchemaOpener.setUp(self) SessionTest.setUp(self) def tearDown(self): SessionTest.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql class postgresqlSpecialActionTestCase(postgresqlOpener, SpecialActionTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlOpener.setUp(self) SpecialActionTest.setUp(self) def tearDown(self): SpecialActionTest.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlSpecialActionTestCaseSchema(postgresqlSchemaOpener, SpecialActionTest, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlSchemaOpener.setUp(self) SpecialActionTest.setUp(self) def tearDown(self): SpecialActionTest.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql class postgresqlRestTest (postgresqlOpener, RestTestCase, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlOpener.setUp(self) RestTestCase.setUp(self) def tearDown(self): RestTestCase.tearDown(self) postgresqlOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlRestTestSchema(postgresqlSchemaOpener, RestTestCase, unittest.TestCase): backend = 'postgresql' def setUp(self): postgresqlSchemaOpener.setUp(self) RestTestCase.setUp(self) def tearDown(self): RestTestCase.tearDown(self) postgresqlSchemaOpener.tearDown(self) @skip_postgresql @pytest.mark.pg_schema class postgresqlDbDropFailureTestSchema(postgresqlPrecreatedSchemaDbOpener, unittest.TestCase): def test_drop(self): """Verify that the schema test database can not be dropped.""" with self.assertRaises(RuntimeError) as m: self.module.db_nuke(config) self.assertEqual(m.exception.args[0], 'must be owner of database rounduptest_schema') # vim: set et sts=4 sw=4 : code-e5bd50120b5a/test/test_pythonexpr.py0000644000000000000000000000223715064275501016534 0ustar 00000000000000""" In Python 3, sometimes TAL "python:" expressions that refer to variables but not all variables are recognized. That is in Python 2.7 all variables used in a TAL "python:" expression are recognized as references. In Python 3.5 (perhaps earlier), some TAL "python:" expressions refer to variables but the reference generates an error like this: : name 'some_tal_variable' is not defined even when the variable is defined. Output after this message lists the variable and its value. """ import unittest from roundup.cgi.PageTemplates.PythonExpr import PythonExpr as PythonExprClass class ExprTest(unittest.TestCase): def testExpr(self): expr = '[x for x in context.assignedto ' \ 'if x.realname not in user_realnames]' pe = PythonExprClass('test', expr, None) # Looking at the expression, only context and user_realnames are # external variables. The names assignedto and realname are members, # and x is local. required_names = ['context', 'user_realnames'] got_names = pe._f_varnames for required_name in required_names: self.assertIn(required_name, got_names) code-e5bd50120b5a/test/test_redis_session.py0000644000000000000000000001140615064275501017163 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import unittest, os, shutil, time from roundup.anypy import strings import pytest try: from roundup.backends.sessions_redis import Sessions, OneTimeKeys skip_redis = lambda func, *args, **kwargs: func from redis import AuthenticationError, ConnectionError except ImportError as e: from .pytest_patcher import mark_class skip_redis = mark_class(pytest.mark.skip( reason='Skipping redis tests: redis module not available')) from .test_sqlite import sqliteOpener from .test_anydbm import anydbmOpener from .session_common import SessionTest class RedisSessionTest(SessionTest): def setUp(self): '''This must not be called if redis can not be loaded. It will cause an error since the ConnectionError and AuthenticationError exceptions aren't defined. ''' SessionTest.setUp(self) import os if 'pytest_redis_pw' in os.environ and os.environ['pytest_redis_pw']: pw = os.environ['pytest_redis_pw'] if ':' in pw: # pw is user:password pw = "%s@" % pw else: # pw is just password pw = ":%s@" % pw else: pw = "" # redefine the session db's as redis. # close the existing session databases before opening new ones. self.db.Session.close() self.db.Otk.close() self.db.config.SESSIONDB_BACKEND = "redis" self.db.config.SESSIONDB_REDIS_URL = \ 'redis://%slocalhost:6379/15?health_check_interval=2' % pw self.db.Session = None self.db.Otk = None self.sessions = self.db.getSessionManager() self.otks = self.db.getOTKManager() try: self.sessions.redis.keys() except (AuthenticationError, ConnectionError) as e: self.skipTest('Redis server unavailable: "%s".' % e) # database should be empty. Verify so we don't clobber # somebody's working database. self.assertEqual(self.sessions.redis.keys(), [], "Tests will not run on a db with keys. " "Run flushdb in 'redis-cli -n 15 -p 6379 -h localhost' " "to empty db first") self.assertEqual(self.otks.redis.keys(), [], "Tests will not run on a db with keys. " "Run flushdb in 'redis-cli -n 15 -p 6379 -h localhost' " "to empty db first") def tearDown(self): self.sessions.clear() self.otks.clear() SessionTest.tearDown(self) # reset to default session backend self.db.config.SESSIONDB_BACKEND = "" self.db.Session = None self.db.Otk = None self.sessions = None self.otks = None def get_ts(self, key="random_session"): db_tstamp = self.db.Session.redis.ttl( self.db.Session.makekey(key)) + \ time.time() print(db_tstamp) return (db_tstamp,) @skip_redis class redis_sqliteSessionTest(sqliteOpener, RedisSessionTest, unittest.TestCase): s2b = lambda x,y : y def testLifetime(self): ts = self.sessions.lifetime(300) print(ts) now = time.time() print(now) self.assertGreater(now + 302, ts) self.assertLess(now + 298, ts) def testDbType(self): self.assertIn("roundlite", repr(self.db)) self.assertIn("roundup.backends.sessions_redis.Sessions", repr(self.db.Session)) @skip_redis class redis_anydbmSessionTest(anydbmOpener, RedisSessionTest, unittest.TestCase): s2b = lambda x,y: strings.s2b(y) def testLifetime(self): ts = self.sessions.lifetime(300) print(ts) now = time.time() print(now) self.assertGreater(now + 302, ts) self.assertLess(now + 298, ts) def testDbType(self): self.assertIn("back_anydbm", repr(self.db)) self.assertIn("roundup.backends.sessions_redis.Sessions", repr(self.db.Session)) code-e5bd50120b5a/test/test_schema.py0000644000000000000000000000564015064275501015555 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import unittest, os, shutil from roundup import configuration from roundup.backends import back_anydbm from roundup.hyperdb import String, Password, Link, Multilink, Date, \ Interval config = configuration.CoreConfig() config.DATABASE = "_test_dir" class SchemaTestCase(unittest.TestCase): def setUp(self): # remove previous test, ignore errors if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) os.makedirs(config.DATABASE + '/files') self.db = back_anydbm.Database(config, 'admin') self.db.post_init() self.db.clear() def tearDown(self): self.db.close() shutil.rmtree(config.DATABASE) def testA_Status(self): status = back_anydbm.Class(self.db, "status", name=String()) self.assertTrue(status, 'no class object generated') status.setkey("name") val = status.create(name="unread") self.assertEqual(val, '1', 'expecting "1"') val = status.create(name="in-progress") self.assertEqual(val, '2', 'expecting "2"') val = status.create(name="testing") self.assertEqual(val, '3', 'expecting "3"') val = status.create(name="resolved") self.assertEqual(val, '4', 'expecting "4"') val = status.count() self.assertEqual(val, 4, 'expecting 4') val = status.list() self.assertEqual(val, ['1', '2', '3', '4'], 'blah') val = status.lookup("in-progress") self.assertEqual(val, '2', 'expecting "2"') status.retire('3') val = status.list() self.assertEqual(val, ['1', '2', '4'], 'blah') def testB_Issue(self): issue = back_anydbm.Class(self.db, "issue", title=String(), status=Link("status")) self.assertTrue(issue, 'no class object returned') def testC_User(self): user = back_anydbm.Class(self.db, "user", username=String(), password=Password()) self.assertTrue(user, 'no class object returned') user.setkey("username") # vim: set filetype=python sts=4 sw=4 et si : code-e5bd50120b5a/test/test_security.py0000644000000000000000000006452415064275501016172 0ustar 00000000000000# Copyright (c) 2002 ekit.com Inc (http://www.ekit-inc.com/) # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. from __future__ import print_function import os import shutil import unittest from roundup import backends import roundup.password from .db_test_base import setupSchema, MyTestCase, config class PermissionTest(MyTestCase, unittest.TestCase): def setUp(self): backend = backends.get_backend('anydbm') # remove previous test, ignore errors if os.path.exists(config.DATABASE): shutil.rmtree(config.DATABASE) os.makedirs(config.DATABASE + '/files') self.db = backend.Database(config, 'admin') setupSchema(self.db, 1, backend) def testInterfaceSecurity(self): ' test that the CGI and mailgw have initialised security OK ' # TODO: some asserts def testInitialiseSecurity(self): ei = self.db.security.addPermission( name="Edit", klass="issue", description="User is allowed to edit issues") self.db.security.addPermissionToRole('User', ei) ai = self.db.security.addPermission( name="View", klass="issue", description="User is allowed to access issues") self.db.security.addPermissionToRole('User', ai) def testAdmin(self): ei = self.db.security.addPermission( name="Edit", klass="issue", description="User is allowed to edit issues") self.db.security.addPermissionToRole('User', ei) ei = self.db.security.addPermission( name="Edit", klass=None, description="User is allowed to edit issues") self.db.security.addPermissionToRole('Admin', ei) u1 = self.db.user.create(username='one', roles='Admin') u2 = self.db.user.create(username='two', roles='User') self.assertTrue(self.db.security.hasPermission('Edit', u1, None)) self.assertTrue(not self.db.security.hasPermission('Edit', u2, None)) def testGetPermission(self): self.db.security.getPermission('Edit') self.db.security.getPermission('View') self.assertRaises(ValueError, self.db.security.getPermission, 'x') self.assertRaises(ValueError, self.db.security.getPermission, 'Edit', 'fubar') add = self.db.security.addPermission get = self.db.security.getPermission # class ei = add(name="Edit", klass="issue") self.assertEqual(get('Edit', 'issue'), ei) ai = add(name="View", klass="issue") self.assertEqual(get('View', 'issue'), ai) # property epi1 = add(name="Edit", klass="issue", properties=['title']) self.assertEqual(get('Edit', 'issue', properties=['title']), epi1) epi2 = add(name="Edit", klass="issue", properties=['title'], props_only=True) self.assertEqual(get('Edit', 'issue', properties=['title'], props_only=False), epi1) self.assertEqual(get('Edit', 'issue', properties=['title'], props_only=True), epi2) self.db.security.set_props_only_default(True) self.assertEqual(get('Edit', 'issue', properties=['title']), epi2) api1 = add(name="View", klass="issue", properties=['title']) self.assertEqual(get('View', 'issue', properties=['title']), api1) self.db.security.set_props_only_default(False) api2 = add(name="View", klass="issue", properties=['title']) self.assertEqual(get('View', 'issue', properties=['title']), api2) self.assertNotEqual(get('View', 'issue', properties=['title']), api1) # check function dummy = lambda: 0 eci = add(name="Edit", klass="issue", check=dummy) self.assertEqual(get('Edit', 'issue', check=dummy), eci) # props_only only makes sense if you are setting props. # make it a no-op unless properties is set. self.assertEqual(get('Edit', 'issue', check=dummy, props_only=True), eci) aci = add(name="View", klass="issue", check=dummy) self.assertEqual(get('View', 'issue', check=dummy), aci) # all epci = add(name="Edit", klass="issue", properties=['title'], check=dummy) self.db.security.set_props_only_default(False) # implicit props_only=False self.assertEqual(get('Edit', 'issue', properties=['title'], check=dummy), epci) # explicit props_only=False self.assertEqual(get('Edit', 'issue', properties=['title'], check=dummy, props_only=False), epci) # implicit props_only=True self.db.security.set_props_only_default(True) self.assertRaises(ValueError, get, 'Edit', 'issue', properties=['title'], check=dummy) # explicit props_only=False self.assertRaises(ValueError, get, 'Edit', 'issue', properties=['title'], check=dummy, props_only=True) apci = add(name="View", klass="issue", properties=['title'], check=dummy) self.assertEqual(get('View', 'issue', properties=['title'], check=dummy), apci) # Reset to default. Somehow this setting looks like it # was bleeding through to other tests in test_xmlrpc. # Is the security module being loaded only once for all tests?? self.db.security.set_props_only_default(False) def testDBinit(self): self.db.user.create(username="demo", roles='User') self.db.user.create(username="anonymous", roles='Anonymous') def testAccessControls(self): add = self.db.security.addPermission has = self.db.security.hasPermission addRole = self.db.security.addRole addToRole = self.db.security.addPermissionToRole none = self.db.user.create(username='none', roles='None') # test admin access addRole(name='Super') addToRole('Super', add(name="Test")) super = self.db.user.create(username='super', roles='Super') # test class-level access addRole(name='Role1') addToRole('Role1', add(name="Test", klass="test")) user1 = self.db.user.create(username='user1', roles='Role1') self.assertEqual(has('Test', user1, 'test'), 1) self.assertEqual(has('Test', super, 'test'), 1) self.assertEqual(has('Test', none, 'test'), 0) # property addRole(name='Role2') addToRole('Role2', add(name="Test", klass="test", properties=['a', 'b'])) user2 = self.db.user.create(username='user2', roles='Role2') # check function check_old_style = lambda db, userid, itemid: itemid == '2' # def check_old_style(db, userid, itemid): # print "checking userid, itemid: %r"%((userid,itemid),) # return(itemid == '2') # setup to check function new style. Make sure that # other args are passed. def check(db, userid, itemid, **other): prop = other['property'] prop = other['classname'] prop = other['permission'] return (itemid == '1') # also create a check as a callable of a class # https://issues.roundup-tracker.org/issue2550952 class CheckClass(object): def __call__(self, db, userid, itemid, **other): prop = other['property'] prop = other['classname'] prop = other['permission'] return (itemid == '1') addRole(name='Role3') # make sure check=CheckClass() and not check=CheckClass # otherwise we get: # inspectible addToRole('Role3', add(name="Test", klass="test", check=CheckClass())) user3 = self.db.user.create(username='user3', roles='Role3') addRole(name='Role4') addToRole('Role4', add(name="Test", klass="test", check=check, properties='a', props_only=True)) user4 = self.db.user.create(username='user4', roles='Role4') self.db.security.set_props_only_default(props_only=True) addRole(name='Role5') addToRole('Role5', add(name="Test", klass="test", check=check_old_style, properties=['a'])) user5 = self.db.user.create(username='user5', roles='Role5') self.db.security.set_props_only_default(False) addRole(name='Role6') addToRole('Role6', add(name="Test", klass="test", check=check, properties=['a', 'b'])) user6 = self.db.user.create(username='user6', roles='Role6') addRole(name='Role7') addToRole('Role7', add(name="Test", klass="test", check=check_old_style, properties=['a', 'b'])) user7 = self.db.user.create(username='user7', roles='Role7') print(user7) # *any* access to class self.assertEqual(has('Test', user1, 'test'), 1) self.assertEqual(has('Test', user2, 'test'), 1) self.assertEqual(has('Test', user3, 'test'), 1) # user4 and user5 should not return true as the permission # is limited to property checks self.assertEqual(has('Test', user4, 'test'), 0) self.assertEqual(has('Test', user5, 'test'), 0) # user6 will will return access self.assertEqual(has('Test', user6, 'test'), 1) # will work because check is ignored, if check was # used this would work but next test would fail self.assertEqual(has('Test', user7, 'test', itemid='2'), 1) # returns true because class tests ignore the check command # if there is no itemid no check command is run self.assertEqual(has('Test', user7, 'test'), 1) self.assertEqual(has('Test', none, 'test'), 0) # *any* access to item self.assertEqual(has('Test', user1, 'test', itemid='1'), 1) self.assertEqual(has('Test', user2, 'test', itemid='1'), 1) self.assertEqual(has('Test', user3, 'test', itemid='1'), 1) self.assertEqual(has('Test', user4, 'test', itemid='1'), 0) self.assertEqual(has('Test', user5, 'test', itemid='1'), 0) self.assertEqual(has('Test', user6, 'test', itemid='1'), 1) self.assertEqual(has('Test', user7, 'test', itemid='2'), 1) self.assertEqual(has('Test', user7, 'test', itemid='1'), 0) self.assertEqual(has('Test', super, 'test', itemid='1'), 1) self.assertEqual(has('Test', none, 'test', itemid='1'), 0) # now property test: no default itemid so check functions not run. self.assertEqual(has('Test', user7, 'test', property='a'), 1) self.assertEqual(has('Test', user7, 'test', property='b'), 1) self.assertEqual(has('Test', user7, 'test', property='c'), 0) self.assertEqual(has('Test', user6, 'test', property='a'), 1) self.assertEqual(has('Test', user6, 'test', property='b'), 1) self.assertEqual(has('Test', user6, 'test', property='c'), 0) self.assertEqual(has('Test', user5, 'test', property='a'), 1) self.assertEqual(has('Test', user5, 'test', property='b'), 0) self.assertEqual(has('Test', user5, 'test', property='c'), 0) self.assertEqual(has('Test', user4, 'test', property='a'), 1) self.assertEqual(has('Test', user4, 'test', property='b'), 0) self.assertEqual(has('Test', user4, 'test', property='c'), 0) self.assertEqual(has('Test', user3, 'test', property='a'), 1) self.assertEqual(has('Test', user3, 'test', property='b'), 1) self.assertEqual(has('Test', user3, 'test', property='c'), 1) self.assertEqual(has('Test', user2, 'test', property='a'), 1) self.assertEqual(has('Test', user2, 'test', property='b'), 1) self.assertEqual(has('Test', user2, 'test', property='c'), 0) self.assertEqual(has('Test', user1, 'test', property='a'), 1) self.assertEqual(has('Test', user1, 'test', property='b'), 1) self.assertEqual(has('Test', user1, 'test', property='c'), 1) self.assertEqual(has('Test', super, 'test', property='a'), 1) self.assertEqual(has('Test', super, 'test', property='b'), 1) self.assertEqual(has('Test', super, 'test', property='c'), 1) self.assertEqual(has('Test', none, 'test', property='a'), 0) self.assertEqual(has('Test', none, 'test', property='b'), 0) self.assertEqual(has('Test', none, 'test', property='c'), 0) self.assertEqual(has('Test', none, 'test'), 0) # now check function self.assertEqual(has('Test', user7, 'test', itemid='1'), 0) self.assertEqual(has('Test', user7, 'test', itemid='2'), 1) self.assertEqual(has('Test', user6, 'test', itemid='1'), 1) self.assertEqual(has('Test', user6, 'test', itemid='2'), 0) # check functions will not run for user4/user5 since the # only perms are for properties only. self.assertEqual(has('Test', user5, 'test', itemid='1'), 0) self.assertEqual(has('Test', user5, 'test', itemid='2'), 0) self.assertEqual(has('Test', user4, 'test', itemid='1'), 0) self.assertEqual(has('Test', user4, 'test', itemid='2'), 0) self.assertEqual(has('Test', user3, 'test', itemid='1'), 1) self.assertEqual(has('Test', user3, 'test', itemid='2'), 0) self.assertEqual(has('Test', user2, 'test', itemid='1'), 1) self.assertEqual(has('Test', user2, 'test', itemid='2'), 1) self.assertEqual(has('Test', user1, 'test', itemid='2'), 1) self.assertEqual(has('Test', user1, 'test', itemid='2'), 1) self.assertEqual(has('Test', super, 'test', itemid='1'), 1) self.assertEqual(has('Test', super, 'test', itemid='2'), 1) self.assertEqual(has('Test', none, 'test', itemid='1'), 0) self.assertEqual(has('Test', none, 'test', itemid='2'), 0) # now mix property and check commands # check is old style props_only = false self.assertEqual(has('Test', user7, 'test', property="c", itemid='2'), 0) self.assertEqual(has('Test', user7, 'test', property="c", itemid='1'), 0) self.assertEqual(has('Test', user7, 'test', property="a", itemid='2'), 1) self.assertEqual(has('Test', user7, 'test', property="a", itemid='1'), 0) # check is new style props_only = false self.assertEqual(has('Test', user6, 'test', itemid='2', property='c'), 0) self.assertEqual(has('Test', user6, 'test', itemid='1', property='c'), 0) self.assertEqual(has('Test', user6, 'test', itemid='2', property='b'), 0) self.assertEqual(has('Test', user6, 'test', itemid='1', property='b'), 1) self.assertEqual(has('Test', user6, 'test', itemid='2', property='a'), 0) self.assertEqual(has('Test', user6, 'test', itemid='1', property='a'), 1) # check is old style props_only = true self.assertEqual(has('Test', user5, 'test', itemid='2', property='b'), 0) self.assertEqual(has('Test', user5, 'test', itemid='1', property='b'), 0) self.assertEqual(has('Test', user5, 'test', itemid='2', property='a'), 1) self.assertEqual(has('Test', user5, 'test', itemid='1', property='a'), 0) # check is new style props_only = true self.assertEqual(has('Test', user4, 'test', itemid='2', property='b'), 0) self.assertEqual(has('Test', user4, 'test', itemid='1', property='b'), 0) self.assertEqual(has('Test', user4, 'test', itemid='2', property='a'), 0) self.assertEqual(has('Test', user4, 'test', itemid='1', property='a'), 1) def testTransitiveSearchPermissions(self): add = self.db.security.addPermission has = self.db.security.hasSearchPermission addRole = self.db.security.addRole addToRole = self.db.security.addPermissionToRole addRole(name='User') addRole(name='Anonymous') addRole(name='Issue') addRole(name='Msg') addRole(name='UV') user = self.db.user.create(username='user1', roles='User') anon = self.db.user.create(username='anonymous', roles='Anonymous') ui = self.db.user.create(username='user2', roles='Issue') uim = self.db.user.create(username='user3', roles='Issue,Msg') uimu = self.db.user.create(username='user4', roles='Issue,Msg,UV') iv = add(name="View", klass="issue") addToRole('User', iv) addToRole('Anonymous', iv) addToRole('Issue', iv) ms = add(name="Search", klass="msg") addToRole('User', ms) addToRole('Anonymous', ms) addToRole('Msg', ms) uv = add(name="View", klass="user") addToRole('User', uv) addToRole('UV', uv) self.assertEqual(has(anon, 'issue', 'messages'), 1) self.assertEqual(has(anon, 'issue', 'messages.author'), 0) self.assertEqual(has(anon, 'issue', 'messages.author.username'), 0) self.assertEqual(has(anon, 'issue', 'messages.recipients'), 0) self.assertEqual(has(anon, 'issue', 'messages.recipients.username'), 0) self.assertEqual(has(user, 'issue', 'messages'), 1) self.assertEqual(has(user, 'issue', 'messages.author'), 1) self.assertEqual(has(user, 'issue', 'messages.author.username'), 1) self.assertEqual(has(user, 'issue', 'messages.recipients'), 1) self.assertEqual(has(user, 'issue', 'messages.recipients.username'), 1) self.assertEqual(has(ui, 'issue', 'messages'), 0) self.assertEqual(has(ui, 'issue', 'messages.author'), 0) self.assertEqual(has(ui, 'issue', 'messages.author.username'), 0) self.assertEqual(has(ui, 'issue', 'messages.recipients'), 0) self.assertEqual(has(ui, 'issue', 'messages.recipients.username'), 0) self.assertEqual(has(uim, 'issue', 'messages'), 1) self.assertEqual(has(uim, 'issue', 'messages.author'), 0) self.assertEqual(has(uim, 'issue', 'messages.author.username'), 0) self.assertEqual(has(uim, 'issue', 'messages.recipients'), 0) self.assertEqual(has(uim, 'issue', 'messages.recipients.username'), 0) self.assertEqual(has(uimu, 'issue', 'messages'), 1) self.assertEqual(has(uimu, 'issue', 'messages.author'), 1) self.assertEqual(has(uimu, 'issue', 'messages.author.username'), 1) self.assertEqual(has(uimu, 'issue', 'messages.recipients'), 1) self.assertEqual(has(uimu, 'issue', 'messages.recipients.username'), 1) # roundup.password has its own built-in tests, call them. def test_password(self): roundup.password.test() # pretend import of crypt failed orig_crypt = roundup.password.crypt roundup.password.crypt = None with self.assertRaises(roundup.password.PasswordValueError) as ctx: roundup.password.test_missing_crypt() self.assertEqual(ctx.exception.args[0], "Unsupported encryption scheme 'crypt'") roundup.password.crypt = orig_crypt def test_pbkdf2_unpack_errors(self): pbkdf2_unpack = roundup.password.pbkdf2_unpack with self.assertRaises(roundup.password.PasswordValueError) as ctx: pbkdf2_unpack("fred$password") self.assertEqual(ctx.exception.args[0], 'invalid PBKDF2 hash (wrong number of separators)') with self.assertRaises(roundup.password.PasswordValueError) as ctx: pbkdf2_unpack("0200000$salt$password") self.assertEqual(ctx.exception.args[0], 'invalid PBKDF2 hash (zero-padded rounds)') with self.assertRaises(roundup.password.PasswordValueError) as ctx: pbkdf2_unpack("fred$salt$password") self.assertEqual(ctx.exception.args[0], 'invalid PBKDF2 hash (invalid rounds)') def test_empty_passwords(self): p = roundup.password.Password() with self.assertRaises(ValueError) as ctx: p == "foo" self.assertEqual(ctx.exception.args[0], 'Password not set') with self.assertRaises(ValueError) as ctx: p.__str__() self.assertEqual(ctx.exception.args[0], 'Password not set') # make sure it uses the default scheme default_scheme = roundup.password.Password.default_scheme p.setPassword("sekret", config=self.db.config) self.assertEqual(p.scheme, default_scheme) def test_pbkdf2_migrate_rounds(self): '''Check that migration happens when number of rounds in config is larger than number of rounds in current password. ''' p = roundup.password.Password('sekrit', 'PBKDF2', config=self.db.config) self.db.config.PASSWORD_PBKDF2_DEFAULT_ROUNDS = 2000000 os.environ["PYTEST_USE_CONFIG"] = "True" self.assertEqual(p.needs_migration(config=self.db.config), True) del(os.environ["PYTEST_USE_CONFIG"]) # set up p with rounds under 1000. This is usually prevented, # but older software could generate smaller rounds. p.password = p.password.replace('1000$', '900$') self.assertEqual(p.needs_migration(config=self.db.config), True) def test_encodePassword_errors(self): self.db.config.PASSWORD_PBKDF2_DEFAULT_ROUNDS = 999 os.environ["PYTEST_USE_CONFIG"] = "True" with self.assertRaises(roundup.password.PasswordValueError) as ctx: roundup.password.encodePassword('sekrit', 'PBKDF2', config=self.db.config) self.assertEqual(ctx.exception.args[0], 'invalid PBKDF2 hash (rounds too low)') del(os.environ["PYTEST_USE_CONFIG"]) with self.assertRaises(roundup.password.PasswordValueError) as ctx: roundup.password.encodePassword('sekrit', 'fred', config=self.db.config) self.assertEqual(ctx.exception.args[0], "Unknown encryption scheme 'fred'") def test_pbkdf2_errors(self): with self.assertRaises(ValueError) as ctx: roundup.password.pbkdf2('sekret', b'saltandpepper', 0, 41) self.assertEqual(ctx.exception.args[0], "key length too large") with self.assertRaises(ValueError) as ctx: roundup.password.pbkdf2('sekret', b'saltandpepper', 0, 40) self.assertEqual(ctx.exception.args[0], "rounds must be positive number") def test_pbkdf2_sha512_errors(self): with self.assertRaises(ValueError) as ctx: roundup.password.pbkdf2_sha512('sekret', b'saltandpepper', 0, 65) self.assertEqual(ctx.exception.args[0], "key length too large") with self.assertRaises(ValueError) as ctx: roundup.password.pbkdf2_sha512('sekret', b'saltandpepper', 0, 64) self.assertEqual(ctx.exception.args[0], "rounds must be positive number") def test_misc_functions(self): import random # for fuzzing later v = roundup.password.bchr(64) if bytes == str: self.assertEqual(v, '@') else: self.assertEqual(v, b'@') v = roundup.password.bord(b'@') if bytes == str: self.assertEqual(v, 64) else: self.assertEqual(v, b'@') for plain, encode in ( (b'tes', 'dGVz'), (b'test', 'dGVzdA'), (b'testb', "dGVzdGI"), ): v = roundup.password.h64encode(plain) self.assertEqual(v, encode) v = roundup.password.h64decode(v) self.assertEqual(v, plain) with self.assertRaises(ValueError) as ctx: v = roundup.password.h64decode("dGVzd") self.assertEqual(ctx.exception.args[0], "Invalid base64 input") # poor man's fuzzer if bytes == str: # alias range to xrange for python2, more efficient. range_ = xrange # noqa: F821 else: range_ = range for i in range_(25): plain = bytearray(random.getrandbits(8) for _ in range_(i*4)) e = roundup.password.h64encode(plain) self.assertEqual(roundup.password.h64decode(e), plain) def test_encodePasswordNoConfig(self): # should run cleanly as we are in a test. # p = roundup.password.encodePassword('sekrit', 'PBKDF2') # verify 1000 rounds being used becaue we are in test mode self.assertTrue(p.startswith("1000$")) del(os.environ["PYTEST_CURRENT_TEST"]) self.assertNotIn("PYTEST_CURRENT_TEST", os.environ) with self.assertRaises(roundup.password.ConfigNotSet) as ctx: roundup.password.encodePassword('sekrit', 'PBKDF2') self.assertEqual(ctx.exception.args[0], "encodePassword called without config.") # vim: set filetype=python sts=4 sw=4 et si : code-e5bd50120b5a/test/test_sqlite.py0000644000000000000000000002165415064275501015621 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # 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. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import unittest, os, shutil, time import sqlite3 as sqlite from roundup.backends import get_backend, have_backend from roundup.backends.sessions_sqlite import Sessions, OneTimeKeys from .db_test_base import DBTest, ROTest, SchemaTest, ClassicInitTest, config from .db_test_base import ConcurrentDBTest, FilterCacheTest from .db_test_base import SpecialActionTest from .rest_common import TestCase as RestTestCase class sqliteOpener: if have_backend('sqlite'): module = get_backend('sqlite') def nuke_database(self): shutil.rmtree(config.DATABASE) def testWalMode(self): """verify that all sqlite db's are in WAL mode and not journal mode """ if not hasattr(self, 'db'): self.skipTest("test has no database open") for db in [self.db]: print("testing db", str(db)) db.sql('pragma journal_mode;') self.assertEqual(db.cursor.fetchone()['journal_mode'], 'wal') class sqliteDBTest(sqliteOpener, DBTest, unittest.TestCase): def setUp(self): # set for manual integration testing of 'native-fts' # It is unset in tearDown so it doesn't leak into other tests. # FIXME extract test methods in DBTest that hit the indexer # into a new class (DBTestIndexer). Add DBTestIndexer # to this class. # Then create a new class in this file: # sqliteDBTestIndexerNative_FTS # that imports from DBestIndexer to test native-fts. # #config['INDEXER'] = 'native-fts' DBTest.setUp(self) def tearDown(self): # clean up config to prevent leak if native-fts is tested config['INDEXER'] = '' DBTest.tearDown(self) def testUpgrade_6_to_7(self): # load the database self.db.issue.create(title="flebble frooz") self.db.commit() if self.db.database_schema['version'] > 7: # make testUpgrades run the downgrade code only. if hasattr(self, "downgrade_only"): # we are being called by an earlier test self.testUpgrade_7_to_8() self.assertEqual(self.db.database_schema['version'], 7) else: # we are being called directly self.downgrade_only = True self.testUpgrade_7_to_8() self.assertEqual(self.db.database_schema['version'], 7) del(self.downgrade_only) elif self.db.database_schema['version'] != 7: self.skipTest("This test only runs for database version 7") self.db.database_schema['version'] = 6 # dropping _fts # select * from _fts # it should fail. # run post-init # same select should succeed (with no rows returned) self.db.sql("drop table __fts") with self.assertRaises(sqlite.OperationalError) as ctx: self.db.sql("select * from __fts") self.assertIn("no such table: __fts", ctx.exception.args[0]) if hasattr(self, "downgrade_only"): return # test upgrade adding __fts table self.db.post_init() self.assertEqual(self.db.db_version_updated, True) # select should now work. self.db.sql("select * from __fts") # we should be at the current db version self.assertEqual(self.db.database_schema['version'], self.db.current_db_version) def testUpgrade_7_to_8(self): # load the database self.db.issue.create(title="flebble frooz") self.db.commit() if self.db.database_schema['version'] != 8: self.skipTest("This test only runs for database version 8") # set up separate session/otk db's. self.db.Otk = OneTimeKeys(self.db) self.db.Session = Sessions(self.db) handle={} handle['otk'] = self.db.Otk handle['session'] = self.db.Session # verify they don't truncate long ints. test_double = 1658718284.7616878 for tablename in ['otk', 'session']: Bdb = handle[tablename] Bdb.sql( 'insert into %(name)ss(%(name)s_key, %(name)s_time, %(name)s_value) ' 'values("foo", %(double)s, "value");'%{'name': tablename, 'double': test_double} ) Bdb.cursor.execute('select %(name)s_time from %(name)ss ' 'where %(name)s_key = "foo"'%{'name': tablename}) self.assertAlmostEqual(Bdb.cursor.fetchone()[0], test_double, -1) # cleanup or else the inserts after the upgrade will not # work. Bdb.sql("delete from %(name)ss where %(name)s_key='foo'"%{ 'name': tablename} ) self.db.database_schema['version'] = 7 if hasattr(self,"downgrade_only"): return # test upgrade altering row self.db.post_init() self.assertEqual(self.db.db_version_updated, True) # verify they keep all signifcant digits before the decimal point for tablename in ['otk', 'session']: Bdb = handle[tablename] Bdb.sql( 'insert into %(name)ss(%(name)s_key, %(name)s_time, %(name)s_value) ' 'values("foo", %(double)s, "value");'%{'name': tablename, 'double': test_double} ) Bdb.cursor.execute('select %(name)s_time from %(name)ss ' 'where %(name)s_key = "foo"'%{'name': tablename}) self.assertAlmostEqual(Bdb.cursor.fetchone()[0], test_double, -1) self.assertEqual(self.db.database_schema['version'], 8) class sqliteROTest(sqliteOpener, ROTest, unittest.TestCase): pass class sqliteSchemaTest(sqliteOpener, SchemaTest, unittest.TestCase): pass class sqliteClassicInitTest(ClassicInitTest, unittest.TestCase): backend = 'sqlite' class sqliteConcurrencyTest(ConcurrentDBTest, unittest.TestCase): backend = 'sqlite' class sqliteFilterCacheTest(sqliteOpener, FilterCacheTest, unittest.TestCase): backend = 'sqlite' class sqliteSpecialActionTestCase(sqliteOpener, SpecialActionTest, unittest.TestCase): backend = 'sqlite' from .session_common import SessionTest class sqliteSessionTest(sqliteOpener, SessionTest, unittest.TestCase): s2b = lambda x,y : y def testDbType(self): self.assertIn("roundlite", repr(self.db)) self.assertIn("roundup.backends.sessions_sqlite.Sessions", repr(self.db.Session)) def testWalMode(self): """verify that all sqlite db's are in WAL mode and not Rollback mode """ for db in [self.db, self.db.Session, self.db.Otk]: print("testing db", str(db)) db.sql('pragma journal_mode;') self.assertEqual(db.cursor.fetchone()['journal_mode'], 'wal') class anydbmSessionTest(sqliteOpener, SessionTest, unittest.TestCase): s2b = lambda x,y : y def setUp(self): SessionTest.setUp(self) # redefine the session db's as anydbm # close the existing session databases before opening new ones. self.db.Session.close() self.db.Otk.close() self.db.config.SESSIONDB_BACKEND = "anydbm" self.db.Session = None self.db.Otk = None self.sessions = self.db.getSessionManager() self.otks = self.db.getOTKManager() def tearDown(self): SessionTest.tearDown(self) # reset to default session backend self.db.config.SESSIONDB_BACKEND = "" self.db.Session = None self.db.Otk = None self.sessions = None self.otks = None def get_ts(self): return (self.sessions.get('random_session', '__timestamp'),) def testDbType(self): self.assertIn("roundlite", repr(self.db)) self.assertIn("roundup.backends.sessions_dbm.Sessions", repr(self.db.Session)) class sqliteRestTest (RestTestCase, unittest.TestCase): backend = 'sqlite' code-e5bd50120b5a/test/test_templating.py0000644000000000000000000022647615064275501016475 0ustar 00000000000000from __future__ import print_function import unittest import time from roundup.anypy.cgi_ import FieldStorage, MiniFieldStorage from roundup.cgi.templating import * from roundup.cgi.ZTUtils.Iterator import Iterator from roundup.test import memorydb from .test_actions import MockNull, true from .html_norm import NormalizingHtmlParser import pytest from .pytest_patcher import mark_class try: from markdown2 import __version_info__ as md2__version_info__ except ImportError: md2__version_info__ = (0,0,0) if ReStructuredText: skip_rst = lambda func, *args, **kwargs: func else: skip_rst = mark_class(pytest.mark.skip( reason='ReStructuredText not available')) import roundup.cgi.templating if roundup.cgi.templating._import_mistune(): skip_mistune = lambda func, *args, **kwargs: func else: skip_mistune = mark_class(pytest.mark.skip( reason='mistune not available')) if roundup.cgi.templating._import_markdown2(): skip_markdown2 = lambda func, *args, **kwargs: func else: skip_markdown2 = mark_class(pytest.mark.skip( reason='markdown2 not available')) if roundup.cgi.templating._import_markdown(): skip_markdown = lambda func, *args, **kwargs: func else: skip_markdown = mark_class(pytest.mark.skip( reason='markdown not available')) from roundup.anypy.strings import u2s, s2u from roundup.backends.sessions_common import SessionCommon class MockConfig(dict): def __getattr__(self, name): try: return self[name] except KeyError as err: raise AttributeError(err) class MockDatabase(MockNull, SessionCommon): def getclass(self, name): # limit class names if name not in [ 'issue', 'user', 'status' ]: raise KeyError('There is no class called "%s"' % name) # Class returned must have hasnode(id) method that returns true # otherwise designators like 'issue1' can't be hyperlinked. self.classes[name].hasnode = lambda id: True if int(id) < 10 else False return self.classes[name] # setup for csrf testing of otks database api storage = {} def set(self, key, **props): MockDatabase.storage[key] = {} if '__timestamp' not in props: props['__timestamp'] = time.time() - 7*24*3600 MockDatabase.storage[key].update(props) def get(self, key, field, default=None): if key not in MockDatabase.storage: return default return MockDatabase.storage[key][field] def getall(self, key): if key not in MockDatabase.storage: return default return MockDatabase.storage[key] def exists(self,key): return key in MockDatabase.storage def getOTKManager(self): return MockDatabase() def lifetime(self, seconds): return time.time() - 7*24*3600 + seconds class TemplatingTestCase(unittest.TestCase): def setUp(self): self.form = FieldStorage() self.client = MockNull() self.client.db = db = MockDatabase() db.security.hasPermission = lambda *args, **kw: True self.client.form = self.form # add client props for testing anti_csrf_nonce self.client.session_api = MockNull(_sid="1234567890") self.client.db.getuid = lambda : 10 self.client.db.config = MockConfig ( {'WEB_CSRF_TOKEN_LIFETIME': 10, 'MARKDOWN_BREAK_ON_NEWLINE': False }) class HTMLDatabaseTestCase(TemplatingTestCase): def test_HTMLDatabase___getitem__(self): db = HTMLDatabase(self.client) self.assertTrue(isinstance(db['issue'], HTMLClass)) # following assertions are invalid # since roundup/cgi/templating.py r1.173. # HTMLItem is function, not class, # but HTMLUserClass and HTMLUser are passed on. # these classes are no more. they have ceased to be. #self.assertTrue(isinstance(db['user'], HTMLUserClass)) #self.assertTrue(isinstance(db['issue1'], HTMLItem)) #self.assertTrue(isinstance(db['user1'], HTMLUser)) def test_HTMLDatabase___getattr__(self): db = HTMLDatabase(self.client) self.assertTrue(isinstance(db.issue, HTMLClass)) # see comment in test_HTMLDatabase___getitem__ #self.assertTrue(isinstance(db.user, HTMLUserClass)) #self.assertTrue(isinstance(db.issue1, HTMLItem)) #self.assertTrue(isinstance(db.user1, HTMLUser)) def test_HTMLDatabase_classes(self): db = HTMLDatabase(self.client) db._db.classes = {'issue':MockNull(), 'user': MockNull()} db.classes() def test_HTMLDatabase_list(self): # The list method used to produce a traceback when a None value # for an order attribute of a class was encountered. This # happens when the 'get' of the order attribute for a numeric # id produced a None value. So we put '23' as a key into the # list and set things up that a None value is returned on 'get'. # This keeps db.issue static, otherwise it changes for each call db = MockNull(issue = HTMLDatabase(self.client).issue) db.issue._klass.list = lambda : ['23', 'a', 'b'] # Make db.getclass return something that has a sensible 'get' method def get(x, y, allow_abort=True): return None mock = MockNull(get = get) db.issue._db.getclass = lambda x : mock l = db.issue.list() class FunctionsTestCase(TemplatingTestCase): def test_lookupIds(self): db = HTMLDatabase(self.client) def lookup(key): if key == 'ok': return '1' if key == 'fail': raise KeyError('fail') if key == '@current_user': raise KeyError('@current_user') return key db._db.classes = {'issue': MockNull(lookup=lookup)} prop = MockNull(classname='issue') self.assertEqual(lookupIds(db._db, prop, ['1','2']), ['1','2']) self.assertEqual(lookupIds(db._db, prop, ['ok','2']), ['1','2']) self.assertEqual(lookupIds(db._db, prop, ['ok', 'fail'], 1), ['1', 'fail']) self.assertEqual(lookupIds(db._db, prop, ['ok', 'fail']), ['1']) self.assertEqual(lookupIds(db._db, prop, ['ok', '@current_user']), ['1']) def test_lookupKeys(self): db = HTMLDatabase(self.client) def get(entry, key, allow_abort=True): return {'1': 'green', '2': 'eggs'}.get(entry, entry) shrubbery = MockNull(get=get) db._db.classes = {'shrubbery': shrubbery} self.assertEqual(lookupKeys(shrubbery, 'spam', ['1','2']), ['green', 'eggs']) self.assertEqual(lookupKeys(shrubbery, 'spam', ['ok','2']), ['ok', 'eggs']) class HTMLClassTestCase(TemplatingTestCase) : def test_link(self): """Make sure lookup of a Link property works even in the presence of multiple values in the form.""" def lookup(key) : self.assertEqual(key, key.strip()) return "Status%s"%key self.form.list.append(MiniFieldStorage("issue@status", "1")) self.form.list.append(MiniFieldStorage("issue@status", "2")) status = hyperdb.Link("status") self.client.db.classes = dict \ ( issue = MockNull(getprops = lambda : dict(status = status)) , status = MockNull(get = lambda id, name : id, lookup = lookup) ) self.client.form = self.form cls = HTMLClass(self.client, "issue") s = cls["status"] self.assertEqual(s._value, '1') def test_link_default(self): """Make sure default value for link is returned if new item and no value in form.""" def lookup(key) : self.assertEqual(key, key.strip()) return "Status%s"%key status = hyperdb.Link("status") # set default_value status.__dict__['_Type__default_value'] = "4" self.client.db.classes = dict \ ( issue = MockNull(getprops = lambda : dict(status = status)) , status = MockNull(get = lambda id, name : id, lookup = lookup, get_default_value = lambda: 4) ) self.client.form = self.form cls = HTMLClass(self.client, "issue") s = cls["status"] self.assertEqual(s._value, '4') def test_link_with_value_and_default(self): """Make sure default value is not used if there is a value in the form.""" def lookup(key) : self.assertEqual(key, key.strip()) return "Status%s"%key self.form.list.append(MiniFieldStorage("issue@status", "2")) self.form.list.append(MiniFieldStorage("issue@status", "1")) status = hyperdb.Link("status") # set default_value status.__dict__['_Type__default_value'] = "4" self.client.db.classes = dict \ ( issue = MockNull(getprops = lambda : dict(status = status)) , status = MockNull(get = lambda id, name : id, lookup = lookup, get_default_value = lambda: 4) ) self.client.form = self.form cls = HTMLClass(self.client, "issue") s = cls["status"] self.assertEqual(s._value, '2') def test_multilink(self): """`lookup` of an item will fail if leading or trailing whitespace has not been stripped. """ def lookup(key) : self.assertEqual(key, key.strip()) return "User%s"%key self.form.list.append(MiniFieldStorage("nosy", "1, 2")) nosy = hyperdb.Multilink("user") self.client.db.classes = dict \ ( issue = MockNull(getprops = lambda : dict(nosy = nosy)) , user = MockNull(get = lambda id, name : id, lookup = lookup) ) cls = HTMLClass(self.client, "issue") cls["nosy"] def test_anti_csrf_nonce(self): '''call the csrf creation function and do basic length test Store the data in a mock db with the same api as the otk db. Make sure nonce is 54 chars long. Lookup the nonce in db and retrieve data. Verify that the nonce lifetime is correct (within 1 second of 1 week - lifetime), the uid is correct (1), the dummy sid is correct. Consider three cases: * create nonce via module function setting lifetime * create nonce via TemplatingUtils method setting lifetime * create nonce via module function with default lifetime ''' # the value below is number of seconds in a week. week_seconds = 604800 otks=self.client.db.getOTKManager() for test in [ 'module', 'template', 'default_time' ]: print("Testing:", test) if test == 'module': # test the module function nonce1 = anti_csrf_nonce(self.client, lifetime=1) # lifetime * 60 is the offset greater_than = week_seconds - 1 * 60 elif test == 'template': # call the function through the TemplatingUtils class cls = TemplatingUtils(self.client) nonce1 = cls.anti_csrf_nonce(lifetime=5) greater_than = week_seconds - 5 * 60 elif test == 'default_time': # use the module function but with no lifetime nonce1 = anti_csrf_nonce(self.client) # see above for web nonce lifetime. greater_than = week_seconds - 10 * 60 self.assertEqual(len(nonce1), 54) uid = otks.get(nonce1, 'uid', default=None) sid = otks.get(nonce1, 'sid', default=None) timestamp = otks.get(nonce1, '__timestamp', default=None) self.assertEqual(uid, 10) self.assertEqual(sid, self.client.session_api._sid) now = time.time() print("now, timestamp, greater, difference", now, timestamp, greater_than, now - timestamp) # lower bound of the difference is above. Upper bound # of difference is run time between time.time() in # the call to anti_csrf_nonce and the time.time() call # that assigns ts above. I declare that difference # to be less than 1 second for this to pass. self.assertEqual(True, greater_than <= now - timestamp < (greater_than + 1) ) def test_number__int__(self): # test with number p = NumberHTMLProperty(self.client, 'testnum', '1', None, 'test', 2345678.2345678) self.assertEqual(p.__int__(), 2345678) property = MockNull(get_default_value = lambda: None) p = NumberHTMLProperty(self.client, 'testnum', '1', property, 'test', None) with self.assertRaises(TypeError) as e: p.__int__() def test_number__float__(self): # test with number p = NumberHTMLProperty(self.client, 'testnum', '1', None, 'test', 2345678.2345678) self.assertEqual(p.__float__(), 2345678.2345678) property = MockNull(get_default_value = lambda: None) p = NumberHTMLProperty(self.client, 'testnum', '1', property, 'test', None) with self.assertRaises(TypeError) as e: p.__float__() def test_number_field(self): import sys _py3 = sys.version_info[0] > 2 # python2 truncates while python3 rounds. Sigh. if _py3: expected_val = 2345678.2345678 else: expected_val = 2345678.23457 # test with number p = NumberHTMLProperty(self.client, 'testnum', '1', None, 'test', 2345678.2345678) self.client.db.config['WEB_USE_BROWSER_NUMBER_INPUT'] = False self.assertEqual(p.field(), ('')%expected_val) self.client.db.config['WEB_USE_BROWSER_NUMBER_INPUT'] = True self.assertEqual(p.field(), ('')%expected_val) self.assertEqual(p.field(size=10), ('')%expected_val) self.assertEqual(p.field(size=10, dataprop="foo", dataprop2=5), (''%expected_val)) self.assertEqual(p.field(size=10, klass="class1", **{ "class": "class2 class3", "data-prop": "foo", "data-prop2": 5}), ('')%expected_val) # get plain representation if user can't edit p.is_edit_ok = lambda: False self.assertEqual(p.field(), p.plain()) # test with string which is wrong type p = NumberHTMLProperty(self.client, 'testnum', '1', None, 'test', "234567e.2345678") self.assertEqual(p.field(), ('')) # test with None value, pretend property.__default_value = Null which # is the default. It would be returned by get_default_value # which I mock. property = MockNull(get_default_value = lambda: None) p = NumberHTMLProperty(self.client, 'testnum', '1', property, 'test', None) self.assertEqual(p.field(), ('')) def test_number_plain(self): import sys _py3 = sys.version_info[0] > 2 # python2 truncates while python3 rounds. Sigh. if _py3: expected_val = 2345678.2345678 else: expected_val = 2345678.23457 p = NumberHTMLProperty(self.client, 'testnum', '1', None, 'test', 2345678.2345678) self.assertEqual(p.plain(), "%s"%expected_val) def test_number_pretty(self): # test with number p = NumberHTMLProperty(self.client, 'testnum', '1', None, 'test', 2345678.2345678) self.assertEqual(p.pretty(), "2345678.235") # test with string which is wrong type p = NumberHTMLProperty(self.client, 'testnum', '1', None, 'test', "2345678.2345678") self.assertEqual(p.pretty(), "2345678.2345678") # test with boolean p = NumberHTMLProperty(self.client, 'testnum', '1', None, 'test', True) self.assertEqual(p.pretty(), "1.000") # test with None value, pretend property.__default_value = Null which # is the default. It would be returned by get_default_value # which I mock. property = MockNull(get_default_value = lambda: None) p = NumberHTMLProperty(self.client, 'testnum', '1', property, 'test', None) self.assertEqual(p.pretty(), '') with self.assertRaises(ValueError) as e: p.pretty('%0.3') def test_string_url_quote(self): ''' test that urlquote quotes the string ''' p = StringHTMLProperty(self.client, 'test', '1', None, 'test', 'test string< foo@bar') self.assertEqual(p.url_quote(), 'test%20string%3C%20foo%40bar') def test_string_email(self): ''' test that email obscures the email ''' p = StringHTMLProperty(self.client, 'test', '1', None, 'test', 'rouilj@foo.example.com') self.assertEqual(p.email(), 'rouilj at foo example ...') def test_string_wrapped(self): test_string = ('A long string that needs to be wrapped to' ' 80 characters and no more. Put in a link issue1.' ' Put in to be escaped. Put in a' ' https://example.com/link as well. Let us see if' ' it will wrap properly.' ) test_result_wrap = {} test_result_wrap[80] = ('A long string that needs to be wrapped to 80' ' characters and no more. Put in a\n' 'link issue1. Put in' ' <html> to be escaped. Put in a ' 'https://example.com/link as\n' 'well. Let us see if it will wrap properly.') test_result_wrap[20] = ( 'A long string that\n' 'needs to be wrapped\n' 'to 80 characters and\n' 'no more. Put in a\nlink issue1. Put in\n' '<html> to be\n' 'escaped. Put in a\n' 'https://example.com/link\n' 'as well. Let us see\n' 'if it will wrap\n' 'properly.') test_result_wrap[100] = ( 'A long string that needs to be wrapped to 80 characters and no more. Put in a link issue1. Put in\n' '<html> to be escaped. Put in a https://example.com/link as well. Let us see if it will wrap\n' 'properly.') p = StringHTMLProperty(self.client, 'test', '1', None, 'test', test_string) for i in [80, 20, 100]: wrapped = p.wrapped(columns=i) print(wrapped) self.assertEqual(wrapped, test_result_wrap[i]) def test_string_plain_or_hyperlinked(self): ''' test that email obscures the email ''' p = StringHTMLProperty(self.client, 'test', '1', None, 'test', 'A string with rouilj@example.com embedded < html') self.assertEqual(p.plain(), 'A string with rouilj@example.com embedded < html') self.assertEqual(p.plain(escape=1), 'A string <b> with rouilj@example.com embedded &lt; html</b>') self.assertEqual(p.plain(hyperlink=1), 'A string <b> with rouilj@example.com embedded &lt; html</b>') self.assertEqual(p.plain(escape=1, hyperlink=1), 'A string <b> with rouilj@example.com embedded &lt; html</b>') self.assertEqual(p.hyperlinked(), 'A string <b> with rouilj@example.com embedded &lt; html</b>') # check designators for designator in [ "issue1", "issue 1" ]: p = StringHTMLProperty(self.client, 'test', '1', None, 'test', designator) self.assertEqual(p.hyperlinked(), '%s'%designator) # issue 100 > 10 which is a magic number for the mocked hasnode # If id number is greater than 10 hasnode reports it does not have # the node. for designator in ['issue100', 'issue 100']: p = StringHTMLProperty(self.client, 'test', '1', None, 'test', designator) self.assertEqual(p.hyperlinked(), designator) # zoom class does not exist for designator in ['zoom1', 'zoom100', 'zoom 1']: p = StringHTMLProperty(self.client, 'test', '1', None, 'test', designator) self.assertEqual(p.hyperlinked(), designator) @skip_rst def test_string_rst(self): p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string with cmeerw@example.com *embedded* \u00df')) # test case to make sure include directive is disabled q = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'\n\n.. include:: XyZrMt.html\n\n\n\n')) q_result=u'''

System Message: WARNING/2 (<string>, line 3)

"include" directive disabled.

.. include:: XyZrMt.html

<badtag>

''' # test case to make sure raw directive is disabled r = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'\n\n.. raw:: html\n\n \n\n')) r_result='''

System Message: WARNING/2 (<string>, line 3)

"raw" directive disabled.

.. raw:: html

   <badtag>
''' # test case to make sure javascript and data url's aren't turned # into links s = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'\njavascript:badcode data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==')) s_result = '
\n

<badtag>\njavascript:badcode data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==

\n
\n' # test url recognition t = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'link is https://example.com/link for testing.')) t_result = '
\n

link is https://example.com/link for testing.

\n
\n' # test text that doesn't need to be processed u = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'Just a plain old string here. Nothig to process.')) u_result = '
\n

Just a plain old string here. Nothig to process.

\n
\n' self.assertEqual(p.rst(), u2s(u'
\n

A string with cmeerw@example.com embedded \u00df

\n
\n')) self.assertEqual(q.rst(), u2s(q_result)) self.assertEqual(r.rst(), u2s(r_result)) self.assertEqual(s.rst(), u2s(s_result)) self.assertEqual(t.rst(), u2s(t_result)) self.assertEqual(u.rst(), u2s(u_result)) def test_string_field(self): p = StringHTMLProperty(self.client, 'test', '1', None, 'test', 'A string with rouilj@example.com embedded < html') self.assertEqual(p.field(), '') def test_string_multiline(self): p = StringHTMLProperty(self.client, 'test', '1', None, 'test', 'A string with rouilj@example.com embedded < html') self.assertEqual(p.multiline(), '') self.assertEqual(p.multiline(rows=300, cols=100, **{'class':'css_class'}), '') def test_url_match(self): '''Test the URL regular expression in StringHTMLProperty. ''' def t(s, nothing=False, **groups): m = StringHTMLProperty.hyper_re.search(s) if nothing: if m: self.assertEqual(m, None, '%r matched (%r)'%(s, m.groupdict())) return else: self.assertNotEqual(m, None, '%r did not match'%s) d = m.groupdict() for g in groups: self.assertEqual(d[g], groups[g], '%s %r != %r in %r'%(g, d[g], groups[g], s)) #t('123.321.123.321', 'url') t('https://example.com/demo/issue8#24MRV9BZYx:V:1B~sssssssssssssss~4~4', url="https://example.com/demo/issue8#24MRV9BZYx:V:1B~sssssssssssssss~4~4") t('http://localhost/', url='http://localhost/') t('http://roundup.net/', url='http://roundup.net/') t('http://richard@localhost/', url='http://richard@localhost/') t('http://richard:sekrit@localhost/', url='http://richard:sekrit@localhost/') t('', url='HTTP://roundup.net/') t('www.a.ex', url='www.a.ex') t('foo.a.ex', nothing=True) t('StDevValidTimeSeries.GetObservation', nothing=True) t('http://a.ex', url='http://a.ex') t('http://a.ex/?foo&bar=baz\\.@!$%()qwerty', url='http://a.ex/?foo&bar=baz\\.@!$%()qwerty') t('www.foo.net', url='www.foo.net') t('richard@com.example', email='richard@com.example') t('r@a.com', email='r@a.com') t('i1', **{'class':'i', 'id':'1'}) t('item123', **{'class':'item', 'id':'123'}) t('item 123', **{'class':'item', 'id':'123'}) t('www.user:pass@host.net', email='pass@host.net') t('user:pass@www.host.net', url='user:pass@www.host.net') t('123.35', nothing=True) t('-.3535', nothing=True) def test_url_replace(self): p = StringHTMLProperty(self.client, 'test', '1', None, 'test', '') def t(s): return p.hyper_re.sub(p._hyper_repl, s) ae = self.assertEqual ae(t('issue5#msg10'), 'issue5#msg10') ae(t('issue5'), 'issue5') ae(t('issue2255'), 'issue2255') ae(t('foo https://example.com/demo/issue8#24MRV9BZYx:V:1B~sssssssssssssss~4~4 bar'), 'foo ' 'https://example.com/demo/issue8#24MRV9BZYx:V:1B~sssssssssssssss~4~4 bar') ae(t('item123123123123'), 'item123123123123') ae(t('http://roundup.net/'), 'http://roundup.net/') ae(t('<HTTP://roundup.net/>'), '<HTTP://roundup.net/>') ae(t('<http://roundup.net/>.'), '<http://roundup.net/>.') ae(t('<www.roundup.net>'), '<www.roundup.net>') ae(t('(www.roundup.net)'), '(www.roundup.net)') ae(t('foo http://msdn.microsoft.com/en-us/library/ms741540(VS.85).aspx bar'), 'foo ' 'http://msdn.microsoft.com/en-us/library/ms741540(VS.85).aspx bar') ae(t('(e.g. http://en.wikipedia.org/wiki/Python_(programming_language))'), '(e.g. ' 'http://en.wikipedia.org/wiki/Python_(programming_language))') ae(t('(e.g. http://en.wikipedia.org/wiki/Python_(programming_language)).'), '(e.g. ' 'http://en.wikipedia.org/wiki/Python_(programming_language)).') ae(t('(e.g. http://en.wikipedia.org/wiki/Python_(programming_language))>.'), '(e.g. ' 'http://en.wikipedia.org/wiki/Python_(programming_language))>.') ae(t('(e.g. http://en.wikipedia.org/wiki/Python_(programming_language>)).'), '(e.g. ' 'http://en.wikipedia.org/wiki/Python_(programming_language>)).') for c in '.,;:!': # trailing punctuation is not included ae(t('http://roundup.net/%c ' % c), 'http://roundup.net/%c ' % c) # trailing punctuation is not included without trailing space ae(t('http://roundup.net/%c' % c), 'http://roundup.net/%c' % c) # but it's included if it's part of the URL ae(t('http://roundup.net/%c/' % c), 'http://roundup.net/%c/' % (c, c)) # including with a non / terminated path ae(t('http://roundup.net/test%c ' % c), 'http://roundup.net/test%c ' % c) # but it's included if it's part of the URL path ae(t('http://roundup.net/%ctest' % c), 'http://roundup.net/%ctest' % (c, c)) def test_input_html4(self): # boolean attributes are just the attribute name # indicate with attr=None or attr="attr" # e.g. disabled input=input_html4(required=None, size=30) self.assertEqual(input, '') input=input_html4(required="required", size=30) self.assertEqual(input, '') attrs={"required": None, "class": "required", "size": 30} input=input_html4(**attrs) self.assertEqual(input, '') attrs={"disabled": "disabled", "class": "required", "size": 30} input=input_html4(**attrs) self.assertEqual(input, '') class HTMLPropertyTestClass(unittest.TestCase): def setUp(self): self.form = FieldStorage() self.client = MockNull() self.client.db = db = memorydb.create('admin') db.tx_Source = "web" db.issue.addprop(tx_Source=hyperdb.String()) db.security.hasPermission = lambda *args, **kw: True self.client.form = self.form self.client._props = MockNull() # add client props for testing anti_csrf_nonce self.client.session_api = MockNull(_sid="1234567890") self.client.db.getuid = lambda : 10 @pytest.fixture(autouse=True) def inject_fixtures(self, caplog): self._caplog = caplog class BooleanHTMLPropertyTestCase(HTMLPropertyTestClass): def setUp(self): super(BooleanHTMLPropertyTestCase, self).setUp() db = self.client.db db.issue.addprop(boolvalt=hyperdb.Boolean()) db.issue.addprop(boolvalf=hyperdb.Boolean()) db.issue.addprop(boolvalunset=hyperdb.Boolean()) self.client.db.issue.create(title="title", boolvalt = True, boolvalf = False) def tearDown(self): self.client.db.close() memorydb.db_nuke('') testdata = [ ("boolvalt", "Yes", True, False), ("boolvalf", "No", False, True), ("boolvalunset", "", False, True), ] def test_BoolHTMLRadioButtons(self): #propname = "boolvalt" #plainval = "Yes" self.maxDiff = None for test_inputs in self.testdata: params = { "check1": 'checked="checked" ' if test_inputs[2] else "", "check2": 'checked="checked" ' if test_inputs[3] else "", "propname": test_inputs[0], "plainval": test_inputs[1], } test_hyperdbBoolean = self.client.db.issue.getprops("1")[ params['propname']] test_boolean = self.client.db.issue.get("1", params['propname']) # client, classname, nodeid, prop, name, value, # anonymous=0, offset=None d = BooleanHTMLProperty(self.client, 'issue', '1', test_hyperdbBoolean, params['propname'], test_boolean) self.assertIsInstance(d._value, (type(None), bool)) self.assertEqual(d.plain(), params['plainval']) input_expected = ( '' '' '') % params self.assertEqual(d.field(), input_expected) y_label = ( '') % params n_label = ('') % params u_label = ('') % params input_expected = ( '' + y_label + '' + n_label ) % params self.assertEqual(d.field(y_label=y_label, n_label=n_label), input_expected) input_expected = ( '' '' '' '') % params print(d.field(labelfirst=True)) self.assertEqual(d.field(labelfirst=True), input_expected) input_expected = ( '' '' '' '' '') % params self.assertEqual(d.field(u_label=u_label), input_expected) # one test with the last d is enough. # check permissions return is_view_ok_orig = d.is_view_ok is_edit_ok_orig = d.is_edit_ok no_access = lambda : False d.is_view_ok = no_access self.assertEqual(d.plain(), "[hidden]") d.is_edit_ok = no_access self.assertEqual(d.field(), "[hidden]") d.is_view_ok = is_view_ok_orig self.assertEqual(d.field(), params['plainval']) d.is_edit_ok = is_edit_ok_orig class DateHTMLPropertyTestCase(HTMLPropertyTestClass): def setUp(self): super(DateHTMLPropertyTestCase, self).setUp() db = self.client.db db.issue.addprop(deadline=hyperdb.Date()) self.test_datestring = "2021-01-01.11:22:10" self.client.db.issue.create(title="title", deadline=date.Date(self.test_datestring)) self.client.db.getUserTimezone = lambda: "2" def tearDown(self): self.client.db.close() memorydb.db_nuke('') def exp_classhelp(self, cls='issue', prop='deadline', dlm='.'): value = dlm.join (('2021-01-01', '11:22:10')) return ('(cal)' ) % {'cls': cls, 'prop': prop, 'value': value} def test_DateHTMLWithDate(self): """Test methods when DateHTMLProperty._value is a hyperdb.Date() """ self.client.db.config['WEB_USE_BROWSER_DATE_INPUT'] = True test_datestring = self.test_datestring test_Date = self.client.db.issue.get("1", 'deadline') test_hyperdbDate = self.client.db.issue.getprops("1")['deadline'] self.client.classname = "issue" self.client.template = "item" # client, classname, nodeid, prop, name, value, # anonymous=0, offset=None d = DateHTMLProperty(self.client, 'issue', '1', test_hyperdbDate, 'deadline', test_Date) self.assertIsInstance(d._value, date.Date) self.assertEqual(d.pretty(), " 1 January 2021") self.assertEqual(d.pretty("%2d %B %Y"), "01 January 2021") self.assertEqual(d.pretty(format="%Y-%m"), "2021-01") self.assertEqual(d.plain(), "2021-01-01.13:22:10") self.assertEqual(d.local("-4").plain(), "2021-01-01.07:22:10") input_expected = """""" self.assertEqual(d.field(display_time=False), input_expected) input_expected = '' self.assertEqual(d.field(), input_expected) input_expected = '' field = d.field(format='%Y-%m-%d.%H:%M:%S', popcal=False) self.assertEqual(field, input_expected) # test with format input_expected = '' + self.exp_classhelp() self.assertEqual(d.field(format="%Y-%m"), input_expected) input_expected = '' input = d.field(format="%Y-%m", popcal=False) self.assertEqual(input, input_expected) def test_DateHTMLWithText(self): """Test methods when DateHTMLProperty._value is a string rather than a hyperdb.Date() """ test_datestring = "2021-01-01 11:22:10" test_date = hyperdb.Date("2") self.form.list.append(MiniFieldStorage("test1@test", test_datestring)) self.client._props=test_date self.client.db.config['WEB_USE_BROWSER_DATE_INPUT'] = False self.client.db.classes = dict \ ( test = MockNull(getprops = lambda : test_date) ) self.client.classname = "test" self.client.template = "item" # client, classname, nodeid, prop, name, value, # anonymous=0, offset=None d = DateHTMLProperty(self.client, 'test', '1', self.client._props, 'test', '') self.assertIs(type(d._value), str) self.assertEqual(d.pretty(), "2021-01-01 11:22:10") self.assertEqual(d.plain(), "2021-01-01 11:22:10") input_expected = '' self.assertEqual(d.field(popcal=False), input_expected) self.client.db.config['WEB_USE_BROWSER_DATE_INPUT'] = True input_expected = '' self.assertEqual(d.field(), input_expected) self.client.db.config['WEB_USE_BROWSER_DATE_INPUT'] = False input_expected = '' self.assertEqual(d.field(size=40, popcal=False), input_expected) input_expected = ('' + self.exp_classhelp(cls='test', prop='test', dlm=' ')) self.maxDiff=None self.assertEqual(d.field(format="%Y-%m"), input_expected) # format always uses type="text" even when date input is set self.client.db.config['WEB_USE_BROWSER_DATE_INPUT'] = True result = d.field(format="%Y-%m-%d", popcal=False) input_expected = '' self.assertEqual(result, input_expected) input_expected = ('' + self.exp_classhelp(cls='test', prop='test', dlm=' ')) self.assertEqual(d.field(format="%Y-%m"), input_expected) result = d.field(format="%Y-%m-%dT%H:%M:%S", popcal=False) input_expected = '' self.assertEqual(result, input_expected) # common markdown test cases class MarkdownTests: def mangleMarkdown2(self, s): ''' markdown2's rel=nofollow support on 'a' tags isn't programmable. So we are using it's builtin nofollow support. Mangle the string so that it matches the test case. turn: into Also if it is a mailto url, we don't expect rel="nofollow", so delete it. turn: into Also when a title is present it is put in a different place from markdown, so fix it to normalize. turn: into ''' if type(self) == Markdown2TestCase and s.find('a rel="nofollow"') != -1: if s.find('href="mailto:') == -1: # not a mailto url if 'rel="nofollow"' in s: if 'title="' in s: s = s.replace(' rel="nofollow" ', ' ').replace(' title=', ' rel="nofollow noopener" title=') else: s = s.replace(' rel="nofollow" ', ' ').replace('">', '" rel="nofollow noopener">') return s else: # a mailto url return s.replace(' rel="nofollow" ', ' ') return s def test_string_markdown(self): p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string with
*embedded* \u00df')) self.assertEqual(p.markdown().strip(), u2s(u'

A string with <br> embedded \u00df

')) def test_string_markdown_link(self): p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A link ')) m = p.markdown().strip() m = self.mangleMarkdown2(m) self.assertEqual( u2s(u'

A link http://localhost

'), m) def test_string_markdown_link_item(self): """ The link formats for the different markdown engines changes. Order of attributes, value for rel (noopener, nofollow etc) is different. So most tests check for a substring that indicates success rather than the entire returned string. """ p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'An issue1 link')) self.assertIn( u2s(u'href="issue1"'), p.markdown().strip()) # just verify that plain linking is working self.assertIn( u2s(u'href="issue1"'), p.plain(hyperlink=1)) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'An [issue1](issue1) link')) self.assertIn( u2s(u'href="issue1"'), p.markdown().strip()) # just verify that plain linking is working self.assertIn( u2s(u'href="issue1"'), p.plain(hyperlink=1)) p = StringHTMLProperty( self.client, 'test', '1', None, 'test', u2s(u'An [issue1](https://example.com/issue1) link')) self.assertIn( u2s(u'href="https://example.com/issue1"'), p.markdown().strip()) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'An [issu1](#example) link')) self.assertIn( u2s(u'href="#example"'), p.markdown().strip()) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'An [issu1](/example) link')) self.assertIn( u2s(u'href="/example"'), p.markdown().strip()) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'An [issu1](./example) link')) self.assertIn( u2s(u'href="./example"'), p.markdown().strip()) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'An [issu1](../example) link')) self.assertIn( u2s(u'href="../example"'), p.markdown().strip()) p = StringHTMLProperty( self.client, 'test', '1', None, 'test', u2s(u'A [wuarchive_ftp](ftp://www.wustl.gov/file) link')) self.assertIn( u2s(u'href="ftp://www.wustl.gov/file"'), p.markdown().strip()) p = StringHTMLProperty( self.client, 'test', '1', None, 'test', u2s(u'An [issue1] (https://example.com/issue1) link')) self.assertIn( u2s(u'href="issue1"'), p.markdown().strip()) if type(self) == MistuneTestCase: # mistune makes the https url into a real link self.assertIn( u2s(u'href="https://example.com/issue1"'), p.markdown().strip()) else: # the other two engines leave the parenthesized url as is. self.assertIn( u2s(u' (https://example.com/issue1) link'), p.markdown().strip()) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'An [issu1](.../example) link')) if (isinstance(self, Markdown2TestCase) and md2__version_info__ > (2, 4, 9)): # markdown2 > 2.4.9 handles this differently self.assertIn( u2s(u'href="#"'), p.markdown().strip()) else: self.assertIn( u2s(u'href=".../example"'), p.markdown().strip()) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A [phone](tel:0016175555555) link')) if (isinstance(self, Markdown2TestCase) and md2__version_info__ > (2, 4, 9)): self.assertIn(u2s(u'href="#"'), p.markdown().strip()) else: self.assertIn( u2s(u'href="tel:0016175555555"'), p.markdown().strip()) def test_string_email_markdown_link(self): # markdown2 and markdown escape the email address try: from html import unescape as html_unescape except ImportError: from HTMLParser import HTMLParser html_unescape = HTMLParser().unescape p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A link ')) m = html_unescape(p.markdown().strip()) m = self.mangleMarkdown2(m) self.assertEqual(m, u2s(u'

A link cmeerw@example.com

')) p = StringHTMLProperty( self.client, 'test', '1', None, 'test', u2s(u'An bare email baduser@daemons.com link')) m = self.mangleMarkdown2(html_unescape(p.markdown().strip())) self.assertIn( u2s(u'href="mailto:baduser@daemons.com"'), m) p = StringHTMLProperty( self.client, 'test', '1', None, 'test', u2s(u'An [email_url](mailto:baduser@daemons.com) link')) m = self.mangleMarkdown2(html_unescape(p.markdown().strip())) if isinstance(self, MistuneTestCase): self.assertIn('email_url', m) else: self.assertIn('email_url', m) def test_string_markdown_javascript_link(self): # make sure we don't get a "javascript:" link p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'')) self.assertTrue(p.markdown().find('href="javascript:') == -1) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'[link](javascript:alert(1))')) self.assertTrue(p.markdown().find('href="javascript:') == -1) def test_string_markdown_data_link(self): # make sure we don't get a "data:" link p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'')) print(p.markdown()) self.assertTrue(p.markdown().find('href="data:') == -1) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'[data link](data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==)')) print(p.markdown()) self.assertTrue(p.markdown().find('href="data:') == -1) def test_string_markdown_forced_line_break(self): p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'This is a set of text \n:that should have a break \n:at newlines. Each \n:colon should be the start of an html line')) # sigh different backends render this differently: # of text
# of text
# etc. # Rather than using a different result for each # renderer, look for '\n\n```\nline 1\nline 2\n```\n\nnew paragraph')) self.assertEqual(p.markdown().strip().replace('\n\n', '\n'), u2s(u'

embedded code block <pre>

\n
line 1\nline 2\n
\n

new </pre> paragraph

')) def test_string_markdown_code_block_attribute(self): parser = NormalizingHtmlParser() ''' also verify that embedded html is escaped ''' p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'embedded code block 
\n\n``` python\nline 1\nline 2\n```\n\nnew
paragraph')) m = parser.normalize(p.markdown()) parser.reset() print(m) if type(self) == MistuneTestCase: self.assertEqual(m, parser.normalize('

embedded code block <pre>

\n
line 1\nline 2\n
\n

new </pre> paragraph

')) elif type(self) == MarkdownTestCase: self.assertEqual(m.replace('class="python"','class="language-python"'), parser.normalize('

embedded code block <pre>

\n
line 1\nline 2\n
\n

new </pre> paragraph

')) else: expected_result = parser.normalize('

embedded code block <pre>

\n
line 1\nline 2\n
\n

new </pre> paragraph

') self.assertEqual(m, expected_result) def test_markdown_return_text_on_exception(self): ''' string is invalid markdown. missing end of fenced code block ''' p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'embedded code block 
\n\n``` python\nline 1\nline 2\n\n\nnew
paragraph')) m = p.markdown().strip() print(m) self.assertEqual(m.replace('\n\n','\n'), '

embedded code block <pre>

\n

``` python\nline 1\nline 2

\n

new </pre> paragraph

') def test_markdown_break_on_newline(self): self.client.db.config['MARKDOWN_BREAK_ON_NEWLINE'] = True p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string with\nline break\ntwice.')) m = p.markdown() self.assertEqual(2, m.count('http://example.com/

') p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'')) m = p.markdown(hyperlink=1) m = self.mangleMarkdown2(m) self.assertEqual(m.rstrip('\n'), '

http://example.com/

') p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'[label](http://example.com/ "a title")')) m = p.markdown(hyperlink=1) m = self.mangleMarkdown2(m) self.assertEqual(m.rstrip('\n'), '

label

') p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'[label](http://example.com/).')) m = p.markdown(hyperlink=1) m = self.mangleMarkdown2(m) self.assertEqual(m.rstrip('\n'), '

label.

') p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'![](http://example.com/)')) m = p.markdown(hyperlink=1) m = self.mangleMarkdown2(m) self.assertIn(m, [ '

\n', '

\n', '

\n', '

', # markdown ]) p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'An URL http://example.com/ with text')) m = p.markdown(hyperlink=1) m = self.mangleMarkdown2(m) self.assertEqual(m.rstrip('\n'), '

An URL http://example.com/ with text

') p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'An URL https://example.com/path with text')) m = p.markdown(hyperlink=1) m = self.mangleMarkdown2(m) self.assertEqual(m.rstrip('\n'), '

An URL https://example.com/path with text

') @skip_mistune class MistuneTestCase(TemplatingTestCase, MarkdownTests) : def setUp(self): TemplatingTestCase.setUp(self) from roundup.cgi import templating self.__markdown = templating.markdown templating.markdown = templating._import_mistune() def tearDown(self): from roundup.cgi import templating templating.markdown = self.__markdown @skip_markdown2 class Markdown2TestCase(TemplatingTestCase, MarkdownTests) : def setUp(self): TemplatingTestCase.setUp(self) from roundup.cgi import templating self.__markdown = templating.markdown templating.markdown = templating._import_markdown2() def tearDown(self): from roundup.cgi import templating templating.markdown = self.__markdown @skip_markdown class MarkdownTestCase(TemplatingTestCase, MarkdownTests) : def setUp(self): TemplatingTestCase.setUp(self) from roundup.cgi import templating self.__markdown = templating.markdown templating.markdown = templating._import_markdown() def tearDown(self): from roundup.cgi import templating templating.markdown = self.__markdown class NoMarkdownTestCase(TemplatingTestCase) : def setUp(self): TemplatingTestCase.setUp(self) from roundup.cgi import templating self.__markdown = templating.markdown templating.markdown = None def tearDown(self): from roundup.cgi import templating templating.markdown = self.__markdown def test_string_markdown(self): p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string http://localhost with cmeerw@example.com
*embedded* \u00df')) self.assertEqual(p.markdown(), u2s(u'A string http://localhost with cmeerw@example.com <br> *embedded* \u00df')) class NoRstTestCase(TemplatingTestCase) : def setUp(self): TemplatingTestCase.setUp(self) from roundup.cgi import templating self.__ReStructuredText = templating.ReStructuredText templating.ReStructuredText = None def tearDown(self): from roundup.cgi import templating templating.ReStructuredText = self.__ReStructuredText def test_string_rst(self): p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string with cmeerw@example.com *embedded* \u00df')) self.assertEqual(p.rst(), u2s(u'A string with cmeerw@example.com *embedded* \u00df')) class NumberIntegerHTMLPropertyTestCase(HTMLPropertyTestClass): def setUp(self): super(NumberIntegerHTMLPropertyTestCase, self).setUp() db = self.client.db db.issue.addprop(numberval=hyperdb.Number()) db.issue.addprop(intval=hyperdb.Integer()) self.client.db.issue.create(title="title", numberval = "3.14", intval="314") def tearDown(self): self.client.db.close() memorydb.db_nuke('') def test_IntegerHTML(self): test_hyperdbInteger = self.client.db.issue.getprops("1")['intval'] test_Integer = test_hyperdbInteger.from_raw( self.client.db.issue.get("1", 'intval') ) # client, classname, nodeid, prop, name, value, # anonymous=0, offset=None d = IntegerHTMLProperty(self.client, 'issue', '1', test_hyperdbInteger, 'intval', test_Integer) self.assertIsInstance(d._value, int) self.assertEqual(d.plain(), "314") input_expected = """""" self.assertEqual(d.field(), input_expected) input_expected = """""" self.assertEqual(d.field(step="50"), input_expected) input_expected = """""" self.assertEqual(d.field(type="text"), input_expected) # check permissions return is_view_ok_orig = d.is_view_ok is_edit_ok_orig = d.is_edit_ok no_access = lambda : False d.is_view_ok = no_access self.assertEqual(d.plain(), "[hidden]") d.is_edit_ok = no_access self.assertEqual(d.field(), "[hidden]") d.is_view_ok = is_view_ok_orig self.assertEqual(d.field(), "314") d.is_edit_ok = is_edit_ok_orig def test_NumberHTML(self): test_hyperdbNumber = self.client.db.issue.getprops("1")['numberval'] test_Number = test_hyperdbNumber.from_raw( self.client.db.issue.get("1", 'numberval') ) # client, classname, nodeid, prop, name, value, # anonymous=0, offset=None d = NumberHTMLProperty(self.client, 'issue', '1', test_hyperdbNumber, 'numberval', test_Number) # string needed for memorydb/anydbm backend. Float?? when # running against sql backends. self.assertIsInstance(d._value, float) self.assertEqual(d._value, 3.14) input_expected = """""" self.assertEqual(d.field(), input_expected) input_expected = """""" self.assertEqual(d.field(step="50"), input_expected) input_expected = """""" self.assertEqual(d.field(type="text"), input_expected) self.assertEqual(d.pretty("%0.3f"), "3.140") self.assertEqual(d.pretty("%0.3d"), "003") self.assertEqual(d.pretty("%2d"), " 3") # see what happens if for other values value = d._value d._value = "1" # integer self.assertEqual(d.pretty("%2d"), "1") d._value = "I'mNotAFloat" # not a number self.assertEqual(d.pretty("%2d"), "I'mNotAFloat") d._value = value # check permissions return is_view_ok_orig = d.is_view_ok is_edit_ok_orig = d.is_edit_ok no_access = lambda : False d.is_view_ok = no_access self.assertEqual(d.plain(), "[hidden]") d.is_edit_ok = no_access self.assertEqual(d.field(), "[hidden]") d.is_view_ok = is_view_ok_orig self.assertEqual(d.field(), "3.14") d.is_edit_ok = is_edit_ok_orig class ZUtilsTestcase(TemplatingTestCase): def test_Iterator(self): """Test all the iterator functions and properties. """ sequence = ['one', 'two', '3', 4] i = Iterator(sequence) for j in [ # element, item, 1st, last, even, odd, number, # letter, Letter, roman, Roman (1, "one", 1, 0, True, 0, 1, 'a', 'A', 'i', 'I'), (1, "two", 0, 0, False, 1, 2, 'b', 'B', 'ii', 'II'), (1, "3", 0, 0, True, 0, 3, 'c', 'C', 'iii', 'III'), (1, 4, 0, 1, False, 1, 4, 'd', 'D', 'iv', 'IV'), # next() fails with 0 when past end of sequence # everything else is left at end of sequence (0, 4, 0, 1, False, 1, 4, 'd', 'D', 'iv', 'IV'), ]: element = i.next() # returns 1 if next item else 0 print(i.item) self.assertEqual(element, j[0]) self.assertEqual(i.item, j[1]) self.assertEqual(i.first(), j[2]) self.assertEqual(i.start, j[2]) self.assertEqual(i.last(), j[3]) self.assertEqual(i.end, j[3]) self.assertIs(i.even(), j[4]) self.assertEqual(i.odd(), j[5]) self.assertEqual(i.number(), j[6]) self.assertEqual(i.index, j[6] - 1) self.assertEqual(i.nextIndex, j[6]) self.assertEqual(i.letter(), j[7]) self.assertEqual(i.Letter(), j[8]) self.assertEqual(i.roman(), j[9]) self.assertEqual(i.Roman(), j[10]) class I: def __init__(self, name, data): self.name = name self.data = data sequence = [I('Al', 'd'), I('Bob', 'e'), I('Bob', 'd'), I('Chip', 'd') ] iterator = iter(sequence) # Iterator is supposed take both sequence and Python iterator. for source in [sequence, iterator]: i = Iterator(source) element = i.next() # returns 1 if next item else 0 item1 = i.item # note these can trigger calls by first/last to same_part(). # It can return true for first/last even when there are more # items in the sequence. I am just testing the current # implementation. Woe to the person who tries to change # Iterator.py. self.assertEqual(element, 1) # i.start == 1, so it bypasses name check self.assertEqual(i.first(name='namea'), 1) self.assertEqual(i.first(name='name'), 1) # i.end == 0 so it uses name check in object self.assertEqual(i.last(name='namea'), 0) self.assertEqual(i.last(name='name'), 0) element = i.next() # returns 1 if next item else 0 item2 = i.item self.assertEqual(element, 1) # i.start == 0 so it uses name check # between item1 and item2 self.assertEqual(i.first(name='namea'), 0) self.assertEqual(i.first(name='name'), 0) # i.end == 0 so it uses name check in object # between item2 and the next item item3 self.assertEqual(i.last(name='namea'), 0) self.assertEqual(i.last(name='name'), True) element = i.next() # returns 1 if next item else 0 item3 = i.item self.assertEqual(element, 1) # i.start == 0 so it uses name check self.assertEqual(i.first(name='namea'), 0) self.assertEqual(i.first(name='name'), 1) # i.end == 0 so it uses name check in object # between item3 and the next item item4 self.assertEqual(i.last(name='namea'), 0) self.assertEqual(i.last(name='name'), 0) element = i.next() # returns 1 if next item else 0 item4 = i.item self.assertEqual(element, 1) # i.start == 0 so it uses name check self.assertEqual(i.first(name='namea'), 0) self.assertEqual(i.first(name='name'), 0) # i.end == 0 so it uses name check in object # last two object have same name (1) self.assertEqual(i.last(name='namea'), 1) self.assertEqual(i.last(name='name'), 1) element = i.next() # returns 1 if next item else 0 self.assertEqual(element, 0) # this is the underlying call for first/last # when i.start/i.end are 0 # use non-existing attribute name, same item self.assertIs(i.same_part('namea', item2, item2), False) # use correct attribute name self.assertIs(i.same_part('name', item2, item2), True) # use no attribute name self.assertIs(i.same_part(None, item2, item2), True) # use non-existing attribute name, different item # non-matching names self.assertIs(i.same_part('namea', item1, item2), False) # use correct attribute name self.assertIs(i.same_part('name', item1, item2), False) # use no attribute name self.assertIs(i.same_part(None, item1, item2), False) # use non-existing attribute name, different item # matching names self.assertIs(i.same_part('namea', item2, item3), False) # use correct attribute name self.assertIs(i.same_part('name', item2, item3), True) # use no attribute name self.assertIs(i.same_part(None, item2, item3), False) r''' class HTMLPermissions: def is_edit_ok(self): def is_view_ok(self): def is_only_view_ok(self): def view_check(self): def edit_check(self): def input_html4(**attrs): class HTMLInputMixin: def __init__(self): class HTMLClass(HTMLInputMixin, HTMLPermissions): def __init__(self, client, classname, anonymous=0): def __repr__(self): def __getitem__(self, item): def __getattr__(self, attr): def designator(self): def getItem(self, itemid, num_re=re.compile(r'-?\d+')): def properties(self, sort=1, cansearch=True): def list(self, sort_on=None): def csv(self): def propnames(self): def filter(self, request=None, filterspec={}, sort=(None,None), def classhelp(self, properties=None, label='(list)', width='500', def submit(self, label="Submit New Entry"): def history(self): def renderWith(self, name, **kwargs): class HTMLItem(HTMLInputMixin, HTMLPermissions): def __init__(self, client, classname, nodeid, anonymous=0): def __repr__(self): def __getitem__(self, item): def __getattr__(self, attr): def designator(self): def is_retired(self): def submit(self, label="Submit Changes"): def journal(self, direction='descending'): def history(self, direction='descending', dre=re.compile('\d+')): def renderQueryForm(self): class HTMLUserPermission: def is_edit_ok(self): def is_view_ok(self): def _user_perm_check(self, type): class HTMLUserClass(HTMLUserPermission, HTMLClass): class HTMLUser(HTMLUserPermission, HTMLItem): def __init__(self, client, classname, nodeid, anonymous=0): def hasPermission(self, permission, classname=_marker): class HTMLProperty(HTMLInputMixin, HTMLPermissions): def __init__(self, client, classname, nodeid, prop, name, value, def __repr__(self): def __str__(self): def __lt__(self, other): def __le__(self, other): def __eq__(self, other): def __ne__(self, other): def __gt__(self, other): def __ge__(self, other): def is_edit_ok(self): def is_view_ok(self): class StringHTMLProperty(HTMLProperty): def _hyper_repl(self, match): def hyperlinked(self): def plain(self, escape=0, hyperlink=0): def stext(self, escape=0): def field(self, size = 30): def multiline(self, escape=0, rows=5, cols=40): def email(self, escape=1): class PasswordHTMLProperty(HTMLProperty): def plain(self): def field(self, size = 30): def confirm(self, size = 30): class NumberHTMLProperty(HTMLProperty): def plain(self): def field(self, size = 30): def __int__(self): def __float__(self): class IntegerHTMLProperty(HTMLProperty): def plain(self): def field(self, size = 30): def __int__(self): class BooleanHTMLProperty(HTMLProperty): def plain(self): def field(self): class DateHTMLProperty(HTMLProperty): def plain(self): def now(self): def field(self, size = 30): def reldate(self, pretty=1): def pretty(self, format=_marker): def local(self, offset): class IntervalHTMLProperty(HTMLProperty): def plain(self): def pretty(self): def field(self, size = 30): class LinkHTMLProperty(HTMLProperty): def __init__(self, *args, **kw): def __getattr__(self, attr): def plain(self, escape=0): def field(self, showid=0, size=None): def menu(self, size=None, height=None, showid=0, additional=[], class MultilinkHTMLProperty(HTMLProperty): def __init__(self, *args, **kwargs): def __len__(self): def __getattr__(self, attr): def __getitem__(self, num): def __contains__(self, value): def reverse(self): def sorted(self, property, reverse=False): def plain(self, escape=0): def field(self, size=30, showid=0): def menu(self, size=None, height=None, showid=0, additional=[], def make_key_function(db, classname, sort_on=None): def keyfunc(a): def find_sort_key(linkcl): def handleListCGIValue(value): class ShowDict: def __init__(self, columns): def __getitem__(self, name): class HTMLRequest(HTMLInputMixin): def __init__(self, client): def _post_init(self): def updateFromURL(self, url): def update(self, kwargs): def description(self): def __str__(self): def indexargs_form(self, columns=1, sort=1, group=1, filter=1, def indexargs_url(self, url, args): def base_javascript(self): def batch(self): class Batch(ZTUtils.Batch): def __init__(self, client, sequence, size, start, end=0, orphan=0, def __getitem__(self, index): def propchanged(self, property): def previous(self): def next(self): #class TemplatingUtils: # def __init__(self, client): # def Batch(self, sequence, size, start, end=0, orphan=0, overlap=0): class NoTemplate(Exception): class Unauthorised(Exception): def __init__(self, action, klass): def __str__(self): class Loader: def __init__(self, dir): def precompileTemplates(self): def load(self, name, extension=None): def __getitem__(self, name): class RoundupPageTemplate(PageTemplate.PageTemplate): def getContext(self, client, classname, request): def render(self, client, classname, request, **options): def __repr__(self): ''' # vim: set et sts=4 sw=4 : code-e5bd50120b5a/test/test_token.py0000644000000000000000000000535215064275501015435 0ustar 00000000000000# # 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. import unittest, time from roundup.token_r import token_split class TokenTestCase(unittest.TestCase): def testValid(self): l = token_split('hello world') self.assertEqual(l, ['hello', 'world']) def testIgnoreExtraSpace(self): l = token_split('hello world ') self.assertEqual(l, ['hello', 'world']) def testQuoting(self): l = token_split('"hello world"') self.assertEqual(l, ['hello world']) l = token_split("'hello world'") self.assertEqual(l, ['hello world']) def testEmbedQuote(self): l = token_split(r'Roch\'e Compaan') self.assertEqual(l, ["Roch'e", "Compaan"]) l = token_split('address="1 2 3"') self.assertEqual(l, ['address=1 2 3']) def testEmbedEscapeQuote(self): l = token_split(r'"Roch\'e Compaan"') self.assertEqual(l, ["Roch'e Compaan"]) l = token_split(r'"Roch\"e Compaan"') self.assertEqual(l, ['Roch"e Compaan']) l = token_split(r'sql "COLLATE = \"utf8mb4_unicode_ci\";"') self.assertEqual(l, ["sql", 'COLLATE = "utf8mb4_unicode_ci";']) l = token_split(r'''sql 'COLLATE = "utf8mb4_unicode_ci";' ''') self.assertEqual(l, ["sql", 'COLLATE = "utf8mb4_unicode_ci";']) l = token_split(r'''sql 'COLLATE = \"utf8mb4_unicode_ci\";' ''') self.assertEqual(l, ["sql", 'COLLATE = "utf8mb4_unicode_ci";']) l = token_split(r'''sql 'COLLATE = \'utf8mb4_unicode_ci\';' ''') self.assertEqual(l, ["sql", "COLLATE = 'utf8mb4_unicode_ci';"]) l = token_split(r'''sql 'new\nline\rneed \ttab' ''') self.assertEqual(l, ["sql", "new\nline\rneed \ttab"]) def testEscaping(self): l = token_split('"Roch\'e" Compaan') self.assertEqual(l, ["Roch'e", "Compaan"]) l = token_split(r'hello\ world') self.assertEqual(l, ['hello world']) l = token_split(r'\\') self.assertEqual(l, ['\\']) l = token_split(r'\n') self.assertEqual(l, ['\n']) l = token_split(r'\r') self.assertEqual(l, ['\r']) l = token_split(r'\t') self.assertEqual(l, ['\t']) def testBadQuote(self): self.assertRaises(ValueError, token_split, '"hello world') self.assertRaises(ValueError, token_split, "Roch'e Compaan") # vim: set filetype=python ts=4 sw=4 et si code-e5bd50120b5a/test/test_userauditor.py0000644000000000000000000001223615064275501016662 0ustar 00000000000000import os, unittest, shutil from .db_test_base import setupTracker from .test_dates import skip_pytz class UserAuditorTest(unittest.TestCase): def setUp(self): self.dirname = '_test_user_auditor' self.instance = setupTracker(self.dirname) self.db = self.instance.open('admin') self.db.tx_Source = "cli" self.db.user.create(username='kyle', address='kyle@example.com', realname='Kyle Broflovski', roles='User') def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def testBadTimezones(self): self.assertRaises(ValueError, self.db.user.create, username='eric', timezone='24') userid = self.db.user.lookup('kyle') self.assertRaises(ValueError, self.db.user.set, userid, timezone='3000') self.assertRaises(ValueError, self.db.user.set, userid, timezone='24') self.assertRaises(ValueError, self.db.user.set, userid, timezone='-24') self.assertRaises(ValueError, self.db.user.set, userid, timezone='-3000') @skip_pytz def testBadTimezonesPyTZ(self): userid = self.db.user.lookup('kyle') self.assertRaises(KeyError, self.db.user.set, userid, timezone='MiddleOf/Nowhere') def testGoodTimezones(self): self.db.user.create(username='test_user01', timezone='12') userid = self.db.user.lookup('kyle') # TODO: roundup should accept non-integer offsets since those are valid # this is the offset for Tehran, Iran #self.db.user.set(userid, timezone='3.5') self.db.user.set(userid, timezone='-23') self.db.user.set(userid, timezone='23') self.db.user.set(userid, timezone='0') @skip_pytz def testGoodTimezonesPyTZ(self): userid = self.db.user.lookup('kyle') self.db.user.create(username='test_user02', timezone='MST') self.db.user.set(userid, timezone='US/Eastern') def testBadEmailAddresses(self): userid = self.db.user.lookup('kyle') self.assertRaises(ValueError, self.db.user.set, userid, address='kyle @ example.com') self.assertRaises(ValueError, self.db.user.set, userid, address='one@example.com,two@example.com') self.assertRaises(ValueError, self.db.user.set, userid, address='weird@@example.com') self.assertRaises(ValueError, self.db.user.set, userid, address='embedded\nnewline@example.com') # verify that we check alternates as well self.assertRaises(ValueError, self.db.user.set, userid, alternate_addresses='kyle @ example.com') # make sure we accept local style addresses self.db.user.set(userid, address='kyle') # verify we are case insensitive self.db.user.set(userid, address='kyle@EXAMPLE.COM') def testUniqueEmailAddresses(self): self.db.user.create(username='kenny', address='kenny@example.com', alternate_addresses='sp_ken@example.com') self.assertRaises(ValueError, self.db.user.create, username='test_user01', address='kenny@example.com') uid = self.db.user.create(username='eric', address='eric@example.com') self.assertRaises(ValueError, self.db.user.set, uid, address='kenny@example.com') # make sure we check alternates self.assertRaises(ValueError, self.db.user.set, uid, address='kenny@example.com') self.assertRaises(ValueError, self.db.user.set, uid, address='sp_ken@example.com') self.assertRaises(ValueError, self.db.user.set, uid, alternate_addresses='kenny@example.com') def testBadRoles(self): userid = self.db.user.lookup('kyle') self.assertRaises(ValueError, self.db.user.set, userid, roles='BadRole') self.assertRaises(ValueError, self.db.user.set, userid, roles='User,BadRole') def testGoodRoles(self): userid = self.db.user.lookup('kyle') # make sure we handle commas in weird places self.db.user.set(userid, roles='User,') self.db.user.set(userid, roles=',User') # make sure we strip whitespace self.db.user.set(userid, roles=' User ') # check for all-whitespace (treat as no role) self.db.user.set(userid, roles=' ') def testBadUsernames(self): ''' ky,le raises: ValueError: Username/Login Name must consist only of the letters a-z (any case), digits 0-9 and the symbols: @._-!+% ''' for name in [ "ky'le", "ky
le", "ky,le" ]: with self.assertRaises(ValueError) as ctx: self.db.user.create(username=name, address='kyle@example.com', realname='Kyle Broflovski', roles='User') self.assertEqual(str(ctx.exception), "Username/Login Name must " "consist only of the letters a-z (any case), " "digits 0-9 and the symbols: @._-!+%") self.db.user.create(username='rouilj-1+mya_ddr@users.example.com', address='kyle1@example.com', realname='Kyle Broflovski', roles='User') # vim: filetype=python sts=4 sw=4 et si code-e5bd50120b5a/test/test_xmlrpc.py0000644000000000000000000004020015064275501015611 0ustar 00000000000000# # Copyright (C) 2007 Stefan Seefeld # All rights reserved. # For license terms see the file COPYING.txt. # from __future__ import print_function import unittest, os, shutil, errno, pytest, sys, difflib, re from contextlib import contextmanager from roundup.anypy import xmlrpc_ MultiCall = xmlrpc_.client.MultiCall from roundup.cgi.exceptions import * from roundup import init, instance, password, hyperdb, date from roundup.xmlrpc import RoundupInstance, RoundupDispatcher from roundup.backends import list_backends from roundup.hyperdb import String from roundup.cgi import TranslationService from roundup.test.tx_Source_detector import init as tx_Source_init from . import db_test_base from .test_mysql import skip_mysql from .test_postgresql import skip_postgresql from .pytest_patcher import mark_class from roundup.anypy.xmlrpc_ import client if client.defusedxml: skip_defusedxml = lambda func, *args, **kwargs: func else: skip_defusedxml = mark_class(pytest.mark.skip( reason='Skipping defusedxml tests: defusedxml library not available')) if sys.version_info[0] > 2: skip_python2 = lambda func, *args, **kwargs: func else: skip_python2 = mark_class(pytest.mark.skip( reason='Skipping test under python 2')) @contextmanager def disable_defusedxml(): # if defusedxml not loaded, do nothing if 'defusedxml' not in sys.modules: yield return sys.modules['defusedxml'].xmlrpc.unmonkey_patch() try: yield finally: # restore normal defused xmlrpc functions sys.modules['defusedxml'].xmlrpc.monkey_patch() class XmlrpcTest(object): backend = None def setUp(self): self.dirname = '_test_xmlrpc' # set up and open a tracker self.instance = db_test_base.setupTracker(self.dirname, self.backend) # open the database self.db = self.instance.open('admin') print("props_only default", self.db.security.get_props_only_default()) # Get user id (user4 maybe). Used later to get data from db. self.joeid = 'user' + self.db.user.create(username='joe', password=password.Password('random'), address='random@home.org', realname='Joe Random', roles='User') self.db.commit() self.db.close() self.db = self.instance.open('joe') self.db.tx_Source = 'web' self.db.issue.addprop(tx_Source=hyperdb.String()) self.db.msg.addprop(tx_Source=hyperdb.String()) self.db.post_init() tx_Source_init(self.db) self.server = RoundupInstance(self.db, self.instance.actions, None) def tearDown(self): self.db.close() try: shutil.rmtree(self.dirname) except OSError as error: if error.errno not in (errno.ENOENT, errno.ESRCH): raise def testAccess(self): # Retrieve all three users. results = self.server.list('user', 'id') self.assertEqual(len(results), 3) # Obtain data for 'joe'. results = self.server.display(self.joeid) self.assertEqual(results['username'], 'joe') self.assertEqual(results['realname'], 'Joe Random') def testChange(self): # Reset joe's 'realname'. results = self.server.set(self.joeid, 'realname=Joe Doe') results = self.server.display(self.joeid, 'realname') self.assertEqual(results['realname'], 'Joe Doe') # check we can't change admin's details self.assertRaises(Unauthorised, self.server.set, 'user1', 'realname=Joe Doe') def testCreate(self): results = self.server.create('issue', 'title=foo') issueid = 'issue' + results results = self.server.display(issueid, 'title') self.assertEqual(results['title'], 'foo') self.assertEqual(self.db.issue.get('1', "tx_Source"), 'web') def testFileCreate(self): results = self.server.create('file', 'content=hello\r\nthere') fileid = 'file' + results results = self.server.display(fileid, 'content') self.assertEqual(results['content'], 'hello\r\nthere') def testSchema(self): schema={'status': [('name', ''), ('order', '')], 'keyword': [('name', '')], 'priority': [('name', ''), ('order', '')], 'user': [('address', ''), ('alternate_addresses', ''), ('organisation', ''), ('password', ''), ('phone', ''), ('queries', ''), ('realname', ''), ('roles', ''), ('timezone', ''), ('username', '')], 'file': [('content', ''), ('name', ''), ('type', '')], 'msg': [('author', ''), ('content', ''), ('date', ''), ('files', ''), ('inreplyto', ''), ('messageid', ''), ('recipients', ''), ('summary', ''), ('tx_Source', ''), ('type', '')], 'query': [('klass', ''), ('name', ''), ('private_for', ''), ('url', '')], 'issue': [('assignedto', ''), ('files', ''), ('keyword', ''), ('messages', ''), ('nosy', ''), ('priority', ''), ('status', ''), ('superseder', ''), ('title', ''), ('tx_Source', '')]} results = self.server.schema() self.assertEqual(results, schema) def testLookup(self): self.assertRaises(KeyError, self.server.lookup, 'user', '1') results = self.server.lookup('user', 'admin') self.assertEqual(results, '1') def testAction(self): # As this action requires special previledges, we temporarily switch # to 'admin' self.db.setCurrentUser('admin') users_before = self.server.list('user') try: tmp = 'user' + self.db.user.create(username='tmp') self.server.action('retire', tmp) finally: self.db.setCurrentUser('joe') users_after = self.server.list('user') self.assertEqual(users_before, users_after) # test a bogus action with self.assertRaises(Exception) as cm: self.server.action('bogus') print(cm.exception) self.assertEqual(cm.exception.args[0], 'action "bogus" is not supported ') def testAuthDeniedEdit(self): # Wrong permissions (caught by roundup security module). self.assertRaises(Unauthorised, self.server.set, 'user1', 'realname=someone') def testAuthDeniedCreate(self): self.assertRaises(Unauthorised, self.server.create, 'user', {'username': 'blah'}) def testAuthAllowedEdit(self): self.db.setCurrentUser('admin') try: try: self.server.set('user2', 'realname=someone') except Unauthorised as err: self.fail('raised %s'%err) finally: self.db.setCurrentUser('joe') def testAuthAllowedCreate(self): self.db.setCurrentUser('admin') try: try: self.server.create('user', 'username=blah') except Unauthorised as err: self.fail('raised %s'%err) finally: self.db.setCurrentUser('joe') def testAuthFilter(self): # this checks if we properly check for search permissions self.db.security.permissions = {} # self.db.security.set_props_only_default(props_only=False) self.db.security.addRole(name='User') self.db.security.addRole(name='Project') self.db.security.addPermissionToRole('User', 'Web Access') self.db.security.addPermissionToRole('Project', 'Web Access') # Allow viewing keyword p = self.db.security.addPermission(name='View', klass='keyword') print("View keyword class: %r"%p) self.db.security.addPermissionToRole('User', p) # Allow viewing interesting things (but not keyword) on issue # But users might only view issues where they are on nosy # (so in the real world the check method would be better) p = self.db.security.addPermission(name='View', klass='issue', properties=("title", "status"), check=lambda x,y,z: True) print("View keyword class w/ props: %r"%p) self.db.security.addPermissionToRole('User', p) # Allow role "Project" access to whole issue p = self.db.security.addPermission(name='View', klass='issue') self.db.security.addPermissionToRole('Project', p) # Allow all access to status: p = self.db.security.addPermission(name='View', klass='status') self.db.security.addPermissionToRole('User', p) self.db.security.addPermissionToRole('Project', p) keyword = self.db.keyword status = self.db.status issue = self.db.issue d1 = keyword.create(name='d1') d2 = keyword.create(name='d2') open = status.create(name='open') closed = status.create(name='closed') issue.create(title='i1', status=open, keyword=[d2]) issue.create(title='i2', status=open, keyword=[d1]) issue.create(title='i2', status=closed, keyword=[d1]) chef = self.db.user.create(username = 'chef', roles='User, Project') joe = self.db.user.lookup('joe') # Conditionally allow view of whole issue (check is False here, # this might check for keyword owner in the real world) p = self.db.security.addPermission(name='View', klass='issue', check=lambda x,y,z: False) print("View issue class: %r"%p) self.db.security.addPermissionToRole('User', p) # Allow user to search for issue.status p = self.db.security.addPermission(name='Search', klass='issue', properties=("status",)) print("View Search class w/ props: %r"%p) self.db.security.addPermissionToRole('User', p) keyw = {'keyword':self.db.keyword.lookup('d1')} stat = {'status':self.db.status.lookup('open')} keygroup = keysort = [('+', 'keyword')] self.db.commit() # Filter on keyword ignored for role 'User': r = self.server.filter('issue', None, keyw) self.assertEqual(r, ['1', '2', '3']) # Filter on status works for all: r = self.server.filter('issue', None, stat) self.assertEqual(r, ['1', '2']) # Sorting and grouping for class User fails: r = self.server.filter('issue', None, {}, sort=keysort) self.assertEqual(r, ['1', '2', '3']) r = self.server.filter('issue', None, {}, group=keygroup) self.assertEqual(r, ['1', '2', '3']) self.db.close() self.db = self.instance.open('chef') self.db.tx_Source = 'web' self.db.issue.addprop(tx_Source=hyperdb.String()) self.db.msg.addprop(tx_Source=hyperdb.String()) self.db.post_init() self.server = RoundupInstance(self.db, self.instance.actions, None) # Filter on keyword works for role 'Project': r = self.server.filter('issue', None, keyw) self.assertEqual(r, ['2', '3']) # Filter on status works for all: r = self.server.filter('issue', None, stat) self.assertEqual(r, ['1', '2']) # Sorting and grouping for class Project works: r = self.server.filter('issue', None, {}, sort=keysort) self.assertEqual(r, ['2', '3', '1']) r = self.server.filter('issue', None, {}, group=keygroup) self.assertEqual(r, ['2', '3', '1']) def testMulticall(self): translator = TranslationService.get_translation( language=self.instance.config["TRACKER_LANGUAGE"], tracker_home=self.instance.config["TRACKER_HOME"]) self.server = RoundupDispatcher(self.db, self.instance.actions, translator, allow_none = True) class S: multicall=self.server.funcs['system.multicall'] self.server.system = S() self.db.issue.create(title='i1') self.db.issue.create(title='i2') m = MultiCall(self.server) m.display('issue1') m.display('issue2') result = m() results = [ {'files': [], 'status': '1', 'tx_Source': 'web', 'keyword': [], 'title': 'i1', 'nosy': [], 'messages': [], 'priority': None, 'assignedto': None, 'superseder': []}, {'files': [], 'status': '1', 'tx_Source': 'web', 'keyword': [], 'title': 'i2', 'nosy': [], 'messages': [], 'priority': None, 'assignedto': None, 'superseder': []}] for n, r in enumerate(result): self.assertEqual(r, results[n]) @skip_python2 @skip_defusedxml def testDefusedXmlBomb(self): self.XmlBomb(expectIn=b"defusedxml.common.EntitiesForbidden") @skip_python2 def testNonDefusedXmlBomb(self): with disable_defusedxml(): self.XmlBomb(expectIn=b"1234567890"*511) def XmlBomb(self, expectIn=None): bombInput = """ ]> filter &d; 0 2 3 username demo """ translator = TranslationService.get_translation( language=self.instance.config["TRACKER_LANGUAGE"], tracker_home=self.instance.config["TRACKER_HOME"]) self.server = RoundupDispatcher(self.db, self.instance.actions, translator, allow_none = True) response = self.server.dispatch(bombInput) print(response) self.assertIn(expectIn, response) class anydbmXmlrpcTest(XmlrpcTest, unittest.TestCase): backend = 'anydbm' @skip_mysql class mysqlXmlrpcTest(XmlrpcTest, unittest.TestCase): backend = 'mysql' class sqliteXmlrpcTest(XmlrpcTest, unittest.TestCase): backend = 'sqlite' @skip_postgresql class postgresqlXmlrpcTest(XmlrpcTest, unittest.TestCase): backend = 'postgresql' code-e5bd50120b5a/test/wsgi_liveserver.py0000644000000000000000000000626715064275501016503 0ustar 00000000000000# -*- coding: utf-8 -*- """ wsgi-liveserver provides a simple LiverServerTestCase class that can be used to help start a web server in the background to serve a WSGI compliant application for use with testing. Generally it will be used in conjuction with something like Selenium to perform a series of functional tests using a browser. Licensed under the GNU GPL v3 Copyright (c) 2013 John Kristensen (unless explicitly stated otherwise). """ import errno import socket import threading import unittest from wsgiref.simple_server import WSGIRequestHandler, make_server __author__ = 'John Kristensen' __version__ = '0.3.1' __license__ = 'GPLv3' """ Classmethod probe_ports() added by John Rouillard 2024. """ class QuietHandler(WSGIRequestHandler): def log_request(*args, **kwargs): pass class LiveServerTestCase(unittest.TestCase): port_range = (8080, 8090) def create_app(self): """Create your wsgi app and return it.""" raise NotImplementedError def __call__(self, result=None): """ Do some custom setup stuff and then hand off to TestCase to do its thing. """ try: self._pre_setup() super(LiveServerTestCase, self).__call__(result) finally: self._post_teardown() def url_base(self): """Return the url of the test server.""" return 'http://{0}:{1}'.format(self.host, self.port) def _pre_setup(self): """Setup and start the test server in the background.""" self._server = None self.host = 'localhost' self.port = self.port_range[0] self._thread = None # Get the app self.app = self.create_app() # Cycle through the port range to find a free port while self._server is None and self.port <= self.port_range[1]: try: self._server = make_server(self.host, self.port, self.app, handler_class=QuietHandler) except socket.error: self.port += 1 # No free port, raise an exception if self._server is None: raise socket.error('Ports {0}-{1} are all already in use'.format( *self.port_range)) # Start the test server in the background self._thread = threading.Thread(target=self._server.serve_forever) self._thread.start() def _post_teardown(self): """Stop the test server.""" if self._thread is not None: self._server.shutdown() self._server.server_close() self._thread.join() del self._server @classmethod def probe_ports(cls, start=port_range[0], end=port_range[1]): port = start while port <= end: s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) try: s.connect(('127.0.0.1', port)) except socket.error as e: if not hasattr(e, 'args') or e.args[0] != errno.ECONNREFUSED: raise return port else: s.close() port += 1 return None