from DateTime import DateTime from plone.app.layout.navigation.interfaces import INavigationRoot from plone.app.querystring import queryparser from plone.registry import field from plone.registry import Record from plone.registry import Registry from plone.registry.interfaces import IRegistry from plone.app.querystring.queryparser import Row from plone.app.querystring.testing import \ NOT_INSTALLED_PLONEAPPQUERYSTRING_INTEGRATION_TESTING from zope.component import getGlobalSiteManager from zope.interface.declarations import implements import unittest2 as unittest MOCK_SITE_ID = "site" class MockObject(object): def __init__(self, uid, path): self.uid = uid self.path = path def getPath(self): return self.path def getPhysicalPath(self): return self.path.split("/") def absolute_url(self): return self.path class MockCatalog(object): def unrestrictedSearchResults(self, query): uid = query.get('UID') if uid == '00000000000000001': return [MockObject(uid='00000000000000001', path="/%s/foo" % MOCK_SITE_ID)] raise NotImplementedError def indexes(self): return ['Title', 'effectiveRange', 'object_provides', 'end', 'Description', 'is_folderish', 'getId', 'start', 'meta_type', 'is_default_page', 'Date', 'review_state', 'portal_type', 'expires', 'allowedRolesAndUsers', 'getObjPositionInParent', 'path', 'UID', 'effective', 'created', 'Creator', 'modified', 'SearchableText', 'sortable_title', 'getRawRelatedItems', 'Subject'] class MockPortalUrl(object): def getPortalPath(self): return "/%s" % MOCK_SITE_ID def getPortalObject(self): return MockObject(uid='00000000000000000', path="/%s" % MOCK_SITE_ID) class MockNavtreeProperties(object): def getProperty(self, name, default=""): return "" class MockSiteProperties(object): navtree_properties = MockNavtreeProperties() class MockSite(object): implements(INavigationRoot) def __init__(self, portal_membership=None): self.reference_catalog = MockCatalog() self.portal_catalog = MockCatalog() self.portal_membership = portal_membership self.portal_url = MockPortalUrl() self.portal_properties = MockSiteProperties() def getPhysicalPath(self): return ["", MOCK_SITE_ID] class MockUser(object): def __init__(self, username=None, roles=None): self.username = 'Anonymous User' if username: self.username = username self.roles = roles or "Anonymous" def getUserName(self): return self.username def getRoles(self): return self.roles class MockPortal_membership(object): def __init__(self, user): self.user = user def getAuthenticatedMember(self): return self.user class TestQueryParserBase(unittest.TestCase): layer = NOT_INSTALLED_PLONEAPPQUERYSTRING_INTEGRATION_TESTING def setUp(self): gsm = getGlobalSiteManager() self.registry = Registry() gsm.registerUtility(self.registry, IRegistry) self.setFunctionForOperation( 'plone.app.querystring.operation.string.is.operation', 'plone.app.querystring.queryparser._equal') self.setFunctionForOperation( 'plone.app.querystring.operation.string.path.operation', 'plone.app.querystring.queryparser._path') def setFunctionForOperation(self, operation, function): function_field = field.ASCIILine(title=u"Operator") function_record = Record(function_field) function_record.value = function self.registry.records[operation] = function_record class TestQueryParser(TestQueryParserBase): def test_exact_title(self): data = { 'i': 'Title', 'o': 'plone.app.querystring.operation.string.is', 'v': 'Welcome to Plone', } parsed = queryparser.parseFormquery(MockSite(), [data, ]) self.assertEqual(parsed, {'Title': {'query': 'Welcome to Plone'}}) def test_path_explicit(self): data = { 'i': 'path', 'o': 'plone.app.querystring.operation.string.path', 'v': '/foo', } parsed = queryparser.parseFormquery(MockSite(), [data, ]) self.assertEqual( parsed, {'path': {'query': ['/%s/foo' % MOCK_SITE_ID]}}) def test_path_computed(self): data = { 'i': 'path', 'o': 'plone.app.querystring.operation.string.path', 'v': '00000000000000001', } parsed = queryparser.parseFormquery(MockSite(), [data, ]) self.assertEqual( parsed, {'path': {'query': ['/%s/foo' % MOCK_SITE_ID]}}) def test_path_with_depth_computed(self): data = { 'i': 'path', 'o': 'plone.app.querystring.operation.string.path', 'v': '/foo::2', } parsed = queryparser.parseFormquery(MockSite(), [data, ]) self.assertEqual(parsed, { 'path': { 'query': ['/%s/foo' % MOCK_SITE_ID], 'depth': 2 } }) def test_multi_path(self): data_1 = { 'i': 'path', 'o': 'plone.app.querystring.operation.string.path', 'v': '/foo', } data_2 = { 'i': 'path', 'o': 'plone.app.querystring.operation.string.path', 'v': '/bar', } parsed = queryparser.parseFormquery(MockSite(), [data_1, data_2]) self.assertEqual( parsed, {'path': {'query': [ '/%s/foo' % MOCK_SITE_ID, '/%s/bar' % MOCK_SITE_ID]}}) def test_multi_path_with_depth_computet(self): data_1 = { 'i': 'path', 'o': 'plone.app.querystring.operation.string.path', 'v': '/foo::2', } data_2 = { 'i': 'path', 'o': 'plone.app.querystring.operation.string.path', 'v': '/bar::5', } parsed = queryparser.parseFormquery(MockSite(), [data_1, data_2]) self.assertEqual( parsed, {'path': {'query': [ '/%s/foo' % MOCK_SITE_ID, '/%s/bar' % MOCK_SITE_ID], 'depth': 2}}) class TestQueryGenerators(TestQueryParserBase): def test__between(self): data = Row( index='modified', operator='_between', values=['2009/08/12', '2009/08/14'] ) parsed = queryparser._between(MockSite(), data) expected = {'modified': {'query': ['2009/08/12', '2009/08/14'], 'range': 'minmax'}} self.assertEqual(parsed, expected) def test__between_reversed_dates(self): data = Row( index='modified', operator='_between', values=['2009/08/14', '2009/08/12'] ) parsed = queryparser._between(MockSite(), data) expected = {'modified': {'query': ['2009/08/12', '2009/08/14'], 'range': 'minmax'}} self.assertEqual(parsed, expected) def test__equal(self): data = Row( index='modified', operator='_equal', values='2010/03/18' ) parsed = queryparser._equal(MockSite(), data) expected = {'modified': {'query': '2010/03/18'}} self.assertEqual(parsed, expected) data = Row( index='modified', operator='_equal', values=['2010/03/18', '2010/03/19'] ) parsed = queryparser._equal(MockSite(), data) expected = {'modified': {'query': ['2010/03/18', '2010/03/19']}} self.assertEqual(parsed, expected) def test__intEqual(self): data = Row( index='modified', operator='_intEqual', values='20' ) parsed = queryparser._intEqual(MockSite(), data) expected = {'modified': {'query': 20}} self.assertEqual(parsed, expected) data = Row( index='modified', operator='_intEqual', values=['20', '21'] ) parsed = queryparser._intEqual(MockSite(), data) expected = {'modified': {'query': [20, 21]}} self.assertEqual(parsed, expected) def test__lessThan(self): data = Row( index='modified', operator='_lessThan', values='2010/03/18' ) parsed = queryparser._lessThan(MockSite(), data) expected = {'modified': {'query': '2010/03/18', 'range': 'max'}} self.assertEqual(parsed, expected) def test__intLessThan(self): data = Row( index='modified', operator='_intLessThan', values='20' ) parsed = queryparser._intLessThan(MockSite(), data) expected = {'modified': {'query': 20, 'range': 'max'}} self.assertEqual(parsed, expected) def test__largerThan(self): data = Row( index='modified', operator='_largerThan', values='2010/03/18' ) parsed = queryparser._largerThan(MockSite(), data) expected = {'modified': {'query': '2010/03/18', 'range': 'min'}} self.assertEqual(parsed, expected) def test__intLargerThan(self): data = Row( index='modified', operator='_intLargerThan', values='20' ) parsed = queryparser._intLargerThan(MockSite(), data) expected = {'modified': {'query': 20, 'range': 'min'}} self.assertEqual(parsed, expected) def test__currentUser(self): # Anonymous user u = MockUser() pm = MockPortal_membership(user=u) context = MockSite(portal_membership=pm) data = Row( index='Creator', operator='_currentUser', values=None ) parsed = queryparser._currentUser(context, data) expected = {'Creator': {'query': 'Anonymous User'}} self.assertEqual(parsed, expected) # Logged in user 'admin' u = MockUser(username='admin') pm = MockPortal_membership(user=u) context = MockSite(portal_membership=pm) data = Row( index='Creator', operator='_currentUser', values=None ) parsed = queryparser._currentUser(context, data) expected = {'Creator': {'query': 'admin'}} self.assertEqual(parsed, expected) def test__showInactive(self): # Anonymous user u = MockUser() pm = MockPortal_membership(user=u) context = MockSite(portal_membership=pm) data = Row(index='show_inactive', operator='_showInactive', values=["Manager"]) parsed = queryparser._showInactive(context, data) # False is expected since Anonymous doesn't have Manager role expected = {'show_inactive': False} self.assertEqual(parsed, expected) # Logged in user 'admin' u = MockUser(username='admin', roles=("Manager",)) pm = MockPortal_membership(user=u) context = MockSite(portal_membership=pm) data = Row(index='show_inactive', operator='_showInactive', values=["Manager"]) parsed = queryparser._showInactive(context, data) # True is expected since Admin should have Manager role expected = {'show_inactive': True} self.assertEqual(parsed, expected) def test__lessThanRelativeDate(self): days = 2 now = DateTime() mydate = now + days expected_dates = [now.earliestTime(), mydate.latestTime()] expected = {'modified': {'query': expected_dates, 'range': 'minmax'}} data = Row( index='modified', operator='_lessThanRelativeDate', values=days ) parsed = queryparser._lessThanRelativeDate(MockSite(), data) self.assertEqual(parsed, expected) def test__moreThanRelativeDate(self): days = 2 now = DateTime() mydate = now - days expected_dates = [mydate.earliestTime(), now.latestTime()] expected = {'modified': {'query': expected_dates, 'range': 'minmax'}} data = Row( index='modified', operator='_moreThanRelativeDate', values=days ) parsed = queryparser._moreThanRelativeDate(MockSite(), data) self.assertEqual(parsed, expected) def test__today(self): now = DateTime() expected_dates = [now.earliestTime(), now.latestTime()] expected = {'modified': {'query': expected_dates, 'range': 'minmax'}} data = Row( index='modified', operator='_today', values=expected_dates ) parsed = queryparser._today(MockSite(), data) self.assertEqual(parsed, expected) def test__path(self): # normal path data = Row( index='path', operator='_path', values='/news/' ) parsed = queryparser._path(MockSite(), data) expected = {'path': {'query': ['/%s/news/' % MOCK_SITE_ID]}} self.assertEqual(parsed, expected) # by uid data = Row( index='path', operator='_path', values='00000000000000001' ) parsed = queryparser._path(MockSite(), data) expected = {'path': {'query': ['/%s/foo' % MOCK_SITE_ID]}} self.assertEqual(parsed, expected) def test__relativePath(self): # build test navtree context = MockObject(uid='00000000000000001', path="/%s/bar/fizz" % MOCK_SITE_ID) context.__parent__ = MockObject(uid='00000000000000002', path="/%s/bar" % MOCK_SITE_ID) # Plone root context.__parent__.__parent__ = MockSite() # Zope root context.__parent__.__parent__.__parent__ = \ MockObject(uid='00000000000000004', path="/") # ploneroot sub folder context.__parent__.__parent__.ham = \ MockObject(uid='00000000000000005', path="/%s/ham" % MOCK_SITE_ID) # collection subfolder context.__parent__.egg = MockObject(uid='00000000000000006', path="/%s/bar/egg" % MOCK_SITE_ID) # show my siblings data = Row( index='path', operator='_relativePath', values='..' ) parsed = queryparser._relativePath(context, data) expected = {'path': {'query': ['/%s/bar' % MOCK_SITE_ID]}} self.assertEqual(parsed, expected) # walk upwards data = Row( index='path', operator='_relativePath', values='../../' ) parsed = queryparser._relativePath(context, data) expected = {'path': {'query': ['/%s' % MOCK_SITE_ID]}} self.assertEqual(parsed, expected) # if you walk beyond INavigatinRoot it should stop and return data = Row(index='path', operator='_relativePath', values='../../../') parsed = queryparser._relativePath(context, data) expected = {'path': {'query': ['/%s' % MOCK_SITE_ID]}} self.assertEqual(parsed, expected) # reach a subfolder on Plone root data = Row(index='path', operator='_relativePath', values='../../ham') parsed = queryparser._relativePath(context, data) expected = {'path': {'query': ['/%s/ham' % MOCK_SITE_ID]}} self.assertEqual(parsed, expected) # reach a subfolder on parent of collection data = Row(index='path', operator='_relativePath', values='../egg') parsed = queryparser._relativePath(context, data) expected = {'path': {'query': ['/%s/bar/egg' % MOCK_SITE_ID]}} self.assertEqual(parsed, expected) # relative path with depth data = Row( index='path', operator='_relativePath', values='..::2' ) parsed = queryparser._relativePath(context, data) expected = {'path': {'query': ['/%s/bar' % MOCK_SITE_ID], 'depth': 2}} self.assertEqual(parsed, expected) def test_getPathByUID(self): actual = queryparser.getPathByUID(MockSite(), '00000000000000001') self.assertEqual(actual, '/site/foo')