diff --git a/edi_component_oca/models/edi_exchange_record.py b/edi_component_oca/models/edi_exchange_record.py index 551d1fa6b..aa4149cb1 100644 --- a/edi_component_oca/models/edi_exchange_record.py +++ b/edi_component_oca/models/edi_exchange_record.py @@ -8,15 +8,9 @@ class EdiExchangeRecord(models.Model): _inherit = "edi.exchange.record" - def _trigger_edi_event_make_name(self, name, suffix=None): - return "on_edi_exchange_{name}{suffix}".format( - name=name, - suffix=("_" + suffix) if suffix else "", - ) - def _trigger_edi_event(self, name, suffix=None, target=None, **kw): """Trigger a component event linked to this backend and edi exchange.""" - name = self._trigger_edi_event_make_name(name, suffix=suffix) + method_name = self._trigger_edi_event_make_name(name, suffix=suffix) target = target or self - target._event(name).notify(self, **kw) + target._event(method_name).notify(self, **kw) return super()._trigger_edi_event(name, suffix=suffix, target=target, **kw) diff --git a/edi_core_oca/models/edi_configuration.py b/edi_core_oca/models/edi_configuration.py index 93d7412f3..bcc0fe4b3 100644 --- a/edi_core_oca/models/edi_configuration.py +++ b/edi_core_oca/models/edi_configuration.py @@ -67,6 +67,12 @@ class EdiConfiguration(models.Model): help="""Used to do something specific here. Receives: operation, edi_action, vals, old_vals.""", ) + is_global = fields.Boolean( + string="Global Configuration", + help="If checked, this configuration will be executed for all records, " + "regardless of the partner.", + default=False, + ) @api.constrains("backend_id", "type_id") def _constrains_backend(self): diff --git a/edi_core_oca/models/edi_exchange_record.py b/edi_core_oca/models/edi_exchange_record.py index a65e15af7..0e27d1521 100644 --- a/edi_core_oca/models/edi_exchange_record.py +++ b/edi_core_oca/models/edi_exchange_record.py @@ -530,8 +530,24 @@ def _notify_related_record(self, message, level="info"): rec._notify_related_record(message, level) def _trigger_edi_event(self, name, suffix=None, target=None, **kw): - """Hook to be implemented in other modules""" - pass + event_name = self._trigger_edi_event_make_name(name, suffix) + target = target or self + + global_configs = self.env["edi.configuration"].search( + [ + ("trigger", "=", event_name), + ("is_global", "=", True), + ] + ) + + for conf in global_configs: + conf.edi_exec_snippet_do(target, **kw) + + def _trigger_edi_event_make_name(self, name, suffix=None): + return "on_edi_exchange_{name}{suffix}".format( + name=name, + suffix=("_" + suffix) if suffix else "", + ) def _notify_done(self): self._notify_related_record(self._exchange_status_message("process_ok")) diff --git a/edi_core_oca/views/edi_configuration_views.xml b/edi_core_oca/views/edi_configuration_views.xml index 053db7764..674e88f8b 100644 --- a/edi_core_oca/views/edi_configuration_views.xml +++ b/edi_core_oca/views/edi_configuration_views.xml @@ -74,6 +74,7 @@ name="model_id" options="{'no_create': True, 'no_create_edit': True}" /> + diff --git a/edi_storage_oca/README.rst b/edi_storage_oca/README.rst index 52b9f7ece..53c75d5ee 100644 --- a/edi_storage_oca/README.rst +++ b/edi_storage_oca/README.rst @@ -1,7 +1,3 @@ -.. image:: https://odoo-community.org/readme-banner-image - :target: https://odoo-community.org/get-involved?utm_source=readme - :alt: Odoo Community Association - =========================== EDI Storage backend support =========================== @@ -17,7 +13,7 @@ EDI Storage backend support .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png :target: https://odoo-community.org/page/development-status :alt: Beta -.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html :alt: License: LGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fedi--framework-lightgray.png?logo=github diff --git a/edi_storage_oca/__manifest__.py b/edi_storage_oca/__manifest__.py index 39f47e247..1fac0f943 100644 --- a/edi_storage_oca/__manifest__.py +++ b/edi_storage_oca/__manifest__.py @@ -15,6 +15,7 @@ "depends": ["edi_core_oca", "fs_storage"], "data": [ "data/cron.xml", + "data/edi_configuration.xml", "security/ir_model_access.xml", "views/edi_backend_views.xml", ], diff --git a/edi_storage_oca/data/edi_configuration.xml b/edi_storage_oca/data/edi_configuration.xml new file mode 100644 index 000000000..3b5a2ea15 --- /dev/null +++ b/edi_storage_oca/data/edi_configuration.xml @@ -0,0 +1,24 @@ + + + On record exchange done + on_edi_exchange_done + Trigger when a record exchange is done + + + On record exchange error + on_edi_exchange_error + Trigger when a record exchange has an error + + + Storage Move File on Done + + + record.on_edi_exchange_done() + + + Storage Move File on Error + + + record.on_edi_exchange_error() + + diff --git a/edi_storage_oca/models/edi_exchange_record.py b/edi_storage_oca/models/edi_exchange_record.py index 2ebbbe71e..796fca4d1 100644 --- a/edi_storage_oca/models/edi_exchange_record.py +++ b/edi_storage_oca/models/edi_exchange_record.py @@ -1,8 +1,14 @@ # Copyright 2024 Camptocamp SA # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +import functools +import os +from pathlib import PurePath + from odoo import fields, models +from .. import utils + class EDIExchangeRecord(models.Model): _inherit = "edi.exchange.record" @@ -13,3 +19,67 @@ class EDIExchangeRecord(models.Model): string="FS Storage", help="Record created from a file found in this FS storage", ) + + def _move_file(self, storage, from_dir_str, to_dir_str, filename): + from_dir = PurePath(from_dir_str) + to_dir = PurePath(to_dir_str) + # - storage.list_files now includes path in fs_storage, breaking change + # - we remove path + files = utils.list_files(storage, from_dir.as_posix()) + files = [os.path.basename(f) for f in files] + if filename not in files: + return False + self._add_post_commit_hook( + utils.move_files, + storage, + [(from_dir / filename).as_posix()], + to_dir.as_posix(), + ) + return True + + def _add_post_commit_hook( + self, move_func, storage, sftp_filepath, sftp_destination_path + ): + """Add hook after commit to move the file when transaction is over.""" + self.env.cr.postcommit.add( + functools.partial(move_func, storage, sftp_filepath, sftp_destination_path) + ) + + def on_edi_exchange_done(self): + storage = self.storage_id + res = False + if self.direction == "input" and storage: + file = self.exchange_filename + pending_dir = self.type_id._storage_fullpath( + self.backend_id.input_dir_pending + ).as_posix() + done_dir = self.type_id._storage_fullpath( + self.backend_id.input_dir_done + ).as_posix() + error_dir = self.type_id._storage_fullpath( + self.backend_id.input_dir_error + ).as_posix() + if not done_dir: + return res + res = self._move_file(storage, pending_dir, done_dir, file) + if not res: + # If a file previously failed it should have been previously + # moved to the error dir, therefore it is not present in the + # pending dir and we need to retry from error dir. + res = self._move_file(storage, error_dir, done_dir, file) + return res + + def on_edi_exchange_error(self): + storage = self.storage_id + res = False + if self.direction == "input" and storage: + file = self.exchange_filename + pending_dir = self.type_id._storage_fullpath( + self.backend_id.input_dir_pending + ).as_posix() + error_dir = self.type_id._storage_fullpath( + self.backend_id.input_dir_error + ).as_posix() + if error_dir: + res = self._move_file(storage, pending_dir, error_dir, file) + return res diff --git a/edi_storage_oca/static/description/index.html b/edi_storage_oca/static/description/index.html index 87b66f49d..7bc5d5df3 100644 --- a/edi_storage_oca/static/description/index.html +++ b/edi_storage_oca/static/description/index.html @@ -3,7 +3,7 @@ -README.rst +EDI Storage backend support -
+
+

