testAccountingRules.py 78.6 KB
Newer Older
1 2
##############################################################################
#
3
# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
4
#          Sebastien Robin <seb@nexedi.com>
5
#          Jerome Perrin <jerome@nexedi.com>
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
#
# 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
26
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 28
#
##############################################################################
29 30 31 32 33
"""
  Tests accounting simulation rules and delivery builder.
This tests also do basic checks for XMLMatrix and Predicate matching the
way it is used in the invoice related simulation.
"""
34

35
# TODO :
Jérome Perrin's avatar
Jérome Perrin committed
36
#   * test with a Person as destination_section
37
#   * test cancelling / deleting an invoice
38
#   * test payment rule & payment builder
39
#   * test simulation purge when Payment delivered or top level Order cancelled
40
#   * test removing cells for a line
41
#
42

43 44
import unittest
import random
45

46

47
from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
48
from Products.ERP5Type.tests.Sequence import SequenceList
49
from Products.ERP5.tests.utils import newSimulationExpectedFailure
50
from Products.ERP5.Document.MirrorMovementGroup import _isMirrored
51

52 53 54 55
from Testing import ZopeTestCase
from zLOG import LOG, INFO
from DateTime import DateTime

56 57

class PurchaseInvoiceTest:
58
  invoice_portal_type = 'Purchase Invoice Transaction'
59
  invoice_transaction_line_portal_type \
60
                     = "Purchase Invoice Transaction Line"
61 62
  invoice_line_portal_type = "Invoice Line"
  invoice_cell_portal_type = "Invoice Cell"
63
  payment_transaction_line_portal_type = "Accounting Transaction Line"
64 65

class SaleInvoiceTest:
66
  invoice_portal_type = 'Sale Invoice Transaction'
67 68 69 70
  invoice_transaction_line_portal_type \
                     = "Sale Invoice Transaction Line"
  invoice_line_portal_type = "Invoice Line"
  invoice_cell_portal_type = "Invoice Cell"
71
  payment_transaction_line_portal_type = "Accounting Transaction Line"
72

73
class TestAccountingRulesMixin:
74
  # define portal_types
75 76 77 78 79 80 81 82 83 84 85 86
  account_module_portal_type           = "Account Module"
  accounting_module_portal_type        = "Accounting Module"
  product_module_portal_type           = "Product Module"
  currency_module_portal_type          = "Currency Module"
  organisation_portal_type             = "Organisation"
  account_portal_type                  = "Account"
  product_portal_type                  = "Product"
  currency_portal_type                 = "Currency"
  predicate_portal_type                = "Predicate"
  applied_rule_portal_type             = "Applied Rule"
  simulation_movement_portal_type      = "Simulation Movement"
  accounting_rule_cell_portal_type     = "Accounting Rule Cell"
87

88
  payment_transaction_portal_type      = "Payment Transaction"
89
  payment_transaction_line_definition_list = (
90
    ('bank', 'account_module/bank', 'account_module/bank'),
91
    )
92

93
  def getBusinessTemplateList(self):
94
    """  Return the list of business templates. """
95 96 97
    return ('erp5_base','erp5_pdm', 'erp5_simulation', 'erp5_trade',
            'erp5_accounting', 'erp5_invoicing', 'erp5_simplified_invoicing',
            'erp5_simulation_test')
98

99
  def getAccountModule(self):
100 101
    return getattr(self.getPortal(), 'account',
        getattr(self.getPortal(), 'account_module'))
102

103
  def getAccountingModule(self):
104 105
    return getattr(self.getPortal(), 'accounting',
        getattr(self.getPortal(), 'accounting_module'))
106 107

  def getProductModule(self):
108 109
    return getattr(self.getPortal(), 'product',
        getattr(self.getPortal(), 'product_module'))
110

111
  ## XXX move this to "Sequence class"
Jérome Perrin's avatar
Jérome Perrin committed
112
  def playSequence(self, sequence_string, quiet=0) :
113 114
    sequence_list = SequenceList()
    sequence_list.addSequenceString(sequence_string)
Jérome Perrin's avatar
Jérome Perrin committed
115
    sequence_list.play(self, quiet=quiet)
116

117

Jérome Perrin's avatar
Jérome Perrin committed
118
class TestAccountingRules(TestAccountingRulesMixin, ERP5TypeTestCase):
119 120 121 122 123 124
  """
  This should test the simulation tree and builds starting from the
  invoice.

  """
  RUN_ALL_TESTS = 1
125 126
  QUIET = 0

127 128
  def getTitle(self):
    return "Accounting Rules"
129

130 131 132
  def afterSetUp(self) :
    self.login()
    self.createCategories()
Jérome Perrin's avatar
Jérome Perrin committed
133
    self.validateRules()
134

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
  def createCategories(self) :
    """ create all categories that are needed for this test.
    It uses getCategoriesToCreate, so you should overload this method.
    """
    # create base categories
    for base_cat in self.getBaseCategoriesToCreate() :
      if not base_cat in self.getCategoryTool().objectIds() :
        self.getCategoryTool().newContent(
          portal_type = 'Base Category',
          id = base_cat)
    # create categories
    for cat_string in self.getCategoriesToCreate() :
      base_cat = cat_string.split("/")[0]
      path = self.getPortal().portal_categories[base_cat]
      for cat in cat_string.split("/")[1:] :
        if not cat in path.objectIds() :
          path = path.newContent(
            portal_type = 'Category',
153
            id = cat)
Jérome Perrin's avatar
Jérome Perrin committed
154 155
        else:
          path = getattr(path, cat)
156 157 158 159 160
    # check categories have been created
    for cat_string in self.getCategoriesToCreate() :
      self.assertNotEquals(None,
                self.getCategoryTool().restrictedTraverse(cat_string),
                cat_string)
161

162 163 164 165 166 167 168 169
  def getBaseCategoriesToCreate(self) :
    return ("hd_size", "cpu_freq")

  def getCategoriesToCreate(self):
    return (
      # regions for our organisations
      "region/europe/west/france",
      "region/africa",
170

171
      # those are mandatory for account, and accounting rules depends on
172
      # the account_type category. (ie payable, will create a Payment
173 174 175 176 177 178 179
      # Transaction accordingly)
      "account_type/asset/cash",
      "account_type/asset/receivable/refundable_vat",
      "account_type/equity",
      "account_type/expense",
      "account_type/income",
      "account_type/liability/payable/collected_vat",
180

181 182 183 184 185
      # some products lines for our products
      "product_line/storever/notebook",
      "product_line/storever/barebone",
      "product_line/storever/openbrick",
      "product_line/not_used/not_matched",
186

187 188 189 190 191 192 193
      # some categories for variating our products
      "cpu_freq/1Ghz",
      "cpu_freq/2Ghz",
      "hd_size/60Go",
      "hd_size/120Go",
    )

194
  def stepCreateInvoiceTransactionRule(self, sequence, **kw) :
195
    """
196 197 198
      Create some predicates in the Invoice Transaction Rule
    """
    invoice_transaction_rule = getattr(self.getRuleTool(),
199
            'default_invoice_transaction_simulation_rule')
200 201
    if invoice_transaction_rule.getValidationState() == 'validated':
      invoice_transaction_rule.invalidate()
202
      self.commit()
203

204 205 206 207 208 209
    # delete anything inside the rule first
    # clear the message queue, so that it does not contains unexistant paths
    self.tic()
    invoice_transaction_rule.deleteContent(
                [x for x in invoice_transaction_rule.objectIds()])
    self.assertEquals(len(invoice_transaction_rule.objectValues()), 0)
210
    self.commit()
211

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
    # and add new content, predicate product_line
    predicate_product_notebook = invoice_transaction_rule.newContent(
      id = 'product_notebook',
      title = 'Product Notebook',
      portal_type = self.predicate_portal_type,
      string_index = 'product',
      int_index = '1',
      membership_criterion_base_category_list = ['product_line',],
      membership_criterion_category_list = ['product_line/storever/notebook'],
    )
    predicate_product_barebone = invoice_transaction_rule.newContent(
      id = 'product_barebone',
      title = 'Product Barebone',
      portal_type = self.predicate_portal_type,
      string_index = 'product',
      int_index = '2',
      membership_criterion_base_category_list = ['product_line',],
      membership_criterion_category_list = ['product_line/storever/barebone'],
    )
    # ... and destination_region
    predicate_region_france = invoice_transaction_rule.newContent(
      id = 'region_france',
      title = 'Region France',
      portal_type = self.predicate_portal_type,
      string_index = 'region',
      int_index ='1',
      membership_criterion_base_category_list = ['destination_region',],
      membership_criterion_category_list =
                    ['destination_region/region/europe/west/france'],
    )
    predicate_region_africa = invoice_transaction_rule.newContent(
      id = 'region_africa',
      title = 'region_africa',
      portal_type = self.predicate_portal_type,
      string_index = 'region',
      int_index = '2',
      membership_criterion_base_category_list = ['destination_region',],
      membership_criterion_category_list = ['destination_region/region/africa'],
    )
    # sanity checks
    self.failUnless(predicate_product_notebook != None)
    self.failUnless(predicate_product_barebone != None)
    self.failUnless(predicate_region_france  != None)
    self.failUnless(predicate_region_africa  != None)
    predicate_list = invoice_transaction_rule.contentValues(
          filter = {'portal_type': self.predicate_portal_type})
    self.assertEqual(len(predicate_list), 4)
    sequence.edit(
      invoice_transaction_rule = invoice_transaction_rule,
      predicate_product_notebook = predicate_product_notebook,
      predicate_product_barebone = predicate_product_barebone,
      predicate_region_france  = predicate_region_france,
      predicate_region_africa  = predicate_region_africa,
    )
266

267
  def stepUpdateInvoiceTransactionRuleMatrix(self, sequence, **kw) :
Jérome Perrin's avatar
Jérome Perrin committed
268
    """Creates/updates the matrix of the sale invoice transaction rule """
269
    invoice_transaction_rule = sequence.get('invoice_transaction_rule')
270

271
    # update the matrix, generates the accounting rule cells
272 273 274
    invoice_transaction_rule.edit()
    invoice_transaction_rule.updateMatrix()
    self.tic()
275

276
    # check the accounting rule cells inside the matrix
