diff --git a/README.md b/README.md index 7cafc6f57..f0505ddfc 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ addon | version | maintainers | summary [base_external_dbsource](base_external_dbsource/) | 16.0.1.0.1 | | External Database Sources [base_external_dbsource_mssql](base_external_dbsource_mssql/) | 16.0.1.0.1 | [![anddago78](https://github.com/anddago78.png?size=30px)](https://github.com/anddago78) | External Database Source - MSSQL [base_external_dbsource_sqlite](base_external_dbsource_sqlite/) | 16.0.1.0.1 | [![anddago78](https://github.com/anddago78.png?size=30px)](https://github.com/anddago78) | External Database Source - SQLite +[base_external_system](base_external_system/) | 16.0.1.0.0 | | Data models allowing for connection to external systems. [base_global_discount](base_global_discount/) | 16.0.1.0.0 | | Base Global Discount [base_import_match](base_import_match/) | 16.0.1.0.0 | | Try to avoid duplicates before importing [base_portal_type](base_portal_type/) | 16.0.1.0.0 | [![hbrunn](https://github.com/hbrunn.png?size=30px)](https://github.com/hbrunn) | Base module to allow different types of portals diff --git a/base_external_system/README.rst b/base_external_system/README.rst new file mode 100644 index 000000000..0f1b5ac32 --- /dev/null +++ b/base_external_system/README.rst @@ -0,0 +1,125 @@ +==================== +Base External System +==================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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--backend-lightgray.png?logo=github + :target: https://github.com/OCA/server-backend/tree/16.0/base_external_system + :alt: OCA/server-backend +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-backend-16-0/server-backend-16-0-base_external_system + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/253/16.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module provides an interface/adapter mechanism for the definition of remote +systems. + +Note that this module stores everything in plain text. In the interest of security, +it is recommended you use another module (such as `keychain` or `red_october` to +encrypt things like the password and private key). This is not done here in order +to not force a specific security method. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +Configure external systems in Settings => Technical => External Systems + +Usage +===== + +The credentials for systems are stored in the ``external.system`` model, and are to +be configured by the user. This model is the unified interface for the underlying +adapters. + +Using the Interface +~~~~~~~~~~~~~~~~~~~ + +Given an ``external.system`` singleton called ``external_system``, you would do the +following to get the underlying system client: + +.. code-block:: python + + with external_system.client() as client: + client.do_something() + +The client will be destroyed once the context has completed. Destruction takes place +in the adapter's ``external_destroy_client`` method. + +The only unified aspect of this interface is the client connection itself. Other more +opinionated interface/adapter mechanisms can be implemented in other modules, such as +the file system interface in `OCA/server-tools/external_file_location +`_. + +Creating an Adapter +~~~~~~~~~~~~~~~~~~~ + +Modules looking to add an external system adapter should inherit the +``external.system.adapter`` model and override the following methods: + +* ``external_get_client``: Returns a usable client for the system +* ``external_destroy_client``: Destroy the connection, if applicable. Does not need + to be defined if the connection destroys itself. + +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 smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* LasLabs + +Contributors +~~~~~~~~~~~~ + +* Dave Lasley +* Ronald Portier +* `Tecnativa `__: + + * Alexandre Díaz + * César A. Sánchez + +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-backend `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_external_system/__init__.py b/base_external_system/__init__.py new file mode 100644 index 000000000..0639de1b6 --- /dev/null +++ b/base_external_system/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from . import models diff --git a/base_external_system/__manifest__.py b/base_external_system/__manifest__.py new file mode 100644 index 000000000..b51d6e7c2 --- /dev/null +++ b/base_external_system/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +{ + "name": "Base External System", + "summary": "Data models allowing for connection to external systems.", + "version": "16.0.1.0.0", + "category": "Base", + "website": "https://github.com/OCA/server-backend", + "author": "LasLabs, " "Odoo Community Association (OCA)", + "license": "LGPL-3", + "application": False, + "installable": True, + "depends": ["base"], + "data": [ + "demo/external_system_os_demo.xml", + "security/ir.model.access.csv", + "views/external_system_view.xml", + ], +} diff --git a/base_external_system/demo/external_system_os_demo.xml b/base_external_system/demo/external_system_os_demo.xml new file mode 100644 index 000000000..ff6b10fa1 --- /dev/null +++ b/base_external_system/demo/external_system_os_demo.xml @@ -0,0 +1,13 @@ + + + + + Example OS Connection + external.system.os + /tmp + + + diff --git a/base_external_system/i18n/base_external_system.pot b/base_external_system/i18n/base_external_system.pot new file mode 100644 index 000000000..805b719fd --- /dev/null +++ b/base_external_system/i18n/base_external_system.pot @@ -0,0 +1,286 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_external_system +# +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: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__company_ids +#: model:ir.model.fields,help:base_external_system.field_external_system_os__company_ids +msgid "Access to this system is restricted to these companies." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__company_ids +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__company_ids +msgid "Companies" +msgstr "" + +#. module: base_external_system +#: model:ir.model.constraint,message:base_external_system.constraint_external_system_name_uniq +msgid "Connection name must be unique." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__create_uid +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__create_uid +msgid "Created by" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__create_date +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__create_date +msgid "Created on" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__display_name +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__display_name +msgid "Display Name" +msgstr "" + +#. module: base_external_system +#: model:ir.model,name:base_external_system.model_external_system +#: model_terms:ir.ui.view,arch_db:base_external_system.external_system_view_form +msgid "External System" +msgstr "" + +#. module: base_external_system +#: model:ir.model,name:base_external_system.model_external_system_adapter +msgid "External System Adapter" +msgstr "" + +#. module: base_external_system +#: model:ir.model,name:base_external_system.model_external_system_os +msgid "External System OS" +msgstr "" + +#. module: base_external_system +#: model:ir.actions.act_window,name:base_external_system.external_system_action +#: model:ir.ui.menu,name:base_external_system.menu_external_system +#: model_terms:ir.ui.view,arch_db:base_external_system.external_system_view_search +msgid "External Systems" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__fingerprint +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__fingerprint +msgid "Fingerprint" +msgstr "" + +#. module: base_external_system +#. odoo-python +#: code:addons/base_external_system/models/external_system.py:0 +#, python-format +msgid "Fingerprint cannot be empty when Ignore Fingerprint is not checked." +msgstr "" + +#. module: base_external_system +#: model_terms:ir.ui.view,arch_db:base_external_system.external_system_view_search +msgid "Group By" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__host +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__host +#: model_terms:ir.ui.view,arch_db:base_external_system.external_system_view_search +msgid "Host" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__id +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__id +msgid "ID" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__ignore_fingerprint +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__ignore_fingerprint +msgid "Ignore Fingerprint" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__interface +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__interface +msgid "Interface" +msgstr "" + +#. module: base_external_system +#: model_terms:ir.ui.view,arch_db:base_external_system.external_system_view_form +msgid "Keys" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system____last_update +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os____last_update +msgid "Last Modified on" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__write_uid +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__write_uid +msgid "Last Updated by" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__write_date +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__write_date +msgid "Last Updated on" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__name +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__name +msgid "Name" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__password +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__password +msgid "Password" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__port +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__port +#: model_terms:ir.ui.view,arch_db:base_external_system.external_system_view_search +msgid "Port" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__private_key +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__private_key +msgid "Private Key" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__private_key_password +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__private_key_password +msgid "Private Key Password" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__remote_path +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__remote_path +msgid "Remote Path" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__remote_path +#: model:ir.model.fields,help:base_external_system.field_external_system_os__remote_path +msgid "Restrict to this directory path on the remote, if applicable." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__ignore_fingerprint +#: model:ir.model.fields,help:base_external_system.field_external_system_os__ignore_fingerprint +msgid "" +"Set this to `True` in order to ignore an invalid/unknown fingerprint from " +"the system." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system_adapter__system_id +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__system_id +msgid "System" +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__system_type +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__system_type +msgid "System Type" +msgstr "" + +#. module: base_external_system +#: model_terms:ir.ui.view,arch_db:base_external_system.external_system_view_form +msgid "Test Connection" +msgstr "" + +#. module: base_external_system +#. odoo-python +#: code:addons/base_external_system/models/external_system_adapter.py:0 +#, python-format +msgid "The connection was a success." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__name +#: model:ir.model.fields,help:base_external_system.field_external_system_os__name +msgid "This is the canonical (humanized) name for the system." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__host +#: model:ir.model.fields,help:base_external_system.field_external_system_os__host +msgid "This is the domain or IP address that the system can be reached at." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__fingerprint +#: model:ir.model.fields,help:base_external_system.field_external_system_os__fingerprint +msgid "" +"This is the fingerprint that is advertised by this system in order to " +"validate its identity." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__interface +#: model:ir.model.fields,help:base_external_system.field_external_system_os__interface +msgid "" +"This is the interface that this system represents. It is created " +"automatically upon creation of the external system." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__password +#: model:ir.model.fields,help:base_external_system.field_external_system_os__password +msgid "" +"This is the password that is used for authenticating to this system, if " +"applicable." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__private_key_password +#: model:ir.model.fields,help:base_external_system.field_external_system_os__private_key_password +msgid "" +"This is the password to unlock the private key that was provided for this " +"sytem." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__port +#: model:ir.model.fields,help:base_external_system.field_external_system_os__port +msgid "This is the port number that the system is listening on." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__private_key +#: model:ir.model.fields,help:base_external_system.field_external_system_os__private_key +msgid "" +"This is the private key that is used for authenticating to this system, if " +"applicable." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,help:base_external_system.field_external_system__username +#: model:ir.model.fields,help:base_external_system.field_external_system_os__username +msgid "" +"This is the username that is used for authenticating to this system, if " +"applicable." +msgstr "" + +#. module: base_external_system +#: model:ir.model.fields,field_description:base_external_system.field_external_system__username +#: model:ir.model.fields,field_description:base_external_system.field_external_system_os__username +#: model_terms:ir.ui.view,arch_db:base_external_system.external_system_view_search +msgid "Username" +msgstr "" diff --git a/base_external_system/models/__init__.py b/base_external_system/models/__init__.py new file mode 100644 index 000000000..84d6fa273 --- /dev/null +++ b/base_external_system/models/__init__.py @@ -0,0 +1,3 @@ +from . import external_system +from . import external_system_adapter +from . import external_system_os diff --git a/base_external_system/models/external_system.py b/base_external_system/models/external_system.py new file mode 100644 index 000000000..e2d79435a --- /dev/null +++ b/base_external_system/models/external_system.py @@ -0,0 +1,124 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from contextlib import contextmanager + +from odoo import _, api, fields, models +from odoo.exceptions import ValidationError + + +class ExternalSystem(models.Model): + + _name = "external.system" + _description = "External System" + + name = fields.Char( + required=True, + help="This is the canonical (humanized) name for the system.", + ) + host = fields.Char( + help="This is the domain or IP address that the system can be reached " "at.", + ) + port = fields.Integer( + help="This is the port number that the system is listening on.", + ) + username = fields.Char( + help="This is the username that is used for authenticating to this " + "system, if applicable.", + ) + password = fields.Char( + help="This is the password that is used for authenticating to this " + "system, if applicable.", + ) + private_key = fields.Text( + help="This is the private key that is used for authenticating to " + "this system, if applicable.", + ) + private_key_password = fields.Text( + help="This is the password to unlock the private key that was " + "provided for this sytem.", + ) + fingerprint = fields.Text( + help="This is the fingerprint that is advertised by this system in " + "order to validate its identity.", + ) + ignore_fingerprint = fields.Boolean( + default=True, + help="Set this to `True` in order to ignore an invalid/unknown " + "fingerprint from the system.", + ) + remote_path = fields.Char( + help="Restrict to this directory path on the remote, if applicable.", + ) + company_ids = fields.Many2many( + string="Companies", + comodel_name="res.company", + required=True, + default=lambda s: [(6, 0, s.env.user.company_id.ids)], + help="Access to this system is restricted to these companies.", + ) + system_type = fields.Selection( + selection="_get_system_types", + required=True, + ) + interface = fields.Reference( + selection="_get_system_types", + readonly=True, + help="This is the interface that this system represents. It is " + "created automatically upon creation of the external system.", + ) + + _sql_constraints = [ + ("name_uniq", "UNIQUE(name)", "Connection name must be unique."), + ] + + @api.model + def _get_system_types(self): + """Return the adapter interface models that are installed.""" + adapter = self.env["external.system.adapter"] + return [(m, self.env[m]._description) for m in adapter._inherit_children] + + @api.constrains("fingerprint", "ignore_fingerprint") + def check_fingerprint_ignore_fingerprint(self): + """Do not allow a blank fingerprint if not set to ignore.""" + for record in self: + if not record.ignore_fingerprint and not record.fingerprint: + raise ValidationError( + _( + "Fingerprint cannot be empty when Ignore Fingerprint is " + "not checked.", + ) + ) + + @contextmanager + def client(self): + """Client object usable as a context manager to include destruction. + + Yields the result from ``external_get_client``, then calls + ``external_destroy_client`` to cleanup the client. + + Yields: + mixed: An object representing the client connection to the remote + system. + """ + with self.interface.client() as client: + yield client + + @api.model_create_multi + def create(self, vals_list): + """Create the interface for the record and assign to ``interface``.""" + records = self.browse([]) + for vals in vals_list: + record = super(ExternalSystem, self).create(vals) + if not self.env.context.get("no_create_interface"): + interface = self.env[vals["system_type"]].create( + {"system_id": record.id} + ) + record.interface = interface + records += record + return records + + def action_test_connection(self): + """Test the connection to the external system.""" + self.ensure_one() + self.interface.external_test_connection() diff --git a/base_external_system/models/external_system_adapter.py b/base_external_system/models/external_system_adapter.py new file mode 100644 index 000000000..8bf09958a --- /dev/null +++ b/base_external_system/models/external_system_adapter.py @@ -0,0 +1,77 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from contextlib import contextmanager + +from odoo import _, api, fields, models +from odoo.exceptions import UserError + + +class ExternalSystemAdapter(models.AbstractModel): + """This is the model that should be inherited for new external systems. + + Methods provided are prefixed with ``external_`` in order to keep from + """ + + _name = "external.system.adapter" + _description = "External System Adapter" + _inherits = {"external.system": "system_id"} + + system_id = fields.Many2one( + string="System", + comodel_name="external.system", + required=True, + ondelete="cascade", + ) + + @contextmanager + def client(self): + """Client object usable as a context manager to include destruction. + + Yields the result from ``external_get_client``, then calls + ``external_destroy_client`` to cleanup the client. + + Yields: + mixed: An object representing the client connection to the remote + system. + """ + client = self.external_get_client() + try: + yield client + finally: + self.external_destroy_client(client) + + def external_get_client(self): + """Return a usable client representing the remote system.""" + self.ensure_one() + + def external_destroy_client(self, client): + """Perform any logic necessary to destroy the client connection. + + Args: + client (mixed): The client that was returned by + ``external_get_client``. + """ + self.ensure_one() + + def external_test_connection(self): + """Adapters should override this method, then call super if valid. + + If the connection is invalid, adapters should raise an instance of + ``odoo.ValidationError``. + + Raises: + odoo.exceptions.UserError: In the event of a good connection. + """ + raise UserError(_("The connection was a success.")) + + @api.model_create_multi + def create(self, vals_list): + context_self = self.with_context(no_create_interface=True) + records = self.browse([]) + for vals in vals_list: + vals.update({"system_type": self._name}) + record = super(ExternalSystemAdapter, context_self).create(vals) + record.system_id.interface = record + records += record + return records diff --git a/base_external_system/models/external_system_os.py b/base_external_system/models/external_system_os.py new file mode 100644 index 000000000..19850c6a7 --- /dev/null +++ b/base_external_system/models/external_system_os.py @@ -0,0 +1,41 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +import os + +from odoo import models + + +class ExternalSystemOs(models.Model): + """This is an Interface implementing the OS module. + + For the most part, this is just a sample of how to implement an external + system interface. This is still a fully usable implementation, however. + """ + + _name = "external.system.os" + _inherit = "external.system.adapter" + _description = "External System OS" + + previous_dir = None + + def external_get_client(self): + """Return a usable client representing the remote system.""" + super(ExternalSystemOs, self).external_get_client() + if self.system_id.remote_path: + ExternalSystemOs.previous_dir = os.getcwd() + os.chdir(self.system_id.remote_path) + return os + + def external_destroy_client(self, client): + """Perform any logic necessary to destroy the client connection. + + Args: + client (mixed): The client that was returned by + ``external_get_client``. + """ + result = super(ExternalSystemOs, self).external_destroy_client(client) + if ExternalSystemOs.previous_dir: + os.chdir(ExternalSystemOs.previous_dir) + ExternalSystemOs.previous_dir = None + return result diff --git a/base_external_system/readme/CONFIGURE.rst b/base_external_system/readme/CONFIGURE.rst new file mode 100644 index 000000000..0efcd8672 --- /dev/null +++ b/base_external_system/readme/CONFIGURE.rst @@ -0,0 +1 @@ +Configure external systems in Settings => Technical => External Systems diff --git a/base_external_system/readme/CONTRIBUTORS.rst b/base_external_system/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..f484d8b9c --- /dev/null +++ b/base_external_system/readme/CONTRIBUTORS.rst @@ -0,0 +1,6 @@ +* Dave Lasley +* Ronald Portier +* `Tecnativa `__: + + * Alexandre Díaz + * César A. Sánchez diff --git a/base_external_system/readme/DESCRIPTION.rst b/base_external_system/readme/DESCRIPTION.rst new file mode 100644 index 000000000..c06b08180 --- /dev/null +++ b/base_external_system/readme/DESCRIPTION.rst @@ -0,0 +1,7 @@ +This module provides an interface/adapter mechanism for the definition of remote +systems. + +Note that this module stores everything in plain text. In the interest of security, +it is recommended you use another module (such as `keychain` or `red_october` to +encrypt things like the password and private key). This is not done here in order +to not force a specific security method. diff --git a/base_external_system/readme/USAGE.rst b/base_external_system/readme/USAGE.rst new file mode 100644 index 000000000..7f358b53d --- /dev/null +++ b/base_external_system/readme/USAGE.rst @@ -0,0 +1,32 @@ +The credentials for systems are stored in the ``external.system`` model, and are to +be configured by the user. This model is the unified interface for the underlying +adapters. + +Using the Interface +~~~~~~~~~~~~~~~~~~~ + +Given an ``external.system`` singleton called ``external_system``, you would do the +following to get the underlying system client: + +.. code-block:: python + + with external_system.client() as client: + client.do_something() + +The client will be destroyed once the context has completed. Destruction takes place +in the adapter's ``external_destroy_client`` method. + +The only unified aspect of this interface is the client connection itself. Other more +opinionated interface/adapter mechanisms can be implemented in other modules, such as +the file system interface in `OCA/server-tools/external_file_location +`_. + +Creating an Adapter +~~~~~~~~~~~~~~~~~~~ + +Modules looking to add an external system adapter should inherit the +``external.system.adapter`` model and override the following methods: + +* ``external_get_client``: Returns a usable client for the system +* ``external_destroy_client``: Destroy the connection, if applicable. Does not need + to be defined if the connection destroys itself. diff --git a/base_external_system/security/ir.model.access.csv b/base_external_system/security/ir.model.access.csv new file mode 100644 index 000000000..f3fafd3ef --- /dev/null +++ b/base_external_system/security/ir.model.access.csv @@ -0,0 +1,3 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_external_system_os_admin,access_external_system_os_admin,model_external_system_os,base.group_system,1,1,1,1 +access_external_system_admin,access_external_system_admin,model_external_system,base.group_system,1,1,1,1 diff --git a/base_external_system/static/description/icon.png b/base_external_system/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/base_external_system/static/description/icon.png differ diff --git a/base_external_system/static/description/index.html b/base_external_system/static/description/index.html new file mode 100644 index 000000000..342ccca71 --- /dev/null +++ b/base_external_system/static/description/index.html @@ -0,0 +1,470 @@ + + + + + + +Base External System + + + +
+

Base External System

+ + +

Beta License: LGPL-3 OCA/server-backend Translate me on Weblate Try me on Runbot

+

This module provides an interface/adapter mechanism for the definition of remote +systems.

+

Note that this module stores everything in plain text. In the interest of security, +it is recommended you use another module (such as keychain or red_october to +encrypt things like the password and private key). This is not done here in order +to not force a specific security method.

+

Table of contents

+ +
+

Configuration

+

Configure external systems in Settings => Technical => External Systems

+
+
+

Usage

+

The credentials for systems are stored in the external.system model, and are to +be configured by the user. This model is the unified interface for the underlying +adapters.

+
+

Using the Interface

+

Given an external.system singleton called external_system, you would do the +following to get the underlying system client:

+
+with external_system.client() as client:
+    client.do_something()
+
+

The client will be destroyed once the context has completed. Destruction takes place +in the adapter’s external_destroy_client method.

+

The only unified aspect of this interface is the client connection itself. Other more +opinionated interface/adapter mechanisms can be implemented in other modules, such as +the file system interface in OCA/server-tools/external_file_location.

+
+
+

Creating an Adapter

+

Modules looking to add an external system adapter should inherit the +external.system.adapter model and override the following methods:

+
    +
  • external_get_client: Returns a usable client for the system
    • +
  • external_destroy_client: Destroy the connection, if applicable. Does not need +to be defined if the connection destroys itself.
    • +
+
+
+
+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • LasLabs
    • +
+
+
+

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-backend project on GitHub.

+

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

+
+
+
+ + diff --git a/base_external_system/tests/__init__.py b/base_external_system/tests/__init__.py new file mode 100644 index 000000000..c91c801ac --- /dev/null +++ b/base_external_system/tests/__init__.py @@ -0,0 +1,3 @@ +from . import test_external_system +from . import test_external_system_adapter +from . import test_external_system_os diff --git a/base_external_system/tests/common.py b/base_external_system/tests/common.py new file mode 100644 index 000000000..e56d2ed83 --- /dev/null +++ b/base_external_system/tests/common.py @@ -0,0 +1,20 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from contextlib import contextmanager +from unittest.mock import MagicMock + +from odoo.tests.common import TransactionCase + + +class Common(TransactionCase): + @contextmanager + def _mock_method(self, method_name, method_obj=None): + if method_obj is None: + method_obj = self.record + magic = MagicMock() + method_obj._patch_method(method_name, magic) + try: + yield magic + finally: + method_obj._revert_method(method_name) diff --git a/base_external_system/tests/test_external_system.py b/base_external_system/tests/test_external_system.py new file mode 100644 index 000000000..b1f212baf --- /dev/null +++ b/base_external_system/tests/test_external_system.py @@ -0,0 +1,68 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from odoo.exceptions import UserError, ValidationError + +from .common import Common + + +class TestExternalSystem(Common): + def setUp(self): + super(TestExternalSystem, self).setUp() + self.record = self.env.ref("base_external_system.external_system_os") + + def test_get_system_types(self): + """It should return at least the test record's interface.""" + self.assertIn( + (self.record._name, self.record._description), + self.env["external.system"]._get_system_types(), + ) + + def test_check_fingerprint_blank(self): + """It should not allow blank fingerprints when checking enabled.""" + with self.assertRaises(ValidationError): + self.record.write({"ignore_fingerprint": False, "fingerprint": False}) + + def test_check_fingerprint_allowed(self): + """It should not raise a validation error if there is a fingerprint.""" + # In Odoo 13.0, due to the way inverse records (models inherited from) + # are handled, setting both fields at the same time causes an error. + self.record.write({"fingerprint": "Data"}) + self.record.write({"ignore_fingerprint": False}) + self.assertTrue(True) + + def test_client(self): + """It should yield the open interface client.""" + with self._mock_method("client", self.record) as magic: + with self.record.system_id.client() as client: + self.assertEqual(client, magic().__enter__()) + + def test_create_creates_and_assigns_interface(self): + """It should create and assign the interface on record create.""" + record = self.env["external.system"].create( + {"name": "Test", "system_type": "external.system.os"} + ) + self.assertEqual( + record.interface._name, + "external.system.os", + ) + + def test_create_context_override(self): + """It should allow for interface create override with context.""" + model = self.env["external.system"].with_context( + no_create_interface=True, + ) + record = model.create({"name": "Test", "system_type": "external.system.os"}) + self.assertFalse(record.interface) + + def test_action_test_connection(self): + """It should proxy to the interface connection tester.""" + with self.assertRaises(UserError): + self.record.system_id.action_test_connection() + + def test_unlink_deletes_interface(self): + """It should delete the interface when the system is deleted.""" + interface = self.record.interface + self.assertTrue(interface.exists()) + self.record.unlink() + self.assertFalse(interface.exists()) diff --git a/base_external_system/tests/test_external_system_adapter.py b/base_external_system/tests/test_external_system_adapter.py new file mode 100644 index 000000000..f5ce4c07c --- /dev/null +++ b/base_external_system/tests/test_external_system_adapter.py @@ -0,0 +1,43 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from odoo.exceptions import UserError + +from .common import Common + + +class TestExternalSystemAdapter(Common): + def setUp(self): + super(TestExternalSystemAdapter, self).setUp() + self.system = self.env.ref("base_external_system.external_system_os") + self.record = self.env["external.system.adapter"].new( + {"system_id": self.system.id} + ) + + def test_client_yields_client(self): + """It should yield the client.""" + with self._mock_method("external_get_client") as magic: + with self.record.client() as client: + self.assertEqual(client, magic()) + + def test_client_destroys_client(self): + """It should destroy the client after use.""" + with self._mock_method("external_destroy_client") as magic: + with self.record.client() as client: + self.assertFalse(magic.call_count) + magic.assert_called_once_with(client) + + def test_external_get_client_ensure_one(self): + """It should assert singletons.""" + with self.assertRaises(ValueError): + self.env["external.system.adapter"].external_get_client() + + def test_external_destroy_client_ensure_one(self): + """It should assert singletons.""" + with self.assertRaises(ValueError): + self.env["external.system.adapter"].external_destroy_client(None) + + def test_external_test_connection(self): + """It should raise a UserError.""" + with self.assertRaises(UserError): + self.record.external_test_connection() diff --git a/base_external_system/tests/test_external_system_os.py b/base_external_system/tests/test_external_system_os.py new file mode 100644 index 000000000..130082b11 --- /dev/null +++ b/base_external_system/tests/test_external_system_os.py @@ -0,0 +1,39 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import os + +from .common import Common + + +class TestExternalSystemOs(Common): + @classmethod + def setUpClass(cls): + """Remember the working dir, just in case.""" + super(TestExternalSystemOs, cls).setUpClass() + cls.working_dir = os.getcwd() + + @classmethod + def tearDownClass(cls): + """Set the working dir back to origin, just in case.""" + result = super(TestExternalSystemOs, cls).tearDownClass() + os.chdir(cls.working_dir) + return result + + def setUp(self): + super(TestExternalSystemOs, self).setUp() + self.record = self.env.ref("base_external_system.external_system_os") + + def test_external_get_client_returns_os(self): + """It should return the Pyhton OS module.""" + self.assertEqual(self.record.external_get_client(), os) + + def test_external_get_client_changes_directories(self): + """It should change to the proper directory.""" + self.record.external_get_client() + self.assertEqual(os.getcwd(), self.record.remote_path) + + def test_external_destroy_client_changes_directory(self): + """It should change back to the previous working directory.""" + self.record.external_destroy_client(None) + self.assertEqual(os.getcwd(), self.working_dir) diff --git a/base_external_system/views/external_system_view.xml b/base_external_system/views/external_system_view.xml new file mode 100644 index 000000000..ec0ee2546 --- /dev/null +++ b/base_external_system/views/external_system_view.xml @@ -0,0 +1,109 @@ + + + + + external.system.view.form + external.system + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +