first submission

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@10567 20353a03-c40f-0410-a6d1-a30d3c3de9de

product/ERP5Banking/tests/testERP5BankingDestructionSurvey.py

+##############################################################################
+#
+# Copyright (c) 2005-2006 Nexedi SARL and Contributors. All Rights Reserved.
+#                    Alexandre Boeglin <alex_AT_nexedi_DOT_com>
+#                    Kevin Deldycke <kevin_AT_nexedi_DOT_com>
+#                    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.
+#
+##############################################################################
+
+
+# import requested python module
+import os
+from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
+from Products.ERP5Type.tests.Sequence import SequenceList
+from Products.DCWorkflow.DCWorkflow import Unauthorized, ValidationFailed
+from Testing.ZopeTestCase.PortalTestCase import PortalTestCase
+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'
+
+# Define how to launch the script if we don't use runUnitTest script
+if __name__ == '__main__':
+  execfile(os.path.join(sys.path[0], 'framework.py'))
+
+
+class TestERP5BankingDestructionSurvey(TestERP5BankingMixin, ERP5TypeTestCase):
+  """
+    This class is a unit test to check the module of Destruction Survey
+
+  """
+
+  login = PortalTestCase.login
+
+  # 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 "ERP5BankingDestructionSurvey"
+
+
+  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.
+    """
+    return ('erp5_base'
+           , 'erp5_trade'
+           , 'erp5_accounting'
+           , 'erp5_banking_core' # erp5_banking_core contains all generic methods for banking
+           , 'erp5_banking_inventory'
+           , 'erp5_banking_cash' # erp5_banking_cash contains all method for monetary destruction
+           )
+
+  def getDestructionSurveyModule(self):
+    """
+    Return the Cash Transer Module
+    """
+    return getattr(self.getPortal(), 'destruction_survey_module', None)
+
+
+  def afterSetUp(self):
+    """
+      Method called before the launch of the test to initialize some data
+    """
+    # Set some variables :
+    self.initDefaultVariable()
+    # the cahs transfer module
+    self.destruction_survey_module = self.getDestructionSurveyModule()
+
+    self.createManagerAndLogin()
+
+    # create categories
+    self.createFunctionGroupSiteCategory()
+
+    # create resources
+    self.createBanknotesAndCoins()
+
+    # Before the test, we need to input the inventory
+
+    inventory_dict_line_1 = {'id' : 'inventory_line_1',
+                             'resource': self.billet_10000,
+                             'variation_id': ('emission_letter', 'cash_status', 'variation'),
+                             'variation_value': ('emission_letter/p', 'cash_status/to_sort') + self.variation_list,
+                             'quantity': self.quantity_10000}
+
+    inventory_dict_line_2 = {'id' : 'inventory_line_2',
+                             'resource': self.piece_200,
+                             'variation_id': ('emission_letter', 'cash_status', 'variation'),
+                             'variation_value': ('emission_letter/p', 'cash_status/to_sort') + self.variation_list,
+                             'quantity': self.quantity_200}
+
+    line_list = [inventory_dict_line_1, inventory_dict_line_2]
+
+    self.cash = self.paris.caveau.auxiliaire.encaisse_des_billets_a_ventiler_et_a_detruire
+    self.counter = self.paris.caveau.auxiliaire.encaisse_des_billets_ventiles_et_detruits
+    self.createCashInventory(source=None, destination=self.cash, currency=self.currency_1, line_list=line_list)
+
+
+  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 DestructionSurvey Module was created
+    self.assertEqual(self.destruction_survey_module.getPortalType(), 'Destruction Survey Module')
+    # check cash transfer module is empty
+    self.assertEqual(len(self.destruction_survey_module.objectValues()), 0)
+
+
+  def stepCheckSourceInitial(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Check inventory in source vault (cash) before a confirm
+    """
+    # check we have 5 banknotes of 10000
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.cash.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.cash.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0)
+    # check we have 12 coin of 200
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.cash.getRelativeUrl(), resource = self.piece_200.getRelativeUrl()), 12.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.cash.getRelativeUrl(), resource = self.piece_200.getRelativeUrl()), 12.0)
+
+
+  def stepCheckDestinationInitial(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Check inventory in destination vault (counter) before confirm
+    """
+    # check we don't have banknotes of 10000
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.counter.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.counter.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0)
+    # check we don't have coins of 200
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.counter.getRelativeUrl(), resource = self.piece_200.getRelativeUrl()), 0.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.counter.getRelativeUrl(), resource = self.piece_200.getRelativeUrl()), 0.0)
+
+
+  def stepCreateDestructionSurvey(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Create a cash transfer document and check it
+    """
+    # Cash transfer has cash for source, counter for destination, and a price cooreponding to the sum of banknote of 10000 abd coin of 200 ( (2+3) * 1000 + (5+7) * 200 )
+    self.destruction_survey = self.destruction_survey_module.newContent(id='destruction_survey_1', portal_type='Destruction Survey', source_value=self.cash, destination_value=self.counter, source_total_asset_price=52400.0)
+    # execute tic
+    self.stepTic()
+    # check we have only one cash transfer
+    self.assertEqual(len(self.destruction_survey_module.objectValues()), 1)
+    # get the cash transfer document
+    self.destruction_survey = getattr(self.destruction_survey_module, 'destruction_survey_1')
+    # check its portal type
+    self.assertEqual(self.destruction_survey.getPortalType(), 'Destruction Survey')
+    # check that its source is cash
+    self.assertEqual(self.destruction_survey.getSource(), 'site/testsite/paris/caveau/auxiliaire/encaisse_des_billets_a_ventiler_et_a_detruire')
+    # check that its destination is counter
+    self.assertEqual(self.destruction_survey.getDestination(), 'site/testsite/paris/caveau/auxiliaire/encaisse_des_billets_ventiles_et_detruits')
+
+
+  def stepCreateValidLine1(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Create the cash transfer line 1 with banknotes of 10000 and check it has been well created
+    """
+    # create the cash transfer line
+    self.addCashLineToDelivery(self.destruction_survey, 'valid_line_1', 'Cash Delivery Line', self.billet_10000,
+            ('emission_letter', 'cash_status', 'variation'), ('emission_letter/p', 'cash_status/to_sort') + self.variation_list,
+            self.quantity_10000)
+    # execute tic
+    self.stepTic()
+    # check there is only one line created
+    self.assertEqual(len(self.destruction_survey.objectValues()), 1)
+    # get the cash transfer line
+    self.valid_line_1 = getattr(self.destruction_survey, 'valid_line_1')
+    # check its portal type
+    self.assertEqual(self.valid_line_1.getPortalType(), 'Cash Delivery Line')
+    # check the resource is banknotes of 10000
+    self.assertEqual(self.valid_line_1.getResourceValue(), self.billet_10000)
+    # chek the value of the banknote
+    self.assertEqual(self.valid_line_1.getPrice(), 10000.0)
+    # check the unit of banknote
+    self.assertEqual(self.valid_line_1.getQuantityUnit(), 'unit')
+    # check we have two delivery cells: (one for year 1992 and one for 2003)
+    self.assertEqual(len(self.valid_line_1.objectValues()), 2)
+    # now check for each variation (years 1992 and 2003)
+    for variation in self.variation_list:
+      # get the delivery cell
+      cell = self.valid_line_1.getCell('emission_letter/p', variation, 'cash_status/to_sort')
+      # chek portal types
+      self.assertEqual(cell.getPortalType(), 'Cash Delivery Cell')
+      # check the banknote of the cell is banknote of 10000
+      self.assertEqual(cell.getResourceValue(), self.billet_10000)
+      # check the source vault is cash
+      self.assertEqual(cell.getSourceValue(), self.cash)
+      # check the destination vault is counter
+      self.assertEqual(cell.getDestinationValue(), self.counter)
+      if cell.getId() == 'movement_0_0_0':
+        # check the quantity of banknote for year 1992 is 2
+        self.assertEqual(cell.getQuantity(), 2.0)
+      elif cell.getId() == 'movement_0_1_0':
+        # check the quantity of banknote for year 2003 is 3
+        self.assertEqual(cell.getQuantity(), 3.0)
+      else:
+        self.fail('Wrong cell created : %s' % cell.getId())
+
+
+  def stepCheckSubTotal(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Check the amount after the creation of cash transfer line 1
+    """
+    # Check number of lines
+    self.assertEqual(len(self.destruction_survey.objectValues()), 1)
+    # Check quantity of banknotes (2 for 1992 and 3 for 2003)
+    self.assertEqual(self.destruction_survey.getTotalQuantity(), 5.0)
+    # Check the total price
+    self.assertEqual(self.destruction_survey.getTotalPrice(), 10000 * 5.0)
+
+
+  def stepCreateValidLine2(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Create the cash transfer line 2 wiht coins of 200 and check it has been well created
+    """
+    # create the line
+    self.addCashLineToDelivery(self.destruction_survey, 'valid_line_2', 'Cash Delivery Line', self.piece_200,
+            ('emission_letter', 'cash_status', 'variation'), ('emission_letter/p', 'cash_status/to_sort') + self.variation_list,
+            self.quantity_200)
+    # execute tic
+    self.stepTic()
+    # check the number of lines (line1 + line2)
+    self.assertEqual(len(self.destruction_survey.objectValues()), 2)
+    # get the second cash transfer line
+    self.valid_line_2 = getattr(self.destruction_survey, 'valid_line_2')
+    # check portal types
+    self.assertEqual(self.valid_line_2.getPortalType(), 'Cash Delivery Line')
+    # check the resource is coin of 200
+    self.assertEqual(self.valid_line_2.getResourceValue(), self.piece_200)
+    # check the value of coin
+    self.assertEqual(self.valid_line_2.getPrice(), 200.0)
+    # check the unit of coin
+    self.assertEqual(self.valid_line_2.getQuantityUnit(), 'unit')
+    # check we have two delivery cells: (one for year 1992 and one for 2003)
+    self.assertEqual(len(self.valid_line_2.objectValues()), 2)
+    for variation in self.variation_list:
+      # get the delivery  cell
+      cell = self.valid_line_2.getCell('emission_letter/p', variation, 'cash_status/to_sort')
+      # check the portal type
+      self.assertEqual(cell.getPortalType(), 'Cash Delivery Cell')
+      if cell.getId() == 'movement_0_0_0':
+        # check the quantity for coin for year 1992 is 5
+        self.assertEqual(cell.getQuantity(), 5.0)
+      elif cell.getId() == 'movement_0_1_0':
+        # check the quantity for coin for year 2003 is 7
+        self.assertEqual(cell.getQuantity(), 7.0)
+      else:
+        self.fail('Wrong cell created : %s' % cell.getId())
+
+
+  def stepCreateInvalidLine(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Create an invalid cash transfer line and
+    check the total with the invalid cash transfer line
+    """
+    # create a line in which quanity of banknotes of 5000 is higher that quantity available at source
+    # here create a line with 24 (11+13) banknotes of 500 although the vault cash has no banknote of 5000
+    self.addCashLineToDelivery(self.destruction_survey, 'invalid_line', 'Cash Delivery Line', self.billet_5000,
+            ('emission_letter', 'cash_status', 'variation'), ('emission_letter/p', 'cash_status/to_sort') + self.variation_list,
+            self.quantity_5000)
+    # execute tic
+    self.stepTic()
+    # Check number of cash transfer lines (line1 + line2 +invalid_line)
+    self.assertEqual(len(self.destruction_survey.objectValues()), 3)
+    # Check quantity, same as checkTotal + banknote of 500: 11 for 1992 and 13 for 2003
+    self.assertEqual(self.destruction_survey.getTotalQuantity(), 5.0 + 12.0 + 24)
+    # chect the total price
+    self.assertEqual(self.destruction_survey.getTotalPrice(), 10000 * 5.0 + 200 * 12.0 + 5000 * 24)
+
+
+  def stepTryConfirmDestructionSurveyWithBadInventory(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Try to confirm the cash transfer with a bad cash transfer line and
+    check the try of confirm the cash transfer with the invalid line has failed
+    """
+    # fix amount (10000 * 5.0 + 200 * 12.0 + 5000 * 24)
+    self.destruction_survey.setSourceTotalAssetPrice('172400.0')
+    # try to do the workflow action "confirm_action', cath the exception ValidationFailed raised by workflow transition
+    self.assertRaises(ValidationFailed, self.workflow_tool.doActionFor, self.destruction_survey, 'confirm_action', wf_id='destruction_survey_workflow')
+    # execute tic
+    self.stepTic()
+    # get state of the cash transfer
+    state = self.destruction_survey.getSimulationState()
+    # check the state is draft
+    self.assertEqual(state, 'draft')
+    # get workflow history
+    workflow_history = self.workflow_tool.getInfoFor(ob=self.destruction_survey, name='history', wf_id='destruction_survey_workflow')
+    # check its len is 2
+    self.assertEqual(len(workflow_history), 2)
+    # check we get an "Insufficient balance" message in the workflow history because of the invalid line
+    msg = workflow_history[-1]['error_message']
+    self.assertEqual('Insufficient Balance.', "%s" %(msg,))
+
+
+  def stepDelInvalidLine(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Delete the invalid cash transfer line previously create
+    """
+    self.destruction_survey.deleteContent('invalid_line')
+
+
+  def stepCheckTotal(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Check the total after the creation of the two cash transfer lines
+    """
+    # Check number of lines (line1 + line2)
+    self.assertEqual(len(self.destruction_survey.objectValues()), 2)
+    # Check quantity, banknotes : 2 for 1992 and 3 for 2003, coin : 5 for 1992 and 7 for 2003
+    self.assertEqual(self.destruction_survey.getTotalQuantity(), 5.0 + 12.0)
+    # check the total price
+    self.assertEqual(self.destruction_survey.getTotalPrice(), 10000 * 5.0 + 200 * 12.0)
+
+
+  def stepConfirmDestructionSurvey(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Confirm the cash transfer and check it
+    """
+    # fix amount (10000 * 5.0 + 200 * 12.0)
+    self.destruction_survey.setSourceTotalAssetPrice('52400.0')
+    # do the Workflow action
+    self.workflow_tool.doActionFor(self.destruction_survey, 'confirm_action', wf_id='destruction_survey_workflow')
+    # execute tic
+    self.stepTic()
+    # get state
+    state = self.destruction_survey.getSimulationState()
+    # check state is confirmed
+    self.assertEqual(state, 'confirmed')
+    # get workflow history
+    workflow_history = self.workflow_tool.getInfoFor(ob=self.destruction_survey, name='history', wf_id='destruction_survey_workflow')
+    # check len of workflow history is 4
+    self.assertEqual(len(workflow_history), 4)
+
+
+
+  def stepDeliverDestructionSurvey(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Deliver the cash transfer with a good user
+    and check that the deliver of a cash tranfer have achieved
+    """
+    # do the workflow transition "deliver_action"
+    self.workflow_tool.doActionFor(self.destruction_survey, 'deliver_action', wf_id='destruction_survey_workflow')
+    # execute tic
+    self.stepTic()
+    # get state of cash transfer
+    state = self.destruction_survey.getSimulationState()
+    # check that state is delivered
+    self.assertEqual(state, 'delivered')
+    # get workflow history
+    workflow_history = self.workflow_tool.getInfoFor(ob=self.destruction_survey, name='history', wf_id='destruction_survey_workflow')
+    # check len of len workflow history is 6
+    self.assertEqual(len(workflow_history), 6)
+
+
+  def stepCheckSourceFinal(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Check inventory at source (vault cash) after deliver of the cash transfer
+    """
+    # check we have 0 banknote of 10000
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.cash.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.cash.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0)
+    # check we have 0 coin of 200
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.cash.getRelativeUrl(), resource = self.piece_200.getRelativeUrl()), 0.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.cash.getRelativeUrl(), resource = self.piece_200.getRelativeUrl()), 0.0)
+
+
+  def stepCheckDestinationFinal(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Check inventory at destination (vault counter) after deliver of the cash transfer
+    """
+    # check we have 5 banknotes of 10000
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.counter.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.counter.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0)
+    # check we have 12 coins of 200
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.counter.getRelativeUrl(), resource = self.piece_200.getRelativeUrl()), 12.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.counter.getRelativeUrl(), resource = self.piece_200.getRelativeUrl()), 12.0)
+
+
+  ##################################
+  ##  Tests
+  ##################################
+
+  def test_01_ERP5BankingDestructionSurvey(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 CheckSourceInitial CheckDestinationInitial ' \
+                    + 'CreateDestructionSurvey ' \
+                    + 'CreateValidLine1 CheckSubTotal ' \
+                    + 'CreateValidLine2 CheckTotal ' \
+                    + 'CheckSourceInitial CheckDestinationInitial ' \
+                    + 'CreateInvalidLine ' \
+                    + 'TryConfirmDestructionSurveyWithBadInventory ' \
+                    + 'DelInvalidLine Tic CheckTotal ' \
+                    + 'ConfirmDestructionSurvey ' \
+                    + 'DeliverDestructionSurvey ' \
+                    + 'CheckSourceFinal CheckDestinationFinal '
+    sequence_list.addSequenceString(sequence_string)
+    # play the sequence
+    sequence_list.play(self)
+
+# define how we launch the unit test
+if __name__ == '__main__':
+  framework()
+else:
+  import unittest
+  def test_suite():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(TestERP5BankingDestructionSurvey))
+    return suite