diff --git a/server_environment_ir_config_parameter/README.rst b/server_environment_ir_config_parameter/README.rst new file mode 100644 index 000000000..22e7cad49 --- /dev/null +++ b/server_environment_ir_config_parameter/README.rst @@ -0,0 +1,121 @@ +====================================== +Server Environment Ir Config Parameter +====================================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:29c97aeb304203d7c075a8ff1295720253ea06b1f8d4fc57ef0fa71b45f3a38b + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/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/17.0/server_environment_ir_config_parameter + :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-17-0/server-env-17-0-server_environment_ir_config_parameter + :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=17.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Override System Parameters from server environment file. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +To configure this module, you need to add a section +``[ir.config_parameter]`` to you server_environment_files +configurations, where the keys are the same as would normally be set in +the Systems Parameter Odoo menu. + +When first using a value, the system will read it from the configuration +file and override any value that would be present in the database, so +the configuration file has precedence. + +When creating or modifying values that are in the configuration file, +the module replace changes, enforcing the configuration value. + +For example you can use this module in combination with +web_environment_ribbon: + +:: + + [ir.config_parameter] + ribbon.name=DEV + +Usage +===== + +Before using this module, you must be familiar with the +server_environment module. + +Known issues / Roadmap +====================== + +When the user modifies System Parameters that are defined in the config +file, the changes are ignored. It would be nice to display which system +parameters come from the config file and possibly make their key and +value readonly in the user interface. + +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 +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* ACSONE SA/NV + +Contributors +------------ + +- Stéphane Bidoul (https://acsone.eu) +- Thierry Ducrest +- Gilles Meyomesse (https://acsone.eu) +- Sylvain LE GAL (https://www.twitter.com/legalsylvain) + +Other credits +------------- + +This module is maintained by: \* Odoo Community Association + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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/server-env `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/server_environment_ir_config_parameter/__init__.py b/server_environment_ir_config_parameter/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/server_environment_ir_config_parameter/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/server_environment_ir_config_parameter/__manifest__.py b/server_environment_ir_config_parameter/__manifest__.py new file mode 100644 index 000000000..839bd9d2c --- /dev/null +++ b/server_environment_ir_config_parameter/__manifest__.py @@ -0,0 +1,16 @@ +# Copyright 2016-2018 ACSONE SA/NV +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +{ + "name": "Server Environment Ir Config Parameter", + "summary": """ + Override System Parameters from server environment file""", + "version": "17.0.1.0.0", + "license": "AGPL-3", + "author": "ACSONE SA/NV, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/server-env", + "depends": ["server_environment"], + "data": [ + "views/view_ir_config_parameter.xml", + ], +} diff --git a/server_environment_ir_config_parameter/i18n/de.po b/server_environment_ir_config_parameter/i18n/de.po new file mode 100644 index 000000000..c9de0a841 --- /dev/null +++ b/server_environment_ir_config_parameter/i18n/de.po @@ -0,0 +1,46 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * server_environment_ir_config_parameter +# +# Translators: +# Niki Waibel , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-06-22 01:12+0000\n" +"PO-Revision-Date: 2017-06-22 01:12+0000\n" +"Last-Translator: Niki Waibel , 2017\n" +"Language-Team: German (https://www.transifex.com/oca/teams/23907/de/)\n" +"Language: de\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,field_description:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "Defined by environment" +msgstr "" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,help:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "" +"If check, the value in the database will be ignored and alternatively, the " +"system will use the key defined in your odoo.cfg environment file." +msgstr "" + +#. module: server_environment_ir_config_parameter +#. odoo-python +#: code:addons/server_environment_ir_config_parameter/models/ir_config_parameter.py:0 +#, python-format +msgid "Key %s is empty in server_environment_file" +msgstr "" + +#. module: server_environment_ir_config_parameter +#: model:ir.model,name:server_environment_ir_config_parameter.model_ir_config_parameter +msgid "System Parameter" +msgstr "" + +#~ msgid "ir.config_parameter" +#~ msgstr "ir.config_parameter" diff --git a/server_environment_ir_config_parameter/i18n/es.po b/server_environment_ir_config_parameter/i18n/es.po new file mode 100644 index 000000000..b63bd54a1 --- /dev/null +++ b/server_environment_ir_config_parameter/i18n/es.po @@ -0,0 +1,49 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * server_environment_ir_config_parameter +# +# Translators: +# Pedro M. Baeza , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-06-22 01:12+0000\n" +"PO-Revision-Date: 2023-07-25 13:10+0000\n" +"Last-Translator: Ivorra78 \n" +"Language-Team: Spanish (https://www.transifex.com/oca/teams/23907/es/)\n" +"Language: es\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 4.17\n" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,field_description:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "Defined by environment" +msgstr "Definido por el entorno" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,help:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "" +"If check, the value in the database will be ignored and alternatively, the " +"system will use the key defined in your odoo.cfg environment file." +msgstr "" +"Si se marca, el valor en la base de datos será ignorado y alternativamente, " +"el sistema utilizará la clave definida en su archivo de entorno odoo.cfg." + +#. module: server_environment_ir_config_parameter +#. odoo-python +#: code:addons/server_environment_ir_config_parameter/models/ir_config_parameter.py:0 +#, python-format +msgid "Key %s is empty in server_environment_file" +msgstr "La clave %s está vacía en server_environment_file" + +#. module: server_environment_ir_config_parameter +#: model:ir.model,name:server_environment_ir_config_parameter.model_ir_config_parameter +msgid "System Parameter" +msgstr "Parámetros del sistema" + +#~ msgid "ir.config_parameter" +#~ msgstr "ir.config_parameter" diff --git a/server_environment_ir_config_parameter/i18n/it.po b/server_environment_ir_config_parameter/i18n/it.po new file mode 100644 index 000000000..da0c37bfc --- /dev/null +++ b/server_environment_ir_config_parameter/i18n/it.po @@ -0,0 +1,46 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * server_environment_ir_config_parameter +# +# Translators: +# Paolo Valier , 2018 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2018-01-06 02:25+0000\n" +"PO-Revision-Date: 2018-01-06 02:25+0000\n" +"Last-Translator: Paolo Valier , 2018\n" +"Language-Team: Italian (https://www.transifex.com/oca/teams/23907/it/)\n" +"Language: it\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,field_description:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "Defined by environment" +msgstr "" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,help:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "" +"If check, the value in the database will be ignored and alternatively, the " +"system will use the key defined in your odoo.cfg environment file." +msgstr "" + +#. module: server_environment_ir_config_parameter +#. odoo-python +#: code:addons/server_environment_ir_config_parameter/models/ir_config_parameter.py:0 +#, python-format +msgid "Key %s is empty in server_environment_file" +msgstr "" + +#. module: server_environment_ir_config_parameter +#: model:ir.model,name:server_environment_ir_config_parameter.model_ir_config_parameter +msgid "System Parameter" +msgstr "" + +#~ msgid "ir.config_parameter" +#~ msgstr "ir.config_parameter" diff --git a/server_environment_ir_config_parameter/i18n/nl_NL.po b/server_environment_ir_config_parameter/i18n/nl_NL.po new file mode 100644 index 000000000..900b4a0fa --- /dev/null +++ b/server_environment_ir_config_parameter/i18n/nl_NL.po @@ -0,0 +1,47 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * server_environment_ir_config_parameter +# +# Translators: +# Peter Hageman , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-06-22 01:12+0000\n" +"PO-Revision-Date: 2017-06-22 01:12+0000\n" +"Last-Translator: Peter Hageman , 2017\n" +"Language-Team: Dutch (Netherlands) (https://www.transifex.com/oca/" +"teams/23907/nl_NL/)\n" +"Language: nl_NL\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,field_description:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "Defined by environment" +msgstr "" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,help:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "" +"If check, the value in the database will be ignored and alternatively, the " +"system will use the key defined in your odoo.cfg environment file." +msgstr "" + +#. module: server_environment_ir_config_parameter +#. odoo-python +#: code:addons/server_environment_ir_config_parameter/models/ir_config_parameter.py:0 +#, python-format +msgid "Key %s is empty in server_environment_file" +msgstr "sleutel %s is leeg in server_environment_file" + +#. module: server_environment_ir_config_parameter +#: model:ir.model,name:server_environment_ir_config_parameter.model_ir_config_parameter +msgid "System Parameter" +msgstr "" + +#~ msgid "ir.config_parameter" +#~ msgstr "ir.config_parameter" diff --git a/server_environment_ir_config_parameter/i18n/ro.po b/server_environment_ir_config_parameter/i18n/ro.po new file mode 100644 index 000000000..cd11348c2 --- /dev/null +++ b/server_environment_ir_config_parameter/i18n/ro.po @@ -0,0 +1,47 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * server_environment_ir_config_parameter +# +# Translators: +# Dorin Hongu , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-12-16 02:17+0000\n" +"PO-Revision-Date: 2017-12-16 02:17+0000\n" +"Last-Translator: Dorin Hongu , 2017\n" +"Language-Team: Romanian (https://www.transifex.com/oca/teams/23907/ro/)\n" +"Language: ro\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=3; plural=(n==1?0:(((n%100>19)||((n%100==0)&&(n!=0)))?" +"2:1));\n" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,field_description:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "Defined by environment" +msgstr "" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,help:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "" +"If check, the value in the database will be ignored and alternatively, the " +"system will use the key defined in your odoo.cfg environment file." +msgstr "" + +#. module: server_environment_ir_config_parameter +#. odoo-python +#: code:addons/server_environment_ir_config_parameter/models/ir_config_parameter.py:0 +#, python-format +msgid "Key %s is empty in server_environment_file" +msgstr "" + +#. module: server_environment_ir_config_parameter +#: model:ir.model,name:server_environment_ir_config_parameter.model_ir_config_parameter +msgid "System Parameter" +msgstr "" + +#~ msgid "ir.config_parameter" +#~ msgstr "ir.config_parameter" diff --git a/server_environment_ir_config_parameter/i18n/server_environment_ir_config_parameter.pot b/server_environment_ir_config_parameter/i18n/server_environment_ir_config_parameter.pot new file mode 100644 index 000000000..231ddf986 --- /dev/null +++ b/server_environment_ir_config_parameter/i18n/server_environment_ir_config_parameter.pot @@ -0,0 +1,38 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * server_environment_ir_config_parameter +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,field_description:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "Defined by environment" +msgstr "" + +#. module: server_environment_ir_config_parameter +#: model:ir.model.fields,help:server_environment_ir_config_parameter.field_ir_config_parameter__is_environment +msgid "" +"If check, the value in the database will be ignored and alternatively, the " +"system will use the key defined in your odoo.cfg environment file." +msgstr "" + +#. module: server_environment_ir_config_parameter +#. odoo-python +#: code:addons/server_environment_ir_config_parameter/models/ir_config_parameter.py:0 +#, python-format +msgid "Key %s is empty in server_environment_file" +msgstr "" + +#. module: server_environment_ir_config_parameter +#: model:ir.model,name:server_environment_ir_config_parameter.model_ir_config_parameter +msgid "System Parameter" +msgstr "" diff --git a/server_environment_ir_config_parameter/models/__init__.py b/server_environment_ir_config_parameter/models/__init__.py new file mode 100644 index 000000000..bd3aa9f10 --- /dev/null +++ b/server_environment_ir_config_parameter/models/__init__.py @@ -0,0 +1 @@ +from . import ir_config_parameter diff --git a/server_environment_ir_config_parameter/models/ir_config_parameter.py b/server_environment_ir_config_parameter/models/ir_config_parameter.py new file mode 100644 index 000000000..a620fe43c --- /dev/null +++ b/server_environment_ir_config_parameter/models/ir_config_parameter.py @@ -0,0 +1,75 @@ +# Copyright 2016-2018 ACSONE SA/NV +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import _, api, fields, models +from odoo.exceptions import UserError + +from odoo.addons.server_environment.server_env import serv_config + +SECTION = "ir.config_parameter" + + +class IrConfigParameter(models.Model): + _inherit = "ir.config_parameter" + + is_environment = fields.Boolean( + string="Defined by environment", + compute="_compute_is_environment", + help="If check, the value in the database will be ignored" + " and alternatively, the system will use the key defined" + " in your odoo.cfg environment file.", + ) + + def _compute_is_environment(self): + for parameter in self: + parameter.is_environment = serv_config.has_option(SECTION, parameter.key) + + @api.model + def get_param(self, key, default=False): + value = super().get_param(key, default=None) + if serv_config.has_option(SECTION, key): + cvalue = serv_config.get(SECTION, key) + if not cvalue: + raise UserError( + _("Key %s is empty in " "server_environment_file") % (key,) + ) + if cvalue != value: + # we write in db on first access; + # should we have preloaded values in database at, + # server startup, modules loading their parameters + # from data files would break on unique key error. + if not self.env.context.get("_from_get_param", 0): + # the check is to avoid recursion, for instance the mail + # addon has an override in ir.config_parameter::write which + # calls get_param if we are setting mail.catchall.alias and + # this will cause an infinite recursion. We cut that + # recursion by using the context check. + # + # The mail addon call to get_param expects to get the value + # *before* the change, so we have to return the database + # value in that case + self.sudo().with_context(_from_get_param=1).set_param(key, cvalue) + value = cvalue + if value is None: + return default + return value + + @api.model_create_multi + def create(self, vals_list): + for vals in vals_list: + key = vals.get("key") + if key and serv_config.has_option(SECTION, key): + # enforce value from config file + vals.update(value=serv_config.get(SECTION, key)) + return super().create(vals_list) + + def write(self, vals): + for rec in self: + key = vals.get("key", rec.key) + if serv_config.has_option(SECTION, key): + # enforce value from config file + newvals = dict(vals, value=serv_config.get(SECTION, key)) + else: + newvals = vals + super(IrConfigParameter, rec).write(newvals) + return True diff --git a/server_environment_ir_config_parameter/pyproject.toml b/server_environment_ir_config_parameter/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/server_environment_ir_config_parameter/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/server_environment_ir_config_parameter/readme/CONFIGURE.md b/server_environment_ir_config_parameter/readme/CONFIGURE.md new file mode 100644 index 000000000..50c628832 --- /dev/null +++ b/server_environment_ir_config_parameter/readme/CONFIGURE.md @@ -0,0 +1,19 @@ +To configure this module, you need to add a section +`[ir.config_parameter]` to you server_environment_files configurations, +where the keys are the same as would normally be set in the Systems +Parameter Odoo menu. + +When first using a value, the system will read it from the configuration +file and override any value that would be present in the database, so +the configuration file has precedence. + +When creating or modifying values that are in the configuration file, +the module replace changes, enforcing the configuration value. + +For example you can use this module in combination with +web_environment_ribbon: + +``` +[ir.config_parameter] +ribbon.name=DEV +``` diff --git a/server_environment_ir_config_parameter/readme/CONTRIBUTORS.md b/server_environment_ir_config_parameter/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..a69e986b1 --- /dev/null +++ b/server_environment_ir_config_parameter/readme/CONTRIBUTORS.md @@ -0,0 +1,5 @@ +- Stéphane Bidoul \<\> () +- Thierry Ducrest \<\> +- Gilles Meyomesse \<\> + () +- Sylvain LE GAL () diff --git a/server_environment_ir_config_parameter/readme/CREDITS.md b/server_environment_ir_config_parameter/readme/CREDITS.md new file mode 100644 index 000000000..a91ab79e0 --- /dev/null +++ b/server_environment_ir_config_parameter/readme/CREDITS.md @@ -0,0 +1 @@ +This module is maintained by: \* Odoo Community Association diff --git a/server_environment_ir_config_parameter/readme/DESCRIPTION.md b/server_environment_ir_config_parameter/readme/DESCRIPTION.md new file mode 100644 index 000000000..8ffc000b2 --- /dev/null +++ b/server_environment_ir_config_parameter/readme/DESCRIPTION.md @@ -0,0 +1 @@ +Override System Parameters from server environment file. diff --git a/server_environment_ir_config_parameter/readme/ROADMAP.md b/server_environment_ir_config_parameter/readme/ROADMAP.md new file mode 100644 index 000000000..f01d3f232 --- /dev/null +++ b/server_environment_ir_config_parameter/readme/ROADMAP.md @@ -0,0 +1,4 @@ +When the user modifies System Parameters that are defined in the config +file, the changes are ignored. It would be nice to display which system +parameters come from the config file and possibly make their key and +value readonly in the user interface. diff --git a/server_environment_ir_config_parameter/readme/USAGE.md b/server_environment_ir_config_parameter/readme/USAGE.md new file mode 100644 index 000000000..44c0bc634 --- /dev/null +++ b/server_environment_ir_config_parameter/readme/USAGE.md @@ -0,0 +1,2 @@ +Before using this module, you must be familiar with the +server_environment module. diff --git a/server_environment_ir_config_parameter/static/description/icon.png b/server_environment_ir_config_parameter/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/server_environment_ir_config_parameter/static/description/icon.png differ diff --git a/server_environment_ir_config_parameter/static/description/index.html b/server_environment_ir_config_parameter/static/description/index.html new file mode 100644 index 000000000..7ca6374e0 --- /dev/null +++ b/server_environment_ir_config_parameter/static/description/index.html @@ -0,0 +1,462 @@ + + + + + + +Server Environment Ir Config Parameter + + + +
+

Server Environment Ir Config Parameter

+ + +

Beta License: AGPL-3 OCA/server-env Translate me on Weblate Try me on Runboat

+

Override System Parameters from server environment file.

+

Table of contents

+ +
+

Configuration

+

To configure this module, you need to add a section +[ir.config_parameter] to you server_environment_files +configurations, where the keys are the same as would normally be set in +the Systems Parameter Odoo menu.

+

When first using a value, the system will read it from the configuration +file and override any value that would be present in the database, so +the configuration file has precedence.

+

When creating or modifying values that are in the configuration file, +the module replace changes, enforcing the configuration value.

+

For example you can use this module in combination with +web_environment_ribbon:

+
+[ir.config_parameter]
+ribbon.name=DEV
+
+
+
+

Usage

+

Before using this module, you must be familiar with the +server_environment module.

+
+
+

Known issues / Roadmap

+

When the user modifies System Parameters that are defined in the config +file, the changes are ignored. It would be nice to display which system +parameters come from the config file and possibly make their key and +value readonly in the user interface.

+
+
+

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 +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • ACSONE SA/NV
    • +
+
+ +
+

Other credits

+

This module is maintained by: * Odoo Community Association

+
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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/server-env project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/server_environment_ir_config_parameter/tests/__init__.py b/server_environment_ir_config_parameter/tests/__init__.py new file mode 100644 index 000000000..83a250db1 --- /dev/null +++ b/server_environment_ir_config_parameter/tests/__init__.py @@ -0,0 +1 @@ +from . import test_server_environment_ircp diff --git a/server_environment_ir_config_parameter/tests/config_param_test.xml b/server_environment_ir_config_parameter/tests/config_param_test.xml new file mode 100644 index 000000000..297a14e9b --- /dev/null +++ b/server_environment_ir_config_parameter/tests/config_param_test.xml @@ -0,0 +1,11 @@ + + + ircp_from_config + value_from_xml + + + + other_ircp_from_config + other_value_from_xml + + diff --git a/server_environment_ir_config_parameter/tests/test_server_environment_ircp.py b/server_environment_ir_config_parameter/tests/test_server_environment_ircp.py new file mode 100644 index 000000000..1e918aa70 --- /dev/null +++ b/server_environment_ir_config_parameter/tests/test_server_environment_ircp.py @@ -0,0 +1,169 @@ +# Copyright 2016-2018 ACSONE SA/NV +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +from os import path + +from odoo.exceptions import UserError +from odoo.tools import convert_file, file_path + +from odoo.addons.server_environment.tests.common import ServerEnvironmentCase + +from ..models import ir_config_parameter + +CONFIG = """ + [ir.config_parameter] + ircp_from_config=config_value + other_ircp_from_config=other_config_value + ircp_without_record=config_value_without_record + other_ircp_without_record=other_config_value_without_record + ircp_empty= + mail.catchall.alias=my_alias +""" + + +class TestEnv(ServerEnvironmentCase): + def setUp(self): + super().setUp() + self.ICP = self.env["ir.config_parameter"] + self.env_config = CONFIG + + def _load_xml(self, module, filepath): + convert_file( + self.env, + module, + path.join(file_path(module), filepath), + {}, + mode="init", + noupdate=False, + kind="test", + ) + + def test_get_param(self): + """Get system parameter from config""" + with self.load_config( + public=self.env_config, serv_config_class=ir_config_parameter + ): + # it's not in db + res = self.ICP.search([("key", "=", "ircp_from_config")]) + self.assertFalse(res) + # read so it's created in db + value = self.ICP.get_param("ircp_from_config") + self.assertEqual(value, "config_value") + # now it's in db + res = self.ICP.search([("key", "=", "ircp_from_config")]) + self.assertEqual(len(res), 1) + self.assertEqual(res.value, "config_value") + + def test_set_param_1(self): + """We can't set parameters that are in config file""" + with self.load_config( + public=self.env_config, serv_config_class=ir_config_parameter + ): + # when creating, the value is overridden by config file + self.ICP.set_param("ircp_from_config", "new_value") + value = self.ICP.get_param("ircp_from_config") + self.assertEqual(value, "config_value") + # when writing, the value is overridden by config file + res = self.ICP.search([("key", "=", "ircp_from_config")]) + self.assertEqual(len(res), 1) + res.write({"value": "new_value"}) + value = self.ICP.get_param("ircp_from_config") + self.assertEqual(value, "config_value") + # unlink works normally... + res = self.ICP.search([("key", "=", "ircp_from_config")]) + self.assertEqual(len(res), 1) + res.unlink() + res = self.ICP.search([("key", "=", "ircp_from_config")]) + self.assertEqual(len(res), 0) + # but the value is recreated when getting param again + value = self.ICP.get_param("ircp_from_config") + self.assertEqual(value, "config_value") + res = self.ICP.search([("key", "=", "ircp_from_config")]) + self.assertEqual(len(res), 1) + + def test_set_param_2(self): + """We can set parameters that are not in config file""" + with self.load_config( + public=self.env_config, serv_config_class=ir_config_parameter + ): + self.ICP.set_param("some.param", "new_value") + self.assertEqual(self.ICP.get_param("some.param"), "new_value") + res = self.ICP.search([("key", "=", "some.param")]) + res.unlink() + res = self.ICP.search([("key", "=", "some.param")]) + self.assertFalse(res) + + def test_empty(self): + """Empty config values cause error""" + with self.load_config( + public=self.env_config, serv_config_class=ir_config_parameter + ): + with self.assertRaises(UserError): + self.ICP.get_param("ircp_empty") + self.assertEqual(self.ICP.get_param("ircp_nonexistant"), False) + + def test_override_xmldata(self): + with self.load_config( + public=self.env_config, serv_config_class=ir_config_parameter + ): + self._load_xml( + "server_environment_ir_config_parameter", "tests/config_param_test.xml" + ) + value = self.ICP.get_param("ircp_from_config") + self.assertEqual(value, "config_value") + + def test_read_mail_catchall_alias(self): + """read mail.catchall.alias from server env: + + this must not break the mail addon's overload""" + with self.load_config( + public=self.env_config, serv_config_class=ir_config_parameter + ): + value = self.ICP.get_param("mail.catchall.alias") + self.assertEqual(value, "my_alias") + res = self.ICP.search([("key", "=", "mail.catchall.alias")]) + self.assertEqual(len(res), 1) + self.assertEqual(res.value, "my_alias") + + def test_write(self): + # there's a write override, test it here + self._load_xml( + "server_environment_ir_config_parameter", "tests/config_param_test.xml" + ) + with self.load_config( + public=self.env_config, serv_config_class=ir_config_parameter + ): + ICP = self.ICP + icp1 = ICP.search([("key", "=", "ircp_from_config")]) + self.assertEqual(icp1.value, "value_from_xml") + icp2 = ICP.search([("key", "=", "other_ircp_from_config")]) + self.assertEqual(icp2.value, "other_value_from_xml") + # Ensures that each record has its own value at write + (icp1 | icp2).write({"value": "test"}) + self.assertEqual(icp1.value, "config_value") + self.assertEqual(icp2.value, "other_config_value") + self.assertEqual(ICP.get_param(icp1.key), "config_value") + self.assertEqual(ICP.get_param(icp2.key), "other_config_value") + + def test_create(self): + self._load_xml( + "server_environment_ir_config_parameter", "tests/config_param_test.xml" + ) + with self.load_config( + public=self.env_config, serv_config_class=ir_config_parameter + ): + vals = [ + { + "key": "ircp_without_record", + "value": "NOPE", + }, + { + "key": "other_ircp_without_record", + "value": "NOPE", + }, + ] + records = self.ICP.create(vals) + # Ensures each record has its own value at create + self.assertEqual( + records.mapped("value"), + ["config_value_without_record", "other_config_value_without_record"], + ) diff --git a/server_environment_ir_config_parameter/views/view_ir_config_parameter.xml b/server_environment_ir_config_parameter/views/view_ir_config_parameter.xml new file mode 100644 index 000000000..709c3862c --- /dev/null +++ b/server_environment_ir_config_parameter/views/view_ir_config_parameter.xml @@ -0,0 +1,35 @@ + + + + + + ir.config_parameter + + + + + + + + + + ir.config_parameter + + + + + + + is_environment + + + is_environment + + + + +