[15.0] FWD port of multiple PRs

.oca/oca-port/blacklist/edi_oca.json

@@ -0,0 +1,28 @@
+{
+  "pull_requests": {
+    "OCA/639": "Nothing to port from PR #OCA/639",
+    "OCA/651": "Nothing to port from PR #OCA/651",
+    "OCA/652": "Nothing to port from PR #OCA/652",
+    "OCA/653": "Nothing to port from PR #OCA/653",
+    "OCA/645": "Nothing to port from PR #OCA/645",
+    "OCA/648": "Nothing to port from PR #OCA/648",
+    "OCA/662": "Nothing to port from PR #OCA/662",
+    "OCA/666": "Nothing to port from PR #OCA/666",
+    "OCA/672": "Nothing to port from PR #OCA/672",
+    "OCA/694": "Nothing to port from PR #OCA/694",
+    "OCA/696": "Nothing to port from PR #OCA/696",
+    "OCA/697": "Nothing to port from PR #OCA/697",
+    "OCA/698": "Nothing to port from PR #OCA/698",
+    "OCA/721": "Nothing to port from PR #OCA/721",
+    "OCA/762": "Nothing to port from PR #OCA/762",
+    "OCA/764": "Nothing to port from PR #OCA/764",
+    "OCA/763": "Nothing to port from PR #OCA/763",
+    "OCA/765": "Nothing to port from PR #OCA/765",
+    "OCA/767": "Nothing to port from PR #OCA/767",
+    "OCA/774": "Nothing to port from PR #OCA/774",
+    "OCA/778": "Nothing to port from PR #OCA/778",
+    "OCA/797": "Nothing to port from PR #OCA/797",
+    "OCA/790": "Nothing to port from PR #OCA/790",
+    "OCA/808": "Nothing to port from PR #OCA/808"
+  }
+}

edi_exchange_template_oca/__manifest__.py

@@ -1,14 +1,14 @@
 # Copyright 2020 ACSONE
-# @author: Simone Orsi <[email protected]>
+# Copyright 2022 Camptocamp SA
+# @author Simone Orsi <[email protected]>
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
-
 {
     "name": "EDI Exchange Template",
     "summary": """Allows definition of exchanges via templates.""",
     "version": "15.0.1.0.1",
     "development_status": "Beta",
     "license": "LGPL-3",
-    "author": "ACSONE,Odoo Community Association (OCA)",
+    "author": "ACSONE,Camptocamp,Odoo Community Association (OCA)",
     "maintainers": ["simahawk"],
     "website": "https://github.com/OCA/edi",
     "depends": ["edi_oca", "component"],

edi_exchange_template_oca/models/edi_backend.py

@@ -12,6 +12,12 @@ def _exchange_generate(self, exchange_record, **kw):
         # Template take precedence over component lookup
         tmpl = self._get_output_template(exchange_record)
         if tmpl:
+            # FIXME: env_ctx is not propagated here because we bypass components completly.
+            # It would be better to move this machinery inside a `generate` component.
+            exchange_record = exchange_record.with_context(
+                edi_framework_action="generate"
+            )
+            tmpl = tmpl.with_context(edi_framework_action="generate")
             return tmpl.exchange_generate(exchange_record, **kw)
         return super()._exchange_generate(exchange_record, **kw)
 

edi_exchange_template_oca/models/edi_exchange_template_mixin.py

@@ -13,6 +13,19 @@
 _logger = logging.getLogger(__name__)
 
 
+def date_to_datetime(dt):
+    """Convert date to datetime."""
+    if isinstance(dt, datetime.date):
+        return datetime.datetime.combine(dt, datetime.datetime.min.time())
+    return dt
+
+
+def to_utc(dt):
+    """Convert date or datetime to UTC."""
+    # Gracefully convert to datetime if needed 1st
+    return date_to_datetime(dt).astimezone(pytz.UTC)
+
+
 class EDIExchangeTemplateMixin(models.AbstractModel):
     """Define a common ground for EDI exchange templates."""
 
@@ -77,22 +90,43 @@
 
     @staticmethod
     def _date_to_string(dt, utc=True):
+        if not dt:
+            return ""
         if utc:
-            dt = dt.astimezone(pytz.UTC)
+            dt = to_utc(dt)
         return fields.Date.to_string(dt)
 
+    @staticmethod
+    def _datetime_to_string(dt, utc=True):
+        if not dt:
+            return ""
+        if utc:
+            dt = to_utc(dt)
+        return fields.Datetime.to_string(dt)
+
     def _get_code_snippet_eval_context(self):
         """Prepare the context used when evaluating python code
 
         :returns: dict -- evaluation context given to safe_eval
         """
+        ctx = {
+            "uid": self.env.uid,
+            "user": self.env.user,
+            "DotDict": DotDict,
+        }
+        ctx.update(self._time_utils())
+        return ctx
+
+    def _time_utils(self):
         return {
             "datetime": safe_eval.datetime,
             "dateutil": safe_eval.dateutil,
             "time": safe_eval.time,
-            "uid": self.env.uid,
-            "user": self.env.user,
-            "DotDict": DotDict,
+            "utc_now": self._utc_now,
+            "date_to_string": self._date_to_string,
+            "datetime_to_string": self._datetime_to_string,
+            "time_to_string": lambda dt: dt.strftime("%H:%M:%S") if dt else "",
+            "first_of": fields.first,
         }
 
     def _evaluate_code_snippet(self, **render_values):

edi_exchange_template_oca/models/edi_exchange_template_output.py

@@ -1,14 +1,12 @@
 # Copyright 2020 ACSONE SA
 # @author Simone Orsi <[email protected]>
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
-import logging
+import lxml.etree as etree
 
 from odoo import fields, models
 
 from ..utils import xml_purge_nswrapper
 
-_logger = logging.getLogger(__name__)
-
 
 class EDIExchangeOutputTemplate(models.Model):
     """Define an output template to generate outgoing records' content."""
@@ -49,6 +47,7 @@ class EDIExchangeOutputTemplate(models.Model):
         readonly=False,
     )
     template_key = fields.Char(related="template_id.xml_id", string="Template key")
