testERP5BankingCheckbookReception.py 22.3 KB
Newer Older
Sebastien Robin's avatar
Sebastien Robin committed
1 2
##############################################################################
#
3
# Copyright (c) 2006-2010 Nexedi SA and Contributors. All Rights Reserved.
Sebastien Robin's avatar
Sebastien Robin committed
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 31 32 33 34 35 36 37 38 39 40 41
#                    Sebastien Robin <seb@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################


# import requested python module
import os
from Products.ERP5Type.tests.Sequence import SequenceList
from Products.DCWorkflow.DCWorkflow import Unauthorized, ValidationFailed
from Products.ERP5Banking.tests.TestERP5BankingMixin import TestERP5BankingMixin

# Needed in order to have a log file inside the current folder
os.environ['EVENT_LOG_FILE']     = os.path.join(os.getcwd(), 'zLOG.log')
# Define the level of log we want, here is all
os.environ['EVENT_LOG_SEVERITY'] = '-300'


42
class TestERP5BankingCheckbookReception(TestERP5BankingMixin):
Sebastien Robin's avatar
Sebastien Robin committed
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
  """
    This class is a unit test to check the module of Cash Transfer

    Here are the following step that will be done in the test :

    XXX to be completed

  """


  # pseudo constants
  RUN_ALL_TEST = 1 # we want to run all test
  QUIET = 0 # we don't want the test to be quiet


  def getTitle(self):
    """
      Return the title of the test
    """
    return "ERP5BankingCheckbookReception"

  def afterSetUp(self):
    """
      Method called before the launch of the test to initialize some data
    """
    # Set some variables :
    self.initDefaultVariable()
    # the cash inventory module
    self.checkbook_reception_module = self.getCheckbookReceptionModule()
    self.check_module = self.getCheckModule()
    self.checkbook_module = self.getCheckbookModule()
    self.checkbook_model_module = self.getCheckbookModelModule()

    self.createManagerAndLogin()
    self.createFunctionGroupSiteCategory()
78
    self.traveler_check_model = self.createTravelerCheckModel('traveler_check_model')
79
    self.createCheckAndCheckbookModel()
Sebastien Robin's avatar
Sebastien Robin committed
80 81 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 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
    self.reception = self.paris.caveau.auxiliaire.encaisse_des_billets_et_monnaies
    self.destination_site = self.paris
    self.checkUserFolderType()
    self.organisation = self.organisation_module.newContent(id='baobab_org', portal_type='Organisation',
                          function='banking', group='baobab',  site='testsite/paris')
    # define the user
    user_dict = {
        'super_user' : [['Manager'], self.organisation, 'banking/comptable', 'baobab', 'testsite/paris']
      }
    # call method to create this user
    self.createERP5Users(user_dict)
    self.logout()
    self.login('super_user')

    # create a person and a bank account
    self.person_1 = self.createPerson(id='person_1',
                                      first_name='Sebastien',
                                      last_name='Robin')
    self.bank_account_1 = self.createBankAccount(person=self.person_1,
                                                 account_id='bank_account_1',
                                                 currency=self.currency_1,
                                                 amount=100000)
    # create a person and a bank account
    self.person_2 = self.createPerson(id='person_2',
                                      first_name='Aurelien',
                                      last_name='Calonne')
    self.bank_account_2 = self.createBankAccount(person=self.person_2,
                                                 account_id='bank_account_1',
                                                 currency=self.currency_1,
                                                 amount=100000)


  def stepCheckObjects(self, sequence=None, sequence_list=None, **kwd):
    """
    Check that all the objects we created in afterSetUp or
    that were added by the business template and that we rely
    on are really here.
    """
    self.checkResourceCreated()
    # check that CheckbookReception Module was created
    self.assertEqual(self.checkbook_reception_module.getPortalType(), 'Checkbook Reception Module')
    # check cash inventory module is empty
    self.assertEqual(len(self.checkbook_reception_module.objectValues()), 0)


  def stepCheckInitialCheckbookInventory(self, sequence=None, sequence_list=None, **kw):
    """
    Check initial cash checkbook on source
    """
    self.assertEqual(len(self.simulation_tool.getCurrentTrackingList(node=self.reception.getRelativeUrl())), 0)
    self.assertEqual(len(self.simulation_tool.getFutureTrackingList(node=self.reception.getRelativeUrl())), 0)


133
  def stepCreateCheckbookReception(self, sequence=None, sequence_list=None, 
134
                                   id='checkbook_reception', imported=0, **kwd):
Sebastien Robin's avatar
Sebastien Robin committed
135 136 137 138
    """
    Create a checkbook reception document and check it
    """
    # Checkbook reception
139 140
    checkbook_reception = self.checkbook_reception_module.newContent(
                     id=id, portal_type='Checkbook Reception',
Sebastien Robin's avatar
Sebastien Robin committed
141
                     source_value=None, destination_value=self.destination_site,
142
                     resource_value=self.currency_1,
143
                     description='test',
144 145
                     start_date=self.date, 
                     imported=imported)
146
    setattr(self, id, checkbook_reception)
Sebastien Robin's avatar
Sebastien Robin committed
147
    # get the checkbook reception document
148
    self.checkbook_reception = getattr(self.checkbook_reception_module, id)
Sebastien Robin's avatar
Sebastien Robin committed
149 150 151 152 153
    # check its portal type
    self.assertEqual(self.checkbook_reception.getPortalType(), 'Checkbook Reception')
    # check that its source is caisse_1
    self.assertEqual(self.checkbook_reception.getSource(), None)
    # check that its destination is caisse_2
154 155 156 157
    if imported:
      self.assertEqual(self.checkbook_reception.getBaobabDestination(), None)
    else:
      self.assertEqual(self.checkbook_reception.getBaobabDestination(), 
Sebastien Robin's avatar
Sebastien Robin committed
158
                     'site/testsite/paris/caveau/auxiliaire/encaisse_des_billets_et_monnaies')
159
    return self.checkbook_reception
Sebastien Robin's avatar
Sebastien Robin committed
160

161 162 163 164 165 166 167 168 169
  def stepCreateCheckbookReception2(self, sequence=None, sequence_list=None, **kwd):
    self.stepCreateCheckbookReception(id='checkbook_reception2')

  def stepCreateCheckbookReception3(self, sequence=None, sequence_list=None, **kwd):
    self.stepCreateCheckbookReception(id='checkbook_reception3')

  def stepCreateCheckbookReception4(self, sequence=None, sequence_list=None, **kwd):
    self.stepCreateCheckbookReception(id='checkbook_reception4')

170 171 172 173
  def stepCreateCheckbookReception5(self, sequence=None, sequence_list=None, **kwd):
    self.stepCreateCheckbookReception(id='checkbook_reception5',
                                      imported=1)

174 175 176
  def stepCreateCheckbookReception6(self, sequence=None, sequence_list=None, **kwd):
    self.stepCreateCheckbookReception(id='checkbook_reception6')

177 178 179 180 181 182 183 184 185
  def stepCreateCheckAndCheckbookLineList2(self, sequence=None, sequence_list=None, **kwd):
    """
    Create the checkbook
    """
    # Add a line for check and checkbook
    self.line_1 = self.checkbook_reception2.newContent(quantity=1,
                                 resource_value=self.checkbook_model_1,
                                 check_amount_value=self.checkbook_model_1.variant_1,
                                 destination_payment_value=self.bank_account_1,
186 187
                                 reference_range_min='0000050',
                                 reference_range_max='0000099',
188 189 190 191 192 193 194 195 196 197 198
                                 )

  def stepCreateCheckAndCheckbookLineList3(self, sequence=None, sequence_list=None, **kwd):
    """
    Create the checkbook
    """
    # Add a line for check and checkbook
    self.line_1 = self.checkbook_reception3.newContent(quantity=1,
                                 resource_value=self.checkbook_model_1,
                                 check_amount_value=self.checkbook_model_1.variant_1,
                                 destination_payment_value=self.bank_account_1,
199 200
                                 reference_range_min='0000150',
                                 reference_range_max='0000199',
201 202 203 204 205 206 207 208 209 210 211 212 213 214
                                 )

  def stepCreateCheckAndCheckbookLineList4(self, sequence=None, sequence_list=None, **kwd):
    """
    Create the checkbook
    """
    # This is not required to create checkbook items, they will be
    # automatically created with the confirm action worfklow transition

    # Add a line for check and checkbook
    self.line_1 = self.checkbook_reception4.newContent(quantity=1,
                                 resource_value=self.checkbook_model_1,
                                 check_amount_value=self.checkbook_model_1.variant_1,
                                 destination_payment_value=self.bank_account_1,
215 216
                                 reference_range_min='0000101',
                                 reference_range_max='0000150',
217
                                 )
