TestERP5BankingMixin.py 43.8 KB
Newer Older
1
#############################################################################
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
#
# Copyright (c) 2006 Nexedi SARL and Contributors. All Rights Reserved.
#                    Aurelien Calonne <aurel@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.
#
##############################################################################

from DateTime import DateTime

Aurel's avatar
Aurel committed
31 32 33 34 35 36 37 38 39 40

def isSameSet(a, b):
  for i in a:
    if not(i in b) : return 0
  for i in b:
    if not(i in a): return 0
  if len(a) != len(b) : return 0
  return 1


41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
class TestERP5BankingMixin:
  """
  Mixin class for unit test of banking operations
  """


  def enableLightInstall(self):
    """
      Return if we should do a light install (1) or not (0)
      Light install variable is used at installation of categories in business template
      to know if we wrap the category or not, if 1 we don't use and installation is faster
    """
    return 1 # here we want a light install for a faster installation

  def enableActivityTool(self):
    """
      Return if we should create (1) or not (0) an activity tool
      This variable is used at the creation of the site to know if we use
      the activity tool or not
    """
    return 1 # here we want to use the activity tool

  def checkUserFolderType(self):
    """
      Check the type of user folder to let the test working with both NuxUserGroup and PAS.
    """
    self.user_folder = self.getUserFolder()
    self.PAS_installed = 0
    if self.user_folder.meta_type == 'Pluggable Auth Service':
      # we use PAS
      self.PAS_installed = 1

  def updateRoleMappings(self, portal_type_list=''):
    """Update the local roles in existing objects.
    """
    portal_catalog = self.portal.portal_catalog
    for portal_type in portal_type_list:
      for brain in portal_catalog(portal_type = portal_type):
        obj = brain.getObject()
        userdb_path, user_id = obj.getOwnerTuple()
        obj.assignRoleToSecurityGroup(user_name = user_id)
82

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
  def assignPASRolesToUser(self, user_name, role_list):
    """
      Assign a list of roles to one user with PAS.
    """
    for role in role_list:
      if role not in self.user_folder.zodb_roles.listRoleIds():
        self.user_folder.zodb_roles.addRole(role)
      self.user_folder.zodb_roles.assignRoleToPrincipal(role, user_name)

  def createManagerAndLogin(self):
    """
      Create a simple user in user_folder with manager rights.
      This user will be used to initialize data in the method afterSetup
    """
    self.getUserFolder()._doAddUser('manager', '', ['Manager'], [])
    self.login('manager')

  def createERP5Users(self, user_dict):
    """
      Create all ERP5 users needed for the test.
      ERP5 user = Person object + Assignment object in erp5 person_module.
    """
    for user_login, user_data in user_dict.items():
      user_roles = user_data[0]
      # Create the Person.
      person = self.person_module.newContent(id=user_login,
          portal_type='Person', reference=user_login, career_role="internal")
      # Create the Assignment.
      assignment = person.newContent( portal_type       = 'Assignment'
                                    , destination_value = user_data[1]
113 114 115
                                    , function          = "function/%s" %user_data[2]
                                    , group             = "group/%s" %user_data[3]
                                    , site              = "site/%s" %user_data[4]
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
                                    , start_date        = '01/01/1900'
                                    , stop_date         = '01/01/2900'
                                    )
      if self.PAS_installed and len(user_roles) > 0:
        # In the case of PAS, if we want global roles on user, we have to do it manually.
        self.assignPASRolesToUser(user_login, user_roles)
      elif not self.PAS_installed:
        # The user_folder counterpart of the erp5 user must be
        #   created manually in the case of NuxUserGroup.
        self.user_folder.userFolderAddUser( name     = user_login
                                          , password = ''
                                          , roles    = user_roles
                                          , domains  = []
                                          )
      # User assignment to security groups is also required, but is taken care of
      #   by the assignment workflow when NuxUserGroup is used and
      #   by ERP5Security PAS plugins in the context of PAS use.
      assignment.open()
134

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
    if self.PAS_installed:
      # reindexing is required for the security to work
      get_transaction().commit()
      self.tic()



  def getUserFolder(self):
    """
    Return the user folder
    """
    return getattr(self.getPortal(), 'acl_users', None)

  def getPersonModule(self):
    """
    Return the person module
    """
    return getattr(self.getPortal(), 'person_module', None)
153

154 155 156 157 158
  def getOrganisationModule(self):
    """
    Return the organisation module
    """
    return getattr(self.getPortal(), 'organisation_module', None)
159

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
  def getCurrencyCashModule(self):
    """
    Return the Currency Cash Module
    """
    return getattr(self.getPortal(), 'currency_cash_module', None)

  def getCashInventoryModule(self):
    """
    Return the Cash Inventory Module
    """
    return getattr(self.getPortal(), 'cash_inventory_module', None)

  def getBankAccountInventoryModule(self):
    """
    Return the Bank Account Inventory Module
    """
    return getattr(self.getPortal(), 'bank_account_inventory_module', None)
177

178 179 180 181 182
  def getCurrencyModule(self):
    """
    Return the Currency Module
    """
    return getattr(self.getPortal(), 'currency_module', None)
183

184 185 186 187 188
  def getCategoryTool(self):
    """
    Return the Category Tool
    """
    return getattr(self.getPortal(), 'portal_categories', None)
189

190 191 192 193 194
  def getWorkflowTool(self):
    """
    Return the Worklfow Tool
    """
    return getattr(self.getPortal(), 'portal_workflow', None)
