add unit test for internal money payment

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

product/ERP5Banking/tests/testERP5BankingInternalMoneyPayment.py

+##############################################################################
+#
+# Copyright (c) 2005-2006 Nexedi SARL and Contributors. All Rights Reserved.
+#                   Aurelien Calonne <aurel@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+#
+##############################################################################
+
+
+# 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 TestERP5BankingInternalMoneyPayment(TestERP5BankingMixin, ERP5TypeTestCase):
+  
+
+  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 "ERP5BankingInternalMoneyPayment"
+  
+  def getInternalMoneyPaymentModule(self):
+    """
+    Return the Internal Money Payment Module
+    """
+    return getattr(self.getPortal(), 'internal_money_payment_module', None)
+
+
+  def afterSetUp(self):
+    """
+      Method called before the launch of the test to initialize some data
+    """
+    self.initDefaultVariable()
+    # Set some variables : 
+    self.internal_money_payment_module = self.getInternalMoneyPaymentModule()
+
+    # Create a user and login as manager to populate the erp5 portal with objects for tests.
+    self.createManagerAndLogin()
+
+    self.createFunctionGroupSiteCategory()
+    self.createBanknotesAndCoins()
+
+    """
+    Windows to create the BANKNOTES of 10 000 and 5000, coins 200.
+    It s same to click to the fast input button.  
+    """
+
+    # 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/valid') + self.variation_list,
+                             'quantity': self.quantity_10000}
+
+    inventory_dict_line_2 = {'id' : 'inventory_line_2',
+                             'resource': self.billet_200,
+                             'variation_id': ('emission_letter', 'cash_status', 'variation'),
+                             'variation_value': ('emission_letter/p', 'cash_status/valid') + self.variation_list,
+                             'quantity': self.quantity_200}
+
+    inventory_dict_line_3 = {'id' : 'inventory_line_3',
+                             'resource': self.billet_5000,
+                             'variation_id': ('emission_letter', 'cash_status', 'variation'),
+                             'variation_value': ('emission_letter/p', 'cash_status/valid') + self.variation_list,
+                             'quantity': self.quantity_5000}
+
+
+    
+    
+    line_list = [inventory_dict_line_1, inventory_dict_line_2, inventory_dict_line_3]
+    
+    self.bi_counter = self.paris.surface.banque_interne
+    self.bi_counter_vault = self.paris.surface.banque_interne.guichet_1.encaisse_des_billets_et_monnaies.sortante
+    self.bi_counter = self.paris.surface.banque_interne.guichet_1
+    
+    self.createCashInventory(source=None, destination=self.bi_counter_vault, currency=self.currency_1,
+                             line_list=line_list)
+
+
+    # now we need to create a user as Manager to do the test
+    # in order to have an assigment defined which is used to do transition
+    # Create an Organisation that will be used for users assignment
+    self.checkUserFolderType()
+    self.organisation = self.organisation_module.newContent(id='paris', 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/surface/banque_interne/guichet_1']
+      }
+    # call method to create this user
+    self.createERP5Users(user_dict)
+    self.logout()
+    self.login('super_user')
+    # open counter date and counter
+    self.openCounterDate(site=self.paris)
+    self.openCounter(site=self.bi_counter_vault)
+
+
+
+
+  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 InternalMoneyPayment Module was created
+    self.assertEqual(self.internal_money_payment_module.getPortalType(), 'Internal Money Payment Module')
+    # check cash sorting module is empty
+    self.assertEqual(len(self.internal_money_payment_module.objectValues()), 0)
+
+
+  def stepCheckInitialInventory(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Check the initial inventory before any operations
+    """
+    self.simulation_tool = self.getSimulationTool()
+    # check we have 5 banknotes of 10000 in encaisse_billets_et_monnaies
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0)
+    # check we have 12 coin of 200 in encaisse_billets_et_monnaies
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0)
+    # check we have 24 banknotes of 200 in encaisse_billets_et_monnaies
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_5000.getRelativeUrl()), 24.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_5000.getRelativeUrl()), 24.0)
+
+
+
+  def stepCreateInternalMoneyPayment(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Create a cash sorting document and check it
+    """
+    # Cash sorting has encaisse_paris for source, guichet_1 for destination, and a price cooreponding to the sum of banknote of 10000 and banknotes of 200 ( (2+3) * 10000 + (2+3) * 200 )
+    self.internal_money_payment = self.internal_money_payment_module.newContent(
+                                    id='internal_money_payment', 
+                                    portal_type='Internal Money Payment', 
+                                    #resource_value = self.currency_1,
+                                    source_total_asset_price=20000.0,
+                                    grouping_reference="lettering",
+                                    description='test',
+                                    )
+    # execute tic
+    self.stepTic()
+    # set source reference
+    self.setDocumentSourceReference(self.internal_money_payment)
+    # check source reference
+    self.assertNotEqual(self.internal_money_payment.getSourceReference(), '')
+    self.assertNotEqual(self.internal_money_payment.getSourceReference(), None)
+    # check we have only one cash sorting
+    self.assertEqual(len(self.internal_money_payment_module.objectValues()), 1)
+    # get the cash sorting document
+    self.internal_money_payment = getattr(self.internal_money_payment_module, 'internal_money_payment')
+    # check its portal type
+    self.assertEqual(self.internal_money_payment.getPortalType(), 'Internal Money Payment')
+    self.assertEqual(self.internal_money_payment.getBaobabSource(), self.bi_counter_vault.getRelativeUrl())
+    # check that its destination is guichet_1
+    self.assertEqual(self.internal_money_payment.getSourceTotalAssetPrice(), 20000.0)
+    self.assertEqual(self.internal_money_payment.getBaobabDestination(), None)
+
+    # the initial state must be draft
+    self.assertEqual(self.internal_money_payment.getSimulationState(), 'draft')
+
+#     # source reference must be automatically generated
+#     #self.internal_money_payment.setSourceReference(self.internal_money_payment.Baobab_getUniqueReference())
+#     self.assertNotEqual(self.internal_money_payment.getSourceReference(), None)
+#     self.assertNotEqual(self.internal_money_payment.getSourceReference(), '')
+
+
+
+  def stepInputCashDetails(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Input cash details
+    """
+    self.addCashLineToDelivery(self.internal_money_payment, 'line_1', 'Cash Delivery Line', self.billet_10000,
+            ('emission_letter', 'cash_status', 'variation'),
+            ('emission_letter/p', 'cash_status/valid') + self.variation_list[1:],
+            {self.variation_list[1] : 1})
+    self.assertEqual(self.internal_money_payment.line_1.getPrice(), 10000)
+
+    self.addCashLineToDelivery(self.internal_money_payment, 'line_2', 'Cash Delivery Line', self.billet_5000,
+            ('emission_letter', 'cash_status', 'variation'),
+            ('emission_letter/p', 'cash_status/valid') + self.variation_list[1:],
+            {self.variation_list[1] : 2})
+    self.assertEqual(self.internal_money_payment.line_2.getPrice(), 5000)
+
+
+  
+  def stepDeliverInternalMoneyPayment(self, sequence=None, sequence_list=None, **kwd):
+
+    self.assertEqual(self.internal_money_payment.getSourceTotalAssetPrice(),
+                     self.internal_money_payment.getTotalPrice(portal_type = 'Cash Delivery Cell'))
+    self.workflow_tool.doActionFor(self.internal_money_payment, 'deliver_action', wf_id='internal_money_payment_workflow')
+    self.assertEqual(self.internal_money_payment.getSimulationState(), 'delivered')
+    
+    self.assertEqual(self.internal_money_payment.getSourceTotalAssetPrice(), 20000.0)
+    self.assertEqual(20000.0, self.internal_money_payment.getTotalPrice(portal_type = 'Cash Delivery Cell'))
+
+
+  def stepCheckFinalInventory(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Check the initial inventory before any operations
+    """
+    self.simulation_tool = self.getSimulationTool()
+    # check we have 5 banknotes of 10000 in encaisse_billets_et_monnaies
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 4.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 4.0)
+    # check we have 12 coin of 200 in encaisse_billets_et_monnaies
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0)
+    # check we have 24 banknotes of 200 in encaisse_billets_et_monnaies
+    self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_5000.getRelativeUrl()), 22.0)
+    self.assertEqual(self.simulation_tool.getFutureInventory(node=self.bi_counter_vault.getRelativeUrl(), resource = self.billet_5000.getRelativeUrl()), 22.0)
+
+
+
+  def stepDelInternalMoneyPayment(self, sequence=None, sequence_list=None, **kwd):
+    """
+    Delete the invalid vault_transfer line previously create
+    """
+    self.internal_money_payment_module.deleteContent('internal_money_payment_1')
+
+  def stepCheckWorklist(self, **kw):
+    self.checkWorklist(self.internal_money_payment)
+
+  ##################################
+  ##  Tests
+  ##################################
+
+  def test_01_ERP5BankingInternalMoneyPayment(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 CheckInitialInventory ' \
+                    + 'CreateInternalMoneyPayment ' \
+                    + 'InputCashDetails  Tic ' \
+                    + 'Tic CheckWorklist ' \
+                    + 'DeliverInternalMoneyPayment Tic ' \
+                    + 'CheckFinalInventory'
+    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(TestERP5BankingInternalMoneyPayment))
+    return suite