277
    cell_list = invoice_transaction_rule.contentValues(
278 279 280 281 282 283 284 285 286 287
                portal_type=self.accounting_rule_cell_portal_type)
    kw = dict(
      product_notebook_region_france_cell=invoice_transaction_rule.getCell(
        'product_notebook', 'region_france', base_id='movement'),
      product_notebook_region_africa_cell=invoice_transaction_rule.getCell(
        'product_notebook', 'region_africa', base_id='movement'),
      product_barebone_region_france_cell=invoice_transaction_rule.getCell(
        'product_barebone', 'region_france', base_id='movement'),
      product_barebone_region_africa_cell=invoice_transaction_rule.getCell(
        'product_barebone', 'region_africa', base_id='movement'),
288
    )
289 290
    self.assertSameSet(cell_list, kw.values())
    sequence.edit(**kw)
291

292
  def stepValidateInvoiceTransaction(self, sequence, **kw) :
293 294 295
    """validates the sale invoice transaction rule"""
    sequence.get('invoice_transaction_rule').validate()

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
  def stepCreateNotebookFranceCell(self, sequence, **kw):
    """ creates the content of product_notebook_region_france_cell """
    # create content in the notebook / france cell
    product_notebook_region_france_cell = sequence.get(
        'product_notebook_region_france_cell')
    product_notebook_region_france_cell_income = \
        product_notebook_region_france_cell.newContent(
            id = 'income',
            source = sequence.get('income').getRelativeUrl(),
            quantity = 1)
    product_notebook_region_france_cell_receivable = \
        product_notebook_region_france_cell.newContent(
            id = 'receivable',
            source = sequence.get('receivable').getRelativeUrl(),
            quantity = -1.196)
    product_notebook_region_france_cell_vat = \
        product_notebook_region_france_cell.newContent(
            id = 'collected_vat',
            source = sequence.get('collected_vat').getRelativeUrl(),
            quantity = 0.196)
    sequence.edit(
      invoice_transaction_rule_cell = product_notebook_region_france_cell,
      product_notebook_region_france_cell_income =
            product_notebook_region_france_cell_income,
      product_notebook_region_france_cell_receivable =
            product_notebook_region_france_cell_receivable,
      product_notebook_region_france_cell_vat =
            product_notebook_region_france_cell_vat,
    )
325

326
  def stepCreateBareboneFranceCell(self, sequence, **kw):
327
    """ creates the content of product_barebone_region_france_cell,
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
      the same as product_notebook_region_france_cell, but the income
      account is differrent """
    # create content in the notebook / france cell
    product_barebone_region_france_cell = sequence.get(
        'product_barebone_region_france_cell')
    product_barebone_region_france_cell_income = \
        product_barebone_region_france_cell.newContent(
            id = 'income',
            source = sequence.get('income_barebone').getRelativeUrl(),
            quantity = 1)
    product_barebone_region_france_cell_receivable = \
        product_barebone_region_france_cell.newContent(
            id = 'receivable',
            source = sequence.get('receivable').getRelativeUrl(),
            quantity = -1.196)
    product_barebone_region_france_cell_vat = \
        product_barebone_region_france_cell.newContent(
            id = 'collected_vat',
            source = sequence.get('collected_vat').getRelativeUrl(),
            quantity = 0.196)
    sequence.edit(
      product_barebone_region_france_cell = product_barebone_region_france_cell,
      product_barebone_region_france_cell_income =\
                product_barebone_region_france_cell_income,
      product_barebone_region_france_cell_vat =\
                product_barebone_region_france_cell_vat,
      product_barebone_region_france_cell_receivable =\
                product_barebone_region_france_cell_receivable
    )
357 358


359 360 361 362 363 364 365 366 367 368 369 370 371
  def stepCreateAccounts(self, sequence, **kw):
    """
      Create an income, an payable and a collected_vat account
    """
    portal = self.getPortal()
    account_module = self.getAccountModule()
    if not hasattr(account_module, 'income') :
      income = account_module.newContent(
        id = "income",
        portal_type = self.account_portal_type,
        title = "Income Notebook",
        account_type = "income",
      )
372
      income_barebone = account_module.newContent(
373 374 375 376 377 378 379 380 381 382 383
        id = "income_barebone",
        portal_type = self.account_portal_type,
        title = "Income Barebone",
        account_type = "income",
      )
      receivable = account_module.newContent(
        id = "receivable",
        portal_type=self.account_portal_type,
        title = "Receivable",
        account_type = "asset/receivable",
      )
384 385 386 387 388 389
      bank = account_module.newContent(
        id = "bank",
        portal_type=self.account_portal_type,
        title = "Bank",
        account_type = "asset/cash/bank",
      )
390 391 392 393 394 395 396 397 398 399 400
      collected_vat = account_module.newContent(
        id = "collected_vat",
        portal_type=self.account_portal_type,
        title = "Collected VAT",
        account_type = "liability/payable/collected_vat",
      )
    # store accounts in sequence object
    sequence.edit(
      income          = account_module.income,
      income_barebone = account_module.income_barebone,
      receivable      = account_module.receivable,
401
      bank   = account_module.bank,
402 403
      collected_vat   = account_module.collected_vat,
    )
404

405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
  def stepCreateEntities(self, sequence, **kw) :
    """ Create a vendor and a client organisation.
      The region of the client is the same as the region
      defined in the rule.
    """
    organisation_module = self.getOrganisationModule()
    if not hasattr(organisation_module, 'vendor') :
      vendor = organisation_module.newContent(
        portal_type = self.organisation_portal_type,
        id = "vendor",
        title = "Vendor",
        region = "europe/west/france",
      )
      self.assertNotEquals(vendor.getDefaultRegionValue(), None)
      client_fr = organisation_module.newContent(
        portal_type = self.organisation_portal_type,
        id = "client_fr",
        title = "French Client",
        region = "europe/west/france",
      )
      self.assertNotEquals(client_fr.getDefaultRegionValue(), None)
    sequence.edit(
      vendor      = organisation_module.vendor,
      client_fr   = organisation_module.client_fr,
      client      = organisation_module.client_fr,
    )
431

432 433
  def stepCreateProducts(self, sequence, **kw) :
    """
434
      Create 2 kind of products, a notebook (Varianted)
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
      and a barebone not varianted.
    """
    product_module = self.getProductModule()
    if not hasattr(product_module, 'notebook') :
      # Create some products
      notebook = product_module.newContent(
        id = 'notebook',
        title = 'Notebook',
        portal_type = self.product_portal_type,
        product_line = 'storever/notebook',
        base_price = 3.0,
      )
      # sets some variation categories on the notebook product
      notebook.setVariationBaseCategoryList(["hd_size", "cpu_freq"])
      notebook.setVariationCategoryList([
        "cpu_freq/1Ghz",
        "cpu_freq/2Ghz",
        "hd_size/60Go",
        "hd_size/120Go",])
454

455 456 457 458 459 460 461 462 463 464 465 466 467
      barebone = product_module.newContent(
        id = 'barebone',
        title = 'Barebone',
        portal_type = self.product_portal_type,
        product_line = 'storever/barebone',
        base_price = 5.0,
      )
    sequence.edit(
      notebook = product_module.notebook,
      barebone = product_module.barebone,
      product_notebook = product_module.notebook,
      product_barebone = product_module.barebone,
    )
468

469 470 471 472 473 474 475 476 477 478
  def stepCreateCurrencies(self, sequence, **kw) :
    """
      Create EUR currency
    """
    currency_module = self.getCurrencyModule()
    if not hasattr(currency_module, 'EUR') :
      currency_module.newContent(
        id = 'EUR',
        title = 'Euro',
        portal_type = self.currency_portal_type,
479
        base_unit_quantity = .01,
480 481
      )
    sequence.edit(euro=currency_module.EUR, currency=currency_module.EUR)
482

483
  def stepCreatePaymentRule(self, sequence, **kw) :
484
    """ create a rule payment transaction generation """
485 486 487 488
    payment_rule = getattr(self.getRuleTool(),
                           'default_payment_simulation_rule')
    if payment_rule.getValidationState() == 'validated':
      payment_rule.invalidate()
489
      self.commit()
490 491 492 493 494

    # delete anything inside the rule first
    # clear the message queue, so that it does not contains unexistant paths
    self.tic()
    payment_rule.deleteContent(
495 496
      [x.getId() for x in payment_rule.objectValues(
      portal_type=['Predicate', self.accounting_rule_cell_portal_type])])
497
    self.commit()
498

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
499 500
    # and add a new predicate
    payment_rule.newContent(
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
      id = 'all',
      title = 'all',
      portal_type = self.predicate_portal_type,
      string_index = 'all',
      int_index = '1',
    )
    sequence.edit(payment_rule=payment_rule)

  def stepUpdatePaymentRuleMatrix(self, sequence, **kw) :
    """Creates/updates the matrix of the sale invoice transaction rule """
    payment_rule = sequence.get('payment_rule')

    # update the matrix, generates the accounting rule cells
    payment_rule.edit()
    payment_rule.updateMatrix()
    self.tic()

    # check the accounting rule cells inside the matrix
    cell_list = payment_rule.contentValues(
                filter = {'portal_type':self.accounting_rule_cell_portal_type})
    self.assertEqual(len(cell_list), 1)
    cell = cell_list[0]

524
    for line_id, line_source_id, line_destination_id in \
525 526
        self.payment_transaction_line_definition_list:
      line = cell.newContent(id=line_id,
527
          portal_type='Accounting Transaction Line',
528 529 530 531
          source=line_source_id,
          destination=line_destination_id)
    payment_rule.validate()
    self.tic()
532

Jérome Perrin's avatar
Jérome Perrin committed
533 534 535 536 537
  def stepCreateEmptyInvoice(self, sequence, **kw) :
    """ Create an empty invoice that will be modified later """
    vendor = sequence.get('vendor')
    client = sequence.get('client')
    currency = sequence.get('currency')
538

Jérome Perrin's avatar
Jérome Perrin committed
539 540
    empty_invoice = self.getAccountingModule().newContent(
                id = 'empty_invoice',
541
                portal_type = self.invoice_portal_type,
Jérome Perrin's avatar
Jérome Perrin committed
542 543 544 545 546
                resource = currency.getRelativeUrl(),
                stop_date = DateTime(2004, 01, 01),
                start_date = DateTime(2004, 01, 01),
                source_section = vendor.getRelativeUrl(),
                destination_section = client.getRelativeUrl(),
547
                created_by_builder = 1,
Jérome Perrin's avatar
Jérome Perrin committed
548
              )
549

550 551
    empty_invoice.setPaymentConditionEfficiency(1.0)

Jérome Perrin's avatar
Jérome Perrin committed
552 553 554 555
    sequence.edit(
      simple_invoice = empty_invoice,
      invoice = empty_invoice,
    )