195

196 197 198 199 200 201 202 203 204 205 206 207
  def getSimulationTool(self):
    """
    Return the Simulation Tool
    """
    return getattr(self.getPortal(), 'portal_simulation', None)

  def getCheckPaymentModule(self):
    """
    Return the Check Payment Module
    """
    return getattr(self.getPortal(), 'check_payment_module', None)

208 209 210 211 212 213
  def getStopPaymentModule(self):
    """
    Return the Stop Payment Module
    """
    return getattr(self.getPortal(), 'stop_payment_module', None)

214 215 216 217 218
  def getCheckDepositModule(self):
    """
    Return the Check Deposit Module
    """
    return getattr(self.getPortal(), 'check_deposit_module', None)
219

220 221 222 223 224
  def getCheckbookModule(self):
    """
    Return the Checkbook Module
    """
    return getattr(self.getPortal(), 'checkbook_module', None)
225

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
  def getCheckbookModelModule(self):
    """
    Return the Checkbook Module
    """
    return getattr(self.getPortal(), 'checkbook_model_module', None)

  def getCheckbookReceptionModule(self):
    """
    Return the Checkbook Reception Module
    """
    return getattr(self.getPortal(), 'checkbook_reception_module', None)

  def getCheckbookVaultTransferModule(self):
    """
    Return the Checkbook Vault Transfer Module
    """
    return getattr(self.getPortal(), 'checkbook_vault_transfer_module', None)

Sebastien Robin's avatar
Sebastien Robin committed
244 245
  def getCheckbookUsualCashTransferModule(self):
    """
246
    Return the Checkbook Delivery Module
Sebastien Robin's avatar
Sebastien Robin committed
247 248 249
    """
    return getattr(self.getPortal(), 'checkbook_usual_cash_transfer_module', None)

250 251 252 253 254 255
  def getCheckbookDeliveryModule(self):
    """
    Return the Checkbook Vault Transfer Module
    """
    return getattr(self.getPortal(), 'checkbook_delivery_module', None)

256 257 258 259 260 261
  def getCheckbookMovementModule(self):
    """
    Return the Checkbook Movement Module
    """
    return getattr(self.getPortal(), 'checkbook_movement_module', None)

262 263 264 265 266
  def getCheckModule(self):
    """
    Return the Check Module
    """
    return getattr(self.getPortal(), 'check_module', None)
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293

  def getCounterDateModule(self):
    """
    Return the Counter Date Module
    """
    return getattr(self.getPortal(), 'counter_date_module', None)

  def getCounterModule(self):
    """
    Return the Counter Date Module
    """
    return getattr(self.getPortal(), 'counter_module', None)


  def stepTic(self, **kwd):
    """
    The is used to simulate the zope_tic_loop script
    Each time this method is called, it simulates a call to tic
    which invoke activities in the Activity Tool
    """
    # execute transaction
    get_transaction().commit()
    self.tic()


  def createCurrency(self, id='EUR', title='Euro'):
    # create the currency document for euro inside the currency module
294 295
    currency = self.getCurrencyModule().newContent(id=id, title=title)
    if id=='USD':
296 297 298 299 300
      # Create an exchange line
      exchange_line = currency.newContent(portal_type='Currency Exchange Line',
          start_date='01/01/1900',stop_date='01/01/2900',
          price_currency='currency_module/EUR',
          currency_exchange_type_list=['currency_exchange_type/sale',
301 302
                                       'currency_exchange_type/purchase',
                                       'currency_exchange_type/transfer'],
303 304
          base_price=2)
      cell_list = exchange_line.objectValues()
305
      self.assertEquals(len(cell_list),3)
306
      for cell in cell_list:
Sebastien Robin's avatar
Sebastien Robin committed
307 308
        cell.setBasePrice(650.0)
        cell.setDiscount(650.0)
309
    return currency
310 311 312 313 314 315 316 317 318


  def createBanknotesAndCoins(self):
    """
    Create some banknotes and coins
    """
    # Define static values (only use prime numbers to prevent confusions like 2 * 6 == 3 * 4)
    # variation list is the list of years for banknotes and coins
    self.variation_list = ('variation/1992', 'variation/2003')
Sebastien Robin's avatar
Sebastien Robin committed
319
    self.usd_variation_list = ('variation/not_defined',)
320 321 322 323 324 325 326 327 328 329 330 331 332 333
    # quantity of banknotes of 10000 :
    self.quantity_10000 = {}
    # 2 banknotes of 10000 for the year 1992
    self.quantity_10000[self.variation_list[0]] = 2
    # 3 banknotes of 10000 for the year of 2003
    self.quantity_10000[self.variation_list[1]] = 3

    # quantity of coin of 200
    self.quantity_200 = {}
    # 5 coins of 200 for the year 1992
    self.quantity_200[self.variation_list[0]] = 5
    # 7 coins of 200 for the year 2003
    self.quantity_200[self.variation_list[1]] = 7

Sebastien Robin's avatar
Sebastien Robin committed
334 335 336 337 338 339 340
    # quantity of coin of 100
    self.quantity_100 = {}
    # 5 coins of 100 for the year 1992
    self.quantity_100[self.variation_list[0]] = 4
    # 7 coins of 100 for the year 2003
    self.quantity_100[self.variation_list[1]] = 6

