audrius/server-backend
1
0
Fork 0
mirror of https://github.com/OCA/server-backend.git synced 2025-02-18 09:52:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

[IMP] : black, isort, prettier

Browse Source
This commit is contained in:
Ronald Portier
2020-08-20 14:01:02 +02:00
parent c6b20605ce
commit e05496d065
12 changed files with 124 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
base_external_system/__manifest__.py
View File

@@ -7,17 +7,14 @@
"version": "12.0.1.0.0",
"category": "Base",
"website": "https://github.com/OCA/server-backend",
"author": "LasLabs, "
"Odoo Community Association (OCA)",
"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',
"depends": ["base",],
"data": [
"demo/external_system_os_demo.xml",
"security/ir.model.access.csv",
"views/external_system_view.xml",
],
}

6
base_external_system/demo/external_system_os_demo.xml
View File

@@ -1,17 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<?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>

83
base_external_system/models/external_system.py
View File

@@ -3,94 +3,89 @@
from contextlib import contextmanager
from odoo import api, fields, models, _
from odoo import _, api, fields, models
from odoo.exceptions import ValidationError
class ExternalSystem(models.Model):
_name = 'external.system'
_description = 'External System'
_name = "external.system"
_description = "External System"
name = fields.Char(
required=True,
help='This is the canonical (humanized) name for the system.',
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.',
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.',
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.',
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.',
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.',
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.',
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.',
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.',
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.',
help="Restrict to this directory path on the remote, if applicable.",
)
company_ids = fields.Many2many(
string='Companies',
comodel_name='res.company',
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,
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',
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.',
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.'),
("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
]
adapter = self.env["external.system.adapter"]
return [(m, self.env[m]._description) for m in adapter._inherit_children]
@api.multi
@api.constrains('fingerprint', 'ignore_fingerprint')
@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.',
))
raise ValidationError(
_(
"Fingerprint cannot be empty when Ignore Fingerprint is "
"not checked.",
)
)
@api.multi
@contextmanager
@@ -111,10 +106,8 @@ class ExternalSystem(models.Model):
def create(self, vals):
"""Create the interface for the record and assign to ``interface``."""
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,
})
if not self.env.context.get("no_create_interface"):
interface = self.env[vals["system_type"]].create({"system_id": record.id,})
record.interface = interface
return record

22
base_external_system/models/external_system_adapter.py
View File

@@ -3,7 +3,7 @@
from contextlib import contextmanager
from odoo import api, fields, models, _
from odoo import _, api, fields, models
from odoo.exceptions import UserError
@@ -13,15 +13,15 @@ class ExternalSystemAdapter(models.AbstractModel):
Methods provided are prefixed with ``external_`` in order to keep from
"""
_name = 'external.system.adapter'
_description = 'External System Adapter'
_inherits = {'external.system': 'system_id'}
_name = "external.system.adapter"
_description = "External System Adapter"
_inherits = {"external.system": "system_id"}
system_id = fields.Many2one(
string='System',
comodel_name='external.system',
string="System",
comodel_name="external.system",
required=True,
ondelete='cascade',
ondelete="cascade",
)
@api.multi
@@ -67,14 +67,14 @@ class ExternalSystemAdapter(models.AbstractModel):
Raises:
odoo.exceptions.UserError: In the event of a good connection.
"""
raise UserError(_('The connection was a success.'))
raise UserError(_("The connection was a success."))
@api.model
def create(self, vals):
context_self = self.with_context(no_create_interface=True)
vals.update({
'system_type': self._name,
})
vals.update(
{"system_type": self._name,}
)
record = super(ExternalSystemAdapter, context_self).create(vals)
record.system_id.interface = record
return record

6
base_external_system/models/external_system_os.py
View File

@@ -13,9 +13,9 @@ class ExternalSystemOs(models.Model):
system interface. This is still a fully usable implementation, however.
"""
_name = 'external.system.os'
_inherit = 'external.system.adapter'
_description = 'External System OS'
_name = "external.system.os"
_inherit = "external.system.adapter"
_description = "External System OS"
previous_dir = None

2
base_external_system/tests/common.py
View File

@@ -2,13 +2,13 @@
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
from contextlib import contextmanager
from 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:

35
base_external_system/tests/test_external_system.py
View File

@@ -7,59 +7,46 @@ 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')
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(),
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,
})
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."""
self.record.write({
'ignore_fingerprint': False,
'fingerprint': 'Data',
})
self.record.write({"ignore_fingerprint": False, "fingerprint": "Data"})
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._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',
})
record = self.env["external.system"].create(
{"name": "Test", "system_type": "external.system.os"}
)
self.assertEqual(
record.interface._name, 'external.system.os',
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',
})
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):

17
base_external_system/tests/test_external_system_adapter.py
View File

@@ -7,23 +7,22 @@ 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,
})
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._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._mock_method("external_destroy_client") as magic:
with self.record.client() as client:
self.assertFalse(magic.call_count)
magic.assert_called_once_with(client)
@@ -31,12 +30,12 @@ class TestExternalSystemAdapter(Common):
def test_external_get_client_ensure_one(self):
"""It should assert singletons."""
with self.assertRaises(ValueError):
self.env['external.system.adapter'].external_get_client()
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)
self.env["external.system.adapter"].external_destroy_client(None)
def test_external_test_connection(self):
"""It should raise a UserError."""

3
base_external_system/tests/test_external_system_os.py
View File

@@ -7,7 +7,6 @@ from .common import Common
class TestExternalSystemOs(Common):
@classmethod
def setUpClass(cls):
"""Remember the working dir, just in case."""
@@ -22,7 +21,7 @@ class TestExternalSystemOs(Common):
def setUp(self):
super(TestExternalSystemOs, self).setUp()
self.record = self.env.ref('base_external_system.external_system_os')
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."""

43
base_external_system/views/external_system_view.xml
View File

@@ -1,21 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<?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"
<button
name="action_test_connection"
type="object"
string="Test Connection" />
string="Test Connection"
/>
</header>
<sheet>
<group name="data">
@@ -50,7 +49,6 @@
</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>
@@ -62,38 +60,39 @@
</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"
<filter
string="Host"
name="host"
domain=""
context="{'group_by': 'host'}" />
<filter string="Port"
context="{'group_by': 'host'}"
/>
<filter
string="Port"
name="port"
domain=""
context="{'group_by': 'port'}" />
<filter string="Username"
context="{'group_by': 'port'}"
/>
<filter
string="Username"
name="username"
domain=""
context="{'group_by': 'username'}" />
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>
@@ -101,11 +100,11 @@
<field name="view_type">form</field>
<field name="view_mode">tree,form</field>
</record>
<menuitem id="menu_external_system"
<menuitem
id="menu_external_system"
name="External Systems"
parent="base.menu_custom"
action="external_system_action"
sequence="50" />
sequence="50"
/>
</odoo>

1
setup/base_external_system/odoo/addons/base_external_system Symbolic link
View File

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

6
setup/base_external_system/setup.py Normal file
View File

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