[IMP] server_environmnet: allow to overwrite odoo config options from server_environment_files

Author: petrus-v

server_environment/README.rst

@@ -40,7 +40,7 @@ are stored in the ``server_environment_files`` companion module.
 
 The ``server_environment_files`` module is optional, the values can be
 set using an environment variable with a fallback on default values in
-the database.
+the database. You will be able to overwrite some odoo options.
 
 The configuration read from the files are visible under the
 Configuration menu. If you are not in the 'dev' environment you will not
@@ -106,6 +106,12 @@ example:
   can override or extend default values;
 - you can override or extend values in the main configuration file of
   your instance;
+* In some platforms (like odoo.sh where production config file is copied to staging)
+  it can be usefull to overwrite options write in the `[options]` section. You must
+  allow the overwrite by adding `server_environment_allow_overwrite_options_section = True``
+  to the former `odoo.cfg` config file or through the environment variable:
+  `export SERVER_ENVIRONMENT_ALLOW_OVERWRITE_OPTIONS_SECTION=True` (if both are set
+  config file take precedent).
 
 Environment variable
 --------------------

server_environment/server_env.py

@@ -107,6 +107,19 @@ def _listconf(env_path):
     return files
 
 
+def _update_odoo_config_options(config_p):
+    allow_overwrite = system_base_config.get(
+        "server_environment_allow_overwrite_options_section",
+        os.environ.get("SERVER_ENVIRONMENT_ALLOW_OVERWRITE_OPTIONS_SECTION"),
+    )
+    if isinstance(allow_overwrite, str) and allow_overwrite:
+        allow_overwrite = _boolean_states.get(allow_overwrite.lower(), False)
+    if allow_overwrite and config_p.has_section("options"):
+        system_base_config.options.update(
+            {k: v for k, v in config_p["options"].items()}
+        )
+
+
 def _load_config_from_server_env_files(config_p):
     default = os.path.join(_dir, "default")
     running_env = os.path.join(_dir, system_base_config["running_env"])
@@ -119,6 +132,7 @@ def _load_config_from_server_env_files(config_p):
         config_p.read(conf_files)
     except Exception as e:
         raise Exception(f'Cannot read config files "{conf_files}":  {e}') from e
+    _update_odoo_config_options(config_p)
 
 
 def _load_config_from_rcfile(config_p):

server_environment/static/description/index.html

@@ -382,7 +382,7 @@ <h1>server configuration environment files</h1>
 are stored in the <tt class="docutils literal">server_environment_files</tt> companion module.</p>
 <p>The <tt class="docutils literal">server_environment_files</tt> module is optional, the values can be
 set using an environment variable with a fallback on default values in
-the database.</p>
+the database. You will be able to overwrite some odoo options.</p>
 <p>The configuration read from the files are visible under the
 Configuration menu. If you are not in the ‘dev’ environment you will not
 be able to see the values contained in the defined secret keys (by
@@ -452,6 +452,12 @@ <h3><a class="toc-backref" href="#toc-entry-3">server_environment_files</a></h3>
 can override or extend default values;</li>
 <li>you can override or extend values in the main configuration file of
 your instance;</li>
+<li>In some platforms (like odoo.sh where production config file is copied to staging)
+it can be usefull to overwrite options write in the <cite>[options]</cite> section. You must
+allow the overwrite by adding <cite>server_environment_allow_overwrite_options_section = True`</cite>
+to the former <cite>odoo.cfg</cite> config file or through the environment variable:
+<cite>export SERVER_ENVIRONMENT_ALLOW_OVERWRITE_OPTIONS_SECTION=True</cite> (if both are set
+config file take precedent).</li>
 </ul>
 </div>
 <div class="section" id="environment-variable">

server_environment/tests/test_server_environment.py

@@ -88,3 +88,61 @@ def test_default_hidden_password(self):
         self.assertIn("odoo_I_db_password", defaults)
         self.assertIn("odoo_I_smtp_password", defaults)
         self.assertIn("outgoing_mail_provider_promail_I_smtp_pass", defaults)
+
+    @patch.dict(os.environ, {"SERVER_ENVIRONMENT_ALLOW_OVERWRITE_OPTIONS_SECTION": "0"})
+    @patch.dict(
+        odoo_config.options,
+        {
+            "running_env": "testing",
+            "server_environment_allow_overwrite_options_section": True,
+            "odoo_test_option": "fake odoo config",
+        },
+    )
+    def test_server_environment_allow_overwrite_options_section(self):
+        with self.set_config_dir("testfiles"):
+            server_env._load_config()
+            self.assertEqual(
+                odoo_config["odoo_test_option"], "Set in config file for testing env"
+            )
+
+    @patch.dict(os.environ, {"SERVER_ENVIRONMENT_ALLOW_OVERWRITE_OPTIONS_SECTION": "1"})
+    @patch.dict(
+        odoo_config.options,
+        {
+            "running_env": "testing",
+            "server_environment_allow_overwrite_options_section": False,
+            "odoo_test_option": "fake odoo config",
+        },
+    )
+    def test_server_environment_disabled_overwrite_options_section(self):
+        with self.set_config_dir("testfiles"):
+            server_env._load_config()
+            self.assertEqual(odoo_config["odoo_test_option"], "fake odoo config")
+
+    @patch.dict(os.environ, {"SERVER_ENVIRONMENT_ALLOW_OVERWRITE_OPTIONS_SECTION": "1"})
+    @patch.dict(
+        odoo_config.options,
+        {
+            "running_env": "testing",
+            "odoo_test_option": "fake odoo config",
+        },
+    )
+    def test_server_environment_allow_overwrite_options_section_by_env(self):
+        with self.set_config_dir("testfiles"):
+            server_env._load_config()
+            self.assertEqual(
+                odoo_config["odoo_test_option"], "Set in config file for testing env"
+            )
+
+    @patch.dict(os.environ, {"SERVER_ENVIRONMENT_ALLOW_OVERWRITE_OPTIONS_SECTION": "0"})
+    @patch.dict(
+        odoo_config.options,
+        {
+            "running_env": "testing",
+            "odoo_test_option": "fake odoo config",
+        },
+    )
+    def test_server_environment_disabled_overwrite_options_section_by_env(self):
+        with self.set_config_dir("testfiles"):
+            server_env._load_config()
+            self.assertEqual(odoo_config["odoo_test_option"], "fake odoo config")

server_environment/tests/testfiles/testing/base.conf

@@ -1,2 +1,5 @@
+[options]
+odoo_test_option = Set in config file for testing env
+
 [external_service.ftp]
 user = testing