341 342 343 344 345 346 347
    # quantity of banknotes of 5000
    self.quantity_5000 = {}
    # 11 banknotes of 5000 for hte year 1992
    self.quantity_5000[self.variation_list[0]] = 11
    # 13 banknotes of 5000 for the year 2003
    self.quantity_5000[self.variation_list[1]] = 13

348 349 350 351 352 353 354 355 356 357 358 359 360
    # quantity of usd banknote of 200
    self.quantity_usd_200 = {}
    # 2 banknotes of 200
    self.quantity_usd_200['variation/not_defined'] = 2
    # quantity of usd banknote of 50
    self.quantity_usd_50 = {}
    # 3 banknotes of 50
    self.quantity_usd_50['variation/not_defined'] = 3
    # quantity of usd banknote of 20
    self.quantity_usd_20 = {}
    # 5 banknotes of 20
    self.quantity_usd_20['variation/not_defined'] = 5

361 362 363 364 365
    # Now create required category for banknotes and coin
    self.cash_status_base_category = getattr(self.category_tool, 'cash_status')
    # add the category valid in cash_status which define status of banknotes and coin
    self.cash_status_valid = self.cash_status_base_category.newContent(id='valid', portal_type='Category')
    self.cash_status_to_sort = self.cash_status_base_category.newContent(id='to_sort', portal_type='Category')
366
    self.cash_status_cancelled = self.cash_status_base_category.newContent(id='cancelled', portal_type='Category')
Aurel's avatar
Aurel committed
367
    self.cash_status_not_defined = self.cash_status_base_category.newContent(id='not_defined', portal_type='Category')
368 369
    self.cash_status_mutilated = self.cash_status_base_category.newContent(id='mutilated', portal_type='Category')
    self.cash_status_retired = self.cash_status_base_category.newContent(id='retired', portal_type='Category')
Aurel's avatar
Aurel committed
370
    self.cash_status_new_not_emitted = self.cash_status_base_category.newContent(id='new_not_emitted', portal_type='Category')
371

372 373
    self.emission_letter_base_category = getattr(self.category_tool, 'emission_letter')
    # add the category k in emission letter that will be used fo banknotes and coins
374 375
    self.emission_letter_p = self.emission_letter_base_category.newContent(id='p', portal_type='Category')
    self.emission_letter_s = self.emission_letter_base_category.newContent(id='s', portal_type='Category')
376
    self.emission_letter_b = self.emission_letter_base_category.newContent(id='b', portal_type='Category')
377
    self.emission_letter_not_defined = self.emission_letter_base_category.newContent(id='not_defined', portal_type='Category')
378 379 380 381

    self.variation_base_category = getattr(self.category_tool, 'variation')
    # add the category 1992 in variation
    self.variation_1992 = self.variation_base_category.newContent(id='1992', portal_type='Category')
382
    # add the category 2003 in variation
383
    self.variation_2003 = self.variation_base_category.newContent(id='2003', portal_type='Category')
384
    # add the category not_defined in variation
Aurel's avatar
Aurel committed
385
    self.variation_not_defined = self.variation_base_category.newContent(id='not_defined',
386
                                      portal_type='Category')
387 388 389 390 391 392 393

    # Create Resources Document (Banknotes & Coins)
    # get the currency cash module
    self.currency_cash_module = self.getCurrencyCashModule()
    # Create Resources Document (Banknotes & Coins)
    self.currency_1 = self.createCurrency()
    # create document for banknote of 10000 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
394 395 396
    self.billet_10000 = self.currency_cash_module.newContent(id='billet_10000',
         portal_type='Banknote', base_price=10000,
         price_currency_value=self.currency_1, variation_list=('1992', '2003'),
397
         quantity_unit_value=self.unit)
398
    # create document for banknote of 500 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
399 400 401
    self.billet_5000 = self.currency_cash_module.newContent(id='billet_5000',
         portal_type='Banknote', base_price=5000,
         price_currency_value=self.currency_1, variation_list=('1992', '2003'),
402
         quantity_unit_value=self.unit)
403
    # create document for coin of 200 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
404 405 406
    self.piece_200 = self.currency_cash_module.newContent(id='piece_200',
         portal_type='Coin', base_price=200,
         price_currency_value=self.currency_1, variation_list=('1992', '2003'),
Sebastien Robin's avatar
Sebastien Robin committed
407 408
         quantity_unit_value=self.unit)
    # create document for coin of 200 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
409 410 411
    self.piece_100 = self.currency_cash_module.newContent(id='piece_100',
         portal_type='Coin', base_price=100,
         price_currency_value=self.currency_1, variation_list=('1992', '2003'),
412
         quantity_unit_value=self.unit)
413
    # create document for banknote of 200 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
414 415 416
    self.billet_200 = self.currency_cash_module.newContent(id='billet_200',
         portal_type='Banknote', base_price=200,
         price_currency_value=self.currency_1, variation_list=('1992', '2003'),
417 418
         quantity_unit_value=self.unit)
    # Create Resources Document (Banknotes & Coins) in USD
419
    self.currency_2 = self.createCurrency(id='USD',title='USD')
420
    # create document for banknote of 100 USD
Aurel's avatar
Aurel committed
421 422 423
    self.usd_billet_200 = self.currency_cash_module.newContent(id='usd_billet_100',
         portal_type='Banknote', base_price=100,
         price_currency_value=self.currency_2, variation_list=('not_defined',),
424 425
         quantity_unit_value=self.unit)
    # create document for banknote of 50 USD
Aurel's avatar
Aurel committed
426 427 428
    self.usd_billet_50 = self.currency_cash_module.newContent(id='usd_billet_50',
         portal_type='Banknote', base_price=50,
         price_currency_value=self.currency_2, variation_list=('not_defined',),
429 430
         quantity_unit_value=self.unit)
    # create document for banknote of 20 USD
Aurel's avatar
Aurel committed
431 432 433
    self.usd_billet_20 = self.currency_cash_module.newContent(id='usd_billet_20',
         portal_type='Banknote', base_price=20,
         price_currency_value=self.currency_2, variation_list=('not_defined',),
434
         quantity_unit_value=self.unit)
435

436
  def createFunctionGroupSiteCategory(self, no_site=0, site_list=[]):
437 438 439 440 441 442
    """
    Create site group function category that can be used for security
    """
    # add category unit in quantity_unit which is the unit that will be used for banknotes and coins
    self.variation_base_category = getattr(self.category_tool, 'quantity_unit')
    self.unit = self.variation_base_category.newContent(id='unit', title='Unit')
443

444 445 446 447
    # add category for currency_exchange_type
    self.currency_exchange_type = getattr(self.category_tool,'currency_exchange_type')
    self.currency_exchange_type.newContent(id='sale')
    self.currency_exchange_type.newContent(id='purchase')
448
    self.currency_exchange_type.newContent(id='transfer')
449

450 451 452 453 454 455 456 457 458 459
    # get the base category function
    self.function_base_category = getattr(self.category_tool, 'function')
    # add category banking in function which will hold all functions neccessary in a bank (at least for this unit test)
    self.banking = self.function_base_category.newContent(id='banking', portal_type='Category', codification='BNK')
    self.caissier_principal = self.banking.newContent(id='caissier_principal', portal_type='Category', codification='CCP')
    self.controleur_caisse = self.banking.newContent(id='controleur_caisse', portal_type='Category', codification='CCT')
    self.void_function = self.banking.newContent(id='void_function', portal_type='Category', codification='VOID')
    self.gestionnaire_caisse_courante = self.banking.newContent(id='gestionnaire_caisse_courante', portal_type='Category', codification='CCO')
    self.gestionnaire_caveau = self.banking.newContent(id='gestionnaire_caveau', portal_type='Category', codification='CCV')
    self.caissier_particulier = self.banking.newContent(id='caissier_particulier', portal_type='Category', codification='CGU')
460 461
    self.controleur_caisse_courante = self.banking.newContent(id='controleur_caisse_courante', portal_type='Category', codification='CCC')
    self.controleur_caveau = self.banking.newContent(id='controleur_caveau', portal_type='Category', codification='CCA')
462
    self.comptable = self.banking.newContent(id='comptable', portal_type='Category', codification='FXF')
463
    self.commis_comptable = self.banking.newContent(id='commis_comptable', portal_type='Category', codification='CBM')
464
    self.chef_section_comptable = self.banking.newContent(id='chef_section_comptable', portal_type='Category', codification='CSB')
465
    self.chef_comptable = self.banking.newContent(id='chef_comptable', portal_type='Category', codification='CCB')
466
    self.chef_de_tri = self.banking.newContent(id='chef_de_tri', portal_type='Category', codification='CTR')
Sebastien Robin's avatar
Sebastien Robin committed
467
    self.chef_caisse = self.banking.newContent(id='chef_caisse', portal_type='Category', codification='CCP')
468
    self.chef_section = self.banking.newContent(id='chef_section', portal_type='Category', codification='FXS')
469 470 471 472 473 474 475 476 477

    # get the base category group
    self.group_base_category = getattr(self.category_tool, 'group')
    # add the group baobab in the group category
    self.baobab = self.group_base_category.newContent(id='baobab', portal_type='Category', codification='BAOBAB')

    # get the base category site
    self.site_base_category = getattr(self.category_tool, 'site')
    # add the category testsite in the category site which hold vaults situated in the bank
478
    self.testsite = self.site_base_category.newContent(id='testsite', portal_type='Category',codification='TEST',vault_type='site')
479 480 481 482 483 484 485 486 487 488 489
    if len(site_list) != 0:
      if 'paris' in site_list:
        self.paris = self.testsite.newContent(id='paris', portal_type='Category', codification='P1',  vault_type='site')
      if 'madrid' in site_list:
        self.madrid = self.testsite.newContent(id='madrid', portal_type='Category', codification='S1',  vault_type='site')
      if 'siege' in site_list:
        self.siege = self.testsite.newContent(id='siege', portal_type='Category', codification='HQ1',  vault_type='site')
    else:
      self.paris = self.testsite.newContent(id='paris', portal_type='Category', codification='P1',  vault_type='site')
      self.madrid = self.testsite.newContent(id='madrid', portal_type='Category', codification='S1',  vault_type='site')
      self.siege = self.testsite.newContent(id='siege', portal_type='Category', codification='HQ1',  vault_type='site')
490 491 492 493 494 495 496 497 498 499 500 501 502

    self.vault_type_base_category = getattr(self.category_tool, 'vault_type')
    site_vault_type = self.vault_type_base_category.newContent(id='site')
    surface_vault_type = site_vault_type.newContent('surface')
    bi_vault_type = surface_vault_type.newContent('banque_interne')
    guichet_bi_vault_type = bi_vault_type.newContent('guichet')
    gp_vault_type = surface_vault_type.newContent('gros_paiement')
    guichet_gp_vault_type = gp_vault_type.newContent('guichet')
    gv_vault_type = surface_vault_type.newContent('gros_versement')
    guichet_gv_vault_type = gv_vault_type.newContent('guichet')
    op_vault_type = surface_vault_type.newContent('operations_diverses')
    guichet_op_vault_type = op_vault_type.newContent('guichet')
    caveau_vault_type = site_vault_type.newContent('caveau')
503
      
504 505 506 507 508 509 510 511
    if not no_site:
      for c in self.testsite.getCategoryChildValueList():
        # create bank structure for each agency
        site = c.getId()
        # surface
        surface = c.newContent(id='surface', portal_type='Category', codification='',  vault_type='site/surface')
        caisse_courante = surface.newContent(id='caisse_courante', portal_type='Category', codification='',  vault_type='site/surface/caisse_courante')
        caisse_courante.newContent(id='encaisse_des_billets_et_monnaies', portal_type='Category', codification='',  vault_type='site/surface/caisse_courante')
Aurel's avatar
Aurel committed
512
        caisse_courante.newContent(id='billets_mutiles', portal_type='Category', codification='',  vault_type='site/surface/caisse_courante')
513 514 515 516 517 518 519
        # create counter for surface
        for s in ['banque_interne', 'gros_versement', 'gros_payement']:
          s = surface.newContent(id='%s' %(s,), portal_type='Category', codification='',  vault_type='site/surface/%s' %(s,))
          for ss in ['guichet_1', 'guichet_2', 'guichet_3']:
            ss =  s.newContent(id='%s' %(ss,), portal_type='Category', codification='',  vault_type='site/surface/%s/guichet' %(s.getId(),))
            for sss in ['encaisse_des_billets_et_monnaies',]:
              sss =  ss.newContent(id='%s' %(sss,), portal_type='Category', codification='',  vault_type='site/surface/%s/guichet' %(s.getId(),))
520 521
              for ssss in ['entrante', 'sortante']:
                sss.newContent(id='%s' %(ssss,), portal_type='Category', codification='',  vault_type='site/surface/%s/guichet' %(s.getId(),))
522 523 524 525 526 527 528 529 530 531 532
            for sss in ['encaisse_des_devises',]:
              sss =  ss.newContent(id='%s' %(sss,), portal_type='Category', codification='',  vault_type='site/surface/%s/guichet' %(s.getId(),))
              for currency in ['usd']:
                sss.newContent(id='%s' %(currency,), portal_type='Category', codification='',  vault_type='site/surface/%s' %(ss.getId(),))
                for ssss in ['entrante', 'sortante']:
                  sss.newContent(id='%s' %(ssss,), portal_type='Category', codification='',  vault_type='site/surface/%s/guichet' %(s.getId(),))
        # create sort room
        salle_tri = surface.newContent(id='salle_tri', portal_type='Category', codification='',  vault_type='site/surface/salle_tri')
        for ss in ['encaisse_des_billets_et_monnaies', 'encaisse_des_billets_recus_pour_ventilation', 'encaisse_des_differences']:
          ss =  salle_tri.newContent(id='%s' %(ss,), portal_type='Category', codification='',  vault_type='site/surface/salle_tri')
          if 'ventilation' in ss.getId():
533
            for country in ['madrid', 'paris']:
534 535 536 537
              if country[0] != c.getCodification()[0]:
                ss.newContent(id='%s' %(country,), portal_type='Category', codification='',  vault_type='site/caveau/%s' %(s.getId(),))
        # caveau
        caveau =  c.newContent(id='caveau', portal_type='Category', codification='',  vault_type='site/caveau')
538
        for s in ['auxiliaire', 'reserve', 'serre']:
539 540 541 542 543
          s = caveau.newContent(id='%s' %(s,), portal_type='Category', codification='',  vault_type='site/caveau/%s' %(s,))
          if s.getId() == 'serre':
            for ss in ['encaisse_des_billets_neufs_non_emis', 'encaisse_des_billets_retires_de_la_circulation','encaisse_des_billets_detruits','encaisse_des_billets_neufs_non_emis_en_transit_allant_a']:
              ss =  s.newContent(id='%s' %(ss,), portal_type='Category', codification='',  vault_type='site/caveau/%s' %(s.getId(),))
              if 'transit' in ss.getId():
544
                for country in ['madrid', 'paris']:
545 546 547 548 549 550 551 552
                  if country[0] != c.getCodification()[0]:
                    ss.newContent(id='%s' %(country,), portal_type='Category', codification='',  vault_type='site/caveau/%s' %(s.getId(),))

          else:
            for ss in ['encaisse_des_billets_et_monnaies', 'encaisse_des_externes',
                       'encaisse_des_billets_recus_pour_ventilation','encaisse_des_devises']:
              ss =  s.newContent(id='%s' %(ss,), portal_type='Category', codification='',  vault_type='site/caveau/%s' %(s.getId(),))
              if 'ventilation' in ss.getId():
553
                for country in ['madrid', 'paris']:
554 555 556 557 558 559 560 561 562 563
                  if country[0] != c.getCodification()[0]:
                    ss.newContent(id='%s' %(country,), portal_type='Category', codification='',  vault_type='site/caveau/%s' %(s.getId(),))
              if 'devises' in ss.getId():
                for currency in ['eur','usd']:
                    ss.newContent(id='%s' %(currency,), portal_type='Category', codification='',  vault_type='site/caveau/%s' %(ss.getId(),))
              #if ss.getId()=='encaisse_des_devises':
              #  for
            if s.getId() == 'auxiliaire':
              for ss in ['encaisse_des_billets_a_ventiler_et_a_detruire', 'encaisse_des_billets_ventiles_et_detruits']:
                s.newContent(id='%s' %(ss,), portal_type='Category', codification='',  vault_type='site/caveau/%s' %(s.getId(),))
564 565


566
  def openCounterDate(self, date=None, site=None,id='counter_date_1',open=1):
567 568 569 570 571 572
    """
    open a couter date fort the given date
    by default use the current date
    """
    if date is None:
      date = DateTime().Date()
573 574
    if site is None:
      site = self.testsite
575
    # create a counter date
576
    counter_date_module = self.getCounterDateModule()
577

578
    counter_date = counter_date_module.newContent(id=id, portal_type="Counter Date",
579 580
                                                            site_value = site,
                                                            start_date = date)
581
    # open the counter date
582 583 584
    if open:
      counter_date.open()
    setattr(self,id,counter_date)
585 586


587
  def openCounter(self, site=None, id='counter_1'):
588 589 590 591
    """
    open a counter for the givent site
    """
    # create a counter
592
    counter_module = self.getCounterModule()
593
    counter = counter_module.newContent(id=id, site_value=site)
594
    # open it
595
    counter.open()
596 597 598 599 600 601 602 603


  def initDefaultVariable(self):
    """
    init some default variable use in all test
    """
    # the erp5 site
    self.portal = self.getPortal()
604
    # the default currency for the site
605
    if not self.portal.hasProperty('reference_currency_id'):
606 607
      self.portal.manage_addProperty('reference_currency_id', 'EUR', type='string')
    else:
Aurel's avatar
Aurel committed
608
      self.portal._updateProperty('reference_currency_id', "EUR")
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
    # the person module
    self.person_module = self.getPersonModule()
    # the organisation module
    self.organisation_module = self.getOrganisationModule()
    # the category tool
    self.category_tool = self.getCategoryTool()
    # the workflow tool
    self.workflow_tool = self.getWorkflowTool()
    # nb use for bank account inventory
    self.account_inventory_number = 0
    # the cash inventory module
    self.cash_inventory_module = self.getCashInventoryModule()
    # the bank inventory module
    self.bank_account_inventory_module = self.getBankAccountInventoryModule()
    # simulation tool
    self.simulation_tool = self.getSimulationTool()
    # get the currency module
    self.currency_module = self.getCurrencyModule()
Sebastien Robin's avatar
Sebastien Robin committed
627 628
    # a default date
    self.date = DateTime()
629

630 631 632 633 634 635 636 637
  def setDocumentSourceReference(self, doc):
    """
    Compute and set the source reference for a document
    """
    # document must have a date defined
    doc.edit(start_date=DateTime())
    # call script to set source reference
    doc.Baobab_getUniqueReference()
638 639 640 641 642 643 644 645 646 647


  def createPerson(self, id, first_name, last_name):
    """
    Create a person
    """
    return self.person_module.newContent(id = id,
                                         portal_type = 'Person',
                                         first_name = first_name,
                                         last_name = last_name)
648

649

Aurel's avatar
Aurel committed
650
  def createBankAccount(self, person, account_id, currency, amount, **kw):
651 652 653
    """
    Create and initialize a bank account for a person
    """
654 655 656 657 658 659 660 661 662 663
    if not kw.has_key('bank_country_code'):
      kw['bank_country_code'] = 'k'
    if not kw.has_key('bank_code'):
      kw['bank_code'] = '1234'
    if not kw.has_key('branch'):
      kw['branch'] = '12345'
    if not kw.has_key('bank_account_number'):
      kw['bank_account_number'] = '123456789012'
    if not kw.has_key('bank_account_key'):
      kw['bank_account_key'] = '12'
664
    bank_account = person.newContent(id = account_id,
Aurel's avatar
Aurel committed
665 666 667
                                     portal_type = 'Bank Account',
                                     price_currency_value = currency,
                                     **kw)
668 669
    # validate this bank account for payment
    bank_account.validate()
670 671
    if amount == 0:
      return bank_account
672 673 674 675 676 677 678 679
    # we need to put some money on this bank account
    if not hasattr(self, 'bank_account_inventory'):
      self.bank_account_inventory = self.bank_account_inventory_module.newContent(id='account_inventory',
                                                                                portal_type='Bank Account Inventory',
                                                                                source=None,
                                                                                destination_value=self.testsite,
                                                                                stop_date=DateTime().Date())

680
    account_inventory_line_id = 'account_inventory_line_%s' %(self.account_inventory_number,)
681
    inventory = self.bank_account_inventory.newContent(id=account_inventory_line_id,
682 683 684 685
                                           portal_type='Bank Account Inventory Line',
                                           resource_value=currency,
                                           destination_payment_value=bank_account,
                                           inventory=amount)
686

687 688 689 690
    # deliver the inventory
    if inventory.getSimulationState()!='delivered':
      inventory.deliver()

691 692
    self.account_inventory_number += 1
    return bank_account
693

