TestERP5BankingMixin.py 58.9 KB
Newer Older
1
#############################################################################
2
#
3
# Copyright (c) 2006-2010 Nexedi SA and Contributors. All Rights Reserved.
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
#                    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
30
from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
31
import transaction
Aurel's avatar
Aurel committed
32 33 34

def isSameSet(a, b):
  for i in a:
Nicolas Dumazet's avatar
Nicolas Dumazet committed
35 36
    if i not in b:
      return False
Aurel's avatar
Aurel committed
37
  for i in b:
Nicolas Dumazet's avatar
Nicolas Dumazet committed
38 39 40
    if i not in a:
      return False
  return len(a) == len(b)
Aurel's avatar
Aurel committed
41

42
class TestERP5BankingMixin(ERP5TypeTestCase):
43 44 45 46
  """
  Mixin class for unit test of banking operations
  """

47 48 49 50 51 52 53
  def getBusinessTemplateList(self):
    """
      Return the list of business templates we need to run the test.
      This method is called during the initialization of the unit test by
      the unit test framework in order to know which business templates
      need to be installed to run the test on.
    """
54 55
    return ('erp5_core_proxy_field_legacy',
            'erp5_base',
56
            'erp5_pdm',
57 58 59 60 61
            'erp5_trade',
            'erp5_accounting',
            'erp5_banking_core',
            'erp5_banking_inventory',
            'erp5_banking_cash',
62 63
            'erp5_banking_check',
    )
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90

  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

91
  def updateRoleMappings(self, portal_type_list=None):
92 93 94 95 96 97 98 99
    """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)
100

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
  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.
126
      main_site = '/'.join(user_data[4].split('/')[0:2])
127
      person = self.person_module.newContent(id=user_login,
128 129
          portal_type='Person', reference=user_login, career_role="internal",
          site=main_site)
130 131 132
      # Create the Assignment.
      assignment = person.newContent( portal_type       = 'Assignment'
                                    , destination_value = user_data[1]
133 134
                                    , function          = "function/%s" %user_data[2]
                                    , group             = "group/%s" %user_data[3]
135
                                    , site              = "%s" %user_data[4]
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
                                    , 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()
154

155 156
    if self.PAS_installed:
      # reindexing is required for the security to work
Aurel's avatar
Aurel committed
157
      transaction.commit()
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
      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)
173

174 175 176 177 178
  def getOrganisationModule(self):
    """
    Return the organisation module
    """
    return getattr(self.getPortal(), 'organisation_module', None)
179

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
  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)
197

198 199 200 201 202
  def getCurrencyModule(self):
    """
    Return the Currency Module
    """
    return getattr(self.getPortal(), 'currency_module', None)
203

204 205 206 207 208
  def getCategoryTool(self):
    """
    Return the Category Tool
    """
    return getattr(self.getPortal(), 'portal_categories', None)
209

210 211 212 213 214
  def getWorkflowTool(self):
    """
    Return the Worklfow Tool
    """
    return getattr(self.getPortal(), 'portal_workflow', None)
215

216 217 218 219 220 221 222 223 224 225 226 227
  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)

228 229 230 231 232 233
  def getStopPaymentModule(self):
    """
    Return the Stop Payment Module
    """
    return getattr(self.getPortal(), 'stop_payment_module', None)

234 235 236 237 238
  def getCheckDepositModule(self):
    """
    Return the Check Deposit Module
    """
    return getattr(self.getPortal(), 'check_deposit_module', None)
239

240 241 242 243 244
  def getCheckbookModule(self):
    """
    Return the Checkbook Module
    """
    return getattr(self.getPortal(), 'checkbook_module', None)
245

246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
  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
264 265
  def getCheckbookUsualCashTransferModule(self):
    """
266
    Return the Checkbook Delivery Module
Sebastien Robin's avatar
Sebastien Robin committed
267 268 269
    """
    return getattr(self.getPortal(), 'checkbook_usual_cash_transfer_module', None)

270 271 272 273 274 275
  def getCheckbookDeliveryModule(self):
    """
    Return the Checkbook Vault Transfer Module
    """
    return getattr(self.getPortal(), 'checkbook_delivery_module', None)

276 277 278 279 280 281
  def getCheckbookMovementModule(self):
    """
    Return the Checkbook Movement Module
    """
    return getattr(self.getPortal(), 'checkbook_movement_module', None)

282 283 284 285 286
  def getCheckModule(self):
    """
    Return the Check Module
    """
    return getattr(self.getPortal(), 'check_module', None)
287

288 289 290 291 292 293
  def getAccountingDateModule(self):
    """
      Return the Accounting Date Module
    """
    return getattr(self.getPortal(), 'accounting_date_module', None)

294 295 296 297 298 299 300 301 302 303 304 305
  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)

306
  def createCurrency(self, currency_list=(('EUR', 'Euro', 1/652., 1/650., 'USD'), ('USD', 'USD', 652, 650., 'EUR')), only_currency=False):
307
    # create the currency document for euro inside the currency module
308 309
    #currency_list = (('EUR', 'Euro', 1/650., 'USD'), ('USD', 'Dollar', 650., 'EUR'))
    # first create currency
310
    for currency_id, title, base_price, cell_price, price_currency in currency_list:
311 312
      currency = self.getCurrencyModule().newContent(id=currency_id, title=title, reference=currency_id)

313 314 315
    if only_currency:
      return
    
316
    # second, create exchange lines
317
    for currency_id, title, base_price, cell_price, price_currency in currency_list:
318 319
      currency = self.getCurrencyModule()[currency_id]
      exchange_line = None
320
      exchange_line = currency.newContent(portal_type='Currency Exchange Line',
Grégory Wisniewski's avatar
Grégory Wisniewski committed
321
                                          start_date='01/01/1900', stop_date='01/01/2900',
322
                                          base_price=base_price,
Aurel's avatar
Aurel committed
323 324 325
                                          currency_exchange_type_list=['currency_exchange_type/sale',
                                                                       'currency_exchange_type/purchase',
                                                                       'currency_exchange_type/transfer'],
326
                                          )
327
      exchange_line.setPriceCurrencyValue(self.getCurrencyModule()[price_currency])
328
      cell_list = exchange_line.objectValues()
Grégory Wisniewski's avatar
Grégory Wisniewski committed
329
      self.assertEquals(len(cell_list), 3)
330
      for cell in cell_list:
331
        cell.setBasePrice(cell_price)
332

333 334 335
      exchange_line.confirm()
      exchange_line.validate()

336
      
337

338
  def _createBanknotesAndCoins(self):
339 340 341 342 343 344
    """
    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')
Grégory Wisniewski's avatar
Grégory Wisniewski committed
345
    self.usd_variation_list = ('variation/not_defined', )
346 347 348 349 350 351 352 353 354 355 356 357 358 359
    # 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
360 361 362 363 364 365 366
    # 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

367 368 369 370 371 372 373
    # 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

374 375 376 377
    # quantity of usd banknote of 200
    self.quantity_usd_200 = {}
    # 2 banknotes of 200
    self.quantity_usd_200['variation/not_defined'] = 2
378 379 380 381
    # quantity of usd banknote of 100
    self.quantity_usd_100 = {}
    # 2 banknotes of 100
    self.quantity_usd_100['variation/not_defined'] = 2
382 383 384 385 386 387 388 389 390
    # 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

391 392 393 394 395
    # 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')
396
    self.cash_status_cancelled = self.cash_status_base_category.newContent(id='cancelled', portal_type='Category')
Aurel's avatar
Aurel committed
397
    self.cash_status_not_defined = self.cash_status_base_category.newContent(id='not_defined', portal_type='Category')
398 399
    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
400
    self.cash_status_new_not_emitted = self.cash_status_base_category.newContent(id='new_not_emitted', portal_type='Category')
Sebastien Robin's avatar
Sebastien Robin committed
401
    self.cash_status_mixed = self.cash_status_base_category.newContent(id='mixed', portal_type='Category')
402

403 404
    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
405 406
    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')
407
    self.emission_letter_b = self.emission_letter_base_category.newContent(id='b', portal_type='Category')
408
    self.emission_letter_k = self.emission_letter_base_category.newContent(id='k', portal_type='Category')
Aurel's avatar
Aurel committed
409
    self.emission_letter_mixed = self.emission_letter_base_category.newContent(id='mixed', portal_type='Category')
410
    self.emission_letter_not_defined = self.emission_letter_base_category.newContent(id='not_defined', portal_type='Category')
411 412 413 414

    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')
415
    # add the category 2003 in variation
416
    self.variation_2003 = self.variation_base_category.newContent(id='2003', portal_type='Category')
417
    # add the category not_defined in variation
Aurel's avatar
Aurel committed
418
    self.variation_not_defined = self.variation_base_category.newContent(id='not_defined',
419
                                      portal_type='Category')
420

Aurel's avatar
Aurel committed
421 422 423 424 425 426
    # Now create required category for region and coin
    self.region_base_category = getattr(self.category_tool, 'region')
    # add the category valid in cash_status which define status of banknotes and coin
    self.region_france = self.region_base_category.newContent(id='france', title="France", portal_type='Category')
    self.region_spain = self.region_base_category.newContent(id='spain', title="Spain", portal_type='Category')

427 428 429 430
    # Create Resources Document (Banknotes & Coins)
    # get the currency cash module
    self.currency_cash_module = self.getCurrencyCashModule()
    # Create Resources Document (Banknotes & Coins)
431 432
    self.createCurrency()
    self.currency_1 = self.currency_module['EUR']
433
    # create document for banknote of 10000 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
434 435 436
    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'),
437
         quantity_unit_value=self.unit)
438
    # create document for banknote of 500 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
439 440 441
    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'),
442
         quantity_unit_value=self.unit)
443
    # create document for coin of 200 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
444 445 446
    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
447 448
         quantity_unit_value=self.unit)
    # create document for coin of 200 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
449 450 451
    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'),
452
         quantity_unit_value=self.unit)
453
    # create document for banknote of 200 euros from years 1992 and 2003
Aurel's avatar
Aurel committed
454 455 456
    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'),
457
         quantity_unit_value=self.unit)
Sebastien Robin's avatar
Sebastien Robin committed
458 459 460 461 462
    # create document for banknote of 200 euros from years 1992 and 2003
    self.billet_100 = self.currency_cash_module.newContent(id='billet_100',
         portal_type='Banknote', base_price=100,
         price_currency_value=self.currency_1, variation_list=('1992', '2003'),
         quantity_unit_value=self.unit)
463
    # Create Resources Document (Banknotes & Coins) in USD
464
    self.currency_2 = self.currency_module['USD']
465
    # create document for banknote of 100 USD
