[14.0][ADD] edi_sale_ubl_oca

edi_oca/models/edi_exchange_consumer_mixin.py

@@ -313,7 +313,8 @@ def _edi_send_via_edi(self, exchange_type, backend=None, force=False, **kw):
             exchange_record = self._edi_create_exchange_record(
                 exchange_type, backend=backend
             )
-        if exchange_record:
+        # If quick exec is on, `exchange_generate_send` already ran
+        if exchange_record and not exchange_type.quick_exec:
             exchange_record.action_exchange_generate_send(**kw)
 
     # TODO: full unit test coverage

edi_sale_input_oca/components/process.py

@@ -3,11 +3,15 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 
+import logging
+
 from odoo import _
 from odoo.exceptions import UserError
 
 from odoo.addons.component.core import Component
 
+_logger = logging.getLogger(__name__)
+
 
 class EDIExchangeSOInput(Component):
     """Process sale orders."""
@@ -16,6 +20,21 @@ class EDIExchangeSOInput(Component):
     _inherit = "edi.component.input.mixin"
     _usage = "input.process.sale.order"
 
+    def __init__(self, work_context):
+        super().__init__(work_context)
+        self.settings = {}
+        # Suppor legacy key `self.type_settings`
+        for key in ("sale_order", "sale_order_import"):
+            if key in self.type_settings:
+                _logger.warning(
+                    "Deprecated key %s for %s. "
+                    "Please use default field values in env_ctx",
+                    key,
+                    self._usage,
+                )
+                self.settings = self.type_settings.get(key, {})
+                break
+
     def process(self):
         wiz = self._setup_wizard()
         res = wiz.import_order_button()
@@ -53,8 +72,19 @@ def _setup_wizard(self):
         wiz.order_file = self.exchange_record._get_file_content(binary=False)
         wiz.order_filename = self.exchange_record.exchange_filename
         wiz.order_file_change()
+        wiz.price_source = self._get_default_price_source()
+        wiz.confirm_order = self._order_should_be_confirmed()
         return wiz
 
+    # Deprecated: use default field values in env_ctx
+    # as these settings are supported by sale_order_import model.
+    def _get_default_price_source(self):
+        return self.settings.get("price_source", "pricelist")
+
+    # Deprecated: use default field values in env_ctx
+    def _order_should_be_confirmed(self):
+        return self.settings.get("confirm_order", False)
+
     def _handle_create_order(self, order_id):
         order = self.env["sale.order"].browse(order_id)
         self.exchange_record._set_related_record(order)

edi_sale_input_oca/tests/test_process.py

@@ -3,8 +3,11 @@
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
 
 import base64
+import textwrap
 from unittest import mock
 
+from odoo.tools import mute_logger
+
 from odoo.addons.component.tests.common import SavepointComponentCase
 from odoo.addons.edi_oca.tests.common import EDIBackendTestMixin
 
@@ -45,6 +48,31 @@ def test_wizard_setup(self):
             self.assertEqual(wiz.price_source, "pricelist")
             md_onchange.assert_called()
 
+    @mute_logger("odoo.addons.edi_sale_input_oca.components.process")
+    def test_wizard_setup_deprecated_settings(self):
+        self.exc_type.advanced_settings_edit = textwrap.dedent(
+            """
+            components:
+                process:
+                    usage: input.process.sale.order
+            sale_order_import:
+                confirm_order: true
+            """
+        )
+        comp = self.backend._get_component(self.record, "process")
+        with mock.patch.object(
+            type(self.wiz_model), "order_file_change"
+        ) as md_onchange:
+            wiz = comp._setup_wizard()
+            self.assertEqual(wiz._name, self.wiz_model._name)
+            self.assertEqual(
+                base64.b64decode(wiz.order_file), b"<fake><order></order></fake>"
+            )
+            self.assertEqual(wiz.order_filename, self.record.exchange_filename)
+            self.assertEqual(wiz.price_source, "pricelist")
+            self.assertEqual(wiz.confirm_order, True)
+            md_onchange.assert_called()
+
     # In both tests here we don"t care about the specific format of the import.
     # We only care that the wizard plugged with the component works as expected.
     def test_existing_order(self):