694 695 696 697 698 699 700 701 702 703 704 705 706 707 708

  def createCheckbook(self, id, vault, bank_account, min, max, date=None):
    """
    Create a checkbook for the given bank account
    """
    if date is None:
      date = DateTime().Date()
    return self.checkbook_module.newContent(id = id,
                                            portal_type = 'Checkbook',
                                            destination_value = vault,
                                            destination_payment_value = bank_account,
                                            reference_range_min = min,
                                            reference_range_max = max,
                                            start_date = date)

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
  def createCheckbookModel(self, id):
    """
    Create a checkbook for the given bank account
    with 3 variations
    """
    model =  self.checkbook_model_module.newContent(id = id,
                                            portal_type = 'Checkbook Model',
                                            )
    model.newContent(id='variant_1',portal_type='Checkbook Model Check Amount Variation',
                     quantity=25,title='25')
    model.newContent(id='variant_2',portal_type='Checkbook Model Check Amount Variation',
                     quantity=25,title='50')
    model.newContent(id='variant_3',portal_type='Checkbook Model Check Amount Variation',
                     quantity=25,title='100')
    return model

725

726 727 728 729 730 731
  def createCheckModel(self, id):
    """
    Create a checkbook for the given bank account
    """
    return self.checkbook_model_module.newContent(id = id,
                                            portal_type = 'Check Model',
732
                                            title = 'Check',
733
                                            )
734

735
  def createCheck(self, id, reference, checkbook,bank_account=None):
736 737 738 739 740
    """
    Create Check in a checkbook
    """
    check = checkbook.newContent(id=id,
                                 portal_type = 'Check',
741 742
                                 reference=reference,
                                 destination_payment_value=bank_account
743
                                )
744

745 746 747 748
    # mark the check as issued
    check.confirm()
    return check

749 750 751 752 753 754 755 756 757 758 759 760
  def createTravelerCheckModel(self, id):
    """
    Create a checkbook for the given bank account
    """
    model = self.checkbook_model_module.newContent(id = id,
                                            title = 'USD Traveler Check',
                                            portal_type = 'Check Model',
                                            fixed_price = 1
                                            )
    variation = model.newContent(id='variant_1',
                                 portal_type='Check Model Type Variation',
                                 price=50)
761
    model.setPriceCurrency(self.currency_2.getRelativeUrl())
762 763
    return model

Aurel's avatar
Aurel committed
764
  def createCashContainer(self, document, container_portal_type, global_dict, line_list, delivery_line_type='Cash Delivery Line'):
Aurel's avatar
Aurel committed
765 766 767 768 769
    """
    Create a cash container
    global_dict has keys :
      emission_letter, variation, cash_status, resource
    line_list is a list od dict with keys:
Aurel's avatar
Aurel committed
770
      reference, range_start, range_stop, quantity, aggregate
Aurel's avatar
Aurel committed
771 772 773 774 775 776 777 778 779 780 781 782 783
    """
    # Container Creation
    base_list=('emission_letter', 'variation', 'cash_status')
    category_list =  ('emission_letter/'+global_dict['emission_letter'], 'variation/'+global_dict['variation'], 'cash_status/'+global_dict['cash_status'] )
    resource_total_quantity = 0
    # create cash container
    for line_dict in line_list:
      movement_container = document.newContent(portal_type          = container_portal_type
                                               , reindex_object     = 1
                                               , reference                 = line_dict['reference']
                                               , cash_number_range_start   = line_dict['range_start']
                                               , cash_number_range_stop    = line_dict['range_stop']
                                               )
Aurel's avatar
Aurel committed
784 785
      if line_dict.has_key('aggregate'):
        movement_container.setAggregateValueList([line_dict['aggregate'],])
Aurel's avatar
Aurel committed
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
      # create a cash container line
      container_line = movement_container.newContent(portal_type      = 'Container Line'
                                                     , reindex_object = 1
                                                     , resource_value = global_dict['resource']
                                                     , quantity       = line_dict['quantity']
                                                     )
      container_line.setResourceValue(global_dict['resource'])
      container_line.setVariationCategoryList(category_list)
      container_line.updateCellRange(script_id='CashDetail_asCellRange',base_id="movement")
      for key in container_line.getCellKeyList(base_id='movement'):
        if isSameSet(key,category_list):
          cell = container_line.newCell(*key)
          cell.setCategoryList(category_list)
          cell.setQuantity(line_dict['quantity'])
          cell.setMappedValuePropertyList(['quantity','price'])
          cell.setMembershipCriterionBaseCategoryList(base_list)
          cell.setMembershipCriterionCategoryList(category_list)
          cell.edit(force_update = 1,
                    price = container_line.getResourceValue().getBasePrice())


      resource_total_quantity += line_dict['quantity']
    # create cash delivery movement
    movement_line = document.newContent(id               = "movement"
Aurel's avatar
Aurel committed
810
                                        , portal_type    = delivery_line_type
Aurel's avatar
Aurel committed
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
                                        , resource_value = global_dict['resource']
                                        , quantity_unit_value = self.getCategoryTool().quantity_unit.unit
                                        )
    movement_line.setVariationBaseCategoryList(base_list)
    movement_line.setVariationCategoryList(category_list)
    movement_line.updateCellRange(script_id="CashDetail_asCellRange", base_id="movement")
    for key in movement_line.getCellKeyList(base_id='movement'):
      if isSameSet(key,category_list):
        cell = movement_line.newCell(*key)
        cell.setCategoryList(category_list)
        cell.setQuantity(resource_total_quantity)
        cell.setMappedValuePropertyList(['quantity','price'])
        cell.setMembershipCriterionBaseCategoryList(base_list)
        cell.setMembershipCriterionCategoryList(category_list)
        cell.edit(force_update = 1,
                  price = movement_line.getResourceValue().getBasePrice())