466
    self.usd_billet_100 = self.currency_cash_module.newContent(id='usd_billet_100',
Aurel's avatar
Aurel committed
467
         portal_type='Banknote', base_price=100,
Grégory Wisniewski's avatar
Grégory Wisniewski committed
468
         price_currency_value=self.currency_2, variation_list=('not_defined', ),
469
         quantity_unit_value=self.unit)
470 471 472
    # create document for banknote of 200 USD
    self.usd_billet_200 = self.currency_cash_module.newContent(id='usd_billet_200',
         portal_type='Banknote', base_price=200,
Grégory Wisniewski's avatar
Grégory Wisniewski committed
473
         price_currency_value=self.currency_2, variation_list=('not_defined', ),
474
         quantity_unit_value=self.unit)
475
    # create document for banknote of 50 USD
Aurel's avatar
Aurel committed
476 477
    self.usd_billet_50 = self.currency_cash_module.newContent(id='usd_billet_50',
         portal_type='Banknote', base_price=50,
Grégory Wisniewski's avatar
Grégory Wisniewski committed
478
         price_currency_value=self.currency_2, variation_list=('not_defined', ),
479 480
         quantity_unit_value=self.unit)
    # create document for banknote of 20 USD
Aurel's avatar
Aurel committed
481 482
    self.usd_billet_20 = self.currency_cash_module.newContent(id='usd_billet_20',
         portal_type='Banknote', base_price=20,
Grégory Wisniewski's avatar
Grégory Wisniewski committed
483
         price_currency_value=self.currency_2, variation_list=('not_defined', ),
484
         quantity_unit_value=self.unit)
485

486
  def createFunctionGroupSiteCategory(self, no_site=0, site_list=None):
487 488 489
    """
    Create site group function category that can be used for security
    """
490
    if site_list is None:
491
      site_list = ["paris", 'madrid', 'siege']
492

493 494 495
    # 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')
496

497 498
    self.category_tool.role.newContent(id='internal', portal_type='Category')

499
    # add category for currency_exchange_type
Grégory Wisniewski's avatar
Grégory Wisniewski committed
500
    self.currency_exchange_type = getattr(self.category_tool, 'currency_exchange_type')
501 502
    self.currency_exchange_type.newContent(id='sale')
    self.currency_exchange_type.newContent(id='purchase')
503
    self.currency_exchange_type.newContent(id='transfer')
504

505 506 507 508 509 510 511 512 513 514
    # 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')
515 516
    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')
517
    self.comptable = self.banking.newContent(id='comptable', portal_type='Category', codification='FXF')
518
    self.commis_comptable = self.banking.newContent(id='commis_comptable', portal_type='Category', codification='CBM')
Aurel's avatar
Aurel committed
519
    self.commis_caisse = self.banking.newContent(id='commis_caisse', portal_type='Category', codification='CCM')
520
    self.chef_section_comptable = self.banking.newContent(id='chef_section_comptable', portal_type='Category', codification='CSB')
521
    self.chef_comptable = self.banking.newContent(id='chef_comptable', portal_type='Category', codification='CCB')
522
    self.chef_de_tri = self.banking.newContent(id='chef_de_tri', portal_type='Category', codification='CTR')
Sebastien Robin's avatar
Sebastien Robin committed
523
    self.chef_caisse = self.banking.newContent(id='chef_caisse', portal_type='Category', codification='CCP')
524
    self.chef_section = self.banking.newContent(id='chef_section', portal_type='Category', codification='FXS')
525
    self.chef_section_financier = self.banking.newContent(id='chef_section_financier', portal_type='Category', codification='FXA')
Aurel's avatar
Aurel committed
526 527 528
    self.financier_a = self.banking.newContent(id='financier_a', portal_type='Category', codification='FNA')
    self.financier_b = self.banking.newContent(id='financier_b', portal_type='Category', codification='FNB')
    self.chef_financier = self.banking.newContent(id='chef_financier', portal_type='Category', codification='FCF')
Aurel's avatar
Aurel committed
529
    self.admin_local = self.banking.newContent(id='administrateur_local', portal_type='Category', codification='ADL')
530 531 532
    self.agent_saisie_sref = self.banking.newContent(id='agent_saisie_sref', portal_type='Category', codification='SSREF')
    self.chef_sref = self.banking.newContent(id='chef_sref', portal_type='Category', codification='CSREF')
    self.analyste_sref = self.banking.newContent(id='analyste_sref', portal_type='Category', codification='ASREF')
Aurel's avatar
Aurel committed
533 534
    self.gestionnaire_devise_a = self.banking.newContent(id='gestionnaire_cours_devise_a', portal_type='Category', codification='GCA')
    self.gestionnaire_devise_b = self.banking.newContent(id='gestionnaire_cours_devise_b', portal_type='Category', codification='GCB')
535 536 537

    # get the base category group
    self.group_base_category = getattr(self.category_tool, 'group')
Aurel's avatar
Aurel committed
538
    self.baobab_group = self.group_base_category.newContent(id='baobab', portal_type='Category', codification='BAOBAB')
539 540 541
    # 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
Grégory Wisniewski's avatar
Grégory Wisniewski committed
542
    self.testsite = self.site_base_category.newContent(id='testsite', portal_type='Category', codification='TEST')
543 544 545 546 547
    site_reference_from_codification_dict = {
      'P10': ('FR', '000', '11111', '000000000000', '25'),
      'S10': ('SP', '000', '11111', '000000000000', '08'),
      'HQ1': ('FR', '000', '11112', '000000000000', '69'),
    }
548
    site_region_from_codification_dict = {
549 550 551
      'P10': 'france', # paris
      'S10': 'spain',  # madrid
      'HQ1': 'france', # main
552
    }
