Commit ebb94845 authored by Kazuhiko Shiozaki's avatar Kazuhiko Shiozaki

* add some tests for SelectionTool.

* getSelectionNames(): return an empty list instead of an empty tupple
  if empty. fix a bug that raises an error without selection_data.
* remove bogus docstrings.
* add some docstrings.
* fix typos.



git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@12678 20353a03-c40f-0410-a6d1-a30d3c3de9de
parent 8d2242c9
...@@ -4,10 +4,10 @@ ...@@ -4,10 +4,10 @@
# Jean-Paul Smets-Solanes <jp@nexedi.com> # Jean-Paul Smets-Solanes <jp@nexedi.com>
# #
# WARNING: This program as such is intended to be used by professional # WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential # programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs # consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial # End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software # guarantees and support are strongly adviced to contract a Free Software
# Service Company # Service Company
# #
# This program is Free Software; you can redistribute it and/or # This program is Free Software; you can redistribute it and/or
...@@ -120,14 +120,17 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -120,14 +120,17 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'getSelectionNames') security.declareProtected(ERP5Permissions.View, 'getSelectionNames')
def getSelectionNames(self, context=None, REQUEST=None): def getSelectionNames(self, context=None, REQUEST=None):
"""
Returns the selection names
"""
if context is None: context = self if context is None: context = self
if not REQUEST: if not REQUEST:
REQUEST = get_request() REQUEST = get_request()
if hasattr(self, 'selection_data'): if hasattr(self, 'selection_data'):
user_id = self.portal_membership.getAuthenticatedMember().getUserName() user_id = self.portal_membership.getAuthenticatedMember().getUserName()
if user_id is not None and self.selection_data.has_key(user_id): if user_id is not None and self.selection_data.has_key(user_id):
return self.selection_data[user_id].keys() return self.selection_data[user_id].keys()
return () return []
security.declareProtected(ERP5Permissions.View, 'callSelectionFor') security.declareProtected(ERP5Permissions.View, 'callSelectionFor')
def callSelectionFor(self, selection_name, context=None, REQUEST=None): def callSelectionFor(self, selection_name, context=None, REQUEST=None):
...@@ -237,7 +240,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -237,7 +240,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'setSelectionCheckedUidsFor') security.declareProtected(ERP5Permissions.View, 'setSelectionCheckedUidsFor')
def setSelectionCheckedUidsFor(self, selection_name, checked_uids, REQUEST=None): def setSelectionCheckedUidsFor(self, selection_name, checked_uids, REQUEST=None):
""" """
Sets the selection params for a given selection_name Sets the checked uids for a given selection_name
""" """
selection_object = self.getSelectionFor(selection_name, REQUEST) selection_object = self.getSelectionFor(selection_name, REQUEST)
if selection_object: if selection_object:
...@@ -248,7 +251,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -248,7 +251,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
def updateSelectionCheckedUidList(self, selection_name, listbox_uid, uids, REQUEST=None): def updateSelectionCheckedUidList(self, selection_name, listbox_uid, uids, REQUEST=None):
""" """
Sets the selection params for a given selection_name Updates the checked uids for a given selection_name
""" """
if listbox_uid is None: if listbox_uid is None:
listbox_uid = [] listbox_uid = []
...@@ -260,7 +263,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -260,7 +263,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'getSelectionCheckedUidsFor') security.declareProtected(ERP5Permissions.View, 'getSelectionCheckedUidsFor')
def getSelectionCheckedUidsFor(self, selection_name, REQUEST=None): def getSelectionCheckedUidsFor(self, selection_name, REQUEST=None):
""" """
Sets the selection params for a given selection_name Returns the checked uids for a given selection_name
""" """
selection_object = self.getSelectionFor(selection_name, REQUEST) selection_object = self.getSelectionFor(selection_name, REQUEST)
if selection_object: if selection_object:
...@@ -272,7 +275,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -272,7 +275,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
def checkAll(self, selection_name, listbox_uid=[], REQUEST=None, def checkAll(self, selection_name, listbox_uid=[], REQUEST=None,
query_string=None, form_id=None): query_string=None, form_id=None):
""" """
Sets the selection params for a given selection_name Check uids in a given listbox_uid list for a given selection_name
""" """
selection_object = self.getSelectionFor(selection_name, REQUEST) selection_object = self.getSelectionFor(selection_name, REQUEST)
if selection_object: if selection_object:
...@@ -293,7 +296,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -293,7 +296,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
def uncheckAll(self, selection_name, listbox_uid=[], REQUEST=None, def uncheckAll(self, selection_name, listbox_uid=[], REQUEST=None,
query_string=None, form_id=None): query_string=None, form_id=None):
""" """
Sets the selection params for a given selection_name Uncheck uids in a given listbox_uid list for a given selection_name
""" """
selection_object = self.getSelectionFor(selection_name, REQUEST) selection_object = self.getSelectionFor(selection_name, REQUEST)
if selection_object: if selection_object:
...@@ -476,7 +479,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -476,7 +479,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'viewLast') security.declareProtected(ERP5Permissions.View, 'viewLast')
def viewLast(self, selection_index='', selection_name='', form_id='view', REQUEST=None): def viewLast(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
""" """
Access first item in a selection Access last item in a selection
""" """
if not REQUEST: if not REQUEST:
REQUEST = get_request() REQUEST = get_request()
...@@ -592,9 +595,6 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -592,9 +595,6 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'setPage') security.declareProtected(ERP5Permissions.View, 'setPage')
def setPage(self, list_selection_name, listbox_uid, query_string=None, uids=None, REQUEST=None): def setPage(self, list_selection_name, listbox_uid, query_string=None, uids=None, REQUEST=None):
"""
Access the previous page of a list
"""
if uids is None: uids = [] if uids is None: uids = []
selection = self.getSelectionFor(list_selection_name, REQUEST) selection = self.getSelectionFor(list_selection_name, REQUEST)
params = selection.getParams() params = selection.getParams()
...@@ -701,9 +701,6 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -701,9 +701,6 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'unfoldDomain') security.declareProtected(ERP5Permissions.View, 'unfoldDomain')
def unfoldDomain(self, REQUEST, form_id=None, query_string=None): def unfoldDomain(self, REQUEST, form_id=None, query_string=None):
"""
Sets the root domain for the current selection
"""
selection_name = REQUEST.list_selection_name selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST) selection = self.getSelectionFor(selection_name, REQUEST)
domain_url = REQUEST.form.get('domain_url',None) domain_url = REQUEST.form.get('domain_url',None)
...@@ -719,9 +716,6 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -719,9 +716,6 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'foldDomain') security.declareProtected(ERP5Permissions.View, 'foldDomain')
def foldDomain(self, REQUEST, form_id=None, query_string=None): def foldDomain(self, REQUEST, form_id=None, query_string=None):
"""
Sets the root domain for the current selection
"""
selection_name = REQUEST.list_selection_name selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST) selection = self.getSelectionFor(selection_name, REQUEST)
domain_url = REQUEST.form.get('domain_url',None) domain_url = REQUEST.form.get('domain_url',None)
...@@ -737,9 +731,6 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -737,9 +731,6 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'setReportRoot') security.declareProtected(ERP5Permissions.View, 'setReportRoot')
def setReportRoot(self, REQUEST, form_id=None, query_string=None): def setReportRoot(self, REQUEST, form_id=None, query_string=None):
"""
Sets the root domain for the current selection
"""
selection_name = REQUEST.list_selection_name selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST) selection = self.getSelectionFor(selection_name, REQUEST)
root_url = REQUEST.form.get('report_root_url','portal_categories') root_url = REQUEST.form.get('report_root_url','portal_categories')
...@@ -751,11 +742,6 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -751,11 +742,6 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'unfoldReport') security.declareProtected(ERP5Permissions.View, 'unfoldReport')
def unfoldReport(self, REQUEST, form_id=None, query_string=None): def unfoldReport(self, REQUEST, form_id=None, query_string=None):
"""
Sets the root domain for the current selection
report_list is a list of relative_url of category, domain, etc.
"""
selection_name = REQUEST.list_selection_name selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST) selection = self.getSelectionFor(selection_name, REQUEST)
report_url = REQUEST.form.get('report_url',None) report_url = REQUEST.form.get('report_url',None)
...@@ -768,9 +754,6 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -768,9 +754,6 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'foldReport') security.declareProtected(ERP5Permissions.View, 'foldReport')
def foldReport(self, REQUEST, form_id=None, query_string=None): def foldReport(self, REQUEST, form_id=None, query_string=None):
"""
Sets the root domain for the current selection
"""
selection_name = REQUEST.list_selection_name selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST) selection = self.getSelectionFor(selection_name, REQUEST)
report_url = REQUEST.form.get('report_url',None) report_url = REQUEST.form.get('report_url',None)
...@@ -799,7 +782,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -799,7 +782,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
selection_name=None, redirect=0, selection_name=None, redirect=0,
form_id=None, query_string=None): form_id=None, query_string=None):
""" """
Toogle display of the listbox Toggle display of the listbox
""" """
request = REQUEST request = REQUEST
# XXX FIXME # XXX FIXME
...@@ -941,7 +924,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -941,7 +924,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
def getPickle(self,**kw): def getPickle(self,**kw):
""" """
we give many keywords and we will get the corresponding we give many keywords and we will get the corresponding
pickle string and signature pickle string
""" """
#LOG('getPickle kw',0,kw) #LOG('getPickle kw',0,kw)
# XXX Remove DateTime, This is really bad, only use for zope 2.6 # XXX Remove DateTime, This is really bad, only use for zope 2.6
...@@ -973,7 +956,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -973,7 +956,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'getObjectFromPickle') security.declareProtected(ERP5Permissions.View, 'getObjectFromPickle')
def getObjectFromPickle(self,pickle_string): def getObjectFromPickle(self,pickle_string):
""" """
we give a pickle string and a signature get object from a pickle string
""" """
object = None object = None
pickle_string = pickle_string.replace('@@@','\n') pickle_string = pickle_string.replace('@@@','\n')
...@@ -987,7 +970,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -987,7 +970,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'getObjectFromPickleAndSignature') security.declareProtected(ERP5Permissions.View, 'getObjectFromPickleAndSignature')
def getObjectFromPickleAndSignature(self,pickle_string,signature): def getObjectFromPickleAndSignature(self,pickle_string,signature):
""" """
we give a pickle string and a signature get object from a pickle string only when a signature maches
""" """
cookie_password = self._getCookiePassword() cookie_password = self._getCookiePassword()
object = None object = None
...@@ -1010,7 +993,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -1010,7 +993,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'registerCookieInfo') security.declareProtected(ERP5Permissions.View, 'registerCookieInfo')
def setCookieInfo(self,request,cookie_name,**kw): def setCookieInfo(self,request,cookie_name,**kw):
""" """
regiter info directly in cookie register info directly in cookie
""" """
cookie_name = cookie_name + '_cookie' cookie_name = cookie_name + '_cookie'
(pickle_string,signature) = self.getPickleAndSignature(**kw) (pickle_string,signature) = self.getPickleAndSignature(**kw)
...@@ -1021,7 +1004,7 @@ class SelectionTool( UniqueObject, SimpleItem ): ...@@ -1021,7 +1004,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
security.declareProtected(ERP5Permissions.View, 'registerCookieInfo') security.declareProtected(ERP5Permissions.View, 'registerCookieInfo')
def getCookieInfo(self,request,cookie_name): def getCookieInfo(self,request,cookie_name):
""" """
regiter info directly in cookie get info directly from cookie
""" """
cookie_name = cookie_name + '_cookie' cookie_name = cookie_name + '_cookie'
object = None object = None
...@@ -1363,4 +1346,3 @@ for property_id in candidate_method_id_list: ...@@ -1363,4 +1346,3 @@ for property_id in candidate_method_id_list:
security_property = getattr(SelectionTool, security_property_id, None) security_property = getattr(SelectionTool, security_property_id, None)
if security_property is not None: if security_property is not None:
setattr(FolderMixIn, security_property_id, security_property) setattr(FolderMixIn, security_property_id, security_property)
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
)"> )">
<p class="form-help"> <p class="form-help">
This page show the active selections for the current user. This page show the active selections for the current user.
It is only usefull for debug purposes. It is only useful for debug purposes.
</p> </p>
<table cellspacing="0" cellpadding="2" border="1"> <table cellspacing="0" cellpadding="2" border="1">
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
<h3> <code>portal_selection</code> Tool </h3> <h3> <code>portal_selection</code> Tool </h3>
<p> This tool allows to manage persistant selections for listbox in ERP5. <p> This tool allows to manage persistent selections for listbox in ERP5.
</p> </p>
<dtml-var manage_page_footer> <dtml-var manage_page_footer>
##############################################################################
#
# Copyright (c) 2007 Nexedi SARL and Contributors. All Rights Reserved.
# Kazuhiko <kazuhiko@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program 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. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
import os, sys
if __name__ == '__main__':
execfile(os.path.join(sys.path[0], 'framework.py'))
# Needed in order to have a log file inside the current folder
os.environ['EVENT_LOG_FILE'] = os.path.join(os.getcwd(), 'zLOG.log')
os.environ['EVENT_LOG_SEVERITY'] = '-300'
from AccessControl.SecurityManagement import newSecurityManager,\
getSecurityManager
from zLOG import LOG
from DateTime import DateTime
from Testing import ZopeTestCase
from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
from Products.ERP5Form.Document.Preference import Priority
from Products.ERP5Form.Selection import Selection
class TestSelectionTool(ERP5TypeTestCase):
quiet = 1
run_all_tests = 1
def getTitle(self):
return "SelectionTool"
def getBusinessTemplateList(self):
# Use the same framework as the functional testing for convenience.
# This adds some specific portal types and skins.
return ('erp5_ui_test',)
def afterSetUp(self):
uf = self.getPortal().acl_users
uf._doAddUser('manager', '', ['Manager', 'Assignor'], [])
user = uf.getUserById('manager').__of__(uf)
newSecurityManager(None, user)
self.portal_selections = self.getPortal().portal_selections
self.portal_selections.setSelectionFor('test_selection', Selection())
self.portal_selections.setSelectionParamsFor('test_selection', {'key':'value'})
def testGetSelectionNames(self, quiet=quiet, run=run_all_test):
if not run: return
self.assertEquals(['test_selection'],
self.portal_selections.getSelectionNames())
def testGetSelectionFor(self, quiet=quiet, run=run_all_test):
if not run: return
selection = self.portal_selections.getSelectionFor('test_selection')
self.assert_(isinstance(selection, Selection))
self.assertEquals('test_selection', selection.name)
def testGetSelectionParamsFor(self, quiet=quiet, run=run_all_test):
if not run: return
self.assertEquals({'key':'value'},
self.portal_selections.getSelectionParamsFor('test_selection'))
if __name__ == '__main__':
framework()
else:
import unittest
def test_suite():
suite = unittest.TestSuite()
suite.addTest(unittest.makeSuite(TestSelectionTool))
return suite
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment