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..bd32c164a 100644 --- a/edi_storage_oca/__manifest__.py +++ b/edi_storage_oca/__manifest__.py @@ -12,7 +12,7 @@ "license": "LGPL-3", "website": "https://github.com/OCA/edi-framework", "author": "ACSONE,Odoo Community Association (OCA)", - "depends": ["edi_core_oca", "fs_storage"], + "depends": ["edi_core_oca", "fs_storage", "edi_component_oca"], "data": [ "data/cron.xml", "security/ir_model_access.xml", diff --git a/edi_storage_oca/models/__init__.py b/edi_storage_oca/models/__init__.py index f9d92a329..152f1b3ba 100644 --- a/edi_storage_oca/models/__init__.py +++ b/edi_storage_oca/models/__init__.py @@ -2,3 +2,4 @@ from . import edi_exchange_type from . import edi_exchange_record from . import edi_oca_storage_handler +from . import edi_event_listener diff --git a/edi_storage_oca/models/edi_event_listener.py b/edi_storage_oca/models/edi_event_listener.py new file mode 100644 index 000000000..7df276794 --- /dev/null +++ b/edi_storage_oca/models/edi_event_listener.py @@ -0,0 +1,79 @@ +# Copyright 2021 ForgeFlow S.L. (https://www.forgeflow.com) +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import functools +import os +from pathlib import PurePath + +from odoo.addons.component.core import Component + +from .. import utils + + +class EdiStorageListener(Component): + _name = "edi.storage.component.listener" + _inherit = "base.event.listener" + + 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, record): + storage = record.storage_id + res = False + if record.direction == "input" and storage: + file = record.exchange_filename + pending_dir = record.type_id._storage_fullpath( + record.backend_id.input_dir_pending + ).as_posix() + done_dir = record.type_id._storage_fullpath( + record.backend_id.input_dir_done + ).as_posix() + error_dir = record.type_id._storage_fullpath( + record.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, record): + storage = record.storage_id + res = False + if record.direction == "input" and storage: + file = record.exchange_filename + pending_dir = record.type_id._storage_fullpath( + record.backend_id.input_dir_pending + ).as_posix() + error_dir = record.type_id._storage_fullpath( + record.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..68e0f2ac7 --- /dev/null +++ b/edi_storage_oca/tests/test_edi_event_listenner.py @@ -0,0 +1,82 @@ +# 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.addons.edi_component_oca.tests.common import ( + EDIBackendCommonComponentRegistryTestCase, +) +from odoo.addons.edi_component_oca.tests.fake_components import FakeInputProcess + +LISTENER_MOCK_PATH = ( + "odoo.addons.edi_storage_oca.models.edi_event_listener.EdiStorageListener" +) + + +class EDIBackendTestCase(EDIBackendCommonComponentRegistryTestCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls._load_module_components(cls, "edi_storage_oca") + cls._build_components( + cls, + FakeInputProcess, + ) + vals = { + "model": cls.partner._name, + "res_id": cls.partner.id, + "exchange_file": base64.b64encode(b"1234"), + } + cls.record = cls.backend.create_record("test_csv_input", vals) + cls.fake_move_args = None + + @classmethod + def _get_backend(cls): + return cls.env.ref("edi_storage_oca.demo_edi_backend_storage") + + def setUp(self): + super().setUp() + FakeInputProcess.reset_faked() + + def _move_file_mocked(self, *args): + self.fake_move_args = [*args] + if not all([*args]): + return False + return True + + def _mock_listener_move_file(self): + return mock.patch(LISTENER_MOCK_PATH + "._move_file", self._move_file_mocked) + + def test_01_process_record_success(self): + with self._mock_listener_move_file(): + self.record.write( + { + "edi_exchange_state": "input_received", + "storage_id": self.backend.storage_id.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.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! Something went wrong :(" + ).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)