829
  def createCashInventory(self, source, destination, currency, line_list=[],extra_id=''):
830 831 832 833
    """
    Create a cash inventory group
    """
    # we need to have a unique inventory group id by destination
834 835
    inventory_group_id = 'inventory_group_%s_%s%s' % \
                         (destination.getParentValue().getUid(),destination.getId(),extra_id)
836 837 838 839
    if not hasattr(self, inventory_group_id):
      inventory_group =  self.cash_inventory_module.newContent(id=inventory_group_id,
                                                               portal_type='Cash Inventory Group',
                                                               source=None,
Aurel's avatar
Aurel committed
840 841
                                                               destination_value=destination,
                                                               start_date=DateTime())
842 843 844 845 846
      setattr(self, inventory_group_id, inventory_group)
    else:
      inventory_group = getattr(self, inventory_group_id)

    # get/create the inventory based on currency
847
    inventory_id = '%s_inventory_%s' %(inventory_group_id,currency.getId())
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
    if not hasattr(self, inventory_id):
      inventory = inventory_group.newContent(id=inventory_id,
                                             portal_type='Cash Inventory',
                                             price_currency_value=currency)
      setattr(self, inventory_id, inventory)
    else:
      inventory = getattr(self, inventory_id)

    # line data are given by a list of dict, dicts must have this key :
    # id :  line id
    # resource : banknote or coin
    # variation_id : list of variation id
    # variation_value : list of variation value (must be in the same order as variation_id
    # quantity
    for line in line_list:
863
      variation_list = line.get('variation_list',None)
864 865 866 867 868 869
      self.addCashLineToDelivery(inventory,
                                 line['id'],
                                 "Cash Inventory Line",
                                 line['resource'],
                                 line['variation_id'],
                                 line['variation_value'],
870
                                 line['quantity'],
Sebastien Robin's avatar
Sebastien Robin committed
871
                                 variation_list=variation_list)
872 873 874
    # deliver the inventory
    if inventory.getSimulationState()!='delivered':
      inventory.deliver()
875 876 877 878
    return inventory_group


  def addCashLineToDelivery(self, delivery_object, line_id, line_portal_type, resource_object,
879 880
          variation_base_category_list, variation_category_list, resource_quantity_dict,
          variation_list=None):
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
    """
    Add a cash line to a delivery
     """
    base_id = 'movement'
    line_kwd = {'base_id':base_id}
    # create the cash line
    line = delivery_object.newContent( id                  = line_id
                                     , portal_type         = line_portal_type
                                     , resource_value      = resource_object # banknote or coin
                                     , quantity_unit_value = self.unit
                                     )
    # set base category list on line
    line.setVariationBaseCategoryList(variation_base_category_list)
    # set category list line
    line.setVariationCategoryList(variation_category_list)
    line.updateCellRange(script_id='CashDetail_asCellRange', base_id=base_id)
    cell_range_key_list = line.getCellRangeKeyList(base_id=base_id)
    if cell_range_key_list <> [[None, None]] :
      for k in cell_range_key_list:
        category_list = filter(lambda k_item: k_item is not None, k)
        c = line.newCell(*k, **line_kwd)
        mapped_value_list = ['price', 'quantity']
        c.edit( membership_criterion_category_list = category_list
              , mapped_value_property_list         = mapped_value_list
              , category_list                      = category_list
              , force_update                       = 1
              )
    # set quantity on cell to define quantity of bank notes / coins
909 910 911
    if variation_list is None:
      variation_list = self.variation_list
    for variation in variation_list:
912 913 914 915 916 917 918 919 920 921 922
      v1, v2 = variation_category_list[:2]
      cell = line.getCell(v1, variation, v2)
      if cell is not None:
        cell.setQuantity(resource_quantity_dict[variation])


  def checkResourceCreated(self):
    """
    Check that all have been create after setup
    """
    # check that Categories were created
923
    self.assertEqual(self.paris.getPortalType(), 'Category')
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942

    # check that Resources were created
    # check portal type of billet_10000
    self.assertEqual(self.billet_10000.getPortalType(), 'Banknote')
    # check value of billet_10000
    self.assertEqual(self.billet_10000.getBasePrice(), 10000)
    # check currency value  of billet_10000
    self.assertEqual(self.billet_10000.getPriceCurrency(), 'currency_module/EUR')
    # check years  of billet_10000
    self.assertEqual(self.billet_10000.getVariationList(), ['1992', '2003'])

    # check portal type of billet_5000
    self.assertEqual(self.billet_5000.getPortalType(), 'Banknote')
    # check value of billet_5000
    self.assertEqual(self.billet_5000.getBasePrice(), 5000)
    # check currency value  of billet_5000
    self.assertEqual(self.billet_5000.getPriceCurrency(), 'currency_module/EUR')
    # check years  of billet_5000
    self.assertEqual(self.billet_5000.getVariationList(), ['1992', '2003'])
943

944 945 946 947 948 949 950 951
    # check portal type of billet_200
    self.assertEqual(self.billet_200.getPortalType(), 'Banknote')
    # check value of billet_200
    self.assertEqual(self.billet_200.getBasePrice(), 200)
    # check currency value  of billet_200
    self.assertEqual(self.billet_200.getPriceCurrency(), 'currency_module/EUR')
    # check years  of billet_200
    self.assertEqual(self.billet_200.getVariationList(), ['1992', '2003'])