Merge PR #204 into 16.0

Signed-off-by thomaspaulb
This commit is contained in:
OCA-git-bot
2023-08-21 14:52:23 +00:00
24 changed files with 1499 additions and 0 deletions

View File

@@ -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/15.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-15-0/server-backend-15-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/15.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
<https://github.com/OCA/server-tools/tree/9.0/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 <https://github.com/OCA/server-backend/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 <https://github.com/OCA/server-backend/issues/new?body=module:%20base_external_system%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
~~~~~~~
* LasLabs
Contributors
~~~~~~~~~~~~
* Dave Lasley <dave@laslabs.com>
* Ronald Portier <ronald@therp.nl>
* `Tecnativa <https://www.tecnativa.com>`__:
* 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 <https://github.com/OCA/server-backend/tree/15.0/base_external_system>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

View File

@@ -0,0 +1,4 @@
# Copyright 2017 LasLabs Inc.
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
from . import models

View File

@@ -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",
],
}

View File

@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="utf-8" ?>
<!--
Copyright 2017 LasLabs Inc.
License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
-->
<odoo>
<record id="external_system_os" model="external.system.os">
<field name="name">Example OS Connection</field>
<field name="system_type">external.system.os</field>
<field name="remote_path">/tmp</field>
<field name="company_ids" eval="[(5, 0), (4, ref('base.main_company'))]" />
</record>
</odoo>

View File

@@ -0,0 +1,284 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_external_system
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 15.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
#: 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
#: 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 ""

View File

@@ -0,0 +1,3 @@
from . import external_system
from . import external_system_adapter
from . import external_system_os

View File

@@ -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()

View File

@@ -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

View File

@@ -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

View File

@@ -0,0 +1 @@
Configure external systems in Settings => Technical => External Systems

View File

@@ -0,0 +1,6 @@
* Dave Lasley <dave@laslabs.com>
* Ronald Portier <ronald@therp.nl>
* `Tecnativa <https://www.tecnativa.com>`__:
* Alexandre Díaz
* César A. Sánchez

View File

@@ -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.

View File

@@ -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
<https://github.com/OCA/server-tools/tree/9.0/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.

View File

@@ -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
1 id name model_id:id group_id:id perm_read perm_write perm_create perm_unlink
2 access_external_system_os_admin access_external_system_os_admin model_external_system_os base.group_system 1 1 1 1
3 access_external_system_admin access_external_system_admin model_external_system base.group_system 1 1 1 1

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

@@ -0,0 +1,470 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<title>Base External System</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="base-external-system">
<h1 class="title">Base External System</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-backend/tree/15.0/base_external_system"><img alt="OCA/server-backend" src="https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-backend-15-0/server-backend-15-0-base_external_system"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/253/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module provides an interface/adapter mechanism for the definition of remote
systems.</p>
<p>Note that this module stores everything in plain text. In the interest of security,
it is recommended you use another module (such as <cite>keychain</cite> or <cite>red_october</cite> to
encrypt things like the password and private key). This is not done here in order
to not force a specific security method.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a><ul>
<li><a class="reference internal" href="#using-the-interface" id="id3">Using the Interface</a></li>
<li><a class="reference internal" href="#creating-an-adapter" id="id4">Creating an Adapter</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id6">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id7">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id9">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<p>Configure external systems in Settings =&gt; Technical =&gt; External Systems</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
<p>The credentials for systems are stored in the <tt class="docutils literal">external.system</tt> model, and are to
be configured by the user. This model is the unified interface for the underlying
adapters.</p>
<div class="section" id="using-the-interface">
<h2><a class="toc-backref" href="#id3">Using the Interface</a></h2>
<p>Given an <tt class="docutils literal">external.system</tt> singleton called <tt class="docutils literal">external_system</tt>, you would do the
following to get the underlying system client:</p>
<pre class="code python literal-block">
<span class="k">with</span> <span class="n">external_system</span><span class="o">.</span><span class="n">client</span><span class="p">()</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
<span class="n">client</span><span class="o">.</span><span class="n">do_something</span><span class="p">()</span>
</pre>
<p>The client will be destroyed once the context has completed. Destruction takes place
in the adapters <tt class="docutils literal">external_destroy_client</tt> method.</p>
<p>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 <a class="reference external" href="https://github.com/OCA/server-tools/tree/9.0/external_file_location">OCA/server-tools/external_file_location</a>.</p>
</div>
<div class="section" id="creating-an-adapter">
<h2><a class="toc-backref" href="#id4">Creating an Adapter</a></h2>
<p>Modules looking to add an external system adapter should inherit the
<tt class="docutils literal">external.system.adapter</tt> model and override the following methods:</p>
<ul class="simple">
<li><tt class="docutils literal">external_get_client</tt>: Returns a usable client for the system</li>
<li><tt class="docutils literal">external_destroy_client</tt>: Destroy the connection, if applicable. Does not need
to be defined if the connection destroys itself.</li>
</ul>
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id5">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-backend/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-backend/issues/new?body=module:%20base_external_system%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id6">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id7">Authors</a></h2>
<ul class="simple">
<li>LasLabs</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id8">Contributors</a></h2>
<ul class="simple">
<li>Dave Lasley &lt;<a class="reference external" href="mailto:dave&#64;laslabs.com">dave&#64;laslabs.com</a>&gt;</li>
<li>Ronald Portier &lt;<a class="reference external" href="mailto:ronald&#64;therp.nl">ronald&#64;therp.nl</a>&gt;</li>
<li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
<li>Alexandre Díaz</li>
<li>César A. Sánchez</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id9">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-backend/tree/15.0/base_external_system">OCA/server-backend</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,3 @@
from . import test_external_system
from . import test_external_system_adapter
from . import test_external_system_os

