[BPRT] edi_storage_oca: Backport from 14.0

Author: thienvh332

edi_storage_oca/README.rst

@@ -7,7 +7,7 @@ EDI Storage backend support
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:8b943f104b4d54ed51a4fb55f4e17ffe1ec3995e962bb7654ea4c5837d952673
+   !! source digest: sha256:58511c29ba3a21a1216a155c53ffb1da90ba5561d407af23213e4207b9a0bcaf
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -17,13 +17,13 @@ EDI Storage backend support
     :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-lightgray.png?logo=github
-    :target: https://github.com/OCA/edi/tree/14.0/edi_storage_oca
+    :target: https://github.com/OCA/edi/tree/12.0/edi_storage_oca
     :alt: OCA/edi
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/edi-14-0/edi-14-0-edi_storage_oca
+    :target: https://translation.odoo-community.org/projects/edi-12-0/edi-12-0-edi_storage_oca
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/builds?repo=OCA/edi&target_branch=14.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/edi&target_branch=12.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -68,7 +68,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/edi/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
-`feedback <https://github.com/OCA/edi/issues/new?body=module:%20edi_storage_oca%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/edi/issues/new?body=module:%20edi_storage_oca%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
@@ -86,6 +86,15 @@ Contributors
 * Simone Orsi <simahawk@gmail.com>
 * Foram Shah <foram.shah@initos.com>
 * Lois Rilo <lois.rilo@forgeflow.com>
+* `Trobz <https://trobz.com>`_:
+
+    * Thien <thienvh@trobz.com>
+
+
+Other credits
+~~~~~~~~~~~~~
+
+The backport of this module from 14.0 to 12.0 was financially supported by Camptocamp
 
 Maintainers
 ~~~~~~~~~~~
@@ -100,6 +109,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.
 
-This module is part of the `OCA/edi <https://github.com/OCA/edi/tree/14.0/edi_storage_oca>`_ project on GitHub.
+This module is part of the `OCA/edi <https://github.com/OCA/edi/tree/12.0/edi_storage_oca>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

edi_storage_oca/__manifest__.py

@@ -7,7 +7,7 @@
     "summary": """
     Base module to allow exchanging files via storage backend (eg: SFTP).
     """,
-    "version": "14.0.1.8.1",
+    "version": "12.0.1.0.1",
     "development_status": "Beta",
     "license": "LGPL-3",
     "website": "https://github.com/OCA/edi",

edi_storage_oca/components/listener.py

@@ -14,7 +14,7 @@ class EdiStorageListener(Component):
     def _move_file(self, storage, from_dir_str, to_dir_str, filename):
         from_dir = PurePath(from_dir_str)
         to_dir = PurePath(to_dir_str)
-        if filename not in storage.list_files(from_dir.as_posix()):
+        if filename not in storage._list(from_dir.as_posix()):
             # The file might have been moved after a previous error.
             return False
         self._add_after_commit_hook(
@@ -24,7 +24,7 @@ def _move_file(self, storage, from_dir_str, to_dir_str, filename):
 
     def _remove_file(self, storage, from_dir_str, filename):
         from_dir = PurePath(from_dir_str)
-        if filename not in storage.list_files(from_dir.as_posix()):
+        if filename not in storage._list(from_dir.as_posix()):
             # The file might have been moved after a previous error.
             return False
         self._add_after_commit_hook(storage.delete, (from_dir / filename).as_posix())

edi_storage_oca/models/edi_backend.py

@@ -140,8 +140,12 @@ def _storage_create_record_if_missing(self, exchange_type, remote_file_name):
         if existing:
             return
         record = self.create_record(
-            exchange_type.code, self._storage_new_exchange_record_vals(file_name)
+            exchange_type.code,
+            {
+                "edi_exchange_state": "input_pending"
+            }
         )
+        record.exchange_filename = file_name
         _logger.debug("%s: new exchange record generated.", self.name)
         return record.identifier
 
@@ -153,7 +157,7 @@ def _storage_get_input_filenames(self, exchange_type):
             # If there is not pattern, return everything
             filenames = [
                 x
-                for x in self.storage_id.list_files(full_input_dir_pending)
+                for x in self.storage_id._list(full_input_dir_pending)
                 if x.strip("/")
             ]
             return filenames
@@ -162,13 +166,10 @@ def _storage_get_input_filenames(self, exchange_type):
         if exchange_type.exchange_file_ext:
             bits.append(r"\." + exchange_type.exchange_file_ext)
         pattern = "".join(bits)
-        full_paths = self.storage_id.find_files(pattern, full_input_dir_pending)
+        full_paths = self.storage_id._find_files(pattern, full_input_dir_pending)
         pending_path_len = len(full_input_dir_pending)
         return [p[pending_path_len:].strip("/") for p in full_paths]
 
-    def _storage_new_exchange_record_vals(self, file_name):
-        return {"exchange_filename": file_name, "edi_exchange_state": "input_pending"}
-
     def _check_output_exchange_sync(self, **kw):
         # Do not skip sent records when dealing w/ storage related exchanges,
         # because we want to update the file state

edi_storage_oca/readme/CONTRIBUTORS.rst

@@ -1,3 +1,7 @@
 * Simone Orsi <simahawk@gmail.com>
 * Foram Shah <foram.shah@initos.com>
 * Lois Rilo <lois.rilo@forgeflow.com>
+* `Trobz <https://trobz.com>`_:
+
+    * Thien <thienvh@trobz.com>
+

