[2755] | 1 | from zope.component import getUtility, getMultiAdapter |
---|
| 2 | |
---|
| 3 | from plone.portlets.interfaces import IPortletType |
---|
| 4 | from plone.portlets.interfaces import IPortletManager |
---|
| 5 | from plone.portlets.interfaces import IPortletAssignment |
---|
| 6 | from plone.portlets.interfaces import IPortletDataProvider |
---|
| 7 | from plone.portlets.interfaces import IPortletRenderer |
---|
| 8 | |
---|
| 9 | from plone.app.portlets.storage import PortletAssignmentMapping |
---|
| 10 | |
---|
| 11 | from quintagroup.portlet.collection import collection |
---|
| 12 | |
---|
| 13 | from quintagroup.portlet.collection.tests.base import TestCase |
---|
| 14 | |
---|
| 15 | |
---|
| 16 | from Products.CMFCore.utils import getToolByName |
---|
| 17 | |
---|
[3555] | 18 | |
---|
[2755] | 19 | class TestQPortletCollection(TestCase): |
---|
| 20 | def afterSetUp(self): |
---|
| 21 | self.setRoles(('Manager',)) |
---|
| 22 | |
---|
| 23 | def testPortletTypeRegistered(self): |
---|
[3555] | 24 | portlet = getUtility( |
---|
| 25 | IPortletType, name='quintagroup.portlet.collection.Collection') |
---|
| 26 | self.assertEquals( |
---|
| 27 | portlet.addview, 'quintagroup.portlet.collection.Collection') |
---|
[2755] | 28 | |
---|
| 29 | def testInterfaces(self): |
---|
| 30 | portlet = collection.Assignment(header=u"title") |
---|
| 31 | self.failUnless(IPortletAssignment.providedBy(portlet)) |
---|
| 32 | self.failUnless(IPortletDataProvider.providedBy(portlet.data)) |
---|
| 33 | |
---|
| 34 | def testInvokeAddview(self): |
---|
[3555] | 35 | portlet = getUtility( |
---|
| 36 | IPortletType, name='quintagroup.portlet.collection.Collection') |
---|
| 37 | mapping = self.portal.restrictedTraverse( |
---|
| 38 | '++contextportlets++plone.leftcolumn') |
---|
[2755] | 39 | for m in mapping.keys(): |
---|
| 40 | del mapping[m] |
---|
| 41 | addview = mapping.restrictedTraverse('+/' + portlet.addview) |
---|
| 42 | |
---|
[3555] | 43 | addview.createAndAdd(data={'header': u"test title"}) |
---|
[2755] | 44 | |
---|
| 45 | self.assertEquals(len(mapping), 1) |
---|
| 46 | self.failUnless(isinstance(mapping.values()[0], collection.Assignment)) |
---|
| 47 | |
---|
| 48 | def testInvokeEditView(self): |
---|
| 49 | mapping = PortletAssignmentMapping() |
---|
| 50 | request = self.folder.REQUEST |
---|
| 51 | |
---|
| 52 | mapping['foo'] = collection.Assignment(header=u"title") |
---|
| 53 | editview = getMultiAdapter((mapping['foo'], request), name='edit') |
---|
| 54 | self.failUnless(isinstance(editview, collection.EditForm)) |
---|
| 55 | |
---|
| 56 | def testRenderer(self): |
---|
| 57 | context = self.folder |
---|
| 58 | request = self.folder.REQUEST |
---|
| 59 | view = self.folder.restrictedTraverse('@@plone') |
---|
[3555] | 60 | manager = getUtility( |
---|
| 61 | IPortletManager, name='plone.rightcolumn', context=self.portal) |
---|
[2755] | 62 | assignment = collection.Assignment(header=u"title") |
---|
| 63 | |
---|
[3555] | 64 | renderer = getMultiAdapter( |
---|
| 65 | (context, request, view, manager, assignment), IPortletRenderer) |
---|
[2755] | 66 | self.failUnless(isinstance(renderer, collection.Renderer)) |
---|
| 67 | |
---|
[3555] | 68 | |
---|
[2755] | 69 | class TestQPortletCollectionRenderer(TestCase): |
---|
| 70 | |
---|
| 71 | def afterSetUp(self): |
---|
| 72 | self.setRoles(('Manager',)) |
---|
| 73 | self.pages = self._createType(self.folder, 'Topic', 'pages') |
---|
[3555] | 74 | crit = self.folder.pages.addCriterion( |
---|
| 75 | 'portal_type', 'ATSimpleStringCriterion') |
---|
[2755] | 76 | crit.setValue('Document') |
---|
| 77 | |
---|
[3555] | 78 | def renderer(self, context=None, request=None, view=None, manager=None, |
---|
| 79 | assignment=None): |
---|
[2755] | 80 | context = context or self.folder |
---|
| 81 | request = request or self.folder.REQUEST |
---|
| 82 | view = view or self.folder.restrictedTraverse('@@plone') |
---|
[3555] | 83 | manager = manager or getUtility( |
---|
| 84 | IPortletManager, name='plone.rightcolumn', context=self.portal) |
---|
[2755] | 85 | assignment = assignment or collection.Assignment(header=u"title") |
---|
| 86 | |
---|
[3555] | 87 | return getMultiAdapter((context, request, view, manager, assignment), |
---|
| 88 | IPortletRenderer) |
---|
[2755] | 89 | |
---|
| 90 | def _createType(self, context, portal_type, id, **kwargs): |
---|
| 91 | """Helper method to create a new type |
---|
| 92 | """ |
---|
| 93 | ttool = getToolByName(context, 'portal_types') |
---|
| 94 | cat = self.portal.portal_catalog |
---|
| 95 | |
---|
| 96 | fti = ttool.getTypeInfo(portal_type) |
---|
| 97 | fti.constructInstance(context, id, **kwargs) |
---|
| 98 | obj = getattr(context.aq_inner.aq_explicit, id) |
---|
| 99 | cat.indexObject(obj) |
---|
| 100 | return obj |
---|
| 101 | |
---|
| 102 | def test_collection_path_unicode(self): |
---|
| 103 | """ |
---|
| 104 | Cover problem in #9184 |
---|
| 105 | """ |
---|
[3555] | 106 | r = self.renderer( |
---|
| 107 | context=self.portal, |
---|
| 108 | assignment=collection.Assignment(header=u"title", |
---|
| 109 | target_collection=u"/events")) |
---|
| 110 | r = r.__of__(self.folder) |
---|
[2755] | 111 | self.assertEqual(r.collection().id, 'events') |
---|
| 112 | |
---|
| 113 | def test_portletStyle(self): |
---|
| 114 | renderer = self.renderer(context=self.portal, |
---|
[3555] | 115 | assignment=collection.Assignment( |
---|
| 116 | header=u"title", |
---|
| 117 | styling="TestClass")) |
---|
[2755] | 118 | renderer = renderer.__of__(self.folder) |
---|
| 119 | renderer.update() |
---|
| 120 | |
---|
| 121 | self.failUnless('TestClass' in renderer.render()) |
---|
| 122 | |
---|
| 123 | def test_attributes(self): |
---|
| 124 | page = self._createType(self.folder, 'Document', 'page') |
---|
| 125 | page.update(title="Test Page", description="Test description") |
---|
[3555] | 126 | target_collection = '/Members/test_user_1_/pages' |
---|
[2755] | 127 | renderer = self.renderer(context=self.portal, |
---|
[3555] | 128 | assignment=collection.Assignment( |
---|
| 129 | header=u"title", |
---|
| 130 | item_attributes=[u'Title'], |
---|
| 131 | target_collection=target_collection)) |
---|
[2755] | 132 | renderer = renderer.__of__(self.folder) |
---|
| 133 | renderer.update() |
---|
| 134 | self.failUnless('Test Page' in renderer.render()) |
---|
| 135 | self.failUnless('Test description' not in renderer.render()) |
---|
| 136 | |
---|
[3555] | 137 | |
---|
[2755] | 138 | class TestQPortletCollectionQuery(TestCase): |
---|
| 139 | |
---|
| 140 | def afterSetUp(self): |
---|
| 141 | self.setRoles(('Manager',)) |
---|
| 142 | #make a collection |
---|
| 143 | self.collection = self._createType(self.folder, 'Topic', 'collection') |
---|
| 144 | |
---|
| 145 | def _createType(self, context, portal_type, id, **kwargs): |
---|
| 146 | """Helper method to create a new type |
---|
| 147 | """ |
---|
| 148 | ttool = getToolByName(context, 'portal_types') |
---|
| 149 | cat = self.portal.portal_catalog |
---|
| 150 | |
---|
| 151 | fti = ttool.getTypeInfo(portal_type) |
---|
| 152 | fti.constructInstance(context, id, **kwargs) |
---|
| 153 | obj = getattr(context.aq_inner.aq_explicit, id) |
---|
| 154 | cat.indexObject(obj) |
---|
| 155 | return obj |
---|
| 156 | |
---|
[3555] | 157 | def renderer(self, context=None, request=None, view=None, manager=None, |
---|
| 158 | assignment=None): |
---|
[2755] | 159 | context = context or self.folder |
---|
| 160 | request = request or self.folder.REQUEST |
---|
| 161 | view = view or self.folder.restrictedTraverse('@@plone') |
---|
[3555] | 162 | manager = manager or getUtility( |
---|
| 163 | IPortletManager, name='plone.leftcolumn', context=self.portal) |
---|
[2755] | 164 | assignment = assignment |
---|
[3555] | 165 | return getMultiAdapter((context, request, view, manager, assignment), |
---|
| 166 | IPortletRenderer) |
---|
[2755] | 167 | |
---|
| 168 | def testSimpleQuery(self): |
---|
| 169 | # set up our collection to search for Folders |
---|
[3555] | 170 | crit = self.folder.collection.addCriterion( |
---|
| 171 | 'portal_type', 'ATSimpleStringCriterion') |
---|
[2755] | 172 | crit.setValue('Folder') |
---|
| 173 | |
---|
| 174 | # add a few folders |
---|
| 175 | for i in range(6): |
---|
[3555] | 176 | self.folder.invokeFactory('Folder', 'folder_%s' % i) |
---|
| 177 | getattr(self.folder, 'folder_%s' % i).reindexObject() |
---|
[2755] | 178 | |
---|
| 179 | # the folders are returned by the topic |
---|
| 180 | collection_num_items = len(self.folder.collection.queryCatalog()) |
---|
| 181 | # We better have some folders |
---|
| 182 | self.failUnless(collection_num_items >= 6) |
---|
| 183 | |
---|
| 184 | mapping = PortletAssignmentMapping() |
---|
[3555] | 185 | t_collection = '/Members/test_user_1_/collection' |
---|
| 186 | mapping['foo'] = collection.Assignment(header=u"title", |
---|
| 187 | target_collection=t_collection) |
---|
| 188 | collectionrenderer = self.renderer(context=None, request=None, |
---|
| 189 | view=None, manager=None, |
---|
| 190 | assignment=mapping['foo']) |
---|
[2755] | 191 | |
---|
| 192 | # we want the portlet to return us the same results as the collection |
---|
[3555] | 193 | self.assertEquals( |
---|
| 194 | collection_num_items, len(collectionrenderer.results())) |
---|
[2755] | 195 | |
---|
| 196 | def testRandomQuery(self): |
---|
[3556] | 197 | # we're being perhaps a bit too clever in random mode with the |
---|
| 198 | # internals of the LazyMap returned by the collection query, so let's |
---|
| 199 | # try a bunch of scenarios to make sure they work |
---|
[2755] | 200 | |
---|
[3540] | 201 | def reset_memoize(inst): |
---|
[3556] | 202 | # Decorator memoize adds attribute('_memojito_') to class instance. |
---|
[3554] | 203 | # It has cached function and their values so it should be deleted |
---|
[3540] | 204 | # for testing. |
---|
| 205 | # Extra info: http://codereview.corp.quintagroup.com/171241/show |
---|
| 206 | if hasattr(inst, '_memojito_'): |
---|
| 207 | delattr(inst, '_memojito_') |
---|
[3554] | 208 | |
---|
[2755] | 209 | # set up our portlet renderer |
---|
| 210 | mapping = PortletAssignmentMapping() |
---|
[3555] | 211 | t_collection = '/Members/test_user_1_/collection' |
---|
[2755] | 212 | mapping['foo'] = collection.Assignment(header=u"title", |
---|
| 213 | random=True, |
---|
[3555] | 214 | target_collection=t_collection) |
---|
| 215 | collectionrenderer = self.renderer(context=None, request=None, |
---|
| 216 | view=None, manager=None, |
---|
| 217 | assignment=mapping['foo']) |
---|
[2755] | 218 | |
---|
| 219 | # add some folders |
---|
| 220 | for i in range(6): |
---|
[3555] | 221 | self.folder.invokeFactory('Folder', 'folder_%s' % i) |
---|
| 222 | getattr(self.folder, 'folder_%s' % i).reindexObject() |
---|
[2755] | 223 | |
---|
[3556] | 224 | # collection with no criteria -- should return empty list, without |
---|
| 225 | # error |
---|
[2755] | 226 | self.assertEqual(len(collectionrenderer.results()), 0) |
---|
[3540] | 227 | reset_memoize(collectionrenderer) |
---|
[2755] | 228 | |
---|
| 229 | # let's make sure the results aren't being memoized |
---|
| 230 | old_func = self.folder.collection.queryCatalog |
---|
| 231 | global collection_was_called |
---|
| 232 | collection_was_called = False |
---|
[3555] | 233 | |
---|
[2755] | 234 | def mark_collection_called(**kw): |
---|
| 235 | global collection_was_called |
---|
| 236 | collection_was_called = True |
---|
| 237 | self.folder.collection.queryCatalog = mark_collection_called |
---|
| 238 | collectionrenderer.results() |
---|
[3540] | 239 | reset_memoize(collectionrenderer) |
---|
[2755] | 240 | self.folder.collection.queryCatalog = old_func |
---|
| 241 | self.failUnless(collection_was_called) |
---|
| 242 | |
---|
| 243 | # collection with simple criterion -- should return 1 (random) folder |
---|
[3555] | 244 | crit = self.folder.collection.addCriterion( |
---|
| 245 | 'portal_type', 'ATSimpleStringCriterion') |
---|
[2755] | 246 | crit.setValue('Folder') |
---|
| 247 | self.assertEqual(len(collectionrenderer.results()), 1) |
---|
[3540] | 248 | reset_memoize(collectionrenderer) |
---|
[2755] | 249 | |
---|
| 250 | # collection with multiple criteria -- should behave similarly |
---|
[3555] | 251 | crit = self.folder.collection.addCriterion( |
---|
| 252 | 'Creator', 'ATSimpleStringCriterion') |
---|
[2755] | 253 | crit.setValue('test_user_1_') |
---|
| 254 | collectionrenderer.results() |
---|
| 255 | |
---|
[3556] | 256 | # collection with sorting -- should behave similarly (sort is |
---|
| 257 | # ignored internally) |
---|
[2755] | 258 | self.folder.collection.setSortCriterion('modified', False) |
---|
| 259 | self.assertEqual(len(collectionrenderer.results()), 1) |
---|
[3540] | 260 | reset_memoize(collectionrenderer) |
---|
[2755] | 261 | |
---|
[3556] | 262 | # same criteria, now with limit set to 2 -- should return 2 (random) |
---|
| 263 | # folders |
---|
[2755] | 264 | collectionrenderer.data.limit = 2 |
---|
| 265 | self.assertEqual(len(collectionrenderer.results()), 2) |
---|
[3540] | 266 | reset_memoize(collectionrenderer) |
---|
[2755] | 267 | |
---|
[3556] | 268 | # make sure there's no error if the limit is greater than the # of |
---|
| 269 | # results found |
---|
[2755] | 270 | collectionrenderer.data.limit = 10 |
---|
| 271 | self.failUnless(len(collectionrenderer.results()) >= 6) |
---|
[3540] | 272 | reset_memoize(collectionrenderer) |
---|
[2755] | 273 | |
---|
| 274 | |
---|
| 275 | def test_suite(): |
---|
| 276 | from unittest import TestSuite, makeSuite |
---|
| 277 | suite = TestSuite() |
---|
| 278 | suite.addTest(makeSuite(TestQPortletCollection)) |
---|
| 279 | suite.addTest(makeSuite(TestQPortletCollectionRenderer)) |
---|
| 280 | suite.addTest(makeSuite(TestQPortletCollectionQuery)) |
---|
| 281 | return suite |
---|