View File

@@ -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)

View File

@@ -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())

View File

@@ -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()

View File

@@ -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)

View File

@@ -0,0 +1,109 @@
<?xml version="1.0" encoding="utf-8" ?>
<!--
Copyright 2017 LasLabs Inc.
License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
-->
<odoo>
<record id="external_system_view_form" model="ir.ui.view">
<field name="name">external.system.view.form</field>
<field name="model">external.system</field>
<field name="arch" type="xml">
<form string="External System">
<header>
<button
name="action_test_connection"
type="object"
string="Test Connection"
/>
</header>
<sheet>
<group name="data">
<group name="group_server_data">
<field name="name" />
<field name="company_ids" widget="many2many_tags" />
<field name="remote_path" />
<field name="ignore_fingerprint" />
</group>
<group name="group_connection_data">
<field name="host" />
<field name="port" />
<field name="username" />
<field name="password" widget="password" />
<field name="system_type" />
</group>
</group>
<notebook>
<page string="Keys">
<group>
<group>
<field name="private_key" />
</group>
<group>
<field name="fingerprint" />
</group>
</group>
</page>
</notebook>
</sheet>
<footer />
</form>
</field>
</record>
<record id="external_system_view_tree" model="ir.ui.view">
<field name="name">external.system.view.tree</field>
<field name="model">external.system</field>
<field name="arch" type="xml">
<tree>
<field name="name" />
<field name="host" />
<field name="port" />
</tree>
</field>
</record>
<record id="external_system_view_search" model="ir.ui.view">
<field name="name">external.system.view.search</field>
<field name="model">external.system</field>
<field name="arch" type="xml">
<search string="External Systems">
<field name="name" />
<field name="company_ids" />
<field name="host" />
<field name="port" />
<field name="username" />
<group expand="0" string="Group By">
<filter
string="Host"
name="host"
domain=""
context="{'group_by': 'host'}"
/>
<filter
string="Port"
name="port"
domain=""
context="{'group_by': 'port'}"
/>
<filter
string="Username"
name="username"
domain=""
context="{'group_by': 'username'}"
/>
</group>
</search>
</field>
</record>
<record id="external_system_action" model="ir.actions.act_window">
<field name="name">External Systems</field>
<field name="res_model">external.system</field>
<field name="type">ir.actions.act_window</field>
<field name="view_mode">tree,form</field>
</record>
<menuitem
id="menu_external_system"
name="External Systems"
parent="base.menu_custom"
action="external_system_action"
sequence="50"
/>
</odoo>

View File

@@ -0,0 +1 @@
../../../../base_external_system

View File

@@ -0,0 +1,6 @@
import setuptools
setuptools.setup(
setup_requires=['setuptools-odoo'],
odoo_addon=True,
)