+    prettify = fields.Boolean(help="Prettify output. Works for XML output only.")
 
     def _default_code_snippet_docs(self):
         return (
@@ -94,14 +93,13 @@ def _get_render_values(self, exchange_record, **kw):
             "record": exchange_record.record,
             "backend": exchange_record.backend_id,
             "template": self,
-            "utc_now": self._utc_now,
-            "date_to_string": self._date_to_string,
             "render_edi_template": self._render_template,
             "get_info_provider": self._get_info_provider,
             "info": {},
         }
-        values.update(self._evaluate_code_snippet(**values))
         values.update(kw)
+        values.update(self._time_utils())
+        values.update(self._evaluate_code_snippet(**values))
         return values
 
     def _render_template(self, exchange_record, code, **kw):
@@ -117,9 +115,14 @@ def _post_process_output(self, output):
         """Post process generated output."""
         if self.output_type == "xml":
             # TODO: lookup for components to handle this dynamically
-            return xml_purge_nswrapper(output)
+            output = xml_purge_nswrapper(output)
+            if self.prettify:
+                output = self._prettify_xml(output)
         return output
 
+    def _prettify_xml(self, xml_string):
+        return etree.tostring(etree.fromstring(xml_string), pretty_print=True)
+
     def _get_info_provider(self, exchange_record, work_ctx=None, usage=None, **kw):
         """Retrieve component providing info to render a template.
 

edi_exchange_template_oca/tests/__init__.py

@@ -1 +1,2 @@
 from . import test_edi_backend_output
+from . import test_nswrapper

edi_exchange_template_oca/tests/test_edi_backend_output.py

@@ -153,6 +153,16 @@ def test_generate_file(self):
         self.assertEqual(doc.getchildren()[1].text, "2")
         self.assertEqual(doc.getchildren()[1].attrib, {"bit": "custom_var"})
 
+    def test_prettify(self):
+        self.tmpl_out2.template_id.arch = (
+            '<t t-name="edi_exchange.test_output2"><root><a>1</a></root></t>'
+        )
+        result = self.tmpl_out2.exchange_generate(self.record2)
+        self.assertEqual(result, b"<root><a>1</a></root>")
+        self.tmpl_out2.prettify = True
+        result = self.tmpl_out2.exchange_generate(self.record2)
+        self.assertEqual(result, b"<root>\n  <a>1</a>\n</root>\n")
+
     def test_generate_file_report(self):
         output = self.backend.exchange_generate(self.record3)
         self.assertTrue(output)

edi_exchange_template_oca/tests/test_nswrapper.py

@@ -0,0 +1,58 @@
+# Copyright 2022 Camptocamp SA
+# @author Simone Orsi <[email protected]>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+from odoo.tests.common import SavepointCase
+from odoo.tools import pycompat
+
+from ..utils import xml_purge_nswrapper
+
+ORDER_RESP_WRAPPER_TMPL = """
+<OrderResponse
+    xmlns="urn:oasis:names:specification:ubl:schema:xsd:OrderResponse-2"
+    xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
+    xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
+>
+    <cbc:UBLVersionID>2.2</cbc:UBLVersionID>
+{}
+</OrderResponse>
+"""
+
+XML1 = """
+    <nswrapper xmlns:foo="http://www.unece.org/cefact/Foo">
+        <foo:LovelyNamespacedElement />
+    </nswrapper>
+"""
+
+XML2 = """
+    <nswrapper
+            xmlns="urn:oasis:names:specification:ubl:schema:xsd:OrderResponse-2"
+            xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
+            xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
+        >
+        <cac:Party>
+            <cbc:EndpointID>7302347231111</cbc:EndpointID>
+            <cac:PartyIdentification>
+                <cbc:ID>7300070011115</cbc:ID>
+            </cac:PartyIdentification>
+            <cac:PartyName>
+                <cbc:Name>Moderna Produkter AB</cbc:Name>
+            </cac:PartyName>
+        </cac:Party>
+    </nswrapper>
+"""
+
+
+class TestNSWrapper(SavepointCase):
+    maxDiff = None
+
+    def test_purge1(self):
+        res = xml_purge_nswrapper(XML1)
+        self.assertNotIn("nswrapper", pycompat.to_text(res))
+
+    def test_purge2(self):
+        res = xml_purge_nswrapper(XML2)
+        self.assertNotIn("nswrapper", pycompat.to_text(res))
+
+    def test_purge3(self):
+        res = xml_purge_nswrapper(ORDER_RESP_WRAPPER_TMPL.format(XML2))
+        self.assertNotIn("nswrapper", pycompat.to_text(res))

edi_exchange_template_oca/utils.py

@@ -1,3 +1,8 @@
+# Copyright 2020 ACSONE SA/NV
+# Copyright 2022 Camptocamp SA
+# @author Simone Orsi <[email protected]>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
 from lxml import etree
 
 from odoo.tools import pycompat
@@ -25,8 +30,9 @@ def xml_purge_nswrapper(xml_content):
     if not (xml_content and xml_content.strip()):
         return xml_content
     root = etree.XML(xml_content)
-    # deeper elements come after, keep the root element at the end (if any)
-    for nswrapper in reversed(root.xpath("//nswrapper")):
+    # Deeper elements come after, keep the root element at the end (if any).
+    # Use `name()` because the real element could be namespaced on render.
+    for nswrapper in reversed(root.xpath("//*[name() = 'nswrapper']")):
         parent = nswrapper.getparent()
         if parent is None:
             # fmt:off

edi_exchange_template_oca/views/edi_exchange_template_output_views.xml

@@ -31,6 +31,10 @@
                             <field name="code" />
                             <field name="output_type" />
                             <field name="generator" />
+                            <field
+                                name="prettify"
+                                attrs="{'invisible': [('generator', '!=', 'qweb')]}"
+                            />
                             <field
                                 name="template_id"
                                 attrs="{'required': [('generator', '=', 'qweb')], 'invisible': [('generator', '!=', 'qweb')]}"

edi_exchange_template_party_data/README.rst

@@ -0,0 +1 @@
+wait for da bot

edi_exchange_template_party_data/__init__.py

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

edi_exchange_template_party_data/__manifest__.py

@@ -0,0 +1,15 @@
+# Copyright 2022 Camptocamp SA
+# @author Simone Orsi <[email protected]>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+{
+    "name": "EDI Exchange Template - Party data",
+    "summary": """Glue module betweeb edi_exchange_template and edi_party_data""",
+    "version": "15.0.1.0.0",
+    "development_status": "Alpha",
+    "license": "AGPL-3",
+    "author": "Camptocamp,Odoo Community Association (OCA)",
+    "maintainers": ["simahawk"],
+    "website": "https://github.com/OCA/edi",
+    "depends": ["edi_exchange_template_oca", "edi_party_data_oca"],
+    "auto_install": True,
+}

edi_exchange_template_party_data/models/__init__.py

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

edi_exchange_template_party_data/models/edi_exchange_template_output.py

@@ -0,0 +1,24 @@
+# Copyright 2022 Camptocamp SA
+# @author Simone Orsi <[email protected]>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from odoo import _, exceptions, models
+
+from odoo.addons.edi_party_data_oca.utils import get_party_data_component
+
+
+class EDIExchangeOutputTemplate(models.Model):
+    """Define an output template to generate outgoing records' content."""
+
+    _inherit = "edi.exchange.template.output"
+
+    def _get_render_values(self, exchange_record, **kw):
+        kw["get_party_data"] = self._get_party_data
+        return super()._get_render_values(exchange_record, **kw)
+
+    def _get_party_data(self, exchange_record, partner, raise_if_not_found=True):
+        """Shortcut to lookup an info provider for parties."""
+        provider = get_party_data_component(exchange_record, partner)
+        if not provider and raise_if_not_found:
+            raise exceptions.UserError(_("No info provider found for party data"))
+        return provider.get_party() if provider else None

edi_exchange_template_party_data/readme/CONTRIBUTORS.rst

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

edi_exchange_template_party_data/readme/DESCRIPTION.rst

@@ -0,0 +1,4 @@
+Glue module betweeb edi_exchange_template and edi_party_data.
+
+Exposes a `get_party_data` function to the rendering context of the template.
+This way you can retrieve party data on the fly.

edi_exchange_template_party_data/tests/__init__.py

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