556

557
  def stepCreateSimpleInvoice(self, sequence, **kw) :
558 559
    """ creates a simple sale invoice for non varianted notebook product.
      The invoice is from `vendor` to `client_fr`, so the cell defined in
560
      stepUpdateInvoiceTransactionRuleMatrix should match.
561 562 563 564 565 566 567
      This invoice containts one line, 10 notebook * 10 EUR, so total price
      is 100
    """
    vendor = sequence.get('vendor')
    client = sequence.get('client')
    product_notebook = sequence.get('product_notebook')
    currency = sequence.get('currency')
568

569 570
    simple_invoice = self.getAccountingModule().newContent(
                id = 'simple_invoice',
571
                portal_type = self.invoice_portal_type,
572
                resource = currency.getRelativeUrl(),
573
                price_currency = currency.getRelativeUrl(),
574 575 576 577
                stop_date = DateTime(2004, 01, 01),
                start_date = DateTime(2004, 01, 01),
                source_section = vendor.getRelativeUrl(),
                destination_section = client.getRelativeUrl(),
578
                created_by_builder = 1,
579
              )
580

581 582 583 584
    invoice_line = simple_invoice.newContent(
      id = 'invoice_line',
      resource = product_notebook.getRelativeUrl(),
      quantity = 10,
Jérome Perrin's avatar
Jérome Perrin committed
585
      price = 10,
586
      portal_type = self.invoice_line_portal_type)
587

588 589
    simple_invoice.setPaymentConditionEfficiency(1.0)

590
    self.assertEqual(invoice_line.getTotalPrice(), 100)
591

592 593 594 595 596 597
    sequence.edit(
      simple_invoice = simple_invoice,
      invoice = simple_invoice,
      invoice_line = invoice_line,
      invoice_lines = [invoice_line]
    )
598

599
  def stepCreateOtherSimpleInvoice(self, sequence, **kw) :
Jérome Perrin's avatar
Jérome Perrin committed
600 601 602 603 604 605 606
    """ creates a simple sale invoice for non varianted notebook product.
      It will contain one line that will later be changed.
    """
    vendor = sequence.get('vendor')
    client = sequence.get('client')
    product_notebook = sequence.get('product_notebook')
    currency = sequence.get('currency')
607

Jérome Perrin's avatar
Jérome Perrin committed
608 609
    simple_invoice = self.getAccountingModule().newContent(
                id = 'other_simple_invoice',
610
                portal_type = self.invoice_portal_type,
Jérome Perrin's avatar
Jérome Perrin committed
611 612 613 614 615
                resource = currency.getRelativeUrl(),
                stop_date = DateTime(2004, 01, 01),
                start_date = DateTime(2004, 01, 01),
                source_section = vendor.getRelativeUrl(),
                destination_section = client.getRelativeUrl(),
616
                created_by_builder = 1,
Jérome Perrin's avatar
Jérome Perrin committed
617
              )
618

Jérome Perrin's avatar
Jérome Perrin committed
619 620 621 622 623
    invoice_line = simple_invoice.newContent(
      id = 'invoice_line',
      resource = product_notebook.getRelativeUrl(),
      quantity = 123,
      price = 456,
624
      portal_type = self.invoice_line_portal_type)
Jérome Perrin's avatar
Jérome Perrin committed
625

626 627
    simple_invoice.setPaymentConditionEfficiency(1.0)

Jérome Perrin's avatar
Jérome Perrin committed
628 629 630 631 632 633 634 635
    sequence.edit(
      simple_invoice = simple_invoice,
      invoice = simple_invoice,
      invoice_line = invoice_line,
      invoice_lines = [invoice_line]
    )

  def stepAddInvoiceLine(self, sequence, **kw) :
636
    """ add an invoice line in the current invoice :
Jérome Perrin's avatar
Jérome Perrin committed
637 638 639 640
      10 notebook * 10 EUR, so total price is 100
    """
    product_notebook = sequence.get('product_notebook')
    invoice = sequence.get('invoice')
641

Jérome Perrin's avatar
Jérome Perrin committed
642 643
    invoice_line = invoice.newContent(
      id = 'invoice_line_%s'%(int(random.random()*1000)),
644
      portal_type = self.invoice_line_portal_type)
Jérome Perrin's avatar
Jérome Perrin committed
645

646 647 648 649 650
    invoice_line.edit(
      resource = product_notebook.getRelativeUrl(),
      quantity = 10,
      price = 10
    )
651

Jérome Perrin's avatar
Jérome Perrin committed
652
    self.assertEqual(invoice_line.getTotalPrice(), 100)
653

Jérome Perrin's avatar
Jérome Perrin committed
654 655 656 657 658 659
    sequence.edit(
      invoice_line = invoice_line,
      invoice_lines = [invoice_line]
    )

  def stepEditInvoiceLine(self, sequence, **kw) :
660
    """ edit the invoice line :
Jérome Perrin's avatar
Jérome Perrin committed
661 662 663 664 665 666 667
      10 notebook * 10 EUR, so total price is 100
    """
    invoice = sequence.get('invoice')
    invoice_line = sequence.get('invoice_line')
    invoice_line.edit(
      quantity = 10,
      price = 10)
668

Jérome Perrin's avatar
Jérome Perrin committed
669 670
    self.assertEqual(invoice_line.getTotalPrice(), 100)

671

Jérome Perrin's avatar
Jérome Perrin committed
672 673 674 675 676
  def stepDeleteInvoiceLine(self, sequence, **kw) :
    """ remove an invoice line from the invoice
    """
    invoice = sequence.get('invoice')
    invoice_line = sequence.get('invoice_line')
677 678
    invoice._delObject(invoice_line.getId())
    invoice.recursiveReindexObject()
679

680
  def stepCreateSimpleInvoiceTwoLines(self, sequence, **kw) :
681 682
    """
      similar to stepCreateSimpleInvoice, but replace
683 684 685 686 687 688 689
      "10 notebook * 10 EUR, so total price is 100" by :
      "5 notebook * 10 EUR + 5 notebook * 10 EUR , so total price is 100"
    """
    vendor = sequence.get('vendor')
    client = sequence.get('client')
    product_notebook = sequence.get('product_notebook')
    currency = sequence.get('currency')
690

691 692
    simple_invoice = self.getAccountingModule().newContent(
                id = 'simple_invoice_two_lines',
693
                portal_type = self.invoice_portal_type,
694 695 696 697 698
                resource = currency.getRelativeUrl(),
                stop_date = DateTime(2004, 01, 01),
                start_date = DateTime(2004, 01, 01),
                source_section = vendor.getRelativeUrl(),
                destination_section = client.getRelativeUrl(),
699
                created_by_builder = 1,
700
              )
701

702 703 704 705
    invoice_line1 = simple_invoice.newContent(
      id = 'invoice_line1',
      resource = product_notebook.getRelativeUrl(),
      quantity = 5,
Jérome Perrin's avatar
Jérome Perrin committed
706
      price = 10,
707
      portal_type = self.invoice_line_portal_type)
708 709
    invoice_line2 = simple_invoice.newContent(
      id = 'invoice_line2',
Jérome Perrin's avatar
Jérome Perrin committed
710
      REsource = product_notebook.getRelativeUrl(),
711
      quantity = 5,
Jérome Perrin's avatar
Jérome Perrin committed
712
      price = 10,
713
      portal_type = self.invoice_line_portal_type)
714

715 716
    simple_invoice.setPaymentConditionEfficiency(1.0)

717 718
    self.assertEqual(invoice_line1.getTotalPrice()
            + invoice_line2.getTotalPrice(), 100)
719

720 721 722 723 724 725
    sequence.edit(
      simple_invoice = simple_invoice,
      invoice = simple_invoice,
      invoice_lines = [invoice_line1, invoice_line2]
    )

726
  def stepCreateSimpleInvoiceTwoCells(self, sequence, **kw) :
727
    """
728
      similar to stepCreateSimpleInvoiceTwoLines, but use two
729
      differents cells on the same line instead of two differents lines.
Jérome Perrin's avatar
Jérome Perrin committed
730 731 732 733 734
    """
    vendor = sequence.get('vendor')
    client = sequence.get('client')
    product_notebook = sequence.get('product_notebook')
    currency = sequence.get('currency')
735

Jérome Perrin's avatar
Jérome Perrin committed
736 737
    simple_invoice = self.getAccountingModule().newContent(
                id = 'simple_invoice_two_cells',
738
                portal_type = self.invoice_portal_type,
Jérome Perrin's avatar
Jérome Perrin committed
739 740 741 742 743
                resource = currency.getRelativeUrl(),
                stop_date = DateTime(2004, 01, 01),
                start_date = DateTime(2004, 01, 01),
                source_section = vendor.getRelativeUrl(),
                destination_section = client.getRelativeUrl(),
744
                created_by_builder = 1,
Jérome Perrin's avatar
Jérome Perrin committed
745
              )
746

Jérome Perrin's avatar
Jérome Perrin committed
747 748 749
    invoice_line = simple_invoice.newContent(
      id = 'invoice_line',
      resource = product_notebook.getRelativeUrl(),
750
      portal_type = self.invoice_line_portal_type)
751

752 753
    simple_invoice.setPaymentConditionEfficiency(1.0)

Jérome Perrin's avatar
Jérome Perrin committed
754 755 756 757 758
    sequence.edit(
      simple_invoice = simple_invoice,
      invoice = simple_invoice,
      invoice_line = invoice_line,
      invoice_lines = [invoice_line]
759
    )
Jérome Perrin's avatar
Jérome Perrin committed
760 761 762 763 764 765
    self.stepAddCellsInInvoiceLine(sequence)

  def stepAddCellsInInvoiceLine(self, sequence, **kw):
    """ add 2 cells in the invoice line, same quantity as simple invoice
    """
    invoice_line = sequence.get('invoice_line')
766

Jérome Perrin's avatar
Jérome Perrin committed
767 768 769 770 771 772 773 774
    # initialy, the line must not contain cells
    self.assertEqual(len(invoice_line.objectIds()), 0)
    invoice_line._setVariationBaseCategoryList(['hd_size', 'cpu_freq'])
    invoice_line._setVariationCategoryList(
                    ['hd_size/60Go', 'hd_size/120Go', 'cpu_freq/1Ghz' ])
    base_id = 'movement'
    invoice_line.updateCellRange(base_id)
    cell_key_list = list(invoice_line.getCellKeyList(base_id = base_id))
775

