testERP5Category.py

##############################################################################
#
# Copyright (c) 2004 Nexedi SARL and Contributors. All Rights Reserved.
#          Sebastien Robin <seb@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability 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
# garantees 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 unittest
from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
from Products.ERP5Type.Base import _aq_reset
from AccessControl.SecurityManagement import newSecurityManager

class TestERP5Category(ERP5TypeTestCase):

  # Different variables used for this test
  run_all_test = 1
  quiet = 1
  base_cat = 'abc'
  base_cat2 = 'efg'
  cat_list = [base_cat + '/1',base_cat + '/2']
  new_cat_list = [base_cat + '/3',base_cat + '/2']
  deep_cat_list = [base_cat + '/1/1',base_cat + '/2/1']
  new_deep_cat_list = [base_cat + '/3/1',base_cat + '/2/1']

  def getTitle(self):
    """
    """
    return "ERP5 Categories"

  def getBusinessTemplateList(self):
    """
      Return the list of business templates.

    """
    return ('erp5_base',)

  def getPortalId(self):
    return self.getPortal().getId()

  def getOrderLine(self):
    return self.getSaleOrderModule()['1']['1']

  def getPredicate(self):
    return self.getSalePackingListModule()['1']

  def afterSetUp(self):
    self.login()
    # This add the base category size
    portal_categories = self.getCategoryTool()
    person_module = self.getPersonModule()
    bc = self.base_cat
    if bc not in portal_categories.objectIds():
      portal_categories.newContent(portal_type='Base Category', id=bc)
    if not portal_categories[bc].has_key('1'):
      portal_categories[bc].newContent(id='1', portal_type='Category')
    self.cat1 = portal_categories[bc]['1']
    if not self.cat1.has_key('1'):
      self.cat1.newContent(id='1', portal_type='Category')
    self.deep_cat1 = self.cat1['1']
    if not portal_categories[bc].has_key('2'):
      portal_categories[bc].newContent(id='2', portal_type='Category')
    self.cat2 = portal_categories[bc]['2']
    if not self.cat2.has_key('1'):
      self.cat2.newContent(id='1', portal_type='Category')
    self.deep_cat2 = self.cat2['1']

    # associate base categories on Organisation portal type
    type_info = self.getTypeTool().Organisation
    type_info._setTypeBaseCategoryList([self.base_cat, self.base_cat2])

    self.commit()

    organisation_module = self.getOrganisationModule()
    if not organisation_module.has_key('1'):
      organisation_module.newContent(id='1', portal_type='Organisation')
    self.organisation = organisation_module['1']
    if not self.organisation.has_key('1'):
      self.organisation.newContent(id='1', portal_type='Telephone')
    self.telephone = self.organisation['1']
    if not organisation_module.has_key('2'):
      organisation_module.newContent(id='2', portal_type='Organisation')
    self.organisation2 = organisation_module['2']
    if not self.organisation2.has_key('1'):
      self.organisation2.newContent(id='1', portal_type='Telephone')
    self.telephone2 = self.organisation2['1']
    if not person_module.has_key('1'):
      person_module.newContent(id='1', portal_type = 'Person')
    self.person = person_module['1']

    bc2 = self.base_cat2
    if bc2 not in portal_categories.objectIds():
      portal_categories.newContent(portal_type='Base Category', id=bc2)
    if not portal_categories[bc2].has_key('1'):
      portal_categories[bc2].newContent(id='1', portal_type='Category')
    self.efg_l1 = portal_categories[bc2]['1']
    if not self.efg_l1.has_key('11'):
      self.efg_l1.newContent(id='11', portal_type='Category')
    self.efg_l2 = self.efg_l1['11']
    if not self.efg_l2.has_key('111'):
      self.efg_l2.newContent(id='111', portal_type='Category')
    self.efg_l3 = self.efg_l2['111']
    if not self.efg_l3.has_key('1111'):
      self.efg_l3.newContent(id='1111',portal_type='Category')
    self.efg_l4 = self.efg_l3['1111']

    # We have no place to put a Predicate, we will put it in the
    # Organisation Module
    module_type = organisation_module.getTypeInfo()
    content_type_set = set(module_type.getTypeAllowedContentTypeList())
    content_type_set.add('Mapped Value')
    module_type._setTypeAllowedContentTypeList(tuple(content_type_set))
    if not organisation_module.has_key('predicate'):
      organisation_module.newContent(id='predicate', portal_type='Mapped Value')
    predicate = organisation_module['predicate']
    predicate.setCriterion('quantity', identity=None, min=None, max=None)
    self.predicate = predicate

    self.commit()# If we don't commit, then we can't rename
    self.tic()

  def beforeTearDown(self):
    portal_categories = self.getCategoryTool()
    if portal_categories[self.base_cat].has_key('3'):
      portal_categories[self.base_cat].manage_delObjects('3')
      self.commitAndTic()

    portal = self.getPortal()
    if 'new_id' in portal.objectIds():
      portal['new_id'].edit(id='organisation_module')
      self.commitAndTic()

    organisation_module = self.getOrganisationModule()
    if organisation_module.has_key('new_id'):
      organisation_module.manage_delObjects('new_id')

    self.commitAndTic()

  def login(self):
    uf = self.getPortal().acl_users
    uf._doAddUser('seb', '', ['Manager'], [])
    user = uf.getUserById('seb').__of__(uf)
    newSecurityManager(None, user)

  def commitAndTic(self):
    """Just to save one line.
    """
    self.tic()

  def test_01_RenameCategory(self, quiet=quiet, run=run_all_test):
    if not run: return
    if not quiet:
      self.logMessage('Rename Category')
    organisation = self.organisation
    organisation.setCategoryList(self.cat_list)
    self.commitAndTic()
    self.failIfDifferentSet(organisation.getCategoryList(),self.cat_list)
    portal_categories = self.getCategoryTool()
    portal_categories[self.base_cat]['1'].edit(id='3')
    self.commitAndTic()
    self.failIfDifferentSet(organisation.getCategoryList(),self.new_cat_list)

  def test_02_RenameCategoryTree(self, quiet=quiet, run=run_all_test):
    if not run: return
    if not quiet:
      self.logMessage('Rename Category Tree')
    organisation = self.organisation
    organisation.setCategoryList(self.deep_cat_list)
    self.commitAndTic()
    self.failIfDifferentSet(organisation.getCategoryList(),self.deep_cat_list)
    portal_categories = self.getCategoryTool()
    portal_categories[self.base_cat]['1'].edit(id='3')
    self.commitAndTic()
    self.failIfDifferentSet(organisation.getCategoryList(),self.new_deep_cat_list)

  def test_03_RenameRelatedObject(self, quiet=quiet, run=run_all_test):
    if not run: return
    if not quiet:
      self.logMessage('Rename Related Object')
    organisation = self.organisation
    organisation2 = self.organisation2
    organisation.setAbcValueList([organisation2])
    self.commitAndTic()
    self.assertEqual(organisation.getAbcValueList(),[organisation2])
    self.assertEqual(organisation.getAbcIdList(),['2'])
    organisation2.edit(id='new_id')
    self.commitAndTic()
    self.assertEqual(organisation.getAbcValueList(),[organisation2])
    self.assertEqual(organisation.getAbcIdList(),['new_id'])

  def test_04_RenameObjectWithRelatedSubObject(
                            self, quiet=quiet, run=run_all_test):
    if not run: return
    if not quiet:
      self.logMessage('Rename Object With a related Sub Object')
    telephone2 = self.telephone2
    organisation = self.organisation
    organisation2 = self.organisation2
    organisation.setAbcValueList([telephone2])
    self.commitAndTic()
    self.assertEqual(organisation.getAbcValueList(),[telephone2])
    self.assertEqual(organisation.getAbcList(),[telephone2.getRelativeUrl()])
    organisation2.edit(id='new_id')
    self.commitAndTic()
    self.assertEqual(organisation.getAbcValueList(),[telephone2])
    self.assertEqual(organisation.getAbcList(),[telephone2.getRelativeUrl()])

  def test_05_RenameMembershipCriterionCategory(
                            self, quiet=quiet, run=run_all_test):
    if not run: return
    if not quiet:
      self.logMessage('Rename Membership Criterion Category')
    predicate = self.predicate
    predicate.setMembershipCriterionBaseCategoryList(self.base_cat)
    predicate.setMembershipCriterionCategoryList(self.cat_list)
    self.commitAndTic()
    self.failIfDifferentSet(predicate.getMembershipCriterionCategoryList(),self.cat_list)
    portal_categories = self.getCategoryTool()
    portal_categories[self.base_cat]['1'].edit(id='3')
    self.commitAndTic()
    self.failIfDifferentSet(predicate.getMembershipCriterionCategoryList(),self.new_cat_list)

  def test_06_RenameModuleWithObjectOuterRelated(
                                self, quiet=quiet, run=run_all_test):
    if not run: return
    if not quiet:
      self.logMessage('Rename Module With an Object Related to an Object it Contains')
    organisation_module = self.getOrganisationModule()
    organisation = self.organisation
    person = self.person
    person.setSubordinationValue(organisation)
    self.commitAndTic()
    self.assertEqual(person.getSubordinationValue(),organisation)
    organisation_module.edit(id='new_id')
    self.commitAndTic()
    self.assertEqual(person.getSubordinationValue(),organisation)

  def test_07_RenameBaseCategoryWithPersonRelatedToSubSubSubCategory(
                                  self, quiet=quiet, run=run_all_test):
    if not run: return
    if not quiet:
      self.logMessage('Rename a Base Category with a Person Related to a Sub-Sub-Sub-Category')
    o = self.organisation
    o.setEfgValueList([self.efg_l4])
    self.commitAndTic()
    self.failIfDifferentSet(o.getEfgList(base=1),[self.base_cat2+'/1/11/111/1111'])
    self.efg_l1.edit(id='new_id')
    self.commitAndTic()
    self.failIfDifferentSet(o.getEfgList(base=1),[self.base_cat2+'/new_id/11/111/1111'])

  def test_08_RenameModuleWithObjectsInnerRelated(
                        self, quiet=quiet, run=run_all_test):
    if not run: return
    if not quiet:
      self.logMessage('Rename a Module with Contained Objects Refering to Other Objects inside the Same Module')
    om = self.getOrganisationModule()
    om['1'].setAbcValue(om['2'])
    self.commitAndTic()
    self.assertEqual(len(om['2'].getRelatedValueList('abc')), 1)
    self.assertEqual(len(om['2'].Base_zSearchRelatedObjectsByCategory(category_uid = om['2'].getUid())),1)    
    self.assertEqual(om['1'].getAbc(),om['2'].getRelativeUrl())
    original_uid = om['2'].getUid()
    om.edit(id='new_id')
    self.commitAndTic()
    om = self.getPortal()['new_id']
    self.assertEqual(original_uid, om['2'].getUid())
    self.assertEqual(om['1'].getAbc(),om['2'].getRelativeUrl())
    self.assertEqual(len(om['2'].getRelatedValueList('abc')), 1)
    self.assertEqual(len(om['2'].Base_zSearchRelatedObjectsByCategory(category_uid = om['2'].getUid())),1)

  def test_09_Base_viewDictWithCategoryWithSubCategory(
                        self, quiet=quiet, run=run_all_test):
    if not run: return
    if not quiet:
      self.logMessage('Make sure Base_viewDict is working for categories with sub categories')
    portal_categories = self.getCategoryTool()
    base_category = portal_categories.activity
    self.assertTrue(len(base_category.Base_viewDict())>0)
    base_category.newContent(id='toto',title='Toto')
    self.assertTrue(len(base_category.Base_viewDict())>0)


  def test_getAcquiredCategoryList(self):
    # create a base category
    ctool = self.getCategoryTool()
    test_aq_category = ctool.newContent(id='test_aq_category',
        portal_type='Base Category',
        acquisition_base_category_list=['parent'],
        acquisition_portal_type="python:['Organisation', 'Telephone']",)
    test_aq_category.newContent(portal_type='Category', id='1')
    # this category will acquire from parent category
    self.assertEqual(['parent'], test_aq_category.getAcquisitionBaseCategoryList())
    # only if portal type of the current document and his parent are in
    # acquisition portal type
    self.assertEqual(['Organisation', 'Telephone'],
                      test_aq_category.getAcquisitionPortalTypeList())
    
    # associate the base category with our portal types
    ttool = self.getTypesTool()
    ttool['Organisation']._setTypeBaseCategoryList(['test_aq_category'])
    ttool['Telephone']._setTypeBaseCategoryList(['test_aq_category'])
    self.commit()

    doc = self.organisation
    subdoc = doc['1']

    doc.setCategoryList(['test_aq_category/1'])
    self.assertEqual(['test_aq_category/1'], ctool.getAcquiredCategoryList(doc))
    self.assertEqual(['test_aq_category/1'], doc.getAcquiredCategoryList())
    
    # Telephone subdocument acquire categories, because 'test_aq_category' has
    # 'parent' in its acquisition_base_category_list
    self.assertEqual([], subdoc.getCategoryList())
    self.assertEqual(['test_aq_category/1'], subdoc.getAcquiredCategoryList())
    
    doc.setCategoryList([])
    self.assertEqual([], ctool.getAcquiredCategoryList(doc))

    # XXX this test's beforeTearDown commits transaction
    self.abort()


def test_suite():
  suite = unittest.TestSuite()
  suite.addTest(unittest.makeSuite(TestERP5Category))
  return suite