Sebastien Robin's avatar
Sebastien Robin committed
218

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
  def stepCreateCheckAndCheckbookLineList5(self, sequence=None, sequence_list=None, **kwd):
    """
    Create the checkbook
    """
    # This is not required to create checkbook items, they will be
    # automatically created with the confirm action worfklow transition

    # Add a line for check and checkbook
    self.line_1 = self.checkbook_reception5.newContent(quantity=1,
                                 resource_value=self.checkbook_model_1,
                                 check_amount_value=self.checkbook_model_1.variant_1,
                                 destination_payment_value=self.bank_account_1,
                                 reference_range_min='0000200',
                                 reference_range_max='0000249',
                                 )

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
  def stepCreateCheckAndCheckbookLineList6(self, sequence=None, sequence_list=None, **kwd):
    """
    Create the checkbook
    """
    # This is not required to create checkbook items, they will be
    # automatically created with the confirm action worfklow transition

    # Add a line for check and checkbook
    self.line_1 = self.checkbook_reception6.newContent(quantity=1,
                                 resource_value=self.checkbook_model_2,
                                 check_amount_value=self.checkbook_model_2.variant_1,
                                 destination_payment_value=self.bank_account_1,
                                 reference_range_min='0000200',
                                 reference_range_max='0000249',
                                 )
 

Sebastien Robin's avatar
Sebastien Robin committed
252 253 254 255 256 257 258 259 260 261 262 263
  def stepCreateCheckAndCheckbookLineList(self, sequence=None, sequence_list=None, **kwd):
    """
    Create the checkbook
    """
    # This is not required to create checkbook items, they will be
    # automatically created with the confirm action worfklow transition

    # Add a line for check and checkbook
    self.line_1 = self.checkbook_reception.newContent(quantity=1,
                                 resource_value=self.checkbook_model_1,
                                 check_amount_value=self.checkbook_model_1.variant_1,
                                 destination_payment_value=self.bank_account_1,
264 265
                                 reference_range_min='0000001',
                                 reference_range_max='0000050'
Sebastien Robin's avatar
Sebastien Robin committed
266 267 268 269 270
                                 )
    self.line_2 = self.checkbook_reception.newContent(quantity=1,
                                 resource_value=self.check_model_1,
                                 check_amount_value=None,
                                 destination_payment_value=self.bank_account_2,
271 272
                                 reference_range_min='0000051',
                                 reference_range_max='0000051'
Sebastien Robin's avatar
Sebastien Robin committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
                                 )

  def stepCheckItemsCreated(self, sequence=None, sequence_list=None, **kwd):
    """
    Create the checkbook
    """
    self.checkbook_1 = None
    self.check_1 = None

    for line in self.checkbook_reception.objectValues():
      aggregate_value_list = line.getAggregateValueList()
      self.assertEquals(len(aggregate_value_list),1)
      aggregate_value = aggregate_value_list[0]
      if aggregate_value.getPortalType()=='Checkbook':
        self.checkbook_1 = aggregate_value
      elif aggregate_value.getPortalType()=='Check':
        self.check_1 = aggregate_value
290 291
        # Make sure new check is in draft mode
        self.assertEquals(self.check_1.getSimulationState(),'draft')
Sebastien Robin's avatar
Sebastien Robin committed
292 293
    self.assertNotEquals(None,self.checkbook_1)
    self.assertNotEquals(None,self.check_1)
294 295 296 297 298
    # Make sure that all checks inside checkbook are create
    self.assertEquals(len(self.checkbook_1.objectValues()),50)
    # Make sure that all checks inside checkbook are not issued yet
    self.assertEquals(self.checkbook_1.objectValues()[0].getSimulationState(),
                      'draft')