Jérome Perrin's avatar
Jérome Perrin committed
776 777 778 779 780
    # this is probably not the easiest way to create cells ...
    price = 10
    quantity = 5
    for cell_key in cell_key_list:
      cell = invoice_line.newCell(base_id = base_id,
781
             portal_type = self.invoice_cell_portal_type, *cell_key)
Jérome Perrin's avatar
Jérome Perrin committed
782 783 784 785
      cell.edit(mapped_value_property_list = ['price','quantity'],
                price = price, quantity = quantity,
                predicate_category_list = cell_key,
                variation_category_list = cell_key)
786

Jérome Perrin's avatar
Jérome Perrin committed
787 788
    # getTotalPrice uses mysql, so we must make sure the invoice is cataloged
    # to have correct results
789
    invoice_line.getParentValue().recursiveImmediateReindexObject()
Jérome Perrin's avatar
Jérome Perrin committed
790 791
    self.assertEqual(invoice_line.getTotalPrice(), 100)
    self.assertEqual(invoice_line.getTotalQuantity(), 10)
792

Jérome Perrin's avatar
Jérome Perrin committed
793 794 795
    # then we must have 2 cells inside our line
    self.assertEqual(len(invoice_line.objectIds()), 2)

796
  def stepCreateMultiLineInvoice(self, sequence, **kw) :
797
    """ create an invoice with varianted products
798 799
      The invoice is from `vendor` to `client_fr`, so the cell defined in
      This invoice containts two lines :
800
      10 notebook * 10 EUR, so total price is 100
801
            (matched by product_notebook_region_france_cell)
802
      10 barebone * 100 EUR, so total price is 1000
803 804 805 806 807 808 809 810
            (matched by product_notebook_region_france_cell)
      total price for the invoice is 100 + 1000
    """
    vendor = sequence.get('vendor')
    client = sequence.get('client')
    product_notebook = sequence.get('product_notebook')
    product_barebone = sequence.get('product_barebone')
    currency = sequence.get('currency')
811

812 813
    multi_line_invoice = self.getAccountingModule().newContent(
                id = 'multi_line_invoice',
814
                portal_type = self.invoice_portal_type,
815 816 817 818 819 820
                resource = currency.getRelativeUrl(),
                price_currency = currency.getRelativeUrl(),
                stop_date = DateTime(2004, 01, 01),
                start_date = DateTime(2004, 01, 01),
                source_section = vendor.getRelativeUrl(),
                destination_section = client.getRelativeUrl(),
821
                created_by_builder = 1,
822
              )
823

824
    notebook_line = multi_line_invoice.newContent(
825
      portal_type = self.invoice_line_portal_type,
826 827 828 829 830 831
      id = 'notebook_line',
      resource = product_notebook.getRelativeUrl(),
      quantity = 10,
      price = 10)

    barebone_line = multi_line_invoice.newContent(
832
      portal_type = self.invoice_line_portal_type,
833 834 835 836 837
      id = 'barebone_line',
      resource = product_barebone.getRelativeUrl(),
      quantity = 10,
      price = 100)

838 839
    multi_line_invoice.setPaymentConditionEfficiency(1.0)

840 841
    self.assertEqual( 10*10 + 10*100,
        notebook_line.getTotalPrice() + barebone_line.getTotalPrice())
842

843 844 845 846 847
    sequence.edit(
      multi_line_invoice = multi_line_invoice,
      invoice = multi_line_invoice,
      invoice_lines = [notebook_line, barebone_line],
    )
848

849 850 851 852 853 854 855 856 857 858 859 860 861
  def stepCheckAddPredicate(self, sequence, **kw) :
    invoice_transaction_rule = sequence.get('invoice_transaction_rule')
    # next, we add a predicate to see if it is still okay (3x2 cells)
    predicate_product3 = invoice_transaction_rule.newContent(
      id = 'product_3',
      title = 'product_3',
      portal_type = self.predicate_portal_type,
      string_index = 'product',
      int_index = '3',
      membership_criterion_base_category_list = ['product_line',],
      membership_criterion_category_list = ['product_line/storever/openbrick'],
    )
    invoice_transaction_rule.updateMatrix()
862
    self.tic()
863 864 865 866 867 868 869 870 871 872 873 874 875
    cell_list = invoice_transaction_rule.contentValues(
        filter = {'portal_type': self.accounting_rule_cell_portal_type})
    self.assertEqual(len(cell_list), 6)

  def stepCheckRemovePredicate(self, sequence, **kw) :
    invoice_transaction_rule = sequence.get('invoice_transaction_rule')
    self.tic() # make sure message queue is empty
    # then, we remove a predicate and check again (3x3 cells)
    invoice_transaction_rule.deleteContent(id = 'region_africa')
    invoice_transaction_rule.updateMatrix()
    cell_list = invoice_transaction_rule.contentValues(
                 filter = {'portal_type':self.accounting_rule_cell_portal_type})
    self.assertEqual(len(cell_list), 3)
876

877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
  def stepCheckRestoreOriginalPredicates(self, sequence, **kw) :
    """ we put back the matrix in the original format (2x2 cells) """
    invoice_transaction_rule = sequence.get("invoice_transaction_rule")
    self.tic() # make sure message queue is empty
    invoice_transaction_rule.deleteContent(id='product_3')
    predicate_region_africa = invoice_transaction_rule.newContent(
      id = 'region_africa', title = 'Region Africa',
      portal_type = self.predicate_portal_type,
      string_index = 'region', int_index = '2',
      membership_criterion_base_category_list = ['destination_region',],
      membership_criterion_category_list = ['destination_region/region/africa'],
    )
    invoice_transaction_rule.updateMatrix()
    cell_list = invoice_transaction_rule.contentValues(
        filter = {'portal_type':self.accounting_rule_cell_portal_type})
    self.assertEqual(len(cell_list), 4)
893

894 895 896 897 898 899
  def stepCreateDummyInvoice(self, sequence, **kw) :
    """ Create a dummy invoice for temp movements """
    invoice = self.getAccountingModule().newContent(
                      id = "dummy_invoice",
                   )
    sequence.edit(invoice = invoice)
900

901
  def stepCreateMatchableInvoiceMovements(self, sequence, **kw) :
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
    """ Create a temp movement that will be matched by the
      default_invoice_transaction_rule """
    from Products.ERP5Type.Document import newTempMovement
    product_notebook_region_france_movement = newTempMovement(
      sequence.get('invoice'),
      'test1',
      resource = sequence.get('notebook').getRelativeUrl(),
      destination = sequence.get('client_fr').getRelativeUrl(),
    )
    product_barebone_region_france_movement = newTempMovement(
      sequence.get('invoice'),
      'test2',
      resource = sequence.get('barebone').getRelativeUrl(),
      destination = sequence.get('client_fr').getRelativeUrl(),
    )
    sequence.edit(
      product_notebook_region_france_movement =
                  product_notebook_region_france_movement ,
      product_barebone_region_france_movement =
                  product_barebone_region_france_movement ,
    )
923

924
  def stepCheckMatchableInvoiceMovements(self, sequence, **kw) :
925 926 927 928 929 930
    """ Check that we have a matching cell for the movement """
    invoice_transaction_rule = sequence.get("invoice_transaction_rule")
    product_barebone_region_france_movement  = sequence.get(
                          'product_barebone_region_france_movement')
    product_notebook_region_france_movement  = sequence.get(
                          'product_notebook_region_france_movement')
931

932 933 934 935 936 937 938
    # Make sure acquisition is working for destination_region
    self.assertEqual(
          product_barebone_region_france_movement.getDestinationRegion(),
          'region/europe/west/france')
    self.assertEqual(
          product_notebook_region_france_movement.getDestinationRegion(),
          'region/europe/west/france')
939

940 941 942 943 944
    # Make sure category is working for resource
    self.assertEqual(product_barebone_region_france_movement.getProductLine(),
            'storever/barebone')
    self.assertEqual(product_notebook_region_france_movement.getProductLine(),
            'storever/notebook')
945 946

    # check the predicates
947 948 949 950
    predicate_product_notebook = sequence.get("predicate_product_notebook")
    predicate_product_barebone = sequence.get("predicate_product_barebone")
    predicate_region_france  = sequence.get("predicate_region_france")
    predicate_region_africa  = sequence.get("predicate_region_africa")
951

952 953 954 955 956 957 958 959
    self.assert_(not predicate_region_africa.test(
                      product_barebone_region_france_movement ))
    self.assert_( predicate_region_france.test(
                      product_barebone_region_france_movement ))
    self.assert_(not predicate_product_notebook.test(
                      product_barebone_region_france_movement ))
    self.assert_( predicate_product_barebone.test(
                      product_barebone_region_france_movement ))
960

961 962 963 964 965 966 967 968
    self.assert_(not predicate_region_africa.test(
                      product_notebook_region_france_movement ))
    self.assert_( predicate_region_france.test(
                      product_notebook_region_france_movement ))
    self.assert_(not predicate_product_barebone.test(
                      product_notebook_region_france_movement ))
    self.assert_( predicate_product_notebook.test(
                      product_notebook_region_france_movement ))
969

970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
    # check the cells
    product_notebook_region_france_cell = sequence.get(
                     'product_notebook_region_france_cell')
    product_barebone_region_france_cell = sequence.get(
                     'product_barebone_region_france_cell')
    product_notebook_region_africa_cell = sequence.get(
                     'product_notebook_region_africa_cell')
    product_barebone_region_africa_cell = sequence.get(
                     'product_barebone_region_africa_cell')
    self.assert_(not product_notebook_region_france_cell.test(
                        product_barebone_region_france_movement ))
    self.assert_(    product_barebone_region_france_cell.test(
                        product_barebone_region_france_movement ))
    self.assert_(not product_notebook_region_africa_cell.test(
                        product_barebone_region_france_movement ))
    self.assert_(not product_barebone_region_africa_cell.test(
                        product_barebone_region_france_movement ))
987

988 989 990 991 992 993 994 995
    self.assert_(    product_notebook_region_france_cell.test(
                        product_notebook_region_france_movement ))
    self.assert_(not product_barebone_region_france_cell.test(
                        product_notebook_region_france_movement ))
    self.assert_(not product_notebook_region_africa_cell.test(
                        product_notebook_region_france_movement ))
    self.assert_(not product_barebone_region_africa_cell.test(
                        product_notebook_region_france_movement ))
996

997 998 999 1000 1001 1002 1003
    # finally check the matching cell is the good one
    self.assertEquals(product_notebook_region_france_cell,
              invoice_transaction_rule._getMatchingCell(
                product_notebook_region_france_movement ))
    self.assertEqual(product_barebone_region_france_cell,
              invoice_transaction_rule._getMatchingCell(
                product_barebone_region_france_movement ))