edi_storage_oca/readme/CREDITS.rst

@@ -0,0 +1 @@
+The backport of this module from 14.0 to 12.0 was financially supported by Camptocamp

edi_storage_oca/static/description/index.html

@@ -367,9 +367,9 @@ <h1 class="title">EDI Storage backend support</h1>
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:8b943f104b4d54ed51a4fb55f4e17ffe1ec3995e962bb7654ea4c5837d952673
+!! source digest: sha256:58511c29ba3a21a1216a155c53ffb1da90ba5561d407af23213e4207b9a0bcaf
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/edi/tree/14.0/edi_storage_oca"><img alt="OCA/edi" src="https://img.shields.io/badge/github-OCA%2Fedi-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/edi-14-0/edi-14-0-edi_storage_oca"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/edi&amp;target_branch=14.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/edi/tree/12.0/edi_storage_oca"><img alt="OCA/edi" src="https://img.shields.io/badge/github-OCA%2Fedi-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/edi-12-0/edi-12-0-edi_storage_oca"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/edi&amp;target_branch=12.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>Allow exchange files using storage backends from <cite>OCA/storage</cite>.</p>
 <p>This module adds a storage backend relation on the EDI backend.
 There you can configure the backend to be used (most often and SFTP)
@@ -399,7 +399,8 @@ <h1 class="title">EDI Storage backend support</h1>
 <li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
 <li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
 <li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
+<li><a class="reference internal" href="#other-credits" id="toc-entry-6">Other credits</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
 </ul>
 </li>
 </ul>
@@ -413,7 +414,7 @@ <h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/edi/issues">GitHub Issues</a>.
 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
-<a class="reference external" href="https://github.com/OCA/edi/issues/new?body=module:%20edi_storage_oca%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/edi/issues/new?body=module:%20edi_storage_oca%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
@@ -426,20 +427,34 @@ <h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
 </div>
 <div class="section" id="contributors">
 <h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
+<ul>
+<li><p class="first">Simone Orsi &lt;<a class="reference external" href="mailto:simahawk&#64;gmail.com">simahawk&#64;gmail.com</a>&gt;</p>
+</li>
+<li><p class="first">Foram Shah &lt;<a class="reference external" href="mailto:foram.shah&#64;initos.com">foram.shah&#64;initos.com</a>&gt;</p>
+</li>
+<li><p class="first">Lois Rilo &lt;<a class="reference external" href="mailto:lois.rilo&#64;forgeflow.com">lois.rilo&#64;forgeflow.com</a>&gt;</p>
+</li>
+<li><p class="first"><a class="reference external" href="https://trobz.com">Trobz</a>:</p>
+<blockquote>
 <ul class="simple">