EDI Storage backend support

- - -Odoo Community Association - -
-

EDI Storage backend support

-

Beta License: LGPL-3 OCA/edi-framework Translate me on Weblate Try me on Runboat

+

Beta License: LGPL-3 OCA/edi-framework Translate me on Weblate Try me on Runboat

Allow exchange files using storage backends from OCA/storage.

This module adds a storage backend relation on the EDI backend. There you can configure the backend to be used (most often and SFTP) and the @@ -411,18 +406,18 @@

EDI Storage backend support

-

Usage

+

Usage

Go to “EDI -> EDI backend” then configure your backend to use a storage backend.

-

Known issues / Roadmap

+

Known issues / Roadmap

  • clean deprecated methods in the storage
-

Bug Tracker

+

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed @@ -430,15 +425,15 @@

Bug Tracker

Do not contact contributors directly about support or help with technical issues.

-

Credits

+

Credits

-

Authors

+

Authors

  • ACSONE
-

Contributors

+

Contributors

-

Other credits

+

Other credits

The migration of this module from 15.0 to 16.0 was financially supported by Camptocamp.

-

Maintainers

+

Maintainers

This module is maintained by the OCA.

Odoo Community Association @@ -469,6 +464,5 @@

Maintainers

-
diff --git a/edi_storage_oca/tests/__init__.py b/edi_storage_oca/tests/__init__.py index 0a73fb8a1..33cc581c7 100644 --- a/edi_storage_oca/tests/__init__.py +++ b/edi_storage_oca/tests/__init__.py @@ -1,2 +1,3 @@ from . import test_edi_backend_storage from . import test_exchange_type +from . import test_edi_event_listenner diff --git a/edi_storage_oca/tests/test_edi_event_listenner.py b/edi_storage_oca/tests/test_edi_event_listenner.py new file mode 100644 index 000000000..9466f357f --- /dev/null +++ b/edi_storage_oca/tests/test_edi_event_listenner.py @@ -0,0 +1,110 @@ +# Copyright 2026 ForgeFlow S.L. (https://www.forgeflow.com) +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import base64 +from unittest import mock + +from odoo.tests.common import TransactionCase + +RECORD_MOCK_PATH = ( + "odoo.addons.edi_storage_oca.models.edi_exchange_record.EDIExchangeRecord" +) +BACKEND_MOCK_PATH = ( + "odoo.addons.edi_core_oca.models.edi_backend.EDIBackend._get_exec_handler" +) + + +class EDIBackendTestCase(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.backend = cls.env.ref("edi_storage_oca.demo_edi_backend_storage") + cls.exchange_type = cls.env.ref( + "edi_storage_oca.demo_edi_type_csv_input", raise_if_not_found=False + ) + if not cls.exchange_type: + cls.exchange_type = cls.env["edi.exchange.type"].create( + { + "name": "Test CSV Input", + "code": "test_csv_input", + "direction": "input", + "backend_id": cls.backend.id, + "backend_type_id": cls.backend.backend_type_id.id, + } + ) + cls.record = cls.env["edi.exchange.record"].create( + { + "type_id": cls.exchange_type.id, + "backend_id": cls.backend.id, + "exchange_file": base64.b64encode(b"1234"), + } + ) + + def setUp(self): + super().setUp() + self.fake_move_args = None + + def _mock_listener_move_file(self): + def _move_file_mocked(record, storage, from_dir_str, to_dir_str, filename): + if not self.fake_move_args: + self.fake_move_args = [storage, from_dir_str, to_dir_str, filename] + return True + + return mock.patch( + RECORD_MOCK_PATH + "._move_file", + autospec=True, + side_effect=_move_file_mocked, + ) + + def _mock_process_handler(self): + def _fake_exec_handler(backend, record, step): + def handler(rec): + if rec.env.context.get("test_break_process"): + rec.write({"edi_exchange_state": "input_processed_error"}) + rec._notify_error("process_ko") + return False + rec.write({"edi_exchange_state": "input_processed"}) + rec._notify_done() + return True + + return handler + + return mock.patch( + BACKEND_MOCK_PATH, autospec=True, side_effect=_fake_exec_handler + ) + + def test_01_process_record_success(self): + with self._mock_listener_move_file(), self._mock_process_handler(): + self.record.write( + { + "edi_exchange_state": "input_received", + "storage_id": self.backend.storage_id.id, + } + ) + self.record._set_file_content("TEST %d" % self.record.id) + self.record.action_exchange_process() + + storage, from_dir_str, to_dir_str, filename = self.fake_move_args + self.assertEqual(storage, self.backend.storage_id) + self.assertEqual(from_dir_str, self.backend.input_dir_pending) + self.assertEqual(to_dir_str, self.backend.input_dir_done) + self.assertEqual(filename, self.record.exchange_filename) + + def test_02_process_record_with_error(self): + with self._mock_listener_move_file(), self._mock_process_handler(): + self.record.write( + { + "edi_exchange_state": "input_received", + "storage_id": self.backend.storage_id.id, + } + ) + self.record._set_file_content("TEST %d" % self.record.id) + self.record.with_context( + test_break_process="OOPS!" + ).action_exchange_process() + + storage, from_dir_str, to_dir_str, filename = self.fake_move_args + self.assertEqual(storage, self.backend.storage_id) + self.assertEqual(from_dir_str, self.backend.input_dir_pending) + self.assertEqual(to_dir_str, self.backend.input_dir_error) + self.assertEqual(filename, self.record.exchange_filename)