diff --git a/product/ERP5Banking/tests/testERP5BankingMonetarySurvey.py b/product/ERP5Banking/tests/testERP5BankingMonetarySurvey.py new file mode 100755 index 0000000000000000000000000000000000000000..9c8bb7a964b9378dd65fec7319b77bea1aeb28dd --- /dev/null +++ b/product/ERP5Banking/tests/testERP5BankingMonetarySurvey.py @@ -0,0 +1,498 @@ +############################################################################## +# +# 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 TestERP5BankingMonetarySurvey(TestERP5BankingMixin, ERP5TypeTestCase): + """ + This class is a unit test to check the module of Monetary 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 "ERP5BankingMonetarySurvey" + + + 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_banking_core' # erp5_banking_core contains all generic methods for banking + , 'erp5_banking_inventory' + , 'erp5_banking_cash' # erp5_banking_cash contains all method for cash transfer + ) + + def getMonetarySurveyModule(self): + """ + Return the Cash Transer Module + """ + return getattr(self.getPortal(), 'monetary_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.monetary_survey_module = self.getMonetarySurveyModule() + + 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/not_defined', 'cash_status/not_defined') + 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/not_defined', 'cash_status/not_defined') + self.variation_list, + 'quantity': self.quantity_200} + + line_list = [inventory_dict_line_1, inventory_dict_line_2] + self.source = self.paris.caveau.auxiliaire.encaisse_des_billets_et_monnaies + self.destination = self.paris.caveau.auxiliaire.encaisse_des_billets_a_ventiler_et_a_detruire + self.createCashInventory(source=None, destination=self.source, 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='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') + + + 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 MonetarySurvey Module was created + self.assertEqual(self.monetary_survey_module.getPortalType(), 'Monetary Survey Module') + # check cash transfer module is empty + self.assertEqual(len(self.monetary_survey_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 usual_cash + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.source.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.source.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0) + # check we have 12 coin of 200 in usual_cash + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.source.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.source.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0) + + + def stepCheckSource(self, sequence=None, sequence_list=None, **kwd): + """ + Check inventory in source vault (usual_cash) before a confirm + """ + # check we have 5 banknotes of 10000 + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.source.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.source.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0) + # check we have 12 coin of 200 + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.source.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.source.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0) + + + def stepCheckDestination(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.destination.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.destination.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0) + # check we don't have coins of 200 + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.destination.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 0.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.destination.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 0.0) + + + def stepCreateMonetarySurvey(self, sequence=None, sequence_list=None, **kwd): + """ + Create a cash transfer document and check it + """ + # Cash transfer has usual_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.monetary_survey = self.monetary_survey_module.newContent(id='monetary_survey_1', portal_type='Monetary Survey', source_value=self.source, destination_value=self.destination, source_total_asset_price=52400.0) + # execute tic + self.stepTic() + # check we have only one cash transfer + self.assertEqual(len(self.monetary_survey_module.objectValues()), 1) + # get the cash transfer document + self.monetary_survey = getattr(self.monetary_survey_module, 'monetary_survey_1') + # check its portal type + self.assertEqual(self.monetary_survey.getPortalType(), 'Monetary Survey') + # check that its source is usual_cash + self.assertEqual(self.monetary_survey.getSource(), 'site/testsite/paris/caveau/auxiliaire/encaisse_des_billets_et_monnaies') + # check that its destination is counter + self.assertEqual(self.monetary_survey.getDestination(), 'site/testsite/paris/caveau/auxiliaire/encaisse_des_billets_a_ventiler_et_a_detruire') + + + 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.monetary_survey, 'valid_line_1', 'Cash Delivery Line', self.billet_10000, + ('emission_letter', 'cash_status', 'variation'), ('emission_letter/not_defined', 'cash_status/not_defined') + self.variation_list, + self.quantity_10000) + # execute tic + self.stepTic() + # check there is only one line created + self.assertEqual(len(self.monetary_survey.objectValues()), 1) + # get the cash transfer line + self.valid_line_1 = getattr(self.monetary_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(), 'quantity_unit/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/not_defined', variation, 'cash_status/not_defined') + # 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 usual_cash + self.assertEqual(cell.getSourceValue(), self.source) + # check the destination vault is counter + self.assertEqual(cell.getDestinationValue(), self.destination) + 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.monetary_survey.objectValues()), 1) + # Check quantity of banknotes (2 for 1992 and 3 for 2003) + self.assertEqual(self.monetary_survey.getTotalQuantity(), 5.0) + # Check the total price + self.assertEqual(self.monetary_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.monetary_survey, 'valid_line_2', 'Cash Delivery Line', self.billet_200, + ('emission_letter', 'cash_status', 'variation'), ('emission_letter/not_defined', 'cash_status/not_defined') + self.variation_list, + self.quantity_200) + # execute tic + self.stepTic() + # check the number of lines (line1 + line2) + self.assertEqual(len(self.monetary_survey.objectValues()), 2) + # get the second cash transfer line + self.valid_line_2 = getattr(self.monetary_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.billet_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(), 'quantity_unit/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/not_defined', variation, 'cash_status/not_defined') + # 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 usual_cash has no banknote of 5000 + self.addCashLineToDelivery(self.monetary_survey, 'invalid_line', 'Cash Delivery Line', self.billet_5000, + ('emission_letter', 'cash_status', 'variation'), ('emission_letter/not_defined', 'cash_status/not_defined') + self.variation_list, + self.quantity_5000) + # execute tic + self.stepTic() + # Check number of cash transfer lines (line1 + line2 +invalid_line) + self.assertEqual(len(self.monetary_survey.objectValues()), 3) + # Check quantity, same as checkTotal + banknote of 500: 11 for 1992 and 13 for 2003 + self.assertEqual(self.monetary_survey.getTotalQuantity(), 5.0 + 12.0 + 24) + # chect the total price + self.assertEqual(self.monetary_survey.getTotalPrice(), 10000 * 5.0 + 200 * 12.0 + 5000 * 24) + + + def stepTryConfirmMonetarySurveyWithBadInventory(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.monetary_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.monetary_survey, 'confirm_action', wf_id='monetary_survey_workflow') + # execute tic + self.stepTic() + # get state of the cash transfer + state = self.monetary_survey.getSimulationState() + # check the state is draft + self.assertEqual(state, 'draft') + # get workflow history + workflow_history = self.workflow_tool.getInfoFor(ob=self.monetary_survey, name='history', wf_id='monetary_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.monetary_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.monetary_survey.objectValues()), 2) + # Check quantity, banknotes : 2 for 1992 and 3 for 2003, coin : 5 for 1992 and 7 for 2003 + self.assertEqual(self.monetary_survey.getTotalQuantity(), 5.0 + 12.0) + # check the total price + self.assertEqual(self.monetary_survey.getTotalPrice(), 10000 * 5.0 + 200 * 12.0) + + + def stepConfirmMonetarySurvey(self, sequence=None, sequence_list=None, **kwd): + """ + Confirm the cash transfer and check it + """ +# import pdb +# pdb.set_trace() + # fix amount (10000 * 5.0 + 200 * 12.0) + self.monetary_survey.setSourceTotalAssetPrice('52400.0') + # do the Workflow action + self.workflow_tool.doActionFor(self.monetary_survey, 'confirm_action', wf_id='monetary_survey_workflow') + # execute tic + self.stepTic() + # get state + state = self.monetary_survey.getSimulationState() + # check state is confirmed + self.assertEqual(state, 'confirmed') + # get workflow history + workflow_history = self.workflow_tool.getInfoFor(ob=self.monetary_survey, name='history', wf_id='monetary_survey_workflow') + # check len of workflow history is 4 + self.assertEqual(len(workflow_history), 4) + + + def stepCheckSourceDebitPlanned(self, sequence=None, sequence_list=None, **kwd): + """ + Check that compution of inventory at vault usual_cash is right after confirm and before deliver + """ + # check we have 5 banknotes of 10000 currently + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.source.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0) + # check we will have 0 banknote of 10000 after deliver + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.source.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0) + # check we have 12 coins of 200 currently + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.source.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0) + # check we will have 0 coin of 200 after deliver + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.source.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 0.0) + + + def stepCheckDestinationCreditPlanned(self, sequence=None, sequence_list=None, **kwd): + """ + Check that compution of inventory at vault counter is right after confirm and before deliver + """ + # check we have 0 banknote of 10000 currently + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.destination.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0) + # check we will have 5 banknotes of 10000 after deliver + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.destination.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0) + # check we have 0 coin of 200 currently + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.destination.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 0.0) + # check we will have 12 coins of 200 after deliver + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.destination.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0) + + + def stepDeliverMonetarySurvey(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.monetary_survey, 'deliver_action', wf_id='monetary_survey_workflow') + # execute tic + self.stepTic() + # get state of cash transfer + state = self.monetary_survey.getSimulationState() + # check that state is delivered + self.assertEqual(state, 'delivered') + # get workflow history + workflow_history = self.workflow_tool.getInfoFor(ob=self.monetary_survey, name='history', wf_id='monetary_survey_workflow') + # check len of len workflow history is 6 + self.assertEqual(len(workflow_history), 6) + + + def stepCheckSourceDebit(self, sequence=None, sequence_list=None, **kwd): + """ + Check inventory at source (vault usual_cash) after deliver of the cash transfer + """ + # check we have 0 banknote of 10000 + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.source.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.source.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 0.0) + # check we have 0 coin of 200 + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.source.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 0.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.source.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 0.0) + + + def stepCheckDestinationCredit(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.destination.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.destination.getRelativeUrl(), resource = self.billet_10000.getRelativeUrl()), 5.0) + # check we have 12 coins of 200 + self.assertEqual(self.simulation_tool.getCurrentInventory(node=self.destination.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0) + self.assertEqual(self.simulation_tool.getFutureInventory(node=self.destination.getRelativeUrl(), resource = self.billet_200.getRelativeUrl()), 12.0) + + + ################################## + ## Tests + ################################## + + def test_01_ERP5BankingMonetarySurvey(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 CheckSource CheckDestination ' \ + + 'CreateMonetarySurvey ' \ + + 'CreateValidLine1 CheckSubTotal ' \ + + 'CreateValidLine2 CheckTotal ' \ + + 'CheckSource CheckDestination ' \ + + 'CreateInvalidLine ' \ + + 'TryConfirmMonetarySurveyWithBadInventory ' \ + + 'DelInvalidLine Tic CheckTotal ' \ + + 'ConfirmMonetarySurvey ' \ + + 'CheckSourceDebitPlanned CheckDestinationCreditPlanned ' \ + + 'CheckSourceDebitPlanned CheckDestinationCreditPlanned ' \ + + 'DeliverMonetarySurvey ' \ + + 'CheckSourceDebit CheckDestinationCredit ' + 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(TestERP5BankingMonetarySurvey)) + return suite