Sebastien Robin's avatar
Sebastien Robin committed
299 300 301 302 303 304 305

  def stepConfirmCheckbookReception(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    state = self.checkbook_reception.getSimulationState()
    # check that state is draft
306
    self.assertEqual(state, 'empty')
Sebastien Robin's avatar
Sebastien Robin committed
307 308 309 310 311 312
    self.workflow_tool.doActionFor(self.checkbook_reception, 'confirm_action', wf_id='checkbook_reception_workflow')
    self.assertEqual(self.checkbook_reception.getSimulationState(), 'confirmed')
    workflow_history = self.workflow_tool.getInfoFor(ob=self.checkbook_reception, name='history', wf_id='checkbook_reception_workflow')
    # check len of len workflow history is 6
    self.assertEqual(len(workflow_history), 3)

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
  def stepConfirmCheckbookReception2(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    self.workflow_tool.doActionFor(self.checkbook_reception2, 'confirm_action', 
                                   wf_id='checkbook_reception_workflow')
    self.assertEqual(self.checkbook_reception2.getSimulationState(), 'confirmed')

  def stepConfirmCheckbookReception3(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    self.workflow_tool.doActionFor(self.checkbook_reception3, 'confirm_action', 
                                   wf_id='checkbook_reception_workflow')
    self.assertEqual(self.checkbook_reception3.getSimulationState(), 'confirmed')

  def stepConfirmCheckbookReception4(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    self.workflow_tool.doActionFor(self.checkbook_reception4, 'confirm_action', 
                                   wf_id='checkbook_reception_workflow')
    self.assertEqual(self.checkbook_reception4.getSimulationState(), 'confirmed')

337 338 339 340 341 342 343 344
  def stepConfirmCheckbookReception5(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    self.workflow_tool.doActionFor(self.checkbook_reception5, 'confirm_action', 
                                   wf_id='checkbook_reception_workflow')
    self.assertEqual(self.checkbook_reception5.getSimulationState(), 'confirmed')

345 346 347 348 349 350 351 352
  def stepConfirmCheckbookReception6(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    self.workflow_tool.doActionFor(self.checkbook_reception6, 'confirm_action', 
                                   wf_id='checkbook_reception_workflow')
    self.assertEqual(self.checkbook_reception6.getSimulationState(), 'confirmed')

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
  def stepDeliverCheckbookReception2Fails(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    msg = self.assertWorkflowTransitionFails(self.checkbook_reception2, 
        'checkbook_reception_workflow', 'deliver_action') 
    self.failUnless(msg.find('The following references are already allocated')
                    >=0)
    self.failUnless(msg.find('50')>=0)

  def stepDeliverCheckbookReception3(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    self.workflow_tool.doActionFor(self.checkbook_reception3, 'deliver_action', 
                                   wf_id='checkbook_reception_workflow')
    self.assertEqual(self.checkbook_reception3.getSimulationState(), 'delivered')

  def stepDeliverCheckbookReception4Fails(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    msg = self.assertWorkflowTransitionFails(self.checkbook_reception4, 
        'checkbook_reception_workflow', 'deliver_action') 
    self.failUnless(msg.find('The following references are already allocated')
                    >=0)
    self.failUnless(msg.find('150')>=0)
Sebastien Robin's avatar
Sebastien Robin committed
380

381 382 383 384 385 386
  def stepDeliverCheckbookReception5(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    self.workflow_tool.doActionFor(self.checkbook_reception5, 'deliver_action', 
                                   wf_id='checkbook_reception_workflow')
Vincent Pelletier's avatar
Vincent Pelletier committed
387
    self.assertEqual(self.checkbook_reception5.getSimulationState(), 'delivered')
388

389 390 391 392 393 394 395 396
  def stepDeliverCheckbookReception6(self, sequence=None, sequence_list=None, **kwd):
    """
    confirm the monetary reception
    """
    self.workflow_tool.doActionFor(self.checkbook_reception6, 'deliver_action', 
                                   wf_id='checkbook_reception_workflow')
    self.assertEqual(self.checkbook_reception6.getSimulationState(), 'delivered')

Sebastien Robin's avatar
Sebastien Robin committed
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
  def stepDeliverCheckbookReception(self, sequence=None, sequence_list=None, **kw):
    """
    Deliver the monetary reception
    """
    state = self.checkbook_reception.getSimulationState()
    # check that state is draft
    self.assertEqual(state, 'confirmed')
    self.workflow_tool.doActionFor(self.checkbook_reception, 'deliver_action', wf_id='checkbook_reception_workflow')
    # execute tic
    self.stepTic()
    # get state of cash sorting
    state = self.checkbook_reception.getSimulationState()
    # check that state is delivered
    self.assertEqual(state, 'delivered')
    # get workflow history
    workflow_history = self.workflow_tool.getInfoFor(ob=self.checkbook_reception, name='history', wf_id='checkbook_reception_workflow')
    # check len of len workflow history is 6
    self.assertEqual(len(workflow_history), 5)


  def stepCheckFinalCheckbookInventory(self, sequence=None, sequence_list=None, **kw):
    """
    Check cash checkbook in item table
    """
    checkbook_list = self.simulation_tool.getCurrentTrackingList(node=self.reception.getRelativeUrl())
    self.assertEqual(len(checkbook_list), 2)
    # check we have cash checkbook 1
    checkbook_object_list = [x.getObject() for x in checkbook_list]
    self.failIfDifferentSet(checkbook_object_list,[self.checkbook_1,self.check_1])
    self.assertEqual(len(self.simulation_tool.getFutureTrackingList(node=self.reception.getRelativeUrl())), 2)

428 429 430 431 432 433 434 435 436
  def stepCheckConfirmedCheckbookForImport(self, sequence=None, sequence_list=None, **kw):
    """
    Check cash checkbook in item table
    """
    checkbook = self.checkbook_reception5.objectValues()[0].getAggregateValue()
    self.assertEqual(checkbook.getValidationState(), 'confirmed')
    check = checkbook.objectValues()[0]
    self.assertEqual(check.getSimulationState(), 'confirmed')

Sebastien Robin's avatar
Sebastien Robin committed
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
  ##################################
  ##  Tests
  ##################################

  def test_01_ERP5BankingCheckbookReception(self, quiet=QUIET, run=RUN_ALL_TEST):
    """
    Define the sequence of step that will be play
    """
    if not run: return
    sequence_list = SequenceList()
    # define the sequence
    sequence_string = 'Tic CheckObjects Tic CheckInitialCheckbookInventory ' \
                    + 'CreateCheckbookReception Tic ' \
                    + 'CreateCheckAndCheckbookLineList Tic ' \
                    + 'ConfirmCheckbookReception Tic ' \
                    + 'DeliverCheckbookReception Tic ' \
                    + 'CheckItemsCreated  ' \
                    + 'CheckFinalCheckbookInventory'
    sequence_list.addSequenceString(sequence_string)
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475

    # Make sure it is impossible to create a checkbook with a reference
    # wich is inside the range of another checkbook
    sequence_string = 'Tic ' \
                    + 'CreateCheckbookReception2 Tic ' \
                    + 'CreateCheckAndCheckbookLineList2 Tic ' \
                    + 'ConfirmCheckbookReception2 Tic ' \
                    + 'DeliverCheckbookReception2Fails Tic '
    sequence_list.addSequenceString(sequence_string)

    # Make sure it is impossible to create in the same time
    # two checkbooks with the same reference, so we must
    # do deliver without tic
    sequence_string = 'Tic ' \
                    + 'CreateCheckbookReception3 Tic ' \
                    + 'CreateCheckbookReception4 Tic ' \
                    + 'CreateCheckAndCheckbookLineList3 Tic ' \
                    + 'ConfirmCheckbookReception3 Tic ' \
                    + 'CreateCheckAndCheckbookLineList4 Tic ' \
                    + 'ConfirmCheckbookReception4 Tic ' \
476
                    + 'DeliverCheckbookReception3 Tic ' \
477 478 479
                    + 'DeliverCheckbookReception4Fails '
    sequence_list.addSequenceString(sequence_string)

480 481 482 483 484 485 486 487 488 489
    # Make sure that if we have an import, then everything
    # will be confirmed automatically
    sequence_string = 'Tic ' \
                    + 'CreateCheckbookReception5 Tic ' \
                    + 'CreateCheckAndCheckbookLineList5 Tic ' \
                    + 'ConfirmCheckbookReception5 Tic ' \
                    + 'DeliverCheckbookReception5 Tic ' \
                    + 'CheckConfirmedCheckbookForImport Tic ' 
    sequence_list.addSequenceString(sequence_string)

490 491 492 493 494 495 496
    # Check that it is possible to have 2 receptions on the same range for 2 different checkbook models
    sequence_string = 'Tic ' \
                    + 'CreateCheckbookReception6 Tic ' \
                    + 'CreateCheckAndCheckbookLineList6 Tic ' \
                    + 'ConfirmCheckbookReception6 Tic ' \
                    + 'DeliverCheckbookReception6 Tic'
    sequence_list.addSequenceString(sequence_string)
497

Sebastien Robin's avatar
Sebastien Robin committed
498 499 500
    # play the sequence
    sequence_list.play(self)