edi_sale_ubl_input_oca/README.rst

@@ -0,0 +1 @@
+bot, please, take care of this!

edi_sale_ubl_input_oca/__manifest__.py

@@ -0,0 +1,25 @@
+# Copyright 2022 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "EDI Sales",
+    "summary": """
+        Configuration and special behaviors for EDI on sales.
+    """,
+    "version": "14.0.1.0.0",
+    "development_status": "Alpha",
+    "license": "AGPL-3",
+    "author": "Camptocamp,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/edi",
+    "depends": [
+        "sale_order_import_ubl",
+        "edi_sale_input_oca",
+        "edi_sale_ubl_oca",
+        "edi_ubl_oca",
+        "edi_xml_oca",
+    ],
+    "data": [],
+    "demo": [
+        "demo/edi_exchange_type.xml",
+    ],
+}

edi_sale_ubl_input_oca/demo/edi_exchange_type.xml

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+    <record id="demo_edi_sale_ubl_input_so_out" model="edi.exchange.type">
+        <field name="backend_type_id" ref="edi_ubl_oca.edi_backend_type_ubl" />
+        <field name="backend_id" ref="edi_ubl_oca.edi_backend_ubl_demo" />
+        <field name="name">Demo UBL Sale Order Response (edi_sale_ubl_input_oca)</field>
+        <field name="code">demo_edi_sale_ubl_input_so_out</field>
+        <field name="direction">output</field>
+        <field name="exchange_filename_pattern">{record_name}-{type.code}-{dt}</field>
+        <field name="exchange_file_ext">xml</field>
+        <field
+            name="state_workflow_ids"
+            eval="[(6, 0, [
+              ref('edi_sale_ubl_oca.edi_sale_order_state_workflow'),
+              ref('edi_sale_ubl_oca.edi_sale_order_line_state_workflow')
+            ])]"
+        />
+    </record>
+
+    <record id="demo_edi_sale_ubl_input_so_in" model="edi.exchange.type">
+        <field name="backend_type_id" ref="edi_ubl_oca.edi_backend_type_ubl" />
+        <field name="backend_id" ref="edi_ubl_oca.edi_backend_ubl_demo" />
+        <field name="ack_type_id" ref="demo_edi_sale_ubl_input_so_out" />
+        <field name="name">Demo UBL Sale Order (edi_sale_ubl_input_oca)</field>
+        <field name="code">demo_edi_sale_ubl_input_so_in</field>
+        <field name="direction">input</field>
+        <field name="exchange_file_ext">xml</field>
+        <field
+            name="state_workflow_ids"
+            eval="[(6, 0, [
+              ref('edi_sale_ubl_oca.edi_sale_order_state_workflow'),
+              ref('edi_sale_ubl_oca.edi_sale_order_line_state_workflow')
+            ])]"
+        />
+        <field name="advanced_settings_edit">
+components:
+    process:
+        usage: input.process.sale.order
+        # Pass all additional arguments to the sale.order.import wizard via ctx keys.
+        # To add more selective features to the wizard, it's recommended to add new fields
+        # and control them via default values.
+        # Example:
+        env_ctx:
+          # Values for the wizard
+          default_confirm_order: false
+          default_price_source: 'pricelist'
+        </field>
+    </record>
+
+</odoo>

edi_sale_ubl_input_oca/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Simone Orsi <[email protected]>

edi_sale_ubl_input_oca/readme/DESCRIPTION.rst

@@ -0,0 +1 @@
+TODO

edi_sale_ubl_input_oca/tests/__init__.py

@@ -0,0 +1,2 @@
+from . import test_order_in
+from . import test_order_in_full_flow

edi_sale_ubl_input_oca/tests/test_order_in.py