1004

1005
  def stepCreateNotMatchableInvoiceMovements(self, sequence, **kw) :
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
    """ create a temp movement that not any cell could match. """
    from Products.ERP5Type.Document import newTempMovement
    bad_movement1 = newTempMovement(
      sequence.get("invoice"),
      'test3',
      product = None,
      destination = sequence.get('client').getRelativeUrl(),
    )
    bad_movement2 = newTempMovement(
      sequence.get("invoice"),
      'test4',
      gap = 'gap/1',
      destination = sequence.get('client').getRelativeUrl(),
    )
    sequence.edit(
      bad_movement1 = bad_movement1,
      bad_movement2 = bad_movement2,
    )

1025
  def stepCheckNotMatchableInvoiceMovements(self, sequence, **kw) :
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
    """ check that temp movement that cannot be matched is not matched. """
    invoice_transaction_rule = sequence.get('invoice_transaction_rule')
    self.assertEqual(None,
      invoice_transaction_rule._getMatchingCell(
        sequence.get('bad_movement1')))
    self.assertEqual(None,
      invoice_transaction_rule._getMatchingCell(
        sequence.get('bad_movement2')))

  def stepClearSimulation(self, sequence, **kw) :
    """ clear the content of portal_simulation """
    self.tic() # make sure message queue is empty
    self.getSimulationTool().deleteContent(
        list(self.getSimulationTool().objectIds()))
1040

1041 1042 1043 1044 1045 1046
  def stepClearAccountingModule(self, sequence, **kw) :
    """ clear the content of accounting module """
    self.tic() # make sure message queue is empty
    # delete
    self.getAccountingModule().deleteContent(
        list(self.getAccountingModule().objectIds()))
1047

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
  def stepCheckFirstRuleIsApplied(self, sequence, **kw) :
    """ check every level of the simulation """
    invoice = sequence.get('invoice')
    invoice_line = sequence.get('invoice_line')
    invoice_transaction_rule = sequence.get('invoice_transaction_rule')
    vendor = sequence.get('vendor')
    client = sequence.get('client')
    currency = sequence.get('currency')
    invoice_transaction_rule_cell = sequence.get(
                                  'invoice_transaction_rule_cell')
1058

1059 1060
    # content of the simulation tool is a list of invoice rules
    applied_rule_list = self.getSimulationTool().contentValues()
1061

1062 1063 1064 1065
    self.assertEqual(len(applied_rule_list), 1)
    applied_rule = applied_rule_list[0]
    self.assertEqual( applied_rule.getPortalType(),
                      self.applied_rule_portal_type)
1066 1067
    self.assertEqual( applied_rule.getSpecialiseReference(),
                      'default_invoice_rule')
1068 1069
    self.assertEqual( applied_rule.getCausality(),
                      invoice.getRelativeUrl())
1070

1071 1072 1073
    # inside the rule there are simulation movements
    simulation_movement_list = applied_rule.contentValues()
    # the first one is a mirror of the movement in the invoice line
1074 1075 1076 1077 1078
    # this applied rule can also contain movement related to those
    # created in the init script, so we only take into account sim.
    # movement linked to an invoice line
    invoice_line_simulation_movement_list = []
    for simulation_movement in simulation_movement_list :
1079 1080
      self.assertNotEquals(simulation_movement.getDeliveryValue(), None)
      if simulation_movement.getDeliveryValue().getPortalType() == \
1081
              self.invoice_line_portal_type :
1082
        invoice_line_simulation_movement_list.append(simulation_movement)
1083

1084 1085
    self.assertEqual( len(invoice_line_simulation_movement_list), 1)
    simulation_movement = invoice_line_simulation_movement_list[0]
1086

1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
    self.assertEqual( simulation_movement.getPortalType(),
                      self.simulation_movement_portal_type)
    self.assertEqual( invoice_line.getResource(),
                      simulation_movement.getResource())
    self.assertEqual( invoice_line.getQuantity(),
                      simulation_movement.getQuantity())
    self.assertEqual( invoice_line.getStopDate(),
                      simulation_movement.getStopDate())
    self.assertEqual( invoice_line.getStartDate(),
                      simulation_movement.getStartDate())
    self.assertEqual( invoice_line.getSourceSection(),
                      simulation_movement.getSourceSection())
    self.assertEqual( invoice_line.getDestinationSection(),
                      simulation_movement.getDestinationSection())
    self.assertEqual( invoice_line.getSource(),
                      simulation_movement.getSource())
    self.assertEqual( invoice_line.getDestination(),
                      simulation_movement.getDestination())
1105

1106 1107
    # inside this movement there are applied rules which specialize
    # invoice_transaction_rule and trade_model_rule...
1108
    applied_rule_list = simulation_movement.contentValues()
1109 1110
    self.assertEquals( len(applied_rule_list), 2)
    # ...but only invoice_transaction_rule is interesting
1111 1112
    applied_rule = [applied_rule for applied_rule in applied_rule_list if
      applied_rule.getSpecialiseValue().getPortalType() ==
1113
      'Invoice Transaction Simulation Rule'][0]
1114 1115 1116 1117
    self.assertEquals( applied_rule.getPortalType(),
                      self.applied_rule_portal_type)
    self.assertEquals( applied_rule.getSpecialise(),
                      invoice_transaction_rule.getRelativeUrl())
1118 1119

    # and in this applied rule, we got simulation movements,
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
    # based on those inside product_notebook_region_france_cell
    simulation_movement_list = applied_rule.contentValues()
    self.assertEqual( len(simulation_movement_list), 3)
    rule_movement_found = {}
    for simulation_movement in simulation_movement_list :
      self.assertEquals( simulation_movement.getSourceSection(),
                        vendor.getRelativeUrl())
      self.assertEquals( simulation_movement.getDestinationSection(),
                        client.getRelativeUrl())
      self.assertEquals( simulation_movement.getResource(),
                        currency.getRelativeUrl())
      self.assertEquals( simulation_movement.getCausalityState(),
                         'expanded')
      for rule_movement in invoice_transaction_rule_cell.contentValues() :
        if simulation_movement.getSource() == rule_movement.getSource() :
          rule_movement_found[rule_movement.getSource()] = 1
          self.assertEquals(simulation_movement.getQuantity(),
                rule_movement.getQuantity() * invoice_line.getTotalPrice())
          self.assertEquals(simulation_movement.getSourceCredit(),
                rule_movement.getSourceCredit() * invoice_line.getTotalPrice())
          self.assertEquals(simulation_movement.getSourceDebit(),
                rule_movement.getSourceDebit() * invoice_line.getTotalPrice())
      self.assert_(len(rule_movement_found.keys()), 3)
    sequence.edit( simulation_movement_list = simulation_movement_list )

1145

Jérome Perrin's avatar
Jérome Perrin committed
1146 1147 1148 1149
  def stepCollectSimulationMovements(self, sequence, **kw) :
    """ put some simulation movements in sequence for later checkings """
    invoice = sequence.get('invoice')
    invoice_line = sequence.get('invoice_line')
1150

Jérome Perrin's avatar
Jérome Perrin committed
1151 1152 1153 1154 1155 1156 1157
    applied_rule_list = self.getSimulationTool().contentValues()
    self.assertEquals(len(applied_rule_list), 1)
    simulation_movement_list = []
    simulation_movement_quantities = {}
    simulation_movement_resources = {}
    simulation_movement_paths = {}
    simulation_movement_section_paths = {}
1158

Jérome Perrin's avatar
Jérome Perrin committed
1159 1160 1161 1162 1163 1164
    applied_rule = applied_rule_list[0]
    for invoice_simulation_movement in applied_rule.objectValues() :
      for invoice_transaction_applied_rule in \
                        invoice_simulation_movement.objectValues() :
        for simulation_movement in \
                   invoice_transaction_applied_rule.objectValues() :
1165
          path = simulation_movement.getPath()
Jérome Perrin's avatar
Jérome Perrin committed
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
          simulation_movement_list.append(simulation_movement)
          simulation_movement_quantities[path] = \
                                    simulation_movement.getQuantity()
          simulation_movement_resources[path] = \
                                    simulation_movement.getResource()
          simulation_movement_paths[path] = (
                      simulation_movement.getSource(),
                      simulation_movement.getDestination())
          simulation_movement_section_paths[path] = (
                      simulation_movement.getSourceSection(),
                      simulation_movement.getDestinationSection())
    sequence.edit(
         simulation_movement_list = simulation_movement_list
      ,  simulation_movement_quantities = simulation_movement_quantities
      ,  simulation_movement_resources = simulation_movement_resources
      ,  simulation_movement_paths = simulation_movement_paths
      ,  simulation_movement_section_paths = simulation_movement_section_paths
    )

  def stepCheckSimulationMovements(self, sequence, **kw) :
    """ checks simulation movements from the sequence object """
    simulation_movement_list = sequence.get(
                                        'simulation_movement_list')
    simulation_movement_quantities = sequence.get(
                                  'simulation_movement_quantities')
    simulation_movement_resources = sequence.get(
                                   'simulation_movement_resources')
    simulation_movement_paths = sequence.get(
                                       'simulation_movement_paths')
    simulation_movement_section_paths = sequence.get(
                               'simulation_movement_section_paths')
1197

Jérome Perrin's avatar
Jérome Perrin committed
1198
    for simulation_movement in simulation_movement_list :
1199
      path = simulation_movement.getPath()
Jérome Perrin's avatar
Jérome Perrin committed
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
      self.assertEquals(
        simulation_movement.getQuantity(),
        simulation_movement_quantities[path]
      )
      self.assertEquals(
        simulation_movement.getResource(),
        simulation_movement_resources[path]
      )
      self.assertEquals(
        (simulation_movement.getSource(), simulation_movement.getDestination()),
        simulation_movement_paths[path]
      )
      self.assertEquals(
           ( simulation_movement.getSourceSection(),
             simulation_movement.getDestinationSection()),
        simulation_movement_section_paths[path]
      )
1217

