Benjamin Frantzen (bfr)
5319b71b66
Before this commit, for an EDI to be successfully posted, returning an attachment from 'post_invoice_edi' was required. In some cases this caused problem:
- When an EDI is posted in two steps, sometimes the attachment is generated in the first step and nothing is returned until the second step. This forced to do some hack where the reference to the attachment in a seperate field to be able to return it after the second step.
- When an EDI doesn't have a file to return (maybe we just send data over an API and get a response without any file involved).
Now, the attachment are removed from account_edi flows. When returning from 'post_invoice_edi', it is still possible to return an attachment whose reference will be kept in the edi_document, but will not change the state of the document to 'sent'.
To make the state change to 'sent', 'post_invoice_edi' must return {'success': True}.
Nothing has changed in the 'cancel' flow, meaning that the buttons related to canceling or reseting an invoice to draft are now based on the state and not on the existence of an attachment on the document. Also, when an invoice is successfully cancelled, the reference to the attachment is STILL removed from the document, since the document does not represent an electronic invoice anymore.
closes odoo/odoo#70040
Related: odoo/upgrade#1946
Related: odoo/enterprise#13220
Signed-off-by: Laurent Smet <smetl@users.noreply.github.com>
217 lines
9.7 KiB
Python
217 lines
9.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
from odoo.modules.module import get_module_resource
|
|
from odoo.addons.account.tests.common import AccountTestInvoicingCommon
|
|
|
|
from contextlib import contextmanager
|
|
from unittest.mock import patch
|
|
from unittest import mock
|
|
|
|
import base64
|
|
|
|
|
|
def _generate_mocked_needs_web_services(needs_web_services):
|
|
return lambda edi_format: needs_web_services
|
|
|
|
|
|
def _generate_mocked_support_batching(support_batching):
|
|
return lambda edi_format, move, state, company: support_batching
|
|
|
|
|
|
def _mocked_get_batch_key(edi_format, move, state):
|
|
return ()
|
|
|
|
|
|
def _mocked_check_move_configuration_success(edi_format, move):
|
|
return []
|
|
|
|
|
|
def _mocked_check_move_configuration_fail(edi_format, move):
|
|
return ['Fake error (mocked)']
|
|
|
|
|
|
def _mocked_post(edi_format, invoices):
|
|
res = {}
|
|
for invoice in invoices:
|
|
attachment = edi_format.env['ir.attachment'].create({
|
|
'name': 'mock_simple.xml',
|
|
'datas': base64.encodebytes(b"<?xml version='1.0' encoding='UTF-8'?><Invoice/>"),
|
|
'mimetype': 'application/xml'
|
|
})
|
|
res[invoice] = {'success': True, 'attachment': attachment}
|
|
return res
|
|
|
|
|
|
def _mocked_post_two_steps(edi_format, invoices):
|
|
# For this test, we use the field ref to know if the first step is already done or not.
|
|
# Typically, a technical field for the reference of the upload to the web-service will
|
|
# be saved on the invoice.
|
|
invoices_no_ref = invoices.filtered(lambda i: not i.ref)
|
|
if len(invoices_no_ref) == len(invoices): # first step
|
|
invoices_no_ref.ref = 'test_ref'
|
|
return {invoice: {} for invoice in invoices}
|
|
elif len(invoices_no_ref) == 0: # second step
|
|
res = {}
|
|
for invoice in invoices:
|
|
attachment = edi_format.env['ir.attachment'].create({
|
|
'name': 'mock_simple.xml',
|
|
'datas': base64.encodebytes(b"<?xml version='1.0' encoding='UTF-8'?><Invoice/>"),
|
|
'mimetype': 'application/xml'
|
|
})
|
|
res[invoice] = {'success': True, 'attachment': attachment}
|
|
return res
|
|
else:
|
|
raise ValueError('wrong use of "_mocked_post_two_steps"')
|
|
|
|
|
|
def _mocked_cancel_success(edi_format, invoices):
|
|
return {invoice: {'success': True} for invoice in invoices}
|
|
|
|
|
|
def _mocked_cancel_failed(edi_format, invoices):
|
|
return {invoice: {'error': 'Faked error (mocked)'} for invoice in invoices}
|
|
|
|
|
|
class AccountEdiTestCommon(AccountTestInvoicingCommon):
|
|
|
|
@classmethod
|
|
def setUpClass(cls, chart_template_ref=None, edi_format_ref=None):
|
|
super().setUpClass(chart_template_ref=chart_template_ref)
|
|
|
|
# ==== EDI ====
|
|
if edi_format_ref:
|
|
cls.edi_format = cls.env.ref(edi_format_ref)
|
|
else:
|
|
cls.edi_format = cls.env['account.edi.format'].sudo().create({
|
|
'name': 'Test EDI format',
|
|
'code': 'test_edi',
|
|
})
|
|
cls.journal = cls.company_data['default_journal_sale']
|
|
cls.journal.edi_format_ids = [(6, 0, cls.edi_format.ids)]
|
|
|
|
####################################################
|
|
# EDI helpers
|
|
####################################################
|
|
|
|
@contextmanager
|
|
def mock_edi(self,
|
|
_is_required_for_invoice_method=lambda edi_format, invoice: True,
|
|
_is_required_for_payment_method=lambda edi_format, invoice: True,
|
|
_support_batching_method=_generate_mocked_support_batching(False),
|
|
_get_batch_key_method=_mocked_get_batch_key,
|
|
_needs_web_services_method=_generate_mocked_needs_web_services(False),
|
|
_check_move_configuration_method=_mocked_check_move_configuration_success,
|
|
_post_invoice_edi_method=_mocked_post,
|
|
_cancel_invoice_edi_method=_mocked_cancel_success,
|
|
_post_payment_edi_method=_mocked_post,
|
|
_cancel_payment_edi_method=_mocked_cancel_success,
|
|
):
|
|
|
|
try:
|
|
with patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._is_required_for_invoice',
|
|
new=_is_required_for_invoice_method), \
|
|
patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._is_required_for_payment',
|
|
new=_is_required_for_payment_method), \
|
|
patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._needs_web_services',
|
|
new=_needs_web_services_method), \
|
|
patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._support_batching',
|
|
new=_support_batching_method), \
|
|
patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._get_batch_key',
|
|
new=_get_batch_key_method), \
|
|
patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._check_move_configuration',
|
|
new=_check_move_configuration_method), \
|
|
patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._post_invoice_edi',
|
|
new=_post_invoice_edi_method), \
|
|
patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._cancel_invoice_edi',
|
|
new=_cancel_invoice_edi_method), \
|
|
patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._post_payment_edi',
|
|
new=_post_payment_edi_method), \
|
|
patch('odoo.addons.account_edi.models.account_edi_format.AccountEdiFormat._cancel_payment_edi',
|
|
new=_cancel_payment_edi_method):
|
|
|
|
yield
|
|
finally:
|
|
pass
|
|
|
|
def edi_cron(self):
|
|
self.env['account.edi.document'].sudo().search([('state', 'in', ('to_send', 'to_cancel'))])._process_documents_web_services(with_commit=False)
|
|
|
|
def _create_empty_vendor_bill(self):
|
|
invoice = self.env['account.move'].create({
|
|
'move_type': 'in_invoice',
|
|
'journal_id': self.company_data['default_journal_purchase'].id,
|
|
})
|
|
return invoice
|
|
|
|
def update_invoice_from_file(self, module_name, subfolder, filename, invoice):
|
|
file_path = get_module_resource(module_name, subfolder, filename)
|
|
file = open(file_path, 'rb').read()
|
|
|
|
attachment = self.env['ir.attachment'].create({
|
|
'name': filename,
|
|
'datas': base64.encodebytes(file),
|
|
'res_id': invoice.id,
|
|
'res_model': 'account.move',
|
|
})
|
|
|
|
invoice.message_post(attachment_ids=[attachment.id])
|
|
|
|
def create_invoice_from_file(self, module_name, subfolder, filename):
|
|
file_path = get_module_resource(module_name, subfolder, filename)
|
|
file = open(file_path, 'rb').read()
|
|
|
|
attachment = self.env['ir.attachment'].create({
|
|
'name': filename,
|
|
'datas': base64.encodebytes(file),
|
|
'res_model': 'account.move',
|
|
})
|
|
journal_id = self.company_data['default_journal_sale']
|
|
action_vals = journal_id.with_context(default_move_type='in_invoice').create_invoice_from_attachment(attachment.ids)
|
|
return self.env['account.move'].browse(action_vals['res_id'])
|
|
|
|
def assert_generated_file_equal(self, invoice, expected_values, applied_xpath=None):
|
|
invoice.action_post()
|
|
invoice.edi_document_ids._process_documents_web_services(with_commit=False) # synchronous are called in post, but there's no CRON in tests for asynchronous
|
|
attachment = invoice._get_edi_attachment(self.edi_format)
|
|
if not attachment:
|
|
raise ValueError('No attachment was generated after posting EDI')
|
|
xml_content = base64.b64decode(attachment.with_context(bin_size=False).datas)
|
|
current_etree = self.get_xml_tree_from_string(xml_content)
|
|
expected_etree = self.get_xml_tree_from_string(expected_values)
|
|
if applied_xpath:
|
|
expected_etree = self.with_applied_xpath(expected_etree, applied_xpath)
|
|
self.assertXmlTreeEqual(current_etree, expected_etree)
|
|
|
|
def create_edi_document(self, edi_format, state, move=None, move_type=None):
|
|
""" Creates a document based on an existing invoice or creates one, too.
|
|
|
|
:param edi_format: The edi_format of the document.
|
|
:param state: The state of the document.
|
|
:param move: The move of the document or None to create a new one.
|
|
:param move_type: If move is None, the type of the invoice to create, defaults to 'out_invoice'.
|
|
"""
|
|
move = move or self.init_invoice(move_type or 'out_invoice', products=self.product_a)
|
|
return self.env['account.edi.document'].create({
|
|
'edi_format_id': edi_format.id,
|
|
'move_id': move.id,
|
|
'state': state
|
|
})
|
|
|
|
def _process_documents_web_services(self, moves, formats_to_return=None):
|
|
""" Generates and returns EDI files for the specified moves.
|
|
formats_to_return is an optional parameter used to pass a set of codes from
|
|
the formats we want to return the files for (in case we want to test specific formats).
|
|
Other formats will still generate documents, they simply won't be returned.
|
|
"""
|
|
moves.edi_document_ids._process_documents_web_services(with_commit=False)
|
|
|
|
documents_to_return = moves.edi_document_ids
|
|
if formats_to_return != None:
|
|
documents_to_return = documents_to_return.filtered(lambda x: x.edi_format_id.code in formats_to_return)
|
|
|
|
attachments = documents_to_return.attachment_id
|
|
data_str_list = []
|
|
for attachment in attachments.with_context(bin_size=False):
|
|
data_str_list.append(base64.decodebytes(attachment.datas))
|
|
return data_str_list
|