553 554 555 556
    self.paris = self.testsite.newContent(id='paris', portal_type='Category', codification='P10',  vault_type='site')
    self.madrid = self.testsite.newContent(id='madrid', portal_type='Category', codification='S10',  vault_type='site')
    self.siege = self.site_base_category.newContent(id='siege', portal_type='Category', codification='HQ1',  vault_type='site')
    created_site_list = [self.paris, self.madrid, self.siege]
557 558 559

    self._createBanknotesAndCoins()

560
    if len(site_list) != 0:
561 562
      for site in site_list:
        if isinstance(site, tuple):
563
          container = self.site_base_category
564
          if len(site) > 2:
565 566 567
            for category_id in site[2].split('/'):
              contained = getattr(container, category_id, None)
              if contained is None:
568
                contained = container.newContent(id=category_id, portal_type='Category')
569
              container = contained
570
            if len(site) > 3:
571
              site_reference_from_codification_dict[site[1]] = site[3]
572 573
              if len(site) > 4:
                site_region_from_codification_dict[site[1]] = site[4]
574 575
          codification = site[1]
          site = site[0]
576
        if site not in ("paris", 'madrid', 'siege'):
577
          site = container.newContent(id=site, portal_type='Category',  codification=codification, vault_type='site')
578
          created_site_list.append(site)
579 580 581 582 583 584 585 586 587

    # Create organisation + bank account for each site category.
    newContent = self.organisation_module.newContent
    for site in created_site_list:
      codification = site.getCodification()
      organisation = newContent(
        portal_type='Organisation',
        id='site_%s' % (codification, ),
        site=site.getRelativeUrl(),
Vincent Pelletier's avatar
Vincent Pelletier committed
588
        region=site_region_from_codification_dict.get(codification),
589
        group='baobab',
590
        role='internal',
591 592 593
        function='banking')
      site_reference = site_reference_from_codification_dict.get(codification)
      if site_reference is not None:
594 595 596 597 598
        self.createBankAccount(
          person=organisation,
          account_id='account_%s' % (codification, ),
          currency=self.currency_1,
          amount=0,
599 600 601 602
          bank_country_code=site_reference[0],
          bank_code=site_reference[1],
          branch=site_reference[2],
          bank_account_number=site_reference[3],
603
          bank_account_key=site_reference[4],
604 605
        )

606 607 608 609
    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')
610 611
    co_vault_type = surface_vault_type.newContent('caisse_courante')
    de_co_vault_type = co_vault_type.newContent('encaisse_des_devises')
612 613 614 615 616 617 618 619
    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')
Sebastien Robin's avatar
Sebastien Robin committed
620 621 622 623 624 625 626 627 628
    auxiliaire_vault_type = caveau_vault_type.newContent('auxiliaire')
    auxiliaire_vault_type.newContent('auxiliaire_vault_type')
    auxiliaire_vault_type.newContent('encaisse_des_devises')
    externe = auxiliaire_vault_type.newContent('encaisse_des_externes')
    externe.newContent('transit')
    caveau_vault_type.newContent('reserve')
    serre = caveau_vault_type.newContent('serre')
    serre.newContent('transit')
    serre.newContent('retire')
629
    salle_tri = surface_vault_type.newContent('salle_tri')
630
      
631
    if not no_site:
632
      destination_site_list = [x.getId() for x in created_site_list]
633
      for c in created_site_list: #self.testsite.getCategoryChildValueList():
634 635 636 637 638 639
        # 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
640
        caisse_courante.newContent(id='billets_mutiles', portal_type='Category', codification='',  vault_type='site/surface/caisse_courante')
641
        caisse_courante.newContent(id='billets_macules', portal_type='Category', codification='',  vault_type='site/surface/caisse_courante')
642
        encaisse_des_devises = caisse_courante.newContent(id='encaisse_des_devises', portal_type='Category', codification='',  vault_type='site/surface/caisse_courante/encaisse_des_devises')
643
        # create counter for surface
Sebastien Robin's avatar
Sebastien Robin committed
644
        for s in ['banque_interne', 'gros_versement', 'gros_paiement']:
645 646 647 648 649 650 651
          vault_codification = c.getCodification()
          if s == 'banque_interne':
            vault_codification += 'BI'
          elif s == 'gros_versement':
            vault_codification += 'GV'
          elif s == 'gros_paiement':
            vault_codification += 'GP'
Grégory Wisniewski's avatar
Grégory Wisniewski committed
652
          s = surface.newContent(id='%s' % (s, ), portal_type='Category', codification=vault_codification,  vault_type='site/surface/%s' % (s, ))
653
          for ss in ['guichet_1', 'guichet_2']:
654
            final_vault_codification = vault_codification + ss[-1]
Grégory Wisniewski's avatar
Grégory Wisniewski committed
655 656 657
            ss =  s.newContent(id='%s' % (ss, ), portal_type='Category', codification=final_vault_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(), ))
658
              for ssss in ['entrante', 'sortante']:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
659 660 661
                sss.newContent(id='%s' % (ssss, ), portal_type='Category', codification='',  vault_type='site/surface/%s/guichet' % (s.getId(), ))
            for sss in ['encaisse_des_devises']:
              sss =  ss.newContent(id='%s' % (sss, ), portal_type='Category', codification='',  vault_type='site/surface/%s/guichet' % (s.getId(), ))
662
              for currency in ['usd']:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
