[MIG] server_environment_data_encryption: Migration to v17.0 (backport from v18)

Author: petrus-v

data_encryption/tests/common.py

@@ -14,23 +14,33 @@
 
 
 class CommonDataEncrypted(TransactionCase):
-    def setUp(self):
-        super().setUp()
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
 
-        self.encrypted_data = self.env["encrypted.data"]
-        self.set_new_key_env("test")
-        self.old_running_env = config.get("running_env", "")
+        cls.encrypted_data = cls.env["encrypted.data"]
+        cls.set_new_key_env("test")
+        old_running_env = config.get("running_env", "")
+
+        def reset_running_env():
+            config["running_env"] = old_running_env
+
+        cls.addClassCleanup(reset_running_env)
         config["running_env"] = "test"
-        self.crypted_data_name = "test_model,1"
+        cls.crypted_data_name = "test_model,1"
 
-    def set_new_key_env(self, environment):
+    @classmethod
+    def set_new_key_env(cls, environment):
         crypting_key = Fernet.generate_key()
         # The key is encoded to bytes in the module, because in real life
         # the key com from the config file and is not in a binary format.
         # So we decode here to avoid having a special behavior because of
         # the tests.
-        config[f"encryption_key_{environment}"] = crypting_key.decode()
+        encryption_key_environment_config_name = f"encryption_key_{environment}"
+        old_key = config.get(encryption_key_environment_config_name, "")
+
+        def reset_config_key():
+            config[encryption_key_environment_config_name] = old_key
 
-    def tearDown(self):
-        config["running_env"] = self.old_running_env
-        return super().tearDown()
+        cls.addClassCleanup(reset_config_key)
+        config[encryption_key_environment_config_name] = crypting_key.decode()

server_environment_data_encryption/README.rst

@@ -10,20 +10,20 @@ Server Environment Data Encryption
    !! source digest: sha256:d332eb4ca40eb79923ed865b069723db1c2f7be0946a840d9e1cd3197939915e
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
-.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
+.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
     :target: https://odoo-community.org/page/development-status
-    :alt: Production/Stable
+    :alt: Alpha
 .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github
-    :target: https://github.com/OCA/server-env/tree/18.0/server_environment_data_encryption
+    :target: https://github.com/OCA/server-env/tree/17.0/server_environment_data_encryption
     :alt: OCA/server-env
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/server-env-18-0/server-env-18-0-server_environment_data_encryption
+    :target: https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-server_environment_data_encryption
     :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/server-env&target_branch=18.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=17.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -34,6 +34,11 @@ file, it will fallback on a Odoo encrypted field instead. Also it allows
 you to configure the environment dependent fields for all your
 environments from the production server.
 
+.. IMPORTANT::
+   This is an alpha version, the data model and design can change at any time without warning.
+   Only for development or testing purpose, do not use in production.
+   `More details on development status <https://odoo-community.org/page/development-status>`_
+
 **Table of contents**
 
 .. contents::
@@ -78,7 +83,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/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/server-env/issues/new?body=module:%20server_environment_data_encryption%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20server_environment_data_encryption%0Aversion:%2017.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.
 
@@ -118,6 +123,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
 
 |maintainer-florian-dacosta| 
 
-This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/18.0/server_environment_data_encryption>`_ project on GitHub.
+This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/17.0/server_environment_data_encryption>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

server_environment_data_encryption/__manifest__.py

@@ -1,8 +1,8 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 {
     "name": "Server Environment Data Encryption",
-    "version": "18.0.1.0.0",
-    "development_status": "Production/Stable",
+    "version": "17.0.1.0.0",
+    "development_status": "Alpha",
     "maintainers": ["florian-dacosta"],
     "category": "Tools",
     "website": "https://github.com/OCA/server-env",

server_environment_data_encryption/models/server_env_mixin.py

@@ -4,7 +4,7 @@
 
 from lxml import etree
 
-from odoo import api, models
+from odoo import _, api, models
 from odoo.exceptions import ValidationError
 from odoo.tools.config import config
 
@@ -98,7 +98,7 @@ def _get_extra_environment_info_div(self, current_env, all_environments):
         # display a warning instead as the module has no effect.
         if not self._current_env_encrypted_key_exists():
             button_div = "<div>"
-            warning_string = self.env._(
+            warning_string = _(
                 "The encryption key for current environement is not defined"
             )
             elem = etree.fromstring(
@@ -119,17 +119,15 @@ def _get_extra_environment_info_div(self, current_env, all_environments):
                 and "alert-info"
                 or "alert-warning"
             )
-            alert_string = self.env._("Modify values for {} environment").format(
-                environment
-            )
+            alert_string = _("Modify values for {} environment").format(environment)
             elem_string += f"""
               <div class="alert lead {alert_type} text-center d-inline"
             invisible="context.get('environment', '{current_env}') != '{environment}'">
                   <strong>{alert_string}</strong>
               </div>
             """
         button_div = """<div class="d-flex gap-1 flex-wrap align-items-center">"""
-        button_string = self.env._("Define values for ")
+        button_string = _("Define values for ")
         for environment in all_environments:
             button = """
             <button name="action_change_env_data_encrypted_fields"
@@ -186,7 +184,7 @@ def _update_form_view_from_env(self, arch, view_type):
 
         if not current_env:
             raise ValidationError(
-                self.env._(
+                _(
                     "you need to define the running_env entry in your odoo "
                     "configuration file"
                 )

server_environment_data_encryption/static/description/index.html

@@ -369,12 +369,18 @@ <h1 class="title">Server Environment Data Encryption</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:d332eb4ca40eb79923ed865b069723db1c2f7be0946a840d9e1cd3197939915e
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-env/tree/18.0/server_environment_data_encryption"><img alt="OCA/server-env" src="https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-env-18-0/server-env-18-0-server_environment_data_encryption"><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/server-env&amp;target_branch=18.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="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-env/tree/17.0/server_environment_data_encryption"><img alt="OCA/server-env" src="https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-server_environment_data_encryption"><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/server-env&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module changes a little the behavior of server_environment modules.
 When Odoo does not find the value of the field in the configuration
 file, it will fallback on a Odoo encrypted field instead. Also it allows
 you to configure the environment dependent fields for all your
 environments from the production server.</p>
+<div class="admonition important">
+<p class="first admonition-title">Important</p>
+<p class="last">This is an alpha version, the data model and design can change at any time without warning.
+Only for development or testing purpose, do not use in production.
+<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
+</div>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -419,7 +425,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/server-env/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/server-env/issues/new?body=module:%20server_environment_data_encryption%0Aversion:%2018.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/server-env/issues/new?body=module:%20server_environment_data_encryption%0Aversion:%2017.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">
@@ -449,7 +455,7 @@ <h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
 promote its widespread use.</p>
 <p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
 <p><a class="reference external image-reference" href="https://github.com/florian-dacosta"><img alt="florian-dacosta" src="https://github.com/florian-dacosta.png?size=40px" /></a></p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-env/tree/18.0/server_environment_data_encryption">OCA/server-env</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-env/tree/17.0/server_environment_data_encryption">OCA/server-env</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>