1218 1219 1220
  def stepCheckPaymentRuleIsApplied(self, sequence, **kw) :
    """ checks that a payment rule is applied for the total amount
      of receivable """
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
    invoice_line = sequence.get('invoice_line')
    simulation_movement = invoice_line.getDeliveryRelatedValue()
    applied_rule_list = simulation_movement.objectValues()
    # Invoice Transaction Rule and Trade Model Rule
    self.assertEquals(2, len(applied_rule_list))
    applied_rule = [x for x in applied_rule_list \
                    if x.getSpecialiseReference() == \
                    'default_invoice_transaction_rule'][0]
    simulation_movement_list = [x for x in applied_rule.objectValues() \
                                if x.getSourceTitle() in ('Receivable',
                                                          'Payable')]
    self.assertEquals(1, len(simulation_movement_list))
    simulation_movement = simulation_movement_list[0]
    applied_rule_list = simulation_movement.objectValues()
    self.assertEquals(1, len(applied_rule_list))
    payment_applied_rule = applied_rule_list[0]
1237

Jérome Perrin's avatar
Jérome Perrin committed
1238
  def stepPlanInvoice(self, sequence, **kw) :
1239
    """ put the invoice in the `planned` state, which will
Jérome Perrin's avatar
Jérome Perrin committed
1240 1241 1242 1243
      start the simulation process. """
    invoice = sequence.get('invoice')
    self.getPortal().portal_workflow.doActionFor(
      invoice, 'plan_action',
1244
      skip_period_validation=1
Jérome Perrin's avatar
Jérome Perrin committed
1245 1246
    )
    self.assertEquals(invoice.getSimulationState(), 'planned')
1247 1248

  def stepConfirmInvoice(self, sequence, **kw) :
1249 1250 1251
    """ put the invoice in the `confirmed` state, which does nothing specific,
    the delivery builder is invoked when starting the invoice.
    """
1252 1253 1254
    invoice = sequence.get('invoice')
    self.getPortal().portal_workflow.doActionFor(
      invoice, 'confirm_action',
1255 1256
      wf_id = 'accounting_workflow',
      skip_period_validation = 1
1257 1258
    )
    self.assertEquals(invoice.getSimulationState(), 'confirmed')
1259

1260 1261 1262 1263
  def stepCheckNoAccountingLinesBuiltYet(self, sequence, **kw) :
    invoice = sequence.get('invoice')
    self.assertEquals(0, len(invoice.getMovementList(
                    portal_type=invoice.getPortalAccountingMovementTypeList())))
1264

1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
  def stepStartInvoice(self, sequence, **kw) :
    """ put the invoice in the `started` state, which starts the delivery
    builder.
    """
    invoice = sequence.get('invoice')
    self.getPortal().portal_workflow.doActionFor(
      invoice, 'start_action',
      wf_id = 'accounting_workflow',
      skip_period_validation = 1
    )
    self.assertEquals(invoice.getSimulationState(), 'started')

1277
  def stepCheckAccountingLinesCoherantWithSimulation(self, sequence, **kw) :
1278
    """ checks that accounting lines are created on the sale invoice
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
    transaction """
    invoice  = sequence.get('invoice')
    vendor   = sequence.get('vendor')
    client   = sequence.get('client')
    currency = sequence.get('currency')
    invoice_line = sequence.get('invoice_line')
    simulation_movement_list = sequence.get('simulation_movement_list')
    invoice_transaction_rule_cell = sequence.get(
                          'invoice_transaction_rule_cell')
    invoice_transaction_line_list = invoice.contentValues(
        filter = {'portal_type':
1290
                  self.invoice_transaction_line_portal_type})
1291 1292
    self.assertEquals( len(invoice_transaction_line_list),
                       len(simulation_movement_list))
1293

1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
    simulation_movement_found = {}
    for invoice_transaction_line in invoice_transaction_line_list :
      self.assertEquals( invoice_transaction_line.getSourceSection(),
                         vendor.getRelativeUrl())
      self.assertEquals( invoice_transaction_line.getDestinationSection(),
                         client.getRelativeUrl())
      self.assertEquals( invoice_transaction_line.getResource(),
                         currency.getRelativeUrl())
      for simulation_movement in simulation_movement_list :
        if simulation_movement.getSource() == \
                            invoice_transaction_line.getSource() :
          simulation_movement_found[simulation_movement.getSource()] = 1
          self.assertEquals(simulation_movement.getQuantity(),
                            invoice_transaction_line.getQuantity())
          self.assertEquals(simulation_movement.getSourceCredit(),
                            invoice_transaction_line.getSourceCredit())
          self.assertEquals(simulation_movement.getSourceDebit(),
                            invoice_transaction_line.getSourceDebit())
1312

1313 1314 1315
          self.assertEquals(simulation_movement.getDelivery(),
                            invoice_transaction_line.getRelativeUrl())
      self.assert_(len(simulation_movement_found.keys()), 3)
1316 1317


1318 1319
  def stepCheckAccountingLinesCreatedForSimpleInvoice(
            self, sequence, **kw) :
1320
    """ Checks that accounting lines are created on the sale invoice
1321 1322 1323
    transaction and that all movement are correctly aggregated.
    The price of the invoice was 100, it should result in the following
    accounting layout :
1324

1325 1326 1327 1328 1329
      ===============   =======   =======
      account           Debit     Credit
      ===============   =======   =======
      income                       100
      collected_vat                 19.60
1330
      receivable         119.60
1331 1332 1333 1334 1335 1336 1337
      ===============   =======   =======
    """
    invoice  = sequence.get('invoice')
    vendor   = sequence.get('vendor')
    client   = sequence.get('client')
    currency = sequence.get('currency')
    invoice_lines = sequence.get('invoice_lines')
1338

1339
    invoice_transaction_line_list = invoice.contentValues(
1340
        filter = {'portal_type': self.invoice_transaction_line_portal_type})
1341
    self.assertEquals(len(invoice_transaction_line_list), 3)
1342

1343 1344 1345 1346 1347
    accounting_lines_layout = {
      'income'            : (0, 100),
      'collected_vat'     : (0, 19.60),
      'receivable'        : (119.60, 0),
    }
1348

1349
    for invoice_transaction_line in invoice_transaction_line_list :
1350 1351 1352
      self.assert_(
          invoice_transaction_line.getSourceId() in accounting_lines_layout.keys(),
          'unexepected source_id %s' % invoice_transaction_line.getSourceId())
Jérome Perrin's avatar
Jérome Perrin committed
1353 1354
      debit, credit = accounting_lines_layout[
                            invoice_transaction_line.getSourceId()]
1355 1356
      self.assertEquals(debit, invoice_transaction_line.getSourceDebit())
      self.assertEquals(credit, invoice_transaction_line.getSourceCredit())
1357 1358 1359
      self.assertNotEquals(
              len(invoice_transaction_line.getDeliveryRelatedValueList(
                              portal_type='Simulation Movement')), 0)
1360

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387
  def stepCheckPaymentLinesCreatedForSimpleInvoice(
            self, sequence, **kw) :
    """ Checks that payment transaction lines are created on the payment
    transaction and that all movement are correctly aggregated.  The
    price of the invoice was 100, it should result in the following
    accounting layout :

      ===============   =======   =======
      account           Debit     Credit
      ===============   =======   =======
      receivable                   119.60
      bank               119.60
      ===============   =======   =======
    """
    payment  = sequence.get('invoice').getCausalityRelatedValue(
        portal_type='Payment Transaction')

    payment_transaction_line_list = payment.contentValues(
        filter = {'portal_type': self.payment_transaction_line_portal_type})
    self.assertEquals(len(payment_transaction_line_list), 2)

    accounting_lines_layout = {
      'receivable'        : (0, 119.60),
      'bank'              : (119.60, 0),
    }

    for payment_transaction_line in payment_transaction_line_list :
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
      if _isMirrored(payment_transaction_line):
        self.assert_(
            payment_transaction_line.getDestinationId() in accounting_lines_layout.keys(),
            'unexepected destination_id %s' % payment_transaction_line.getDestinationId())
        debit, credit = accounting_lines_layout[
                              payment_transaction_line.getDestinationId()]
        self.assertEquals(debit, payment_transaction_line.getDestinationDebit())
        self.assertEquals(credit, payment_transaction_line.getDestinationCredit())
        self.assertNotEquals(
                len(payment_transaction_line.getDeliveryRelatedValueList(
                                portal_type='Simulation Movement')), 0)
      else:
        self.assert_(
            payment_transaction_line.getSourceId() in accounting_lines_layout.keys(),
            'unexepected source_id %s' % payment_transaction_line.getSourceId())
        debit, credit = accounting_lines_layout[
                              payment_transaction_line.getSourceId()]
        self.assertEquals(debit, payment_transaction_line.getSourceDebit())
        self.assertEquals(credit, payment_transaction_line.getSourceCredit())
        self.assertNotEquals(
                len(payment_transaction_line.getDeliveryRelatedValueList(
                                portal_type='Simulation Movement')), 0)
1410

1411 1412
  def stepCheckAccountingLinesCreatedForMultiLineInvoice(
            self, sequence, **kw) :
1413
    """ Checks that accounting lines are created on the sale invoice
1414 1415 1416
    transaction and that all movement are correctly aggregated.
    The price of the invoice was 1100, it should result in the following
    accounting layout :
1417

1418 1419 1420 1421 1422 1423
      ===============   =======   =======
      account           Debit     Credit
      ===============   =======   =======
      income                       100
      income_barebone              1000
      collected_vat                215.60
1424
      receivable        1315.60
1425 1426 1427 1428 1429 1430 1431
      ===============   =======   =======
    """
    invoice  = sequence.get('invoice')
    vendor   = sequence.get('vendor')
    client   = sequence.get('client')
    currency = sequence.get('currency')
    invoice_lines = sequence.get('invoice_lines')
1432

1433
    invoice_transaction_line_list = invoice.contentValues(
1434
        filter = {'portal_type': self.invoice_transaction_line_portal_type})
1435
    self.assertEquals(len(invoice_transaction_line_list), 4)
1436

1437 1438 1439 1440 1441 1442
    accounting_lines_layout = {
      'income'            : (0, 100),
      'income_barebone'   : (0, 1000),
      'collected_vat'     : (0, 215.60),
      'receivable'        : (1315.60, 0),
    }
1443

1444
    for invoice_transaction_line in invoice_transaction_line_list :
Jérome Perrin's avatar
Jérome Perrin committed
1445 1446
      debit, credit = accounting_lines_layout[
                                    invoice_transaction_line.getSourceId()]
1447 1448
      self.assertEquals(debit, invoice_transaction_line.getSourceDebit())
      self.assertEquals(credit, invoice_transaction_line.getSourceCredit())
1449 1450 1451
      self.assertNotEquals(
              len(invoice_transaction_line.getDeliveryRelatedValueList(
                              portal_type='Simulation Movement')), 0)
Jérome Perrin's avatar
Jérome Perrin committed
1452