663
                currency_cat = sss.newContent(id='%s' % (currency, ), portal_type='Category', codification='',  vault_type='site/surface/%s' % (ss.getId(), ))
664
                for ssss in ['entrante', 'sortante']:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
665
                  currency_cat.newContent(id='%s' % (ssss, ), portal_type='Category', codification='',  vault_type='site/surface/%s/guichet' % (s.getId(), ))
666 667
        # create sort room
        salle_tri = surface.newContent(id='salle_tri', portal_type='Category', codification='',  vault_type='site/surface/salle_tri')
668
        for ss in ['encaisse_des_billets_et_monnaies', 'encaisse_des_billets_recus_pour_ventilation', 'encaisse_des_differences', 'encaisse_des_externes']:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
669
          ss =  salle_tri.newContent(id='%s' % (ss, ), portal_type='Category', codification='',  vault_type='site/surface/salle_tri')
670
          if 'ventilation' in ss.getId():
671
            for country in destination_site_list:
672
              if country[0] != c.getCodification()[0]:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
673
                ss.newContent(id='%s' % (country, ), portal_type='Category', codification='',  vault_type='site/caveau/%s' % (s.getId(), ))
674 675
        # caveau
        caveau =  c.newContent(id='caveau', portal_type='Category', codification='',  vault_type='site/caveau')
676
        for s in ['auxiliaire', 'reserve', 'serre']:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
677
          s = caveau.newContent(id='%s' % (s, ), portal_type='Category', codification='',  vault_type='site/caveau/%s' % (s, ))
678
          if s.getId() == 'serre':
Grégory Wisniewski's avatar
Grégory Wisniewski committed
679 680
            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(), ))
681
              if 'transit' in ss.getId():
682
                for country in destination_site_list:
683
                  if country[0] != c.getCodification()[0]:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
684
                    ss.newContent(id='%s' % (country, ), portal_type='Category', codification='',  vault_type='site/caveau/%s' % (s.getId(), ))
685 686 687

          else:
            for ss in ['encaisse_des_billets_et_monnaies', 'encaisse_des_externes',
Grégory Wisniewski's avatar
Grégory Wisniewski committed
688 689
                       '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(), ))
690
              if 'ventilation' in ss.getId():
691
                for country in destination_site_list:
692
                  if country[0] != c.getCodification()[0]:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
693
                    ss.newContent(id='%s' % (country, ), portal_type='Category', codification='',  vault_type='site/caveau/%s' % (s.getId(), ))
694
              if 'devises' in ss.getId():
Grégory Wisniewski's avatar
Grégory Wisniewski committed
695 696
                for currency in ['eur', 'usd']:
                  ss.newContent(id='%s' % (currency, ), portal_type='Category', codification='',  vault_type='site/caveau/%s' % (ss.getId(), ))
697
              if 'encaisse_des_externes' in ss.getId():
Grégory Wisniewski's avatar
Grégory Wisniewski committed
698
                ss.newContent(id='transit', portal_type='Category', codification='',  vault_type='site/caveau/%s' % (s.getId(), ))
699 700 701
              #if ss.getId()=='encaisse_des_devises':
              #  for
            if s.getId() == 'auxiliaire':
702
              for ss in ['encaisse_des_billets_a_ventiler_et_a_detruire', 'encaisse_des_billets_ventiles_et_detruits', 'billets_detenus_par_des_tiers', 'encaisse_des_billets_recus_pour_ventilation_venant_de']:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
703
                s.newContent(id='%s' % (ss, ), portal_type='Category', codification='',  vault_type='site/caveau/%s' % (s.getId(), ))
704 705
        # Create forreing currency entries in encaisse_des_devises.
        for currency in ['usd', ]:
706
          caisse_courante.encaisse_des_devises.newContent(id=currency, portal_type='Category', codification='', vault_type='site/surface/caisse_courante/encaisse_des_devises')
707

708 709
    return created_site_list

710 711
  def _openDate(self, date=None, site=None, id=None, open=True, container=None, 
                portal_type=None, force_check=0):
712 713
    if date is None:
      date = DateTime().Date()
714 715
    if not isinstance(date, str):
      date = date.Date()
716 717
    if site is None:
      site = self.testsite
718 719
    date_object = container.newContent(id=id, portal_type=portal_type,
                                       site_value = site, start_date = date)
720
    if open:
721
      if force_check and date_object.getPortalType() == 'Counter Date':
722 723 724 725 726
        self.workflow_tool.doActionFor(date_object, 'open_action', 
                                     wf_id='counter_date_workflow',
                                     your_check_date_is_today=0)
      else:
        date_object.open()
727
    setattr(self, id, date_object)
728
    date_object.assignRoleToSecurityGroup()
729 730 731 732 733 734 735

  def openAccountingDate(self, date=None, site=None, id='accounting_date_1', open=True):
    """
    open an accounting date for the given date
    by default use the current date
    """
    self._openDate(date=date, site=site, id=id, open=open, container=self.getAccountingDateModule(), portal_type='Accounting Date')
736

737
  def openCounterDate(self, date=None, site=None, id='counter_date_1', open=True, force_check=0):
738 739 740 741
    """
    open a couter date for the given date
    by default use the current date
    """
742 743 744 745
    self._openDate(date=date, site=site, id=id, open=open, 
                   container=self.getCounterDateModule(), 
                   portal_type='Counter Date',
                   force_check=force_check)
746

747
  def openCounter(self, site=None, id='counter_1'):
748 749 750 751
    """
    open a counter for the givent site
    """
    # create a counter
752
    counter_module = self.getCounterModule()
753 754
    while "guichet" not in site.getId():
      site = site.getParentValue()
755
    counter = counter_module.newContent(id=id, site_value=site)
756
    # open it
757
    counter.open()
758

Aurel's avatar
Aurel committed
759 760 761 762 763 764 765
  def closeCounterDate(self, id):
    """
    close the counter date
    """
    module = self.getCounterDateModule()
    counter_date = module[id]
    counter_date.close()
766 767 768 769 770 771 772

  def initDefaultVariable(self):
    """
    init some default variable use in all test
    """
    # the erp5 site
    self.portal = self.getPortal()
773

774 775 776 777 778 779 780 781 782 783 784 785 786 787
    # Make sure movement table does not exist
    sql_connection = self.getSQLConnection()
    sql_connection.manage_test("DROP TABLE IF EXISTS movement")
    # Delete also all ZSQL Methods related to movement table
    catalog = self.portal.portal_catalog.getSQLCatalog()
    catalog.manage_delObjects(ids=["z0_drop_movement",
                                   "z0_uncatalog_movement",
                                   "z_catalog_movement_list",
                                   "z_create_movement",
                                   ])
    # Update properties of catalog
    sql_catalog_object_list = list(catalog.sql_catalog_object_list)
    sql_uncatalog_object = list(catalog.sql_uncatalog_object)
    sql_clear_catalog = list(catalog.sql_clear_catalog)
788
    sql_search_tables = list(catalog.sql_search_tables)
789 790 791 792 793

    sql_catalog_object_list.remove("z_catalog_movement_list")
    sql_uncatalog_object.remove("z0_uncatalog_movement")
    sql_clear_catalog.remove("z0_drop_movement")
    sql_clear_catalog.remove("z_create_movement")
794
    sql_search_tables.remove("movement")
795 796 797 798

    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
799
    catalog.sql_search_tables = tuple(sql_search_tables)
800

801
    # the default currency for the site
802
    if not self.portal.hasProperty('reference_currency_id'):
803 804
      self.portal.manage_addProperty('reference_currency_id', 'EUR', type='string')
    else:
Aurel's avatar
Aurel committed
805
      self.portal._updateProperty('reference_currency_id', "EUR")
806 807 808 809 810 811
    # not working days
    if not self.portal.hasProperty('not_working_days'):
      self.portal.manage_addProperty('not_working_days', '', type='string')
    else:
      self.portal._updateProperty('not_working_days', "")
      
Grégory Wisniewski's avatar
Grégory Wisniewski committed
812
    setattr(self.portal, 'functionnal_test_mode', 1)
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
    # 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()
831
    self.checkbook_model_module = self.portal.checkbook_model_module
Sebastien Robin's avatar
Sebastien Robin committed
832 833
    # a default date
    self.date = DateTime()
834

835 836 837 838 839
  def setDocumentSourceReference(self, doc):
    """
    Compute and set the source reference for a document
    """
    # document must have a date defined
840 841
    if doc.getStartDate() is None:
      doc.edit(start_date=DateTime())
842 843
    # call script to set source reference
    doc.Baobab_getUniqueReference()
844 845


Grégory Wisniewski's avatar
Grégory Wisniewski committed
846
  def createPerson(self, id, first_name, last_name, site=None):
847 848 849
    """
    Create a person
    """
850
    if site is None:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
851
      site = "testsite/paris"
852 853 854
    return self.person_module.newContent(id = id,
                                         portal_type = 'Person',
                                         first_name = first_name,
855 856
                                         last_name = last_name,
                                         site=site)
857

858

859
  def createBankAccount(self, person, account_id, currency, amount, inv_date=None, **kw):
860 861 862
    """
    Create and initialize a bank account for a person
    """
863 864 865 866 867 868 869 870 871 872
    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'
873
    if not kw.has_key('internal_bank_account_number'):
Grégory Wisniewski's avatar
Grégory Wisniewski committed
874
      kw['internal_bank_account_number'] = 'k%11s' % (12341234512 + self.account_inventory_number, )
875
      #kw['internal_bank_account_number'] = 'k12341234512'
876
    bank_account = person.newContent(id = account_id,
Aurel's avatar
Aurel committed
877 878 879
                                     portal_type = 'Bank Account',
                                     price_currency_value = currency,
                                     **kw)
880 881 882 883 884 885 886 887 888
    if not kw.has_key('reference') and bank_account.getReference() is None:
      # If there is no automatic getter-time calculation of the reference and
      # no reference has been explicitely set, generate one composed of all
      # bank codes and a static prefix - to avoid collisions as much as
      # possible.
      bank_account.edit(reference='ref_%s%s%s%s%s' % (kw['bank_country_code'],
        kw['bank_code'], kw['branch'], kw['bank_account_number'],
        kw['bank_account_key']))
      
889 890
    # validate this bank account for payment
    bank_account.validate()
891 892 893 894 895 896
    if amount:
      # we need to put some money on this bank account
      self.createBankAccountInventory(bank_account, amount, inv_date=inv_date)
    return bank_account

  def createBankAccountInventory(self, bank_account, amount, inv_date=None):
897
    if not hasattr(self, 'bank_account_inventory'):
898 899
      self.bank_account_inventory = self.bank_account_inventory_module.newContent(id='account_inventory_group',
                                                                                portal_type='Bank Account Inventory Group',
900
                                                                                site_value=self.testsite,
901 902
                                                                                stop_date=DateTime().Date())

903 904
    if inv_date is None:
      inv_date = DateTime()
905
    inventory = self.bank_account_inventory.newContent(id=bank_account.getInternalBankAccountNumber(),
906 907 908
                                                       portal_type='Bank Account Inventory',
                                                       destination_payment_value=bank_account,
                                                       stop_date=inv_date)
Grégory Wisniewski's avatar
Grégory Wisniewski committed
909
    account_inventory_line_id = 'account_inventory_line_%s' % (self.account_inventory_number, )
910
    inventory_line = inventory.newContent(id=account_inventory_line_id,
911
                                          portal_type='Bank Account Inventory Line',
912
                                          resource_value=bank_account.getPriceCurrencyValue(),
913 914
                                          quantity=amount)

915

916 917 918 919
    # deliver the inventory
    if inventory.getSimulationState()!='delivered':
      inventory.deliver()

920 921
    self.account_inventory_number += 1

922
  def createCheckbook(self, id, vault, bank_account, min, max, date=None):
923 924 925 926 927
    """
    Create a checkbook for the given bank account
    """
    if date is None:
      date = DateTime().Date()
928 929 930 931 932 933 934 935 936
    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,
    )
937

938
  def createCheckbookModel(self, id, check_model, reference=None,
939
          unique_per_account=True):
940 941 942 943
    """
    Create a checkbook for the given bank account
    with 3 variations
    """
944 945 946 947 948 949 950
    model =  self.checkbook_model_module.newContent(
        id=id,
        portal_type='Checkbook Model',
        title='Generic',
        account_number_enabled=True,
        reference=reference,
        composition=check_model.getRelativeUrl(),
951
        unique_per_account=unique_per_account,
952
    )
Grégory Wisniewski's avatar
Grégory Wisniewski committed
953 954 955 956 957 958
    model.newContent(id='variant_1', portal_type='Checkbook Model Check Amount Variation',
                     quantity=50, title='50')
    model.newContent(id='variant_2', portal_type='Checkbook Model Check Amount Variation',
                     quantity=100, title='100')
    model.newContent(id='variant_3', portal_type='Checkbook Model Check Amount Variation',
                     quantity=200, title='200')
959 960
    return model

961

962
  def createCheckModel(self, id, reference='CCOP', unique_per_account=True):
963 964 965
    """
    Create a checkbook for the given bank account
    """
966 967 968 969 970 971
    return self.checkbook_model_module.newContent(
        id=id,
        portal_type='Check Model',
        title='Check',
        reference=reference,
        account_number_enabled=True,
972
        unique_per_account=unique_per_account,
973
    )
974

975 976 977 978 979 980
  def createCheckAndCheckbookModel(self):
    """
    create default checkbook and check models
    """
    self.check_model = self.createCheckModel(id='check_model')
    self.check_model_1 = self.check_model
981
    self.check_model_2 = self.createCheckModel(id='check_model_2', reference='CCCO')
982 983
    self.check_model_1_2 = self.createCheckModel(
        id='check_model_1_2',
984
        reference='CCOP',
985
        unique_per_account=False,
986 987 988
    )
    self.check_model_2_2 = self.createCheckModel(
        id='check_model_2_2',
989
        reference='CCCO',
990
        unique_per_account=False,
991
    )
992 993 994
    self.checkbook_model = self.createCheckbookModel(
           id='checkbook_model', check_model=self.check_model)
    self.checkbook_model_1 = self.checkbook_model
995
    self.checkbook_model_2 = self.createCheckbookModel(
996
           id='checkbook_model_2', check_model=self.check_model_2)
997 998 999
    self.checkbook_model_1_2 = self.createCheckbookModel(
           id='checkbook_model_1_2',
           check_model=self.check_model_1_2,
1000
           unique_per_account=False,
1001 1002 1003 1004
    )
    self.checkbook_model_2_2 = self.createCheckbookModel(
           id='checkbook_model_2_2',
           check_model=self.check_model_2_2,
1005
           unique_per_account=False,
1006
    )
1007

1008
  def createCheck(self, id, reference, checkbook, bank_account=None,
1009
                        resource_value=None, destination_value=None):
1010 1011 1012 1013 1014
    """
    Create Check in a checkbook
    """
    check = checkbook.newContent(id=id,
                                 portal_type = 'Check',
1015
                                 reference=reference,
1016
                                 destination_payment_value=bank_account,
1017 1018
                                 resource_value=resource_value,
                                 destination_value=destination_value
1019
                                )
1020

1021 1022 1023 1024
    # mark the check as issued
    check.confirm()
    return check

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
  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)
1037
    model.setPriceCurrency(self.currency_2.getRelativeUrl())
1038 1039
    return model

Aurel's avatar
Aurel committed
1040
  def createCashContainer(self, document, container_portal_type, global_dict, line_list, delivery_line_type='Cash Delivery Line'):
Aurel's avatar
Aurel committed
1041 1042 1043 1044 1045
    """
    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
1046
      reference, range_start, range_stop, quantity, aggregate
Aurel's avatar
Aurel committed
1047 1048
    """
    # Container Creation
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1049
    base_list = ('emission_letter', 'variation', 'cash_status')
Aurel's avatar
Aurel committed
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
    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
1060
      if line_dict.has_key('aggregate'):
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1061
        movement_container.setAggregateValueList([line_dict['aggregate'], ])
