diff --git a/server_environment_autocreate/LICENSE b/server_environment_autocreate/LICENSE new file mode 100644 index 000000000..0a041280b --- /dev/null +++ b/server_environment_autocreate/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/server_environment_autocreate/README.rst b/server_environment_autocreate/README.rst new file mode 100644 index 000000000..ae0d28329 --- /dev/null +++ b/server_environment_autocreate/README.rst @@ -0,0 +1,163 @@ +============================= +Server Environment Autocreate +============================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:c41974e39c6f11adbecf0ad0a3a5d3ce800c956e62b57a0ba270146c2de654a1 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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-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%2Fserver--env-lightgray.png?logo=github + :target: https://github.com/OCA/server-env/tree/18.0/server_environment_autocreate + :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_autocreate + :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 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module adds a way to create automaticaly records using +server_environment server.env.mixin. + +**Table of contents** + +.. contents:: + :local: + +Use Cases / Context +=================== + +Modules that uses server_environment server.env.mixin need to be created +manually in the database. This module avoid that needs by adding a way +to autocreate records. + +Configuration +============= + +This module does not need any configuration in Odoo. + +The configuration is made in either server_environment_files, the +environment variable or the configuration file as described in +server_environment. + +On top of the fields available when defining a record inheriting +server.env.mixin, it is possible to add ``__autocreate = {}``. The value +is a dictionary that will be passed when the record is created. This +allows setting required field values that are not made available. The +values are only used once, when the object is created. Changes are not +used. + +To continue the example provided by server_environment, to have this +module create the record for storage_backend.my_sftp, the file would +look like: + +:: + + # These variables are not odoo standard variables, + # they are there to represent what your file could look like + export WORKERS='8' + export MAX_CRON_THREADS='1' + export LOG_LEVEL=info + export LOG_HANDLER=":INFO" + export DB_MAXCONN=5 + + # server environment options + export SERVER_ENV_CONFIG=" + [storage_backend.my_sftp] + __autocreate={} + sftp_server=10.10.10.10 + sftp_login=foo + sftp_port=22200 + directory_path=Odoo + " + +Another example, using a value in the creation dictionnary, when using +`fs_storage `__ +module, the name of the storage is required so the configuration would +look like: + +.. code:: ini + + [fs_storage.my_sftp] + __autocreate = {"name": "My SFTP"} + protocol=sftp + options={"host": "10.10.10.10", "username": "foo", "password": "xxxxxxxxx"} + +When the module creates such a record, it will add an xml id in the form +``__server_environment_autocreate__.
``. + +When the module is removed, the created record are kept. They can be +found by searching the xmlid for the pseudo module +``__server_environment_autocreate__``. + +If the creation fails with an exception, or if the values dictionary is +incorrect, this will prevent the loading of the registry. This is +intended, so that odoo does not start without the intended +configuration. + +Usage +===== + +This module does not impact the user interface. + +Known issues / Roadmap +====================== + +- This module does not guarantee that any model record can be created, + extra steps might be needed. +- If a created record is not referenced in the configuration anymore, + it is not removed. + +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 +------- + +* XCG Consulting + +Contributors +------------ + +- XCG Consulting, part of `Orbeet `__: + + - Vincent Hatakeyama + +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_autocreate/__init__.py b/server_environment_autocreate/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/server_environment_autocreate/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/server_environment_autocreate/__manifest__.py b/server_environment_autocreate/__manifest__.py new file mode 100644 index 000000000..998c83a7f --- /dev/null +++ b/server_environment_autocreate/__manifest__.py @@ -0,0 +1,14 @@ +# Copyright 2025 XCG Consulting +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html) + +{ + "name": "Server Environment Autocreate", + "summary": """Add ability to auto create records""", + "version": "18.0.1.0.0", + "license": "LGPL-3", + "author": "XCG Consulting,Odoo Community Association (OCA)", + "depends": ["server_environment"], + "development_status": "Beta", + "category": "Tools", + "website": "https://github.com/OCA/server-env", +} diff --git a/server_environment_autocreate/models/__init__.py b/server_environment_autocreate/models/__init__.py new file mode 100644 index 000000000..6bd869a1e --- /dev/null +++ b/server_environment_autocreate/models/__init__.py @@ -0,0 +1 @@ +from . import server_env_mixin diff --git a/server_environment_autocreate/models/server_env_mixin.py b/server_environment_autocreate/models/server_env_mixin.py new file mode 100644 index 000000000..1fcf1ffb7 --- /dev/null +++ b/server_environment_autocreate/models/server_env_mixin.py @@ -0,0 +1,64 @@ +# Copyright 2024, 2028 XCG Consulting (https://xcg-consulting.fr). +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html) +import logging +from ast import literal_eval + +from odoo import api, models # type: ignore[import-untyped] + +from odoo.addons.server_environment.server_env import serv_config + +_logger = logging.getLogger(__name__) + + +class ServerEnvMixin(models.AbstractModel): + """Inherited to add autocreation of records when register_hook is called.""" + + _inherit = "server.env.mixin" + + _server_env_allow_autocreate: bool = True + + @api.model + def _get_server_env_section_name(self, section_name: str) -> None | str: + """From the full section name of the configuration, allow to get the name if + the section matches the model. + For example “storage_backend.my_sftp” (used in server_environement + documentation) would return “my_sftp” on the model “storage.backend”. + + This is the inverse of :meth:`~_server_env_section_name`, so this method + needs to be redefined when that method is changed. + + :param section_name: name of the configuration section + :return: None if the section name does not match, the section name otherwise. + """ + global_section_name = self._server_env_global_section_name() + if section_name.startswith(f"{global_section_name}."): + return section_name[len(global_section_name) + 1 :] + return None + + def _register_hook(self): + super()._register_hook() + if self._server_env_allow_autocreate: + for section in serv_config: + name_value = self._get_server_env_section_name(section) + if name_value is None: + continue + if not serv_config[section].get("__autocreate", None): + continue + domain = [(self._server_env_section_name_field, "=", name_value)] + count = self.with_context(active_test=False).search_count(domain) + if not count: + _logger.info("Automatic creation of section %s", section) + values = literal_eval(serv_config[section].get("__autocreate")) + values[self._server_env_section_name_field] = name_value + records = self.create([values]) + self.env["ir.model.data"].create( + [ + { + "name": section.replace(" ", "_"), + "model": self._name, + "module": "__server_environment_autocreate__", + "res_id": record.id, + } + for record in records + ] + ) diff --git a/server_environment_autocreate/pyproject.toml b/server_environment_autocreate/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/server_environment_autocreate/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/server_environment_autocreate/readme/CONFIGURE.md b/server_environment_autocreate/readme/CONFIGURE.md new file mode 100644 index 000000000..03bb36467 --- /dev/null +++ b/server_environment_autocreate/readme/CONFIGURE.md @@ -0,0 +1,45 @@ +This module does not need any configuration in Odoo. + +The configuration is made in either server_environment_files, the environment variable or the configuration file as described in server_environment. + +On top of the fields available when defining a record inheriting server.env.mixin, it is possible to add `__autocreate = {}`. +The value is a dictionary that will be passed when the record is created. +This allows setting required field values that are not made available. +The values are only used once, when the object is created. Changes are not used. + +To continue the example provided by server_environment, to have this module create the record for storage_backend.my_sftp, the file would look like: + + # These variables are not odoo standard variables, + # they are there to represent what your file could look like + export WORKERS='8' + export MAX_CRON_THREADS='1' + export LOG_LEVEL=info + export LOG_HANDLER=":INFO" + export DB_MAXCONN=5 + + # server environment options + export SERVER_ENV_CONFIG=" + [storage_backend.my_sftp] + __autocreate={} + sftp_server=10.10.10.10 + sftp_login=foo + sftp_port=22200 + directory_path=Odoo + " + +Another example, using a value in the creation dictionnary, when using [fs_storage](https://github.com/OCA/storage/tree/17.0/fs_storage) module, the name of the storage is required so the configuration would look like: + +```ini +[fs_storage.my_sftp] +__autocreate = {"name": "My SFTP"} +protocol=sftp +options={"host": "10.10.10.10", "username": "foo", "password": "xxxxxxxxx"} +``` + +When the module creates such a record, it will add an xml id in the form `__server_environment_autocreate__.
`. + +When the module is removed, the created record are kept. +They can be found by searching the xmlid for the pseudo module `__server_environment_autocreate__`. + +If the creation fails with an exception, or if the values dictionary is incorrect, this will prevent the loading of the +registry. This is intended, so that odoo does not start without the intended configuration. diff --git a/server_environment_autocreate/readme/CONTEXT.md b/server_environment_autocreate/readme/CONTEXT.md new file mode 100644 index 000000000..ddc259ca6 --- /dev/null +++ b/server_environment_autocreate/readme/CONTEXT.md @@ -0,0 +1,2 @@ +Modules that uses server_environment server.env.mixin need to be created manually in the database. +This module avoid that needs by adding a way to autocreate records. diff --git a/server_environment_autocreate/readme/CONTRIBUTORS.md b/server_environment_autocreate/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..fc66b0012 --- /dev/null +++ b/server_environment_autocreate/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- XCG Consulting, part of [Orbeet](https://orbeet.io/): + - Vincent Hatakeyama \<\> diff --git a/server_environment_autocreate/readme/DESCRIPTION.md b/server_environment_autocreate/readme/DESCRIPTION.md new file mode 100644 index 000000000..03cabcab6 --- /dev/null +++ b/server_environment_autocreate/readme/DESCRIPTION.md @@ -0,0 +1 @@ +This module adds a way to create automaticaly records using server_environment server.env.mixin. diff --git a/server_environment_autocreate/readme/ROADMAP.md b/server_environment_autocreate/readme/ROADMAP.md new file mode 100644 index 000000000..420e92140 --- /dev/null +++ b/server_environment_autocreate/readme/ROADMAP.md @@ -0,0 +1,2 @@ +- This module does not guarantee that any model record can be created, extra steps might be needed. +- If a created record is not referenced in the configuration anymore, it is not removed. diff --git a/server_environment_autocreate/readme/USAGE.md b/server_environment_autocreate/readme/USAGE.md new file mode 100644 index 000000000..710118c9e --- /dev/null +++ b/server_environment_autocreate/readme/USAGE.md @@ -0,0 +1 @@ +This module does not impact the user interface. diff --git a/server_environment_autocreate/static/description/icon.png b/server_environment_autocreate/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/server_environment_autocreate/static/description/icon.png differ diff --git a/server_environment_autocreate/static/description/index.html b/server_environment_autocreate/static/description/index.html new file mode 100644 index 000000000..e81114a68 --- /dev/null +++ b/server_environment_autocreate/static/description/index.html @@ -0,0 +1,504 @@ + + + + + +Server Environment Autocreate + + + +
+

Server Environment Autocreate

+ + +

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

+

This module adds a way to create automaticaly records using +server_environment server.env.mixin.

+

Table of contents

+ +
+

Use Cases / Context

+

Modules that uses server_environment server.env.mixin need to be created +manually in the database. This module avoid that needs by adding a way +to autocreate records.

+
+
+

Configuration

+

This module does not need any configuration in Odoo.

+

The configuration is made in either server_environment_files, the +environment variable or the configuration file as described in +server_environment.

+

On top of the fields available when defining a record inheriting +server.env.mixin, it is possible to add __autocreate = {}. The value +is a dictionary that will be passed when the record is created. This +allows setting required field values that are not made available. The +values are only used once, when the object is created. Changes are not +used.

+

To continue the example provided by server_environment, to have this +module create the record for storage_backend.my_sftp, the file would +look like:

+
+# These variables are not odoo standard variables,
+# they are there to represent what your file could look like
+export WORKERS='8'
+export MAX_CRON_THREADS='1'
+export LOG_LEVEL=info
+export LOG_HANDLER=":INFO"
+export DB_MAXCONN=5
+
+# server environment options
+export SERVER_ENV_CONFIG="
+[storage_backend.my_sftp]
+__autocreate={}
+sftp_server=10.10.10.10
+sftp_login=foo
+sftp_port=22200
+directory_path=Odoo
+"
+
+

Another example, using a value in the creation dictionnary, when using +fs_storage +module, the name of the storage is required so the configuration would +look like:

+
+[fs_storage.my_sftp]
+__autocreate = {"name": "My SFTP"}
+protocol=sftp
+options={"host": "10.10.10.10", "username": "foo", "password": "xxxxxxxxx"}
+
+

When the module creates such a record, it will add an xml id in the form +__server_environment_autocreate__.<section name with space replaced by ->.

+

When the module is removed, the created record are kept. They can be +found by searching the xmlid for the pseudo module +__server_environment_autocreate__.

+

If the creation fails with an exception, or if the values dictionary is +incorrect, this will prevent the loading of the registry. This is +intended, so that odoo does not start without the intended +configuration.

+
+
+

Usage

+

This module does not impact the user interface.

+
+
+

Known issues / Roadmap

+
    +
  • This module does not guarantee that any model record can be created, +extra steps might be needed.
  • +
  • If a created record is not referenced in the configuration anymore, +it is not removed.
  • +
+
+
+

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

+
    +
  • XCG Consulting
  • +
+
+
+

Contributors

+ +
+
+

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_autocreate/tests/__init__.py b/server_environment_autocreate/tests/__init__.py new file mode 100644 index 000000000..7890390fa --- /dev/null +++ b/server_environment_autocreate/tests/__init__.py @@ -0,0 +1 @@ +from . import test_server_environment_autocreate diff --git a/server_environment_autocreate/tests/files/autocreate/base.conf b/server_environment_autocreate/tests/files/autocreate/base.conf new file mode 100644 index 000000000..d11b8b813 --- /dev/null +++ b/server_environment_autocreate/tests/files/autocreate/base.conf @@ -0,0 +1,14 @@ +[external_service.ftp 1] +__autocreate={"description": "ftp server"} + +[external_service.ftp2] +__autocreate={"description": "ftp2"} +host=sftp2.example.com +user=monty +password=python + +[external_service_2.ftp] +__autocreate={"description": "ftp"} +host=sftp.example.com +user=monty +password=python diff --git a/server_environment_autocreate/tests/files/default/base.conf b/server_environment_autocreate/tests/files/default/base.conf new file mode 100644 index 000000000..4cabb5baa --- /dev/null +++ b/server_environment_autocreate/tests/files/default/base.conf @@ -0,0 +1,7 @@ +[external_service.ftp 1] +host = sftp.example.com +user = foo +password = bar + +[external_service.ftp 3] +host = sftp3.example.com diff --git a/server_environment_autocreate/tests/models.py b/server_environment_autocreate/tests/models.py new file mode 100644 index 000000000..badbf1321 --- /dev/null +++ b/server_environment_autocreate/tests/models.py @@ -0,0 +1,31 @@ +# Copyright 2024 XCG Consulting +# @author Vincent Hatakeyama +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +from odoo import fields, models + + +class ExternalService(models.Model): + _name = "external_service" + _description = "External Service" + _inherit = "server.env.mixin" + + name = fields.Char(required=True) + description = fields.Char(required=True) + host = fields.Char() + user = fields.Char() + password = fields.Char() + + @property + def _server_env_fields(self): + return { + "host": {}, + "user": {}, + "password": {}, + } + + +class ExternalService2(models.Model): + _name = "external_service_2" + _inherit = "external_service" + _description = "External Service 2" + _server_env_allow_autocreate = False diff --git a/server_environment_autocreate/tests/test_server_environment_autocreate.py b/server_environment_autocreate/tests/test_server_environment_autocreate.py new file mode 100644 index 000000000..802e76642 --- /dev/null +++ b/server_environment_autocreate/tests/test_server_environment_autocreate.py @@ -0,0 +1,88 @@ +# Copyright 2018 Camptocamp (https://www.camptocamp.com). +# Copyright 2024, 2025 XCG Consulting (https://xcg-consulting.fr). +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html) +import os +from unittest.mock import patch + +from odoo_test_helper import FakeModelLoader + +from odoo.tests import tagged # type: ignore[import-untyped] +from odoo.tools.config import config # type: ignore[import-untyped] + +from odoo.addons.server_environment import server_env # type: ignore[import-untyped] +from odoo.addons.server_environment.models import server_env_mixin +from odoo.addons.server_environment.tests import common + +from ..models import server_env_mixin as server_env_mixin_2 + + +# Test need to be run post install otherwise the _register_hook is not called yet +@tagged("post_install", "-at_install") +class TestEnv(common.ServerEnvironmentCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + # Load fake models ->/ + cls.loader = FakeModelLoader(cls.env, cls.__module__) + cls.loader.backup_registry() + from .models import ExternalService, ExternalService2 + + cls.loader.update_registry((ExternalService, ExternalService2)) + cls.env["external_service"].create([{"name": "ftp2", "description": "another"}]) + + @classmethod + def tearDownClass(cls): + cls.loader.restore_registry() + super().tearDownClass() + + @patch.dict(config.options, {"running_env": "autocreate"}) + def test_autocreate(self): + original_serv_config = server_env_mixin.serv_config + try: + with self.set_config_dir(os.path.join(os.path.dirname(__file__), "files")): + parser = server_env._load_config() + server_env_mixin.serv_config = parser + server_env_mixin_2.serv_config = parser + # Needed to force _register_hook with auto creation + self.loader.update_registry(tuple()) + + # auto created record + record = self.env.ref( + "__server_environment_autocreate__.external_service.ftp_1" + ) + self.assertEqual(record.name, "ftp 1") + self.assertEqual(record.description, "ftp server") + self.assertEqual(record.host, "sftp.example.com") + self.assertEqual(record.user, "foo") + self.assertEqual(record.password, "bar") + + # create record in setupClass + # Test it has no xmlid + record = self.env.ref( + "__server_environment_autocreate__.external_service.ftp2", False + ) + self.assertFalse(record) + # look for it + record = self.env["external_service"].search([("name", "=", "ftp2")]) + self.assertEqual(len(record), 1) + self.assertEqual(record.name, "ftp2") + # different from __autocreate dict as it is created in setUpClass + self.assertEqual(record.description, "another") + self.assertEqual(record.host, "sftp2.example.com") + self.assertEqual(record.user, "monty") + self.assertEqual(record.password, "python") + + # assert no creation if autocreate to false on model + self.assertFalse( + self.env.ref( + "__server_environment_autocreate__.external_service_2.ftp", + False, + ) + ) + self.assertFalse( + self.env["external_service_2"].search([("name", "=", "ftp")]) + ) + + finally: + server_env_mixin.serv_config = original_serv_config + server_env_mixin_2.serv_config = original_serv_config