@@ -0,0 +1,87 @@
+# Copyright 2022 Camptocamp SA
+# @author: Simone Orsi <[email protected]>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import exceptions
+
+from odoo.addons.edi_oca.tests.common import EDIBackendCommonComponentTestCase
+from odoo.addons.edi_sale_ubl_oca.tests.common import OrderInboundTestMixin
+
+
+class TestOrderInbound(EDIBackendCommonComponentTestCase, OrderInboundTestMixin):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.exc_type_in = cls.env.ref(
+            "edi_sale_ubl_input_oca.demo_edi_sale_ubl_input_so_in"
+        )
+        cls._setup_inbound_order(cls.backend, cls.exc_type_in)
+
+    @classmethod
+    def _get_backend(cls):
+        return cls.env.ref("edi_ubl_oca.edi_backend_ubl_demo")
+
+    def test_existing_order_break_on_error(self):
+        self.assertEqual(self.exc_record_in.edi_exchange_state, "input_received")
+        self.env["sale.order"].create(
+            {
+                "partner_id": self.order_data.partner.id,
+                "client_order_ref": self.order_data.client_order_ref,
+            }
+        )
+        with self.assertRaisesRegex(
+            exceptions.UserError, self.err_msg_already_imported
+        ):
+            self.exc_record_in.with_context(
+                _edi_process_break_on_error=True
+            ).action_exchange_process()
+        self.assertEqual(self.exc_record_in.edi_exchange_state, "input_received")
+
+    def test_existing_order(self):
+        self.assertEqual(self.exc_record_in.edi_exchange_state, "input_received")
+        self.env["sale.order"].create(
+            {
+                "partner_id": self.order_data.partner.id,
+                "client_order_ref": self.order_data.client_order_ref,
+            }
+        )
+        # Test w/ error handling
+        self.exc_record_in.action_exchange_process()
+        self.assertEqual(self.exc_record_in.edi_exchange_state, "input_processed_error")
+        err_msg = "Sales order has already been imported before"
+        self.assertIn(err_msg, self.exc_record_in.exchange_error)
+
+    def test_new_order(self):
+        self.assertEqual(self.exc_record_in.edi_exchange_state, "input_received")
+        order = self._find_order()
+        self.assertFalse(order)
+        # Test w/ error handling
+        # .with_context(_edi_process_break_on_error=True)
+        self.exc_record_in.action_exchange_process()
+        self.assertEqual(self.exc_record_in.edi_exchange_state, "input_processed")
+        order = self._find_order()
+        self.assertEqual(self.exc_record_in.record, order)
+        order_msg = order.message_ids[0]
+        self.assertIn("Exchange processed successfully", order_msg.body)
+        self.assertIn(self.exc_record_in.identifier, order_msg.body)
+        self.assertIn(
+            f"/web#id={self.exc_record_in.id}&amp;model=edi.exchange.record&amp;view_type=form",
+            order_msg.body,
+        )
+        # TODO: test order data. To do so, first add such tests to sale_order_import
+        self.assertEqual(order.order_line.mapped("edi_id"), ["1", "2"])
+
+    def test_cancel(self):
+        self.assertEqual(self.exc_record_in.edi_exchange_state, "input_received")
+        order = self.env["sale.order"].create(
+            {
+                "partner_id": self.order_data.partner.id,
+                "client_order_ref": self.order_data.client_order_ref,
+                "origin_exchange_record_id": self.exc_record_in.id,
+            }
+        )
+        self.exc_record_in._set_related_record(order)
+        order.action_confirm()
+        self.assertTrue(order.edi_state_id.code, order.EDI_STATE_ORDER_ACCEPTED)
+        order.action_cancel()
+        self.assertTrue(order.edi_state_id.code, order.EDI_STATE_ORDER_REJECTED)

edi_sale_ubl_input_oca/tests/test_order_in_full_flow.py