Aurel's avatar
Aurel committed
1062 1063 1064 1065 1066 1067 1068 1069
      # 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)
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1070
      container_line.updateCellRange(script_id='CashDetail_asCellRange', base_id="movement")
Aurel's avatar
Aurel committed
1071
      for key in container_line.getCellKeyList(base_id='movement'):
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1072
        if isSameSet(key, category_list):
Aurel's avatar
Aurel committed
1073 1074 1075
          cell = container_line.newCell(*key)
          cell.setCategoryList(category_list)
          cell.setQuantity(line_dict['quantity'])
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1076
          cell.setMappedValuePropertyList(['quantity', 'price'])
Aurel's avatar
Aurel committed
1077 1078 1079 1080 1081 1082 1083 1084 1085
          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
1086
                                        , portal_type    = delivery_line_type
Aurel's avatar
Aurel committed
1087 1088 1089 1090 1091 1092 1093
                                        , 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'):
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1094
      if isSameSet(key, category_list):
Aurel's avatar
Aurel committed
1095 1096 1097
        cell = movement_line.newCell(*key)
        cell.setCategoryList(category_list)
        cell.setQuantity(resource_total_quantity)
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1098
        cell.setMappedValuePropertyList(['quantity', 'price'])
Aurel's avatar
Aurel committed
1099 1100 1101 1102 1103 1104
        cell.setMembershipCriterionBaseCategoryList(base_list)
        cell.setMembershipCriterionCategoryList(category_list)
        cell.edit(force_update = 1,
                  price = movement_line.getResourceValue().getBasePrice())


Grégory Wisniewski's avatar
Grégory Wisniewski committed
1105
  def createCashInventory(self, source, destination, currency, line_list=[], extra_id='',
1106
                          reset_quantity=0, start_date=None, quantity_factor=1):
1107 1108 1109 1110
    """
    Create a cash inventory group
    """
    # we need to have a unique inventory group id by destination
1111

1112
    inventory_group_id = 'inventory_group_%s_%s%s' % \
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1113
                         (destination.getParentValue().getUid(), destination.getId(), extra_id)
1114
    if start_date is None:
1115
      start_date = DateTime()-1
1116 1117 1118
    if not hasattr(self, inventory_group_id):
      inventory_group =  self.cash_inventory_module.newContent(id=inventory_group_id,
                                                               portal_type='Cash Inventory Group',
Aurel's avatar
Aurel committed
1119
                                                               destination_value=destination,
1120
                                                               start_date=start_date)
1121 1122 1123 1124 1125
      setattr(self, inventory_group_id, inventory_group)
    else:
      inventory_group = getattr(self, inventory_group_id)

    # get/create the inventory based on currency
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1126
    inventory_id = '%s_inventory_%s' % (inventory_group_id, currency.getId())
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
    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:
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1142
      variation_list = line.get('variation_list', None)
1143 1144 1145 1146 1147 1148
      self.addCashLineToDelivery(inventory,
                                 line['id'],
                                 "Cash Inventory Line",
                                 line['resource'],
                                 line['variation_id'],
                                 line['variation_value'],
1149
                                 line['quantity'],
1150
                                 variation_list=variation_list,
1151 1152
                                 reset_quantity=reset_quantity,
                                 quantity_factor=quantity_factor)
1153 1154 1155
    # deliver the inventory
    if inventory.getSimulationState()!='delivered':
      inventory.deliver()
1156 1157 1158 1159
    return inventory_group


  def addCashLineToDelivery(self, delivery_object, line_id, line_portal_type, resource_object,
1160
          variation_base_category_list, variation_category_list, resource_quantity_dict,
1161
          variation_list=None, reset_quantity=0, quantity_factor=1):
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
    """
    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
1190 1191 1192
    if variation_list is None:
      variation_list = self.variation_list
    for variation in variation_list:
1193 1194 1195
      v1, v2 = variation_category_list[:2]
      cell = line.getCell(v1, variation, v2)
      if cell is not None:
1196 1197 1198
        quantity = resource_quantity_dict[variation]
        if reset_quantity:
          quantity = 0
1199
        cell.setQuantity(quantity*quantity_factor)
1200 1201 1202 1203 1204 1205 1206


  def checkResourceCreated(self):
    """
    Check that all have been create after setup
    """
    # check that Categories were created
1207
    self.assertEqual(self.paris.getPortalType(), 'Category')
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226

    # 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'])
1227

1228 1229 1230 1231 1232 1233 1234 1235
    # 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'])
1236 1237 1238

  def resetInventory(self, 
               sequence=None, line_list=None, sequence_list=None, extra_id=None, 
1239
               destination=None, currency=None, start_date=None, **kwd):
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
    """
    Make sure we can not close the counter date 
    when there is still some operations remaining
    """
    if extra_id is not None:
      extra_id = '_reset_%s' % extra_id
    else:
      extra_id = '_reset'
    # Before the test, we need to input the inventory
    self.createCashInventory(source=None, destination=destination, currency=currency,
Grégory Wisniewski's avatar
Grégory Wisniewski committed
1250
                             line_list=line_list, extra_id=extra_id, reset_quantity=1,
1251
                             start_date=start_date)
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261

  def stepDeleteResetInventory(self, sequence=None, sequence_list=None, **kwd):
    """
    Make sure we can not close the counter date 
    when there is still some operations remaining
    """
    inventory_module = self.getPortal().cash_inventory_module
    to_delete_id_list = [x for x in inventory_module.objectIds() 
                         if x.find('reset')>=0]
    inventory_module.manage_delObjects(ids=to_delete_id_list)
1262