1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
  def stepCheckPaymentLinesCreatedForMultiLineInvoice(
            self, sequence, **kw) :
    """ Checks that payment transaction lines are created on the payment
    transaction and that all movement are correctly aggregated.  The
    price of the invoice was 100, it should result in the following
    accounting layout :

      ===============   =======   =======
      account           Debit     Credit
      ===============   =======   =======
      receivable                  1315.60
      bank              1315.60
      ===============   =======   =======
    """
    payment  = sequence.get('invoice').getCausalityRelatedValue(
        portal_type='Payment Transaction')

    payment_transaction_line_list = payment.contentValues(
        filter = {'portal_type': self.payment_transaction_line_portal_type})
    self.assertEquals(len(payment_transaction_line_list), 2)

    accounting_lines_layout = {
      'receivable'        : (0, 1315.60),
      'bank'              : (1315.60, 0),
    }

    for payment_transaction_line in payment_transaction_line_list :
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
      if _isMirrored(payment_transaction_line):
        self.assert_(
            payment_transaction_line.getDestinationId() in accounting_lines_layout.keys(),
            'unexepected source_id %s' % payment_transaction_line.getDestinationId())
        debit, credit = accounting_lines_layout[
                              payment_transaction_line.getDestinationId()]
        self.assertEquals(debit, payment_transaction_line.getDestinationDebit())
        self.assertEquals(credit, payment_transaction_line.getDestinationCredit())
        self.assertNotEquals(
                len(payment_transaction_line.getDeliveryRelatedValueList(
                                portal_type='Simulation Movement')), 0)
      else:
        self.assert_(
            payment_transaction_line.getSourceId() in accounting_lines_layout.keys(),
            'unexepected source_id %s' % payment_transaction_line.getSourceId())
        debit, credit = accounting_lines_layout[
                              payment_transaction_line.getSourceId()]
        self.assertEquals(debit, payment_transaction_line.getSourceDebit())
        self.assertEquals(credit, payment_transaction_line.getSourceCredit())
        self.assertNotEquals(
                len(payment_transaction_line.getDeliveryRelatedValueList(
                                portal_type='Simulation Movement')), 0)
1502

Jérome Perrin's avatar
Jérome Perrin committed
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
  def stepRebuildAndCheckNothingIsCreated(self, sequence, **kw) :
    """ Calls the DeliveryBuilder again and checks that the accounting module
    remains unchanged.
    """
    accounting_transaction_count = len(self.getAccountingModule().objectIds())
    accounting_lines_dict = {}
    for transaction in self.getAccountingModule().objectValues():
      transaction_dict = {}
      for accounting_line in transaction.objectValues() :
        if accounting_line.getPortalType() != \
1513
                          self.invoice_line_portal_type :
Jérome Perrin's avatar
Jérome Perrin committed
1514 1515 1516
          transaction_dict[accounting_line.getId()] = \
                accounting_line.getTotalQuantity()
      accounting_lines_dict[transaction.getId()] = transaction_dict
1517

Jérome Perrin's avatar
Jérome Perrin committed
1518 1519 1520 1521 1522 1523
    # reindex the simulation for testing purposes
    self.getSimulationTool().recursiveReindexObject()
    self.tic()
    delivery_tool = self.getPortal().portal_deliveries
    # and build again ...
    delivery_tool.sale_invoice_transaction_builder.build()
1524 1525
    delivery_tool.purchase_invoice_transaction_builder.build()
    delivery_tool.payment_transaction_builder.build()
Jérome Perrin's avatar
Jérome Perrin committed
1526 1527 1528 1529
    if hasattr(delivery_tool, 'pay_sheet_transaction_builder') :
      # TODO: conflict with pay_sheet_transaction_builder must be tested too
      delivery_tool.pay_sheet_transaction_builder.build()
    self.tic()
1530

Jérome Perrin's avatar
Jérome Perrin committed
1531 1532 1533
    # nothing should have changed
    self.assertEquals(accounting_transaction_count,
            len(self.getAccountingModule().objectIds()))
1534

Jérome Perrin's avatar
Jérome Perrin committed
1535 1536 1537 1538
    for transaction in self.getAccountingModule().objectValues() :
      transaction_dict = accounting_lines_dict[transaction.getId()]
      for accounting_line in transaction.objectValues() :
        if accounting_line.getPortalType() != \
1539
                          self.invoice_line_portal_type :
Jérome Perrin's avatar
Jérome Perrin committed
1540 1541 1542
          self.assertEquals(
              transaction_dict[accounting_line.getId()],
              accounting_line.getTotalQuantity())
1543

1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
  def stepCheckInvoiceSimulation(self, sequence=None, \
                                    sequence_list=None, **kw):
    invoice = sequence.get('invoice')

    applied_rule_list = invoice.getCausalityRelatedValueList(
      portal_type = self.applied_rule_portal_type,
        )

    self.assertEquals(
        1,
        len(applied_rule_list)
    )

    applied_rule = applied_rule_list[0]

    self.assertEquals(
1560 1561
      'default_invoice_rule',
      applied_rule.getSpecialiseReference()
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
    )

    self.assertEquals(
      # reduntant?
      invoice.getRelativeUrl(),
      applied_rule.getCausality()
    )

    simulation_movement_list = applied_rule.objectValues()

    self.assertEquals(
        1,
        len(simulation_movement_list)
    )

    simulation_movement = simulation_movement_list[0]

    invoice_line = sequence.get('invoice_line')
    resource = sequence.get('product_notebook')
    vendor = sequence.get('vendor')
    client = sequence.get('client')
    currency = sequence.get('currency')

    self.assertEquals(
      resource.getRelativeUrl(),
      simulation_movement.getResource()
    )

    self.assertEquals(
      currency.getRelativeUrl(),
      simulation_movement.getPriceCurrency()
    )

    self.assertEquals(
      vendor.getRelativeUrl(),
      simulation_movement.getSourceSection()
    )

    self.assertEquals(
      client.getRelativeUrl(),
      simulation_movement.getDestinationSection()
    )

    self.assertEquals(
      invoice_line.getRelativeUrl(),
      simulation_movement.getDelivery()
    )

    self.assertEquals(
      10,
      simulation_movement.getQuantity()
    )

    self.assertEquals(
      10,
      simulation_movement.getPrice()
    )
1619

1620
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1621
  def test_04_SimpleInvoice(self, quiet=QUIET, run=RUN_ALL_TESTS):
Jérome Perrin's avatar
Jérome Perrin committed
1622
    """ Simple Invoice.
1623 1624
    Try to expand an invoice containing only one simple Invoice Line.
    Check that the build is correct.
1625
    """
1626 1627
    if not run:
      return
1628
    if not quiet:
1629
      message = 'Test Simple Invoice Rule'
1630
      ZopeTestCase._print('\n%s ' % message)
1631 1632 1633 1634 1635 1636 1637
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1638 1639
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
1640 1641
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
1642
      stepValidateInvoiceTransaction
1643 1644 1645 1646
      stepCreateNotebookFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
1647
      stepCreateSimpleInvoice
1648 1649
      stepPlanInvoice
      stepTic
1650
      stepCheckFirstRuleIsApplied
1651 1652 1653
      stepCheckPaymentRuleIsApplied
      stepConfirmInvoice
      stepTic
1654 1655 1656
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
1657
      stepCheckAccountingLinesCoherantWithSimulation
1658 1659
      stepCheckAccountingLinesCreatedForSimpleInvoice
      stepCheckPaymentLinesCreatedForSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1660
      """, quiet=quiet )
1661

1662
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1663
  def test_04b_SimpleInvoiceConfirm(self, quiet=QUIET, run=RUN_ALL_TESTS):
Jérome Perrin's avatar
Jérome Perrin committed
1664 1665
    """  Same test as SimpleInvoice but directly confirm the invoice
    without planning it """
1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
    if not run:
      return
    if not quiet:
      message = 'Test Simple Invoice Rule (without plan)'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1678 1679
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
1680 1681
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
1682
      stepValidateInvoiceTransaction
1683 1684 1685 1686
      stepCreateNotebookFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
1687
      stepCreateSimpleInvoice
1688 1689
      stepConfirmInvoice
      stepTic
1690 1691 1692
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
1693
      stepCheckAccountingLinesCreatedForSimpleInvoice
1694
      stepCheckPaymentLinesCreatedForSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1695
      stepRebuildAndCheckNothingIsCreated
Jérome Perrin's avatar
Jérome Perrin committed
1696
      """, quiet=quiet )
1697

1698
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1699
  def test_04c_SimpleInvoiceTwoLines(self, quiet=QUIET, run=RUN_ALL_TESTS):
Jérome Perrin's avatar
Jérome Perrin committed
1700
    """ Simple Invoice, 2 lines.
1701 1702 1703 1704 1705 1706
    Same test as SimpleInvoice but use 2 lines of quantity 5 instead of
    1 line of quantity 10.
    """
    if not run:
      return
    if not quiet:
Jérome Perrin's avatar
Jérome Perrin committed
1707
      message = 'Test Simple Invoice Rule (with 2 lines)'
1708 1709 1710 1711 1712 1713 1714 1715
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1716 1717
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
1718 1719
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
1720
      stepValidateInvoiceTransaction
1721 1722 1723 1724
      stepCreateNotebookFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
1725
      stepCreateSimpleInvoiceTwoLines
1726 1727
      stepConfirmInvoice
      stepTic
1728 1729 1730
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
1731
      stepCheckAccountingLinesCreatedForSimpleInvoice
1732
      stepCheckPaymentLinesCreatedForSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1733
      stepRebuildAndCheckNothingIsCreated
Jérome Perrin's avatar
Jérome Perrin committed
1734
      """, quiet=quiet )
1735

1736
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1737
  def test_04d_SimpleInvoiceTwoCells(self, quiet=QUIET, run=RUN_ALL_TESTS):
Jérome Perrin's avatar
Jérome Perrin committed
1738 1739 1740
    """ Simple Invoice, 2 cells.
    Same test as SimpleInvoice but use 2 cells of quantity 5 instead of
    1 line of quantity 10.