-<li>Simone Orsi &lt;<a class="reference external" href="mailto:simahawk&#64;gmail.com">simahawk&#64;gmail.com</a>&gt;</li>
-<li>Foram Shah &lt;<a class="reference external" href="mailto:foram.shah&#64;initos.com">foram.shah&#64;initos.com</a>&gt;</li>
-<li>Lois Rilo &lt;<a class="reference external" href="mailto:lois.rilo&#64;forgeflow.com">lois.rilo&#64;forgeflow.com</a>&gt;</li>
+<li>Thien &lt;<a class="reference external" href="mailto:thienvh&#64;trobz.com">thienvh&#64;trobz.com</a>&gt;</li>
 </ul>
+</blockquote>
+</li>
+</ul>
+</div>
+<div class="section" id="other-credits">
+<h2><a class="toc-backref" href="#toc-entry-6">Other credits</a></h2>
+<p>The backport of this module from 14.0 to 12.0 was financially supported by Camptocamp</p>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.</p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/edi/tree/14.0/edi_storage_oca">OCA/edi</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/edi/tree/12.0/edi_storage_oca">OCA/edi</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>

edi_storage_oca/tests/common.py

@@ -106,20 +106,22 @@ def _mocked_backend_list_files(self, mocked_paths, path, **kwargs):
 
     def _mock_storage_backend_get(self, mocked_paths):
         mocked = functools.partial(self._mocked_backend_get, mocked_paths)
-        return mock.patch(STORAGE_BACKEND_MOCK_PATH + ".get", mocked)
+        return mock.patch(STORAGE_BACKEND_MOCK_PATH + "._get_b64_data", mocked)
 
     def _mock_storage_backend_add(self):
-        return mock.patch(STORAGE_BACKEND_MOCK_PATH + ".add", self._mocked_backend_add)
+        return mock.patch(
+            STORAGE_BACKEND_MOCK_PATH + "._add_b64_data", self._mocked_backend_add
+        )
 
     def _mock_storage_backend_list_files(self, mocked_paths):
         mocked = functools.partial(self._mocked_backend_list_files, mocked_paths)
-        return mock.patch(STORAGE_BACKEND_MOCK_PATH + ".list_files", mocked)
+        return mock.patch(STORAGE_BACKEND_MOCK_PATH + "._list", mocked)
 
     def _mock_storage_backend_find_files(self, result):
         def _result(self, pattern, relative_path=None, **kw):
             return result
 
-        return mock.patch(STORAGE_BACKEND_MOCK_PATH + ".find_files", _result)
+        return mock.patch(STORAGE_BACKEND_MOCK_PATH + "._find_files", _result)
 
     def _test_result(
         self,

edi_storage_oca/tests/test_components_base.py

@@ -30,7 +30,7 @@ def test_remote_file_path(self):
             self.checker_input._get_remote_file_path("WHATEVER", "foo.csv")
 
     def test_get_remote_file(self):
-        with mock.patch(STORAGE_BACKEND_MOCK_PATH + ".get") as mocked:
+        with mock.patch(STORAGE_BACKEND_MOCK_PATH + "._get_b64_data") as mocked:
             self.checker._get_remote_file("pending")
             mocked.assert_called_with(
                 "demo_out/pending/{}".format(self._filename(self.record)), binary=False

edi_storage_oca/tests/test_edi_backend_storage.py

@@ -161,6 +161,10 @@ def test_cron_full_flow(self):
                 "exchange_file": rec1.exchange_file,
             }
         )
+        # Avoid the exchange_file name generated from the compute function
+        # of rec2 and rec3 is the same, leading to an incorrect test
+        rec2.exchange_filename = "rec2.csv"
+
         mocked_paths = {
             self._file_fullpath("done", record=rec1): self.fakepath,
             self._file_fullpath("error", record=rec2): self.fakepath,

edi_storage_oca/tests/test_edi_storage_listener.py

@@ -75,7 +75,6 @@ def test_02_process_record_with_error(self):
 
     def test_03_process_record_success_delete(self):
         self.backend.write({"input_dir_remove": True, "input_dir_done": False})
-        self.backend.flush()
 
         with self._mock_listener_remove_file():
             self.record.write({"edi_exchange_state": "input_received"})