@@ -0,0 +1,74 @@
+# Copyright 2022 Camptocamp SA
+# @author: Simone Orsi <[email protected]>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from unittest import mock
+
+from odoo.addons.edi_oca.tests.common import EDIBackendCommonComponentTestCase
+from odoo.addons.edi_sale_ubl_oca.tests.common import OrderInboundTestMixin
+
+# TODO: split in different tests w/ SingleTransaction
+
+
+class TestOrderInboundFull(EDIBackendCommonComponentTestCase, OrderInboundTestMixin):
+
+    _schema_path = "base_ubl:data/xsd-2.2/maindoc/UBL-OrderResponse-2.2.xsd"
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls._setup_env()
+        cls.backend = cls._get_backend()
+        cls.exc_type_out = cls.env.ref(
+            "edi_sale_ubl_input_oca.demo_edi_sale_ubl_input_so_out"
+        )
+        cls.exc_type_in = cls.env.ref(
+            "edi_sale_ubl_input_oca.demo_edi_sale_ubl_input_so_in"
+        )
+        cls._setup_inbound_order(cls.backend, cls.exc_type_in)
+        cls.edi_conf = cls.env.ref(
+            "edi_sale_oca.demo_edi_configuration_confirmed"
+        ).copy(
+            {
+                "name": "UBL IN EDI Conf",
+                "type_id": cls.exc_type_out.id,
+                "backend_id": cls.backend.id,
+            }
+        )
+
+    @classmethod
+    def _get_backend(cls):
+        return cls.env.ref("edi_ubl_oca.edi_backend_ubl_demo")
+
+    # No need to test sending data
+    @mock.patch("odoo.addons.edi_oca.models.edi_backend.EDIBackend._exchange_send")
+    def test_new_order(self, mock_send):
+        order = self._find_order()
+        self.backend._check_input_exchange_sync()
+        self.assertEqual(self.exc_record_in.edi_exchange_state, "input_processed")
+        order = self._find_order()
+        order.partner_id.edi_sale_conf_ids = self.edi_conf
+        self.assertEqual(self.exc_record_in.record, order)
+        order_msg = order.message_ids[0]
+        self.assertIn("Exchange processed successfully", order_msg.body)
+        self.assertIn(self.exc_record_in.identifier, order_msg.body)
+        order.invalidate_cache()
+        # Test relations
+        self.assertEqual(len(order.exchange_record_ids), 1)
+        exc_record = order.exchange_record_ids.filtered(
+            lambda x: x.type_id == self.exc_type_in
+        )
+        self.assertEqual(exc_record, self.exc_record_in)
+        # Confirm the order
+        with mock.patch.object(
+            type(self.backend), "_exchange_generate"
+        ) as mock_generate:
+            mock_generate.return_value = "<xml>fake</xml>"
+            order.action_confirm()
+        # Should give us a valid order response ack record
+        ack_exc_record = order.exchange_record_ids.filtered(
+            lambda x: x.type_id == self.exc_type_out
+        )
+        file_content = ack_exc_record._get_file_content()
+        self.assertEqual(file_content, "<xml>fake</xml>")
+        self.assertEqual(ack_exc_record.edi_exchange_state, "output_sent")

edi_sale_ubl_oca/README.rst

@@ -0,0 +1 @@
+bot, please, take care of this!

edi_sale_ubl_oca/__init__.py

@@ -0,0 +1,2 @@
+from . import components
+from . import models

edi_sale_ubl_oca/__manifest__.py

@@ -0,0 +1,29 @@
+# Copyright 2022 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "EDI Sales",
+    "summary": """
+        Configuration and special behaviors for EDI on sales.
+    """,
+    "version": "14.0.1.0.0",
+    "development_status": "Alpha",
+    "license": "AGPL-3",
+    "author": "Camptocamp,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/edi",
+    "depends": [
+        "edi_sale_oca",
+        "edi_state_oca",
+        "edi_ubl_oca",
+        # This could be made optional
+        # but the delivery part would need another source of data
+        "sale_stock",
+    ],
+    "data": [
+        "data/edi_state.xml",
+        "views/sale_order.xml",
+    ],
+    "demo": [
+        "demo/edi_exchange_type.xml",
+    ],
+}

edi_sale_ubl_oca/components/__init__.py

@@ -0,0 +1 @@
+from . import listeners