1741
    """
Jérome Perrin's avatar
Jérome Perrin committed
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753
    if not run:
      return
    if not quiet:
      message = 'Test Simple Invoice Rule (with 2 cells)'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1754 1755
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
1756 1757
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
1758
      stepValidateInvoiceTransaction
Jérome Perrin's avatar
Jérome Perrin committed
1759 1760 1761 1762
      stepCreateNotebookFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
1763
      stepCreateSimpleInvoiceTwoCells
Jérome Perrin's avatar
Jérome Perrin committed
1764 1765
      stepConfirmInvoice
      stepTic
1766 1767 1768
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
Jérome Perrin's avatar
Jérome Perrin committed
1769
      stepCheckAccountingLinesCreatedForSimpleInvoice
1770
      stepCheckPaymentLinesCreatedForSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1771
      stepRebuildAndCheckNothingIsCreated
Jérome Perrin's avatar
Jérome Perrin committed
1772
      """, quiet=quiet )
1773 1774

  # next 5 tests will check update of applied rules.
1775
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1776
  def test_05a_SimpleInvoiceReExpandAddLine(self, quiet=QUIET,
1777
        run=RUN_ALL_TESTS):
1778
    """ Add a new line then updateSimulation.
Jérome Perrin's avatar
Jérome Perrin committed
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794
    Create an empty invoice, plan, add a line so that this
    invoice is the same as `SimpleInvoice`, confirm it then check
    accounting lines
    """
    if not run:
      return
    if not quiet:
      message = 'Test Simple Invoice Rule (add invoice line and reexpand)'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1795 1796
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
1797 1798
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
1799
      stepValidateInvoiceTransaction
Jérome Perrin's avatar
Jérome Perrin committed
1800 1801 1802 1803 1804 1805 1806 1807 1808 1809
      stepCreateNotebookFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
      stepCreateEmptyInvoice
      stepPlanInvoice
      stepTic
      stepAddInvoiceLine
      stepConfirmInvoice
      stepTic
1810 1811 1812
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
Jérome Perrin's avatar
Jérome Perrin committed
1813
      stepCheckAccountingLinesCreatedForSimpleInvoice
1814
      stepCheckPaymentLinesCreatedForSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1815
      stepRebuildAndCheckNothingIsCreated
Jérome Perrin's avatar
Jérome Perrin committed
1816
      """, quiet=quiet )
1817

1818
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1819
  def test_05b_SimpleInvoiceReExpandEditLine(self, quiet=QUIET,
1820
              run = RUN_ALL_TESTS):
Jérome Perrin's avatar
Jérome Perrin committed
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
    """ Tests that editing a line updates simulation correctly """
    if not run:
      return
    if not quiet:
      message = 'Test Simple Invoice Rule (edit line and reexpand)'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1834 1835
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
1836 1837
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
1838
      stepValidateInvoiceTransaction
Jérome Perrin's avatar
Jérome Perrin committed
1839 1840 1841 1842
      stepCreateNotebookFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
1843
      stepCreateOtherSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1844 1845 1846 1847 1848
      stepPlanInvoice
      stepTic
      stepEditInvoiceLine
      stepConfirmInvoice
      stepTic
1849 1850 1851
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
Jérome Perrin's avatar
Jérome Perrin committed
1852
      stepCheckAccountingLinesCreatedForSimpleInvoice
1853
      stepCheckPaymentLinesCreatedForSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1854
      stepRebuildAndCheckNothingIsCreated
Jérome Perrin's avatar
Jérome Perrin committed
1855
      """, quiet=quiet )
Jérome Perrin's avatar
Jérome Perrin committed
1856

1857
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1858
  def test_05c_SimpleInvoiceReExpandDeleteLine(
Jérome Perrin's avatar
Jérome Perrin committed
1859
                        self, quiet=QUIET, run=RUN_ALL_TESTS):
Jérome Perrin's avatar
Jérome Perrin committed
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
    """ Tests that removing a line updates simulation correctly """
    if not run:
      return
    if not quiet:
      message = 'Test Simple Invoice Rule (delete line and reexpand)'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1873 1874
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
1875 1876
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
1877
      stepValidateInvoiceTransaction
Jérome Perrin's avatar
Jérome Perrin committed
1878 1879 1880 1881
      stepCreateNotebookFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
1882
      stepCreateSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1883 1884 1885 1886 1887 1888 1889
      stepAddInvoiceLine
      stepPlanInvoice
      stepTic
      stepDeleteInvoiceLine
      stepTic
      stepConfirmInvoice
      stepTic
1890 1891 1892
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
Jérome Perrin's avatar
Jérome Perrin committed
1893
      stepCheckAccountingLinesCreatedForSimpleInvoice
1894
      stepCheckPaymentLinesCreatedForSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1895
      stepRebuildAndCheckNothingIsCreated
Jérome Perrin's avatar
Jérome Perrin committed
1896
      """, quiet=quiet )
1897

1898
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1899
  def test_05d_SimpleInvoiceReExpandCreateCell(self, quiet=QUIET,
1900
                  run=RUN_ALL_TESTS):
Jérome Perrin's avatar
Jérome Perrin committed
1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
    """ Tests that replacing a line by cells updates simulation correctly """
    if not run:
      return
    if not quiet:
      message = 'Test Simple Invoice Rule (add cells in a line and reexpand)'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1914 1915
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
1916 1917
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
1918
      stepValidateInvoiceTransaction
Jérome Perrin's avatar
Jérome Perrin committed
1919 1920 1921 1922
      stepCreateNotebookFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
1923
      stepCreateOtherSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1924 1925 1926 1927 1928
      stepPlanInvoice
      stepTic
      stepAddCellsInInvoiceLine
      stepConfirmInvoice
      stepTic
1929 1930 1931
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
Jérome Perrin's avatar
Jérome Perrin committed
1932
      stepCheckAccountingLinesCreatedForSimpleInvoice
1933
      stepCheckPaymentLinesCreatedForSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1934
      stepRebuildAndCheckNothingIsCreated
Jérome Perrin's avatar
Jérome Perrin committed
1935
      """, quiet=quiet)
1936

1937
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1938
  def test_05e_SimpleInvoiceExpandManyTimes(
Jérome Perrin's avatar
Jérome Perrin committed
1939
                                self, quiet=QUIET, run=RUN_ALL_TESTS):
Jérome Perrin's avatar
Jérome Perrin committed
1940 1941 1942 1943 1944
    """ Tests that updating an applied rule many times doesn't break the
    build """
    if not run:
      return
    if not quiet:
1945
      message = 'Test Simple Invoice Rule (many updateSimulation)'
Jérome Perrin's avatar
Jérome Perrin committed
1946 1947 1948 1949 1950 1951 1952 1953
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1954 1955
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
1956 1957
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
1958
      stepValidateInvoiceTransaction
Jérome Perrin's avatar
Jérome Perrin committed
1959 1960 1961 1962
      stepCreateNotebookFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
1963
      stepCreateSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1964 1965 1966 1967 1968 1969 1970 1971
      stepPlanInvoice
      stepTic """ +
      ("""
      stepEditInvoiceLine
      stepTic""" * 4) +
      """
      stepConfirmInvoice
      stepTic
1972 1973 1974
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
Jérome Perrin's avatar
Jérome Perrin committed
1975
      stepCheckAccountingLinesCreatedForSimpleInvoice
1976
      stepCheckPaymentLinesCreatedForSimpleInvoice
Jérome Perrin's avatar
Jérome Perrin committed
1977
      stepRebuildAndCheckNothingIsCreated
Jérome Perrin's avatar
Jérome Perrin committed
1978
      """, quiet=quiet )
Jérome Perrin's avatar
Jérome Perrin committed
1979

1980
  @newSimulationExpectedFailure
Jérome Perrin's avatar
Jérome Perrin committed
1981
  def test_06_MultiLineInvoice(self, quiet=QUIET, run=RUN_ALL_TESTS):
Jérome Perrin's avatar
Jérome Perrin committed
1982
    """ Multiple lines invoice.
1983
    Try to expand an invoice containing multiples Invoice Line.
Jérome Perrin's avatar
Jérome Perrin committed
1984
    Check that the build is correct, ie similar movements are aggregated.
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
    """
    if not run:
      return
    if not quiet:
      message = 'Test Multi Line Invoice Rule'
      ZopeTestCase._print('\n%s ' % message)
      LOG('Testing... ', INFO, message)

    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
1998 1999
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
2000 2001
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
2002
      stepValidateInvoiceTransaction
2003 2004 2005 2006 2007 2008
      stepTic
      stepCreateNotebookFranceCell
      stepCreateBareboneFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
2009
      stepCreateMultiLineInvoice
2010 2011 2012
      stepPlanInvoice
      stepConfirmInvoice
      stepTic
2013 2014 2015
      stepCheckNoAccountingLinesBuiltYet
      stepStartInvoice
      stepTic
2016
      stepCheckAccountingLinesCreatedForMultiLineInvoice
2017
      stepCheckPaymentLinesCreatedForMultiLineInvoice
Jérome Perrin's avatar
Jérome Perrin committed
2018
      stepRebuildAndCheckNothingIsCreated
Jérome Perrin's avatar
Jérome Perrin committed
2019
      """, quiet=quiet )
2020 2021


2022
  @newSimulationExpectedFailure
2023 2024 2025 2026 2027 2028 2029 2030 2031
  def test_planning_invoice_creates_simulation(self, quiet=QUIET):
    # http://mail.nexedi.com/pipermail/erp5-dev/2008-June/001969.html
    self.playSequence("""
      stepCreateAccounts
      stepCreateEntities
      stepCreateCurrencies
      stepCreateProducts
      stepCreateInvoiceTransactionRule
      stepUpdateInvoiceTransactionRuleMatrix
2032 2033
      stepCreatePaymentRule
      stepUpdatePaymentRuleMatrix
2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046
      stepValidateInvoiceTransaction
      stepTic
      stepCreateNotebookFranceCell
      stepCreateBareboneFranceCell
      stepTic
      stepClearSimulation
      stepClearAccountingModule
      stepCreateSimpleInvoice
      stepTic
      stepPlanInvoice
      stepTic
      stepCheckInvoiceSimulation
      """, quiet=quiet)
2047 2048 2049 2050 2051 2052

class TestSaleAccountingRules(SaleInvoiceTest, TestAccountingRules):
  pass


class TestPurchaseAccountingRules(PurchaseInvoiceTest, TestAccountingRules):
2053 2054 2055 2056
  # XXX this test is not really complete, originally we were testing Sale only,
  # so the test steps just test that source is correct, and not the
  # destination. For now it just tests that workflows for Purchase invokes
  # building correctly ...
2057 2058 2059
  pass


2060 2061
def test_suite():
  suite = unittest.TestSuite()
2062 2063
  suite.addTest(unittest.makeSuite(TestSaleAccountingRules))
  suite.addTest(unittest.makeSuite(TestPurchaseAccountingRules))
2064
  return suite